Pelzini

This is the code documentation for the Pelzini project

source of /processor/parser_item.php

Contains the ParserItem class
  1. <?php
  2. /*
  3. Copyright 2008 Josh Heidenreich
  4.  
  5. This file is part of Pelzini.
  6.  
  7. Pelzini is free software: you can redistribute it and/or modify
  8. it under the terms of the GNU General Public License as published by
  9. the Free Software Foundation, either version 3 of the License, or
  10. (at your option) any later version.
  11.  
  12. Pelzini is distributed in the hope that it will be useful,
  13. but WITHOUT ANY WARRANTY; without even the implied warranty of
  14. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15. GNU General Public License for more details.
  16.  
  17. You should have received a copy of the GNU General Public License
  18. along with Pelzini. If not, see <http://www.gnu.org/licenses/>.
  19. */
  20.  
  21.  
  22. /**
  23.  * Contains the {@link ParserItem} class
  24.  *
  25.  * @package Parser model
  26.  * @author Josh Heidenreich
  27.  * @since 0.2
  28.  **/
  29.  
  30. /**
  31.  * The top-level class of all parser items. Almost all ParserItems should extend {@link CodeParserItem}.
  32.  **/
  33. abstract class ParserItem
  34. {
  35.  
  36. /**
  37.   * In almost all cases this method should be overwritten, but it does not have to be.
  38.   * All overwriting classes must call this method at the beginning of their constructor:
  39.   * parent::__construct();
  40.   **/
  41. protected function __construct()
  42. {}
  43.  
  44.  
  45. /**
  46.   * Is used for debugging.
  47.   **/
  48. abstract protected function dump();
  49.  
  50. }
  51.  
  52.  
  53. ?>
  54.