tags() public static method

See the $tags property for the list of supported tags.
public static tags ( string $string ) : array
$string string The string to be parsed for tags
return array Returns an array where each docblock tag is a key name, and the corresponding values are either strings (if one of each tag), or arrays (if multiple of the same tag).
Docblock Class Documentation
Beispiel #1
0
 /**
  * This is a short description.
  *
  * This is a longer description...
  * That contains
  * multiple lines
  *
  * @important This is a tag that spans a single line.
  * @discuss This is a tag that
  *      spans
  * several
  * lines.
  * @discuss The second discussion item
  * @link http://example.com/
  * @see lithium\analysis\Docblock
  * @return void This tag contains a email@address.com.
  */
 public function testTagParsing()
 {
     $info = Inspector::info(__METHOD__ . '()');
     $result = Docblock::comment($info['comment']);
     $this->assertEqual('This is a short description.', $result['description']);
     $expected = "This is a longer description...\nThat contains\nmultiple lines";
     $this->assertEqual($expected, $result['text']);
     $tags = $result['tags'];
     $expected = array('important', 'discuss', 'link', 'see', 'return');
     $this->assertEqual($expected, array_keys($tags));
     $this->assertEqual("This is a tag that\n     spans\nseveral\nlines.", $tags['discuss'][0]);
     $this->assertEqual("The second discussion item", $tags['discuss'][1]);
     $this->assertEqual('void This tag contains a email@address.com.', $tags['return']);
     $this->assertEqual(array(), Docblock::tags(null));
     $this->assertEqual(array('params' => array()), Docblock::tags("Foobar\n\n@param string"));
 }