vendor/symfony/console/Symfony/Component/Console/Helper/HelperInterface.php

   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
  12 namespace Symfony\Component\Console\Helper;
  13
  14 /**
  15  * HelperInterface is the interface all helpers must implement.
  16  *
  17  * @author Fabien Potencier <fabien@symfony.com>
  18  *
  19  * @api
  20  */
  21 interface HelperInterface
  22 {
  23     /**
  24      * Sets the helper set associated with this helper.
  25      *
  26      * @param HelperSet $helperSet A HelperSet instance
  27      *
  28      * @api
  29      */
  30     public function setHelperSet(HelperSet $helperSet = null);
  31
  32     /**
  33      * Gets the helper set associated with this helper.
  34      *
  35      * @return HelperSet A HelperSet instance
  36      *
  37      * @api
  38      */
  39     public function getHelperSet();
  40
  41     /**
  42      * Returns the canonical name of this helper.
  43      *
  44      * @return string The canonical name
  45      *
  46      * @api
  47      */
  48     public function getName();
  49 }