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

Class: ControlTag

Source Location: /framework/template/tags/form/control.inc.php

Class Overview

CompilerComponent
   |
   --ServerComponentTag
      |
      --ServerTagComponentTag
         |
         --ControlTag

Ancester tag class for input controls

Methods


Child classes:

ButtonTag
Compile time component for button tags
InputTag
Compile time component for building runtime InputComponents Creates all the components beginning with the name Input
InputAutoCompleteTag
EXPERIMATAL! Allows text input tags with support for autocompletion (using JavaScript)
SelectTag
Compile time component for building runtime select components
TextAreaTag
Compile time component for building runtime textarea components

Inherited Variables

Inherited Methods

Class: ServerTagComponentTag

ServerTagComponentTag::generateConstructor()
Writes the compiled template constructor from the runtime component,
ServerTagComponentTag::generateExtraAttributes()
Adds any additional XML attributes
ServerTagComponentTag::getRenderedTag()
Returns the XML tag name
ServerTagComponentTag::postGenerate()
Writes the closing tag string to the compiled template
ServerTagComponentTag::preGenerate()
Calls the parent preGenerate() method then writes the XML tag name plus a PHP string which renders the attributes from the runtime component.

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

Ancester tag class for input controls
access:  protected

Class Methods


method CheckNestingLevel



void CheckNestingLevel( )

API Tags:

access:  protected
Overrides 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.)

method generateConstructor



void generateConstructor( CodeWriter &$code)

API Tags:

access:  protected

Overridden in child classes as:

InputAutoCompleteTag::generateConstructor()

Overrides ServerTagComponentTag::generateConstructor() (Writes the compiled template constructor from the runtime component,)

Parameters:

CodeWriter   &$code  

method getServerId

Returns the identifying server ID.

It's value it determined in the following order;

  1. The XML id attribute in the template if it exists
  2. The XML name attribute in the template if it exists
  3. The value of $this->ServerId
  4. An ID generated by the getNewServerId() function



string getServerId( )

API Tags:

return:  value identifying this component
access:  protected
see:  getNewServerId()
Overrides CompilerComponent::getServerId() (Returns the identifying server ID.)

method prepare



void prepare( )

API Tags:

access:  protected

Overridden in child classes as:

InputTag::prepare()
Sets the runtimeComponentName property, depending on the type of Input tag
SelectTag::prepare()

Overrides CompilerComponent::prepare() (Calls the prepare method for each child component, which will override)
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:44:55 -0800 by phpDocumentor 1.2.3