Class: IsterUIComponent

Source Location: /IsterUIComponent.php

Class Overview

IsterObject
   |
   --IsterAttributeSet
      |
      --IsterFilterOwner
         |
         --IsterUIBase
            |
            --IsterUIComponent

This class represents a ui component.

Author(s): Ingo Schramm

Child classes:

IsterUIFormConnector: This class represents a connection of a form object and a data object.

Inherited Constants

Inherited Variables

Class: IsterUIBase

IsterUIBase::$app
IsterUIBase::$descr
IsterUIBase::$function
IsterUIBase::$fw
IsterUIBase::$loader
IsterUIBase::$name
IsterUIBase::$required
IsterUIBase::$string
IsterUIBase::$tmpl

Inherited Methods

Class: IsterUIBase

IsterUIBase::IsterUIBase(): Constructor
IsterUIBase::catString(): Concat $str parameter to $this->string property.
IsterUIBase::getApplication(): Get the objet's IsterAppMain object.
IsterUIBase::getFramework(): Get the objet's IsterUIFramework object.
IsterUIBase::getName(): Get the objet's name.
IsterUIBase::getRequired(): Returns bitmask of required objects.
IsterUIBase::getSqlFunction(): Get the objet's IsterSqlFunction object.
IsterUIBase::getTemplate(): Get the objet's IsterTemplate object.
IsterUIBase::hasTemplate()
IsterUIBase::setApplication(): Set the application object.
IsterUIBase::setDescription(): Set the description object.
IsterUIBase::setFramework(): Set the objet's IsterUIFramework object.
IsterUIBase::setName(): Set the object's name
IsterUIBase::setSqlFunction(): Set the objet's IsterSqlFunction object.
IsterUIBase::setTemplate(): Set the objet's IsterTemplate object.
IsterUIBase::test(): Test if some objects exist.
IsterUIBase::toString(): Return a string representation of this object.

Class: IsterFilterOwner

IsterFilterOwner::IsterFilterOwner(): Constructor
IsterFilterOwner::apply(): Apply all filters in order of definition.
IsterFilterOwner::deleteFilter(): Delete a filter.
IsterFilterOwner::getFilter(): Get a filter.
IsterFilterOwner::getFilterNames(): Get an array with all filter names.
IsterFilterOwner::hasFilters(): Return number of filters.
IsterFilterOwner::setFilter(): Add an IsterBufferFilter.

Class: IsterAttributeSet

IsterAttributeSet::IsterAttributeSet(): Constructor
IsterAttributeSet::addAttribute(): depricated
IsterAttributeSet::addAttributeReference(): depricated
IsterAttributeSet::addAttributesArray(): depricated
IsterAttributeSet::delete(): Delete all attributes.
IsterAttributeSet::deleteAttribute(): Delete an aAttribute.
IsterAttributeSet::getAttribute(): Get the value of an attribute.
IsterAttributeSet::getAttributeNames(): Return an array containing the names of all attributes.
IsterAttributeSet::getAttributeReference(): Get the reference value of an attribute.
IsterAttributeSet::getAttributesArray(): Get all attributes.
IsterAttributeSet::hasAttribute(): Check whether an attribute has been set.
IsterAttributeSet::setAttribute(): Set a new attribute or overwrite an already existing attribute.
IsterAttributeSet::setAttributeReference(): Set an attribute and store only a reference of the attribute.
IsterAttributeSet::setAttributesArray(): Set an array of key value pairs, each pair an attribute.

Class: IsterObject

IsterObject::IsterObject(): Constructor
IsterObject::abstractMethodError(): Report attempt to call an abstract method.
IsterObject::addLogger(): Add an IsterLogger to process log messages.
IsterObject::deleteLogger(): Delete an already registered IsterLogger.
IsterObject::getLoggerNames(): Fetch the names of all currently registered IsterLoggers.
IsterObject::getMem(): Return maximum amount of memory an application has allocated at this point.
IsterObject::log(): Trigger a log message.
IsterObject::passPHPmessage(): Catch PHP E_WARNING and E_NOTICE messages.
IsterObject::serialize(): Serialize the object.
IsterObject::setLogLocal(): Set logging local for the current object.
IsterObject::setupLogger(): Setup a logger.
IsterObject::triggerError(): Alias for log();
IsterObject::unserialize(): Unserialize the object.
IsterObject::__sleep(): Executed prior to serialize().
IsterObject::__wakeup(): Executed prior to unserialize().

Class Details

This class represents a ui component.

This class does not require an IsterSqlFunction, but it may have one. If you want the parent's IsterSqlFunction be passed to the component, extend this class and set $this->required = $this->required | ISTER_UI_REQ_SQL in the constructor.

As of 0.4.6 components may omit to own a template.

copyright:	Copyright (c) 2005 Ister.ORG Ingo Schramm
author:	Ingo Schramm

[ Top ]

Class Methods

constructor IsterUIComponent

IsterUIComponent IsterUIComponent(
)

Constructor

$this->required = $this->required;

[ Top ]

method applySecurityPolicies

boolean applySecurityPolicies(
[boolean
$pathinfo = false])

Apply the IsterHttpSecurityPolicies to the request and to pathinfo.

Parameters:

boolean

$pathinfo

whether to apply policy of pathinfo or not

[ Top ]

method defineSql

boolean defineSql(
mixed
$name, mixed
$sql)

Define a SQL function on the component's IsterSQLFunction object.

[ Top ]

method isCheckable

boolean isCheckable(
string
$test)

Test for a checkable attribute.

The $test may be one of 'create', 'execute' or 'none'. The correspondent attributes must be set in view.xml. If 'create' is set, the testExecute() method of the selector will also be called.

since:

0.5.0

Parameters:

string

$test

[ Top ]

method run

boolean run(
)

Execute this object.

Should be overwritten, this returns simply true.

since:

0.4.6

Overridden in child classes as:

IsterUIFormConnector::run(): Execute the current connector.

[ Top ]

method setCheckable

boolean setCheckable(
string
$value)

since:

0.5.0

Parameters:

string

$value

[ Top ]

method toString

string toString(
)

Return a string representation of this component.

As of 0.4.6 this method returns $this->string if $this does not own a template. Also, the object's attributes are automatically added to the template if it exists.

Overridden in child classes as:

IsterUIFormConnector::toString(): Return a string representation of this object.

Overrides IsterUIBase::toString() (Return a string representation of this object.)

[ Top ]

Documentation generated on Tue, 20 Dec 2005 11:21:24 +0100 by phpDocumentor 1.3.0RC4

	ui
	[ doc home ] [ class tree: ui ] [ index: ui ] [ all elements ]