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


Classes:
HTML_Page2
Files:
Doctypes.php
Frame.php
Frameset.php
Namespaces.php
Page2.php
Page2_Complex.php
Page2_Frameset.php
Page2_NoDoctype.php
Page2_Simple.php

Class: HTML_Page2

Source Location: /HTML_Page2-0.6.4/HTML/Page2.php

Class Overview

HTML_Common
   |
   --HTML_Page2

(X)HTML Page generation class


Author(s):

Version:

  • Release: 2.0.0

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

[line 221]
(X)HTML Page generation class

This class handles the details for creating a properly constructed XHTML page. Page caching, stylesheets, client side script, and Meta tags can be managed using this class.

The body may be a string, object, or array of objects or strings. Objects with toHtml() and toString() methods are supported.

XHTML Examples:

Simplest example:

  1.  // the default doctype is XHTML 1.0 Transitional
    2. 

  2.  // All doctypes and defaults are set in HTML/Page/Doctypes.php
    3. 

  3.  $p = new HTML_Page2();
    4. 

  4.  
    5. 

  5.  //add some content
    6. 

  6.  $p->addBodyContent("<p>some text</p>");
    7. 

  7.  
    8. 

  8.  // print to browser
    9. 

  9.  $p->display();
    10. 

  10.  ?>
    11.
Complex XHTML example:

  1.  <?php
    2. 

  2.  // The array takes an array of attributes that determine many important
    3. 

  3.  // aspects of the page generations.
    4. 

  4.  
    5. 

  5.  // Possible attributes are: charset, mime, lineend, tab, doctype, namespace,
    6. 

  6.  // language and cache
    7. 

  7.  
    8. 

  8.  $p = new HTML_Page2(array (
    9. 

  9.  
    10. 

  10.                 // Sets the charset encoding (default: utf-8)
    11. 

  11.                 'charset'  => 'utf-8',
    12. 

  12.  
    13. 

  13.                 // Sets the line end character (default: unix (\n))
    14. 

  14.                 'lineend'  => 'unix',
    15. 

  15.  
    16. 

  16.                 // Sets the tab string for autoindent (default: tab (\t))
    17. 

  17.                 'tab'  => '  ',
    18. 

  18.  
    19. 

  19.                 // This is where you define the doctype
    20. 

  20.                 'doctype'  => "XHTML 1.0 Strict",
    21. 

  21.  
    22. 

  22.                 // Global page language setting
    23. 

  23.                 'language' => 'en',
    24. 

  24.  
    25. 

  25.                 // If cache is set to true, the browser may cache the output.
    26. 

  26.                 'cache'    => 'false'
    27. 

  27.                 ));
    28. 

  28.  
    29. 

  29.  // Here we go
    30. 

  30.  
    31. 

  31.  // Set the page title
    32. 

  32.  $p->setTitle("My page");
    33. 

  33.  
    34. 

  34.  // Add optional meta data
    35. 

  35.  $p->setMetaData("author", "My Name");
    36. 

  36.  
    37. 

  37.  // Put something into the body
    38. 

  38.  $p->addBodyContent("<p>some text</p>");
    39. 

  39.  
    40. 

  40.  // If at some point you want to clear the page content
    41. 

  41.  // and output an error message, you can easily do that
    42. 

  42.  // See the source for <a href="../HTML_Page2/HTML_Page2.html#methodtoHtml">toHtml</a> and _getDoctype
    43. 

  43.  // for more details
    44. 

  44.  if ($error) {
    45. 

  45.      $p->setTitle("Error!");
    46. 

  46.      $p->setBody("<p>Houston, we have a problem: $error</p>");
    47. 

  47.      $p->display();
    48. 

  48.      die;
    49. 

  49.  } // end error handling
    50. 

  50.  
    51. 

  51.  // print to browser
    52. 

  52.  $p->display();
    53. 

  53.  // output to file
    54. 

  54.  $p->toFile('example.html');
    55. 

  55.  ?>
    56.
Simple XHTML declaration example: 
  1.  <?php
    2. 

  2.  $p = new HTML_Page2();
    3. 

  3.  // An XHTML compliant page (with title) is automatically generated
    4. 

  4.  
    5. 

  5.  // This overrides the XHTML 1.0 Transitional default
    6. 

  6.  $p->setDoctype('XHTML 1.0 Strict');
    7. 

  7.  
    8. 

  8.  // Put some content in here
    9. 

  9.  $p->addBodyContent("<p>some text</p>");
    10. 

  10.  
    11. 

  11.  // print to browser
    12. 

  12.  $p->display();
    13. 

  13.  ?>
    14.
