Pelzini

This is the code documentation for the Pelzini project

source of /processor/parser_constant.php

Contains the ParserConstant 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.  * Contains the {@link ParserConstant} class
  23.  *
  24.  * @package Parser model
  25.  * @author Josh Heidenreich
  26.  * @since 0.1
  27.  **/
  28.  
  29. /**
  30.  * Represents a constant
  31.  **/
  32. class ParserConstant extends CodeParserItem {
  33. public $name;
  34. public $value;
  35. public $description;
  36.  
  37. public function __construct()
  38. {
  39. parent::__construct();
  40.  
  41. $this->description = '';
  42. }
  43.  
  44.  
  45. /**
  46.   * Applies the contents of a doc-block to this element
  47.   *
  48.   * @param $text The content of the DocBlock
  49.   **/
  50. protected function processSpecificDocblockTags($docblock_tags)
  51. {
  52. $this->description = htmlify_text(@$docblock_tags['@summary']);
  53. }
  54.  
  55.  
  56. /**
  57.   * Debugging use only
  58.   **/
  59. public function dump()
  60. {
  61. echo '<div style="border: 1px orange solid;">';
  62. echo $this->name, ' = ', $this->value;
  63. echo $this->description;
  64.  
  65. parent::dump();
  66. echo '</div>';
  67. }
  68.  
  69.  
  70. }
  71.  
  72.  
  73. ?>
  74.