PHP Class ApiGen\Templating\Filters\SourceFilters

Inheritance: extends Filters

Datei anzeigen Open project: apigen/apigen Class Usage Examples

Public Methods

Method	Description
__construct ( ApiGen\Contracts\Configuration\ConfigurationInterface $configuration )
sourceUrl ( ApiGen\Contracts\Parser\Reflection\ElementReflectionInterface $element, boolean $withLine = true ) : string
staticFile ( string $name ) : string

Private Methods

Method	Description
getElementLinesAnchor ( ApiGen\Contracts\Parser\Reflection\Behavior\LinedInterface $element ) : string
isDirectUrl ( ApiGen\Contracts\Parser\Reflection\ElementReflectionInterface $element ) : boolean

Method Details

__construct() public method

public __construct ( ApiGen\Contracts\Configuration\ConfigurationInterface $configuration )
$configuration	ApiGen\Contracts\Configuration\ConfigurationInterface

sourceUrl() public method

public sourceUrl ( ApiGen\Contracts\Parser\Reflection\ElementReflectionInterface $element, boolean $withLine = true ) : string
$element	ApiGen\Contracts\Parser\Reflection\ElementReflectionInterface
$withLine	boolean	Include file line number into the link
return	string

staticFile() public method

public staticFile ( string $name ) : string
$name	string
return	string