Added setters at Location and Description;

Added DocBlock::appendTag();
Minor reorganization at the tag setters;

Author: boenrobot

src/phpDocumentor/Reflection/DocBlock.php

@@ -12,6 +12,7 @@
 
 namespace phpDocumentor\Reflection;
 
+use phpDocumentor\Reflection\DocBlock\Tag;
 use phpDocumentor\Reflection\DocBlock\Context;
 use phpDocumentor\Reflection\DocBlock\Location;
 
@@ -28,13 +29,13 @@ class DocBlock implements \Reflector
     protected $short_description = '';
 
     /**
-     * @var \phpDocumentor\Reflection\DocBlock\LongDescription The actual
+     * @var DocBlock\Description The actual
      *     description for this docblock.
      */
     protected $long_description = null;
 
     /**
-     * @var \phpDocumentor\Reflection\DocBlock\Tags[] An array containing all
+     * @var Tag[] An array containing all
      *     the tags in this docblock; except inline.
      */
     protected $tags = array();
@@ -221,7 +222,7 @@ protected function parseTags($tags)
 
             // create proper Tag objects
             foreach ($result as $key => $tag_line) {
-                $result[$key] = DocBlock\Tag::createInstance($tag_line, $this);
+                $result[$key] = Tag::createInstance($tag_line, $this);
             }
         }
 
