PHPXRef 0.7.1 : Joomla 1.5.26 DE : Detail view of document.php

Document class, provides an easy interface to parse and display a document

Class constructor

param: array $options Associative array of options

getInstance($type = 'html', $attributes = array() X-Ref

Returns a reference to the global JDocument object, only creating it
if it doesn't already exist.

This method must be invoked as:
<pre> $document = &JDocument::getInstance();</pre>

param: type $type The document type to instantiate
return: object The document object.

setType($type) X-Ref

Set the document type

param: string $type

getType() X-Ref

Returns the document type

return: string

getHeadData() X-Ref

Get the document head data

return: array The document head data in array form

setHeadData($data) X-Ref

Set the document head data

param: array $data The document head data in array form

getBuffer() X-Ref

Get the contents of the document buffer

return: The contents of the document buffer

setBuffer($content) X-Ref

Set the contents of the document buffer

param: string $content The content to be set in the buffer

getMetaData($name, $http_equiv = false) X-Ref

Gets a meta tag.

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

setMetaData($name, $content, $http_equiv = false) X-Ref

Sets or alters a meta tag.

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

addScript($url, $type="text/javascript") X-Ref

Adds a linked script to the page

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

addScriptDeclaration($content, $type = 'text/javascript') X-Ref

Adds a script to the page

param: string $content Script
param: string $type Scripting mime (defaults to 'text/javascript')
return: void

addStyleSheet($url, $type = 'text/css', $media = null, $attribs = array() X-Ref

Adds a linked stylesheet to the page

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

addStyleDeclaration($content, $type = 'text/css') X-Ref

Adds a stylesheet declaration to the page

param: string $content Style declarations
param: string $type Type of stylesheet (defaults to 'text/css')
return: void

setCharset($type = 'utf-8') X-Ref

Sets the document charset

param: string $type Charset encoding string
return: void

getCharset() X-Ref

Returns the document charset encoding.

return: string

setLanguage($lang = "en-gb") X-Ref

Sets the global document language declaration. Default is English (en-gb).

param: string $lang

getLanguage() X-Ref

Returns the document language.

return: string

setDirection($dir = "ltr") X-Ref

Sets the global document direction declaration. Default is left-to-right (ltr).

param: string $lang

getDirection() X-Ref

Returns the document language.

return: string

setTitle($title) X-Ref

Sets the title of the document

param: string $title

getTitle() X-Ref

Return the title of the document.

return: string

setBase($base) X-Ref

Sets the base URI of the document

param: string $base

getBase() X-Ref

Return the base URI of the document.

return: string

setDescription($description) X-Ref

Sets the description of the document

param: string $title

getDescription() X-Ref

Return the title of the page.

return: string

setLink($url) X-Ref

Sets the document link

param: string $url A url
return: void

getLink() X-Ref

Returns the document base url

return: string

setGenerator($generator) X-Ref

Sets the document generator

param: string
return: void

getGenerator() X-Ref

Returns the document generator

return: string

setModifiedDate($date) X-Ref

Sets the document modified date

param: string
return: void

getModifiedDate() X-Ref

Returns the document modified date

return: string

setMimeEncoding($type = 'text/html') X-Ref

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

<p>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
({@link http://www.w3.org/TR/xhtml-media-types/
http://www.w3.org/TR/xhtml-media-types/}) for more details.</p>

param: string $type
return: void

setLineEnd($style) X-Ref

Sets the line end style to Windows, Mac, Unix or a custom string.

param: string $style "win", "mac", "unix" or custom string.
return: void

_getLineEnd() X-Ref

Returns the lineEnd

return: string

setTab($string) X-Ref

Sets the string used to indent HTML

param: string $string String used to indent ("\11", "\t", ' ', etc.).
return: void

_getTab() X-Ref

Returns a string containing the unit for indenting HTML

return: string

loadRenderer( $type ) X-Ref

Load a renderer

param: string The renderer type
return: object

render( $cache = false, $params = array() X-Ref

Outputs the document

param: boolean     $cache        If true, cache the output
param: boolean     $compress    If true, compress the output
param: array        $params        Associative array of attributes
return: The rendered data

Copyright:	Copyright (C) 2005 - 2010 Open Source Matters. All rights reserved.
License:	GNU/GPL, see LICENSE.php
Version:	$Id: document.php 14401 2010-01-26 14:10:00Z louis $
File Size:	782 lines (15 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

PHP Cross Reference of Joomla 1.5.26 DE

/libraries/joomla/document/ -> document.php (summary)

Defines 1 class