Pelzini

This is the code documentation for the Pelzini project

source of /processor/parser_variable.php

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