HTML examples:

HTML 4.01 example:

  1.  <?php
    2. 

  2.  $p = new HTML_Page2('doctype="HTML 4.01 Strict"');
    3. 

  3.  $p->addBodyContent = "<p>some text</p>";
    4. 

  4.  $p->display();
    5. 

  5.  ?>
    6.
nuke doctype declaration:

  1.  <?php
    2. 

  2.  $p = new HTML_Page2('doctype="none"');
    3. 

  3.  $p->addBodyContent = "<p>some text</p>";
    4. 

  4.  $p->display();
    5. 

  5.  ?>
    6.



[ Top ]

Class Variables

$frameset =

[line 390]

Contains an instance of {@see HTML_Page2_Frameset}
  • Since: 2.0
  • Access: public

Type:   object


[ Top ]


Method Detail

HTML_Page2 (Constructor)   [line 438]

void HTML_Page2( [mixed $attributes = array()])

Class constructor.

Accepts an array of attributes

General options:

  • "lineend" => "unix|win|mac" (Sets line ending style; defaults to unix.) See also setLineEnd.
  • "tab" => string (Sets line ending style; defaults to \t.) See also setTab.
  • "cache" => "false|true" See also setCache.
  • "charset" => charset string (Sets charset encoding; defaults to utf-8) See also setCharset and getCharset.
  • "mime" => mime encoding string (Sets document mime type; defaults to text/html) See also setMimeEncoding.
XHTML specific options:

  • "doctype" => string (Sets XHTML doctype; defaults to XHTML 1.0 Transitional.) See also setDoctype.
  • "language" => two letter language designation. (Defines global document language; defaults to "en".) See also setLang.
  • "namespace" => string (Sets document namespace; defaults to the W3C defined namespace.) See also setNamespace.
  • "profile" => string (Sets head section profile) See also setHeadProfile.
  • "prolog" => bool (Enables or disables the XML prolog. This is usually unwanted, as it makes the page invalid XHTML.) See also disableXmlProlog and enableXmlProlog.
For extensive usage examples, see class-level documentation ({@see HTML_Page2}).

  • Since: 2.0
  • Access: public

Parameters:

mixed   $attributes   —  Associative array of table tag attributes

[ Top ]

addBodyContent   [line 1000]

void addBodyContent( mixed $content, [int $flag = HTML_PAGE2_APPEND])

Sets the content of the <body> tag

It is possible to add objects, strings or an array of strings and/or objects. Objects must have a toHtml or toString method.

By default, if content already exists, the new content is appended. If you wish to overwrite whatever is in the body, use setBody; unsetBody completely empties the body without inserting new content. You can also use prependBodyContent to prepend content to whatever is currently in the array of body elements.

The following constants are defined to be passed as the flag attribute: HTML_PAGE2_APPEND, HTML_PAGE2_PREPEND and HTML_PAGE2_REPLACE. Their usage should be quite clear from their names.

  • Access: public

Parameters:

mixed   $content   —  New <body> tag content (may be passed as a reference)
int   $flag   —  Whether to prepend, append or replace the content.

[ Top ]

addFavicon   [line 1092]

void addFavicon( string $href, [string $type = 'image/x-icon'], [string $relation = 'shortcut icon'])

Adds a shortcut icon (favicon)

This adds a link to the icon shown in the favorites list or on the left of the url in the address bar. Some browsers display it on the tab, as well.

  • Access: public

Parameters:

string   $href   —  The link that is being related.
string   $type   —  File type
string   $relation   —  Relation of link

[ Top ]

addHeadLink   [line 1113]

void addHeadLink( string $href, string $relation, [string $relType = 'rel'], [array $attributes = array()])

Adds <link> tags to the head of the document

$relType defaults to 'rel' as it is the most common relation type used. ('rev' refers to reverse relation, 'rel' indicates normal, forward relation.) Typical tag: <link href="index.php" rel="Start">

  • Access: public

Parameters:

string   $href   —  The link that is being related.
string   $relation   —  Relation of link.
string   $relType   —  Relation type attribute. Either rel or rev (default: 'rel').
array   $attributes   —  Associative array of remaining attributes.

[ Top ]

addRawHeaderData   [line 1827]

void addRawHeaderData( string $content)

Adds raw data to the head of the document

Use this function to add raw data strings to the header.

  • Access: public

Parameters:

string   $content   —  Raw data to be added.

[ Top ]

addScript   [line 1023]

void addScript( string $url, [string $type = "text/javascript"])

