api/symfony/Bundle/FrameworkBundle/Command/RouterDebugCommand.yaml
2024-09-26 02:03:21 -07:00

113 lines
4.4 KiB
YAML

name: RouterDebugCommand
class_comment: null
dependencies:
- name: DescriptorHelper
type: class
source: Symfony\Bundle\FrameworkBundle\Console\Helper\DescriptorHelper
- name: AsCommand
type: class
source: Symfony\Component\Console\Attribute\AsCommand
- name: Command
type: class
source: Symfony\Component\Console\Command\Command
- name: CompletionInput
type: class
source: Symfony\Component\Console\Completion\CompletionInput
- name: CompletionSuggestions
type: class
source: Symfony\Component\Console\Completion\CompletionSuggestions
- name: InvalidArgumentException
type: class
source: Symfony\Component\Console\Exception\InvalidArgumentException
- name: InputArgument
type: class
source: Symfony\Component\Console\Input\InputArgument
- name: InputInterface
type: class
source: Symfony\Component\Console\Input\InputInterface
- name: InputOption
type: class
source: Symfony\Component\Console\Input\InputOption
- name: OutputInterface
type: class
source: Symfony\Component\Console\Output\OutputInterface
- name: SymfonyStyle
type: class
source: Symfony\Component\Console\Style\SymfonyStyle
- name: FileLinkFormatter
type: class
source: Symfony\Component\ErrorHandler\ErrorRenderer\FileLinkFormatter
- name: RouteCollection
type: class
source: Symfony\Component\Routing\RouteCollection
- name: RouterInterface
type: class
source: Symfony\Component\Routing\RouterInterface
- name: BuildDebugContainerTrait
type: class
source: BuildDebugContainerTrait
properties: []
methods:
- name: execute
visibility: protected
parameters:
- name: input
- name: output
comment: "# * A console command for retrieving information about routes.\n# *\n\
# * @author Fabien Potencier <fabien@symfony.com>\n# * @author Tobias Schultze\
\ <http://tobion.de>\n# *\n# * @final\n# */\n# #[AsCommand(name: 'debug:router',\
\ description: 'Display current routes for an application')]\n# class RouterDebugCommand\
\ extends Command\n# {\n# use BuildDebugContainerTrait;\n# \n# public function\
\ __construct(\n# private RouterInterface $router,\n# private ?FileLinkFormatter\
\ $fileLinkFormatter = null,\n# ) {\n# parent::__construct();\n# }\n# \n# protected\
\ function configure(): void\n# {\n# $this\n# ->setDefinition([\n# new InputArgument('name',\
\ InputArgument::OPTIONAL, 'A route name'),\n# new InputOption('show-controllers',\
\ null, InputOption::VALUE_NONE, 'Show assigned controllers in overview'),\n#\
\ new InputOption('show-aliases', null, InputOption::VALUE_NONE, 'Show aliases\
\ in overview'),\n# new InputOption('format', null, InputOption::VALUE_REQUIRED,\
\ \\sprintf('The output format (\"%s\")', implode('\", \"', $this->getAvailableFormatOptions())),\
\ 'txt'),\n# new InputOption('raw', null, InputOption::VALUE_NONE, 'To output\
\ raw route(s)'),\n# ])\n# ->setHelp(<<<'EOF'\n# The <info>%command.name%</info>\
\ displays the configured routes:\n# \n# <info>php %command.full_name%</info>\n\
# \n# The <info>--format</info> option specifies the format of the command output:\n\
# \n# <info>php %command.full_name% --format=json</info>\n# EOF\n# )\n# ;\n# }\n\
# \n# /**\n# * @throws InvalidArgumentException When route does not exist"
- name: findRouteNameContaining
visibility: private
parameters:
- name: name
- name: routes
comment: null
- name: complete
visibility: public
parameters:
- name: input
- name: suggestions
comment: null
- name: findRouteContaining
visibility: private
parameters:
- name: name
- name: routes
comment: null
- name: getAvailableFormatOptions
visibility: private
parameters: []
comment: '# @return string[]'
traits:
- Symfony\Bundle\FrameworkBundle\Console\Helper\DescriptorHelper
- Symfony\Component\Console\Attribute\AsCommand
- Symfony\Component\Console\Command\Command
- Symfony\Component\Console\Completion\CompletionInput
- Symfony\Component\Console\Completion\CompletionSuggestions
- Symfony\Component\Console\Exception\InvalidArgumentException
- Symfony\Component\Console\Input\InputArgument
- Symfony\Component\Console\Input\InputInterface
- Symfony\Component\Console\Input\InputOption
- Symfony\Component\Console\Output\OutputInterface
- Symfony\Component\Console\Style\SymfonyStyle
- Symfony\Component\ErrorHandler\ErrorRenderer\FileLinkFormatter
- Symfony\Component\Routing\RouteCollection
- Symfony\Component\Routing\RouterInterface
- BuildDebugContainerTrait
interfaces: []