Class: GalleryPersistent

Source Location: /modules/core/classes/GalleryPersistent.class

Class GalleryPersistent

Class Overview

Base class that contains information about the state of its members

Located in /modules/core/classes/GalleryPersistent.class [line 35]

Author(s):

API Tags:

Abstract:

Properties

$_persistentStatus

Methods

[ Top ]

Direct descendents

Child Class	Description
GalleryEntity	A GalleryEntity is a stateful representation of an entity in the persistent store. You can load, modify, save and delete it. Any modifications made to this entity will live in memory until you commit the changes to the store (hence, it's stateful).

[ Top ]

Property Summary

array

$_persistentStatus

Keep track of which internal values are persistant and which ones aren't so that we'll know when and what to save to the database.

[ Top ]

Method Summary

GalleryPersistent	GalleryPersistent()
void	clearPersistentFlag()	Clear a flag.
array	getClassFile()	Return the relative path to the class for this entity
mixed	getOriginalValue()	Return the original value of the given member.
boolean	isModified()	Have we modified any data in this class?
GalleryStatus	resetOriginalValues()	Reset all original values to the current values in the entity (or null if so specified).
void	setPersistentFlag()	Set a flag.
bool	testPersistentFlag()	Test a flag.

[ Top ]

Properties

array $_persistentStatus [line 43]

Keep track of which internal values are persistant and which ones aren't so that we'll know when and what to save to the database.

API Tags:

Access:

private

[ Top ]

Methods

Constructor GalleryPersistent [line 46]

GalleryPersistent GalleryPersistent(
)

[ Top ]

clearPersistentFlag [line 127]

void clearPersistentFlag(
int
$flag 
)

Clear a flag.

The GalleryStorage strategy uses this to flag objects for its own internal purposes.

Parameters:

int

$flag:

a bit flag to clear

[ Top ]

getClassFile [line 148]

array getClassFile(
)

Return the relative path to the class for this entity

API Tags:

Return:

GalleryStatus a status code string a path like modules/core/classes/GalleryUser.class

Redefined in descendants as:

EntityTestEntity::getClassFile()

[ Top ]

getOriginalValue [line 75]

mixed getOriginalValue(

$member 
)

Return the original value of the given member.

Parameters:

$member:

API Tags:

Return:

the value, or null if it was not defined.

[ Top ]

isModified [line 57]

boolean isModified(
[string
$member = null] 
)

Have we modified any data in this class?

Parameters:

string

$member:

(optional) check just this field

API Tags:

Return:

true if modified, false if not.

[ Top ]

resetOriginalValues [line 88]

GalleryStatus resetOriginalValues(
[boolean
$resetToNull = false] 
)

Reset all original values to the current values in the entity (or null if so specified).

Parameters:

boolean

$resetToNull:

(optional) reset all original values to null if true

API Tags:

Return:

a status code

[ Top ]

setPersistentFlag [line 117]

void setPersistentFlag(
int
$flag 
)

Set a flag.

The GalleryStorage strategy uses this to flag objects for its own internal purposes.

Parameters:

int

$flag:

a bit flag to set

[ Top ]

testPersistentFlag [line 138]

bool testPersistentFlag(
int
$flag 
)

Test a flag.

The GalleryStorage strategy uses this to flag objects for its own internal purposes.

Parameters:

int

$flag:

a bit flag to test

API Tags:

Return:

true if the bit is on, false otherwise

[ Top ]

Documentation generated on Fri, 08 Oct 2010 05:01:44 -0700 by phpDocumentor 1.3.0RC6

	GalleryCore Classes

[ class tree: GalleryCore ] [ index: GalleryCore ] [ all elements ]