Class Horde_Share_Object_sql

Description

Extension of the Horde_Share_Object class for storing share information in the sql driver.

Located in /Share/Share/sql.php (line 925)

Horde_Share_Object
   |
   --Horde_Share_Object_sql
Direct descendents
Class Description
 class Horde_Share_Object_sql_hierarchical Class for storing Share information.
 class Horde_Share_Object_sqlng Extension of the Horde_Share_Object class for storing share information in the Sqlng driver.
Variable Summary
 mixed $data
Method Summary
 Horde_Share_Object_sql Horde_Share_Object_sql (array $data)
 boolean hasPermission (string $userid, integer $permission, [string $creator = null])
 boolean setPermission ( &$perm, [boolean $update = true], Horde_Permission $perm)
 mixed _get (string $attribute)
 string _getId ()
 string _getName ()
 void _save ()
 mixed _set (string $attribute, mixed $value)
Variables
mixed $data = array() (line 932)

The actual storage object that holds the data.

Inherited Variables

Inherited from Horde_Share_Object

Horde_Share_Object::$_shareOb
Methods
Constructor Horde_Share_Object_sql (line 939)

Constructor.

Horde_Share_Object_sql Horde_Share_Object_sql (array $data)
  • array $data: Share data array.
getPermission (line 1185)

Returns the permission of this share.

  • return: Permission object that represents the permissions on this share.
Horde_Permission &getPermission ()

Redefined in descendants as:
hasPermission (line 1151)

Checks to see if a user has a given permission.

  • return: Whether or not $userid has $permission.
boolean hasPermission (string $userid, integer $permission, [string $creator = null])
  • string $userid: The userid of the user.
  • integer $permission: A PERMS_* constant to test for.
  • string $creator: The creator of the event.
setPermission (line 1170)

Sets the permission of this share.

  • return: True if no error occured, PEAR_Error otherwise
boolean setPermission ( &$perm, [boolean $update = true], Horde_Permission $perm)
  • Horde_Permission $perm: Permission object.
  • boolean $update: Should the share be saved after this operation?
  • &$perm

Redefined in descendants as:
_get (line 985)

Returns one of the attributes of the object, or null if it isn't defined.

  • return: The value of the attribute, or an empty string.
mixed _get (string $attribute)
  • string $attribute: The attribute to retrieve.

Redefined in descendants as:
_getId (line 999)

Returns the ID of this share.

  • return: The share's ID.
string _getId ()
_getName (line 1009)

Returns the name of this share.

  • return: The share's name.
string _getName ()

Redefined in descendants as:
_save (line 1017)

Saves the current attribute values.

void _save ()

Redefined in descendants as:
_set (line 968)

Sets an attribute value in this object.

  • return: True if setting the attribute did succeed, a PEAR_Error otherwise.
mixed _set (string $attribute, mixed $value)
  • string $attribute: The attribute to set.
  • mixed $value: The value for $attribute.

Inherited Methods

Inherited From Horde_Share_Object

 Horde_Share_Object::addGroupPermission()
 Horde_Share_Object::addUserPermission()
 Horde_Share_Object::get()
 Horde_Share_Object::getId()
 Horde_Share_Object::getName()
 Horde_Share_Object::listGroups()
 Horde_Share_Object::listUsers()
 Horde_Share_Object::removeGroup()
 Horde_Share_Object::removeGroupPermission()
 Horde_Share_Object::removeUser()
 Horde_Share_Object::removeUserPermission()
 Horde_Share_Object::save()
 Horde_Share_Object::set()
 Horde_Share_Object::setShareOb()
 Horde_Share_Object::__sleep()

Documentation generated on Sun, 30 Jan 2011 05:21:47 +0000 by phpDocumentor 1.4.3