File Source for htf_frm

<?php
/**
* htf_frm_headconfigクラス
*
* headconfig情報を保持しヘッダを管理するクラス
*
* @package HtmlTemplateFramework
* @subpackage frame
* @access public
* @author Yamauchi Shogo <htf@as-prj.com>
* @version $Id: htf_frm_headconfig.phl ,v 1.0 $
***/
require_once("htf_com_initialize.inc"); //共通初期処理
require_once("htf_tag_element.phl"); //タグオブジェクト
require_once("htf_frm_headtag_element.phl"); //headタグ要素オブジェクト
/**
* headconfig情報を保持しヘッダを管理するクラス。
*
* コンストラクタに引数で渡されるheadconfig要素のDOMノードを参照し、
* htfフレームで出力するhtmlのheadタグ部分の情報を保持します。
*
* @access public
* @author Yamauchi Shogo <htf@as-prj.com>
***/
class htf_frm_headconfig {
/**
* content_type属性
*
* htmlのheadタグ内に出力するmetaタグのcontent-type指定文字列を指定します。
* 初期値は、htf環境設定情報に設定されている内部エンコーディング文字列を参照して決定されます。
* UTF-8の場合には、'text/html; charset=utf-8'
* EUC-JPの場合には、'text/html; charset=euc-jp'
* が設定されています。
* htmlタグ出力時の例として、たとえば、content_type属性に'text/html; charset=euc-jp'と設定すると、headタグ内に
* <samp>
* <meta http-equiv="Content-Type" content="text/html; charset=euc-jp">
* </samp>
*
* とmetaタグが出力されます。
*
* @access public
* @var string
*/
var $content_type;
/**
* content_style_type属性
*
* htmlのheadタグ内に出力するmetaタグのcontent-style-type指定文字列を指定します。
* 初期値は、'text/css'です。空文字を指定すると該当のmetaタグは出力されません。
* htmlタグ出力時の例として、たとえば、content_style_type属性に'text/cssと設定すると、headタグ内に
* <samp>
* <meta http-equiv="Content-Style-Type" content="text/css">
* </samp>
*
* とmetaタグが出力されます。
*
* @access public
* @var string
*/
var $content_style_type;
/**
* content_script_type属性
*
* htmlのheadタグ内に出力するmetaタグのcontent-script-type指定文字列を指定します。
* 初期値は、'text/javascript'です。空文字を指定すると該当のmetaタグは出力されません。
* htmlタグ出力時の例として、たとえば、content_script_type属性に'text/vbscript'と設定すると、headタグ内に
* <samp>
* <meta http-equiv="Content-Script-Type" content="text/vbscript">
* </samp>
*
* とmetaタグが出力されます。
*
* @access public
* @var string
*/
var $content_script_type;
/**
* title属性
*
* htmlのheadタグ内に出力するtitleタグの文字列を指定します。
* 初期値は、空文字です。空文字の場合には、titleタグは出力されません。
* htmlタグ出力時の例として、たとえば、title属性に'出力タイトル'と設定すると、headタグ内に
* <samp>
* <title>出力タイトル<title>
* </samp>
*
* とtitleタグが出力されます。
*
* @access public
* @var string
*/
var $title;
/**
* author属性
*
* htmlのheadタグ内に出力するmetaタグのauthor指定文字列を指定します。
* 初期値は、空文字です。空文字の場合には、authorを出力するmetaタグは出力されません。
* htmlタグ出力時の例として、たとえば、author属性に'ASP Software'と設定すると、headタグ内に
* <samp>
* <meta name="author" content="ASP Software">
* </samp>
*
* とmetaタグが出力されます。
*
* @access public
* @var string
*/
var $author;
/**
* copyright属性
*
* htmlのheadタグ内に出力するmetaタグのcopyright指定文字列を指定します。
* 初期値は、空文字です。空文字の場合には、copyrightを出力するmetaタグは出力されません。
* htmlタグ出力時の例として、たとえば、copyright属性に'Copyright(C)1996-2006 ASP Software. All rights reserved.'と設定すると、headタグ内に
* <samp>
* <meta name="copyright" content="Copyright(C)1996-2006 ASP Software. All rights reserved.">
* </samp>
*
* とmetaタグが出力されます。
*
* @access public
* @var string
*/
var $copyright;
/**
* description属性
*
* htmlのheadタグ内に出力するmetaタグのdescription指定文字列を指定します。
* 初期値は、空文字です。空文字の場合には、descriptionを出力するmetaタグは出力されません。
* htmlタグ出力時の例として、たとえば、description属性に'ASPソフトウエアが役立つフリー＆シェアウエアを提供します。'と設定すると、headタグ内に
* <samp>
* <meta name="description" content="ASPソフトウエアが役立つフリー＆シェアウエアを提供します。">
* </samp>
*
* とmetaタグが出力されます。
*
* @access public
* @var string
*/
var $description;
/**
* keywords属性
*
* htmlのheadタグ内に出力するmetaタグのkeywords指定文字列を指定します。
* 初期値は、空文字です。空文字の場合には、keywordsを出力するmetaタグは出力されません。
* htmlタグ出力時の例として、たとえば、keywords属性に'メール配信,一括配信,AS-SMTP,AS-POP3,AS-SendMail'と設定すると、headタグ内に
* <samp>
* <meta name="keywords" content="メール配信,一括配信,AS-SMTP,AS-POP3,AS-SendMail">
* </samp>
*
* とmetaタグが出力されます。
*
* @access public
* @var string
*/
var $keywords;
/**
* robots属性
*
* htmlのheadタグ内に出力するmetaタグのrobots指定文字列を指定します。
* 初期値は、空文字です。空文字の場合には、robotsを出力するmetaタグは出力されません。
* htmlタグ出力時の例として、たとえば、robots属性に'INDEX,FOLLOW'と設定すると、headタグ内に
* <samp>
* <meta name="robots" content="INDEX,FOLLOW">
* </samp>
*
* とmetaタグが出力されます。
*
* @access public
* @var string
*/
var $robots;
/**
* addheader属性
*
* htfで指定可能な各属性情報以外にheadタグ内に出力を行いたい場合、addheader属性にPHPスクリプトファイル名を設定します。
* headタグ出力時に、属性指定のファイルをサーチし、ファイル内容をincludeして出力します。初期値は、空文字です。
* ファイルのサーチ順は、
* (1)現在の実行ディレクトリ
* (2)実行ディレクトリから上位（ドキュメントルート・またはルートディレクトリまで）
* (3)PHPに設定されたインクルードディレクトリ
* となります。
* また、使用する用途としては、たとえば、
* (1)htfで選択されるCSSファイル以外のCSSファイルを使用したい
* (2)JavaScriptファイルを読み込みたい
* (3)他のmetaタグを出力したい
* 場合などが該当します。
*
* @access public
* @var string
*/
var $addheader;
/**
* cssstr属性
*
* CSS文字列をhead内に直接出力したい場合、cssstr属性に出力文字列を設定します。
* この属性はhtf_frm_frameconfigクラスで使用され、htfフレームの他ページエリアでの指定書式は、このプロパティを介して出力されます。
*
* @access public
* @var string
*/
var $cssstr;
/**
* cssfilename属性
*
* 読み込むCSSファイル名を指定します。
* この属性は、htfが判別するCSSファイルを定義するために使用されます。
* htmlタグ出力時の例として、たとえば、cssfilename属性に'/css/style.css'と設定されたとすると、headタグ内に
* <samp>
* <link rel="stylesheet" href="/css/style.css" type="text/css">
* </samp>
*
* とlinkタグが出力されます。
*
* @access public
* @var string
*/
var $cssfilename;
/**
* head属性
*
* 出力するheadタグのタグオブジェクトです。
*
* @access private
* @var htf_frm_headtag_element
*/
var $head;
/**
* 引数のDOMノードから、htf_frm_headconfigクラスのインスタンスを生成します。
* 各属性値が存在しない場合には、初期値で生成します。
*
* @param object $objnode headconfigのDOMノード
* @return void
***/
function htf_frm_headconfig($objnode=NULL) {
//プロパティ初期化
$this->initialize_property();
//各プロパティ上書き
if (!is_null($objnode)) {
$this->override_property($objnode->attributes());
}
/*
print("headconfig_construct \n");
print("content_type:".$this->content_type." \n");
print("content_style_type:".$this->content_style_type." \n");
*/
return;
}
/**
* HTMLのheadタグを文字列として取得します。
*
* @access public
* @return string headタグ文字列
***/
function get_htmltag() {
//headタグ生成
$this->make_headtag();
//headタグ出力
return $this->head->get_htmltag();
}
/**
* HTMLのheadタグを出力します。
*
* @access public
* @return void
***/
function print_htmltag() {
//headタグ生成
$this->make_headtag();
//headタグ出力
$this->head->print_htmltag();
return;
}
/**
* headタグオブジェクトを生成します。
*
* @access private
* @return void
***/
function make_headtag() {
//mm_swap用jsファイルパス取得(インクルードパスから）
$strjspath = htf_get_fileincludepath(HTF_MM_SWAP_JS);
//addheader指定ファイルパス取得
$strfpath= $this->get_addheaderpath();
//headタグオブジェクト作成
$this->head = new htf_frm_headtag_element($strfpath);
//metaタグ・Content-Type
$this->head->add_meta_content_type($this->content_type);
//metaタグ・Content-Styel-Type
$this->head->add_meta_content_style_type($this->content_style_type);
//metaタグ・Content-Script-Type
$this->head->add_meta_content_script_type($this->content_script_type);
//metaタグ・author
$this->head->add_meta_author($this->author);
//metaタグ・copyright
$this->head->add_meta_copyright($this->copyright);
//metaタグ・description
$this->head->add_meta_description($this->description);
//metaタグ・keywords
$this->head->add_meta_keywords($this->keywords);
//metaタグ・robots
$this->head->add_meta_robots($this->robots);
//metaタグ・Generator
$this->head->add_meta_generator();
//titleタグ
$this->head->add_title($this->title);
//styleタグ（引数のCSS文字列から生成）
$this->head->add_style($this->cssstr, $this->content_style_type);
//linkタグ（引数のCSSファイル名から生成）
$this->head->add_link($this->cssfilename);
//scriptタグ（イメージスワップ用jsファイルがインクルードにあるはず）
$this->head->add_script($strjspath, 'text/javascript', 'JavaScript1.1');
return;
}
/**
* 各種プロパティを初期化します。
*
* @access private
* @return void
***/
function initialize_property() {
//内部エンコードからContent-Type設定文字列を判断
if (!strcasecmp(HTF_PHP_INTERNAL_ENCODING, 'euc-jp')) {
$this->content_type = HTF_CONTENT_TYPE_HTML_EUCJP;
} else {
$this->content_type = HTF_CONTENT_TYPE_HTML_UTF8;
}
$this->content_style_type = HTF_CONTENT_STYLE_TYPE_CSS;
$this->content_script_type = HTF_CONTENT_SCRIIPT_TYPE_JAVASCRIPT;
$this->title = "";
$this->author = "";
$this->copyright = "";
$this->description = "";
$this->keywords = "";
$this->robots = "";
$this->addheader = "";
$this->cssstr = "";
$this->cssfilename = "";
return;
}
/**
* 各種プロパティを上書きします。
*
* @access private
* @return void
***/
function override_property($arrattr) {
for ($i=0 ; $i<count($arrattr) ; $i++) {
if (htf_comp_xmlattrname(HTF_ATTR_HEADCONFIG_CONTENT_TYPE, $arrattr[$i]->name)){
//content_type属性
$this->content_type = htf_get_encoded_attr($arrattr[$i]->value);
} else if (htf_comp_xmlattrname(HTF_ATTR_HEADCONFIG_CONTENT_STYLE_TYPE, $arrattr[$i]->name)){
//content_style_type属性
$this->content_style_type = htf_get_encoded_attr($arrattr[$i]->value);
} else if (htf_comp_xmlattrname(HTF_ATTR_HEADCONFIG_CONTENT_SCRIPT_TYPE, $arrattr[$i]->name)){
//content_script_type属性
$this->content_script_type = htf_get_encoded_attr($arrattr[$i]->value);
} else if (htf_comp_xmlattrname(HTF_ATTR_HEADCONFIG_TITLE, $arrattr[$i]->name)) {
//title属性
$this->title = htf_get_encoded_attr($arrattr[$i]->value);
} else if (htf_comp_xmlattrname(HTF_ATTR_HEADCONFIG_AUTHOR, $arrattr[$i]->name)){
//author属性
$this->author = htf_get_encoded_attr($arrattr[$i]->value);
} else if (htf_comp_xmlattrname(HTF_ATTR_HEADCONFIG_COPYRIGHT, $arrattr[$i]->name)){
//copyright属性
$this->copyright = htf_get_encoded_attr($arrattr[$i]->value);
} else if (htf_comp_xmlattrname(HTF_ATTR_HEADCONFIG_DESCRIPTION, $arrattr[$i]->name)){
//description属性
$this->description = htf_get_encoded_attr($arrattr[$i]->value);
} else if (htf_comp_xmlattrname(HTF_ATTR_HEADCONFIG_KEYWORDS, $arrattr[$i]->name)){
//keywords属性
$this->keywords = htf_get_encoded_attr($arrattr[$i]->value);
} else if (htf_comp_xmlattrname(HTF_ATTR_HEADCONFIG_ROBOTS, $arrattr[$i]->name)){
//robots属性
$this->robots = htf_get_encoded_attr($arrattr[$i]->value);
} else if (htf_comp_xmlattrname(HTF_ATTR_HEADCONFIG_ADDHEADER, $arrattr[$i]->name)){
//addheader属性
$this->addheader = htf_get_encoded_attr($arrattr[$i]->value);
}
}
return;
}
/**
* addheaderの存在パスをサーチして取得します。
*
* @access private
* @return string addheaderの存在パス
***/
function get_addheaderpath() {
$retpath="";
if (htf_is_existsval($this->addheader)) {
//まずは上位パスをサーチ
$retpath = htf_get_filepath_relative(realpath('.'), $this->addheader);
if (!htf_is_existsval($retpath)) {
//見つからなかったらインクルードパスをサーチ
$retpath = htf_get_fileincludepath($this->addheader);
}
}
return $retpath;
}
}
?>

Source for file htf_frm_headconfig.phl