phpDocumentor
\
phpDocumentor
Compiler
Linker
Pass
Configuration
Definition
Exception
Console
Command
Project
DependencyInjection
Descriptor
Builder
Reflector
Docblock
Tags
Cache
DocBlock
Example
Exception
Filter
Interfaces
ProjectDescriptor
Query
TableOfContents
Tag
BaseTypes
Traits
Validation
ValueObjects
Event
Guides
DependencyInjection
Handlers
References
Resolver
Php
Parser
Cache
Event
Exception
Middleware
Pipeline
Stage
Cache
Parser
Transformer
Event
Router
Template
Writer
Exception
Graph
Twig
LinkRenderer

\phpDocumentor\Transformer\RouterRouter

Summary

Methods
Properties
Constants
__construct()
generate()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
generateUrlForDescriptor()
slugifyNameBasedOnType()
removeFileExtensionFromPath()
$fqsenUrlGenerator
$urlGenerator
$slugger
N/A

Properties

$fqsenUrlGenerator

$fqsenUrlGenerator : \phpDocumentor\Transformer\Router\ClassBasedFqsenUrlGenerator

Type

\phpDocumentor\Transformer\Router\ClassBasedFqsenUrlGenerator

$urlGenerator

$urlGenerator : \Symfony\Component\Routing\Generator\UrlGeneratorInterface

Type

\Symfony\Component\Routing\Generator\UrlGeneratorInterface

$slugger

$slugger : \Symfony\Component\String\Slugger\SluggerInterface

Type

\Symfony\Component\String\Slugger\SluggerInterface

Methods

__construct()

__construct(\phpDocumentor\Transformer\Router\ClassBasedFqsenUrlGenerator  $fqsenUrlGenerator, \Symfony\Component\Routing\Generator\UrlGeneratorInterface  $urlGenerator, \Symfony\Component\String\Slugger\SluggerInterface  $slugger) : mixed

Parameters

\phpDocumentor\Transformer\Router\ClassBasedFqsenUrlGenerator $fqsenUrlGenerator
\Symfony\Component\Routing\Generator\UrlGeneratorInterface $urlGenerator
\Symfony\Component\String\Slugger\SluggerInterface $slugger

Returns

mixed —

generate()

generate(\phpDocumentor\Descriptor\Interfaces\ElementInterface|\phpDocumentor\Descriptor\Descriptor|\phpDocumentor\Reflection\Fqsen|\League\Uri\Contracts\UriInterface  $node) : string

Parameters

\phpDocumentor\Descriptor\Interfaces\ElementInterface|\phpDocumentor\Descriptor\Descriptor|\phpDocumentor\Reflection\Fqsen|\League\Uri\Contracts\UriInterface $node

Returns

string —

generateUrlForDescriptor()

generateUrlForDescriptor(string  $type, string  $fqsen, string  $fragment = '') : string

Parameters

string $type
string $fqsen
string $fragment

Returns

string —

slugifyNameBasedOnType()

slugifyNameBasedOnType(string  $type, string  $name) : string

Parameters

string $type
string $name

Returns

string —

removeFileExtensionFromPath()

removeFileExtensionFromPath(string  $path) : string

Removes the file extension from the provided path.

Parameters

string $path

Returns

string —