PHP Class ApiGen\Templating\Filters\UrlFilters

Inheritance: extends Filters
Datei anzeigen Open project: apigen/apigen

Public Methods

Method Description
__construct ( Configuration $configuration, ApiGen\Generator\SourceCodeHighlighter\SourceCodeHighlighter $highlighter, ApiGen\Generator\Markups\Markup $markup, ApiGen\Contracts\Generator\Resolvers\ElementResolverInterface $elementResolver, ApiGen\Templating\Filters\Helpers\LinkBuilder $linkBuilder, ElementLinkFactory $elementLinkFactory )
annotation ( string $value, string $name, ApiGen\Contracts\Parser\Reflection\ElementReflectionInterface $reflectionElement ) : string
description ( string $annotation, ApiGen\Contracts\Parser\Reflection\ElementReflectionInterface $reflectionElement ) : string
doc ( string $text, ApiGen\Contracts\Parser\Reflection\ElementReflectionInterface $reflectionElement, boolean $block = false ) : string
highlightPhp ( string $source, ApiGen\Contracts\Parser\Reflection\ElementReflectionInterface $reflectionElement ) : string
highlightValue ( string $definition, ApiGen\Contracts\Parser\Reflection\ElementReflectionInterface $reflectionElement ) : string
longDescription ( ApiGen\Contracts\Parser\Reflection\ElementReflectionInterface $element ) : string
resolveLink ( string $definition, ApiGen\Contracts\Parser\Reflection\ElementReflectionInterface $reflectionElement ) : string | null Tries to parse a definition of a class/method/property/constant/function and returns the appropriate link if successful.
shortDescription ( ApiGen\Contracts\Parser\Reflection\ElementReflectionInterface $reflectionElement, boolean $block = false ) : string
typeLinks ( string $annotation, ApiGen\Contracts\Parser\Reflection\ElementReflectionInterface $reflectionElement ) : string Returns links for types.

Private Methods

Method Description
createLinkForElement ( $reflectionElement, array $classes ) : string
getDescriptionFromValue ( mixed $value, ApiGen\Contracts\Parser\Reflection\ElementReflectionInterface $elementReflection ) : string
processLicenseAnnotations ( string $value ) : string
processLinkAnnotations ( string $value ) : string
processReturnAnnotations ( string $value, ApiGen\Contracts\Parser\Reflection\ElementReflectionInterface $reflectionElement ) : string
processSeeAnnotations ( string $value, ApiGen\Contracts\Parser\Reflection\ElementReflectionInterface $reflectionElement ) : string
processThrowsAnnotations ( string $value, ApiGen\Contracts\Parser\Reflection\ElementReflectionInterface $elementReflection ) : string
processUsesAndUsedbyAnnotations ( string $value, ApiGen\Contracts\Parser\Reflection\ElementReflectionInterface $reflectionElement ) : string
resolveInternalAnnotation ( string $text ) : string
resolveLinkAndSeeAnnotation ( string $text, ApiGen\Contracts\Parser\Reflection\ElementReflectionInterface $reflectionElement ) : string

Method Details

__construct() public method

public __construct ( Configuration $configuration, ApiGen\Generator\SourceCodeHighlighter\SourceCodeHighlighter $highlighter, ApiGen\Generator\Markups\Markup $markup, ApiGen\Contracts\Generator\Resolvers\ElementResolverInterface $elementResolver, ApiGen\Templating\Filters\Helpers\LinkBuilder $linkBuilder, ElementLinkFactory $elementLinkFactory )
$configuration ApiGen\Configuration\Configuration
$highlighter ApiGen\Generator\SourceCodeHighlighter\SourceCodeHighlighter
$markup ApiGen\Generator\Markups\Markup
$elementResolver ApiGen\Contracts\Generator\Resolvers\ElementResolverInterface
$linkBuilder ApiGen\Templating\Filters\Helpers\LinkBuilder
$elementLinkFactory ApiGen\Templating\Filters\Helpers\ElementLinkFactory

annotation() public method

public annotation ( string $value, string $name, ApiGen\Contracts\Parser\Reflection\ElementReflectionInterface $reflectionElement ) : string
$value string
$name string
$reflectionElement ApiGen\Contracts\Parser\Reflection\ElementReflectionInterface
return string

description() public method

public description ( string $annotation, ApiGen\Contracts\Parser\Reflection\ElementReflectionInterface $reflectionElement ) : string
$annotation string
$reflectionElement ApiGen\Contracts\Parser\Reflection\ElementReflectionInterface
return string

doc() public method

public doc ( string $text, ApiGen\Contracts\Parser\Reflection\ElementReflectionInterface $reflectionElement, boolean $block = false ) : string
$text string
$reflectionElement ApiGen\Contracts\Parser\Reflection\ElementReflectionInterface
$block boolean
return string

highlightPhp() public method

public highlightPhp ( string $source, ApiGen\Contracts\Parser\Reflection\ElementReflectionInterface $reflectionElement ) : string
$source string
$reflectionElement ApiGen\Contracts\Parser\Reflection\ElementReflectionInterface
return string

highlightValue() public method

public highlightValue ( string $definition, ApiGen\Contracts\Parser\Reflection\ElementReflectionInterface $reflectionElement ) : string
$definition string
$reflectionElement ApiGen\Contracts\Parser\Reflection\ElementReflectionInterface
return string

longDescription() public method

public longDescription ( ApiGen\Contracts\Parser\Reflection\ElementReflectionInterface $element ) : string
$element ApiGen\Contracts\Parser\Reflection\ElementReflectionInterface
return string

shortDescription() public method

public shortDescription ( ApiGen\Contracts\Parser\Reflection\ElementReflectionInterface $reflectionElement, boolean $block = false ) : string
$reflectionElement ApiGen\Contracts\Parser\Reflection\ElementReflectionInterface
$block boolean
return string