Class Horde_Share_Object_sql_hierarchical

Description

Class for storing Share information.

Located in /Share/Share/sql_hierarchical.php (line 599)

Horde_Share_Object
   |
   --Horde_Share_Object_sql
      |
      --Horde_Share_Object_sql_hierarchical
Method Summary
 mixed countChildren ([integer $perm = PERMS_SHOW], [boolean $allLevels = true])
 mixed getChildren ([int $perm = PERMS_SHOW], [boolean $allLevels = true])
 mixed getParent ()
 array() getParents ()
 mixed setParent (mixed $parent)
 mixed _get (string $attribute)
 unknown _getName ()
Variables
Methods
Constructor Horde_Share_Object_sql_hierarchical (line 608)

Constructor. This is here primarily to make calling the parent constructor(s) from any subclasses cleaner.

Horde_Share_Object_sql_hierarchical Horde_Share_Object_sql_hierarchical (unknown_type $data)
  • unknown_type $data
countChildren (line 629)

Return a count of the number of children this share has

  • return: The number of child shares || PEAR_Error
mixed countChildren ([integer $perm = PERMS_SHOW], [boolean $allLevels = true])
  • integer $perm: A PERMS_* constant
  • boolean $allLevels: Count grandchildren or just children
getChildren (line 643)

Get all children of this share.

  • return: An array of Horde_Share_Object objects || PEAR_Error
mixed getChildren ([int $perm = PERMS_SHOW], [boolean $allLevels = true])
  • int $perm: PERMS_* constant. If NULL will return all shares regardless of permissions.
  • boolean $allLevels: Return all levels.
getParent (line 655)

Returns a child's direct parent

  • return: The direct parent Horde_Share_Object or PEAR_Error
mixed getParent ()
getParents (line 665)

Get all of this share's parents.

  • return: An array of Horde_Share_Objects
array() getParents ()
getPermission (line 734)

Returns the permission of this share.

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

Redefinition of:
Horde_Share_Object_sql::getPermission()
Returns the permission of this share.
inheritPermissions (line 616)
void inheritPermissions ()
setParent (line 683)

Set the parent object for this share.

  • return: true || PEAR_Error
mixed setParent (mixed $parent)
  • mixed $parent: A Horde_Share object or share id for the parent.
_get (line 752)

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.

Redefinition of:
Horde_Share_Object_sql::_get()
Returns one of the attributes of the object, or null if it isn't defined.
_getName (line 768)

Hierarchical shares do not have share names.

unknown _getName ()

Redefinition of:
Horde_Share_Object_sql::_getName()
Returns the name of this share.

Inherited Methods

Inherited From Horde_Share_Object_sql

 Horde_Share_Object_sql::Horde_Share_Object_sql()
 Horde_Share_Object_sql::getPermission()
 Horde_Share_Object_sql::hasPermission()
 Horde_Share_Object_sql::setPermission()
 Horde_Share_Object_sql::_get()
 Horde_Share_Object_sql::_getId()
 Horde_Share_Object_sql::_getName()
 Horde_Share_Object_sql::_save()
 Horde_Share_Object_sql::_set()

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:22:13 +0000 by phpDocumentor 1.4.3