• Главная
• Pop
• Code
• Generator
• DocblockGenerator

PHP Класс Pop\Code\Generator\DocblockGenerator

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство	Тип	Описание
$desc	string	Docblock description
$indent	string	Docblock indent
$output	string	Docblock output
$tags	array	Docblock tags

Открытые методы

Метод	Описание
__construct ( string $desc = null, string $indent = null ) : DocblockGenerator	Constructor
__toString ( ) : string	Print docblock
factory ( string $desc = null, string $indent = null ) : DocblockGenerator	Static method to instantiate the docblock object and return itself to facilitate chaining methods together.
getDesc ( ) : string	Get the docblock description
getIndent ( ) : string	Get the docblock indent
getParam ( integer $index ) : array	Get a param
getReturn ( ) : array	Get the return
getTag ( string $name ) : string	Get a tag
parse ( string $docblock, string $forceIndent = null ) : DocblockGenerator	Static method to parse a docblock string and return a new docblock generator object.
render ( boolean $ret = false ) : mixed	Render docblock
setDesc ( string $desc = null ) : DocblockGenerator	Set the docblock description
setIndent ( string $indent = null ) : DocblockGenerator	Set the docblock indent
setParam ( string $type, string $var = null, string $desc = null ) : DocblockGenerator	Add a param tag
setParams ( array $params ) : DocblockGenerator	Add a param tag
setReturn ( string $type, string $desc = null ) : DocblockGenerator	Add a return tag
setTag ( string $name, string $desc = null ) : DocblockGenerator	Add a basic tag
setTags ( array $tags ) : DocblockGenerator	Add basic tags

Защищенные методы

Метод	Описание
formatTags ( ) : string	Format the docblock tags
getParamLength ( ) : integer	Get the longest param type length
getTagLength ( ) : integer	Get the longest tag length

Описание методов

Описание свойств