Class CMS3_SemanticOutputHandler

Description

class CMS3_SemanticOutputHandler generates simple output readable with a xsl/xml complaint browser

Located in /lib/SemanticOutputHandler/CMS3_SemanticOutputHandler.php (line 32)

CMS3_StandartOutputHandler_OutputHandler
   |
   --CMS3_SemanticOutputHandler
Variable Summary
 mixed $Body
 mixed $BodyList
 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 ()
 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 $Identifier = "" (line 46)
  • access: protected
mixed $IsDisabled = false (line 41)

* Attributes: **

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

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

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

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 180)

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 200)

Gets the header extension

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

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 78)

Gets the pluginID of the plugin.

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

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

this prints a xml page with a very simple schema: <semanticpage> <title>Page Title</title> <content> <para>Main paragraph</para> <subpara>Sub paragraph<subpara> <subpara headline="Optional headline of sub paragraph">Sub paragraph<subpara> <subpara>Sub paragraph<subpara> <subpara>Sub paragraph<subpara> ... </content> </semanticpage>

  • access: public
void Parse ()
Register (line 66)
  • 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 132)

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 54)

Sets the complete unique identifier.

  • access: public
void SetIdentifier ([string $Identifier = ""])
  • string $Identifier: Idenfitifer Complete unique identifier.
SetTitle (line 109)
  • 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:08 +0200 by phpDocumentor 1.3.1