Cnz_Html
[ class tree: Cnz_Html ] [ index: Cnz_Html ] [ all elements ]
Packages:
Cnz
Cnz_Html

Source for file Head.php

Documentation is available at Head.php

  1. <?php
  2. /**
  3.  * CNZ Framework
  4.  *
  5.  * A Framework for Creating and Using Complex Web Elements
  6.  *
  7.  * The purpose of this framework is to provide a library of high-level objects
  8.  * to facilitate common HTML coding tasks, such as menus, tables, and forms.
  9.  * The intent is to reduce repetitive HTML coding as much as possible, replacing
  10.  * it with a combination of configuration files and style sheets with
  11.  * standardized naming conventions.
  12.  *
  13.  * This framework is built on and requires the
  14.  * {@link http://framework.zend.com/ Zend Framework}.
  15.  *
  16.  * @category Cnz
  17.  * @package  Cnz_Html
  18.  *
  19.  * @author    Lyle Frost <lfrost@cnz.com>
  20.  * @copyright Copyright (c) 2006-2007 Citadel Network <{@link http://www.citadelnetwork.com/}>
  21.  * @filesource
  22.  * @license   http://www.citadelnetwork.com/license/cnzframework New BSD License
  23.  * @version   $Id: Head.php 27 2007-07-19 18:47:54Z lfrost $
  24.  */
  25.  
  26. /**
  27.  * Required classes.
  28.  *
  29.  * @ignore
  30.  */
  31. Zend_Loader::loadClass('Cnz_Html_Element');
  32.  
  33. /**
  34.  * HTML Head class
  35.  *
  36.  * This class automates the creation and display of a header block.
  37.  *
  38.  * Where the lists are filenames, the file extension should not be included.
  39.  * Style filenames must have the extension .css, and client-side script files
  40.  * must have the extension .js.
  41.  *
  42.  * Scripts for a given page should be stored underneath
  43.  * <var>scriptDirLocal</var>.  Scripts for an entire site should be stored
  44.  * underneath <var>scriptDirSite</var>.  Scripts to be shared across sites on a
  45.  * server should be stored in <var>scriptDirServer</var>.  Script names may also
  46.  * be code-generated and fed to the constructor.  Similary for styles.
  47.  *
  48.  * Each script and style may be specified as either an absolute path or a
  49.  * relative path.  If a relative path, then the file is taken from the site
  50.  * directory if the file exists, else the server directory.  If scriptAuto/
  51.  * styleAuto is enabled, then all script/style files (judged by the file
  52.  * extension) in the local script/style directory are used.
  53.  *
  54.  * Styles may be followed by a field delimiter (<kbd>:</kbd>) and a value for
  55.  * the media attribute.  If no media attribute is specified, the default is
  56.  * <kbd>all</kbd>.
  57.  *
  58.  * Example INI (defaults shown as comments):
  59.  *
  60.  * <pre><samp>
  61.  * [htmlHead]
  62.  * ;author          = <organization>
  63.  * ;copyright       = "Copyright &copy; <author>"
  64.  * description      = Description for this Site
  65.  * ;distribution    = global
  66.  * keywords         = keyword list
  67.  * organization     = Organization Name
  68.  * ;revisit         = 7 days
  69.  * ;robots          = index,follow
  70.  * scripts          = mootools
  71.  * ;scriptAuto      = yes
  72.  * ;scriptDirLocal  = script/
  73.  * ;scriptDirServer = /slib/script/
  74.  * ;scriptDirSite   = /lib/script/
  75.  * styles           = main:all,another:all
  76.  * ;styleAuto       = yes
  77.  * ;styleDirLocal   = style/
  78.  * ;styleDirServer  = /slib/style/
  79.  * ;styleDirSite    = /lib/script/
  80.  * ;title           = <domain>
  81.  * </samp></pre>
  82.  *
  83.  * Example PHP:
  84.  *
  85.  * <code>
  86.  * $htmlHead = Cnz_Html::loadAndDisplay('Cnz_Html_Head');
  87.  * </code>
  88.  *
  89.  * @category Cnz
  90.  * @package  Cnz_Html
  91.  */
  92. class Cnz_Html_Head extends Cnz_Html_Element
  93. {
  94.     const HAS_CONFIG        = true;
  95.     const PREFIX            = 'HtmlHead';
  96.     const DEFAULT_COPYRIGHT        = 'Copyright &copy; ';
  97.     const DEFAULT_DISTRIBUTION    = 'global';
  98.     const DEFAULT_MEDIA        = 'all';
  99.     const DEFAULT_REVISIT        = '7 days';
  100.     const DEFAULT_ROBOTS        = 'index,follow';
  101.     const DEFAULT_SCRIPT_DIR_SERVER    = '/slib/script/';
  102.     const DEFAULT_SCRIPT_DIR_SITE    = '/lib/script/';
  103.     const DEFAULT_SCRIPT_DIR_LOCAL    = 'script/';
  104.     const DEFAULT_STYLE_DIR_SERVER    = '/slib/style/';
  105.     const DEFAULT_STYLE_DIR_SITE    = '/lib/style/';
  106.     const DEFAULT_STYLE_DIR_LOCAL    = 'style/';
  107.     const TITLE_SEPARATOR        = ' :: ';
  108.  
  109.     /**#@+ @var array */
  110.     private    $subtitleArray        = array();
  111.     private    $scriptArray        = array();
  112.     /** Associative array stylename => media */
  113.     private    $styleArray        = array();
  114.     /**#@-*/
  115.  
  116.     /**#@+ @var boolean */
  117.     private    $scriptAutoFlag        = true;
  118.     private    $styleAutoFlag        = true;
  119.     /**#@-*/
  120.  
  121.     /**#@+ @var string */
  122.     private    $title            = NULL;
  123.     /** Default value $this->organization */
  124.     private    $author            = NULL;
  125.     /** Default value DEFAULT_COPYRIGHT . $this->organization or author */
  126.     private    $copyright        = NULL;
  127.     private    $description        = NULL;
  128.     private    $distribution        = self::DEFAULT_DISTRIBUTION;
  129.     private    $keywords        = NULL;
  130.     private    $scriptList        = NULL;
  131.     private    $styleList        = NULL;
  132.     private    $organization        = NULL;
  133.     private    $revisit        = self::DEFAULT_REVISIT;
  134.     private    $robots            = self::DEFAULT_ROBOTS;
  135.     private    $scriptDirLocal        = self::DEFAULT_SCRIPT_DIR_LOCAL;
  136.     private    $scriptDirServer    = self::DEFAULT_SCRIPT_DIR_SERVER;
  137.     private    $scriptDirSite        = self::DEFAULT_SCRIPT_DIR_SITE;
  138.     private    $styleDirLocal        = self::DEFAULT_STYLE_DIR_LOCAL;
  139.     private    $styleDirServer        = self::DEFAULT_STYLE_DIR_SERVER;
  140.     private    $styleDirSite        = self::DEFAULT_STYLE_DIR_SITE;
  141.     /**#@-*/
  142.  
  143.     /* Getters/Setters ===================================================*/
  144.  
  145.     /** @return string Copyright */
  146.     public function getCopyright()
  147.     {
  148.         return $this->copyright;
  149.     }
  150.  
  151.     /** @return string Organization */
  152.     public function getOrganization()
  153.     {
  154.         return $this->organization;
  155.     }
  156.  
  157.     /** @return string Title */
  158.     public function getTitle()
  159.     {
  160.         return $this->title;
  161.     }
  162.  
  163.     /* Methods ===========================================================*/
  164.  
  165.     /**
  166.      * Option fields:
  167.      *   string keywords   List of additional keywords
  168.      *   string scripts    List of additional client-side scripts
  169.      *   string styles     List of additional CSS styles
  170.      *   string subtitles  List of page subtitles
  171.      *
  172.      * Configuration fields:
  173.      *   author           Value for author meta tag (default organization)
  174.      *   copyright        Value for copyright meta tag (default Copyright &copy; author)
  175.      *   description      Value for description meta tag (default none)
  176.      *   distribution     Value for distribution meta tag (default global)
  177.      *   keywords         Value for keywords meta tag (default none)
  178.      *   organization     Value for organization meta tag (required)
  179.      *   revisit          Value for revisit meta tag (default 7 days)
  180.      *   robots           Value for robots meta tag (default index,follow)
  181.      *   scripts          List of client-side scripts to include (default none)
  182.      *   scriptAuto       Automatically include scripts in local script dir (default yes).
  183.      *   scriptDirLocal   Local script directory (default script/)
  184.      *   scriptDirServer  Server script directory (default /slib/script/)
  185.      *   scriptDirSite    Site script directory (default /lib/script/)
  186.      *   styles           List of styles to include (default none)
  187.      *   styleAuto        Automatically include stypes in local style dir (default yes).
  188.      *   styleDirLocal    Local style directory (default style/)
  189.      *   styleDirServer   Server style directory (default /slib/style/)
  190.      *   styleDirSite     Site style directory (default /lib/style/)
  191.      *   title            Site title (default none)
  192.      *
  193.      * @param  array $options Options
  194.      */
  195.     public function __construct(array $options = array())
  196.     {
  197.         parent::__construct($options);
  198.  
  199.         // Process options.
  200.         if (isset($options['keywords'])) $this->keywords .= ',' . $options['keywords'];
  201.         if (isset($options['scripts'])) $this->scriptList .= ',' . $options['scripts'];
  202.         if (isset($options['styles'])) $this->styleList .= ',' . $options['styles'];
  203.         if (isset($options['subtitles'])) $this->subtitleArray = Cnz_Html::listToArray($options['subtitles']);
  204.  
  205.         // Process configuration.
  206.         if (isset($this->config->author)) $this->author = $this->config->author;
  207.         if (isset($this->config->copyright)) $this->copyright = $this->config->copyright;
  208.         if (isset($this->config->description)) $this->description = $this->config->description;
  209.         if (isset($this->config->distribution)) $this->distribution = $this->config->distribution;
  210.         if (isset($this->config->keywords)) $this->keywords = $this->config->keywords;
  211.         if (isset($this->config->organization)) $this->organization = $this->config->organization;
  212.         if (isset($this->config->revisit)) $this->revisit = $this->config->revisit;
  213.         if (isset($this->config->robots)) $this->robots = $this->config->robots;
  214.         if (isset($this->config->scripts)) $this->scriptArray = Cnz_Html::listToArray($this->config->scripts);
  215.         if (isset($this->config->scriptAuto)) $this->scriptAutoFlag = Cnz_Html::configFlag($this->config->scriptAuto);
  216.         if (isset($this->config->scriptDirLocal)) $this->scriptDirLocal = $this->config->scriptDirLocal;
  217.         if (isset($this->config->scriptDirServer)) $this->scriptDirServer = $this->config->scriptDirServer;
  218.         if (isset($this->config->scriptDirSite)) $this->scriptDirSite = $this->config->scriptDirSite;
  219.         if (isset($this->config->styles)) $this->styleArray = Cnz_Html::listToArray($this->config->styles);
  220.         if (isset($this->config->styleAuto)) $this->styleAutoFlag = Cnz_Html::configFlag($this->config->styleAuto);
  221.         if (isset($this->config->styleDirLocal)) $this->styleDirLocal = $this->config->styleDirLocal;
  222.         if (isset($this->config->styleDirServer)) $this->styleDirServer = $this->config->styleDirServer;
  223.         if (isset($this->config->styleDirSite)) $this->styleDirSite = $this->config->styleDirSite;
  224.         if (isset($this->config->title)) $this->title = $this->config->title;
  225.  
  226.         if (empty($this->author)) $this->author = $this->organization;
  227.         if (empty($this->copyright)) $this->copyright = self::DEFAULT_COPYRIGHT . $this->author;
  228.         if (empty($this->title)) $this->title = Cnz_Html::getDomain();
  229.  
  230.         Cnz_Html::listAppendToArray($this->scriptArray, $this->scriptList);
  231.         Cnz_Html::listAppendToArray($this->styleArray, $this->styleList);
  232.  
  233.         // Automatic scripts
  234.         $scriptDirLocal = Cnz_Html::docDir() . $this->scriptDirLocal;
  235.         if ($this->scriptAutoFlag && is_dir($scriptDirLocal))
  236.         {
  237.             $scripts = scandir($scriptDirLocal);
  238.             if ($scripts === false)
  239.             {
  240.                 Cnz_Html::getLogger()->warn(__METHOD__ . '[' . __LINE__ . '] ' . 'Failed scanning local script directory.');
  241.             }
  242.             foreach ($scripts as $script)
  243.             {
  244.                 $filebase = Cnz_Html::checkFileExtension($script, Cnz_Html::SCRIPT_FILE_EXT);
  245.                 if ($filebase)
  246.                 {
  247.                     $this->scriptArray['local:' . $filebase] = NULL;
  248.                 }
  249.             }
  250.         }
  251.  
  252.         // Automatic styles
  253.         $styleDirLocal = Cnz_Html::docDir() . $this->styleDirLocal;
  254.         if ($this->styleAutoFlag && is_dir($styleDirLocal))
  255.         {
  256.             $styles = scandir($styleDirLocal);
  257.             if ($styles === false)
  258.             {
  259.                 Cnz_Html::getLogger()->warn(__METHOD__ . '[' . __LINE__ . '] ' . 'Failed scanning local style directory.');
  260.             }
  261.             foreach ($styles as $style)
  262.             {
  263.                 $filebase = Cnz_Html::checkFileExtension($style, Cnz_Html::STYLE_FILE_EXT);
  264.                 if ($filebase)
  265.                 {
  266.                     $this->styleArray['local:' . $filebase] = self::DEFAULT_MEDIA;
  267.                 }
  268.             }
  269.         }
  270.  
  271.         return;
  272.     }
  273.  
  274.     /**
  275.      * @param  string $style Unused
  276.      * @return void 
  277.      */
  278.     public function display($style = NULL)
  279.     {
  280.         $is = Cnz_Html::getIndentString();
  281.         $indent = Cnz_Html::indentGenerate();
  282.  
  283.         echo $indent, '<head>', "\n";
  284.  
  285.         //
  286.         // subtitles
  287.         if (is_array($this->subtitleArray))
  288.         {
  289.             foreach ($this->subtitleArray as $subtitle => $value)
  290.             {
  291.                 $this->title .= self::TITLE_SEPARATOR . $subtitle;
  292.             }
  293.         }
  294.         echo $indent, $is, '<title>', $this->title, '</title>', "\n";
  295.  
  296.         // base
  297.         // This is for compatibility with mod_rewrite.
  298.         $base = Cnz_Html::docDir(true);
  299.         if (substr($base, -1) != '/') $base = dirname($base);
  300.         echo $indent, $is, '<base href = "', Cnz_Html::uriRoot(), $base, '"/>', "\n";
  301.  
  302.         // styles
  303.         foreach ($this->styleArray as $src => $media)
  304.         {
  305.             $src = trim($src);
  306.             echo $indent, $is, '<link href = "';
  307.             if (strncmp($src, 'local:', 6) == 0)
  308.             {
  309.                 echo $this->styleDirLocal;
  310.                 $src = substr($src, 6);
  311.             }
  312.             elseif (substr($src, 0, 1) != '/')
  313.             {
  314.                 // if file exists in site dir, use it, else use server dir.
  315.                 if (is_file($_SERVER['DOCUMENT_ROOT'] . $this->styleDirSite . $src . '.' . Cnz_Html::STYLE_FILE_EXT)) echo $this->styleDirSite;
  316.                 else echo $this->styleDirServer;
  317.             }
  318.             if (empty($media)) $media = self::DEFAULT_MEDIA;
  319.             echo $src;
  320.             echo '.', Cnz_Html::STYLE_FILE_EXT, '" media = "' . $media . '" rel = "stylesheet" type = "', Cnz_Html::STYLE_TYPE, '"/>', "\n";
  321.         }
  322.  
  323.         // meta tags
  324.         if (!empty($this->author)) echo $indent, $is, '<meta name = "author" content = "', $this->author, '"/>', "\n";
  325.         if (!empty($this->copyright)) echo $indent, $is, '<meta name = "copyright" content = "', str_replace('&copy;', '(c)', $this->copyright), '"/>', "\n";
  326.         if (!empty($this->description)) echo $indent, $is, '<meta name = "description" content = "', $this->description, '"/>', "\n";
  327.         if (!empty($this->distribution)) echo $indent, $is, '<meta name = "distribution" content = "', $this->distribution, '"/>', "\n";
  328.         if (!empty($this->keywords)) echo $indent, $is, '<meta name = "keywords" content = "', $this->keywords, '"/>', "\n";
  329.         if (!empty($this->organization)) echo $indent, $is, '<meta name = "organization" content = "', $this->organization, '"/>', "\n";
  330.         if (!empty($this->revisit)) echo $indent, $is, '<meta name = "revisit-after" content = "', $this->revisit, '"/>', "\n";
  331.         if (!empty($this->robots)) echo $indent, $is, '<meta name = "robots" content = "', $this->robots, '"/>', "\n";
  332.  
  333.         // JavaScript sources
  334.         foreach ($this->scriptArray as $src => $value)
  335.         {
  336.             $src = trim($src);
  337.             echo $indent, $is, '<script src = "';
  338.             if (strncmp($src, 'local:', 6) == 0)
  339.             {
  340.                 echo $this->scriptDirLocal;
  341.                 $src = substr($src, 6);
  342.             }
  343.             elseif (substr($src, 0, 1) != '/')
  344.             {
  345.                 // if file exists in site dir, use it, else use server dir.
  346.                 if (is_file($_SERVER['DOCUMENT_ROOT'] . $this->scriptDirSite . $src . '.' . Cnz_Html::SCRIPT_FILE_EXT)) echo $this->scriptDirSite;
  347.                 else echo $this->scriptDirServer;
  348.             }
  349.             echo $src;
  350.              echo '.', Cnz_Html::SCRIPT_FILE_EXT, '" type = "', Cnz_Html::getJavascriptType(), '"></script>', "\n";
  351.         }
  352.  
  353.         echo $indent, '</head>', "\n";
  354.  
  355.         return;
  356.     }
  357. }
Documentation generated on Thu, 19 Jul 2007 15:02:05 -0400 by phpDocumentor 1.4.0RC2