PHP Class TheSeer\phpDox\Collector\Project

Mostrar archivo Open project: theseer/phpdox Class Usage Examples

Public Methods

Method Description
__construct ( TheSeer\phpDox\FileInfo $srcDir, TheSeer\phpDox\FileInfo $xmlDir )
addClass ( ClassObject $class )
addFile ( TheSeer\phpDox\Collector\SourceFile $file ) : boolean
addInterface ( InterfaceObject $interface )
addTrait ( TraitObject $trait )
cleanVanishedFiles ( ) : array
getIndex ( ) : TheSeer\fDOM\fDOMDocument
getSourceDir ( ) : TheSeer\phpDox\FileInfo
getSourceTree ( ) : TheSeer\fDOM\fDOMDocument
getUnitByName ( $name ) : TheSeer\fDOM\fDOMElement
getXmlDir ( ) : TheSeer\phpDox\FileInfo
hasNamespaces ( ) : boolean
registerForSaving ( AbstractUnitObject $unit )
removeFile ( TheSeer\phpDox\FileInfo $file )
save ( ) : array

Private Methods

Method Description
findAffectedUnits ( $fname ) : array
initCollections ( ) : void
initDirectories ( )
removeFileReferences ( string $path )
saveSources ( )
saveUnit ( array $map, array $reportUnits, AbstractUnitObject $unit )

Method Details

__construct() public method

public __construct ( TheSeer\phpDox\FileInfo $srcDir, TheSeer\phpDox\FileInfo $xmlDir )
$srcDir TheSeer\phpDox\FileInfo
$xmlDir TheSeer\phpDox\FileInfo

addClass() public method

public addClass ( ClassObject $class )
$class ClassObject

addFile() public method

public addFile ( TheSeer\phpDox\Collector\SourceFile $file ) : boolean
$file TheSeer\phpDox\Collector\SourceFile
return boolean

addInterface() public method

public addInterface ( InterfaceObject $interface )
$interface InterfaceObject

addTrait() public method

public addTrait ( TraitObject $trait )
$trait TraitObject

cleanVanishedFiles() public method

public cleanVanishedFiles ( ) : array
return array

getIndex() public method

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

getSourceDir() public method

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

getSourceTree() public method

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

getUnitByName() public method

public getUnitByName ( $name ) : TheSeer\fDOM\fDOMElement
$name
return TheSeer\fDOM\fDOMElement

getXmlDir() public method

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

hasNamespaces() public method

public hasNamespaces ( ) : boolean
return boolean

registerForSaving() public method

public registerForSaving ( AbstractUnitObject $unit )
$unit AbstractUnitObject

removeFile() public method

public removeFile ( TheSeer\phpDox\FileInfo $file )
$file TheSeer\phpDox\FileInfo

save() public method

public save ( ) : array
return array