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

Class: ServerComponentTag

Source Location: /framework/template/compiler/servercomponent.inc.php

http://wact.sourceforge.net/index.php/ServerComponentTag

Class Overview

CompilerComponent
   |
   --ServerComponentTag

Server component tags have a corresponding server Component which represents an API which can be used to manipulate the marked up portion of the template.

Methods


Child classes:

ServerDataComponentTag
Server tag component tags are ServerComponentTags which also correspond to an HTML tag.
ServerTagComponentTag
Server tag component tags are ServerComponentTags which also correspond to an HTML tag.
CacheOutputCacheTag
Compile time component for instructing output to be cached in a file at runtime.
CoreBlockTag
Compile time component for block tags http://wact.sourceforge.net/index.php/CoreBlockTag
CoreCssTag
Acts as a placeholder for writing CSS.
CorePlaceHolderTag
Present a named location where content can be inserted at runtime
CoreScriptTag
Acts as a placeholder for writing JavaScript.
DataDumpTag
The compile time component to dump a result set
DataGroupTag
The compile time component representing a group of columns
DataColumnTag
The compile time component representing common attributes for a column of table cells
HtmlBaseTag
Base tag (not directly used) for HTML tags
HtmlBBCodeTag
Parse the
PageNavigatorTag
Compile time component for root of a pager tag

Inherited Variables

Inherited Methods

Class: CompilerComponent

CompilerComponent::addChild()
Adds a child component, by reference, to the array of children
CompilerComponent::addChildAttribute()
Sets the XML attributes for this component (as extracted from the template)
CompilerComponent::CheckNestingLevel()
Used to perform some error checking on the source template, such as examining the tag hierarchy and triggering an error if a tag is incorrectly nested.
CompilerComponent::findChild()
Returns a child component, given it's ServerID
CompilerComponent::findChildByClass()
Returns a child component, given it's compile time component class
CompilerComponent::findChildrenByClass()
Returns an array of child components, given it's compile time component class
CompilerComponent::findImmediateChildByClass()
Returns a child component, given it's compile time component class
CompilerComponent::findParentByClass()
Returns a parent component, recursively searching parents by their compile time component class name
CompilerComponent::findSelfOrParentByClass()
Extends findParentByClass to begin search at the current component then moving on to its parent, if there's no match.
CompilerComponent::generate()
Calls the local preGenerate(), generateContents() and postGenerate() methods.
CompilerComponent::generateAttributeList()
CompilerComponent::generateConstructor()
Calls the generateConstructor() method of each child component
CompilerComponent::generateContents()
Calls the generate() method of each child component
CompilerComponent::generateDynamicAttributeList()
CompilerComponent::getAttribute()
Returns the value of an XML attribute (as extracted from template) or NULL if attribute not found
CompilerComponent::getAttributesAsArray()
Returns an array containing the attributes of this component that can be resolved at compile time.
CompilerComponent::getBoolAttribute()
Return the value of a boolean attribute as a boolean.
CompilerComponent::getClientId()
Get the value of the XML id attribute
CompilerComponent::getComponentRefCode()
Gets the component reference code of the parent.
CompilerComponent::getDataSource()
If a parent compile time component exists, returns the value of the parent's getDataSource() method, which will be a concrete implementation
CompilerComponent::getDataSourceRefCode()
Gets the DataSource reference code of the parent
CompilerComponent::getLastChild()
Returns the last child added to a component
CompilerComponent::getParentDataSource()
Gets the parent in the DataSource, if one exists
CompilerComponent::getProperty()
CompilerComponent::getRootDataSource()
Gets a root DataSource
CompilerComponent::getServerId()
Returns the identifying server ID.
CompilerComponent::hasAttribute()
Check to see whether a named attribute exists
CompilerComponent::isDataSource()
CompilerComponent::postGenerate()
Post generation method, calls the WrappingComponents generateWrapperPostfix() method if the component exists
CompilerComponent::preGenerate()
Pre generation method, calls the WrappingComponents generateWrapperPrefix() method if the component exists
CompilerComponent::prepare()
Calls the prepare method for each child component, which will override
CompilerComponent::preParse()
Provides instruction to the template parser, while parsing is in
CompilerComponent::registerProperty()
register a property with this component. Currently, this component must be a database to support properties.
CompilerComponent::registerWrapper()
Set a wrapping component for this component
CompilerComponent::removeAttribute()
Remove an attribute from the list
CompilerComponent::removeChild()
Removes a child component, given it's ServerID
CompilerComponent::setAttribute()
Sets an attribute

Class Details

Server component tags have a corresponding server Component which represents an API which can be used to manipulate the marked up portion of the template.
abstract:  
access:  public
see:  http://wact.sourceforge.net/index.php/ServerComponentTag

Class Methods


method generateConstructor

Calls the parent getComponentRefCode() method and writes it to the

compiled template, appending an addChild() method used to create this component at runtime




method getComponentRefCode

Returns a string of PHP code identifying the component in the hierarchy.

string getComponentRefCode( )

API Tags:

access:  protected
Overrides CompilerComponent::getComponentRefCode() (Gets the component reference code of the parent.)
WACT: Copyright 2003 Procata, Inc. Released under the LGPL license (http://www.gnu.org/copyleft/lesser.html)
Documentation generated on Sun, 28 Nov 2004 19:50:08 -0800 by phpDocumentor 1.2.3