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

Class: IsterAppConfigureCollection

Source Location: /IsterAppConfigureCollection.php

Class Overview

IsterObject
   |
   --IsterAppConfigureCollection

This class represents a configuration collection.


Author(s): Ingo Schramm   

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

Methods


Inherited Constants

Inherited Variables

Inherited Methods

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 configuration collection.

A collection is composed of IsterAppConfigureSet objectss. Each such set can have an arbitrary number of IsterAppConfigureSections and each section can have an arbitrary number of IsterAppConfigureOptions.

depricated As of version 0.4.0 you should use the IsterAppProperty* classes for application configuration. These have a much better performance. The IsterAppConfigure* classes will be removed from the framework as of version 0.5.0.


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


[ Top ]


Class Methods


constructor IsterAppConfigureCollection

IsterAppConfigureCollection IsterAppConfigureCollection( object IsterAppConfigureReader $reader, [object IsterAppConfigureWriter $writer = null])

Constructor

If the reader has the APP_CONFIG_READER_CAP_GETALL capability, the constructor will read all configuration options at once.


Parameters:


[ Top ]

method getOpt

object IsterAppConfigureOption getOpt( string $option, [string $section = 'default'], [string $set = 'default'])

return:  The option object or false on error.

Parameters:

string   $option  
string   $section  
string   $set  

[ Top ]

method getOptValue

mixed getOptValue( string $name, [string $section = 'default'], [string $set = 'default'])

Get the value of a named configuration option.

return:  Value of the option or false on error.

Parameters:

string   $name  
string   $section  
string   $set  

[ Top ]

method getSection

object IsterAppConfigureSection getSection( string $section, [string $set = 'default'])

Get an IsterAppConfigureSection from the Collection.

Parameters:

string   $section  
string   $set  

[ Top ]

method getSet

object IsterAppConfigureSet getSet( string $set)

Get an IsterAppConfigureSet from the Collection.

Parameters:

string   $set  

[ Top ]

method setOpt

boolean setOpt( string $option, [string $section = 'default'], [string $set = 'default'])

Set an IsterAppConfigureOption object.

Parameters:

string   $option  
string   $section  
string   $set  

[ Top ]

method setOptValue

boolean setOptValue( string $name, mixed $value, [string $section = 'default'], [string $set = 'default'])

Set the value of a configuration optin.

Parameters:

string   $name  
mixed   $value  
string   $section  
string   $set  

[ Top ]

method setSection

boolean setSection( object IsterAppConfigureSection $section, [string $set = 'default'])

Set an IsterAppConfigureSection to the Collection.

Parameters:

object IsterAppConfigureSection   $section  
string   $set  

[ Top ]

method setSet

boolean setSet( object IsterAppConfigureSet $set)

Set an IsterAppConfigureSet to the Collection.

Parameters:


[ Top ]

method write

boolean write( )

This will write the configure collection using the passed IsterAppConfigureWriter object.

[ Top ]


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