DebugFormatterHelper.php
2 years ago
DescriptorHelper.php
2 years ago
Dumper.php
2 years ago
FormatterHelper.php
2 years ago
Helper.php
2 years ago
HelperInterface.php
2 years ago
HelperSet.php
2 years ago
InputAwareHelper.php
2 years ago
ProcessHelper.php
2 years ago
ProgressBar.php
2 years ago
ProgressIndicator.php
2 years ago
QuestionHelper.php
2 years ago
SymfonyQuestionHelper.php
2 years ago
Table.php
2 years ago
TableCell.php
2 years ago
TableCellStyle.php
2 years ago
TableRows.php
3 years ago
TableSeparator.php
2 years ago
TableStyle.php
2 years ago
DescriptorHelper.php
76 lines
| 1 | <?php |
| 2 | |
| 3 | /* |
| 4 | * This file is part of the Symfony package. |
| 5 | * |
| 6 | * (c) Fabien Potencier <fabien@symfony.com> |
| 7 | * |
| 8 | * For the full copyright and license information, please view the LICENSE |
| 9 | * file that was distributed with this source code. |
| 10 | */ |
| 11 | namespace IAWP_SCOPED\Symfony\Component\Console\Helper; |
| 12 | |
| 13 | use IAWP_SCOPED\Symfony\Component\Console\Descriptor\DescriptorInterface; |
| 14 | use IAWP_SCOPED\Symfony\Component\Console\Descriptor\JsonDescriptor; |
| 15 | use IAWP_SCOPED\Symfony\Component\Console\Descriptor\MarkdownDescriptor; |
| 16 | use IAWP_SCOPED\Symfony\Component\Console\Descriptor\TextDescriptor; |
| 17 | use IAWP_SCOPED\Symfony\Component\Console\Descriptor\XmlDescriptor; |
| 18 | use IAWP_SCOPED\Symfony\Component\Console\Exception\InvalidArgumentException; |
| 19 | use IAWP_SCOPED\Symfony\Component\Console\Output\OutputInterface; |
| 20 | /** |
| 21 | * This class adds helper method to describe objects in various formats. |
| 22 | * |
| 23 | * @author Jean-François Simon <contact@jfsimon.fr> |
| 24 | * @internal |
| 25 | */ |
| 26 | class DescriptorHelper extends Helper |
| 27 | { |
| 28 | /** |
| 29 | * @var DescriptorInterface[] |
| 30 | */ |
| 31 | private $descriptors = []; |
| 32 | public function __construct() |
| 33 | { |
| 34 | $this->register('txt', new TextDescriptor())->register('xml', new XmlDescriptor())->register('json', new JsonDescriptor())->register('md', new MarkdownDescriptor()); |
| 35 | } |
| 36 | /** |
| 37 | * Describes an object if supported. |
| 38 | * |
| 39 | * Available options are: |
| 40 | * * format: string, the output format name |
| 41 | * * raw_text: boolean, sets output type as raw |
| 42 | * |
| 43 | * @throws InvalidArgumentException when the given format is not supported |
| 44 | */ |
| 45 | public function describe(OutputInterface $output, ?object $object, array $options = []) |
| 46 | { |
| 47 | $options = \array_merge(['raw_text' => \false, 'format' => 'txt'], $options); |
| 48 | if (!isset($this->descriptors[$options['format']])) { |
| 49 | throw new InvalidArgumentException(\sprintf('Unsupported format "%s".', $options['format'])); |
| 50 | } |
| 51 | $descriptor = $this->descriptors[$options['format']]; |
| 52 | $descriptor->describe($output, $object, $options); |
| 53 | } |
| 54 | /** |
| 55 | * Registers a descriptor. |
| 56 | * |
| 57 | * @return $this |
| 58 | */ |
| 59 | public function register(string $format, DescriptorInterface $descriptor) |
| 60 | { |
| 61 | $this->descriptors[$format] = $descriptor; |
| 62 | return $this; |
| 63 | } |
| 64 | /** |
| 65 | * {@inheritdoc} |
| 66 | */ |
| 67 | public function getName() |
| 68 | { |
| 69 | return 'descriptor'; |
| 70 | } |
| 71 | public function getFormats() : array |
| 72 | { |
| 73 | return \array_keys($this->descriptors); |
| 74 | } |
| 75 | } |
| 76 |