File Source for HTMLDocument.class.php

<?php
/**
* For including this file you have to define the constant "CLASSPATH".
* Because every include in the framework depends on the CLASSPATH definition.
* The CLASSPATH means the relative path to the folder that contains the
* framework GilliGan.
*
* @package html
*/
if( !defined( "CLASSPATH" ) )
{
echo "<h3>You have to define the constant CLASSPATH!</h3>\n";
echo "Example: define( 'CLASSPATH', '../path/to/classes/' );\n";
exit();
}
/**
* Including the parent class.
*/
require_once( CLASSPATH."html/ABSTHTMLTag.class.php" );
/**
* Including a class to format plain text.
*/
require_once( CLASSPATH."core/PlainTextFormatter.class.php" );
/**
* Including a class to generate Javascripts or setting up little standard
* javascripts.
*/
include_once( CLASSPATH."html/JavaScript.class.php" );
$gg_constant_code = 0;
/**
* Constant represents the standard mode for html to the gilligan-framework.
*/
define( "HTML_STANDARD_MODE", $gg_constant_code++ );
/**
* Constant represents the quirk mode for html to the gilligan-framework.
*/
define( "HTML_QUIRK_MODE", $gg_constant_code++ );
/**
* Creating HTML-Documents
*
* @package html
* @version 0.2.23
* @author Daniel Plücken <daniel@debakel.net>
* @license http://www.gnu.org/copyleft/lesser.html
* GNU Lesser General Public License
* @copyright Copyright (c) 2003 Daniel Plücken <daniel@debakel.net>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General
* Public License along with this library; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place, Suite 330,
* Boston, MA 02111-1307 USA
*/
class HTMLDocument extends ABSTHTMLTag
{
/**
* @var array $meta
* @access private
*/
var $meta;
/**
* The title of this document.
*
* @var string $title
* @access private
*/
var $title;
/**
* @var string $head
* @access private
*/
var $head;
/**
* The content of this HTML-document.
*
* @var string $body
* @access private
*/
var $body;
/**
* The space between </body> and </html>.
*
* @var string $behindbody
* @access public
*/
var $behindbody;
/**
* Class variable to switch the mode of the document between quirk and
* standard.
*
* @var integer
*/
var $mode = HTML_STANDARD_MODE;
var $docitems;
var $doctables;
var $docforms;
///////////////////////////////
// Attributes of the body-tag
/**
* Stores the value of the text-attribute of the body-tag.
*
* @var integer $text
*/
var $text;
/**
* Stores the value of the bgcolor-attribute of the body-tag to set the
* backgroundcolor of the Site.
*
* @var integer $bgcolor
*/
var $bgcolor;
/**
* Stores the value of the leftmargin-attribute of the body-tag.
*
* @var integer
*/
var $leftmargin = 0;
/**
* Stores the value of the topmargin-attribute of the body-tag.
*
* @var integer $topmargin
*/
var $topmargin = 0;
/**
* Stores the value of the marginwidth-attribute of the body-tag.
*
* @var integer $marginwidth
*/
var $marginwidth = 0;
/**
* Stores the value of the marginheight-attribute of the body-tag.
*
* @var integer $marginheight
*/
var $marginheight = 0;
/**
* Stores the javascript order that should execute when the browser loads
* the document.
*
* @var string $onload
*/
var $onload;
/**
* Stores the javascript order that should execute when the browser leaves
* the document.
*
* var string $onblur
*/
var $onblur;
/**
* Stores the javascript order that should execute when the document will be
* scrolled.
*
* var string $onscroll
*/
var $onscroll;
/**
* Stores the javascript order that should execute when the document will be
* resized.
*
* var string $onresize
*/
var $onresize;
/**
* Stores the value of the background-attribute of the body-tag. For using
* a background image.
*
* @var integer $background
*/
var $background;
/**
* Standard is 4.01.
*
* @var double $version
*/
var $version = 4.01;
/**
* Valid values for example are "html", "math" or "svg". The standard value is
* "html".
*
* @var string $doctype
*/
var $doctype = "html";
/**
* Valid values for example are "HTML", "XHTML", "SVG" or "MathML". The
* standard value is "HTML".
*
* @var string $contenttype
*/
var $contenttype = "HTML";
/**
* Valid values for example are "Final", "Strict", "Transitional"
* or "Frameset". The standard value is "Transitional".
* If "Frameset" is set as value, the body-tag will not be add!
*
* @var string $behaviour
*/
var $behaviour = "Transitional";
/**
* Stores wether the doctype definition should include to the document or
* not.
*
* @var boolean $include_doctype
*/
var $include_doctype = true;
// Attributes of the body-tag /
///////////////////////////////
/**
* Stores whether the document should be formatted by the PlainTextFormatter
* or not.
*
* @var boolean $noformat
* @access private
*/
var $noformat = false;
/**
* Constructor.
*
* @access public
* @version 1.1
* @since 0.1.0
*
* @param $title The title of the document.
* @param $head Javascripts, stylesheets etc.
* @param $body The content of the document.
* @param $behindbody For example javascripts after the closing body-tag.
* @param $meta_char The value of the meta-charset of this document.
*
* @return HTMLDocument
*/
function HTMLDocument(
$title = "",
$head = "",
$body = "",
$behindbody = "",
$meta_char = "ISO-8859-1"
)
{
$this->title = $title;
$this->head = $head;
$this->body = $body;
$this->behindbody = $behindbody;
$this->meta["charset"] = $meta_char;
}
/**
* Sets the title of this document.
*
* @access public
* @version 1.0
* @since 0.1.0
*
* @param string $string
*
* @return void
*/
function setTitle( $string )
{ $this->title = $string; }
/**
* Sets the head of this document.
*
* @access public
* @version 1.0
* @since 0.1.0
*
* @param string $string
*
* @return void
*/
function setHead( $string )
{ $this->head = $string; }
/**
* Sets the body's content of this document.
*
* @access public
* @version 1.0
* @since 0.1.0
*
* @param string $string
*
* @return void
*/
function setBody( $string )
{ $this->body = $string; }
/**
* Sets the mode of this document to quirk or standard. Preselect on method
* call with no entered parameter is the quirk mode, because preselect of the
* class-initiation is the standard mode.
*
* @access public
* @version 1.0
* @since 0.2.21
*
* @param integer $int
*
* @return void
*/
function setMode( $int = HTML_QUIRK_MODE )
{
switch( $int )
{
case HTML_STANDARD_MODE:
case HTML_QUIRK_MODE;
$this->mode = $int;
default:
break;
}
}
/**
* Sets the body's text-attribute of this document.
*
* @access public
* @version 1.0
* @since 0.1.0
*
* @param string $string
*
* @return void
*/
function setText( $string )
{ $this->text = $string; }
/**
* Sets the body's bgcolor-attribute of this document.
*
* @access public
* @version 1.0
* @since 0.1.0
*
* @param string $string
*
* @return void
*/
function setBGColor( $string )
{ $this->bgcolor = $string; }
/**
* Sets the body's leftmargin-attribute of this document.
*
* @access public
* @version 1.0
* @since 0.1.0
*
* @param string $string
*
* @return void
*/
function setLeftMargin( $string )
{ $this->leftmargin = $string; }
/**
* Sets the body's topmargin-attribute of this document.
*
* @access public
* @version 1.0
* @since 0.1.0
*
* @param string $string
*
* @return void
*/
function setTopMargin( $string )
{ $this->topmargin = $string; }
/**
* Sets the body's marginwidth-attribute of this document.
*
* @access public
* @version 1.0
* @since 0.1.0
*
* @param string $string
*
* @return void
*/
function setMarginWidth( $string )
{ $this->marginwidth = $string; }
/**
* Sets the body's marginheight-attribute of this document.
*
* @access public
* @version 1.0
* @since 0.1.0
*
* @param string $string
*
* @return void
*/
function setMarginHeight( $string )
{ $this->marginheight = $string; }
/**
* Sets the body's onload-attribute of this document.
*
* @access public
* @version 1.0
* @since 0.1.0
*
* @param string $string
*
* @return void
*/
function setOnLoad( $string )
{ $this->onload = $string; }
/**
* Sets the body's onblur-attribute of this document.
*
* @access public
* @version 1.0
* @since 0.1.0
*
* @param string $string
*
* @return void
*/
function setOnBlur( $string )
{ $this->onblur = $string; }
/**
* Sets the body's onscroll-attribute of this document.
*
* @access public
* @version 1.0
* @since 0.2.23
*
* @param string $string
*
* @return void
*/
function setOnScroll( $string )
{ $this->onscroll = $string; }
/**
* Sets the body's onresize-attribute of this document.
*
* @access public
* @version 1.0
* @since 0.2.23
*
* @param string $string
*
* @return void
*/
function setOnResize( $string )
{ $this->onresize = $string; }
/**
* Sets the body's background-attribute of this document.
*
* @access public
* @version 1.0
* @since 0.1.0
*
* @param string $string
*
* @return void
*/
function setBackground( $string )
{ $this->background = $string; }
/**
* Sets the behaviour of body's formatting. If noformat is set to true then
* the body will not be formatted by the plaintextformatter. Look at package
* CLASSPATH."core" at the class PlainTextFormatter for further information.
*
* @access public
* @version 1.0
* @since 0.1.0
*
* @param boolean $boolean
*
* @return void
*/
function setNoFormat( $boolean = true )
{ $this->noformat = $boolean; }
/**
* Returns the current title of this document.
*
* @access public
* @version 1.0
* @since 0.1.0
*
* @return string
*/
function getTitle()
{ return $this->title; }
/**
* Returns the current head's content of this document.
*
* @access public
* @version 1.0
* @since 0.1.0
*
* @return string
*/
function getHead()
{ return $this->head; }
/**
* Returns the current body's content of this document.
*
* @access public
* @version 1.0
* @since 0.1.0
*
* @return string
*/
function getBody()
{ return $this->body; }
/**
* Returns the current document's mode (standard or quirk).
*
* @access public
* @version 1.0
* @since 0.2.21
*
* @return integer
*/
function getMode()
{ return $this->mode; }
/**
* Returns the current body's text-attribute of this document.
*
* @access public
* @version 1.0
* @since 0.1.0
*
* @return string
*/
function getText()
{ return $this->text; }
/**
* Returns the current body's bgcolor-attribute of this document.
*
* @access public
* @version 1.0
* @since 0.1.0
*
* @return string
*/
function getBGColor()
{ return $this->bgcolor; }
/**
* Returns the current body's leftmargin-attribute of this document.
*
* @access public
* @version 1.0
* @since 0.1.0
*
* @return string
*/
function getLeftMargin()
{ return $this->leftmargin; }
/**
* Returns the current body's topmargin-attribute of this document.
*
* @access public
* @version 1.0
* @since 0.1.0
*
* @return string
*/
function getTopMargin()
{ return $this->topmargin; }
/**
* Returns the current body's marginwidth-attribute of this document.
*
* @access public
* @version 1.0
* @since 0.1.0
*
* @return string
*/
function getMarginWidth()
{ return $this->marginwidth; }
/**
* Returns the current body's marginheight text-attribute of this document.
*
* @access public
* @version 1.0
* @since 0.1.0
*
* @return string
*/
function getMarginHeight()
{ return $this->marginheight; }
/**
* Returns the current body's onload-attribute of this document.
*
* @access public
* @version 1.0
* @since 0.1.0
*
* @return string
*/
function getOnLoad()
{ return $this->onload; }
/**
* Returns the body's onblur-attribute of this document.
*
* @access public
* @version 1.0
* @since 0.1.0
*
* @return string
*/
function getOnBlur()
{ return $this->onblur; }
/**
* Returns the body's onscroll-attribute of this document.
*
* @access public
* @version 1.0
* @since 0.1.0
*
* @return string
*/
function getOnScroll()
{ return $this->onscroll; }
/**
* Returns the body's onresize-attribute of this document.
*
* @access public
* @version 1.0
* @since 0.1.0
*
* @return string
*/
function getOnResize()
{ return $this->onresize; }
/**
* Returns the body's background-attribute of this document.
*
* @access public
* @version 1.0
* @since 0.1.0
*
* @return string
*/
function getBackground()
{ return $this->background; }
/*
* Adds a formitem?????????
*
* @todo comment this function it could be somthing todo with php-generator
*
* @version 1.0
* @author Daniel Plücken <daniel@debakel.net>
* @access public??????????
*
* @return string
*/
/*
function addItem( &$item_ref )
{
if( get_class( $item_ref ) == "htmltable" )
$this->doctables[] =& $item_ref;
else
if(
get_class( $item_ref ) == "htmlform"
|| get_class( $item_ref ) == "dbtfillingform"
|| get_class( $item_ref ) == "contactform"
)
$this->docforms[] =& $item_ref;
else
$this->docitems[] =& $item_ref;
} */
/**
* Generates the sourcecode to build this object and returns it.
*
* @access public
* @version 1.01
* @since 0.1.0
*
* @return string
*/
function getPHPSource()
{
$outputstr = "\x24body = \"".$this->body."\";\n";
for( $i = 0; $i < count( $this->docitems ); $i++ )
$outputstr .= $this->docitems[$i]->getPHPSource()."\n\n";
// newline after items
$outputstr .= "\n";
for( $i = 0; $i < count( $this->doctables ); $i++ )
$outputstr .= $this->doctables[$i]->getPHPSource()."\n\n";
// newline after tables
$outputstr .= "\n";
for( $i = 0; $i < count( $this->docforms ); $i++ )
$outputstr .= $this->docforms[$i]->getPHPSource()."\n\n";
// newline after Forms
$outputstr .= "\n";
// DIES MUSS NOCH GEAENDERT WERDERN !!!
$outputstr .= "\x24body = \x24form->get();\n";
$outputstr .= "\x24doc = new HTMLDocument(\n"
." \"".$this->getTitle()."\",\n"
." \x24head,\n"
." \x24body \n"
." );\n\n";
$outputstr .= !empty( $this->text )
? "\x24doc->setText( \"".$this->getText()."\" );\n"
: "";
$outputstr .= !empty( $this->bgcolor )
? "\x24doc->setBGColor( \"".$this->getBGColor()."\" );\n"
: "";
$outputstr .= isset( $this->leftmargin )
? "\x24doc->setLeftMargin( ".$this->getLeftMargin()." );\n"
: "";
$outputstr .= isset( $this->topmargin )
? "\x24doc->setTopMargin( ".$this->getTopMargin()." );\n"
: "";
$outputstr .= isset( $this->marginwidth )
? "\x24doc->setMarginWidth( ".$this->getMarginWidth()." );\n"
: "";
$outputstr .= isset( $this->marginheight )
? "\x24doc->setMarginHeight( ".$this->getMarginHeight()." );\n"
: "";
$outputstr .= !empty( $this->onload )
? "\x24doc->setOnLoad( \"".$this->getOnLoad()."\" );\n"
: "";
$outputstr .= !empty( $this->onscroll )
? "\x24doc->setOnScroll( \"".$this->getOnScroll()."\" );\n"
: "";
$outputstr .= !empty( $this->onresize )
? "\x24doc->setOnScroll( \"".$this->getOnResize()."\" );\n"
: "";
$outputstr .= !empty( $this->background )
? "\x24doc->setBackground( \"".$this->getBackground()."\" );\n"
: "";
$outputstr .= "echo \x24doc->get();\n";
return $outputstr;
}
/**
* Returns a generated string based on the attributes of this HTML-Object.
*
* @access public
* @version 1.31
* @since 0.1.0
*
* @return string
*/
function get()
{
////////////////////////
// DOCTYPE declaration
if ( $this->include_doctype )
{
$definition_url = "";
$definition_domain = "http://www.w3.org/";
if( strtolower( $this->doctype ) == "html" )
if(
$this->version == 1.1
&& strtoupper( $this->contenttype ) == "XHTML"
)
$definition_url = $definition_domain."TR/xhtml11/DTD/xhtml11.dtd";
else
if ( $this->mode == HTML_STANDARD_MODE )
switch( strtoupper( $this->behaviour ) )
{
case "STRICT":
if( strtoupper( $this->contenttype ) == "HTML" )
$definition_url = $definition_domain."TR/html4/strict.dtd";
else
if( strtoupper( $this->contenttype ) == "XHTML" )
$definition_url = $definition_domain
."TR/xhtml1/DTD/xhtml1-strict.dtd";
break;
case "TRANSITIONAL":
if( strtoupper( $this->contenttype ) == "HTML" )
$definition_url = $definition_domain."TR/html4/loose.dtd";
else
if( strtoupper( $this->contenttype ) == "XHTML" )
$definition_url = $definition_domain
."TR/xhtml1/DTD/xhtml1-transitional.dtd";
break;
case "FRAMESET":
if( strtoupper( $this->contenttype ) == "HTML" )
$definition_url = $definition_domain
."TR/html4/frameset.dtd";
else
if( strtoupper( $this->contenttype ) == "XHTML" )
$definition_url = $definition_domain
."TR/xhtml1/DTD/xhtml1-frameset.dtd";
break;
default:
break;
}
$out = "<!DOCTYPE ".strtolower( $this->doctype )." "
."PUBLIC \"-//W3C//DTD ".strtoupper( $this->contenttype )." "
.$this->version
.(
strtoupper( $this->behaviour != "STRICT" )
|| $this->version != 4.0
|| $this->contenttype != "HTML"
? " ".ucfirst( strtolower( $this->behaviour ) )
: ""
)."//EN\""
.(
!empty( $definition_url )
? " \"".$definition_url."\""
: ""
).">\r\n";
}
// DOCTYPE declaration /
////////////////////////
$out .= "<html>\r\n";
$out .= " <head>\r\n";
$out .= " <title>".$this->title."</title>\r\n";
$out .= " <meta http-equiv=\"content-type\" "
."content=\"text/html; charset="
.$this->meta["charset"]."\">\r\n";
$out .= PlainTextFormatter::indentText( $this->head, 2 );
if( is_array( $GLOBALS["javascript_content"] ) )
{
$js = new JavaScript();
foreach( $GLOBALS["javascript_content"] as $str_tmp )
$js->add( $str_tmp );
$out .= $js->get();
}
$out .= " </head>\r\n\r\n";
if( strtoupper( $this->behaviour ) != "FRAMESET" )
$out .= " <body"
.( !empty( $this->id )
? " id=\"".$this->id."\""
: " id=\"".preg_replace(
"!^.*?([^/.]+)[^/]*$!",
"$1", $_SERVER["SCRIPT_NAME"]
)."\""
)
.( !empty( $this->text )
? " text=\"".$this->text."\""
: ""
)
.( !empty( $this->bgcolor )
? " bgcolor=\"".$this->bgcolor."\""
: ""
)
.( !empty( $this->onload )
? " onLoad=\"".$this->onload."\""
: ""
)
.( !empty( $this->onblur )
? " onBlur=\"".$this->onblur."\""
: ""
)
.( !empty( $this->onscroll )
? " onScroll=\"".$this->onscroll."\""
: ""
)
.( !empty( $this->onresize )
? " onResize=\"".$this->onresize."\""
: ""
)
.( ( $this->leftmargin != "" )
? " leftmargin=\"".$this->leftmargin."\""
: ""
)
.( ( $this->topmargin != "" )
? " topmargin=\"".$this->topmargin."\""
: ""
)
.( ( $this->marginwidth != "" )
? " marginwidth=\"".$this->marginwidth."\""
: ""
)
.( ( $this->marginheight != "" )
? " marginheight=\"".$this->marginheight."\""
: ""
)
.( ( $this->background != "" )
? " background=\"".$this->background."\""
: ""
)
.">";
if( $this->noformat )
$out .= $this->body.(
strtoupper( $this->behaviour ) != "FRAMESET"
? "</body>\r\n" : ""
);
else
$out .= "\r\n".PlainTextFormatter::indentText( $this->body, 2 )
.(
strtoupper( $this->behaviour ) != "FRAMESET"
? " </body>\r\n" : ""
);
$out .= PlainTextFormatter::indentText( $this->behindbody, 2 );
$out .= "</html>";
return $out;
}
} // END of class HTMLDocument
?>

Source for file HTMLDocument.class.php