123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304 |
- <?php
- /*
- * This file is part of the Symfony package.
- *
- * (c) Fabien Potencier <fabien@symfony.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
- namespace Symfony\Bundle\FrameworkBundle\Console\Descriptor;
- use Symfony\Component\Console\Descriptor\DescriptorInterface;
- use Symfony\Component\Console\Helper\Table;
- use Symfony\Component\Console\Output\OutputInterface;
- use Symfony\Component\DependencyInjection\Alias;
- use Symfony\Component\DependencyInjection\ContainerBuilder;
- use Symfony\Component\DependencyInjection\Definition;
- use Symfony\Component\DependencyInjection\ParameterBag\ParameterBag;
- use Symfony\Component\EventDispatcher\EventDispatcherInterface;
- use Symfony\Component\Routing\Route;
- use Symfony\Component\Routing\RouteCollection;
- /**
- * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com>
- *
- * @internal
- */
- abstract class Descriptor implements DescriptorInterface
- {
- /**
- * @var OutputInterface
- */
- private $output;
- /**
- * {@inheritdoc}
- */
- public function describe(OutputInterface $output, $object, array $options = array())
- {
- $this->output = $output;
- switch (true) {
- case $object instanceof RouteCollection:
- $this->describeRouteCollection($object, $options);
- break;
- case $object instanceof Route:
- $this->describeRoute($object, $options);
- break;
- case $object instanceof ParameterBag:
- $this->describeContainerParameters($object, $options);
- break;
- case $object instanceof ContainerBuilder && isset($options['group_by']) && 'tags' === $options['group_by']:
- $this->describeContainerTags($object, $options);
- break;
- case $object instanceof ContainerBuilder && isset($options['id']):
- $this->describeContainerService($this->resolveServiceDefinition($object, $options['id']), $options);
- break;
- case $object instanceof ContainerBuilder && isset($options['parameter']):
- $this->describeContainerParameter($object->getParameter($options['parameter']), $options);
- break;
- case $object instanceof ContainerBuilder:
- $this->describeContainerServices($object, $options);
- break;
- case $object instanceof Definition:
- $this->describeContainerDefinition($object, $options);
- break;
- case $object instanceof Alias:
- $this->describeContainerAlias($object, $options);
- break;
- case $object instanceof EventDispatcherInterface:
- $this->describeEventDispatcherListeners($object, $options);
- break;
- case \is_callable($object):
- $this->describeCallable($object, $options);
- break;
- default:
- throw new \InvalidArgumentException(sprintf('Object of type "%s" is not describable.', \get_class($object)));
- }
- }
- /**
- * Returns the output.
- *
- * @return OutputInterface The output
- */
- protected function getOutput()
- {
- return $this->output;
- }
- /**
- * Writes content to output.
- *
- * @param string $content
- * @param bool $decorated
- */
- protected function write($content, $decorated = false)
- {
- $this->output->write($content, false, $decorated ? OutputInterface::OUTPUT_NORMAL : OutputInterface::OUTPUT_RAW);
- }
- /**
- * Writes content to output.
- *
- * @param Table $table
- * @param bool $decorated
- */
- protected function renderTable(Table $table, $decorated = false)
- {
- if (!$decorated) {
- $tableStyle = $table->getStyle();
- $tableStyle->setCellRowFormat('%s');
- $tableStyle->setCellRowContentFormat('%s');
- $tableStyle->setCellHeaderFormat('%s');
- }
- $table->render();
- }
- /**
- * Describes an InputArgument instance.
- */
- abstract protected function describeRouteCollection(RouteCollection $routes, array $options = array());
- /**
- * Describes an InputOption instance.
- */
- abstract protected function describeRoute(Route $route, array $options = array());
- /**
- * Describes container parameters.
- */
- abstract protected function describeContainerParameters(ParameterBag $parameters, array $options = array());
- /**
- * Describes container tags.
- */
- abstract protected function describeContainerTags(ContainerBuilder $builder, array $options = array());
- /**
- * Describes a container service by its name.
- *
- * Common options are:
- * * name: name of described service
- *
- * @param Definition|Alias|object $service
- * @param array $options
- */
- abstract protected function describeContainerService($service, array $options = array());
- /**
- * Describes container services.
- *
- * Common options are:
- * * tag: filters described services by given tag
- */
- abstract protected function describeContainerServices(ContainerBuilder $builder, array $options = array());
- /**
- * Describes a service definition.
- */
- abstract protected function describeContainerDefinition(Definition $definition, array $options = array());
- /**
- * Describes a service alias.
- */
- abstract protected function describeContainerAlias(Alias $alias, array $options = array());
- /**
- * Describes a container parameter.
- */
- abstract protected function describeContainerParameter($parameter, array $options = array());
- /**
- * Describes event dispatcher listeners.
- *
- * Common options are:
- * * name: name of listened event
- */
- abstract protected function describeEventDispatcherListeners(EventDispatcherInterface $eventDispatcher, array $options = array());
- /**
- * Describes a callable.
- *
- * @param callable $callable
- * @param array $options
- */
- abstract protected function describeCallable($callable, array $options = array());
- /**
- * Formats a value as string.
- *
- * @param mixed $value
- *
- * @return string
- */
- protected function formatValue($value)
- {
- if (\is_object($value)) {
- return sprintf('object(%s)', \get_class($value));
- }
- if (\is_string($value)) {
- return $value;
- }
- return preg_replace("/\n\s*/s", '', var_export($value, true));
- }
- /**
- * Formats a parameter.
- *
- * @param mixed $value
- *
- * @return string
- */
- protected function formatParameter($value)
- {
- if (\is_bool($value) || \is_array($value) || (null === $value)) {
- $jsonString = json_encode($value);
- if (preg_match('/^(.{60})./us', $jsonString, $matches)) {
- return $matches[1].'...';
- }
- return $jsonString;
- }
- return (string) $value;
- }
- /**
- * @param ContainerBuilder $builder
- * @param string $serviceId
- *
- * @return mixed
- */
- protected function resolveServiceDefinition(ContainerBuilder $builder, $serviceId)
- {
- if ($builder->hasDefinition($serviceId)) {
- return $builder->getDefinition($serviceId);
- }
- // Some service IDs don't have a Definition, they're simply an Alias
- if ($builder->hasAlias($serviceId)) {
- return $builder->getAlias($serviceId);
- }
- if ('service_container' === $serviceId) {
- return $builder;
- }
- // the service has been injected in some special way, just return the service
- return $builder->get($serviceId);
- }
- /**
- * @param ContainerBuilder $builder
- * @param bool $showPrivate
- *
- * @return array
- */
- protected function findDefinitionsByTag(ContainerBuilder $builder, $showPrivate)
- {
- $definitions = array();
- $tags = $builder->findTags();
- asort($tags);
- foreach ($tags as $tag) {
- foreach ($builder->findTaggedServiceIds($tag) as $serviceId => $attributes) {
- $definition = $this->resolveServiceDefinition($builder, $serviceId);
- if (!$definition instanceof Definition || !$showPrivate && !$definition->isPublic()) {
- continue;
- }
- if (!isset($definitions[$tag])) {
- $definitions[$tag] = array();
- }
- $definitions[$tag][$serviceId] = $definition;
- }
- }
- return $definitions;
- }
- protected function sortParameters(ParameterBag $parameters)
- {
- $parameters = $parameters->all();
- ksort($parameters);
- return $parameters;
- }
- protected function sortServiceIds(array $serviceIds)
- {
- asort($serviceIds);
- return $serviceIds;
- }
- }
|