Descriptor.php 3.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107
  1. <?php
  2. /*
  3. * This file is part of the Symfony package.
  4. *
  5. * (c) Fabien Potencier <fabien@symfony.com>
  6. *
  7. * For the full copyright and license information, please view the LICENSE
  8. * file that was distributed with this source code.
  9. */
  10. namespace Symfony\Component\Console\Descriptor;
  11. use Symfony\Component\Console\Application;
  12. use Symfony\Component\Console\Command\Command;
  13. use Symfony\Component\Console\Input\InputArgument;
  14. use Symfony\Component\Console\Input\InputDefinition;
  15. use Symfony\Component\Console\Input\InputOption;
  16. use Symfony\Component\Console\Output\OutputInterface;
  17. use Symfony\Component\Console\Exception\InvalidArgumentException;
  18. /**
  19. * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com>
  20. *
  21. * @internal
  22. */
  23. abstract class Descriptor implements DescriptorInterface
  24. {
  25. /**
  26. * @var OutputInterface
  27. */
  28. private $output;
  29. /**
  30. * {@inheritdoc}
  31. */
  32. public function describe(OutputInterface $output, $object, array $options = array())
  33. {
  34. $this->output = $output;
  35. switch (true) {
  36. case $object instanceof InputArgument:
  37. $this->describeInputArgument($object, $options);
  38. break;
  39. case $object instanceof InputOption:
  40. $this->describeInputOption($object, $options);
  41. break;
  42. case $object instanceof InputDefinition:
  43. $this->describeInputDefinition($object, $options);
  44. break;
  45. case $object instanceof Command:
  46. $this->describeCommand($object, $options);
  47. break;
  48. case $object instanceof Application:
  49. $this->describeApplication($object, $options);
  50. break;
  51. default:
  52. throw new InvalidArgumentException(sprintf('Object of type "%s" is not describable.', get_class($object)));
  53. }
  54. }
  55. /**
  56. * Writes content to output.
  57. *
  58. * @param string $content
  59. * @param bool $decorated
  60. */
  61. protected function write($content, $decorated = false)
  62. {
  63. $this->output->write($content, false, $decorated ? OutputInterface::OUTPUT_NORMAL : OutputInterface::OUTPUT_RAW);
  64. }
  65. /**
  66. * Describes an InputArgument instance.
  67. *
  68. * @return string|mixed
  69. */
  70. abstract protected function describeInputArgument(InputArgument $argument, array $options = array());
  71. /**
  72. * Describes an InputOption instance.
  73. *
  74. * @return string|mixed
  75. */
  76. abstract protected function describeInputOption(InputOption $option, array $options = array());
  77. /**
  78. * Describes an InputDefinition instance.
  79. *
  80. * @return string|mixed
  81. */
  82. abstract protected function describeInputDefinition(InputDefinition $definition, array $options = array());
  83. /**
  84. * Describes a Command instance.
  85. *
  86. * @return string|mixed
  87. */
  88. abstract protected function describeCommand(Command $command, array $options = array());
  89. /**
  90. * Describes an Application instance.
  91. *
  92. * @return string|mixed
  93. */
  94. abstract protected function describeApplication(Application $application, array $options = array());
  95. }