PHP Класс doc

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

Открытые свойства

Свойство Тип Описание
$_data mixed[] Data about the element creamed from the token stream before the object for this element was created. This array contains extra data about the element that occurs before the element definition in the token stream (including doc comment data), it is merged with the objects fields upon object completion.
$_docComment str The unprocessed doc comment.
$_name str The name of this construct
$_root rootDoc Reference to the root element.
$_tags tag[] Array of doc tags.
$inBody integer Whether parsing is inside this elements curly braces.

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

Метод Описание
getFileContents ( $filename ) : str Get body of a text document
getRawCommentText ( ) : str Return the full unprocessed text of the comment.
isClass ( ) : boolean Is this construct a class. Note: interfaces are not classes. False until overridden.
isConstructor ( ) : boolean Is this construct a constructor. False until overridden.
isException ( ) : boolean Is this construct an exception. False until overridden.
isField ( ) : boolean Is this construct a field. False until overridden.
isFinal ( ) : boolean Is this construct final. False until overridden.
isFunction ( ) : boolean Is this construct a function. False until overridden.
isGlobal ( ) : boolean Is this construct a global variable. False until overridden.
isInterface ( ) : boolean Is this construct an interface. False until overridden.
isMethod ( ) : boolean Is this construct a method. False until overridden.
isOrdinaryClass ( ) : boolean Is this construct an ordinary class (not an interface or an exception).
isTrait ( ) : boolean Is this construct an trait. False until overridden.
mergeData ( ) Merge the contents of the doc comment into the element object.
name ( ) : str Return the name of this doc item.
set ( $member, $value ) : boolean Setter method.
setByRef ( $member, &$value ) : boolean Setter by reference method.
setTag ( $tagName, $tag ) Set a tag.
tags ( $tagName = NULL ) : Tag[] Return tags of the specified kind in this Doc item. For example, if 'tagName' has value "@serial", all tags in this Doc item of type "@serial" will be returned. If NULL is given for 'tagName', all tags in this Doc item are returned.

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

getFileContents() публичный Метод

Get body of a text document
public getFileContents ( $filename ) : str
Результат str

getRawCommentText() публичный Метод

Return the full unprocessed text of the comment.
public getRawCommentText ( ) : str
Результат str

isClass() публичный Метод

Is this construct a class. Note: interfaces are not classes. False until overridden.
public isClass ( ) : boolean
Результат boolean

isConstructor() публичный Метод

Is this construct a constructor. False until overridden.
public isConstructor ( ) : boolean
Результат boolean

isException() публичный Метод

Is this construct an exception. False until overridden.
public isException ( ) : boolean
Результат boolean

isField() публичный Метод

Is this construct a field. False until overridden.
public isField ( ) : boolean
Результат boolean

isFinal() публичный Метод

Is this construct final. False until overridden.
public isFinal ( ) : boolean
Результат boolean

isFunction() публичный Метод

Is this construct a function. False until overridden.
public isFunction ( ) : boolean
Результат boolean

isGlobal() публичный Метод

Is this construct a global variable. False until overridden.
public isGlobal ( ) : boolean
Результат boolean

isInterface() публичный Метод

Is this construct an interface. False until overridden.
public isInterface ( ) : boolean
Результат boolean

isMethod() публичный Метод

Is this construct a method. False until overridden.
public isMethod ( ) : boolean
Результат boolean

isOrdinaryClass() публичный Метод

False until overridden.
public isOrdinaryClass ( ) : boolean
Результат boolean

isTrait() публичный Метод

Is this construct an trait. False until overridden.
public isTrait ( ) : boolean
Результат boolean

mergeData() публичный Метод

Merge the contents of the doc comment into the element object.
public mergeData ( )

name() публичный Метод

Return the name of this doc item.
public name ( ) : str
Результат str

set() публичный Метод

Setter method.
public set ( $member, $value ) : boolean
Результат boolean

setByRef() публичный Метод

Setter by reference method.
public setByRef ( $member, &$value ) : boolean
Результат boolean

setTag() публичный Метод

Set a tag.
public setTag ( $tagName, $tag )

tags() публичный Метод

Return tags of the specified kind in this Doc item. For example, if 'tagName' has value "@serial", all tags in this Doc item of type "@serial" will be returned. If NULL is given for 'tagName', all tags in this Doc item are returned.
public tags ( $tagName = NULL ) : Tag[]
Результат Tag[] An array of Tag containing all tags of name 'tagname' or a singular tag object if only one exists for the given 'tagname'

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

$_data публичное свойство

Data about the element creamed from the token stream before the object for this element was created. This array contains extra data about the element that occurs before the element definition in the token stream (including doc comment data), it is merged with the objects fields upon object completion.
public mixed[] $_data
Результат mixed[]

$_docComment публичное свойство

The unprocessed doc comment.
public str $_docComment
Результат str

$_name публичное свойство

The name of this construct
public str $_name
Результат str

$_root публичное свойство

Reference to the root element.
public rootDoc $_root
Результат rootDoc

$_tags публичное свойство

Array of doc tags.
public tag[] $_tags
Результат tag[]

$inBody публичное свойство

Whether parsing is inside this elements curly braces.
public int $inBody
Результат integer