Blame view

vendor/symfony/console/Helper/DescriptorHelper.php 2.53 KB
ad2e91f7   Mihail   move multyparser ...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
  <?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\Component\Console\Helper;
  
  use Symfony\Component\Console\Descriptor\DescriptorInterface;
  use Symfony\Component\Console\Descriptor\JsonDescriptor;
  use Symfony\Component\Console\Descriptor\MarkdownDescriptor;
  use Symfony\Component\Console\Descriptor\TextDescriptor;
  use Symfony\Component\Console\Descriptor\XmlDescriptor;
  use Symfony\Component\Console\Output\OutputInterface;
  
  /**
   * This class adds helper method to describe objects in various formats.
   *
   * @author Jean-François Simon <contact@jfsimon.fr>
   */
  class DescriptorHelper extends Helper
  {
      /**
       * @var DescriptorInterface[]
       */
      private $descriptors = array();
  
      /**
       * Constructor.
       */
      public function __construct()
      {
          $this
              ->register('txt', new TextDescriptor())
              ->register('xml', new XmlDescriptor())
              ->register('json', new JsonDescriptor())
              ->register('md', new MarkdownDescriptor())
          ;
      }
  
      /**
       * Describes an object if supported.
       *
       * Available options are:
       * * format: string, the output format name
       * * raw_text: boolean, sets output type as raw
       *
       * @param OutputInterface $output
       * @param object          $object
       * @param array           $options
       *
       * @throws \InvalidArgumentException when the given format is not supported
       */
      public function describe(OutputInterface $output, $object, array $options = array())
      {
          $options = array_merge(array(
              'raw_text' => false,
              'format' => 'txt',
          ), $options);
  
          if (!isset($this->descriptors[$options['format']])) {
              throw new \InvalidArgumentException(sprintf('Unsupported format "%s".', $options['format']));
          }
  
          $descriptor = $this->descriptors[$options['format']];
          $descriptor->describe($output, $object, $options);
      }
  
      /**
       * Registers a descriptor.
       *
       * @param string              $format
       * @param DescriptorInterface $descriptor
       *
       * @return DescriptorHelper
       */
      public function register($format, DescriptorInterface $descriptor)
      {
          $this->descriptors[$format] = $descriptor;
  
          return $this;
      }
  
      /**
       * {@inheritdoc}
       */
      public function getName()
      {
          return 'descriptor';
      }
  }