Class: GalleryGroup

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

Class GalleryGroup

Class Overview

Representation of a group of users

A group is a set of GalleryUsers that can be treated as if they were a single user. This is very useful for managing permissions.

Located in /modules/core/classes/GalleryGroup.class [line 52]

GalleryPersistent
   |
   --GalleryEntity
      |
      --GalleryGroup

Properties

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From GalleryEntity

GalleryEntity::$creationTimestamp

GalleryEntity::$entityType

GalleryEntity::$id

GalleryEntity::$isLinkable

GalleryEntity::$linkedEntity

GalleryEntity::$linkId

GalleryEntity::$modificationTimestamp

GalleryEntity::$onLoadHandlers

GalleryEntity::$serialNumber

Inherited From GalleryPersistent

GalleryPersistent::$_persistentStatus

Inherited From GalleryEntity

GalleryEntity::addOnLoadHandler()

Add onLoad handler.

GalleryEntity::create()

Create a new instance of this GalleryEntity in the persistent store

GalleryEntity::createLink()

Create a new linked version of this item into a new album

GalleryEntity::delete()

Delete this GalleryEntity

GalleryEntity::detachLink()

Detach this entity from the entity it is linked to by the simple expedient of overwriting over all non-null members with the equivalent from the link target.

GalleryEntity::getClassName()

Return the case sensitive name of this entity class. This is exactly what get_class() would return in PHP5. PHP4 is case-insensitive though so we must rely on it being set in each entity. The framework uses this as an index into entity related tables.

GalleryEntity::getCreationTimestamp()

GalleryEntity::getEntityType()

GalleryEntity::getId()

GalleryEntity::getIsLinkable()

GalleryEntity::getLinkedEntity()

GalleryEntity::getLinkId()

GalleryEntity::getModificationTimestamp()

GalleryEntity::getOnLoadHandlers()

GalleryEntity::getRenderer()

GalleryEntity::getSerialNumber()

GalleryEntity::hasOnLoadHandler()

Check for an onLoad handler.

GalleryEntity::isLinked()

Return true if this entity is linked to another

GalleryEntity::itemTypeName()

Return the name of this type of item.

GalleryEntity::onLoad()

This is called after an entity is loaded by the GalleryStorage subsystem.

GalleryEntity::onSave()

This is called after an entity is saved by the GalleryStorage subsystem.

GalleryEntity::refresh()

Refresh this item from the persistent store

GalleryEntity::removeOnLoadHandler()

Remove onLoad handler.

GalleryEntity::save()

Save the changes to this GalleryEntity.

GalleryEntity::setCreationTimestamp()

GalleryEntity::setEntityType()

GalleryEntity::setId()

GalleryEntity::setIsLinkable()

GalleryEntity::setLinkedEntity()

GalleryEntity::setLinkId()

GalleryEntity::setModificationTimestamp()

GalleryEntity::setOnLoadHandlers()

GalleryEntity::setSerialNumber()

Inherited From GalleryPersistent

GalleryPersistent::GalleryPersistent()

GalleryPersistent::clearPersistentFlag()

Clear a flag.

GalleryPersistent::getClassFile()

Return the relative path to the class for this entity

GalleryPersistent::getOriginalValue()

Return the original value of the given member.

GalleryPersistent::isModified()

Have we modified any data in this class?

GalleryPersistent::resetOriginalValues()

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

GalleryPersistent::setPersistentFlag()

Set a flag.

GalleryPersistent::testPersistentFlag()

Test a flag.

[ Top ]

Property Summary

string	$groupName	The group name
int	$groupType	The group type

[ Top ]

Method Summary

GalleryStatus	create()	Create a new instance of this GalleryGroup in the persistent store
GalleryStatus	delete()	Delete this GalleryGroup.
void	getClassName()
void	getGroupName()
void	getGroupType()
void	itemTypeName()
void	setGroupName()
void	setGroupType()

[ Top ]

Properties

string $groupName [line 78]

The group name

Information Tags:

G2:	<member-name>groupName</member-name>
G2:	<member>
G2:	<member-type>STRING</member-type>
G2:	<member-size>MEDIUM</member-size>
G2:	<member-external-access>READ</member-external-access>
G2:	<unique/>
G2:	</member>

[ Top ]

int $groupType [line 64]

The group type

Information Tags:

G2:	<member>
G2:	<member-name>groupType</member-name>
G2:	<member-type>INTEGER</member-type>
G2:	<required/>
G2:	</member>

[ Top ]

Methods

create [line 88]

GalleryStatus create(
string
$groupName, [int
$groupType = GROUP_NORMAL] 
)

Create a new instance of this GalleryGroup in the persistent store

Parameters:

string	$groupName:	the name of the new group
int	$groupType:	the type of group

API Tags:

Return:

a status code

Redefinition of:

GalleryEntity::create(): Create a new instance of this GalleryEntity in the persistent store

[ Top ]

delete [line 129]

GalleryStatus delete(
)

Delete this GalleryGroup.

Do some bookkeeping, like removing any user/group mappings.

API Tags:

Return:

a status code

Redefinition of:

GalleryEntity::delete(): Delete this GalleryEntity

[ Top ]

getClassName [line 172]

void getClassName(
)

API Tags:

See:

GalleryEntity::getClassName

Redefinition of:

GalleryEntity::getClassName(): Return the case sensitive name of this entity class. This is exactly what get_class() would return in PHP5. PHP4 is case-insensitive though so we must rely on it being set in each entity. The framework uses this as an index into entity related tables.

[ Top ]

getGroupName [line 184]

void getGroupName(
)

[ Top ]

getGroupType [line 176]

void getGroupType(
)

[ Top ]

itemTypeName [line 159]

void itemTypeName(
[
$localized = true] 
)

Parameters:

$localized:

API Tags:

See:

GalleryEntity::itemTypeName

Redefinition of:

GalleryEntity::itemTypeName(): Return the name of this type of item.

[ Top ]

setGroupName [line 188]

void setGroupName(

$groupName 
)

Parameters:

$groupName:

[ Top ]

setGroupType [line 180]

void setGroupType(

$groupType 
)

Parameters:

$groupType:

[ Top ]

Documentation generated on Fri, 08 Oct 2010 04:59:25 -0700 by phpDocumentor 1.3.0RC6

	GalleryCore Classes

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