Class CMS3_StandartOutputHandler

Description

class CMS3_StandartOutputHandler, a very simple OutputHandler; no configuration available only static template and sitemap.

Located in /lib/StandartOutputHandler/CMS3_StandartOutputHandler.php (line 32)

CMS3_StandartOutputHandler_OutputHandler
   |
   --CMS3_StandartOutputHandler
Variable Summary
 mixed $Body
 mixed $BodyList
 mixed $Header
 mixed $Identifier
 mixed $IsDisabled
 mixed $Owner
 mixed $Title
Method Summary
 void Disable ()
 void ExtentHeader (string $line)
 string GetContent ()
 string GetHeader ()
 string GetIdentifier ()
 string GetPluginID ()
 void Parse ()
 string ParseEmbedments (string $Content)
 void ParseLinkEntry ( $Entry)
 void PrintError (string $msg, int $code)
 void Register (CMS3_System &$Owner)
 void SetBody (string $body, [array $List = null])
 void SetIdentifier ([string $Identifier = ""])
 void SetTitle (string $title)
Variables
mixed $Body = "" (line 42)
  • access: protected
mixed $BodyList = null (line 43)
  • access: protected
mixed $Header = "" (line 44)
  • access: protected
mixed $Identifier = "" (line 47)
  • access: protected
mixed $IsDisabled = false (line 41)

* Attributes: **

  • access: protected
mixed $Owner = null (line 46)
  • access: protected
mixed $Title = "Untitled" (line 45)
  • access: protected
Methods
Disable (line 227)

Diable the OutputHandler, do this if you wish to print binary data.

  • access: public
void Disable ()
ExtentHeader (line 92)

Data provided by use of this method may be left out if the OutputHandler wishes to print something else the HTML, therefor don't add important information here.

  • access: public
void ExtentHeader (string $line)
  • string $line: line A line you wish to add to the header.
GetContent (line 196)

Gets content ready to be printed

This does not include header, only the body content.

  • return: Content ready for print
  • access: public
string GetContent ()
GetHeader (line 216)

Gets the header extension

  • return: Lines to be added to the header
  • access: public
string GetHeader ()
GetIdentifier (line 239)

Gets to original identifier specified as <Namespace>/<PluginID>.<ext> Do this if you wish to extraxt the extention and parse manually.

  • access: public
string GetIdentifier ()
GetPluginID (line 79)

Gets the pluginID of the plugin.

  • access: public
string GetPluginID ()
Parse (line 136)

Print the content, should also be called from GetPage().

  • access: public
void Parse ()
ParseEmbedments (line 276)

Finds and replaces all embedments, in a given string

Currently not working since support for embeds isn't implemented yet.

  • return: Content where all embedments have been included.
  • access: protected
string ParseEmbedments (string $Content)
  • string $Content: Content The string you wish to clear of embedments
ParseLinkEntry (line 165)
  • access: protected
void ParseLinkEntry ( $Entry)
  • $Entry
PrintError (line 258)

Print an error code, if you use this method no other methods will be available.

This method will print all 4xx and 5xx error codes specified in the RFC 2616, and some of the codes specified in the WebDAV extension. NOTE: This mehtod postes a soft error code in HTML, this may be improved later on.

  • access: public
void PrintError (string $msg, int $code)
  • string $msg: msg The message you wish to print
  • int $code: code The error code you wish to print eg. 404.

Redefinition of:
CMS3_StandartOutputHandler_OutputHandler::PrintError()
Print an error code, if you use this method no other methods will be available.
Register (line 67)
  • access: public
void Register (CMS3_System &$Owner)
  • CMS3_System &$Owner: Owner The CMS3_System that owns this plugin, gives the plugin ability to get data from
SetBody (line 126)

Set the body if the page, read parameter documentation.

Embedments may be included in the body, they shall be formatted as follows: [[EMBED|<identifier>|EMBED]], where <identifier> is the identifier returned from the IEmbedable.

  • access: public
void SetBody (string $body, [array $List = null])
  • string $body: body Body of the page, or description of a channel.
  • array $List: List Parse a list, use this feature if you wish to parse a list. This will also enable to OutputHandler to print a feed. This parameter is optional, if set the first parameter will define the description of the channel, and every body and title in this array will define an entry. Array layout: [body,body,...] or [[title,body],[title,body],...]
SetIdentifier (line 55)

Sets the complete unique identifier.

  • access: public
void SetIdentifier ([string $Identifier = ""])
  • string $Identifier: Idenfitifer Complete unique identifier.
SetTitle (line 103)
  • access: public
void SetTitle (string $title)
  • string $title: title

Inherited Methods

Inherited From CMS3_StandartOutputHandler_OutputHandler

 CMS3_StandartOutputHandler_OutputHandler::PrintError()

Documentation generated on Mon, 30 Apr 2007 01:59:09 +0200 by phpDocumentor 1.3.1