SnapPermissionObject Class Reference
[Permissions Management Objects]

INSERT BRIEF DESCRIPTION HERE. More...

Inheritance diagram for SnapPermissionObject:

[legend]

List of all members.

Public Member Functions
	__construct ($objType, $objId, $ownerType, $ownerId)
	INSERT BRIEF DESCRIPTION HERE.
	getCapability ($cap)
	INSERT BRIEF DESCRIPTION HERE.
	getCapId ($cap)
	INSERT BRIEF DESCRIPTION HERE.
	getId ()
	INSERT BRIEF DESCRIPTION HERE.
	getObjectId ()
	INSERT BRIEF DESCRIPTION HERE.
	getOwnerId ()
	INSERT BRIEF DESCRIPTION HERE.
	getType ()
	INSERT BRIEF DESCRIPTION HERE.
	isCapability ($cap)
	INSERT BRIEF DESCRIPTION HERE.
	setCapability ($cap, $val)
	INSERT BRIEF DESCRIPTION HERE.
Static Public Member Functions
static	getCapabilities ($type=false)
	INSERT BRIEF DESCRIPTION HERE.
static	getCapabilityDescriptions ($type)
	INSERT BRIEF DESCRIPTION HERE.
static	getCapDesc ($type, $cap)
	INSERT BRIEF DESCRIPTION HERE.
static	isCapabilityForType ($type, $cap)
	INSERT BRIEF DESCRIPTION HERE.
static	warmCache ($type, $parId, $ownerType, $ownerId)
	INSERT BRIEF DESCRIPTION HERE.
Protected Member Functions
	populate ($row=null)
	INSERT BRIEF DESCRIPTION HERE.

---

Detailed Description

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Author:

AUTHOR (DATE)

Definition at line 11 of file SnapPermissionObject.php5.

---

Constructor & Destructor Documentation

SnapPermissionObject::__construct	(	$	objType,
		$	objId,
		$	ownerType,
		$	ownerId
	)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

	$objType	[TYPE]: DESCRIPTION
	$objId	[TYPE]: DESCRIPTION
	$ownerType	[TYPE]: DESCRIPTION
	$ownerId	[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 35 of file SnapPermissionObject.php5.

References SnapPermission::CAP_DEFAULT, and populate().

---

Member Function Documentation

static SnapPermissionObject::getCapabilities

(

$

type = false

)

[static]

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

$type

[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 257 of file SnapPermissionObject.php5.

References SnapDBI::freeResult(), SnapDBI::getRow(), SnapDBI::query(), and SObject::setError().

Referenced by SnapPermission::getCapabilities(), SnapPermission::revokeGroup(), and SnapPermission::revokeUser().

SnapPermissionObject::getCapability

(

$

cap

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

$cap

[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 121 of file SnapPermissionObject.php5.

References SObject::setError().

static SnapPermissionObject::getCapabilityDescriptions

(

$

type

)

[static]

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

$type

[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 350 of file SnapPermissionObject.php5.

Referenced by SnapPermission::getCapabilityDescriptions().

static SnapPermissionObject::getCapDesc	(	$	type,
		$	cap
	)			[static]

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

	$type	[TYPE]: DESCRIPTION
	$cap	[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 366 of file SnapPermissionObject.php5.

SnapPermissionObject::getCapId

(

$

cap

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

$cap

[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 335 of file SnapPermissionObject.php5.

SnapPermissionObject::getId

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 64 of file SnapPermissionObject.php5.

Referenced by SnapResourceUserPermission::retrieve(), SnapResourceGroupPermission::retrieve(), SnapDirectoryUserPermission::retrieve(), SnapDirectoryGroupPermission::retrieve(), and warmCache().

SnapPermissionObject::getObjectId

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 86 of file SnapPermissionObject.php5.

SnapPermissionObject::getOwnerId

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 97 of file SnapPermissionObject.php5.

SnapPermissionObject::getType

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 75 of file SnapPermissionObject.php5.

SnapPermissionObject::isCapability

(

$

cap

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

$cap

[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 109 of file SnapPermissionObject.php5.

static SnapPermissionObject::isCapabilityForType	(	$	type,
		$	cap
	)			[static]

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

	$type	[TYPE]: DESCRIPTION
	$cap	[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 320 of file SnapPermissionObject.php5.

Referenced by SnapPermission::doCommit().

SnapPermissionObject::populate

(

$

row = null

)

[protected]

INSERT BRIEF DESCRIPTION HERE.

For internal use only.

INSERT FULL DESCRIPTION HERE

Parameters:

$row

[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 156 of file SnapPermissionObject.php5.

References SnapPermission::CAP_ALLOW, SnapPermission::CAP_DEFAULT, SnapPermission::CAP_DENY, SnapDBI::freeResult(), SnapDBI::getRow(), SnapDBI::query(), and SObject::setError().

Referenced by __construct().

SnapPermissionObject::setCapability	(	$	cap,
		$	val
	)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

	$cap	[TYPE]: DESCRIPTION
	$val	[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 139 of file SnapPermissionObject.php5.

References SObject::setError().

static SnapPermissionObject::warmCache	(	$	type,
		$	parId,
		$	ownerType,
		$	ownerId
	)			[static]

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

	$type	[TYPE]: DESCRIPTION
	$parId	[TYPE]: DESCRIPTION
	$ownerType	[TYPE]: DESCRIPTION
	$ownerId	[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 210 of file SnapPermissionObject.php5.

References SnapDBI::freeResult(), SnapCache::getById(), getId(), SnapDBI::getRow(), SnapCache::putById(), and SnapDBI::query().

---

The documentation for this class was generated from the following file:

• snap2/perm/SnapPermissionObject.php5