HtmlTemplateFramework
[ class tree: HtmlTemplateFramework ] [ index: HtmlTemplateFramework ] [ all elements ]
Packages:
HtmlTemplateFramework

Source for file htf_frm_frameconfig.phl

Documentation is available at htf_frm_frameconfig.phl

  1. <?php
  2. /**
  3.  * htf_frm_frameconfigクラス
  4.  *
  5.  * 作成するhtfフレーム全体の情報を管理するクラス
  6.  *
  7.  * @package HtmlTemplateFramework
  8.  * @subpackage frame
  9.  * @access  public
  10.  * @author    Yamauchi Shogo <htf@as-prj.com>
  11.  * @version $Id: htf_frm_htmlconfig.phl ,v 1.0 $
  12.  ***/
  13. require_once("htf_com_initialize.inc");        //共通初期処理
  14. require_once("htf_tag_element.phl");        //タグオブジェクト
  15. require_once("htf_frm_getcss.phl");            //CSS取得
  16. require_once("htf_frm_headconfig.phl");        //ヘッダ
  17. require_once("htf_frm_bodyconfig.phl");        //ボディ
  18.  
  19. /**
  20.  * 作成するhtfフレーム全体の情報を保持するクラス。
  21.  *
  22.  * コンストラクタに引数で渡されるframeconfig要素のDOMノードを参照し、
  23.  * htfフレーム全体の情報を保持します。<br>
  24.  * <br>
  25.  * 保持する内容は、htfフレーム定義xmlファイルのルート要素(frameconfig)に記述される
  26.  * 属性と、配下の子要素の情報(headconfig要素/bodyconfig要素)の内容です。
  27.  * headconfig要素・bodyconfig要素が存在しない場合には、初期値で各保有インスタンスを生成します。<br>
  28.  * <br>
  29.  * また、HTMLタグを構成する際には、子要素のCSS記述のheadタグへの設定や、
  30.  * CSS設定ファイルをサーチして、使用するCSSファイルの決定・headタグへの設定も行います。
  31.  * 
  32.  * @access  public
  33.  * @author    Yamauchi Shogo <htf@as-prj.com>
  34.  ***/
  35. class htf_frm_frameconfig {
  36.    /**
  37.     * 言語
  38.     * 
  39.     * コンストラクタで渡されたframeconfig要素のlang属性に指定された値を保有します。
  40.     * 初期値は'ja'で、htmlタグのlang属性として設定されます。
  41.     * 
  42.     * @access public
  43.     * @var string 
  44.     */
  45.     var $lang;
  46.    /**
  47.     * 文書型
  48.     * 
  49.     * コンストラクタでframeconfig要素のdoctype属性に指定された値を保有します。
  50.     * 初期値は'HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"'で、文書のDOCTYPE宣言に使用されます。
  51.     * 
  52.     * @access public
  53.     * @var string 
  54.     */
  55.     var $doctype;
  56.    /**
  57.     * CSSのOS/ブラウザ判別属性
  58.     * 
  59.     * コンストラクタでframeconfig要素のbrowser_distinct_css属性に指定された値を保有します。
  60.     * 初期値は'off'で、この場合はOS/ブラウザ判別によるCSSの判別は行いません。判別する場合には、
  61.     * 'on'を設定します。
  62.     * 
  63.     * @access public
  64.     * @var string 
  65.     */
  66.     var $browser_distinct_css;
  67.    /**
  68.     * headconfig
  69.     * 
  70.     * frameconfig要素の子要素のheadconfig要素の内容を保持します。
  71.     * 
  72.     * @access public
  73.     * @var htf_frm_headconfig 
  74.     */
  75.     var $headconfig;
  76.    /**
  77.     * bodyconfig
  78.     * 
  79.     * frameconfig要素の子要素のbodyconfig要素の内容を保持します。
  80.     * 
  81.     * @access public
  82.     * @var htf_frm_bodyconfig 
  83.     */
  84.     var $bodyconfig;
  85.    /**
  86.     * htfフレームで管理するイメージ格納パス（デフォルトは空文字）。
  87.     * ex)/htf/sample/images
  88.     * @access public
  89.     * @var string 
  90.     */
  91.     var $imagepath;
  92.    /**
  93.     * htfフレームで管理するCSSファイル格納パス（デフォルトは空文字）。
  94.     * ex)/htf/sample/css
  95.     * @access public
  96.     * @var string 
  97.     */
  98.     var $csspath;
  99.    /**
  100.     * htfフレームで管理するJavaScriptファイル格納パス（デフォルトは空文字）。
  101.     * ex)/htf/sample/js
  102.     * @access public
  103.     * @var string 
  104.     */
  105.     var $jspath;
  106.    /**
  107.     * htfフレームで管理するルートパス（デフォルトは空文字）。
  108.     * ex)/htf/sample
  109.     * @access public
  110.     * @var string 
  111.     */
  112.     var $rootpath;
  113.  
  114.     /**
  115.      * 引数のDOMノードから、htf_frm_frameconfigクラスのインスタンスを生成します。
  116.      * 各属性値や子要素が存在しない場合には、初期値で生成します。
  117.      *
  118.      * @param     object    $objnode  frameconfigのDOMノード
  119.      * @return    void 
  120.      ***/
  121.     function htf_frm_frameconfig($objnode=NULL) {
  122.         //属性配列・ノード配列取得
  123.         if (!is_null($objnode)) {
  124.             $arrattr = $objnode->attributes();
  125.             $arrnodes = $objnode->child_nodes();
  126.         } else {
  127.             $arrattr = array();
  128.             $arrnodes = array();
  129.         }
  130.         //プロパティ初期化
  131.         $this->initialize_property();
  132.         //各プロパティ上書き
  133.         $this->override_property($arrattr);
  134.         //bodyconfig配下の子ノード取得
  135.         $this->get_childnodes($arrnodes);
  136.         //pageconfigが生成されない場合は初期値で生成
  137.         $this->initialize_nullnodes();
  138.  
  139.     }
  140.  
  141.     /**
  142.      * htfフレーム全体のHTMLタグを文字列として取得します。
  143.      *
  144.      * ただし、配下のページエリアのタイプがinclude指定の場合には、その部分はincludeを記述したphpスクリプト文字列となります。
  145.      * 
  146.      * @access     public
  147.      * @return    string 
  148.      ***/
  149.     function get_htmltag() {
  150.         //htmlタグ作成
  151.         $htmltag = $this->make_htmltag();
  152.         //DOCTYPE設定
  153.         if (htf_is_existsval($this->doctype)) {
  154.             $strret = htf_add_cr('<!DOCTYPE '.$this->doctype.'>');
  155.         }
  156.         $strret.= $htmltag->get_htmltag();
  157.  
  158.         return $strret;
  159.     }
  160.  
  161.     /**
  162.      * htfフレーム全体のHTMLタグを出力します。
  163.      *
  164.      * @access     public
  165.      * @return    void 
  166.      ***/
  167.     function print_htmltag() {
  168.         //htmlタグ作成
  169.         $htmltag = $this->make_htmltag();
  170.         //DOCTYPE設定
  171.         if (htf_is_existsval($this->doctype)) {
  172.             print(htf_add_cr('<!DOCTYPE '.$this->doctype.'>'));
  173.         }
  174.         $htmltag->print_htmltag();
  175.  
  176.         return;
  177.     }
  178.  
  179.     /**
  180.      * 出力するタグオブジェクトを生成します。
  181.      *
  182.      * @access     private
  183.      * @return    htf_tag_element 
  184.      ***/
  185.     function make_htmltag() {
  186.         //htmlオブジェクト生成
  187.         $htmlobj = new htf_tag_element("html", TRUE, HTF_ITEMCASE_ELEMENT);
  188.         //CSS文字列取得＆ヘッダ設定
  189.         $strcss = $this->bodyconfig->get_cssformat();
  190.         $this->headconfig->cssstr.= $strcss;
  191.         //カスタムCSS取得＆ヘッダ設定
  192.         $strcssfname = $this->get_cssfname(HTF_CSS_FNAME);
  193.         $this->headconfig->cssfilename = $strcssfname;
  194.  
  195.         //lang設定
  196.         if (htf_is_existsval($this->lang)) {
  197.             $htmlobj->add_attribute('lang' ,$this->lang, HTF_ITEMCASE_ATTRIUTE);
  198.         }
  199.         //head設定
  200.         $ret = $htmlobj->add_content($this->headconfig);
  201.         //body設定
  202.         $htmlobj->add_content($this->bodyconfig);
  203.         
  204.         return $htmlobj;
  205.     }
  206.     
  207.     /**
  208.      * 各種プロパティを初期化します。
  209.      *
  210.      * @access     private
  211.      * @return    void 
  212.      ***/
  213.     function initialize_property() {
  214.         //プロパティ初期化
  215.         $this->lang = HTF_LANG_JA;
  216.         $this->doctype = HTF_HTML401TRANSITIONAL;
  217.         $this->browser_distinct_css = HTF_CONF_OFF;
  218.         $this->headconfig = NULL;
  219.         $this->bodyconfig = NULL;
  220.         $this->imagepath = "";
  221.         $this->csspath = "";
  222.         $this->jspath = "";
  223.         $this->rootpath = "";
  224.     }
  225.     
  226.     /**
  227.      * 各種プロパティを引数の属性内容によって上書きします。
  228.      *
  229.      * @param     array    $arrattr  属性情報(htf_tag_attribute)配列
  230.      * @access     private
  231.      * @return    void 
  232.      ***/
  233.     function override_property($arrattr) {
  234.         //各プロパティ取得
  235.         for ($i=0 ; $i<count($arrattr) ; $i++) {
  236.             if (htf_comp_xmlattrname(HTF_ATTR_HTMLCONFIG_DOCTYPE, $arrattr[$i]->name)) {
  237.                 //doctype属性
  238.                 $this->doctype = htf_get_encoded_attr($arrattr[$i]->value);
  239.             } else if (htf_comp_xmlattrname(HTF_ATTR_HTMLCONFIG_LANG, $arrattr[$i]->name)) {
  240.                 //lang属性
  241.                 $this->lang = htf_get_encoded_attr($arrattr[$i]->value);
  242.             } else if (htf_comp_xmlattrname(HTF_ATTR_HTMLCONFIG_BROWSER_DISTINCT_CSS, $arrattr[$i]->name)) {
  243.                 //browser_distinct_css属性
  244.                 $this->browser_distinct_css = htf_get_encoded_attr($arrattr[$i]->value);
  245.             } else if (htf_comp_xmlattrname(HTF_ATTR_HTMLCONFIG_IMAGEPATH, $arrattr[$i]->name)) {
  246.                 //imagepath属性
  247.                 $this->imagepath = htf_get_encoded_attr($arrattr[$i]->value);
  248.             } else if (htf_comp_xmlattrname(HTF_ATTR_HTMLCONFIG_CSSPATH, $arrattr[$i]->name)) {
  249.                 //csspath属性
  250.                 $this->csspath = htf_get_encoded_attr($arrattr[$i]->value);
  251.             } else if (htf_comp_xmlattrname(HTF_ATTR_HTMLCONFIG_JSPATH, $arrattr[$i]->name)) {
  252.                 //jspath属性
  253.                 $this->jspath = htf_get_encoded_attr($arrattr[$i]->value);
  254.             } else if (htf_comp_xmlattrname(HTF_ATTR_HTMLCONFIG_ROOTPATH, $arrattr[$i]->name)) {
  255.                 //rootpath属性
  256.                 $this->rootpath = htf_get_encoded_attr($arrattr[$i]->value);
  257.             }
  258.         }
  259.         return;
  260.     }
  261.  
  262.     /**
  263.      * 引数のノード情報から子要素オブジェクトを生成する。
  264.      *
  265.      * @param     array    $arrcnode  子ノード配列配列
  266.      * @access     private
  267.      * @return    void 
  268.      ***/
  269.     function get_childnodes($arrcnode) {
  270.         for ($i=0; $i<count($arrcnode) ; $i++) {
  271.             if ($arrcnode[$i]->node_type() != XML_TEXT_NODE) {
  272.                 if (htf_comp_xmlelementname($arrcnode[$i]->node_name(),HTF_CONF_XML_HEADCONFIG)) {
  273.                     //headconfig
  274.                     $this->headconfig = new htf_frm_headconfig($arrcnode[$i]);
  275.                 } else if (htf_comp_xmlelementname($arrcnode[$i]->node_name(),HTF_CONF_XML_BODYCONFIG)) {
  276.                     //bodyconfig
  277.                     $this->bodyconfig = new htf_frm_bodyconfig($arrcnode[$i]);
  278.                 }
  279.             }
  280.         }
  281.         return;
  282.     }
  283.  
  284.     /**
  285.      * 存在しない要素について、子要素を初期値で生成する。
  286.      *
  287.      * @access     private
  288.      * @return    void 
  289.      ***/
  290.     function initialize_nullnodes() {
  291.         if (is_null($this->headconfig)) {
  292.             $this->headconfig = new htf_frm_headconfig();
  293.         }
  294.         if (is_null($this->bodyconfig)) {
  295.             $this->bodyconfig = new htf_frm_bodyconfig();
  296.         }
  297.         return;
  298.     }
  299.  
  300.     /**
  301.      * 引数のCSS定義xmlファイルをサーチして、使用するCSSファイルを返します。
  302.      *
  303.      * @param     string   $strxml  CSS定義xmlファイル名(cssdef.xml)
  304.      * @access     private
  305.      * @return    void 
  306.      ***/
  307.     function get_cssfname($strxml) {
  308.         //css定義xmlファイルパス取得
  309.         //カレントから上位ディレクトリをサーチ
  310.         $strfpath = htf_get_filepath(realpath('.'), $strxml);
  311.         if (!htf_is_existsval($strfpath)) {
  312.             //見つからなかったらインクルードパスをサーチ
  313.             $strfpath = htf_get_fileincludepath($strxml);
  314.         }
  315.         //css定義xmlファイルが見当たらない場合は空文字を返して終了
  316.         if (!htf_is_existsval($strfpath)) {
  317.             return "";
  318.         }
  319.         //使用するCSSファイルを判別
  320.         $objgetcss = new htf_frm_getcss($strfpath, $_SERVER['HTTP_USER_AGENT'], $this->browser_distinct_css);
  321.         $strcsspath = $objgetcss->cssname;
  322.  
  323.         return $strcsspath;
  324.         
  325.     }
  326.  
  327.  
  328.     /**
  329.      * 配下の子ノードに記載されているhtfフレーム置換タグを置換します。
  330.      * 
  331.      * @access     public
  332.      * @return    void 
  333.      ***/
  334.     function replace_defintag_childnodes()
  335.     {
  336.         //bodyconfig->bgimage
  337.         if (!is_null($his->bodyconfig)) {
  338.             $this->bodyconfig->bgimage = $this->replace_definetag($this->bodyconfig->bgimage);
  339.             //bodyconfig->pageconfig->bgimage
  340.             if (!is_null($this->bodyconfig->pageconfig)) {
  341.                 $this->bodyconfig->pageconfig->bgimage = $this->replace_definetag($this->bodyconfig->pageconfig->bgimage);
  342.                 //bodyconfig->pageconfig->pageheader->bgimage
  343.                 if (is_null($this->bodyconfig->pageconfig->pageheader)) {
  344.                     $this->bodyconfig->pageconfig->pageheader->bgimage = $this->replace_definetag($this->bodyconfig->pageconfig->pageheader->bgimage);
  345.                 }
  346.                 //bodyconfig->pageconfig->indexbar->bgimage
  347.                 if (is_null($this->bodyconfig->pageconfig->indexbar)) {
  348.                     $this->bodyconfig->pageconfig->indexbar->bgimage = $this->replace_definetag($this->bodyconfig->pageconfig->indexbar->bgimage);
  349.                 }
  350.                 //bodyconfig->pageconfig->leftarea->bgimage
  351.                 if (is_null($this->bodyconfig->pageconfig->leftarea)) {
  352.                     $this->bodyconfig->pageconfig->leftarea->bgimage = $this->replace_definetag($this->bodyconfig->pageconfig->leftarea->bgimage);
  353.                 }
  354.                 //bodyconfig->pageconfig->contentarea->bgimage
  355.                 if (is_null($this->bodyconfig->pageconfig->contentarea)) {
  356.                     $this->bodyconfig->pageconfig->contentarea->bgimage = $this->replace_definetag($this->bodyconfig->pageconfig->contentarea->bgimage);
  357.                 }
  358.                 //bodyconfig->pageconfig->rightarea->bgimage
  359.                 if (is_null($this->bodyconfig->pageconfig->rightarea)) {
  360.                     $this->bodyconfig->pageconfig->rightarea->bgimage = $this->replace_definetag($this->bodyconfig->pageconfig->rightarea->bgimage);
  361.                 }
  362.                 //bodyconfig->pageconfig->pagefooter->bgimage
  363.                 if (is_null($this->bodyconfig->pageconfig->pagefooter)) {
  364.                     $this->bodyconfig->pageconfig->pagefooter->bgimage = $this->replace_definetag($this->bodyconfig->pageconfig->pagefooter->bgimage);
  365.                 }
  366.             }
  367.             
  368.         }
  369.         //headconfig->cssfilename
  370.         if (!is_null($this->headconfig)) {
  371.             $this->headconfig->cssfilename = $this->replace_definetag($this->headconfig->cssfilename);
  372.         }
  373.         
  374.         return;
  375.     }
  376.         
  377.     /**
  378.      * htfフレームで設定された各種パス情報(イメージパス・CSSパス・JavaScriptパス・ルートパス)
  379.      * で引数内の置換タグを変換します。置換タグ定義は次の通り。
  380.      * %FRAME_IMAGEPATH%→イメージパス　%FRAME_CSSPATH%→CSSパス %FRAME_JSPATH%→JavaScriptパス　%FRAME_ROOTPATH%→ルートパス
  381.      * 
  382.      * @access     public
  383.      * @param     string    $srcstr 
  384.      * @return    string 
  385.      ***/
  386.     function replace_definetag($srcstr) {
  387.         $repstr1st = str_replace(HTF_REPLACE_FRAME_IMAGEPATH, $this->imagepath, $srcstr);
  388.         $repstr2nd = str_replace(HTF_REPLACE_FRAME_CSSPATH, $this->csspath, $repstr1st);
  389.         $repstr3rd = str_replace(HTF_REPLACE_FRAME_JSPATH, $this->jspath, $repstr2nd);
  390.         $repstr4th = str_replace(HTF_REPLACE_FRAME_ROOTPATH, $this->rootpath, $repstr3rd);
  391.         
  392.         return $repstr4th;
  393.     }    
  394. }
  395.  
  396. ?>
Documentation generated on Tue, 19 Sep 2006 06:20:52 +0900 by phpDocumentor 1.3.0