Source for file jResponseHtml.class.php

Documentation is available at jResponseHtml.class.php

<?php
/**
* @package jelix
* @subpackage core_response
* @author Laurent Jouanneau
* @contributor Yann, Dominique Papin
* @contributor Warren Seine, Alexis Métaireau, Julien Issler, Olivier Demah, Brice Tence
* few lines of code are copyrighted CopixTeam http://www.copix.org
* @link http://www.jelix.org
* @licence GNU Lesser General Public Licence see LICENCE file or http://www.gnu.org/licenses/lgpl.html
*/
/**
*
*/
require_once(JELIX_LIB_CORE_PATH.'response/jResponseBasicHtml.class.php');
require_once(JELIX_LIB_PATH.'tpl/jTpl.class.php');
/**
* HTML response
* @package jelix
* @subpackage core_response
*/
class jResponseHtml extends jResponseBasicHtml {
/**
* jresponse id
* @var string
*/
protected $_type = 'html';
/**
* Title of the document
* @var string
*/
public $title = '';
/**
* favicon url linked to the document
* @var string
* @since 1.0b2
*/
public $favicon = '';
/**
* The template engine used to generate the body content
* @var jTpl
*/
public $body = null;
/**
* selector of the main template file
* This template should contains the body content, and is used by the $body template engine
* @var string
*/
public $bodyTpl = '';
/**
* Selector of the template used when there are some errors, instead of $bodyTpl
* @var string
*/
public $bodyErrorTpl = '';
/**
* body attributes
* This attributes are written on the body tags
* @var array
*/
public $bodyTagAttributes= array();
/**
* list of css stylesheet
* @var array key = url, value=link attributes
*/
protected $_CSSLink = array ();
/**
* list of css stylesheet for IE
* @var array key = url, value=link attributes + optional parameter _iecondition
*/
protected $_CSSIELink = array ();
/**
* list of CSS code
*/
protected $_Styles = array ();
/**
* list of js script
* @var array key = url, value=link attributes
*/
protected $_JSLink = array ();
/**
* list of js script for IE
* @var array key = url, value=link attributes + optional parameter _iecondition
*/
protected $_JSIELink = array ();
/**
* inline js code to insert before js links
* @var array list of js source code
*/
protected $_JSCodeBefore = array ();
/**
* inline js code to insert after js links
* @var array list of js source code
*/
protected $_JSCode = array ();
/**
* list of keywords to add into a meta keyword tag
* @var array array of strings
*/
protected $_MetaKeywords = array();
/**
* list of descriptions to add into a meta description tag
* @var array array of strings
*/
protected $_MetaDescription = array();
/**
* content of the meta author tag
* @var string
*/
protected $_MetaAuthor = '';
/**
* content of the meta generator tag
* @var string
*/
protected $_MetaGenerator = '';
/**
* list of information to generate link tags
* @var array keys are the href value, valu is an array ('rel','type','title')
*/
protected $_Link = array();
/**
* the end tag to finish tags. it is different if we are in XHTML mode or not
* @var string
*/
protected $_endTag="/>\n";
/**
* says if the document uses a Strict or Transitional Doctype
* @var boolean
* @since 1.1.3
*/
protected $_strictDoctype = true;
/**
* constructor;
* setup the charset, the lang, the template engine
*/
function __construct (){
$this->body = new jTpl();
parent::__construct();
}
/**
* output the html content
*
* @return boolean true if the generated content is ok
*/
public function output(){
if($this->_outputOnlyHeaders){
$this->sendHttpHeaders();
return true;
}
foreach($this->plugins as $name=>$plugin)
$plugin->afterAction();
$this->doAfterActions();
$this->setContentType();
// let's get the main content for the body
// we don't output yet <head> and other things, to have the
// opportunity for any components called during the output,
// to add things in the <head>
if ($this->bodyTpl != '') {
$this->body->meta($this->bodyTpl);
$content = $this->body->fetch($this->bodyTpl, 'html', true, false);
}
else $content = '';
// retrieve errors messages and log messages
jLog::outputLog($this);
foreach($this->plugins as $name=>$plugin)
$plugin->beforeOutput();
// now let's output the html content
$this->sendHttpHeaders();
$this->outputDoctype();
$this->outputHtmlHeader();
echo '<body ';
foreach($this->bodyTagAttributes as $attr=>$value){
echo $attr,'="', htmlspecialchars($value),'" ';
}
echo ">\n";
echo implode("\n",$this->_bodyTop);
echo $content;
echo implode("\n",$this->_bodyBottom);
foreach($this->plugins as $name=>$plugin)
$plugin->atBottom();
echo '</body></html>';
return true;
}
/**
* add a generic link to the head
*
* @param string $href url of the link
* @param string $rel relation name
* @param string $type mime type of the ressource
* @param string $title
*/
public function addLink($href, $rel, $type='', $title='') {
$this->_Link[$href] = array($rel, $type, $title);
}
/**
* add a link to a javascript script in the document head
*
* $forIe parameter exists since 1.0b2
*
* @param string $src the link
* @param array $params additionnals attributes for the script tag
* @param boolean $forIE if true, the script sheet will be only for IE browser. string values possible (ex:'lt IE 7')
*/
public function addJSLink ($src, $params=array(), $forIE=false){
if($forIE){
if (!isset ($this->_JSIELink[$src])){
if (!is_bool($forIE) && !empty($forIE))
$params['_ieCondition'] = $forIE;
$this->_JSIELink[$src] = $params;
}
}else{
if (!isset ($this->_JSLink[$src])){
$this->_JSLink[$src] = $params;
}
}
}
/**
* returns all JS links
* @return array key = url, value=link attributes
*/
public function getJSLinks() { return $this->_JSLink; }
/**
* set all JS links
* @param array $list key = url, value=link attributes
*/
public function setJSLinks($list) { $this->_JSLink = $list; }
/**
* returns all JS links for IE
* @return array key = url, value=link attributes + optional parameter _iecondition
*/
public function getJSIELinks() { return $this->_JSIELink; }
/**
* set all JS links for IE
* @param array $list key = url, value=link attributes
*/
public function setJSIELinks($list) { $this->_JSIELink = $list; }
/**
* returns all CSS links
* @var array key = url, value=link attributes
*/
public function getCSSLinks() { return $this->_CSSLink; }
/**
* set all CSS links
* @param array $list key = url, value=link attributes
*/
public function setCSSLinks($list) { $this->_CSSLink = $list; }
/**
* returns all CSS links for IE
* @var array key = url, value=link attributes + optional parameter _iecondition
*/
public function getCSSIELinks() { return $this->_CSSIELink; }
/**
* set all CSS links for IE
* @param array $list key = url, value=link attributes
*/
public function setCSSIELinks($list) { $this->_CSSIELink = $list; }
/**
* add a link to a css stylesheet in the document head
*
* $forIe parameter exists since 1.0b2
*
* @param string $src the link
* @param array $params additionnals attributes for the link tag
* @param mixed $forIE if true, the style sheet will be only for IE browser. string values possible (ex:'lt IE 7')
*/
public function addCSSLink ($src, $params=array (), $forIE=false){
if($forIE){
if (!isset ($this->_CSSIELink[$src])){
if (!is_bool($forIE) && !empty($forIE))
$params['_ieCondition'] = $forIE;
$this->_CSSIELink[$src] = $params;
}
}else{
if (!isset ($this->_CSSLink[$src])){
$this->_CSSLink[$src] = $params;
}
}
}
/**
* add inline css style into the document (inside a <style> tag)
* @param string $selector css selector
* @param string $def css properties for the given selector
*/
public function addStyle ($selector, $def=null){
if (!isset ($this->_Styles[$selector])){
$this->_Styles[$selector] = $def;
}
}
/**
* add inline javascript code (inside a <script> tag)
* @param string $code javascript source code
* @param boolean $before will insert the code before js links if true
*/
public function addJSCode ($code, $before = false){
if ($before)
$this->_JSCodeBefore[] = $code;
else
$this->_JSCode[] = $code;
}
/**
* add some keywords in a keywords meta tag
* @author Yann
* @param string $content keywords
* @since 1.0b1
*/
public function addMetaKeywords ($content){
$this->_MetaKeywords[] = $content;
}
/**
* add a description in a description meta tag
* @author Yann
* @param string $content a description
* @since 1.0b1
*/
public function addMetaDescription ($content){
$this->_MetaDescription[] = $content;
}
/**
* add author(s) in a author meta tag
* @author Olivier Demah
* @param string $content author(s)
* @since 1.2
*/
public function addMetaAuthor($content){
$this->_MetaAuthor = $content;
}
/**
* add generator a generator meta tag
* @author Olivier Demah
* @param string $content generator
* @since 1.2
*/
public function addMetaGenerator($content){
$this->_MetaGenerator = $content;
}
/**
* generate the doctype. You can override it if you want to have your own doctype, like XHTML+MATHML.
* @since 1.1
*/
protected function outputDoctype (){
if($this->_isXhtml){
echo '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 '.($this->_strictDoctype?'Strict':'Transitional').'//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-'.($this->_strictDoctype?'strict':'transitional').'.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="',$this->_lang,'" lang="',$this->_lang,'">
';
}else{
echo '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01'.($this->_strictDoctype?'':' Transitional').'//EN" "http://www.w3.org/TR/html4/'.($this->_strictDoctype?'strict':'loose').'.dtd">', "\n";
echo '<html lang="',$this->_lang,'">';
}
}
protected function outputJsScriptTag( $fileUrl, $scriptParams ) {
$params = '';
foreach ($scriptParams as $param_name=>$param_value){
if ($param_name=='_ieCondition')
continue ;
$params .= $param_name.'="'. htmlspecialchars($param_value).'" ';
}
echo '<script type="text/javascript" src="',htmlspecialchars($fileUrl),'" ',$params,'></script>',"\n";
}
protected function outputCssLinkTag( $fileUrl, $cssParams ) {
$params = '';
foreach ($cssParams as $param_name=>$param_value){
if ($param_name=='_ieCondition')
continue ;
$params .= $param_name.'="'. htmlspecialchars($param_value).'" ';
}
if(!isset($cssParams['rel']))
$params .='rel="stylesheet" ';
echo '<link type="text/css" href="',htmlspecialchars($fileUrl),'" ',$params,$this->_endTag,"\n";
}
/**
* generate the content of the <head> content
*/
protected function outputHtmlHeader (){
echo '<head>'."\n";
if($this->_isXhtml && $this->xhtmlContentType && strstr($_SERVER['HTTP_ACCEPT'],'application/xhtml+xml')){
echo '<meta content="application/xhtml+xml; charset='.$this->_charset.'" http-equiv="content-type"'.$this->_endTag;
} else {
echo '<meta content="text/html; charset='.$this->_charset.'" http-equiv="content-type"'.$this->_endTag;
}
echo '<title>'.htmlspecialchars($this->title)."</title>\n";
if(!empty($this->_MetaDescription)){
// meta description
$description = implode(' ',$this->_MetaDescription);
echo '<meta name="description" content="'.htmlspecialchars($description).'" '.$this->_endTag;
}
if(!empty($this->_MetaKeywords)){
// meta description
$keywords = implode(',',$this->_MetaKeywords);
echo '<meta name="keywords" content="'.htmlspecialchars($keywords).'" '.$this->_endTag;
}
if (!empty($this->_MetaGenerator)) {
echo '<meta name="generator" content="'.htmlspecialchars($this->_MetaGenerator).'" '.$this->_endTag;
}
if (!empty($this->_MetaAuthor)) {
echo '<meta name="author" content="'.htmlspecialchars($this->_MetaAuthor).'" '.$this->_endTag;
}
// css link
foreach ($this->_CSSLink as $src=>$params){
$this->outputCssLinkTag($src, $params);
}
foreach ($this->_CSSIELink as $src=>$params){
// special params for conditions on IE versions
if (!isset($params['_ieCondition']))
$params['_ieCondition'] = 'IE' ;
echo '<!--[if '.$params['_ieCondition'].' ]>';
$this->outputCssLinkTag($src, $params);
echo '<![endif]-->';
}
if($this->favicon != ''){
$fav = htmlspecialchars($this->favicon);
echo '<link rel="icon" type="image/x-icon" href="',$fav,'" ',$this->_endTag;
echo '<link rel="shortcut icon" type="image/x-icon" href="',$fav,'" ',$this->_endTag;
}
// others links
foreach($this->_Link as $href=>$params){
$more = array();
if( !empty($params[1]))
$more[] = 'type="'.$params[1].'"';
if (!empty($params[2]))
$more[] = 'title = "'.htmlspecialchars($params[2]).'"';
echo '<link rel="',$params[0],'" href="',htmlspecialchars($href),'" ',implode($more, ' '),$this->_endTag;
}
// js code
if(count($this->_JSCodeBefore)){
echo '<script type="text/javascript">
// <![CDATA[
'.implode ("\n", $this->_JSCodeBefore).'
// ]]>
</script>';
}
// js link
foreach ($this->_JSLink as $src=>$params){
$this->outputJsScriptTag($src, $params);
}
foreach ($this->_JSIELink as $src=>$params){
if (!isset($params['_ieCondition']))
$params['_ieCondition'] = 'IE' ;
echo '<!--[if '.$params['_ieCondition'].' ]>';
$this->outputJsScriptTag($src, $params);
echo '<![endif]-->';
}
// styles
if(count($this->_Styles)){
echo "<style type=\"text/css\">\n";
foreach ($this->_Styles as $selector=>$value){
if (strlen ($value)){
// there is a key/value
echo $selector.' {'.$value."}\n";
}else{
// no value, it could be simply a command
//for example @import something, ...
echo $selector, "\n";
}
}
echo "\n </style>\n";
}
// js code
if(count($this->_JSCode)){
echo '<script type="text/javascript">
// <![CDATA[
'.implode ("\n", $this->_JSCode).'
// ]]>
</script>';
}
echo implode ("\n", $this->_headBottom), '</head>';
}
/**
* used to erase some head properties
* @param array $what list of one or many of this strings : 'CSSLink', 'CSSIELink', 'Styles', 'JSLink', 'JSIELink', 'JSCode', 'Others','MetaKeywords','MetaDescription'. If null, it cleans all values.
*/
public function clearHtmlHeader ($what=null){
$cleanable = array ('CSSLink', 'CSSIELink', 'Styles', 'JSLink','JSIELink', 'JSCode', 'Others','MetaKeywords','MetaDescription');
if($what==null)
$what= $cleanable;
foreach ($what as $elem){
if (in_array ($elem, $cleanable)){
$name = '_'.$elem;
$this->$name = array ();
}
}
}
/**
* change the type of html for the output
* @param boolean $xhtml true if you want xhtml, false if you want html
*/
public function setXhtmlOutput($xhtml = true){
$this->_isXhtml = $xhtml;
if($xhtml)
$this->_endTag = "/>\n";
else
$this->_endTag = ">\n";
}
/**
* activate / deactivate the strict Doctype (activated by default)
* @param boolean $val true for strict, false for transitional
* @since 1.1.3
*/
public function strictDoctype($val = true){
$this->_strictDoctype = $val;
}
/**
* return the end of a html tag : "/>" or ">", depending if it will generate xhtml or html
* @return string
*/
public function endTag(){ return $this->_endTag;}
}

Documentation generated on Mon, 26 Oct 2015 21:55:35 +0100 by phpDocumentor 1.4.3