Call us: 0031 23-75-10500  |  Language: Dutch English German
 
The PxDocBlock Class

PxDocBlock: Class that gives access to all properties and methods of a docblock

To instantiate a docblock object, just call the constructed with the raw source code of a docblock, including
the opening and closing comments.

The title and description, and the properties will automatically be filtered out and are accessible through
this object.

You can even change the properties of the docblock, and generate the modified docblock by casting the object
to a string.

Synopsis


Class PxDocBlock

Methods

public PxDocBlock::__construct ( string $text )
public string PxDocBlock::__toString ( void )
public PxDocBlockProperty PxDocBlock::addProperty ( string $type , string $line )
public string PxDocBlock::description ( void )
public boolean PxDocBlock::modified ( void )
public PxDocBlockProperty[] PxDocBlock::properties ( [string|boolean $type = false] )
public PxDocBlockProperty PxDocBlock::property ( string $type )
public PxDocBlock PxDocBlock::setDescription ( string $description )
public PxDocBlock PxDocBlock::setTitle ( string $title )
public string PxDocBlock::title ( void )