PHP Class doc

Inheritance: extends CI_Controller
Afficher le fichier Open project: peej/phpdoctor Class Usage Examples

Méthodes publiques

Свойство Type Description
$_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.

Méthodes publiques

Méthode Description
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.

Method Details

getFileContents() public méthode

Get body of a text document
public getFileContents ( $filename ) : str
Résultat str

getRawCommentText() public méthode

Return the full unprocessed text of the comment.
public getRawCommentText ( ) : str
Résultat str

isClass() public méthode

Is this construct a class. Note: interfaces are not classes. False until overridden.
public isClass ( ) : boolean
Résultat boolean

isConstructor() public méthode

Is this construct a constructor. False until overridden.
public isConstructor ( ) : boolean
Résultat boolean

isException() public méthode

Is this construct an exception. False until overridden.
public isException ( ) : boolean
Résultat boolean

isField() public méthode

Is this construct a field. False until overridden.
public isField ( ) : boolean
Résultat boolean

isFinal() public méthode

Is this construct final. False until overridden.
public isFinal ( ) : boolean
Résultat boolean

isFunction() public méthode

Is this construct a function. False until overridden.
public isFunction ( ) : boolean
Résultat boolean

isGlobal() public méthode

Is this construct a global variable. False until overridden.
public isGlobal ( ) : boolean
Résultat boolean

isInterface() public méthode

Is this construct an interface. False until overridden.
public isInterface ( ) : boolean
Résultat boolean

isMethod() public méthode

Is this construct a method. False until overridden.
public isMethod ( ) : boolean
Résultat boolean

isOrdinaryClass() public méthode

False until overridden.
public isOrdinaryClass ( ) : boolean
Résultat boolean

isTrait() public méthode

Is this construct an trait. False until overridden.
public isTrait ( ) : boolean
Résultat boolean

mergeData() public méthode

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

name() public méthode

Return the name of this doc item.
public name ( ) : str
Résultat str

set() public méthode

Setter method.
public set ( $member, $value ) : boolean
Résultat boolean

setByRef() public méthode

Setter by reference method.
public setByRef ( $member, &$value ) : boolean
Résultat boolean

setTag() public méthode

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

tags() public méthode

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[]
Résultat Tag[] An array of Tag containing all tags of name 'tagname' or a singular tag object if only one exists for the given 'tagname'

Property Details

$_data public_oe property

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
Résultat mixed[]

$_docComment public_oe property

The unprocessed doc comment.
public str $_docComment
Résultat str

$_name public_oe property

The name of this construct
public str $_name
Résultat str

$_root public_oe property

Reference to the root element.
public rootDoc $_root
Résultat rootDoc

$_tags public_oe property

Array of doc tags.
public tag[] $_tags
Résultat tag[]

$inBody public_oe property

Whether parsing is inside this elements curly braces.
public int $inBody
Résultat integer