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

Class: IsterAttributeSet

Source Location: /IsterAttributeSet.php

Class Overview

IsterObject
   |
   --IsterAttributeSet

An object having attributes.


Author(s): Ingo Schramm   

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

Methods


Child classes:

IsterNamedAttributeSet
This class represents a named attribute set
IsterFilterOwner
This class represents an owner of certain IsterBufferFilter objects.
IsterAppPropertyCollection
This class represents a collection of application properties.
IsterACL
An IsterACL object provides access control information.
IsterSqlRow
This class represents a row of a database table.
IsterSqlDataObject
This class represents a persistent data container.
IsterAppPropertyReader
This class represents a reader of properties.
IsterSession
This class represents a session.
IsterHttpSecureObject
This class represents objects that may apply an IsterHttpSecurityPolicy.
IsterSessionObject
This class represents a session object.

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

An object having attributes.

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


[ Top ]


Class Methods


constructor IsterAttributeSet

IsterAttributeSet IsterAttributeSet( )

Constructor

As of version 0.4.0 passing a prefix is useless.


[ Top ]

method addAttribute

boolean addAttribute( string $attr, [mixed $val = ''])

depricated

Parameters:

string   $attr  
mixed   $val  

[ Top ]

method addAttributeReference

boolean addAttributeReference( string $attr, mixed &$val)

depricated

Parameters:

string   $attr  
mixed   &$val  

[ Top ]

method addAttributesArray

boolean addAttributesArray( array $array)

depricated

Parameters:

array   $array  

[ Top ]

method delete

boolean delete( )

Delete all attributes.

Overridden in child classes as:

IsterSqlDataObject::delete()
Delete the object's data from database.
IsterSessionObject::delete()
Delete all attributes.

[ Top ]

method deleteAttribute

boolean deleteAttribute( string $attr)

Delete an aAttribute.

Overridden in child classes as:

IsterSessionObject::deleteAttribute()
Delete an attribute.

Parameters:

string   $attr  

[ Top ]

method getAttribute

mixed getAttribute( string $attr)

Get the value of an attribute.

return:  The value of the attribute, null on error.

Overridden in child classes as:

IsterSessionObject::getAttribute()
Get the value of an attribute.

Parameters:

string   $attr   Name of the attribute.

[ Top ]

method getAttributeNames

array getAttributeNames( )

Return an array containing the names of all attributes.

[ Top ]

method getAttributeReference

mixed &getAttributeReference( string $attr)

Get the reference value of an attribute.

return:  The value of the attribute, null on error.

Parameters:

string   $attr   Name of the attribute.

[ Top ]

method getAttributesArray

array getAttributesArray( )

Get all attributes.

return:  Array of '$name => $value' pairs or false if no attributes are found.

Overridden in child classes as:

IsterSessionObject::getAttributesArray()
Get all attributes.

[ Top ]

method hasAttribute

boolean hasAttribute( string $attr)

Check whether an attribute has been set.

Parameters:

string   $attr   Name of the attribute.

[ Top ]

method setAttribute

boolean setAttribute( string $attr, [mixed $val = ''])

Set a new attribute or overwrite an already existing attribute.

Overridden in child classes as:

IsterSessionObject::setAttribute()
Set a new attribute or overwrite an already existing attribute.

Parameters:

string   $attr  
mixed   $val  

[ Top ]

method setAttributeReference

boolean setAttributeReference( string $attr, mixed &$val)

Set an attribute and store only a reference of the attribute.

Overridden in child classes as:

IsterSessionObject::setAttributeReference()
Return false and warn since references may not be used in sessions.

Parameters:

string   $attr  
mixed   &$val  

[ Top ]

method setAttributesArray

boolean setAttributesArray( array $array)

Set an array of key value pairs, each pair an attribute.

Overridden in child classes as:

IsterSessionObject::setAttributesArray()
Set an array of key value pairs, each pair an attribute.

Parameters:

array   $array  

[ Top ]


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