Class: ComponentDynamicOutput

Source Location: /components/dynamicOutput/ComponentDynamicOutput.inc.php

Class Overview

XmlObject
   |
   --Component
      |
      --ComponentDynamicOutput

Represents a component that can output the current values of input fields as well

Inherited Methods

Class: Component

Component::__construct(): Construct a new component
Component::createNewDatabaseFieldIfRequested()
Component::doActionToUrlRedirections()
Component::getComponentCode(): Returns PHP code generated by the component which implements the component's functionality.
Component::getComponentCodeBeforeHtmlTag(): Returns PHP code generated by the component which implements the component's functionality.
Component::getComponentIdExpandedDefault(): Returns whether or not the input field for the component Id should be shown expanded by default or not (ie. collapsed). This function may be overwritten by individual components
Component::getHtmlEditorCustomization(): Returns javascript code to put a drop down in the HTML Editor tool bar for adding input fields and database field directly into the HTML text without typing it in. This function can be overridden if special buttons or dropdowns need to be added to the HTML Editor toolbar.
Component::getId(): Returns the component's Id from the XML
Component::getParentApp(): Returns the parent Application of this component
Component::getParentPage(): Returns the parent Page of this object
Component::getType(): Returns the type of the component as text.
Component::getX(): Returns the component's X-screen coordinate from the XML
Component::getY(): Returns the component's Y-screen coordinate from the XML
Component::getZ(): Returns the component's Z-screen coordinate (the depth) from the XML
Component::handlePropertiesUi(): Responds to user input from the edit component screen, performs input validation and stores input values until they are saved or discarded.
Component::isActive(): Returns TRUE if this component is currently marked active
Component::isComplete(): Returns true if complete functionality of the component has been defined, otherwise false
Component::printComponentHelp(): This function is a wrapper which calls the global printHelp from common.inc.php
Component::printHtmlEditorUi(): Prints the UI for an HTML editor
Component::printJavaScriptOnChangeFunction(): This function puts a javscript function in the edit component dialog box that handles the component id change. whenever the component id changes we add this new id into the list of options for the field it is associated to in a database.
Component::printLinkToDatabaseFieldUi(): Prints the UI for linking a component to a database field
Component::printPropertiesUi(): Outputs the User Interface for editing the components properties.
Component::printSubmitFormFunction()
Component::rewriteLinksForEditMode(): This function rewrites all HTML links '<a href="something">' to '<a href="something?editMode=1">'
Component::setActive(): Makes this component active
Component::setId(): Sets the component's Id in the XML
Component::setX(): Sets the component's X-screen coordinate in the XML
Component::setY(): Sets the component's Y-screen coordinate in the XML
Component::setZ(): Sets the component's Z-screen coordinate in the XML
Component::unsetActive(): Makes this component inactive

Class: XmlObject

XmlObject::__construct()
XmlObject::getDom(): Returns a refernce to the DOMDocument that is at the root of this XML object
XmlObject::getFirstChildNodeByTagName(): Returns a reference to the first child XML node with a particular name
XmlObject::getOrCreateChildNodeByTagName(): Returns a reference to the first child XML node with a particular name.
XmlObject::getXmlNode(): Returns a reference to the DOMNode of this XML object
XmlObject::removeAllChildNodesByTagName(): Deletes all child nodes that have a particular name
XmlObject::setXmlNode(): Sets a refernce to the DOMNode.

Class Details

[line 9]
Represents a component that can output the current values of input fields as well

as results from a database query

[ Top ]

Class Methods

constructor __construct [line 21]

ComponentDynamicOutput __construct(
mixed
$oParentPage, [mixed
$oComponentNode = NULL])

Creates a dynamicOutput component.

By default, if no query object exists yet within the component, a new query object is created which later will contain the selected database fields and also the "WHERE" clause

Tags:

access:

public

Overrides Component::__construct() (Construct a new component)

[ Top ]

method createNewQuery [line 357]

Query createNewQuery(
[string
$sQueryType = "select"])

Creates a new query, i.e. '<query>'

Tags:

