<?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\Exception\InvalidArgumentException; 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 array $descriptors = []; 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 * * @throws InvalidArgumentException when the given format is not supported */ public function describe(OutputInterface $output, ?object $object, array $options = []) { $options = array_merge([ '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. * * @return $this */ public function register(string $format, DescriptorInterface $descriptor): static { $this->descriptors[$format] = $descriptor; return $this; } public function getName(): string { return 'descriptor'; } public function getFormats(): array { return array_keys($this->descriptors); } }
Name | Type | Size | Permission | Actions |
---|---|---|---|---|
DebugFormatterHelper.php | File | 3.24 KB | 0644 |
|
DescriptorHelper.php | File | 2.42 KB | 0644 |
|
Dumper.php | File | 1.85 KB | 0644 |
|
FormatterHelper.php | File | 2.18 KB | 0644 |
|
Helper.php | File | 4.32 KB | 0644 |
|
HelperInterface.php | File | 814 B | 0644 |
|
HelperSet.php | File | 1.79 KB | 0644 |
|
InputAwareHelper.php | File | 710 B | 0644 |
|
OutputWrapper.php | File | 2.94 KB | 0644 |
|
ProcessHelper.php | File | 4.64 KB | 0644 |
|
ProgressBar.php | File | 18.55 KB | 0644 |
|
ProgressIndicator.php | File | 6.85 KB | 0644 |
|
QuestionHelper.php | File | 19.13 KB | 0644 |
|
SymfonyQuestionHelper.php | File | 3.13 KB | 0644 |
|
Table.php | File | 30.57 KB | 0644 |
|
TableCell.php | File | 1.72 KB | 0644 |
|
TableCellStyle.php | File | 2.2 KB | 0644 |
|
TableRows.php | File | 590 B | 0644 |
|
TableSeparator.php | File | 531 B | 0644 |
|
TableStyle.php | File | 12.46 KB | 0644 |
|