From fdbb019439708863f1afa9875e198b463731af82 Mon Sep 17 00:00:00 2001 From: Chris Wright Date: Thu, 2 Apr 2015 16:32:21 +0100 Subject: [PATCH] Rationalise docblock whitespace --- examples/AQuery.php | 12 +-- examples/SOAQuery.php | 12 +-- src/LibDNS/Decoder/Decoder.php | 93 +++++++------------ src/LibDNS/Decoder/DecoderFactory.php | 18 ++-- src/LibDNS/Decoder/DecodingContext.php | 20 ++-- src/LibDNS/Decoder/DecodingContextFactory.php | 19 ++-- src/LibDNS/Encoder/Encoder.php | 37 ++++---- src/LibDNS/Encoder/EncoderFactory.php | 18 ++-- src/LibDNS/Encoder/EncodingContext.php | 22 ++--- src/LibDNS/Encoder/EncodingContextFactory.php | 21 ++--- src/LibDNS/Enumeration.php | 18 ++-- src/LibDNS/Messages/Message.php | 29 ++---- src/LibDNS/Messages/MessageFactory.php | 19 ++-- src/LibDNS/Messages/MessageOpCodes.php | 18 ++-- src/LibDNS/Messages/MessageResponseCodes.php | 18 ++-- src/LibDNS/Messages/MessageTypes.php | 18 ++-- src/LibDNS/Packets/LabelRegistry.php | 20 ++-- src/LibDNS/Packets/Packet.php | 19 ++-- src/LibDNS/Packets/PacketFactory.php | 18 ++-- src/LibDNS/Records/Question.php | 18 ++-- src/LibDNS/Records/QuestionFactory.php | 19 ++-- src/LibDNS/Records/RData.php | 30 +++--- src/LibDNS/Records/RDataBuilder.php | 21 ++--- src/LibDNS/Records/RDataFactory.php | 18 ++-- src/LibDNS/Records/Record.php | 20 ++-- src/LibDNS/Records/RecordCollection.php | 28 ++---- .../Records/RecordCollectionFactory.php | 20 ++-- src/LibDNS/Records/RecordTypes.php | 18 ++-- src/LibDNS/Records/Resource.php | 19 ++-- src/LibDNS/Records/ResourceBuilder.php | 23 +++-- src/LibDNS/Records/ResourceBuilderFactory.php | 19 ++-- src/LibDNS/Records/ResourceClasses.php | 18 ++-- src/LibDNS/Records/ResourceFactory.php | 21 ++--- src/LibDNS/Records/ResourceQClasses.php | 18 ++-- src/LibDNS/Records/ResourceQTypes.php | 18 ++-- src/LibDNS/Records/ResourceTypes.php | 18 ++-- .../TypeDefinitions/FieldDefinition.php | 27 +++--- .../FieldDefinitionFactory.php | 27 +++--- .../TypeDefinitions/TypeDefinition.php | 22 ++--- .../TypeDefinitions/TypeDefinitionFactory.php | 22 ++--- .../TypeDefinitions/TypeDefinitionManager.php | 20 ++-- .../TypeDefinitionManagerFactory.php | 18 ++-- src/LibDNS/Records/Types/Anything.php | 19 ++-- src/LibDNS/Records/Types/BitMap.php | 18 ++-- src/LibDNS/Records/Types/Char.php | 19 ++-- src/LibDNS/Records/Types/CharacterString.php | 19 ++-- src/LibDNS/Records/Types/DomainName.php | 24 ++--- src/LibDNS/Records/Types/IPv4Address.php | 21 ++--- src/LibDNS/Records/Types/IPv6Address.php | 24 ++--- src/LibDNS/Records/Types/Long.php | 19 ++-- src/LibDNS/Records/Types/Short.php | 19 ++-- src/LibDNS/Records/Types/Type.php | 20 ++-- src/LibDNS/Records/Types/TypeBuilder.php | 19 ++-- src/LibDNS/Records/Types/TypeFactory.php | 27 ++---- src/LibDNS/Records/Types/Types.php | 18 ++-- tools/autoload_generator.php | 12 +-- 56 files changed, 554 insertions(+), 655 deletions(-) diff --git a/examples/AQuery.php b/examples/AQuery.php index 49d0ca6..8ea7e0b 100644 --- a/examples/AQuery.php +++ b/examples/AQuery.php @@ -4,12 +4,12 @@ * * PHP version 5.4 * - * @category LibDNS - * @package Examples - * @author Chris Wright - * @copyright Copyright (c) Chris Wright - * @license http://www.opensource.org/licenses/mit-license.html MIT License - * @version 1.0.0 + * @category LibDNS + * @package Examples + * @author Chris Wright + * @copyright Copyright (c) Chris Wright + * @license http://www.opensource.org/licenses/mit-license.html MIT License + * @version 1.0.0 */ namespace LibDNS\Examples; diff --git a/examples/SOAQuery.php b/examples/SOAQuery.php index d6cdfb7..30e9b6a 100644 --- a/examples/SOAQuery.php +++ b/examples/SOAQuery.php @@ -4,12 +4,12 @@ * * PHP version 5.4 * - * @category LibDNS - * @package Examples - * @author Chris Wright - * @copyright Copyright (c) Chris Wright - * @license http://www.opensource.org/licenses/mit-license.html MIT License - * @version 1.0.0 + * @category LibDNS + * @package Examples + * @author Chris Wright + * @copyright Copyright (c) Chris Wright + * @license http://www.opensource.org/licenses/mit-license.html MIT License + * @version 1.0.0 */ namespace LibDNS\Examples; diff --git a/src/LibDNS/Decoder/Decoder.php b/src/LibDNS/Decoder/Decoder.php index 563c6a4..3368020 100644 --- a/src/LibDNS/Decoder/Decoder.php +++ b/src/LibDNS/Decoder/Decoder.php @@ -4,12 +4,12 @@ * * PHP version 5.4 * - * @category LibDNS - * @package Decoder - * @author Chris Wright - * @copyright Copyright (c) Chris Wright - * @license http://www.opensource.org/licenses/mit-license.html MIT License - * @version 2.0.0 + * @category LibDNS + * @package Decoder + * @author Chris Wright + * @copyright Copyright (c) Chris Wright + * @license http://www.opensource.org/licenses/mit-license.html MIT License + * @version 2.0.0 */ namespace LibDNS\Decoder; @@ -35,9 +35,9 @@ /** * Decodes raw network data to Message objects * - * @category LibDNS - * @package Decoder - * @author Chris Wright + * @category LibDNS + * @package Decoder + * @author Chris Wright */ class Decoder { @@ -74,11 +74,11 @@ class Decoder /** * Constructor * - * @param \LibDNS\Packets\PacketFactory $packetFactory - * @param \LibDNS\Messages\MessageFactory $messageFactory - * @param \LibDNS\Records\QuestionFactory $questionFactory - * @param \LibDNS\Records\ResourceBuilder $resourceBuilder - * @param \LibDNS\Records\Types\TypeBuilder $typeBuilder + * @param \LibDNS\Packets\PacketFactory $packetFactory + * @param \LibDNS\Messages\MessageFactory $messageFactory + * @param \LibDNS\Records\QuestionFactory $questionFactory + * @param \LibDNS\Records\ResourceBuilder $resourceBuilder + * @param \LibDNS\Records\Types\TypeBuilder $typeBuilder * @param \LibDNS\Decoder\DecodingContextFactory $decodingContextFactory */ public function __construct( @@ -101,10 +101,8 @@ public function __construct( * Read a specified number of bytes of data from a packet * * @param \LibDNS\Packets\Packet $packet - * @param int $length - * + * @param int $length * @return string - * * @throws \UnexpectedValueException When the read operation does not result in the requested number of bytes */ private function readDataFromPacket(Packet $packet, $length) @@ -120,8 +118,7 @@ private function readDataFromPacket(Packet $packet, $length) * Decode the header section of the message * * @param \LibDNS\Decoder\DecodingContext $decodingContext - * @param \LibDNS\Messages\Message $message - * + * @param \LibDNS\Messages\Message $message * @throws \UnexpectedValueException When the header section is invalid */ private function decodeHeader(DecodingContext $decodingContext, Message $message) @@ -151,11 +148,9 @@ private function decodeHeader(DecodingContext $decodingContext, Message $message * Decode an Anything field * * @param \LibDNS\Decoder\DecodingContext $decodingContext - * @param \LibDNS\Records\Types\Anything $anything The object to populate with the result - * @param int $length - * + * @param \LibDNS\Records\Types\Anything $anything The object to populate with the result + * @param int $length * @return int The number of packet bytes consumed by the operation - * * @throws \UnexpectedValueException When the packet data is invalid */ private function decodeAnything(DecodingContext $decodingContext, Anything $anything, $length) @@ -169,11 +164,9 @@ private function decodeAnything(DecodingContext $decodingContext, Anything $anyt * Decode a BitMap field * * @param \LibDNS\Decoder\DecodingContext $decodingContext - * @param \LibDNS\Records\Types\BitMap $bitMap The object to populate with the result - * @param int $length - * + * @param \LibDNS\Records\Types\BitMap $bitMap The object to populate with the result + * @param int $length * @return int The number of packet bytes consumed by the operation - * * @throws \UnexpectedValueException When the packet data is invalid */ private function decodeBitMap(DecodingContext $decodingContext, BitMap $bitMap, $length) @@ -187,10 +180,8 @@ private function decodeBitMap(DecodingContext $decodingContext, BitMap $bitMap, * Decode a Char field * * @param \LibDNS\Decoder\DecodingContext $decodingContext - * @param \LibDNS\Records\Types\Char $char The object to populate with the result - * + * @param \LibDNS\Records\Types\Char $char The object to populate with the result * @return int The number of packet bytes consumed by the operation - * * @throws \UnexpectedValueException When the packet data is invalid */ private function decodeChar(DecodingContext $decodingContext, Char $char) @@ -204,11 +195,9 @@ private function decodeChar(DecodingContext $decodingContext, Char $char) /** * Decode a CharacterString field * - * @param \LibDNS\Decoder\DecodingContext $decodingContext + * @param \LibDNS\Decoder\DecodingContext $decodingContext * @param \LibDNS\Records\Types\CharacterString $characterString The object to populate with the result - * * @return int The number of packet bytes consumed by the operation - * * @throws \UnexpectedValueException When the packet data is invalid */ private function decodeCharacterString(DecodingContext $decodingContext, CharacterString $characterString) @@ -223,11 +212,9 @@ private function decodeCharacterString(DecodingContext $decodingContext, Charact /** * Decode a DomainName field * - * @param \LibDNS\Decoder\DecodingContext $decodingContext - * @param \LibDNS\Records\Types\DomainName $domainName The object to populate with the result - * + * @param \LibDNS\Decoder\DecodingContext $decodingContext + * @param \LibDNS\Records\Types\DomainName $domainName The object to populate with the result * @return int The number of packet bytes consumed by the operation - * * @throws \UnexpectedValueException When the packet data is invalid */ private function decodeDomainName(DecodingContext $decodingContext, DomainName $domainName) @@ -285,11 +272,9 @@ private function decodeDomainName(DecodingContext $decodingContext, DomainName $ /** * Decode an IPv4Address field * - * @param \LibDNS\Decoder\DecodingContext $decodingContext - * @param \LibDNS\Records\Types\IPv4Address $ipv4Address The object to populate with the result - * + * @param \LibDNS\Decoder\DecodingContext $decodingContext + * @param \LibDNS\Records\Types\IPv4Address $ipv4Address The object to populate with the result * @return int The number of packet bytes consumed by the operation - * * @throws \UnexpectedValueException When the packet data is invalid */ private function decodeIPv4Address(DecodingContext $decodingContext, IPv4Address $ipv4Address) @@ -303,11 +288,9 @@ private function decodeIPv4Address(DecodingContext $decodingContext, IPv4Address /** * Decode an IPv6Address field * - * @param \LibDNS\Decoder\DecodingContext $decodingContext - * @param \LibDNS\Records\Types\IPv6Address $ipv6Address The object to populate with the result - * + * @param \LibDNS\Decoder\DecodingContext $decodingContext + * @param \LibDNS\Records\Types\IPv6Address $ipv6Address The object to populate with the result * @return int The number of packet bytes consumed by the operation - * * @throws \UnexpectedValueException When the packet data is invalid */ private function decodeIPv6Address(DecodingContext $decodingContext, IPv6Address $ipv6Address) @@ -322,10 +305,8 @@ private function decodeIPv6Address(DecodingContext $decodingContext, IPv6Address * Decode a Long field * * @param \LibDNS\Decoder\DecodingContext $decodingContext - * @param \LibDNS\Records\Types\Long $long The object to populate with the result - * + * @param \LibDNS\Records\Types\Long $long The object to populate with the result * @return int The number of packet bytes consumed by the operation - * * @throws \UnexpectedValueException When the packet data is invalid */ private function decodeLong(DecodingContext $decodingContext, Long $long) @@ -340,10 +321,8 @@ private function decodeLong(DecodingContext $decodingContext, Long $long) * Decode a Short field * * @param \LibDNS\Decoder\DecodingContext $decodingContext - * @param \LibDNS\Records\Types\Short $short The object to populate with the result - * + * @param \LibDNS\Records\Types\Short $short The object to populate with the result * @return int The number of packet bytes consumed by the operation - * * @throws \UnexpectedValueException When the packet data is invalid */ private function decodeShort(DecodingContext $decodingContext, Short $short) @@ -358,11 +337,9 @@ private function decodeShort(DecodingContext $decodingContext, Short $short) * Decode a Type field * * @param \LibDNS\Decoder\DecodingContext $decodingContext - * @param \LibDNS\Records\Types\Type $type The object to populate with the result - * @param int $length Expected data length - * + * @param \LibDNS\Records\Types\Type $type The object to populate with the result + * @param int $length Expected data length * @return int The number of packet bytes consumed by the operation - * * @throws \UnexpectedValueException When the packet data is invalid * @throws \InvalidArgumentException When the Type subtype is unknown */ @@ -397,9 +374,7 @@ private function decodeType(DecodingContext $decodingContext, Type $type, $lengt * Decode a question record * * @param \LibDNS\Decoder\DecodingContext $decodingContext - * * @return \LibDNS\Records\Question - * * @throws \UnexpectedValueException When the record is invalid */ private function decodeQuestionRecord(DecodingContext $decodingContext) @@ -420,9 +395,7 @@ private function decodeQuestionRecord(DecodingContext $decodingContext) * Decode a resource record * * @param \LibDNS\Decoder\DecodingContext $decodingContext - * * @return \LibDNS\Records\Resource - * * @throws \UnexpectedValueException When the record is invalid * @throws \InvalidArgumentException When a type subtype is unknown */ @@ -467,9 +440,7 @@ private function decodeResourceRecord(DecodingContext $decodingContext) * Decode a Message from raw network data * * @param string $data The data string to decode - * * @return \LibDNS\Messages\Message - * * @throws \UnexpectedValueException When the packet data is invalid * @throws \InvalidArgumentException When a type subtype is unknown */ diff --git a/src/LibDNS/Decoder/DecoderFactory.php b/src/LibDNS/Decoder/DecoderFactory.php index a18be13..75ca0c4 100644 --- a/src/LibDNS/Decoder/DecoderFactory.php +++ b/src/LibDNS/Decoder/DecoderFactory.php @@ -4,12 +4,12 @@ * * PHP version 5.4 * - * @category LibDNS - * @package Decoder - * @author Chris Wright - * @copyright Copyright (c) Chris Wright - * @license http://www.opensource.org/licenses/mit-license.html MIT License - * @version 2.0.0 + * @category LibDNS + * @package Decoder + * @author Chris Wright + * @copyright Copyright (c) Chris Wright + * @license http://www.opensource.org/licenses/mit-license.html MIT License + * @version 2.0.0 */ namespace LibDNS\Decoder; @@ -30,9 +30,9 @@ /** * Creates Decoder objects * - * @category LibDNS - * @package Decoder - * @author Chris Wright + * @category LibDNS + * @package Decoder + * @author Chris Wright */ class DecoderFactory { diff --git a/src/LibDNS/Decoder/DecodingContext.php b/src/LibDNS/Decoder/DecodingContext.php index 9c6d727..91ede93 100644 --- a/src/LibDNS/Decoder/DecodingContext.php +++ b/src/LibDNS/Decoder/DecodingContext.php @@ -4,12 +4,12 @@ * * PHP version 5.4 * - * @category LibDNS - * @package Decoder - * @author Chris Wright - * @copyright Copyright (c) Chris Wright - * @license http://www.opensource.org/licenses/mit-license.html MIT License - * @version 2.0.0 + * @category LibDNS + * @package Decoder + * @author Chris Wright + * @copyright Copyright (c) Chris Wright + * @license http://www.opensource.org/licenses/mit-license.html MIT License + * @version 2.0.0 */ namespace LibDNS\Decoder; @@ -19,9 +19,9 @@ /** * Holds data associated with a decode operation * - * @category LibDNS - * @package Decoder - * @author Chris Wright + * @category LibDNS + * @package Decoder + * @author Chris Wright */ class DecodingContext { @@ -58,7 +58,7 @@ class DecodingContext /** * Constructor * - * @param \LibDNS\Packets\Packet $packet + * @param \LibDNS\Packets\Packet $packet * @param \LibDNS\Packets\LabelRegistry $labelRegistry */ public function __construct(Packet $packet, LabelRegistry $labelRegistry) diff --git a/src/LibDNS/Decoder/DecodingContextFactory.php b/src/LibDNS/Decoder/DecodingContextFactory.php index 22c5676..12bacad 100644 --- a/src/LibDNS/Decoder/DecodingContextFactory.php +++ b/src/LibDNS/Decoder/DecodingContextFactory.php @@ -4,12 +4,12 @@ * * PHP version 5.4 * - * @category LibDNS - * @package Decoder - * @author Chris Wright - * @copyright Copyright (c) Chris Wright - * @license http://www.opensource.org/licenses/mit-license.html MIT License - * @version 2.0.0 + * @category LibDNS + * @package Decoder + * @author Chris Wright + * @copyright Copyright (c) Chris Wright + * @license http://www.opensource.org/licenses/mit-license.html MIT License + * @version 2.0.0 */ namespace LibDNS\Decoder; @@ -19,9 +19,9 @@ /** * Creates DecodingContext objects * - * @category LibDNS - * @package Decoder - * @author Chris Wright + * @category LibDNS + * @package Decoder + * @author Chris Wright */ class DecodingContextFactory { @@ -29,7 +29,6 @@ class DecodingContextFactory * Create a new DecodingContext object * * @param \LibDNS\Packets\Packet $packet The packet to be decoded - * * @return \LibDNS\Decoder\DecodingContext */ public function create(Packet $packet) diff --git a/src/LibDNS/Encoder/Encoder.php b/src/LibDNS/Encoder/Encoder.php index eff3958..38b136e 100644 --- a/src/LibDNS/Encoder/Encoder.php +++ b/src/LibDNS/Encoder/Encoder.php @@ -4,12 +4,12 @@ * * PHP version 5.4 * - * @category LibDNS - * @package Encoder - * @author Chris Wright - * @copyright Copyright (c) Chris Wright - * @license http://www.opensource.org/licenses/mit-license.html MIT License - * @version 2.0.0 + * @category LibDNS + * @package Encoder + * @author Chris Wright + * @copyright Copyright (c) Chris Wright + * @license http://www.opensource.org/licenses/mit-license.html MIT License + * @version 2.0.0 */ namespace LibDNS\Encoder; @@ -31,9 +31,9 @@ /** * Encodes Message objects to raw network data * - * @category LibDNS - * @package Encoder - * @author Chris Wright + * @category LibDNS + * @package Encoder + * @author Chris Wright */ class Encoder { @@ -92,7 +92,7 @@ private function encodeHeader(EncodingContext $encodingContext, Message $message /** * Encode an Anything field * - * @param \LibDNS\Records\Types\Anything $anything + * @param \LibDNS\Records\Types\Anything $anything * @return string */ private function encodeAnything(Anything $anything) @@ -103,7 +103,7 @@ private function encodeAnything(Anything $anything) /** * Encode a BitMap field * - * @param \LibDNS\Records\Types\BitMap $bitMap + * @param \LibDNS\Records\Types\BitMap $bitMap * @return string */ private function encodeBitMap(BitMap $bitMap) @@ -114,7 +114,7 @@ private function encodeBitMap(BitMap $bitMap) /** * Encode a Char field * - * @param \LibDNS\Records\Types\Char $char + * @param \LibDNS\Records\Types\Char $char * @return string */ private function encodeChar(Char $char) @@ -209,7 +209,7 @@ private function encodeIPv6Address(IPv6Address $ipv6Address) /** * Encode a Long field * - * @param \LibDNS\Records\Types\Long $long + * @param \LibDNS\Records\Types\Long $long * @return string */ private function encodeLong(Long $long) @@ -220,7 +220,7 @@ private function encodeLong(Long $long) /** * Encode a Short field * - * @param \LibDNS\Records\Types\Short $short + * @param \LibDNS\Records\Types\Short $short * @return string */ private function encodeShort(Short $short) @@ -232,7 +232,7 @@ private function encodeShort(Short $short) * Encode a type object * * @param \LibDNS\Encoder\EncodingContext $encodingContext - * @param \LibDNS\Records\Types\Type $type + * @param \LibDNS\Records\Types\Type $type * @return string */ private function encodeType(EncodingContext $encodingContext, Type $type) @@ -266,7 +266,7 @@ private function encodeType(EncodingContext $encodingContext, Type $type) * Encode a question record * * @param \LibDNS\Encoder\EncodingContext $encodingContext - * @param \LibDNS\Records\Question $record + * @param \LibDNS\Records\Question $record */ private function encodeQuestionRecord(EncodingContext $encodingContext, Question $record) { @@ -288,7 +288,7 @@ private function encodeQuestionRecord(EncodingContext $encodingContext, Question * Encode a resource record * * @param \LibDNS\Encoder\EncodingContext $encodingContext - * @param \LibDNS\Records\Resource $record + * @param \LibDNS\Records\Resource $record */ private function encodeResourceRecord(EncodingContext $encodingContext, Resource $record) { @@ -317,8 +317,7 @@ private function encodeResourceRecord(EncodingContext $encodingContext, Resource * Encode a Message to raw network data * * @param \LibDNS\Messages\Message $message The Message to encode - * @param bool $compress Enable message compression - * + * @param bool $compress Enable message compression * @return string */ public function encode(Message $message, $compress = true) diff --git a/src/LibDNS/Encoder/EncoderFactory.php b/src/LibDNS/Encoder/EncoderFactory.php index 307bb19..1101ca5 100644 --- a/src/LibDNS/Encoder/EncoderFactory.php +++ b/src/LibDNS/Encoder/EncoderFactory.php @@ -4,12 +4,12 @@ * * PHP version 5.4 * - * @category LibDNS - * @package Encoder - * @author Chris Wright - * @copyright Copyright (c) Chris Wright - * @license http://www.opensource.org/licenses/mit-license.html MIT License - * @version 2.0.0 + * @category LibDNS + * @package Encoder + * @author Chris Wright + * @copyright Copyright (c) Chris Wright + * @license http://www.opensource.org/licenses/mit-license.html MIT License + * @version 2.0.0 */ namespace LibDNS\Encoder; @@ -18,9 +18,9 @@ /** * Creates Encoder objects * - * @category LibDNS - * @package Encoder - * @author Chris Wright + * @category LibDNS + * @package Encoder + * @author Chris Wright */ class EncoderFactory { diff --git a/src/LibDNS/Encoder/EncodingContext.php b/src/LibDNS/Encoder/EncodingContext.php index d9b0c8e..cf1f4b0 100644 --- a/src/LibDNS/Encoder/EncodingContext.php +++ b/src/LibDNS/Encoder/EncodingContext.php @@ -4,12 +4,12 @@ * * PHP version 5.4 * - * @category LibDNS - * @package Encoder - * @author Chris Wright - * @copyright Copyright (c) Chris Wright - * @license http://www.opensource.org/licenses/mit-license.html MIT License - * @version 2.0.0 + * @category LibDNS + * @package Encoder + * @author Chris Wright + * @copyright Copyright (c) Chris Wright + * @license http://www.opensource.org/licenses/mit-license.html MIT License + * @version 2.0.0 */ namespace LibDNS\Encoder; @@ -19,9 +19,9 @@ /** * Holds data associated with an encode operation * - * @category LibDNS - * @package Encoder - * @author Chris Wright + * @category LibDNS + * @package Encoder + * @author Chris Wright */ class EncodingContext { @@ -48,9 +48,9 @@ class EncodingContext /** * Constructor * - * @param \LibDNS\Packets\Packet $packet + * @param \LibDNS\Packets\Packet $packet * @param \LibDNS\Packets\LabelRegistry $labelRegistry - * @param bool $compress + * @param bool $compress */ public function __construct(Packet $packet, LabelRegistry $labelRegistry, $compress) { diff --git a/src/LibDNS/Encoder/EncodingContextFactory.php b/src/LibDNS/Encoder/EncodingContextFactory.php index fe3a742..76f5abf 100644 --- a/src/LibDNS/Encoder/EncodingContextFactory.php +++ b/src/LibDNS/Encoder/EncodingContextFactory.php @@ -4,12 +4,12 @@ * * PHP version 5.4 * - * @category LibDNS - * @package Encoder - * @author Chris Wright - * @copyright Copyright (c) Chris Wright - * @license http://www.opensource.org/licenses/mit-license.html MIT License - * @version 2.0.0 + * @category LibDNS + * @package Encoder + * @author Chris Wright + * @copyright Copyright (c) Chris Wright + * @license http://www.opensource.org/licenses/mit-license.html MIT License + * @version 2.0.0 */ namespace LibDNS\Encoder; @@ -19,9 +19,9 @@ /** * Creates EncodingContext objects * - * @category LibDNS - * @package Encoder - * @author Chris Wright + * @category LibDNS + * @package Encoder + * @author Chris Wright */ class EncodingContextFactory { @@ -29,8 +29,7 @@ class EncodingContextFactory * Create a new EncodingContext object * * @param \LibDNS\Packets\Packet $packet The packet to be decoded - * @param bool $compress Whether message compression is enabled - * + * @param bool $compress Whether message compression is enabled * @return \LibDNS\Encoder\EncodingContext */ public function create(Packet $packet, $compress) diff --git a/src/LibDNS/Enumeration.php b/src/LibDNS/Enumeration.php index 141afbc..02ec46d 100644 --- a/src/LibDNS/Enumeration.php +++ b/src/LibDNS/Enumeration.php @@ -4,21 +4,21 @@ * * PHP version 5.4 * - * @category LibDNS - * @package LibDNS - * @author Chris Wright - * @copyright Copyright (c) Chris Wright - * @license http://www.opensource.org/licenses/mit-license.html MIT License - * @version 2.0.0 + * @category LibDNS + * @package LibDNS + * @author Chris Wright + * @copyright Copyright (c) Chris Wright + * @license http://www.opensource.org/licenses/mit-license.html MIT License + * @version 2.0.0 */ namespace LibDNS; /** * Base class for enumerations to prevent instantiation * - * @category LibDNS - * @package LibDNS - * @author Chris Wright + * @category LibDNS + * @package LibDNS + * @author Chris Wright */ class Enumeration { diff --git a/src/LibDNS/Messages/Message.php b/src/LibDNS/Messages/Message.php index ec0afc9..1667ebe 100644 --- a/src/LibDNS/Messages/Message.php +++ b/src/LibDNS/Messages/Message.php @@ -4,12 +4,12 @@ * * PHP version 5.4 * - * @category LibDNS - * @package Messages - * @author Chris Wright - * @copyright Copyright (c) Chris Wright - * @license http://www.opensource.org/licenses/mit-license.html MIT License - * @version 2.0.0 + * @category LibDNS + * @package Messages + * @author Chris Wright + * @copyright Copyright (c) Chris Wright + * @license http://www.opensource.org/licenses/mit-license.html MIT License + * @version 2.0.0 */ namespace LibDNS\Messages; @@ -19,9 +19,9 @@ /** * Represents a DNS protocol message * - * @category LibDNS - * @package Messages - * @author Chris Wright + * @category LibDNS + * @package Messages + * @author Chris Wright */ class Message { @@ -89,8 +89,7 @@ class Message * Constructor * * @param \LibDNS\Records\RecordCollectionFactory $recordCollectionFactory Factory which makes RecordCollection objects - * @param int $type Value of the message type field - * + * @param int $type Value of the message type field * @throws \RangeException When the supplied message type is outside the valid range 0 - 1 */ public function __construct(RecordCollectionFactory $recordCollectionFactory, $type = null) @@ -119,7 +118,6 @@ public function getID() * Set the value of the message ID field * * @param int $id The new value - * * @throws \RangeException When the supplied value is outside the valid range 0 - 65535 */ public function setID($id) @@ -146,7 +144,6 @@ public function getType() * Set the value of the message type field * * @param int $type The new value - * * @throws \RangeException When the supplied value is outside the valid range 0 - 1 */ public function setType($type) @@ -173,7 +170,6 @@ public function getOpCode() * Set the value of the message opcode field * * @param int $opCode The new value - * * @throws \RangeException When the supplied value is outside the valid range 0 - 15 */ public function setOpCode($opCode) @@ -190,7 +186,6 @@ public function setOpCode($opCode) * Inspect the value of the authoritative field and optionally set a new value * * @param bool $newValue The new value - * * @return bool The old value */ public function isAuthoritative($newValue = null) @@ -208,7 +203,6 @@ public function isAuthoritative($newValue = null) * Inspect the value of the truncated field and optionally set a new value * * @param bool $newValue The new value - * * @return bool The old value */ public function isTruncated($newValue = null) @@ -226,7 +220,6 @@ public function isTruncated($newValue = null) * Inspect the value of the recusion desired field and optionally set a new value * * @param bool $newValue The new value - * * @return bool The old value */ public function isRecursionDesired($newValue = null) @@ -244,7 +237,6 @@ public function isRecursionDesired($newValue = null) * Inspect the value of the recursion available field and optionally set a new value * * @param bool $newValue The new value - * * @return bool The old value */ public function isRecursionAvailable($newValue = null) @@ -272,7 +264,6 @@ public function getResponseCode() * Set the value of the message response code field * * @param int $responseCode The new value - * * @throws \RangeException When the supplied value is outside the valid range 0 - 15 */ public function setResponseCode($responseCode) diff --git a/src/LibDNS/Messages/MessageFactory.php b/src/LibDNS/Messages/MessageFactory.php index 8d49124..e393163 100644 --- a/src/LibDNS/Messages/MessageFactory.php +++ b/src/LibDNS/Messages/MessageFactory.php @@ -4,12 +4,12 @@ * * PHP version 5.4 * - * @category LibDNS - * @package Messages - * @author Chris Wright - * @copyright Copyright (c) Chris Wright - * @license http://www.opensource.org/licenses/mit-license.html MIT License - * @version 2.0.0 + * @category LibDNS + * @package Messages + * @author Chris Wright + * @copyright Copyright (c) Chris Wright + * @license http://www.opensource.org/licenses/mit-license.html MIT License + * @version 2.0.0 */ namespace LibDNS\Messages; @@ -18,9 +18,9 @@ /** * Factory which creates Message objects * - * @category LibDNS - * @package Messages - * @author Chris Wright + * @category LibDNS + * @package Messages + * @author Chris Wright */ class MessageFactory { @@ -28,7 +28,6 @@ class MessageFactory * Create a new Message object * * @param int $type Value of the message type field - * * @return \LibDNS\Messages\Message */ public function create($type = null) diff --git a/src/LibDNS/Messages/MessageOpCodes.php b/src/LibDNS/Messages/MessageOpCodes.php index 6346857..54f8e1e 100644 --- a/src/LibDNS/Messages/MessageOpCodes.php +++ b/src/LibDNS/Messages/MessageOpCodes.php @@ -4,12 +4,12 @@ * * PHP version 5.4 * - * @category LibDNS - * @package Messages - * @author Chris Wright - * @copyright Copyright (c) Chris Wright - * @license http://www.opensource.org/licenses/mit-license.html MIT License - * @version 2.0.0 + * @category LibDNS + * @package Messages + * @author Chris Wright + * @copyright Copyright (c) Chris Wright + * @license http://www.opensource.org/licenses/mit-license.html MIT License + * @version 2.0.0 */ namespace LibDNS\Messages; @@ -18,9 +18,9 @@ /** * Enumeration of possible message types * - * @category LibDNS - * @package Messages - * @author Chris Wright + * @category LibDNS + * @package Messages + * @author Chris Wright */ class MessageOpCodes extends Enumeration { diff --git a/src/LibDNS/Messages/MessageResponseCodes.php b/src/LibDNS/Messages/MessageResponseCodes.php index 9ac50c2..cf4f271 100644 --- a/src/LibDNS/Messages/MessageResponseCodes.php +++ b/src/LibDNS/Messages/MessageResponseCodes.php @@ -4,12 +4,12 @@ * * PHP version 5.4 * - * @category LibDNS - * @package Messages - * @author Chris Wright - * @copyright Copyright (c) Chris Wright - * @license http://www.opensource.org/licenses/mit-license.html MIT License - * @version 2.0.0 + * @category LibDNS + * @package Messages + * @author Chris Wright + * @copyright Copyright (c) Chris Wright + * @license http://www.opensource.org/licenses/mit-license.html MIT License + * @version 2.0.0 */ namespace LibDNS\Messages; @@ -18,9 +18,9 @@ /** * Enumeration of possible message types * - * @category LibDNS - * @package Messages - * @author Chris Wright + * @category LibDNS + * @package Messages + * @author Chris Wright */ class MessageResponseCodes extends Enumeration { diff --git a/src/LibDNS/Messages/MessageTypes.php b/src/LibDNS/Messages/MessageTypes.php index 8a4721d..f36c05a 100644 --- a/src/LibDNS/Messages/MessageTypes.php +++ b/src/LibDNS/Messages/MessageTypes.php @@ -4,12 +4,12 @@ * * PHP version 5.4 * - * @category LibDNS - * @package Messages - * @author Chris Wright - * @copyright Copyright (c) Chris Wright - * @license http://www.opensource.org/licenses/mit-license.html MIT License - * @version 2.0.0 + * @category LibDNS + * @package Messages + * @author Chris Wright + * @copyright Copyright (c) Chris Wright + * @license http://www.opensource.org/licenses/mit-license.html MIT License + * @version 2.0.0 */ namespace LibDNS\Messages; @@ -18,9 +18,9 @@ /** * Enumeration of possible message types * - * @category LibDNS - * @package Messages - * @author Chris Wright + * @category LibDNS + * @package Messages + * @author Chris Wright */ class MessageTypes extends Enumeration { diff --git a/src/LibDNS/Packets/LabelRegistry.php b/src/LibDNS/Packets/LabelRegistry.php index d12d198..a836648 100644 --- a/src/LibDNS/Packets/LabelRegistry.php +++ b/src/LibDNS/Packets/LabelRegistry.php @@ -5,21 +5,21 @@ * * PHP version 5.4 * - * @category LibDNS - * @package Packets - * @author Chris Wright - * @copyright Copyright (c) Chris Wright - * @license http://www.opensource.org/licenses/mit-license.html MIT License - * @version 2.0.0 + * @category LibDNS + * @package Packets + * @author Chris Wright + * @copyright Copyright (c) Chris Wright + * @license http://www.opensource.org/licenses/mit-license.html MIT License + * @version 2.0.0 */ namespace LibDNS\Packets; /** * Creates Packet objects * - * @category LibDNS - * @package Packets - * @author Chris Wright + * @category LibDNS + * @package Packets + * @author Chris Wright */ class LabelRegistry { @@ -60,7 +60,6 @@ public function register($labels, $index) * Lookup the index of a label * * @param string $label - * * @return int|null */ public function lookupIndex($label) @@ -72,7 +71,6 @@ public function lookupIndex($label) * Lookup the label at an index * * @param int $index - * * @return string[]|null */ public function lookupLabel($index) diff --git a/src/LibDNS/Packets/Packet.php b/src/LibDNS/Packets/Packet.php index 91ebc85..3bd0570 100644 --- a/src/LibDNS/Packets/Packet.php +++ b/src/LibDNS/Packets/Packet.php @@ -4,21 +4,21 @@ * * PHP version 5.4 * - * @category LibDNS - * @package Packets - * @author Chris Wright - * @copyright Copyright (c) Chris Wright - * @license http://www.opensource.org/licenses/mit-license.html MIT License - * @version 2.0.0 + * @category LibDNS + * @package Packets + * @author Chris Wright + * @copyright Copyright (c) Chris Wright + * @license http://www.opensource.org/licenses/mit-license.html MIT License + * @version 2.0.0 */ namespace LibDNS\Packets; /** * Represents a raw network data packet * - * @category LibDNS - * @package Packets - * @author Chris Wright + * @category LibDNS + * @package Packets + * @author Chris Wright */ class Packet { @@ -81,7 +81,6 @@ public function read($length = null) * Append data to the packet * * @param string $data The data to append - * * @return int The number of bytes written */ public function write($data) diff --git a/src/LibDNS/Packets/PacketFactory.php b/src/LibDNS/Packets/PacketFactory.php index 98ad9f4..4e4566c 100644 --- a/src/LibDNS/Packets/PacketFactory.php +++ b/src/LibDNS/Packets/PacketFactory.php @@ -4,21 +4,21 @@ * * PHP version 5.4 * - * @category LibDNS - * @package Packets - * @author Chris Wright - * @copyright Copyright (c) Chris Wright - * @license http://www.opensource.org/licenses/mit-license.html MIT License - * @version 2.0.0 + * @category LibDNS + * @package Packets + * @author Chris Wright + * @copyright Copyright (c) Chris Wright + * @license http://www.opensource.org/licenses/mit-license.html MIT License + * @version 2.0.0 */ namespace LibDNS\Packets; /** * Creates Packet objects * - * @category LibDNS - * @package Packets - * @author Chris Wright + * @category LibDNS + * @package Packets + * @author Chris Wright */ class PacketFactory { diff --git a/src/LibDNS/Records/Question.php b/src/LibDNS/Records/Question.php index c6a0e2d..4c1580f 100644 --- a/src/LibDNS/Records/Question.php +++ b/src/LibDNS/Records/Question.php @@ -4,12 +4,12 @@ * * PHP version 5.4 * - * @category LibDNS - * @package Records - * @author Chris Wright - * @copyright Copyright (c) Chris Wright - * @license http://www.opensource.org/licenses/mit-license.html MIT License - * @version 2.0.0 + * @category LibDNS + * @package Records + * @author Chris Wright + * @copyright Copyright (c) Chris Wright + * @license http://www.opensource.org/licenses/mit-license.html MIT License + * @version 2.0.0 */ namespace LibDNS\Records; @@ -18,9 +18,9 @@ /** * Represents a DNS question record * - * @category LibDNS - * @package Records - * @author Chris Wright + * @category LibDNS + * @package Records + * @author Chris Wright */ class Question extends Record { diff --git a/src/LibDNS/Records/QuestionFactory.php b/src/LibDNS/Records/QuestionFactory.php index f84662e..edb7ca0 100644 --- a/src/LibDNS/Records/QuestionFactory.php +++ b/src/LibDNS/Records/QuestionFactory.php @@ -4,12 +4,12 @@ * * PHP version 5.4 * - * @category LibDNS - * @package Records - * @author Chris Wright - * @copyright Copyright (c) Chris Wright - * @license http://www.opensource.org/licenses/mit-license.html MIT License - * @version 2.0.0 + * @category LibDNS + * @package Records + * @author Chris Wright + * @copyright Copyright (c) Chris Wright + * @license http://www.opensource.org/licenses/mit-license.html MIT License + * @version 2.0.0 */ namespace LibDNS\Records; @@ -18,9 +18,9 @@ /** * Creates Question objects * - * @category LibDNS - * @package Records - * @author Chris Wright + * @category LibDNS + * @package Records + * @author Chris Wright */ class QuestionFactory { @@ -28,7 +28,6 @@ class QuestionFactory * Create a new Question object * * @param int $type The resource type - * * @return \LibDNS\Records\Question */ public function create($type) diff --git a/src/LibDNS/Records/RData.php b/src/LibDNS/Records/RData.php index 470268f..9f61196 100644 --- a/src/LibDNS/Records/RData.php +++ b/src/LibDNS/Records/RData.php @@ -4,12 +4,12 @@ * * PHP version 5.4 * - * @category LibDNS - * @package Records - * @author Chris Wright - * @copyright Copyright (c) Chris Wright - * @license http://www.opensource.org/licenses/mit-license.html MIT License - * @version 2.0.0 + * @category LibDNS + * @package Records + * @author Chris Wright + * @copyright Copyright (c) Chris Wright + * @license http://www.opensource.org/licenses/mit-license.html MIT License + * @version 2.0.0 */ namespace LibDNS\Records; @@ -19,9 +19,9 @@ /** * Represents a data type comprising multiple simple types * - * @category LibDNS - * @package Records - * @author Chris Wright + * @category LibDNS + * @package Records + * @author Chris Wright */ class RData implements \Iterator, \Countable { @@ -70,9 +70,7 @@ public function __toString() * Get the field indicated by the supplied index * * @param int $index - * * @return \LibDNS\Records\Types\Type - * * @throws \OutOfBoundsException When the supplied index does not refer to a valid field */ public function getField($index) @@ -87,9 +85,8 @@ public function getField($index) /** * Set the field indicated by the supplied index * - * @param int $index + * @param int $index * @param \LibDNS\Records\Types\Type $value - * * @throws \InvalidArgumentException When the supplied index/value pair does not match the type definition */ public function setField($index, Type $value) @@ -105,9 +102,7 @@ public function setField($index, Type $value) * Get the field indicated by the supplied name * * @param string $name - * * @return \LibDNS\Records\Types\Type - * * @throws \OutOfBoundsException When the supplied name does not refer to a valid field */ public function getFieldByName($name) @@ -118,10 +113,9 @@ public function getFieldByName($name) /** * Set the field indicated by the supplied name * - * @param string $name + * @param string $name * @param \LibDNS\Records\Types\Type $value - * - * @throws \OutOfBoundsException When the supplied name does not refer to a valid field + * @throws \OutOfBoundsException When the supplied name does not refer to a valid field * @throws \InvalidArgumentException When the supplied value does not match the type definition */ public function setFieldByName($name, Type $value) diff --git a/src/LibDNS/Records/RDataBuilder.php b/src/LibDNS/Records/RDataBuilder.php index 26b9d2a..6bebf00 100644 --- a/src/LibDNS/Records/RDataBuilder.php +++ b/src/LibDNS/Records/RDataBuilder.php @@ -4,12 +4,12 @@ * * PHP version 5.4 * - * @category LibDNS - * @package Records - * @author Chris Wright - * @copyright Copyright (c) Chris Wright - * @license http://www.opensource.org/licenses/mit-license.html MIT License - * @version 2.0.0 + * @category LibDNS + * @package Records + * @author Chris Wright + * @copyright Copyright (c) Chris Wright + * @license http://www.opensource.org/licenses/mit-license.html MIT License + * @version 2.0.0 */ namespace LibDNS\Records; @@ -19,9 +19,9 @@ /** * Creates RData objects * - * @category LibDNS - * @package Records - * @author Chris Wright + * @category LibDNS + * @package Records + * @author Chris Wright */ class RDataBuilder { @@ -38,7 +38,7 @@ class RDataBuilder /** * Constructor * - * @param \LibDNS\Records\RDataFactory $rDataFactory + * @param \LibDNS\Records\RDataFactory $rDataFactory * @param \LibDNS\Records\Types\TypeBuilder $typeBuilder */ public function __construct(RDataFactory $rDataFactory, TypeBuilder $typeBuilder) @@ -51,7 +51,6 @@ public function __construct(RDataFactory $rDataFactory, TypeBuilder $typeBuilder * Create a new RData object * * @param \LibDNS\Records\TypeDefinitions\TypeDefinition $typeDefinition - * * @return \LibDNS\Records\RData */ public function build(TypeDefinition $typeDefinition) diff --git a/src/LibDNS/Records/RDataFactory.php b/src/LibDNS/Records/RDataFactory.php index 6b2bf0f..133e869 100644 --- a/src/LibDNS/Records/RDataFactory.php +++ b/src/LibDNS/Records/RDataFactory.php @@ -4,12 +4,12 @@ * * PHP version 5.4 * - * @category LibDNS - * @package Records - * @author Chris Wright - * @copyright Copyright (c) Chris Wright - * @license http://www.opensource.org/licenses/mit-license.html MIT License - * @version 2.0.0 + * @category LibDNS + * @package Records + * @author Chris Wright + * @copyright Copyright (c) Chris Wright + * @license http://www.opensource.org/licenses/mit-license.html MIT License + * @version 2.0.0 */ namespace LibDNS\Records; @@ -18,9 +18,9 @@ /** * Creates RData objects * - * @category LibDNS - * @package Records - * @author Chris Wright + * @category LibDNS + * @package Records + * @author Chris Wright */ class RDataFactory { diff --git a/src/LibDNS/Records/Record.php b/src/LibDNS/Records/Record.php index 066dfad..ec9a97a 100644 --- a/src/LibDNS/Records/Record.php +++ b/src/LibDNS/Records/Record.php @@ -4,12 +4,12 @@ * * PHP version 5.4 * - * @category LibDNS - * @package Records - * @author Chris Wright - * @copyright Copyright (c) Chris Wright - * @license http://www.opensource.org/licenses/mit-license.html MIT License - * @version 2.0.0 + * @category LibDNS + * @package Records + * @author Chris Wright + * @copyright Copyright (c) Chris Wright + * @license http://www.opensource.org/licenses/mit-license.html MIT License + * @version 2.0.0 */ namespace LibDNS\Records; @@ -18,9 +18,9 @@ /** * Represents a DNS record * - * @category LibDNS - * @package Records - * @author Chris Wright + * @category LibDNS + * @package Records + * @author Chris Wright */ abstract class Record { @@ -58,7 +58,6 @@ public function getName() * Set the value of the record name field * * @param string|\LibDNS\Records\Types\DomainName $name - * * @throws \UnexpectedValueException When the supplied value is not a valid domain name */ public function setName($name) @@ -94,7 +93,6 @@ public function getClass() * Set the value of the record class field * * @param int $class The new value, can be indicated using the ResourceClasses/ResourceQClasses enums - * * @throws \RangeException When the supplied value is outside the valid range 0 - 65535 */ public function setClass($class) diff --git a/src/LibDNS/Records/RecordCollection.php b/src/LibDNS/Records/RecordCollection.php index 4bd2b4f..a0de99a 100644 --- a/src/LibDNS/Records/RecordCollection.php +++ b/src/LibDNS/Records/RecordCollection.php @@ -4,21 +4,21 @@ * * PHP version 5.4 * - * @category LibDNS - * @package Records - * @author Chris Wright - * @copyright Copyright (c) Chris Wright - * @license http://www.opensource.org/licenses/mit-license.html MIT License - * @version 2.0.0 + * @category LibDNS + * @package Records + * @author Chris Wright + * @copyright Copyright (c) Chris Wright + * @license http://www.opensource.org/licenses/mit-license.html MIT License + * @version 2.0.0 */ namespace LibDNS\Records; /** * Collection of Record objects * - * @category LibDNS - * @package Records - * @author Chris Wright + * @category LibDNS + * @package Records + * @author Chris Wright */ class RecordCollection implements \Iterator, \Countable { @@ -51,7 +51,6 @@ class RecordCollection implements \Iterator, \Countable * Constructor * * @param int $type Can be indicated using the RecordTypes enum - * * @throws \InvalidArgumentException When the specified record type is invalid */ public function __construct($type) @@ -102,7 +101,6 @@ private function removeFromNameMap(Record $record) * Add a record to the collection * * @param \LibDNS\Records\Record $record The record to add - * * @throws \InvalidArgumentException When the wrong record type is supplied */ public function add(Record $record) @@ -140,8 +138,7 @@ public function remove(Record $record) * Test whether the collection contains a specific record * * @param \LibDNS\Records\Record $record The record to search for - * @param bool $sameInstance Whether to perform strict comparisons in search - * + * @param bool $sameInstance Whether to perform strict comparisons in search * @return bool */ public function contains(Record $record, $sameInstance = false) @@ -153,7 +150,6 @@ public function contains(Record $record, $sameInstance = false) * Get all records in the collection that refer to the specified name * * @param string $name The name to match records against - * * @return \LibDNS\Records\Record[] */ public function getRecordsByName($name) @@ -165,9 +161,7 @@ public function getRecordsByName($name) * Get a record from the collection by index * * @param int $index Record index - * * @return \LibDNS\Records\Record - * * @throws \OutOfBoundsException When the supplied index does not refer to a valid record */ public function getRecordByIndex($index) @@ -183,7 +177,6 @@ public function getRecordByIndex($index) * Remove all records in the collection that refer to the specified name * * @param string $name The name to match records against - * * @return int The number of records removed */ public function clearRecordsByName($name) @@ -239,7 +232,6 @@ public function getType() * Get the record indicated by the iteration pointer (Iterator interface) * * @return \LibDNS\Records\Record - * * @throws \OutOfBoundsException When the pointer does not refer to a valid record */ public function current() diff --git a/src/LibDNS/Records/RecordCollectionFactory.php b/src/LibDNS/Records/RecordCollectionFactory.php index deaa2d7..9f18840 100644 --- a/src/LibDNS/Records/RecordCollectionFactory.php +++ b/src/LibDNS/Records/RecordCollectionFactory.php @@ -4,21 +4,21 @@ * * PHP version 5.4 * - * @category LibDNS - * @package Records - * @author Chris Wright - * @copyright Copyright (c) Chris Wright - * @license http://www.opensource.org/licenses/mit-license.html MIT License - * @version 2.0.0 + * @category LibDNS + * @package Records + * @author Chris Wright + * @copyright Copyright (c) Chris Wright + * @license http://www.opensource.org/licenses/mit-license.html MIT License + * @version 2.0.0 */ namespace LibDNS\Records; /** * Creates RecordCollection objects * - * @category LibDNS - * @package Records - * @author Chris Wright + * @category LibDNS + * @package Records + * @author Chris Wright */ class RecordCollectionFactory { @@ -26,9 +26,7 @@ class RecordCollectionFactory * Create a new RecordCollection object * * @param int $type Can be indicated using the RecordTypes enum - * * @return \LibDNS\Records\RecordCollection - * * @throws \InvalidArgumentException When the specified record type is invalid */ public function create($type) diff --git a/src/LibDNS/Records/RecordTypes.php b/src/LibDNS/Records/RecordTypes.php index 5a4d9b0..c81f3eb 100644 --- a/src/LibDNS/Records/RecordTypes.php +++ b/src/LibDNS/Records/RecordTypes.php @@ -4,12 +4,12 @@ * * PHP version 5.4 * - * @category LibDNS - * @package Records - * @author Chris Wright - * @copyright Copyright (c) Chris Wright - * @license http://www.opensource.org/licenses/mit-license.html MIT License - * @version 2.0.0 + * @category LibDNS + * @package Records + * @author Chris Wright + * @copyright Copyright (c) Chris Wright + * @license http://www.opensource.org/licenses/mit-license.html MIT License + * @version 2.0.0 */ namespace LibDNS\Records; @@ -18,9 +18,9 @@ /** * Enumeration of possible record types * - * @category LibDNS - * @package Records - * @author Chris Wright + * @category LibDNS + * @package Records + * @author Chris Wright */ class RecordTypes extends Enumeration { diff --git a/src/LibDNS/Records/Resource.php b/src/LibDNS/Records/Resource.php index bea196d..1404e0a 100644 --- a/src/LibDNS/Records/Resource.php +++ b/src/LibDNS/Records/Resource.php @@ -4,12 +4,12 @@ * * PHP version 5.4 * - * @category LibDNS - * @package Records - * @author Chris Wright - * @copyright Copyright (c) Chris Wright - * @license http://www.opensource.org/licenses/mit-license.html MIT License - * @version 2.0.0 + * @category LibDNS + * @package Records + * @author Chris Wright + * @copyright Copyright (c) Chris Wright + * @license http://www.opensource.org/licenses/mit-license.html MIT License + * @version 2.0.0 */ namespace LibDNS\Records; @@ -18,9 +18,9 @@ /** * Represents a DNS resource record * - * @category LibDNS - * @package Records - * @author Chris Wright + * @category LibDNS + * @package Records + * @author Chris Wright */ class Resource extends Record { @@ -62,7 +62,6 @@ public function getTTL() * Set the value of the record TTL field * * @param int $ttl The new value - * * @throws \RangeException When the supplied value is outside the valid range 0 - 4294967296 */ public function setTTL($ttl) diff --git a/src/LibDNS/Records/ResourceBuilder.php b/src/LibDNS/Records/ResourceBuilder.php index 7f59bd6..8addc4a 100644 --- a/src/LibDNS/Records/ResourceBuilder.php +++ b/src/LibDNS/Records/ResourceBuilder.php @@ -4,12 +4,12 @@ * * PHP version 5.4 * - * @category LibDNS - * @package Records - * @author Chris Wright - * @copyright Copyright (c) Chris Wright - * @license http://www.opensource.org/licenses/mit-license.html MIT License - * @version 2.0.0 + * @category LibDNS + * @package Records + * @author Chris Wright + * @copyright Copyright (c) Chris Wright + * @license http://www.opensource.org/licenses/mit-license.html MIT License + * @version 2.0.0 */ namespace LibDNS\Records; @@ -18,9 +18,9 @@ /** * Builds Resource objects of a specific type * - * @category LibDNS - * @package Records - * @author Chris Wright + * @category LibDNS + * @package Records + * @author Chris Wright */ class ResourceBuilder { @@ -42,8 +42,8 @@ class ResourceBuilder /** * Constructor * - * @param \LibDNS\Records\ResourceFactory $resourceFactory - * @param \LibDNS\Records\RDataBuilder $rDataBuilder + * @param \LibDNS\Records\ResourceFactory $resourceFactory + * @param \LibDNS\Records\RDataBuilder $rDataBuilder * @param \LibDNS\Records\TypeDefinitions\TypeDefinitionManager $typeDefinitionManager */ public function __construct(ResourceFactory $resourceFactory, RDataBuilder $rDataBuilder, TypeDefinitionManager $typeDefinitionManager) @@ -57,7 +57,6 @@ public function __construct(ResourceFactory $resourceFactory, RDataBuilder $rDat * Create a new Resource object * * @param int $type Type of the resource, can be indicated using the ResourceTypes enum - * * @return \LibDNS\Records\Resource */ public function build($type) diff --git a/src/LibDNS/Records/ResourceBuilderFactory.php b/src/LibDNS/Records/ResourceBuilderFactory.php index 13a22a7..3c7ec1d 100644 --- a/src/LibDNS/Records/ResourceBuilderFactory.php +++ b/src/LibDNS/Records/ResourceBuilderFactory.php @@ -4,12 +4,12 @@ * * PHP version 5.4 * - * @category LibDNS - * @package Records - * @author Chris Wright - * @copyright Copyright (c) Chris Wright - * @license http://www.opensource.org/licenses/mit-license.html MIT License - * @version 2.0.0 + * @category LibDNS + * @package Records + * @author Chris Wright + * @copyright Copyright (c) Chris Wright + * @license http://www.opensource.org/licenses/mit-license.html MIT License + * @version 2.0.0 */ namespace LibDNS\Records; @@ -22,9 +22,9 @@ /** * Creates ResourceBuilder objects * - * @category LibDNS - * @package Records - * @author Chris Wright + * @category LibDNS + * @package Records + * @author Chris Wright */ class ResourceBuilderFactory { @@ -32,7 +32,6 @@ class ResourceBuilderFactory * Create a new ResourceBuilder object * * @param \LibDNS\Records\TypeDefinitions\TypeDefinitionManager $typeDefinitionManager - * * @return \LibDNS\Records\ResourceBuilder */ public function create(TypeDefinitionManager $typeDefinitionManager = null) diff --git a/src/LibDNS/Records/ResourceClasses.php b/src/LibDNS/Records/ResourceClasses.php index bd0d8dd..cc1e056 100644 --- a/src/LibDNS/Records/ResourceClasses.php +++ b/src/LibDNS/Records/ResourceClasses.php @@ -4,12 +4,12 @@ * * PHP version 5.4 * - * @category LibDNS - * @package Records - * @author Chris Wright - * @copyright Copyright (c) Chris Wright - * @license http://www.opensource.org/licenses/mit-license.html MIT License - * @version 2.0.0 + * @category LibDNS + * @package Records + * @author Chris Wright + * @copyright Copyright (c) Chris Wright + * @license http://www.opensource.org/licenses/mit-license.html MIT License + * @version 2.0.0 */ namespace LibDNS\Records; @@ -18,9 +18,9 @@ /** * Enumeration of possible resource CLASS values * - * @category LibDNS - * @package Records - * @author Chris Wright + * @category LibDNS + * @package Records + * @author Chris Wright */ class ResourceClasses extends Enumeration { diff --git a/src/LibDNS/Records/ResourceFactory.php b/src/LibDNS/Records/ResourceFactory.php index 6c7f14f..72456aa 100644 --- a/src/LibDNS/Records/ResourceFactory.php +++ b/src/LibDNS/Records/ResourceFactory.php @@ -4,12 +4,12 @@ * * PHP version 5.4 * - * @category LibDNS - * @package Records - * @author Chris Wright - * @copyright Copyright (c) Chris Wright - * @license http://www.opensource.org/licenses/mit-license.html MIT License - * @version 2.0.0 + * @category LibDNS + * @package Records + * @author Chris Wright + * @copyright Copyright (c) Chris Wright + * @license http://www.opensource.org/licenses/mit-license.html MIT License + * @version 2.0.0 */ namespace LibDNS\Records; @@ -18,18 +18,17 @@ /** * Creates Resource objects * - * @category LibDNS - * @package Records - * @author Chris Wright + * @category LibDNS + * @package Records + * @author Chris Wright */ class ResourceFactory { /** * Create a new Resource object * - * @param int $type Can be indicated using the ResourceTypes enum + * @param int $type Can be indicated using the ResourceTypes enum * @param \LibDNS\Records\RData $data - * * @return \LibDNS\Records\Resource */ public function create($type, $data) diff --git a/src/LibDNS/Records/ResourceQClasses.php b/src/LibDNS/Records/ResourceQClasses.php index 7aae1e5..82f2e2f 100644 --- a/src/LibDNS/Records/ResourceQClasses.php +++ b/src/LibDNS/Records/ResourceQClasses.php @@ -4,21 +4,21 @@ * * PHP version 5.4 * - * @category LibDNS - * @package Records - * @author Chris Wright - * @copyright Copyright (c) Chris Wright - * @license http://www.opensource.org/licenses/mit-license.html MIT License - * @version 2.0.0 + * @category LibDNS + * @package Records + * @author Chris Wright + * @copyright Copyright (c) Chris Wright + * @license http://www.opensource.org/licenses/mit-license.html MIT License + * @version 2.0.0 */ namespace LibDNS\Records; /** * Enumeration of possible resource QCLASS values * - * @category LibDNS - * @package Records - * @author Chris Wright + * @category LibDNS + * @package Records + * @author Chris Wright */ class ResourceQClasses extends ResourceClasses { diff --git a/src/LibDNS/Records/ResourceQTypes.php b/src/LibDNS/Records/ResourceQTypes.php index 186d1bc..7eccc77 100644 --- a/src/LibDNS/Records/ResourceQTypes.php +++ b/src/LibDNS/Records/ResourceQTypes.php @@ -4,21 +4,21 @@ * * PHP version 5.4 * - * @category LibDNS - * @package Records - * @author Chris Wright - * @copyright Copyright (c) Chris Wright - * @license http://www.opensource.org/licenses/mit-license.html MIT License - * @version 2.0.0 + * @category LibDNS + * @package Records + * @author Chris Wright + * @copyright Copyright (c) Chris Wright + * @license http://www.opensource.org/licenses/mit-license.html MIT License + * @version 2.0.0 */ namespace LibDNS\Records; /** * Enumeration of possible resource QTYPE values * - * @category LibDNS - * @package Records - * @author Chris Wright + * @category LibDNS + * @package Records + * @author Chris Wright */ class ResourceQTypes extends ResourceTypes { diff --git a/src/LibDNS/Records/ResourceTypes.php b/src/LibDNS/Records/ResourceTypes.php index 351816c..ccb7955 100644 --- a/src/LibDNS/Records/ResourceTypes.php +++ b/src/LibDNS/Records/ResourceTypes.php @@ -4,12 +4,12 @@ * * PHP version 5.4 * - * @category LibDNS - * @package Records - * @author Chris Wright - * @copyright Copyright (c) Chris Wright - * @license http://www.opensource.org/licenses/mit-license.html MIT License - * @version 2.0.0 + * @category LibDNS + * @package Records + * @author Chris Wright + * @copyright Copyright (c) Chris Wright + * @license http://www.opensource.org/licenses/mit-license.html MIT License + * @version 2.0.0 */ namespace LibDNS\Records; @@ -18,9 +18,9 @@ /** * Enumeration of possible resource TYPE values * - * @category LibDNS - * @package Records - * @author Chris Wright + * @category LibDNS + * @package Records + * @author Chris Wright */ class ResourceTypes extends Enumeration { diff --git a/src/LibDNS/Records/TypeDefinitions/FieldDefinition.php b/src/LibDNS/Records/TypeDefinitions/FieldDefinition.php index db781bd..e15a0a0 100644 --- a/src/LibDNS/Records/TypeDefinitions/FieldDefinition.php +++ b/src/LibDNS/Records/TypeDefinitions/FieldDefinition.php @@ -4,12 +4,12 @@ * * PHP version 5.4 * - * @category LibDNS - * @package TypeDefinitions - * @author Chris Wright - * @copyright Copyright (c) Chris Wright - * @license http://www.opensource.org/licenses/mit-license.html MIT License - * @version 2.0.0 + * @category LibDNS + * @package TypeDefinitions + * @author Chris Wright + * @copyright Copyright (c) Chris Wright + * @license http://www.opensource.org/licenses/mit-license.html MIT License + * @version 2.0.0 */ namespace LibDNS\Records\TypeDefinitions; @@ -28,9 +28,9 @@ /** * Defines a field in a type * - * @category LibDNS - * @package TypeDefinitions - * @author Chris Wright + * @category LibDNS + * @package TypeDefinitions + * @author Chris Wright */ class FieldDefinition { @@ -62,11 +62,11 @@ class FieldDefinition /** * Constructor * - * @param int $index + * @param int $index * @param string $name - * @param int $type - * @param bool $allowsMultiple - * @param int $minimumValues + * @param int $type + * @param bool $allowsMultiple + * @param int $minimumValues */ public function __construct($index, $name, $type, $allowsMultiple, $minimumValues) { @@ -131,7 +131,6 @@ public function getMinimumValues() * Assert that a Type object is valid for this field * * @param \LibDNS\Records\Types\Type - * * @return bool */ public function assertDataValid(Type $value) diff --git a/src/LibDNS/Records/TypeDefinitions/FieldDefinitionFactory.php b/src/LibDNS/Records/TypeDefinitions/FieldDefinitionFactory.php index 7ab3818..df28529 100644 --- a/src/LibDNS/Records/TypeDefinitions/FieldDefinitionFactory.php +++ b/src/LibDNS/Records/TypeDefinitions/FieldDefinitionFactory.php @@ -4,33 +4,32 @@ * * PHP version 5.4 * - * @category LibDNS - * @package TypeDefinitions - * @author Chris Wright - * @copyright Copyright (c) Chris Wright - * @license http://www.opensource.org/licenses/mit-license.html MIT License - * @version 2.0.0 + * @category LibDNS + * @package TypeDefinitions + * @author Chris Wright + * @copyright Copyright (c) Chris Wright + * @license http://www.opensource.org/licenses/mit-license.html MIT License + * @version 2.0.0 */ namespace LibDNS\Records\TypeDefinitions; /** * Creates FieldDefinition objects * - * @category LibDNS - * @package TypeDefinitions - * @author Chris Wright + * @category LibDNS + * @package TypeDefinitions + * @author Chris Wright */ class FieldDefinitionFactory { /** * Create a new FieldDefinition object * - * @param int $index + * @param int $index * @param string $name - * @param int $type - * @param bool $allowsMultiple - * @param int $minimumValues - * + * @param int $type + * @param bool $allowsMultiple + * @param int $minimumValues * @return \LibDNS\Records\TypeDefinitions\FieldDefinition */ public function create($index, $name, $type, $allowsMultiple, $minimumValues) diff --git a/src/LibDNS/Records/TypeDefinitions/TypeDefinition.php b/src/LibDNS/Records/TypeDefinitions/TypeDefinition.php index 9d44878..ba66edf 100644 --- a/src/LibDNS/Records/TypeDefinitions/TypeDefinition.php +++ b/src/LibDNS/Records/TypeDefinitions/TypeDefinition.php @@ -4,21 +4,21 @@ * * PHP version 5.4 * - * @category LibDNS - * @package TypeDefinitions - * @author Chris Wright - * @copyright Copyright (c) Chris Wright - * @license http://www.opensource.org/licenses/mit-license.html MIT License - * @version 2.0.0 + * @category LibDNS + * @package TypeDefinitions + * @author Chris Wright + * @copyright Copyright (c) Chris Wright + * @license http://www.opensource.org/licenses/mit-license.html MIT License + * @version 2.0.0 */ namespace LibDNS\Records\TypeDefinitions; /** * Defines a data type comprising multiple fields * - * @category LibDNS - * @package TypeDefinitions - * @author Chris Wright + * @category LibDNS + * @package TypeDefinitions + * @author Chris Wright */ class TypeDefinition implements \Iterator, \Countable { @@ -87,9 +87,9 @@ public function __construct(FieldDefinitionFactory $fieldDefFactory, array $defi /** * Register a field from the type definition * - * @param int $index + * @param int $index * @param string $name - * @param int $type + * @param int $type * @throws \InvalidArgumentException When the field definition is invalid */ private function registerField($index, $name, $type) diff --git a/src/LibDNS/Records/TypeDefinitions/TypeDefinitionFactory.php b/src/LibDNS/Records/TypeDefinitions/TypeDefinitionFactory.php index e00ecfc..0aede80 100644 --- a/src/LibDNS/Records/TypeDefinitions/TypeDefinitionFactory.php +++ b/src/LibDNS/Records/TypeDefinitions/TypeDefinitionFactory.php @@ -4,21 +4,21 @@ * * PHP version 5.4 * - * @category LibDNS - * @package TypeDefinitions - * @author Chris Wright - * @copyright Copyright (c) Chris Wright - * @license http://www.opensource.org/licenses/mit-license.html MIT License - * @version 2.0.0 + * @category LibDNS + * @package TypeDefinitions + * @author Chris Wright + * @copyright Copyright (c) Chris Wright + * @license http://www.opensource.org/licenses/mit-license.html MIT License + * @version 2.0.0 */ namespace LibDNS\Records\TypeDefinitions; /** * Creates TypeDefinition objects * - * @category LibDNS - * @package TypeDefinitions - * @author Chris Wright + * @category LibDNS + * @package TypeDefinitions + * @author Chris Wright */ class TypeDefinitionFactory { @@ -26,10 +26,8 @@ class TypeDefinitionFactory * Create a new TypeDefinition object * * @param FieldDefinitionFactory $fieldDefinitionFactory - * @param int[] $definition Structural definition of the fields - * + * @param int[] $definition Structural definition of the fields * @return \LibDNS\Records\TypeDefinitions\TypeDefinition - * * @throws \InvalidArgumentException When the type definition is invalid */ public function create(FieldDefinitionFactory $fieldDefinitionFactory, array $definition) diff --git a/src/LibDNS/Records/TypeDefinitions/TypeDefinitionManager.php b/src/LibDNS/Records/TypeDefinitions/TypeDefinitionManager.php index 1c8e48a..2cdf036 100644 --- a/src/LibDNS/Records/TypeDefinitions/TypeDefinitionManager.php +++ b/src/LibDNS/Records/TypeDefinitions/TypeDefinitionManager.php @@ -4,12 +4,12 @@ * * PHP version 5.4 * - * @category LibDNS - * @package TypeDefinitions - * @author Chris Wright - * @copyright Copyright (c) Chris Wright - * @license http://www.opensource.org/licenses/mit-license.html MIT License - * @version 2.0.0 + * @category LibDNS + * @package TypeDefinitions + * @author Chris Wright + * @copyright Copyright (c) Chris Wright + * @license http://www.opensource.org/licenses/mit-license.html MIT License + * @version 2.0.0 */ namespace LibDNS\Records\TypeDefinitions; @@ -20,9 +20,9 @@ /** * Holds data about how the RDATA sections of known resource record types are structured * - * @category LibDNS - * @package TypeDefinitions - * @author Chris Wright + * @category LibDNS + * @package TypeDefinitions + * @author Chris Wright */ class TypeDefinitionManager { @@ -49,7 +49,7 @@ class TypeDefinitionManager /** * Constructor * - * @param \LibDNS\Records\TypeDefinitions\TypeDefinitionFactory $typeDefFactory + * @param \LibDNS\Records\TypeDefinitions\TypeDefinitionFactory $typeDefFactory * @param \LibDNS\Records\TypeDefinitions\FieldDefinitionFactory $fieldDefFactory */ public function __construct(TypeDefinitionFactory $typeDefFactory, FieldDefinitionFactory $fieldDefFactory) diff --git a/src/LibDNS/Records/TypeDefinitions/TypeDefinitionManagerFactory.php b/src/LibDNS/Records/TypeDefinitions/TypeDefinitionManagerFactory.php index 959cec1..d2a219b 100644 --- a/src/LibDNS/Records/TypeDefinitions/TypeDefinitionManagerFactory.php +++ b/src/LibDNS/Records/TypeDefinitions/TypeDefinitionManagerFactory.php @@ -4,21 +4,21 @@ * * PHP version 5.4 * - * @category LibDNS - * @package TypeDefinitions - * @author Chris Wright - * @copyright Copyright (c) Chris Wright - * @license http://www.opensource.org/licenses/mit-license.html MIT License - * @version 2.0.0 + * @category LibDNS + * @package TypeDefinitions + * @author Chris Wright + * @copyright Copyright (c) Chris Wright + * @license http://www.opensource.org/licenses/mit-license.html MIT License + * @version 2.0.0 */ namespace LibDNS\Records\TypeDefinitions; /** * Creates TypeDefinitionManager objects * - * @category LibDNS - * @package TypeDefinitions - * @author Chris Wright + * @category LibDNS + * @package TypeDefinitions + * @author Chris Wright */ class TypeDefinitionManagerFactory { diff --git a/src/LibDNS/Records/Types/Anything.php b/src/LibDNS/Records/Types/Anything.php index f40f33e..d3e9593 100644 --- a/src/LibDNS/Records/Types/Anything.php +++ b/src/LibDNS/Records/Types/Anything.php @@ -4,21 +4,21 @@ * * PHP version 5.4 * - * @category LibDNS - * @package Types - * @author Chris Wright - * @copyright Copyright (c) Chris Wright - * @license http://www.opensource.org/licenses/mit-license.html MIT License - * @version 2.0.0 + * @category LibDNS + * @package Types + * @author Chris Wright + * @copyright Copyright (c) Chris Wright + * @license http://www.opensource.org/licenses/mit-license.html MIT License + * @version 2.0.0 */ namespace LibDNS\Records\Types; /** * Represents a generic binary data string * - * @category LibDNS - * @package Types - * @author Chris Wright + * @category LibDNS + * @package Types + * @author Chris Wright */ class Anything extends Type { @@ -31,7 +31,6 @@ class Anything extends Type * Set the internal value * * @param string $value The new value - * * @throws \UnexpectedValueException When the supplied value is outside the valid length range 0 - 65535 */ public function setValue($value) diff --git a/src/LibDNS/Records/Types/BitMap.php b/src/LibDNS/Records/Types/BitMap.php index a69ef1d..41c237e 100644 --- a/src/LibDNS/Records/Types/BitMap.php +++ b/src/LibDNS/Records/Types/BitMap.php @@ -4,21 +4,21 @@ * * PHP version 5.4 * - * @category LibDNS - * @package Types - * @author Chris Wright - * @copyright Copyright (c) Chris Wright - * @license http://www.opensource.org/licenses/mit-license.html MIT License - * @version 2.0.0 + * @category LibDNS + * @package Types + * @author Chris Wright + * @copyright Copyright (c) Chris Wright + * @license http://www.opensource.org/licenses/mit-license.html MIT License + * @version 2.0.0 */ namespace LibDNS\Records\Types; /** * Represents a bit map * - * @category LibDNS - * @package Types - * @author Chris Wright + * @category LibDNS + * @package Types + * @author Chris Wright */ class BitMap extends Type { diff --git a/src/LibDNS/Records/Types/Char.php b/src/LibDNS/Records/Types/Char.php index 3b7fff5..577cdaa 100644 --- a/src/LibDNS/Records/Types/Char.php +++ b/src/LibDNS/Records/Types/Char.php @@ -4,21 +4,21 @@ * * PHP version 5.4 * - * @category LibDNS - * @package Types - * @author Chris Wright - * @copyright Copyright (c) Chris Wright - * @license http://www.opensource.org/licenses/mit-license.html MIT License - * @version 2.0.0 + * @category LibDNS + * @package Types + * @author Chris Wright + * @copyright Copyright (c) Chris Wright + * @license http://www.opensource.org/licenses/mit-license.html MIT License + * @version 2.0.0 */ namespace LibDNS\Records\Types; /** * Represents an 8-bit unsigned integer * - * @category LibDNS - * @package Types - * @author Chris Wright + * @category LibDNS + * @package Types + * @author Chris Wright */ class Char extends Type { @@ -31,7 +31,6 @@ class Char extends Type * Set the internal value * * @param int $value The new value - * * @throws \UnderflowException When the supplied value is less than 0 * @throws \OverflowException When the supplied value is greater than 255 */ diff --git a/src/LibDNS/Records/Types/CharacterString.php b/src/LibDNS/Records/Types/CharacterString.php index 1ee1d52..2a2b2d7 100644 --- a/src/LibDNS/Records/Types/CharacterString.php +++ b/src/LibDNS/Records/Types/CharacterString.php @@ -4,21 +4,21 @@ * * PHP version 5.4 * - * @category LibDNS - * @package Types - * @author Chris Wright - * @copyright Copyright (c) Chris Wright - * @license http://www.opensource.org/licenses/mit-license.html MIT License - * @version 2.0.0 + * @category LibDNS + * @package Types + * @author Chris Wright + * @copyright Copyright (c) Chris Wright + * @license http://www.opensource.org/licenses/mit-license.html MIT License + * @version 2.0.0 */ namespace LibDNS\Records\Types; /** * Represents a binary character string * - * @category LibDNS - * @package Types - * @author Chris Wright + * @category LibDNS + * @package Types + * @author Chris Wright */ class CharacterString extends Type { @@ -31,7 +31,6 @@ class CharacterString extends Type * Set the internal value * * @param string $value The new value - * * @throws \UnexpectedValueException When the supplied value is outside the valid length range 0 - 255 */ public function setValue($value) diff --git a/src/LibDNS/Records/Types/DomainName.php b/src/LibDNS/Records/Types/DomainName.php index 40e103c..fba3fbe 100644 --- a/src/LibDNS/Records/Types/DomainName.php +++ b/src/LibDNS/Records/Types/DomainName.php @@ -4,21 +4,21 @@ * * PHP version 5.4 * - * @category LibDNS - * @package Types - * @author Chris Wright - * @copyright Copyright (c) Chris Wright - * @license http://www.opensource.org/licenses/mit-license.html MIT License - * @version 2.0.0 + * @category LibDNS + * @package Types + * @author Chris Wright + * @copyright Copyright (c) Chris Wright + * @license http://www.opensource.org/licenses/mit-license.html MIT License + * @version 2.0.0 */ namespace LibDNS\Records\Types; /** * Represents a fully qualified domain name * - * @category LibDNS - * @package Types - * @author Chris Wright + * @category LibDNS + * @package Types + * @author Chris Wright */ class DomainName extends Type { @@ -38,7 +38,6 @@ class DomainName extends Type * Constructor * * @param string|string[] $value - * * @throws \UnexpectedValueException When the supplied value is not a valid domain name */ public function __construct($value = null) @@ -56,7 +55,6 @@ public function __construct($value = null) * Set the internal value * * @param string $value The new value - * * @throws \UnexpectedValueException When the supplied value is not a valid domain name */ public function setValue($value) @@ -68,7 +66,6 @@ public function setValue($value) * Get the domain name labels * * @param bool $tldFirst Whether to return the label list ordered with the TLD label first - * * @return string[] */ public function getLabels($tldFirst = false) @@ -80,8 +77,7 @@ public function getLabels($tldFirst = false) * Set the domain name labels * * @param string[] $labels The new label list - * @param bool $tldFirst Whether the supplied label list is ordered with the TLD label first - * + * @param bool $tldFirst Whether the supplied label list is ordered with the TLD label first * @throws \UnexpectedValueException When the supplied label list is not a valid domain name */ public function setLabels(array $labels, $tldFirst = false) diff --git a/src/LibDNS/Records/Types/IPv4Address.php b/src/LibDNS/Records/Types/IPv4Address.php index 432df96..88c2c67 100644 --- a/src/LibDNS/Records/Types/IPv4Address.php +++ b/src/LibDNS/Records/Types/IPv4Address.php @@ -4,21 +4,21 @@ * * PHP version 5.4 * - * @category LibDNS - * @package Types - * @author Chris Wright - * @copyright Copyright (c) Chris Wright - * @license http://www.opensource.org/licenses/mit-license.html MIT License - * @version 2.0.0 + * @category LibDNS + * @package Types + * @author Chris Wright + * @copyright Copyright (c) Chris Wright + * @license http://www.opensource.org/licenses/mit-license.html MIT License + * @version 2.0.0 */ namespace LibDNS\Records\Types; /** * Represents an IPv4 address * - * @category LibDNS - * @package Types - * @author Chris Wright + * @category LibDNS + * @package Types + * @author Chris Wright */ class IPv4Address extends Type { @@ -36,7 +36,6 @@ class IPv4Address extends Type * Constructor * * @param string|int[] $value String representation or octet list - * * @throws \UnexpectedValueException When the supplied value is not a valid IPv4 address */ public function __construct($value = null) @@ -54,7 +53,6 @@ public function __construct($value = null) * Set the internal value * * @param string $value The new value - * * @throws \UnexpectedValueException When the supplied value is outside the valid length range 0 - 65535 */ public function setValue($value) @@ -76,7 +74,6 @@ public function getOctets() * Set the address octets * * @param int[] $octets The new address octets - * * @throws \UnexpectedValueException When the supplied octet list is not a valid IPv4 address */ public function setOctets(array $octets) diff --git a/src/LibDNS/Records/Types/IPv6Address.php b/src/LibDNS/Records/Types/IPv6Address.php index 716c501..f6145ed 100644 --- a/src/LibDNS/Records/Types/IPv6Address.php +++ b/src/LibDNS/Records/Types/IPv6Address.php @@ -4,21 +4,21 @@ * * PHP version 5.4 * - * @category LibDNS - * @package Types - * @author Chris Wright - * @copyright Copyright (c) Chris Wright - * @license http://www.opensource.org/licenses/mit-license.html MIT License - * @version 2.0.0 + * @category LibDNS + * @package Types + * @author Chris Wright + * @copyright Copyright (c) Chris Wright + * @license http://www.opensource.org/licenses/mit-license.html MIT License + * @version 2.0.0 */ namespace LibDNS\Records\Types; /** * Represents an IPv6 address * - * @category LibDNS - * @package Types - * @author Chris Wright + * @category LibDNS + * @package Types + * @author Chris Wright */ class IPv6Address extends Type { @@ -36,14 +36,13 @@ class IPv6Address extends Type * Create a compressed string representation of an IPv6 address * * @param int[] $shorts Address shorts - * * @return string */ private function createCompressedString($shorts) { $compressLen = $compressPos = $currentLen = $currentPos = 0; $inBlock = false; - + for ($i = 0; $i < 8; $i++) { if ($shorts[$i] === 0) { if (!$inBlock) { @@ -88,7 +87,6 @@ private function createCompressedString($shorts) * Constructor * * @param string|int[] $value String representation or shorts list - * * @throws \UnexpectedValueException When the supplied value is not a valid IPv6 address */ public function __construct($value = null) @@ -106,7 +104,6 @@ public function __construct($value = null) * Set the internal value * * @param string $value The new value - * * @throws \UnexpectedValueException When the supplied value is outside the valid length range 0 - 65535 */ public function setValue($value) @@ -141,7 +138,6 @@ public function getShorts() * Set the address shorts * * @param int[] $shorts The new address shorts - * * @throws \UnexpectedValueException When the supplied short list is not a valid IPv6 address */ public function setShorts(array $shorts) diff --git a/src/LibDNS/Records/Types/Long.php b/src/LibDNS/Records/Types/Long.php index c9acf40..64bdc05 100644 --- a/src/LibDNS/Records/Types/Long.php +++ b/src/LibDNS/Records/Types/Long.php @@ -4,21 +4,21 @@ * * PHP version 5.4 * - * @category LibDNS - * @package Types - * @author Chris Wright - * @copyright Copyright (c) Chris Wright - * @license http://www.opensource.org/licenses/mit-license.html MIT License - * @version 2.0.0 + * @category LibDNS + * @package Types + * @author Chris Wright + * @copyright Copyright (c) Chris Wright + * @license http://www.opensource.org/licenses/mit-license.html MIT License + * @version 2.0.0 */ namespace LibDNS\Records\Types; /** * Represents a 32-bit unsigned integer * - * @category LibDNS - * @package Types - * @author Chris Wright + * @category LibDNS + * @package Types + * @author Chris Wright */ class Long extends Type { @@ -31,7 +31,6 @@ class Long extends Type * Set the internal value * * @param int $value The new value - * * @throws \UnderflowException When the supplied value is less than 0 * @throws \OverflowException When the supplied value is greater than 4294967296 */ diff --git a/src/LibDNS/Records/Types/Short.php b/src/LibDNS/Records/Types/Short.php index 228ddda..2fb1f99 100644 --- a/src/LibDNS/Records/Types/Short.php +++ b/src/LibDNS/Records/Types/Short.php @@ -4,21 +4,21 @@ * * PHP version 5.4 * - * @category LibDNS - * @package Types - * @author Chris Wright - * @copyright Copyright (c) Chris Wright - * @license http://www.opensource.org/licenses/mit-license.html MIT License - * @version 2.0.0 + * @category LibDNS + * @package Types + * @author Chris Wright + * @copyright Copyright (c) Chris Wright + * @license http://www.opensource.org/licenses/mit-license.html MIT License + * @version 2.0.0 */ namespace LibDNS\Records\Types; /** * Represents a 16-bit unsigned integer * - * @category LibDNS - * @package Types - * @author Chris Wright + * @category LibDNS + * @package Types + * @author Chris Wright */ class Short extends Type { @@ -31,7 +31,6 @@ class Short extends Type * Set the internal value * * @param int $value The new value - * * @throws \UnderflowException When the supplied value is less than 0 * @throws \OverflowException When the supplied value is greater than 65535 */ diff --git a/src/LibDNS/Records/Types/Type.php b/src/LibDNS/Records/Types/Type.php index 485bade..736d299 100644 --- a/src/LibDNS/Records/Types/Type.php +++ b/src/LibDNS/Records/Types/Type.php @@ -4,21 +4,21 @@ * * PHP version 5.4 * - * @category LibDNS - * @package Types - * @author Chris Wright - * @copyright Copyright (c) Chris Wright - * @license http://www.opensource.org/licenses/mit-license.html MIT License - * @version 2.0.0 + * @category LibDNS + * @package Types + * @author Chris Wright + * @copyright Copyright (c) Chris Wright + * @license http://www.opensource.org/licenses/mit-license.html MIT License + * @version 2.0.0 */ namespace LibDNS\Records\Types; /** * Base class for simple data types * - * @category LibDNS - * @package Types - * @author Chris Wright + * @category LibDNS + * @package Types + * @author Chris Wright */ abstract class Type { @@ -31,7 +31,6 @@ abstract class Type * Constructor * * @param mixed $value Internal value - * * @throws \RuntimeException When the supplied value is invalid */ public function __construct($value = null) @@ -65,7 +64,6 @@ public function getValue() * Set the internal value * * @param mixed $value The new value - * * @throws \RuntimeException When the supplied value is invalid */ abstract public function setValue($value); diff --git a/src/LibDNS/Records/Types/TypeBuilder.php b/src/LibDNS/Records/Types/TypeBuilder.php index e1b1dcc..12c7d21 100644 --- a/src/LibDNS/Records/Types/TypeBuilder.php +++ b/src/LibDNS/Records/Types/TypeBuilder.php @@ -4,21 +4,21 @@ * * PHP version 5.4 * - * @category LibDNS - * @package Types - * @author Chris Wright - * @copyright Copyright (c) Chris Wright - * @license http://www.opensource.org/licenses/mit-license.html MIT License - * @version 2.0.0 + * @category LibDNS + * @package Types + * @author Chris Wright + * @copyright Copyright (c) Chris Wright + * @license http://www.opensource.org/licenses/mit-license.html MIT License + * @version 2.0.0 */ namespace LibDNS\Records\Types; /** * Builds Types from type definitions * - * @category LibDNS - * @package Types - * @author Chris Wright + * @category LibDNS + * @package Types + * @author Chris Wright */ class TypeBuilder { @@ -41,7 +41,6 @@ public function __construct(TypeFactory $typeFactory) * Build a new Type object corresponding to a resource record type * * @param int $type Data type, can be indicated using the Types enum - * * @return \LibDNS\Records\Types\Type */ public function build($type) diff --git a/src/LibDNS/Records/Types/TypeFactory.php b/src/LibDNS/Records/Types/TypeFactory.php index 5f7c6e7..5685d9d 100644 --- a/src/LibDNS/Records/Types/TypeFactory.php +++ b/src/LibDNS/Records/Types/TypeFactory.php @@ -4,21 +4,21 @@ * * PHP version 5.4 * - * @category LibDNS - * @package Types - * @author Chris Wright - * @copyright Copyright (c) Chris Wright - * @license http://www.opensource.org/licenses/mit-license.html MIT License - * @version 2.0.0 + * @category LibDNS + * @package Types + * @author Chris Wright + * @copyright Copyright (c) Chris Wright + * @license http://www.opensource.org/licenses/mit-license.html MIT License + * @version 2.0.0 */ namespace LibDNS\Records\Types; /** * Creates Type objects * - * @category LibDNS - * @package Types - * @author Chris Wright + * @category LibDNS + * @package Types + * @author Chris Wright */ class TypeFactory { @@ -26,7 +26,6 @@ class TypeFactory * Create a new Anything object * * @param string $value - * * @return \LibDNS\Records\Types\Anything */ public function createAnything($value = null) @@ -38,7 +37,6 @@ public function createAnything($value = null) * Create a new BitMap object * * @param string $value - * * @return \LibDNS\Records\Types\BitMap */ public function createBitMap($value = null) @@ -50,7 +48,6 @@ public function createBitMap($value = null) * Create a new Char object * * @param int $value - * * @return \LibDNS\Records\Types\Char */ public function createChar($value = null) @@ -62,7 +59,6 @@ public function createChar($value = null) * Create a new CharacterString object * * @param string $value - * * @return \LibDNS\Records\Types\CharacterString */ public function createCharacterString($value = null) @@ -74,7 +70,6 @@ public function createCharacterString($value = null) * Create a new DomainName object * * @param string|string[] $value - * * @return \LibDNS\Records\Types\DomainName */ public function createDomainName($value = null) @@ -86,7 +81,6 @@ public function createDomainName($value = null) * Create a new IPv4Address object * * @param string $value - * * @return \LibDNS\Records\Types\IPv4Address */ public function createIPv4Address($value = null) @@ -98,7 +92,6 @@ public function createIPv4Address($value = null) * Create a new IPv6Address object * * @param string $value - * * @return \LibDNS\Records\Types\IPv6Address */ public function createIPv6Address($value = null) @@ -110,7 +103,6 @@ public function createIPv6Address($value = null) * Create a new Long object * * @param int $value - * * @return \LibDNS\Records\Types\Long */ public function createLong($value = null) @@ -122,7 +114,6 @@ public function createLong($value = null) * Create a new Short object * * @param int $value - * * @return \LibDNS\Records\Types\Short */ public function createShort($value = null) diff --git a/src/LibDNS/Records/Types/Types.php b/src/LibDNS/Records/Types/Types.php index 2908216..3e18be2 100644 --- a/src/LibDNS/Records/Types/Types.php +++ b/src/LibDNS/Records/Types/Types.php @@ -4,12 +4,12 @@ * * PHP version 5.4 * - * @category LibDNS - * @package Types - * @author Chris Wright - * @copyright Copyright (c) Chris Wright - * @license http://www.opensource.org/licenses/mit-license.html MIT License - * @version 2.0.0 + * @category LibDNS + * @package Types + * @author Chris Wright + * @copyright Copyright (c) Chris Wright + * @license http://www.opensource.org/licenses/mit-license.html MIT License + * @version 2.0.0 */ namespace LibDNS\Records\Types; @@ -18,9 +18,9 @@ /** * Enumeration of simple data types * - * @category LibDNS - * @package Types - * @author Chris Wright + * @category LibDNS + * @package Types + * @author Chris Wright */ class Types extends Enumeration { diff --git a/tools/autoload_generator.php b/tools/autoload_generator.php index 60e7908..6e45651 100644 --- a/tools/autoload_generator.php +++ b/tools/autoload_generator.php @@ -4,12 +4,12 @@ * * PHP version 5.4 * - * @category LibDNS - * @package Tools - * @author Chris Wright - * @copyright Copyright (c) Chris Wright - * @license http://www.opensource.org/licenses/mit-license.html MIT License - * @version 1.0.0 + * @category LibDNS + * @package Tools + * @author Chris Wright + * @copyright Copyright (c) Chris Wright + * @license http://www.opensource.org/licenses/mit-license.html MIT License + * @version 1.0.0 */ namespace LibDNS\Tools;