VCL
[ class tree: VCL ] [ index: VCL ] [ all elements ]

Class: TemplateManager

Source Location: /templateplugins.inc.php

Class Overview

Object
   |
   --Persistent
      |
      --Component
         |
         --TemplateManager

Template Manager to register all available template engines


Author(s):

Variables

Methods


Inherited Variables

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 162]
Template Manager to register all available template engines

This is the main class used by the template engine to register and get existing page templates. You only need to use this class if you are creating new plugins for template engines.

  1.  <?php
  2.  //Template registration
  3.  global $TemplateManager;
  4.  $TemplateManager->registerTemplate('SmartyTemplate','smartytemplate.inc.php');
  5.  ?>




Tags:

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


[ Top ]


Class Variables

$_templates = null

[line 164]



Tags:

access:  protected

Type:   mixed


[ Top ]



Class Methods


constructor __construct [line 166]

TemplateManager __construct( [ $aowner = null])



Overrides Component::__construct() (Component constructor)

Parameters:

   $aowner  

[ Top ]

method getEngines [line 202]

array getEngines( )

Return an array of engines

This property is used by the IDE to get a list of available and registered template engines, you don't need to use this property directly.




Tags:

return:  Array with all template engine names
see:  TemplateManager::registerTemplate()


[ Top ]

method registerTemplate [line 186]

void registerTemplate( string $classname, string $unitname)

Registers a new template engine to be available on the IDE.

  1.  <?php
  2.  //Template registration
  3.  global $TemplateManager;
  4.  $TemplateManager->registerTemplate('SmartyTemplate','smartytemplate.inc.php');
  5.  ?>




Parameters:

string   $classname   Class for the template engine
string   $unitname   Unit that holds the class

[ Top ]


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