Class: SmartyTemplate

Source Location: /smartytemplate.inc.php

Class Overview

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

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

Author(s):

Child classes:

VCLTemplate: 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: PageTemplate

PageTemplate::__construct()
PageTemplate::assignComponents(): Called to assign component code to template holes
PageTemplate::dumpTemplate(): Called to dump the parsed Template to the output stream
PageTemplate::initialize(): Called to initialize the template system
PageTemplate::readFileName(): Template filename
PageTemplate::writeFileName()

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 44]
This class is used by the template engine to work with Smarty templates.

This class inherits from PageTemplate and implements the required methods to make the template engine work with Smarty templates.

You don't need to use this class directly, as the template engine takes care of everything to show up your template. You can check this class if you plan to develop your own template engine as it provides everything needed to implement PageTemplate methods.

Tags:

link:	http://smarty.php.net/
example:	example not found
example:	example not found
example:	example not found

[ Top ]

Class Variables

$_endform = ''

[line 49]

Tags:

access:

public

Type:

mixed

[ Top ]

$_headercode = ''

[line 47]

Tags:

access:

public

Type:

mixed

[ Top ]

$_smarty = null

[line 46]

Tags:

access:

public

Type:

mixed

[ Top ]

$_startform = ''

[line 48]

Tags:

access:

public

Type:

mixed

[ Top ]

Class Methods

method assignComponents [line 154]

void assignComponents(
)

Overridden in child classes as:

VCLTemplate::assignComponents()

Overrides PageTemplate::assignComponents() (Called to assign component code to template holes)

[ Top ]

method dumpTemplate [line 189]

void dumpTemplate(
)

Overrides PageTemplate::dumpTemplate() (Called to dump the parsed Template to the output stream)

[ Top ]

method endform [line 144]

string endform(
)

This method calls the EndForm property of the Page and return its value

Use this method to get the end part of the form declaration used by the page, actually </form>

[ Top ]

method headercode [line 102]

string headercode(
)

This method gets the code for the header section of the template

This method is called by the template engine to get the header code for the template

[ Top ]

method initialize [line 51]

void initialize(
)

Overrides PageTemplate::initialize() (Called to initialize the template system)

[ Top ]

method startform [line 125]

string startform(
)

This method gets the code for the starting form

This method is called by the template engine to get the starting code for the form.

[ Top ]

Documentation generated on Sat, 13 Jun 2009 10:51:56 -0700 by phpDocumentor 1.4.1