Adds a linked script to the page
  • Access: public

Parameters:

string   $url   —  URL to the linked script
string   $type   —  Type of script. Defaults to 'text/javascript'

[ Top ]

addScriptDeclaration   [line 1040]

void addScriptDeclaration( mixed $content, [string $type = 'text/javascript'])

Adds a script to the page

Content can be a string or an object with a toString method. Defaults to text/javascript.

  • Access: public

Parameters:

mixed   $content   —  Script (may be passed as a reference)
string   $type   —  Scripting mime (defaults to 'text/javascript')

[ Top ]

addStyleDeclaration   [line 1073]

void addStyleDeclaration( mixed $content, [string $type = 'text/css'])

Adds a stylesheet declaration to the page

Content can be a string or an object with a toString method. Defaults to text/css.

  • Access: public

Parameters:

mixed   $content   —  Style declarations (may be passed as a reference)
string   $type   —  Type of stylesheet (defaults to 'text/css')

[ Top ]

addStyleSheet   [line 1055]

void addStyleSheet( string $url, [string $type = 'text/css'], [string $media = null])

Adds a linked stylesheet to the page
  • Access: public

Parameters:

string   $url   —  URL to the linked style sheet
string   $type   —  Mime encoding type
string   $media   —  Media type that this stylesheet applies to

[ Top ]

apiVersion   [line 1127]

double apiVersion( )

Returns the current API version
  • Access: public

[ Top ]

disableXmlProlog   [line 1166]

void disableXmlProlog( )

Disables prepending the XML prolog for XHTML documents

Normally, XHTML documents require the XML prolog to be on the first line of each valid document:

  1.  <?xml version="1.0" encoding="utf-8"?>
    2. 

  2.  <!DOCTYPE html
    3. 

  3.      PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
    4. 

  4.      "http://www.w3c.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
    5. 

  5.  
    6. 

  6.  <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
    7. 

  7.  <head>
    8. 

  8.  ...
    9.
However, some browsers, most noticeably Microsoft Internet Explorer, have difficulties properly displaying XHTML in compatibility mode with this. This method is for workaround solutions, such as the infamous CSS Box Hack.

The opposite (and default) effect can be achieved using the enableXmlProlog method.

Usage:

  1.  $page->disableXmlProlog();
    2.

  • Access: public

[ Top ]

display   [line 1793]

void display( )

Outputs the HTML content to the browser

This method outputs to the default display device. Normally that will be the browser.

If caching is turned off, which is the default case, this generates the appropriate headers:

  1.  header("Expires: Tue, 1 Jan 1980 12:00:00 GMT");
    2. 

  2.  header("Last-Modified: " . gmdate("D, d M Y H:i:s") . " GMT");
    3. 

  3.  header("Cache-Control: no-cache");
    4. 

  4.  header("Pragma: no-cache");
    5.
This functionality can be disabled:

  1.  $page->setCache('true');
    2.

  • Access: public

[ Top ]

enableXmlProlog   [line 1188]

void enableXmlProlog( )

Enables prepending the XML prolog for XHTML documents (default)

This method enables the default XHTML output, with an XML prolog on the first line of the document. See disableXmlProlog for more details on why it may or may not be advantageous to have the XML prolog disabled.

Usage:

  1.  $page->enableXmlProlog();
    2.

  • Access: public

[ Top ]

getBodyContent   [line 1838]

string getBodyContent( )

Get/Return the Body Content.
  • Access: public

[ Top ]

getCharset   [line 1199]

string getCharset( )

Returns the document charset encoding.
  • Access: public

[ Top ]

getDoctypeString   [line 1210]

string getDoctypeString( )

Returns the document type string
  • Access: public

[ Top ]

getLang   [line 1226]

string getLang( )

Returns the document language.
  • Access: public

[ Top ]

getTitle   [line 1237]

string getTitle( )

Return the title of the page.
  • Access: public

[ Top ]

prependBodyContent   [line 1265]

void prependBodyContent( mixed $content)

Prepends content to the content of the <body> tag. Wrapper for addBodyContent

If you wish to overwrite whatever is in the body, use setBody; addBodyContent provides full functionality including appending; unsetBody completely empties the body without inserting new content. It is possible to add objects, strings or an array of strings and/or objects Objects must have a toString method.

  • Access: public

Parameters:

mixed   $content   —  New <body> tag content (may be passed as a reference)

[ Top ]

setBody   [line 1288]

void setBody( mixed $content)

Sets the content of the <body> tag.

If content exists, it is overwritten. If you wish to use a "safe" version, use addBodyContent. Objects must have a toString method.

