PHP Class type

Mostra file Open project: peej/phpdoctor Class Usage Examples

Public Properties

Property Type Description
$_dimension integer The number of dimensions this type has.
$_name str The name of the type.
$_root rootDoc Reference to the root element.

Public Methods

Method Description
asClassDoc ( ) : ClassDoc Return this type as a class.
dimension ( ) : str Return the type's dimension information, as a string.
qualifiedTypeName ( ) : str Get qualified name of this type.
toString ( ) : str Returns a string representation of the type.
type ( $name, &$root ) Constructor
typeName ( ) : str Get name of this type.

Method Details

asClassDoc() public method

Return this type as a class.
public asClassDoc ( ) : ClassDoc
return ClassDoc A classDoc if the type is a class, null if it is a primitive type.

dimension() public method

Return the type's dimension information, as a string.
public dimension ( ) : str
return str

qualifiedTypeName() public method

Get qualified name of this type.
public qualifiedTypeName ( ) : str
return str

toString() public method

Returns a string representation of the type.
public toString ( ) : str
return str

type() public method

Constructor
public type ( $name, &$root )

typeName() public method

Get name of this type.
public typeName ( ) : str
return str

Property Details

$_dimension public_oe property

The number of dimensions this type has.
public int $_dimension
return integer

$_name public_oe property

The name of the type.
public str $_name
return str

$_root public_oe property

Reference to the root element.
public rootDoc $_root
return rootDoc