The Horde_Perms_Sql:: class provides a SQL driver for the Horde
permissions system.
Copyright 2008-2012 Horde LLC (http://www.horde.org/)
See the enclosed file COPYING for license information (LGPL). If you
did not receive this file, see http://www.horde.org/licenses/lgpl21.
Methods summary
public
|
#
__construct( array $params = array() )
Constructor.
Parameters
- $params
- <p>Configuration parameters (in addition to base
Horde_Perms parameters):</p>
<pre><span class="php-quote">'db'</span> - (Horde_Db_Adapter) [REQUIRED] The DB instance.
<span class="php-quote">'table'</span> - (string) The name of the perms table.
<span class="php-keyword1">DEFAULT</span>: <span class="php-quote">'horde_perms'</span></pre>
Throws
Overrides
|
public
Horde_Perms_Permission_Sql
|
#
newPermission( string $name, string $type = 'matrix', array $params = null )
Returns a new permissions object.
Returns a new permissions object.
Parameters
- $name
- The permission's name.
- $type
- The permission type.
- $params
- The permission parameters.
Returns
Throws
|
public
Horde_Perms_Permission_Sql
|
#
getPermission( string $name )
Returns an object corresponding to the named permission, with the
users and other data retrieved appropriately.
Returns an object corresponding to the named permission, with the
users and other data retrieved appropriately.
Parameters
- $name
- The name of the permission to retrieve.
Returns
Throws
Throw
Horde_Perms_Exception
|
public
Horde_Perms_Permission_Sql
|
#
getPermissionById( integer $id )
Returns a permission object corresponding to the given unique ID,
with the users and other data retrieved appropriately.
Returns a permission object corresponding to the given unique ID,
with the users and other data retrieved appropriately.
Parameters
- $id
- The unique ID of the permission to retrieve.
Returns
Throws
|
public
integer
|
#
addPermission( Horde_Perms_Permission $perm )
Adds a permission to the permissions system. The permission must first
be created with newPermission(), and have any initial users added to
it, before this function is called.
Adds a permission to the permissions system. The permission must first
be created with newPermission(), and have any initial users added to
it, before this function is called.
Parameters
Returns
integer
Permission ID in the database.
Throws
|
public
boolean
|
#
removePermission( Horde_Perms_Permission $perm, boolean $force = false )
Removes a permission from the permissions system permanently.
Removes a permission from the permissions system permanently.
Parameters
- $perm
- <p>The permission to
remove.</p>
- $force
- <p>Force to remove every
child.</p>
Returns
boolean
True if permission was deleted.
Throws
|
public
integer
|
#
getPermissionId( Horde_Perms_Permission_Sql $permission )
Returns the unique identifier of this permission.
Returns the unique identifier of this permission.
Parameters
- $permission
- <p>$perm The permission object to
get the ID of.</p>
Returns
integer
The unique id.
Throws
|
public
boolean
|
#
exists( string $permission )
Checks if a permission exists in the system.
Checks if a permission exists in the system.
Parameters
- $permission
- The permission to check.
Returns
boolean
True if the permission exists.
Throws
|
public
integer
|
#
getParent( mixed $child )
Returns a child's direct parent ID.
Returns a child's direct parent ID.
Parameters
- $child
- <p>The object name for which to look up the parent's
ID.</p>
Returns
integer
The unique ID of the parent.
Throws
|
public
array
|
#
getParents( string $child )
Returns a list of parent permissions.
Returns a list of parent permissions.
Parameters
- $child
- The name of the child to retrieve parents for.
Returns
array
A hash with all parents in a tree format.
Throws
|
public
array
|
#
getTree( )
Returns all permissions of the system in a tree format.
Returns all permissions of the system in a tree format.
Returns
array
A hash with all permissions in a tree format.
Throws
|
Horde_Perms_Sql