return:	Object that holds the query parameter
access:	public

Parameters:

string

$sQueryType

Type of the query (ie. select, insert, update, delete)

[ Top ]

method getComponentCode [line 231]

string getComponentCode(
)

Returns the html text

Tags:

return:	HTML text
access:	public

Overrides Component::getComponentCode() (Returns PHP code generated by the component which implements the component's functionality.)

[ Top ]

method getExistingOrNewQuery [line 371]

Query getExistingOrNewQuery(
)

Returns a query object, if one already exists it is returned, otherwise a new object is created

Tags:

return:	The object holding the query parameters
access:	public

[ Top ]

method getFields [line 471]

Array getFields(
)

Returns the database fields that are selected for displaying

Tags:

return:	The array containing the selected field names
access:	public

[ Top ]

method getHtml [line 265]

string getHtml(
)

Returns the HTML from the XML file

Tags:

return:	HTML text
access:	public

[ Top ]

method getHtmlEditorCustomization [line 386]

string getHtmlEditorCustomization(
)

Returns javascript code to put a drop down in the HTML Editor tool bar for adding input fields and database field directly into the HTML text without typing it in.

Tags:

return:	javascript code
access:	public

Overrides Component::getHtmlEditorCustomization() (Returns javascript code to put a drop down in the HTML Editor tool bar for adding input fields and database field directly into the HTML text without typing it in. This function can be overridden if special buttons or dropdowns need to be added to the HTML Editor toolbar.)

[ Top ]

method getHtmlRepeat [line 301]

boolean getHtmlRepeat(
)

Returns whether or not the HTML output should be repeated for each database row matching the filter.

TRUE means repeat (default); FALSE means just show HTML for "current" data row;

Tags:

return:	TRUE if output should be repeated, FALSE otherwise
access:	public

[ Top ]

method getQuery [line 337]

Query getQuery(
)

Returns a query from the XML

Tags:

return:	object that contains the query parameters or NULL
access:	public

[ Top ]

method getType [line 31]

string getType(
)

Returns the type of the component i.e. dynamicOutput

Tags:

return:	dynamicOutput
access:	public

Overrides Component::getType() (Returns the type of the component as text.)

[ Top ]

method handlePropertiesUi [line 173]

boolean handlePropertiesUi(
mixed
$bInputErrorsSoFar)

Responds to user input from the edit component screen, performs input validation and stores input values until they are saved or discarded

Tags:

return:	TRUE if no user input error occurred, FALSE otherwise
access:	public

Overrides Component::handlePropertiesUi() (Responds to user input from the edit component screen, performs input validation and stores input values until they are saved or discarded.)

[ Top ]

method printFilterFields [line 38]

void printFilterFields(
)

Prints the dialog box for setting the filter parameters

Tags:

access:

public

[ Top ]

method printPropertiesUi [line 82]

void printPropertiesUi(
)

This function invokes a dialog box which contains an instantiated object of the FCKEditor It allows to create custom HTML providing all the relevant functionality provided by the FCKEditor.

Tags:

access:

public

Overrides Component::printPropertiesUi() (Outputs the User Interface for editing the components properties.)

[ Top ]

method setFields [line 462]

void setFields(
Array
$aSelectedFields)

Sets the database fields that are selected for displaying

Tags:

access:

public

Parameters:

Array

$aSelectedFields

The array containing the selected field names

[ Top ]

method setHtml [line 279]

void setHtml(
string
$sHtml)

Sets the HTML in the XML file

Tags:

access:

public

Parameters:

string

$sHtml

HTML text

[ Top ]

method setHtmlRepeat [line 322]

void setHtmlRepeat(
boolean
$bRepeat)

Sets whether or not the HTML output should be repeated for each database row matching the filter.

TRUE means repeat; FALSE means just show HTML for "current" data row;

Tags:

access:

public

Parameters:

boolean

$bRepeat

TRUE if output should be repeated, FALSE otherwise

[ Top ]

Documentation generated on Wed, 12 Jan 2005 17:50:59 -0500 by phpDocumentor 1.3.0RC3