HelperInterface.php 1011 B

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