PHP Class TheSeer\phpDox\Collector\AbstractUnitObject

Exibir arquivo Open project: theseer/phpdox Class Usage Examples

Protected Properties

Property	Type	Description
$rootName	string

Public Methods

Method	Description
__construct ( string $name = NULL, TheSeer\phpDox\Collector\SourceFile $file = NULL )
addConstant ( $name ) : ConstantObject
addExtender ( AbstractUnitObject $unit )
addExtends ( $name )
addImplements ( $name )
addMember ( $name ) : MemberObject
addMethod ( $name )
addTrait ( string $name ) : TheSeer\phpDox\Collector\TraitUseObject
export ( ) : TheSeer\fDOM\fDOMDocument
getCompactDescription ( ) : string
getConstants ( ) : array
getExportedMembers ( ) : array
getExportedMethods ( ) : MethodObject[]
getExtends ( ) : mixed
getImplements ( ) : array
getLocalName ( ) : string
getName ( ) : string
getNamespace ( ) : string
getSourceFilename ( ) : TheSeer\phpDox\FileInfo
getTraitUse ( $name ) : TheSeer\phpDox\Collector\TraitUseObject
getType ( )
getUsedTraits ( ) : array
hasExtends ( ) : boolean
hasImplements ( ) : boolean
import ( TheSeer\fDOM\fDOMDocument $dom )
importExports ( AbstractUnitObject $unit, $container = 'parent' )
importTraitExports ( AbstractUnitObject $trait, TheSeer\phpDox\Collector\TraitUseObject $use )
markDependencyAsUnresolved ( string $dependency )
setAbstract ( boolean $isAbstract )
setDocBlock ( DocBlock $docblock )
setEndLine ( integer $endLine )
setFinal ( boolean $isFinal )
setStartLine ( integer $startLine )
usesTraits ( ) : boolean
usesTtrait ( $name ) : boolean

Protected Methods

Method	Description
addToContainer ( $containerName, $elementName ) : TheSeer\fDOM\fDOMElement
getRootNode ( )
setName ( $name, TheSeer\fDOM\fDOMElement $ctx )

Private Methods

Method	Description
adjustStaticResolution ( TheSeer\fDOM\fDOMElement $ctx )
getMethod ( $name )
hasMethod ( $name )

Method Details

__construct() public method

public __construct ( string $name = NULL, TheSeer\phpDox\Collector\SourceFile $file = NULL )
$name	string
$file	TheSeer\phpDox\Collector\SourceFile

addConstant() public method

public addConstant ( $name ) : ConstantObject
$name
return	ConstantObject

addExtender() public method

public addExtender ( AbstractUnitObject $unit )
$unit	AbstractUnitObject

addExtends() public method

public addExtends ( $name )
$name

addImplements() public method

public addImplements ( $name )
$name

addMember() public method

public addMember ( $name ) : MemberObject
$name
return	MemberObject

addMethod() public method

public addMethod ( $name )

addToContainer() protected method

protected addToContainer ( $containerName, $elementName ) : TheSeer\fDOM\fDOMElement
$containerName
$elementName
return	TheSeer\fDOM\fDOMElement

addTrait() public method

public addTrait ( string $name ) : TheSeer\phpDox\Collector\TraitUseObject
$name	string
return	TheSeer\phpDox\Collector\TraitUseObject

export() public method

public export ( ) : TheSeer\fDOM\fDOMDocument
return	TheSeer\fDOM\fDOMDocument

getCompactDescription() public method

public getCompactDescription ( ) : string
return	string

getConstants() public method

public getConstants ( ) : array
return	array

getExportedMembers() public method

public getExportedMembers ( ) : array
return	array

getExportedMethods() public method

public getExportedMethods ( ) : MethodObject[]
return	MethodObject[]

getExtends() public method

public getExtends ( ) : mixed
return	mixed

getImplements() public method

public getImplements ( ) : array
return	array

getLocalName() public method

public getLocalName ( ) : string
return	string

getName() public method

public getName ( ) : string
return	string

getNamespace() public method

public getNamespace ( ) : string
return	string

getRootNode() protected method

protected getRootNode ( )

getSourceFilename() public method

public getSourceFilename ( ) : TheSeer\phpDox\FileInfo
return	TheSeer\phpDox\FileInfo

getTraitUse() public method

public getTraitUse ( $name ) : TheSeer\phpDox\Collector\TraitUseObject
$name
return	TheSeer\phpDox\Collector\TraitUseObject

getType() public method

public getType ( )

getUsedTraits() public method

public getUsedTraits ( ) : array
return	array

hasExtends() public method

public hasExtends ( ) : boolean
return	boolean

hasImplements() public method

public hasImplements ( ) : boolean
return	boolean

import() public method

public import ( TheSeer\fDOM\fDOMDocument $dom )
$dom	TheSeer\fDOM\fDOMDocument

importExports() public method

public importExports ( AbstractUnitObject $unit, $container = 'parent' )
$unit	AbstractUnitObject

importTraitExports() public method

public importTraitExports ( AbstractUnitObject $trait, TheSeer\phpDox\Collector\TraitUseObject $use )
$trait	AbstractUnitObject
$use	TheSeer\phpDox\Collector\TraitUseObject

markDependencyAsUnresolved() public method

public markDependencyAsUnresolved ( string $dependency )
$dependency	string

setAbstract() public method

public setAbstract ( boolean $isAbstract )
$isAbstract	boolean

setDocBlock() public method

public setDocBlock ( DocBlock $docblock )
$docblock	TheSeer\phpDox\DocBlock\DocBlock

setEndLine() public method

public setEndLine ( integer $endLine )
$endLine	integer

setFinal() public method

public setFinal ( boolean $isFinal )
$isFinal	boolean

setName() protected method

protected setName ( $name, TheSeer\fDOM\fDOMElement $ctx )
$name
$ctx	TheSeer\fDOM\fDOMElement

setStartLine() public method

public setStartLine ( integer $startLine )
$startLine	integer

usesTraits() public method

public usesTraits ( ) : boolean
return	boolean

usesTtrait() public method

public usesTtrait ( $name ) : boolean
$name
return	boolean

Property Details

$rootName protected_oe property

protected string $rootName
return	string