Description.php 1.2KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546
  1. <?php
  2. /*
  3. This program is free software: you can redistribute it and/or modify
  4. it under the terms of the GNU General Public License as published by
  5. the Free Software Foundation, either version 3 of the License, or
  6. (at your option) any later version.
  7. This program is distributed in the hope that it will be useful,
  8. but WITHOUT ANY WARRANTY; without even the implied warranty of
  9. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  10. GNU General Public License for more details.
  11. You should have received a copy of the GNU General Public License
  12. along with this program. If not, see <http://www.gnu.org/licenses/>.
  13. */
  14. /**
  15. * A Description container for error messages.
  16. * @author Chris Corbyn <chris@w3style.co.uk>
  17. * @package Yay
  18. */
  19. interface Yay_Description
  20. {
  21. /**
  22. * Append an existing Description to this Description.
  23. * @param Yay_Description
  24. */
  25. public function appendDescription(Yay_Description $description);
  26. /**
  27. * Append text content to this Description.
  28. * @param string $text
  29. */
  30. public function appendText($text);
  31. /**
  32. * Get this description back as a formatted string.
  33. * @return string
  34. */
  35. public function toString();
  36. }