Class: IsterUIBase

Source Location: /IsterUIBase.php

Class Overview

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

This class represents an object having some other objets as protected properties.

Author(s): Ingo Schramm

Variables

Methods

Child classes:

IsterUIComponent: This class represents a ui component.

IsterUIFramework: This class represents a framework.

IsterUIView: This class represents a view.

Inherited Constants

Inherited Variables

Class: IsterFilterOwner

IsterFilterOwner::$checker

Inherited Methods

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 an object having some other objets as protected properties.

The protected properties are instances of IsterObjectChecker, IsterSqlFunction, IsterTemplate, IsterAppMain, IsterClassLoader. All getter methods will return the desired object by reference.

copyright:	Copyright (c) 2005 Ister.ORG Ingo Schramm
author:	Ingo Schramm
see:	IsterFilterOwner::IsterFilterOwner(), IsterClassLoader, IsterSqlFunction, IsterTemplate, IsterAppMain

[ Top ]

Class Variables

protected object IsterAppMain $app	The framework object.
protected object IsterUIDescExpat $descr	The object's description.
protected object IsterSqlFunction $function	The object's sql function.
protected object IsterUIFramework $fw	The framework object.
protected object IsterClassLoader $loader	The object's class loader.
protected string $name	Name of the object.
protected integer $required	The object's requirements bitmask.
protected string $string	A string representation of this object, may be set from the outside.
protected object IsterTemplate $tmpl	The object's template.

[ Top ]

Class Methods

constructor IsterUIBase

IsterUIBase IsterUIBase(
)

Constructor

$this->required = ISTER_UI_REQ_DESCRIPTION;

[ Top ]

method catString

boolean catString(
string
$str)

Concat $str parameter to $this->string property.

since:

0.5.0

Parameters:

string

$str

[ Top ]

method getApplication

object IsterAppMain &getApplication(
)

Get the objet's IsterAppMain object.

[ Top ]

method getFramework

object IsterUIFramework &getFramework(
)

Get the objet's IsterUIFramework object.

[ Top ]

method getName

string getName(
)

Get the objet's name.

[ Top ]

method getRequired

integer getRequired(
)

Returns bitmask of required objects.

[ Top ]

method getSqlFunction

object IsterSqlFunction &getSqlFunction(
)

Get the objet's IsterSqlFunction object.

[ Top ]

method getTemplate

object IsterTemplate &getTemplate(
)

Get the objet's IsterTemplate object.

[ Top ]

method hasTemplate

boolean hasTemplate(
)

since:

0.4.6

[ Top ]

method setApplication

boolean setApplication(
object IsterAppMain
&$app)

Set the application object.

This method automatically initializes $this->request.

Overridden in child classes as:

IsterUIFormConnector::setApplication(): Set the application object.

Parameters:

object IsterAppMain

&$app

[ Top ]

method setDescription

boolean setDescription(
object IsterUIDesc
&$descr)

Set the description object.

Parameters:

object IsterUIDesc

&$descr

[ Top ]

method setFramework

boolean setFramework(
object IsterUIFramework
&$fw)

Set the objet's IsterUIFramework object.

Parameters:

object IsterUIFramework

&$fw

[ Top ]

method setName

boolean setName(
mixed
$name)

Set the object's name

[ Top ]

method setSqlFunction

boolean setSqlFunction(
object IsterSqlFunction
&$function)

Set the objet's IsterSqlFunction object.

Parameters:

object IsterSqlFunction

&$function

[ Top ]

method setTemplate

boolean setTemplate(
object IsterTemplate
&$tmpl, [mixed
$path = '.'])

Set the objet's IsterTemplate object.

Parameters:

object IsterTemplate

&$tmpl

[ Top ]

method test

boolean test(
array
$list)

Test if some objects exist.

Parameters:

array

$list

list of property names

[ Top ]

method toString

string toString(
)

Return a string representation of this object.

Overridden in child classes as:

IsterUIComponent::toString(): Return a string representation of this component.

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

IsterUIView::toString(): Return string representation of this view.

[ Top ]

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

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