Pelzini

This is the code documentation for the Pelzini project

source of /processor/metadata_outputter.php

This file contains the MetadataOutputter 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.  * This file contains the {@link MetadataOutputter} class
  24.  *
  25.  * @package Outputters
  26.  * @author Josh
  27.  * @since 0.3
  28.  **/
  29.  
  30. /**
  31.  * Outputs the tree to a metadata file
  32.  **/
  33. abstract class MetadataOutputter extends Outputter {
  34. protected $filename;
  35.  
  36.  
  37. /**
  38.   * Sets the full filename to output to
  39.   */
  40. public function __construct($filename)
  41. {
  42. $this->filename = $filename;
  43. }
  44.  
  45.  
  46. /**
  47.   * Sets the full filename to output to
  48.   */
  49. public function set_filename($filename)
  50. {
  51. $this->filename = $filename;
  52. }
  53.  
  54.  
  55. /**
  56.   * Returns the file extension of the outputted file (e.g. 'xml')
  57.   **/
  58. abstract function get_ext();
  59.  
  60. /**
  61.   * Returns the mimetype of the outputted file (e.g. 'text/xml')
  62.   **/
  63. abstract function get_mimetype();
  64.  
  65. /**
  66.   * Does nothing; there is no layout to check
  67.   */
  68. public function check_layout() {}
  69. }
  70.  
  71.  
  72. ?>
  73.