Source for file Header.class.php

Documentation is available at Header.class.php

  1. <?php
  2. /**
  3.  * Gumbo Library Framework
  4.  *
  5.  * LICENSE
  6.  * This library is being released under the terms of the New BSD License.  A
  7.  * copy of the license is packaged with the software (LICENSE.txt).  If no
  8.  * copy is found, a copy of the license template can be found at:
  9.  * http://www.opensource.org/licenses/bsd-license.php
  10.  * 
  11.  * @category Gumbo
  12.  * @package Template
  13.  * @copyright Copyright (c) 2007, iBayou, Michael Luster
  14.  * @license http://www.opensource.org/licenses/bsd-license.php New BSD License
  15.  * @author Michael Luster <mluster79@yahoo.com>
  16.  * @link http://sourceforge.net/projects/phpgumbo
  17.  * @version 0.0.1
  18.  */
  19.  
  20. /**
  21.  * Special Template Header Class
  22.  * 
  23.  * This class will represent the Header.  If using HTML, it provides methods for
  24.  * adding Stylesheets and JavaScript dynamically.  This will format two Template
  25.  * variables 'header_styles' and 'header_javascript'.
  26.  *
  27.  * @category Gumbo
  28.  * @package Template
  29.  * @copyright Copyright (c) 2007, iBayou, Michael Luster
  30.  * @license http://www.opensource.org/licenses/bsd-license.php New BSD License
  31.  * @author Michael Luster <mluster79@yahoo.com>
  32.  * @link http://sourceforge.net/projects/phpgumbo
  33.  * @desc Special Template Header Class
  34.  * @version 0.0.1
  35.  */
  36.  
  37. gumbo_load ("Interface_Singleton");
  38. gumbo_load ("Template_Special");
  39.  
  40. class Gumbo_Template_Special_Header extends Gumbo_Template_Special implements Gumbo_Interface_Singleton {
  41.     
  42.     /** @var Gumbo_Template_Header $_instance */
  43.     private static $_instance = null;
  44.     
  45.     /** @var Gumbo_Interface_List $_styles list of extra stylesheets */
  46.     private $_styles;
  47.     /** @var Gumbo_Interface_List $_javascript list of javascript files */
  48.     private $_javascript;
  49.     
  50.     
  51.     
  52.     /**
  53.      * Constructor
  54.      * @uses Gumbo_Template
  55.      */
  56.     private function __construct () {
  57.         gumbo_load ("Template");
  58.         gumbo_load ("List");
  59.         
  60.         $fact = new Gumbo_Template ();
  61.         $this->setEngine ($fact->factory ());
  62.         $this->getEngine ()->loadGlobals ();
  63.         
  64.         $this->_styles = new Gumbo_List ();
  65.         $this->_javascript = new Gumbo_List ();
  66.     }
  67.     
  68.     /**
  69.      * Singleton Method
  70.      * @return Gumbo_Interface_Special_Header 
  71.      */
  72.     public static function instance () {
  73.         if (self::$_instance == null) {
  74.             self::$_instance = new Gumbo_Template_Header ();
  75.         }
  76.         return self::$_instance;
  77.     }
  78.     
  79.     
  80.     
  81.     /** ACTION METHODS **/
  82.     /**
  83.      * Returns the formatted text to the browser
  84.      * @param bool $reload reloads the output
  85.      * @return string 
  86.      */
  87.     public function fetch ($reload=false) {
  88.         $this->getEngine ()->setFile ($this->getFile ());
  89.         if (!$this->isActive () && $this->getFileBasic ()) {
  90.             $this->getEngine ()->setFile ($this->getFileBasic ());
  91.         } else {
  92.             return;
  93.         }
  94.         
  95.         // assign extra styles
  96.         $txt = null;
  97.         foreach ($this->getStyles () as $style) {
  98.             $txt .= "\t<link href=\"" . gumbo_appendLocation ($style ['url']) . $style ['file'] . "\" rel=\"stylesheet\" type=\"text/css\" media=\"" . $style ['media'] . "\" />\n";
  99.         }
  100.         $this->assign ("header_styles", $txt);
  101.         
  102.         // assign Javascript
  103.         $txt = null;
  104.         foreach ($this->getJavascript () as $js) {
  105.             $txt .= "\t<script type=\"text/javascript\" ";
  106.             if (!$js ['file']) {
  107.                 $txt .= "src=\"{$js ['js']}\" />";
  108.             } else {
  109.                 $txt .= ">{$js ['js']}</style>";
  110.             }
  111.             $txt .= "\n";
  112.         }
  113.         $this->assign ("header_javascript", $txt);
  114.         
  115.         // assign the Elements
  116.         foreach ($this->getElements () as $key=>$val) {
  117.             $val->loadGlobals ();
  118.             $this->assign ($key, $val);
  119.         }
  120.         
  121.         return $this->getEngine ()->fetch ($reload);
  122.     }
  123.     
  124.     /**
  125.      * Adds a style sheet (path not necessary)
  126.      * @param string $file file name of the style sheet
  127.      * @param string $media media type (screen|print|etc.)
  128.      * @param string $url URL to style sheet
  129.      * @throws Gumbo_Exception
  130.      */
  131.     public function addStyle ($file, $media=null, $url=null) {
  132.         try {
  133.             // verify precondition
  134.             if (!is_string ($file)) {
  135.                 throw new Gumbo_Exception ("Invalid Argument 'file:str' => {$file}:" . gettype ($file));
  136.             }
  137.             
  138.             try {
  139.                 // verify precondition
  140.                 if (!is_null ($url) && !is_string ($url)) {
  141.                     throw new Gumbo_Exception ("Invalid Argument 'url:str' => {$url}:" . gettype ($url));
  142.                 }
  143.             } catch (Gumbo_Exception $e) {
  144.                 $e->setFunction (__METHOD__);
  145.                 gumbo_trigger ($e);
  146.                 $url = null;
  147.             }
  148.             
  149.             if (is_null ($media)) { $media = "screen"; }
  150.             if (!is_string ($media)) {
  151.                 throw new Gumbo_Exception ("Invalid Argument 'media:str' => {$media}:" . gettype ($media));
  152.             }
  153.             $media = strtolower ($media);
  154.             
  155.             switch ($media) {
  156.                 case "all" : break;
  157.                 case "screen" : break;
  158.                 case "print" : break;
  159.                 case "handheld" : break;
  160.                 case "projection" : break;
  161.                 case "tty" : break;
  162.                 case "tv" : break;
  163.                 case "braille" : break;
  164.                 case "aural" : break;
  165.                 default : throw new Gumbo_Exception ("Invalid Media Value [all|screen|print|handheld|projection|tty|tv|braille|aural]: {$media}");
  166.             }
  167.             
  168.             $this->getStyles ()->add (array ("file"=>$file, "media"=>$media, "url"=>$url));
  169.         } catch (Gumbo_Exception $e) {
  170.             $e->setFunction (__METHOD__);
  171.             gumbo_trigger ($e);
  172.         }
  173.     }
  174.     
  175.     /**
  176.      * Adds Javascript to the Header
  177.      * @param string $js file name or javascript text
  178.      * @param bool $as_string 
  179.      */
  180.     public function addJavascript ($js, $as_string=false) {
  181.         try {
  182.             // verify precondition
  183.             if (!is_string ($js)) {
  184.                 throw new Gumbo_Exception ("Invalid Argument 'js:str' => {$js}:" . gettype ($js));
  185.             }
  186.             try {
  187.                 if (!is_bool ($as_string)) {
  188.                     throw new Gumbo_Exception ("Invalid Argument 'as_string:bool' => {$as_string}:" . gettype ($as_string));
  189.                 }
  190.             } catch (Gumbo_Exception $e) {
  191.                 $e->setFunction (__METHOD__);
  192.                 gumbo_trigger ($e);
  193.                 $as_string = false;
  194.             }
  195.             
  196.             $this->getJavascript ()->add (array ("js"=>$js, "file"=>$as_string));
  197.         } catch (Gumbo_Exception $e) {
  198.             $e->setFunction (__METHOD__);
  199.             gumbo_trigger ($e);
  200.         }
  201.     }
  202.  
  203.     
  204.     
  205.     /** ACCESSOR METHODS **/
  206.     /**
  207.      * Returns the extra style sheets to include in the template file
  208.      * @return Gumbo_Interface_List 
  209.      */
  210.     public function getStyles () {
  211.         return $this->_styles;
  212.     }
  213.     
  214.     /**
  215.      * Returns any Javascript Files
  216.      * @return Gumbo_Interface_List 
  217.      */
  218.     public function getJavascript () {
  219.         return $this->_javascript;
  220.     }
  221.     
  222. }
  223.  
  224. ?>