[Summary view] [Print] [Text view]

   1  <?php
   2  /**
   3   * Part of the Joomla Framework Console Package
   4   *
   5   * @copyright  Copyright (C) 2005 - 2021 Open Source Matters, Inc. All rights reserved.
   6   * @license    GNU General Public License version 2 or later; see LICENSE
   7   */
   8  
   9  namespace Joomla\Console\Helper;
  10  
  11  use Joomla\Console\Descriptor\TextDescriptor;
  12  use Symfony\Component\Console\Helper\Helper;
  13  use Symfony\Component\Console\Output\OutputInterface;
  14  
  15  /**
  16   * Describes an object.
  17   *
  18   * @since  2.0.0
  19   */
  20  class DescriptorHelper extends Helper
  21  {
  22      /**
  23       * Describes an object if supported.
  24       *
  25       * @param   OutputInterface  $output   The output object to use.
  26       * @param   object           $object   The object to describe.
  27       * @param   array            $options  Options for the descriptor.
  28       *
  29       * @return  void
  30       *
  31       * @since   _2.0.0
  32       */
  33  	public function describe(OutputInterface $output, $object, array $options = [])
  34      {
  35          (new TextDescriptor)->describe($output, $object, $options);
  36      }
  37  
  38      /**
  39       * Returns the canonical name of this helper.
  40       *
  41       * @return  string  The canonical name
  42       *
  43       * @since   _2.0.0
  44       */
  45  	public function getName()
  46      {
  47          return 'descriptor';
  48      }
  49  }