Class: IsterUIFramework

Source Location: /IsterUIFramework.php

Class Overview

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

This class represents a framework.

Author(s): Ingo Schramm

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 framework.

The framework object parses the XML description and creates an application as defined. The session is implicitly created and saved at the end. Defined configuration objects will be saved if a property has been changed by the script. Defined security policies will be applied to the request. For the selected view it will be checked if the current user has sufficient access rights. If not, the defined access denied view will be selected and processed. If no view has been selected or the requested view does not exist, the default view will be called. The framework also tries to create the default view if creation of the selected view failed.

Example:

 // create description
  $fac   = new IsterUIDescFactory();
 $descr = $fac->get(ISTER_UI_FRAMEWORK);
 $descr->setSource('framework.xml');
 // create framework
  $fw = new IsterUIFramework;
 // set description
  $fw->setDescription($descr);
 // execute framework
  $fw->run();

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

[ Top ]

Class Methods

constructor IsterUIFramework

IsterUIFramework IsterUIFramework(
)

Constructor

The constructor will implicitly start output buffering.

[ Top ]

method getContainer

object IsterAppMain &getContainer(
)

Get the session container.

Returns null if no session is active.

[ Top ]

method getResponse

object IsterHttpResponse &getResponse(
)

Get the current response object.

[ Top ]

method newApp

boolean newApp(
array
$app)

Callback called by IsterUIFWDescExpat

Parameters:

array

$app

[ Top ]

method newConfig

boolean newConfig(
array
$conf)

Callback called by IsterUIFWDescExpat

Parameters:

array

$conf

[ Top ]

method newFilter

boolean newFilter(
mixed
$flt)

Callback called by IsterUIFWDescExpat

[ Top ]

method newLogger

boolean newLogger(
mixed
$logger)

Callback called by IsterUIFWDescExpat

[ Top ]

method newPolicy

boolean newPolicy(
mixed
$pol)

Callback called by IsterUIFWDescExpat

The policies will be created but not yet applied.

[ Top ]

method newProtect

boolean newProtect(
array
$prot)

Callback called by IsterUIFWDescExpat

Parameters:

array

$prot

[ Top ]

method newSelector

boolean newSelector(
array
$sel)

Callback called by IsterUIFWDescExpat

Parameters:

array

$sel

[ Top ]

method newSession

boolean newSession(
array
$sess)

Callback called by IsterUIFWDescExpat

Parameters:

array

$sess

[ Top ]

method newSql

boolean newSql(
array
$sql)

Callback called by IsterUIFWDescExpat

Parameters:

array

$sql

[ Top ]

method newView

boolean newView(
mixed
$view)

Callback called by IsterUIFWDescExpat

[ Top ]

method run

integer run(
)

Execute this framework.

This methods first reads the description and builds up the application. Then the request is checked for which view was requested, the acl of the requested view is compared with the current user's access rights and the view or - if access has been denied - the default view is processed and the resulting string is sent after any defined filter has been applied.

The method returns the bytes sent or false on error.

[ Top ]

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

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