Class: SilentCompilerDirectiveTag

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

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

Class Overview

CompilerComponent
   |
   --SilentCompilerDirectiveTag

Silent compiler directive tags are instructions for the compiler and do not have a corresponding runtime Component, nor do they normally generate output into the compiled template.

Methods

Child classes:

CoreGraftTag: Grafts the tag contents into the component tree as children of the indicated <core:placeholder> component.

CoreImportTag: Imports a property definition file into the DataSource (e.g.

CoreSetTag: Sets a property in the runtime DataSource, according the attributes of this tag at compile time.

DataDefaultTag: The compile time component to output when the DataSet is empty

DataCellTag: The compile time component for a cell template

DataHeaderTag: The compile time component to output a heading for a column, group or table

DataFooterTag: The compile time component to output a footer for a column or table

ListDefaultTag: Default List tag for a list which failed to have any contents

ListSeparatorTag: Compile time component for separators in a list

PageElipsesTag: Compile time component for elispses in a pager.

PageNumberTag: Compile time component for page numbers in pager

PageSeparatorTag: Compile time component for separators in a Pager

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

Silent compiler directive tags are instructions for the compiler and do not have a corresponding runtime Component, nor do they normally generate output into the compiled template.

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

Class Methods

method generate

Does nothing - SilentCompilerDirectiveTags do not generate during construction of the compiled template

void generate(
CodeWriter
&$code)

API Tags:

access:

protected

Overrides CompilerComponent::generate() (Calls the local preGenerate(), generateContents() and postGenerate() methods.)

Parameters:

CodeWriter

&$code

method generateNow

Results in all components registered as children of the instance of this component having their generate() methods called

void generateNow(
string
&$code)

API Tags:

access:	protected
see:	CompilerComponent::generate

Parameters:

string

&$code

code to generate

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