Class: PageTemplate

Source Location: /templateplugins.inc.php

Class Overview

Object
   |
   --Persistent
      |
      --Component
         |
         --PageTemplate

Base class for template engines.

Author(s):

Variables

$_filename

Methods

Child classes:

SmartyTemplate: This class is used by the template engine to work with Smarty templates.

Inherited Variables

Class: Component

Component::$alreadycreated
Component::$components
Component::$lastresourceread
Component::$owner
Component::$reallastresourceread
Component::$_childnames
Component::$_controlstate
Component::$_name
Component::$_namepath
Component::$_tag

Class: Object

Object::$input

Inherited Methods

Class: Component

Component::__construct(): Component constructor
Component::ajaxCall(): Dumps the javascript code to make an ajax call to the server.
Component::callEvent(): Calls a server event.
Component::defaultName()
Component::defaultTag()
Component::dumpChildrenFormItems(): This method is called by the page just after dumping the starting form tag.
Component::dumpChildrenHeaderCode(): Dumps the header code for all the children
Component::dumpChildrenJavascript(): Dumps the javascript code for all the children
Component::dumpFormItems(): Dumps code just after the form tag, useful to dump hidden fields for state retrieving for non visible components
Component::dumpHeaderCode(): Dumps header code required
Component::dumpHiddenKeyFields(): Dumps hidden field values for the key record
Component::dumpJavascript(): Dumps the javascript code needed by this component
Component::dumpJSEvent(): Dumps javascript code for an event
Component::fixupProperty(): Resolves the right reference to an object property
Component::generateAjaxEvent(): Returns the javascript code to generate an ajax call.
Component::getName(): Specifies the name for the component. The name is used as an identifier and should be unique.
Component::getTag(): A versatile property of every Component that can be used in any way you want
Component::hasValidDataField(): Returns true if a valid data field is attached to the component
Component::init(): Initializes a component
Component::insertComponent(): Inserts a component into the component's collection
Component::loaded(): Initializes the component after the form file has been read into memory.
Component::loadedChildren(): Calls childrens loaded
Component::loadResource(): Loads this component from a string
Component::preinit(): Method called before init()
Component::readAccessibility(): Provides accessibility info to the embedded RPC engine.
Component::readComponentCount(): Indicates the number of components owned by the component.
Component::readComponents(): Lists all the components owned by this component.
Component::readControlState(): A flag to know the state of the control, csLoading, csDesigning
Component::readDataFieldValue(): This property returns the value of the datafield if any.
Component::readFromResource(): Reads a component from a resource file
Component::readNamePath(): Specifies the path to uniquely identify a component, qualified by the owner when required.
Component::readOwner(): Indicates the component that is responsible for streaming and freeing this component.
Component::removeComponent(): Removes a component from the component's collection
Component::serializeChildren(): Serializes all children
Component::setName()
Component::setTag()
Component::unserializeChildren(): Unserializes all children by calling unserialize for all the components
Component::updateDataField(): Updates the field on the dataset attached, if any
Component::writeControlState()

Class: Persistent

Persistent::allowserialize(): This method provides an opportunity for the component developer to prevent the serialization/unserialization of a property.
Persistent::assign(): Assigns the source properties to this object.
Persistent::assignError(): Raises an assignation error.
Persistent::assignTo(): Assigns this object to another object.
Persistent::inSession(): This method determines if this object exists in the current session.
Persistent::readNamePath(): Used to serialize/unserialize. It returns the full path to identify this component.
Persistent::readOwner(): Owner of the component.
Persistent::serialize(): Stores this object into the session.
Persistent::unserialize(): This method uses PHP reflection to iterate through published properties (the ones starting with get) and retrieve the properties stored by a previous serialize() call.

Class: Object

Object::__construct(): Constructs an object and initializes its data before the object is first used.
Object::className(): Returns a string indicating the type of the object instance (as opposed to the type of the variable passed as an argument).
Object::classNameIs(): Determines whether an object is of a specific type.
Object::classParent(): Returns the type of the immediate ancestor of a class.
Object::inheritsFrom(): Determines the relationship of two object types.
Object::methodExists(): Check if a method exists declared on this object instance.
Object::readProperty(): Reads a property from the streams
Object::__get(): To virtualize properties
Object::__set(): To virtualize properties

Class Details

[line 38]
Base class for template engines.

Inherit from it and override initialize(), assignComponents() and dumpTemplate()

Tags:

example:	example not found
example:	example not found
example:	example not found

[ Top ]

Class Variables

$_filename = ''

[line 40]

Tags:

access:

protected

Type:

mixed

[ Top ]

Class Methods

constructor __construct [line 136]

PageTemplate __construct(
[
$aowner = null])

Overrides Component::__construct() (Component constructor)

Parameters:

$aowner

[ Top ]

method assignComponents [line 118]

void assignComponents(
)

Called to assign component code to template holes

Override this method to iterate through all components in the form and place the code in the holes of your template.

<?php
function assignComponents()
{
$form=$this->owner;
ob_start();
$form->callEvent('onshowheader',array());
$contents=ob_get_contents();
ob_end_clean();
$this->_smarty->assign('HeaderCode', $contents.$form->dumpChildrenHeaderCode(true).$form->dumpHeaderJavascript(true));
$this->_smarty->assign('StartForm', $form->readStartForm());
$this->_smarty->assign('EndForm', $form->readEndForm());
reset($form->controls->items);
while (list($k,$v)=each($form->controls->items))
{
$dump = false;
if( $v->Visible && !$v->IsLayer )
{
if( $v->Parent->methodExists('getActiveLayer') )
{
$dump = ( (string)$v->Layer == (string)$v->Parent->Activelayer );
}
else
{
$dump = true;
}
}
if ($dump)
{
$code="<div id=\"".$v->Name."_outer\">\n";
$code.=$v->show(true);
$code.="\n</div>\n";
$this->_smarty->assign($v->Name, $code);
}
}
}
?>

Overridden in child classes as:

SmartyTemplate::assignComponents()

VCLTemplate::assignComponents()

[ Top ]

method dumpTemplate [line 134]

void dumpTemplate(
)

Called to dump the parsed Template to the output stream

Override this method to dump the template with all the contents to the output.

<?php
function dumpTemplate()
{
$this->_smarty->display($this->FileName);
}
?>

Overridden in child classes as:

SmartyTemplate::dumpTemplate()

[ Top ]

method initialize [line 71]

void initialize(
)

Called to initialize the template system

Override this method to provide initialization code for your template system, this process is usually create the template object

<?php
function initialize()
{
require_once("smarty/libs/Smarty.class.php");
$this->_smarty = new Smarty;
$this->_smarty->template_dir = '';
}
?>

Overridden in child classes as:

SmartyTemplate::initialize()

[ Top ]

method readFileName [line 50]

string readFileName(
)

Template filename

Use this property to specify the filename in your system that has the template to use when rendering the page.

[ Top ]

method writeFileName [line 51]

void writeFileName(

$value)

Parameters:

$value

[ Top ]

Documentation generated on Sat, 13 Jun 2009 10:52:12 -0700 by phpDocumentor 1.4.1