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

Class: IsterSessionObject

Source Location: /IsterSessionObject.php

Class Overview

IsterObject
   |
   --IsterAttributeSet
      |
      --IsterSessionObject

This class represents a session object.


Author(s): Ingo Schramm   

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

Methods


Inherited Constants

Inherited Variables

Inherited Methods

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 session object.

As of version 0.4.4 an object of this class automatically includes all class definitions of objects stored here to prevent incorrect deserialization. In difference to IsterSession not only children of IsterObject may be stored. Nevertheless, the class definition must be called '<class>.php' and be located in include path.

Note: If objects contain other objects, the class definitions of these contained objects must be loaded manually before session starts.


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


[ Top ]


Class Methods


constructor IsterSessionObject

IsterSessionObject IsterSessionObject( [array $args = null])

Constructor

If an array is passed to the constructor, each key value pair will become the new object's property with key as name and value as value.


Parameters:

array   $args  

[ Top ]

method delete

boolean delete( )

Delete all attributes.

Session safe even for (non-nested) objects.


since:  0.4.4
Overrides IsterAttributeSet::delete() (Delete all attributes.)

[ Top ]

method deleteAttribute

boolean deleteAttribute( mixed $name)

Delete an attribute.

Session safe even for (non-nested) objects.


since:  0.4.4
Overrides IsterAttributeSet::deleteAttribute() (Delete an aAttribute.)

[ Top ]

method getAttribute

void getAttribute( mixed $name)

Get the value of an attribute.

Session safe even for (non-nested) objects.


since:  0.4.4
Overrides IsterAttributeSet::getAttribute() (Get the value of an attribute.)

[ Top ]

method getAttributesArray

boolean getAttributesArray( mixed $array)

Get all attributes.

Session safe even for (non-nested) objects.


since:  0.4.4
Overrides IsterAttributeSet::getAttributesArray() (Get all attributes.)

[ Top ]

method setAttribute

boolean setAttribute( mixed $name, mixed $value)

Set a new attribute or overwrite an already existing attribute.

Session safe even for (non-nested) objects.


since:  0.4.4
Overrides IsterAttributeSet::setAttribute() (Set a new attribute or overwrite an already existing attribute.)

[ Top ]

method setAttributeReference

boolean setAttributeReference( mixed $name, mixed &$value)

Return false and warn since references may not be used in sessions.

since:  0.4.4
Overrides IsterAttributeSet::setAttributeReference() (Set an attribute and store only a reference of the attribute.)

[ Top ]

method setAttributesArray

boolean setAttributesArray( mixed $array)

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

Session safe even for (non-nested) objects.


since:  0.4.4
Overrides IsterAttributeSet::setAttributesArray() (Set an array of key value pairs, each pair an attribute.)

[ Top ]

method __sleep

array __sleep( )

since:  0.4.4
Overrides IsterObject::__sleep() (Executed prior to serialize().)

[ Top ]


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