Class: ServerDataComponentTag

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

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

Class Overview

CompilerComponent
   |
   --ServerComponentTag
      |
      --ServerDataComponentTag

Server tag component tags are ServerComponentTags which also correspond to an HTML tag.

Variables

$DataSourceReferenceVariable

Methods

Child classes:

CoreDataSourceTag: Datasources act is "namespaces" for a template.

DataTableTag: The compile time component to output a result set as an HTML table

ErrorSummaryTag: Compile time component for errorsummary tags.

ListListTag: The parent compile time component for lists

Inherited Variables

Class: CompilerComponent

CompilerComponent::$attributeNodes
CompilerComponent::$children
CompilerComponent::$emptyClosedTag
CompilerComponent::$hasClosingTag
CompilerComponent::$parent
CompilerComponent::$plainTagCount
CompilerComponent::$properties
CompilerComponent::$ServerId
CompilerComponent::$SourceFile
CompilerComponent::$StartingLineNo
CompilerComponent::$tag
CompilerComponent::$TagInfo
CompilerComponent::$WrappingComponents

Inherited Methods

Class: ServerComponentTag

ServerComponentTag::generateConstructor(): Calls the parent getComponentRefCode() method and writes it to the
ServerComponentTag::getComponentRefCode(): Returns a string of PHP code identifying the component in the hierarchy.

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 tag component tags are ServerComponentTags which also correspond to an HTML tag.

Makes it easier to implement instead of extending from the ServerComponentTag class

abstract:
access:	public
see:	http://wact.sourceforge.net/index.php/ServerTagComponentTag

Class Variables

$DataSourceReferenceVariable =

Type:

mixed

Class Methods

method getDataSource

ListListTag &getDataSource(
)

API Tags:

return:	this instance
access:	protected

Overrides CompilerComponent::getDataSource() (If a parent compile time component exists, returns the value of the parent's getDataSource() method, which will be a concrete implementation)

method getDataSourceRefCode

string getDataSourceRefCode(
)

API Tags:

return:	PHP runtime variable reference to component
access:	protected

Overrides CompilerComponent::getDataSourceRefCode() (Gets the DataSource reference code of the parent)

method isDataSource

Boolean isDataSource(
)

API Tags:

return:

Indicating whether or not this component is a DataSource

Overrides CompilerComponent::isDataSource() (parent method not documented)

method preGenerate

Calls the parent preGenerate() method then writes "$DataSpace->prepare();" to the compiled template.

void preGenerate(
CodeWriter
&$code)

API Tags:

access:

protected

Overridden in child classes as:

DataTableTag::preGenerate()

ErrorSummaryTag::preGenerate()

ListListTag::preGenerate()

Overrides CompilerComponent::preGenerate() (Pre generation method, calls the WrappingComponents generateWrapperPrefix() method if the component exists)

Parameters:

CodeWriter

&$code

Documentation generated on Sun, 28 Nov 2004 19:50:10 -0800 by phpDocumentor 1.2.3