PHP Class fieldDoc

Inheritance: extends ProgramElementDoc
Exibir arquivo Open project: peej/phpdoctor

Public Properties

Property Type Description
$_type type The type of the variable.
$_value mixed The value of the variable if it is a constant.

Public Methods

Method Description
constantValue ( ) : str Returns the value of the constant.
fieldDoc ( $name, &$parent, &$root, $filename = NULL, $lineNumber = NULL, $sourcePath = NULL ) Constructor
isField ( ) : boolean Construct is a field.
isGlobal ( ) : boolean Construct is a global.
type ( ) : Type Get type of this variable.
typeAsString ( ) : str Format a field type for outputting. Recognised types are turned into HTML anchor tags to the documentation page for the class defining them.
value ( ) : mixed Returns the value of the field.

Method Details

constantValue() public method

Returns the value of the constant.
public constantValue ( ) : str
return str

fieldDoc() public method

Constructor
public fieldDoc ( $name, &$parent, &$root, $filename = NULL, $lineNumber = NULL, $sourcePath = NULL )

isField() public method

Construct is a field.
public isField ( ) : boolean
return boolean

isGlobal() public method

Construct is a global.
public isGlobal ( ) : boolean
return boolean

type() public method

Get type of this variable.
public type ( ) : Type
return Type

typeAsString() public method

Format a field type for outputting. Recognised types are turned into HTML anchor tags to the documentation page for the class defining them.
public typeAsString ( ) : str
return str The string representation of the field type

value() public method

Returns the value of the field.
public value ( ) : mixed
return mixed

Property Details

$_type public_oe property

The type of the variable.
public type $_type
return type

$_value public_oe property

The value of the variable if it is a constant.
public mixed $_value
return mixed