MCMS
[ class tree: MCMS ] [ index: MCMS ] [ all elements ]

Source for file Compilable.php

Documentation is available at Compilable.php

  1. <?php
  2. /* vim: set expandtab tabstop=4 shiftwidth=4: */
  3. // +----------------------------------------------------------------------+
  4. // | MCMS: a PHP Content Management System for creating accessible sites. |
  5. // | Copyright (C) 2005  Silvio Moioli                                    |
  6. // |                                                                      |
  7. // | This program 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 2 of the License, or    |
  10. // | (at your option) any later version.                                  |
  11. // |                                                                      |
  12. // | This program 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 this program; if not, write to the Free Software          |
  19. // | Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 |
  20. // +----------------------------------------------------------------------+
  21. // | Authors: Silvio Moioli <silvio at moioli dot net> www.moioli.net     |
  22. // +----------------------------------------------------------------------+
  23. //
  24. //$Id:
  25.  
  26. /**
  27.  * Classe astratta che rappresenta una pagina XHTML.
  28.  * Ogni sottoclasse deve implementare tutti i suoi metodi e potrà
  29.  * essere usata per generare il codice relativo tramite
  30.  * un oggetto Compiler.
  31.  *
  32.  * @package  MCMS
  33.  * @version  2
  34.  * @author   Silvio Moioli <silvio at moioli dot net>
  35.  */
  36. /*abstract*/ class Compilable extends PEAR
  37. {
  38.     /**
  39.      * Costruttore di default
  40.      *
  41.      */
  42.     function Compilable()
  43.     {
  44.     }
  45.     
  46.     /**
  47.      * Questo metodo è "astratto" pertanto dovrebbe essere implementato da
  48.      * tutte le classi che estendono questa classe.
  49.      *
  50.      * Ritorna il titolo (in XHTML) di questa pagina.
  51.      *
  52.      * @return string una stringa XHTML rappresentante il titolo della pagina
  53.      */
  54.     /*abstract*/function getTitle()
  55.     {
  56.         return PEAR_raiseError("Unimplemented abstract method called!");
  57.     }
  58.     
  59.     /**
  60.      * Questo metodo è "astratto" pertanto dovrebbe essere implementato da
  61.      * tutte le classi che estendono questa classe.
  62.      *
  63.      * Ritorna una breve descrizione (solo testo) di questa pagina.
  64.      *
  65.      * @return string una stringa rappresentante la descrizione della pagina
  66.      */
  67.     /*abstract*/function getDescription()
  68.     {
  69.         return PEAR_raiseError("Unimplemented abstract method called!");
  70.     }
  71.     
  72.     /**
  73.      * Questo metodo è "astratto" pertanto dovrebbe essere implementato da
  74.      * tutte le classi che estendono questa classe.
  75.      *
  76.      * Ritorna un array di stringhe XHTML relative al menu (barra di navigazione)
  77.      * di questa pagina.
  78.      *
  79.      * @return array vettore di stringhe XHTML rappresentante il menu della pagina
  80.      */
  81.     /*abstract*/function getMenuEntries()
  82.     {
  83.         return PEAR_raiseError("Unimplemented abstract method called!");
  84.     }
  85.     
  86.     /**
  87.      * Questo metodo è "astratto" pertanto dovrebbe essere implementato da
  88.      * tutte le classi che estendono questa classe.
  89.      *
  90.      * Ritorna il contenuto (XHTML) del corpo di questa pagina.
  91.      *
  92.      * @return string la stringa XHTML rappresentante il corpo della pagina
  93.      */
  94.     /*abstract*/function getContents()
  95.     {
  96.         return PEAR_raiseError("Unimplemented abstract method called!");
  97.     }
  98.  
  99.     /**
  100.      * Questo metodo è "astratto" pertanto dovrebbe essere implementato da
  101.      * tutte le classi che estendono questa classe.
  102.      *
  103.      * Ritorna una stringa di parole chiave (solo testo, separate da virgole)
  104.      * di questa pagina.
  105.      *
  106.      * @return string la stringa rappresentante le parole chiave della pagina
  107.      */
  108.     /*abstract*/function getKeywords()
  109.     {
  110.         return PEAR_raiseError("Unimplemented abstract method called!");
  111.     }
  112.     
  113.     /**
  114.      * Questo metodo è "astratto" pertanto dovrebbe essere implementato da
  115.      * tutte le classi che estendono questa classe.
  116.      *
  117.      * Ritorna il nome del file template per questa pagina (pathname relativo
  118.      * a $_SERVER["DOCUMENT_ROOT"]/admin/include/smarty/templates/)
  119.      *
  120.      * @return string il nome del file del template
  121.      */
  122.     /*abstract*/function getTemplate()
  123.     {
  124.         return PEAR_raiseError("Unimplemented abstract method called!");
  125.     }
  126.     
  127.     /**
  128.      * Questo metodo è "astratto" pertanto dovrebbe essere implementato da
  129.      * tutte le classi che estendono questa classe.
  130.      *
  131.      * Ritorna un array di plugin di MCMS (sottoclassi di Component) che
  132.      * si applicano a questa pagina.
  133.      *
  134.      * @return array un vettore di Component che si applicano a questa pagina
  135.      */
  136.     /*abstract*/function getComponents()
  137.     {
  138.         return PEAR_raiseError("Unimplemented abstract method called!");
  139.     }
  140. }
  141. ?>

Documentation generated on Wed, 26 Jul 2006 21:44:51 +0200 by phpDocumentor 1.3.0RC6