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

Source for file Document.php

Documentation is available at Document.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: Document.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 Document class
  35.  *
  36.  * This class creates a <kbd>div</kbd> block to contain the "real" document
  37.  * content of the page.  This content is included from a separate file,
  38.  * defaulting to the file <kbd>document.php</kbd> in the current directory.
  39.  * This separation allows the page content to be edited separately from the
  40.  * supporting framework (menu, banner, etc.).
  41.  *
  42.  * Ideally, this would also be used by search engines.  If a standard existed
  43.  * for identifying real content from the supporting framework, search engines
  44.  * could weight this content more heavily.  This would reduce the search noise
  45.  * that results when some criteria appear only in the menu, advertising links,
  46.  * etc.
  47.  *
  48.  * There are currently no configuration settings for this class, but the section
  49.  * should exist anyway.
  50.  *
  51.  * Example INI:
  52.  *
  53.  * <pre><samp>
  54.  * [HtmlDocument]
  55.  * </samp></pre>
  56.  *
  57.  * @category Cnz
  58.  * @package  Cnz_Html
  59.  */
  60. class Cnz_Html_Document extends Cnz_Html_Element
  61. {
  62.     const    DEFAULT_DOCUMENT_FILE    = 'document.php';
  63.  
  64.     /**#@+ @var int */
  65.     private    $saveIndentLevel    = 0;
  66.     /**#@-*/
  67.  
  68.     /**#@+ @var string */
  69.     private    $documentFile        = self::DEFAULT_DOCUMENT_FILE;
  70.     /**#@-*/
  71.  
  72.     /* Methods ===========================================================*/
  73.  
  74.     /**
  75.      * Option fields:
  76.      *   filename  Document filename
  77.      *
  78.      * Configuration fields:
  79.      *   none
  80.      *
  81.      * @param  array $options Options
  82.      * @return void 
  83.      */
  84.     public function __construct(array $options = array())
  85.     {
  86.         parent::__construct($options);
  87.         if (isset($options['filename'])) $this->documentFile = $options['filename'];
  88.         return;
  89.     }
  90.  
  91.     /**
  92.      * @param  string $style Value for outermost style attribute
  93.      * @return void 
  94.      */
  95.     public function display($style = NULL)
  96.     {
  97.         // This is for compatibility with mod_rewrite.
  98.         $curDir = getcwd();
  99.         $dir = Cnz_Html::docDir();
  100.         if (substr($dir, -1) != '/') $dir = dirname($dir);
  101.         if (!chdir($dir))
  102.         {
  103.             Cnz_Html::getLogger()->err(__METHOD__ . '[' . __LINE__ . '] ' . ' Error changing directory to ' . $dir . ' from directory ' . $curDir . '.');
  104.             return;
  105.         }
  106.  
  107.         $indent = Cnz_Html::indentGenerate();
  108.  
  109.         echo $indent, '<div class = "', $this->genStyles(), '"';
  110.         echo ' id = "', $this->genId(), '"';
  111.         if (!empty($style)) echo ' style = "', $style, '"';
  112.         echo '>', "\n";
  113.  
  114.         if (is_file($this->documentFile))
  115.         {
  116.             $this->saveIndentLevel = Cnz_Html::getIndentLevel();
  117.             Cnz_Html::setIndentLevel(0);
  118.             echo '<!-- DOCUMENT BEGIN >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> -->', "\n";
  119.  
  120.             Zend_Loader::loadFile($this->documentFile, $dir);
  121.             echo '<!-- DOCUMENT END <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< -->', "\n";
  122.             Cnz_Html::setIndentLevel($this->saveIndentLevel);
  123.         }
  124.         else
  125.         {
  126.             Cnz_Html::getLogger()->debug(__METHOD__ . '[' . __LINE__ . '] ' . ' No document file ' . $this->documentFile . ' from directory ' . getcwd() . '.');
  127.         }
  128.  
  129.         // Note:  documentFile could have changed $indent.
  130.         $indent = Cnz_Html::indentGenerate();
  131.         echo $indent, '</div>', "\n";
  132.  
  133.         // Restore current directory.
  134.         if (!chdir($curDir))
  135.         {
  136.             Cnz_Html::getLogger()->err(__METHOD__ . '[' . __LINE__ . '] ' . ' Error changing directory to ' . $curDir . ' from directory ' . getcwd() . '.');
  137.             return;
  138.         }
  139.  
  140.         return;
  141.     }
  142. }
Documentation generated on Thu, 19 Jul 2007 15:02:00 -0400 by phpDocumentor 1.4.0RC2