*/
/**
* Load the parent class
*/
GalleryCoreApi::relativeRequireOnce('modules/core/classes/GalleryEntity.class');
/**
* 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.
*
* @g2 GalleryGroup
* @g2 GalleryEntity
* @g2
* @g2 1
* @g2 1
* @g2
* @g2
*
* @package GalleryCore
* @subpackage Classes
*/
class GalleryGroup_core extends GalleryEntity {
/*
* ****************************************
* Members
* ****************************************
*/
/**
* The group type
*
* @g2
* @g2 groupType
* @g2 INTEGER
* @g2
* @g2
*
* @var int $_groupType
* @access private
*/
var $_groupType;
/**
* The group name
*
* @g2
* @g2 groupName
* @g2 STRING
* @g2 MEDIUM
* @g2
* @g2
*
* @var string $_groupName
* @access private
*/
var $_groupName;
/*
* ****************************************
* Methods
* ****************************************
*/
/**
* Create a new instance of this GalleryGroup in the persistent store
*
* @param string the name of the new group
* @param int the type of group
* @return object GalleryStatus a status code
*/
function create($groupName, $groupType=GROUP_NORMAL) {
global $gallery;
/* Check to see if we have a collision */
$query = '
SELECT
[GalleryGroup::id]
FROM
[GalleryGroup]
WHERE
[GalleryGroup::groupName] = ?
';
list($ret, $results) =
$gallery->search($query, array($groupName),
array('limit' => array('count' => 1)));
if ($ret->isError()) {
return $ret->wrap(__FILE__, __LINE__);
}
$result = $results->nextResult();
if ($result[0] > 0) {
return GalleryStatus::error(ERROR_COLLISION, __FILE__, __LINE__);
}
$ret = parent::create();
if ($ret->isError()) {
return $ret->wrap(__FILE__, __LINE__);
}
$this->setGroupName($groupName);
$this->setGroupType($groupType);
return GalleryStatus::success();
}
/**
* Delete this GalleryGroup
*
* Do some bookkeeping, like removing any user/group mappings
*
* @access public
* @return object GalleryStatus a status code
*/
function delete() {
$ret = GalleryCoreApi::removeAllUsersFromGroup($this->getId());
if ($ret->isError()) {
return $ret->wrap(__FILE__, __LINE__);
}
/* Delete all permissions from the permissions map table */
GalleryCoreApi::relativeRequireOnce('modules/core/classes/GalleryAccessMap.class');
$ret = GalleryAccessMap::removeMapEntry(array('groupId' => $this->getId()));
if ($ret->isError()) {
return $ret->wrap(__FILE__, __LINE__);
}
$ret = parent::delete();
if ($ret->isError()) {
return $ret->wrap(__FILE__, __LINE__);
}
return GalleryStatus::success();
}
/**
* @see GalleryEntity::itemTypeName
*/
function itemTypeName($localized = true) {
if ($localized) {
list ($ret, $core) = GalleryCoreApi::loadPlugin('module', 'core');
if (! $ret->isError()) {
return array($core->translate('Group'), $core->translate('group'));
}
}
return array('Group', 'group');
}
}
include(dirname(__FILE__) . '/interfaces/GalleryGroup.inc');
?>