Pelzini

This is the code documentation for the Pelzini project

source of /processor/transformer.php

Contains the Transformer 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 Transformer} class
  24.  *
  25.  * @package Transformers
  26.  * @author Josh
  27.  * @since 0.2
  28.  **/
  29.  
  30. /**
  31.  * The top-level class of all transformers.
  32.  * Transformers alter the parser model before it is outputted, for creating reports, etc.
  33.  **/
  34. abstract class Transformer
  35. {
  36.  
  37. /**
  38.   * Transforms the data model before outputting
  39.   *
  40.   * @param array $parser_model The data model to transform
  41.   * @return array The new data model, or null if there was an error
  42.   **/
  43. abstract public function transform(&$parser_model);
  44.  
  45. }
  46.  
  47.  
  48. ?>
  49.