@@ -271,7 +272,7 @@ public function getLocation()
     /**
      * Returns the tags for this DocBlock.
      *
-     * @return DocBlock\Tag[]
+     * @return Tag[]
      */
     public function getTags()
     {
@@ -284,13 +285,13 @@ public function getTags()
      *
      * @param string $name String to search by.
      *
-     * @return DocBlock\Tag[]
+     * @return Tag[]
      */
     public function getTagsByName($name)
     {
         $result = array();
 
-        /** @var DocBlock\Tag $tag */
+        /** @var Tag $tag */
         foreach ($this->getTags() as $tag) {
             if ($tag->getName() != $name) {
                 continue;
@@ -311,7 +312,7 @@ public function getTagsByName($name)
      */
     public function hasTag($name)
     {
-        /** @var DocBlock\Tag $tag */
+        /** @var Tag $tag */
         foreach ($this->getTags() as $tag) {
             if ($tag->getName() == $name) {
                 return true;
@@ -320,6 +321,32 @@ public function hasTag($name)
 
         return false;
     }
+    
+    /**
+     * Appends a tag at the end of the list of tags.
+     * 
+     * @param Tag $tag The tag to add.
+     * 
+     * @return Tag The newly added tag.
+     * 
+     * @throws \LogicException When the tag belongs to a different DocBlock.
+     */
+    public function appendTag(Tag $tag)
+    {
+        if (null === $tag->getDocBlock()) {
+            $tag->setDocBlock($this);
+        }
+        
+        if ($tag->getDocBlock() === $this) {
+            $this->tags[] = $tag;
+        } else {
+            throw new \LogicException(
+                'This tag belongs to a different DocBlock object.'
+            );
+        }
+
+        return $tag;
+    }
 
     /**
      * Builds a string representation of this object.

src/phpDocumentor/Reflection/DocBlock/Description.php

@@ -35,17 +35,16 @@ class Description implements \Reflector
     /**
      * Populates the fields of a description.
      *
-     * @param string   $content  The DocBlock contents without asterisks.
+     * @param string   $content  The description's conetnts.
      * @param DocBlock $docblock The DocBlock which this description belongs to.
      */
     public function __construct($content, DocBlock $docblock = null)
     {
-        $this->contents = trim($content);
-        $this->docblock = $docblock;
+        $this->setContent($content)->setDocBlock($docblock);
     }
 
     /**
-     * Returns the text of this description.
+     * Gets the text of this description.
      *
      * @return string
      */
@@ -54,6 +53,21 @@ public function getContents()
         return $this->contents;
     }
 
+    /**
+     * Sets the text of this description.
+     * 
+     * @param string $content The new text of this description.
+     * 
+     * @return $this
+     */
+    public function setContent($content)
+    {
+        $this->contents = trim($content);
+        
+        $this->parsedContents = null;
+        return $this;
+    }
+
     /**
      * Returns the parsed text of this description.
      *
@@ -98,7 +112,9 @@ public function getParsedContents()
                 null,
                 PREG_SPLIT_DELIM_CAPTURE
             );
-            for ($i=1, $l = count($this->parsedContents); $i<$l; $i += 2) {
+
+            $count = count($this->parsedContents);
+            for ($i=1; $i<$count; $i += 2) {
                 $this->parsedContents[$i] = Tag::createInstance(
                     $this->parsedContents[$i],
                     $this->docblock
@@ -108,7 +124,7 @@ public function getParsedContents()
             //In order to allow "literal" inline tags, the otherwise invalid
             //sequence "{@}" is changed to "@", and "{}" is changed to "}".
             //See unit tests for examples.
-            for ($i=0, $l = count($this->parsedContents); $i<$l; $i += 2) {
+            for ($i=0; $i<$count; $i += 2) {
                 $this->parsedContents[$i] = str_replace(
                     array('{@}', '{}'),
                     array('@', '}'),
@@ -153,6 +169,31 @@ public function getFormattedContents()
         return trim($result);
     }
 
+    /**
+     * Gets the docblock this tag belongs to.
+     * 
+     * @return DocBlock The docblock this description belongs to.
+     */
+    public function getDocBlock()
+    {
+        return $this->docblock;
+    }
+
+    /**
+     * Sets the docblock this tag belongs to.
+     * 
+     * @param DocBlock $docblock The new docblock this description belongs to.
+     *     Setting NULL removes any association.
+     * 
+     * @return $this
+     */
+    public function setDocBlock(DocBlock $docblock = null)
+    {
+        $this->docblock = $docblock;
+
+        return $this;
+    }
+
     /**
      * Builds a string representation of this object.
      *

src/phpDocumentor/Reflection/DocBlock/Location.php

@@ -22,32 +22,55 @@
 class Location
 {
     /** @var int Line where the DocBlock text starts. */
-    protected $line_number = 0;
+    protected $lineNumber = 0;
 
     /** @var int Column where the DocBlock text starts. */
-    protected $column_number = 0;
+    protected $columnNumber = 0;
 
     public function __construct(
-        $line_number = 0,
-        $column_number = 0
+        $lineNumber = 0,
+        $columnNumber = 0
     ) {
-        $this->line_number = (int)$line_number;
-        $this->column_number = (int)$column_number;
+        $this->setLineNumber($lineNumber)->setColumnNumber($columnNumber);
     }
 
     /**
      * @return int Line where the DocBlock text starts.
      */
     public function getLineNumber()
     {
-        return $this->line_number;
+        return $this->lineNumber;
+    }
+
+    /**
+     * 
+     * @param type $lineNumber
+     * @return $this
+     */
+    public function setLineNumber($lineNumber)
+    {
+        $this->lineNumber = (int)$lineNumber;
+
+        return $this;
     }
 
     /**
      * @return int Column where the DocBlock text starts.
      */
     public function getColumnNumber()
     {
-        return $this->column_number;
+        return $this->columnNumber;
+    }
+
+    /**
+     * 
+     * @param int $columnNumber
+     * @return $this
+     */
+    public function setColumnNumber($columnNumber)
+    {
+        $this->columnNumber = (int)$columnNumber;
+
+        return $this;
     }
 }

src/phpDocumentor/Reflection/DocBlock/Tag/AuthorTag.php

@@ -23,6 +23,16 @@
  */
 class AuthorTag extends Tag
 {
+    /**
+     * PCRE regular expression matching any valid value for the name component.
+     */
+    const REGEX_AUTHOR_NAME = '[^\<]*';
+
+    /**
+     * PCRE regular expression matching any valid value for the email component.
+     */
+    const REGEX_AUTHOR_EMAIL = '[^\>]*';
+
     /** @var string The name of the author */
     protected $authorName = '';
 
@@ -48,7 +58,9 @@ public function setContent($content)
     {
         parent::setContent($content);
         if (preg_match(
-            '/^([^\<]*)(\<([^\>]*)\>)?$/u',
+            '/^(' . self::REGEX_AUTHOR_NAME .
+            ')(\<(' . self::REGEX_AUTHOR_EMAIL .
+            ')\>)?$/u',
             $this->description,
             $matches
         )) {
@@ -75,13 +87,16 @@ public function getAuthorName()
      * Sets the author's name.
      * 
      * @param string $authorName The new author name.
+     *     An invalid value will set an empty string.
      * 
      * @return $this
      */
     public function setAuthorName($authorName)
     {
         $this->content = null;
-        $this->authorName = $authorName;
+        $this->authorName
+            = preg_match('/^' . self::REGEX_AUTHOR_NAME . '$/u', $authorName)
+            ? $authorName : '';
 
         return $this;
     }
@@ -100,14 +115,17 @@ public function getAuthorEmail()
      * Sets the author's email.
      * 
      * @param string $authorEmail The new author email.
+     *     An invalid value will set an empty string.
      * 
      * @return $this
      */
     public function setAuthorEmail($authorEmail)
     {
-        $this->content = null;
-        $this->authorEmail = $authorEmail;
+        $this->authorEmail
+            = preg_match('/^' . self::REGEX_AUTHOR_EMAIL . '$/u', $authorEmail)
+            ? $authorEmail : '';
 
+        $this->content = null;
         return $this;
     }
 }