Current File : //var/www/vinorea/vendor/friendsofsymfony/jsrouting-bundle/Command/RouterDebugExposedCommand.php |
<?php
/*
* This file is part of the FOSJsRoutingBundle package.
*
* (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace FOS\JsRoutingBundle\Command;
use FOS\JsRoutingBundle\Extractor\ExposedRoutesExtractorInterface;
use Symfony\Bundle\FrameworkBundle\Console\Helper\DescriptorHelper;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Routing\Route;
use Symfony\Component\Routing\RouterInterface;
use Symfony\Component\Routing\RouteCollection;
/**
* A console command for retrieving information about exposed routes.
*
* @author William DURAND <william.durand1@gmail.com>
*/
class RouterDebugExposedCommand extends Command
{
protected static $defaultName = 'fos:js-routing:debug';
private $extractor;
private $router;
public function __construct(ExposedRoutesExtractorInterface $extractor, RouterInterface $router)
{
$this->extractor = $extractor;
$this->router = $router;
parent::__construct();
}
/**
* {@inheritdoc}
*/
protected function configure()
{
$this
->setDefinition(array(
new InputArgument('name', InputArgument::OPTIONAL, 'A route name'),
new InputOption('show-controllers', null, InputOption::VALUE_NONE, 'Show assigned controllers in overview'),
new InputOption('format', null, InputOption::VALUE_REQUIRED, 'The output format (txt, xml, json, or md)', 'txt'),
new InputOption('raw', null, InputOption::VALUE_NONE, 'To output raw route(s)'),
new InputOption('domain', null, InputOption::VALUE_OPTIONAL | InputOption::VALUE_IS_ARRAY, 'Specify expose domain', array())
))
->setName('fos:js-routing:debug')
->setDescription('Displays currently exposed routes for an application')
->setHelp(<<<EOF
The <info>fos:js-routing:debug</info> command displays an application's routes which will be available via JavaScript.
<info>php app/console fos:js-routing:debug</info>
You can alternatively specify a route name as an argument to get more info about that specific route:
<info>php app/console fos:js-routing:debug my_route</info>
EOF
)
;
}
/**
* @see Command
*/
protected function execute(InputInterface $input, OutputInterface $output): int
{
if ($name = $input->getArgument('name')) {
/** @var Route $route */
$route = $this->router->getRouteCollection()->get($name);
if (!$route) {
throw new \InvalidArgumentException(sprintf('The route "%s" does not exist.', $name));
}
if (!$this->extractor->isRouteExposed($route, $name)) {
throw new \InvalidArgumentException(sprintf('The route "%s" was found, but it is not an exposed route.', $name));
}
$helper = new DescriptorHelper();
$helper->describe($output, $route, array(
'format' => $input->getOption('format'),
'raw_text' => $input->getOption('raw'),
'show_controllers' => $input->getOption('show-controllers'),
));
} else {
$helper = new DescriptorHelper();
$helper->describe($output, $this->getRoutes($input->getOption('domain')), array(
'format' => $input->getOption('format'),
'raw_text' => $input->getOption('raw'),
'show_controllers' => $input->getOption('show-controllers'),
));
}
return 0;
}
protected function getRoutes($domain = array())
{
$routes = $this->extractor->getRoutes();
if (empty($domain)) {
return $routes;
}
$targetRoutes = new RouteCollection();
foreach ($routes as $name => $route) {
$expose = $route->getOption('expose');
$expose = is_string($expose) ? ($expose === 'true' ? 'default' : $expose) : 'default';
if (in_array($expose, $domain, true)) {
$targetRoutes->add($name, $route);
}
}
return $targetRoutes;
}
}