This function acts as a wrapper for addBodyContent. If you are using PHP 4.x and would like to pass an object by reference, this is not the function to use. Use addBodyContent with the flag HTML_PAGE2_REPLACE instead.

  • Access: public

Parameters:

mixed   $content   —  New <body> tag content. May be an object or passed as a reference.

[ Top ]

setBodyAttributes   [line 1317]

void setBodyAttributes( array $attributes)

Sets the attributes of the <body> tag

If attributes exist, they are overwritten. In XHTML, all attribute names must be lowercase. As lowercase attributes are legal in SGML, all attributes are automatically lowercased. This also prevents accidentally creating duplicate attributes when attempting to update one.

  • Access: public

Parameters:

array   $attributes   —  <body> tag attributes.

[ Top ]

setCache   [line 1337]

void setCache( [string $cache = 'false'])

Defines if the document should be cached by the browser

Defaults to false.

A fully configurable cache header is in the works. for now, though if you would like to determine exactly what caching headers are sent to to the browser, set cache to true, and then output your own headers before calling display.

  • Access: public

Parameters:

string   $cache   —  Options are currently 'true' or 'false'

[ Top ]

setCharset   [line 1363]

void setCharset( [string $type = 'utf-8'])

Sets the document charset

By default, HTML_Page2 uses UTF-8 encoding. This is properly handled by PHP, but remember to use the htmlentities attribute for charset so that whatever you get from a database is properly handled by the browser.

The current most popular encoding: iso-8859-1. If it is used, htmlentities and htmlspecialchars can be used without any special settings.

  • Access: public

Parameters:

string   $type   —  Charset encoding string

[ Top ]

setDoctype   [line 1385]

void setDoctype( [string $type = "XHTML 1.0 Transitional"])

Sets or alters the !DOCTYPE declaration.

Can be set to "strict", "transitional" or "frameset". Defaults to "XHTML 1.0 Transitional".

This must come after declaring the character encoding with setCharset or directly when the class is initiated HTML_Page2. Use in conjunction with setMimeEncoding

Framesets are not yet implemented.

  • Access: public

Parameters:

string   $type   —  String containing a document type

[ Top ]

setHeadProfile   [line 1417]

void setHeadProfile( [string $profile = ''])

Sets the <head> profile

Profiles allow for adding various uncommented links, etc. to the head section. For more details, see the W3C documents (http://www.w3.org/TR/html4/struct/global.html#h-7.4.4.3 and http://www.w3.org/TR/html401/types.html#type-links) detailing proper use.

  • Access: public

Parameters:

string   $profile   —  URL to profile

[ Top ]

setLang   [line 1430]

void setLang( [string $lang = "en"])

Sets the global document language declaration. Default is English.
  • Access: public

Parameters:

string   $lang   —  Two-letter language designation

[ Top ]

setMetaContentType   [line 1482]

void setMetaContentType( )

Sets an http-equiv Content-Type meta tag
  • Access: public

[ Top ]

setMetaData   [line 1445]

void setMetaData( string $name, string $content, [bool $http_equiv = false])

Sets or alters a meta tag.
  • Access: public

Parameters:

string   $name   —  Value of name or http-equiv tag
string   $content   —  Value of the content tag
bool   $http_equiv   —  META type "http-equiv" defaults to null

[ Top ]

setMetaRefresh   [line 1503]

void setMetaRefresh( int $time, [string $url = 'self'], [bool $https = false])

Shortcut to set or alter a refresh meta tag

If no $url is passed, "self" is presupposed, and the appropriate URL will be automatically generated. In this case, an optional third boolean parameter enables https redirects to self.

  • Access: public

Parameters:

int   $time   —  Time till refresh (in seconds)
string   $url   —  Absolute URL or "self"
bool   $https   —  If $url == self, then set protocol to https://

[ Top ]

setMimeEncoding   [line 1557]

void setMimeEncoding( [string $type = 'text/html'])

Sets the document MIME encoding that is sent to the browser.

This usually will be text/html because most browsers cannot yet accept the proper mime settings for XHTML: application/xhtml+xml and to a lesser extent application/xml and text/xml. See the W3C note (http://www.w3.org/TR/xhtml-media-types/) for more details.

Here is a possible way of automatically including the proper mime type for XHTML 1.0 if the requesting browser supports it:

  1.  <?php
    2. 

  2.  // Initialize the HTML_Page2 object:
    3. 

  3.  require 'HTML/Page2.php';
    4. 

  4.  $page = new HTML_Page2();
    5. 

  5.  
    6. 

  6.  // Check if browse can take the proper mime type
    7. 

  7.  if ( strpos($_SERVER['HTTP_ACCEPT'], 'application/xhtml+xml') ) {
    8. 

  8.      $page->setDoctype('XHTML 1.0 Strict');
    9. 

  9.      $page->setMimeEncoding('application/xhtml+xml');
    10. 

  10.  } else {
    11. 

  11.      // HTML that qualifies for XHTML 1.0 Strict automatically
    12. 

  12.      // also complies with XHTML 1.0 Transitional, so if the
    13. 

  13.      // requesting browser doesn't take the necessary mime type
    14. 

  14.      // for XHTML 1.0 Strict, let's give it what it can take.
    15. 

  15.      $page->setDoctype('XHTML 1.0 Transitional');
    16. 

  16.  }
    17. 

  17.  
    18. 

  18.  // finish building your page here..
    19. 

  19.  
    20. 

  20.  $page->display();
    21. 

  21.  ?>
    22.

  • Access: public

Parameters:

string   $type   —  Optional. Defaults to 'text/html'

[ Top ]

setNamespace   [line 1584]

void setNamespace( [string $namespace = ''])

Sets the document namespace

By default, W3C namespaces are used. However, if you need to define your own namespace, you can set it here.

Usage:

  1.  // This is how you can set your own namespace:
    2. 

  2.  $page->setNamespace('http://www.w3.org/1999/xhtml');
    3. 

  3.  
    4. 

  4.  // This reverts to default setting and retrieves the appropriate
    5. 

  5.  // W3C namespace for the document type:
    6. 

  6.  $page->setNamespace();
    7.

  • Access: public

Parameters:

string   $namespace   —  Optional. W3C namespaces are used by default.

[ Top ]

setTitle   [line 1607]

void setTitle( string $title)

Sets the title of the page

Usage:

  1.  $page->setTitle('My Page');
    2.

  • Access: public

Parameters:

string   $title   —  Title of the page

[ Top ]

toFile   [line 1748]

void toFile( string $filename)

Generates the document and outputs it to a file.

Uses http://www.php.net/file_put_contents when available. Includes a workaround for older versions of PHP.

Usage example:

  1.  <?php
    2. 

  2.  require "HTML/Page2.php";
    3. 

  3.  $page = new HTML_Page2();
    4. 

  4.  $page->setTitle('My Page');
    5. 

  5.  $page->addBodyContent('<h1>My Page</h1>');
    6. 

  6.  $page->addBodyContent('<p>First Paragraph.</p>');
    7. 

  7.  $page->addBodyContent('<p>Second Paragraph.</p>');
    8. 

  8.  $page->toFile('myPage.html');
    9. 

  9.  ?>
    10.

  • Since: 2.0
  • Access: public

Parameters:

string   $filename   —  Filename to output document to.

[ Top ]

toHtml   [line 1636]

string toHtml( )

Generates and returns the complete page as a string

This is what you would call if you want to save the page in a database. It creates a complete, valid HTML document, and returns it as a string.

Usage example:

  1.  <?php
    2. 

  2.  require "HTML/Page2.php";
    3. 

  3.  $page = new HTML_Page2();
    4. 

  4.  $page->setTitle('My Page');
    5. 

  5.  $page->addBodyContent('<h1>My Page</h1>');
    6. 

  6.  $page->addBodyContent('<p>First Paragraph.</p>');
    7. 

  7.  $page->addBodyContent('<p>Second Paragraph.</p>');
    8. 

  8.  $html = $page->toHtml();
    9. 

  9.  // here you insert HTML into a database
    10. 

  10.  ?>
    11.

  • Access: public

[ Top ]

unsetBody   [line 1299]

void unsetBody( )

Unsets the content of the <body> tag.
  • Access: public

[ Top ]

unsetMetaData   [line 1467]

void unsetMetaData( string $name, [bool $http_equiv = false])

Unsets a meta tag.
  • Access: public

Parameters:

string   $name   —  Value of name or http-equiv tag
bool   $http_equiv   —  META type "http-equiv" defaults to null

[ Top ]

_elementToHtml   [line 509]

string _elementToHtml( &$element, mixed $element)

Iterates through an array, returning an HTML string

It also handles objects, calling the toHTML or toString methods and propagating the line endings and tabs for objects that extend HTML_Common.

For more details read the well-documented source.

  • Access: protected

Parameters:

mixed   $element   —  The element to be processed
   &$element   — 

[ Top ]
Documentation generated on Mon, 11 Mar 2019 16:03:54 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.