[Horde_Share] element index

Package indexes

All elements
a c d e g h i k l n r s u _
_
top
Variable $_app
Horde_Share::$_app in Share.php
The application we're managing shares for.
Variable $_availablePermissions
A list of available permission.
Variable $_cache
A cache of all shares that have been retrieved, so we don't hit the backend again and again for them.
Variable $_data
A cache for the share attributes.
Variable $_datatree
Pointer to a DataTree instance to manage/store shares
Variable $_db
Handle for the current database connection.
Variable $_folder
The Kolab folder this share is based on.
Variable $_folder_name
The Kolab folder name.
Variable $_list
Our Kolab folder list handler
Variable $_list
Our Kolab folder list handler
Variable $_listcache
Cache used for listShares().
Variable $_listCacheValidity
A marker for the validity of the list cache
Variable $_params
SQL connection parameters
Variable $_root
Horde_Share::$_root in Share.php
The root of the Share tree.
Variable $_shareMap
Id-name-map of already cached share objects.
Variable $_shareOb
The Horde_Share object which this share came from - needed for updating data in the backend to make changes stick, etc.
Variable $_shareObject
The Horde_Share_Object subclass to instantiate objects as
Variable $_shareObject
The Horde_Share_Object subclass to instantiate objects as
Variable $_shareObject
The Horde_Share_Object subclass to instantiate objects as
Variable $_shareObject
The Horde_Share_Object subclass to instantiate objects as
Variable $_sortList
A list of objects that we're currently sorting, for reference during the sorting algorithm.
Variable $_table
Main share table for the current scope.
Variable $_type
The share type
Variable $_write_db
Handle for the current database connection, used for writing. Defaults to the same handle as $db if a separate write database is not required.
Method _addShare
Adds a share to the shares system.
Method _addShare
Adds a share to the shares system.
Method _addShare
Adds a share to the shares system.
Method _buildPermsFromRow
Builds a list of permission bit masks from the "perm" column.
Method _buildPermsFromRow
Builds a list of permission bit masks from all columns in a data row prefixed with "perm_".
Method _connect
Attempts to open a connection to the sql server.
Method _countShares
Returns the number of shares that $userid has access to.
Method _countShares
Returns the number of shares that $userid has access to.
Method _countShares
Returns the number of shares that $userid has access to.
Method _exists
Checks if a share exists in the system.
Method _exists
Checks if a share exists in the system.
Method _exists
Checks if a share exists in the system.
Method _folderError
Return a standard error in case the share has not been correctly initialized.
Method _fromAttributes
Takes in a list of attributes from the backend and maps it to our internal data array.
Method _fromDriverCharset
Utility function to convert from the SQL server's charset.
Method _get
Returns one of the attributes of the object, or null if it isn't defined.
Method _get
Returns an attribute value from this object.
Method _get
Returns one of the attributes of the object, or null if it isn't defined.
Method _get
Returns one of the attributes of the object, or null if it isn't defined.
Method _getId
Returns the ID of this share.
Method _getId
Returns the ID of this share.
Method _getId
Returns the ID of this share.
Method _getName
Returns the name of this share.
Method _getName
Returns the name of this share.
Method _getName
Hierarchical shares do not have share names.
Method _getName
Returns the name of this share.
Method _getPermsCriteria
Builds an ANDed criteria snippet for a set or permissions.
Method _getShare
Returns a Horde_Share_Object_sql object corresponding to the given share name, with the details retrieved appropriately.
Method _getShare
Returns a Horde_Share_Object_kolab object of the request folder.
Method _getShare
Returns a Horde_Share_Object_datatree object corresponding to the given share name, with the details retrieved appropriately.
Method _getShareById
Returns a Horde_Share_Object_datatree object corresponding to the given unique ID, with the details retrieved appropriately.
Method _getShareById
Returns a Horde_Share_Object_sql object corresponding to the given unique ID, with the details retrieved appropriately.
Method _getShareById
Returns a Horde_Share_Object_kolab object of the requested folder.
Method _getShareCriteria
Returns an array of criteria for querying shares.
Method _getShareCriteria
Returns an array of criteria for querying shares.
Method _getShareCriteria
Returns an array of criteria for querying shares.
Method _getShareCriteria
Returns a criteria statement for querying shares.
Method _getShareGroups
Get groups permissions
Method _getSharePerms
Method _getSharePerms
Converts the permissions from the database table format into the Horde_Share format.
Method _getShares
Returns an array of Horde_Share_Object_sql objects corresponding to the given set of unique IDs, with the details retrieved appropriately.
Method _getShares
Returns an array of Horde_Share_Object_datatree objects corresponding to the given set of unique IDs, with the details retrieved appropriately.
Method _getShares
Returns an array of Horde_Share_Object_kolab objects corresponding to the requested folders.
Method _getShares
Returns an array of Horde_Share_Object_sql objects corresponding to the given set of unique IDs, with the details retrieved appropriately.
Method _getShareUsers
Get users permissions
Method _getUserAndGroupShares
Returns the records and share IDs from the user and group tables that match the search criteria.
Method _hasGroups
Finds out if the share has user set
Method _hasUsers
Finds out if the share has user set
Method _listAllShares
Lists *all* shares for the current app/share, regardless of permissions.
Method _listAllShares
Lists *all* shares for the current app/share, regardless of permissions.
Method _listAllShares
Lists *all* shares for the current app/share, regardless of permissions.
Method _listShares
Returns an array of all shares that $userid has access to.
Method _listShares
Returns an array of all shares that $userid has access to.
Method _loadPermissions
Helper function to load the permissions data into the share data
Method _newShare
Returns a new share object.
Method _newShare
Returns a new share object.
Method _newShare
Returns a new share object.
Method _newShare
Returns a new share object.
Method _removeShare
Removes a share from the shares system permanently.
Method _removeShare
Removes a share from the shares system permanently.
Method _removeShare
Removes a share from the shares system permanently.
Method _save
Saves the current attribute values.
Method _save
Saves the current attribute values.
Method _save
Saves the current attribute values.
Method _save
Saves the current attribute values.
Method _selectDB
Resets the current database name so that MDB2 is always selecting the database before sending a query.
Method _set
Sets an attribute value in this object.
Method _set
Sets an attribute value in this object.
Method _set
Sets an attribute value in this object.
Method _setAvailablePermissions
Populates the $availablePermissions property with all seen permissions.
Method _sortShares
Utility function to be used with uasort() for sorting arrays of Horde_Share objects.
Method _toAttributes
Maps this object's attributes from the data array into a format that we can store in the attributes storage backend.
Method _toDriverCharset
Utility function to convert TO the SQL server's charset.
Method _toDriverKeys
Convert an array keyed on client keys to an array keyed on the driver keys.
Method __sleep
Returns the properties that need to be serialized.
Method __sleep
Returns the properties that need to be serialized.
Method __sleep
Returns the properties that need to be serialized.
Method __sleep
Returns the properties that need to be serialized.
Method __sleep
Returns the properties that need to be serialized.
Method __sleep
Returns the properties that need to be serialized.
Method __wakeup
Initializes the object.
Method __wakeup
Initializes the object.
Method __wakeup
Initializes the object.
Method __wakeup
Initializes the object.
Method __wakeup
Initializes the object.
a
top
Variable $availablePermissions
A list of available permission.
Method addGroupPermission
Gives a group certain privileges for this share.
Method addShare
Adds a share to the shares system.
Method addUserPermission
Gives a user a certain privilege for this share.
c
top
Method convertBitmaskToArray
Converts a bit mask number to a bit mask array.
Method countChildren
Return a count of the number of children this share has
Method countOwners
Count the number of users who have shares with the given permissions for the current user.
Method countShares
Returns the count of all shares that $userid has access to.
Method countShares
Returns the number of shares that $userid has access to.
Method countShares
Returns the number of shares that $userid has access to.
d
top
Variable $data
The actual storage object that holds the data.
Variable $datatreeObject
The actual storage object that holds the data.
Class DataTreeObject_Share
DataTreeObject_Share in datatree.php
Extension of the DataTreeObject class for storing Share information in the DataTree driver. If you want to store specialized Share information, you should extend this class instead of extending DataTreeObject directly.
Method delete
Delete this share.
Page datatree.php
datatree.php in datatree.php
e
top
Method exists
Checks if a share exists in the system.
g
top
Method get
Returns an attribute value from this object.
Method getChildren
Get all children of this share.
Method getDefaultShare
Create a default share for the current app
Method getDefaultShareName
Returns the default share name for the current application.
Method getId
Returns the ID of this share.
Method getIdentityByShare
Returns the Identity for a particular share owner.
Method getName
Returns the name of this share.
Method getParent
Returns a share's direct parent object.
Method getParent
Returns a child's direct parent
Method getParents
Get all of this share's parents.
Method getPermission
Returns the permissions from this storage object.
Method getPermission
Returns the permission of this share.
Method getPermission
Returns the permission of this share.
Method getPermission
Returns the permission of this share.
Method getPermissions
Finds out what rights the given user has to this object.
Method getShare
Override the Horde_Share base class to avoid any confusion
Method getShare
Returns a Horde_Share_Object object corresponding to the given share name, with the details retrieved appropriately.
Method getShareById
Returns a Horde_Share_Object object corresponding to the given unique ID, with the details retrieved appropriately.
Method getShareById
Returns a Horde_Share_Object object corresponding to the given unique ID, with the details retrieved appropriately.
Method getShares
Returns an array of Horde_Share_Object objects corresponding to the given set of unique IDs, with the details retrieved appropriately.
Method getShares
Returns an array of Horde_Share_Object objects corresponding to the given set of unique IDs, with the details retrieved appropriately.
Method getTable
Get storage table
Method getWriteDb
Refetence to write db
h
top
Method hasPermission
Checks to see if a user has a given permission.
Method hasPermission
Checks to see if a user has a given permission.
Method hasPermission
Checks to see if a user has a given permission.
Class Horde_Share
Horde_Share in Share.php
Horde_Share:: provides an interface to all shares a user might have. Its methods take care of any site-specific restrictions configured in in the application's prefs.php and conf.php files.
Method Horde_Share
Constructor.
Class Horde_Share_datatree
Horde_Share_datatree in datatree.php
Horde_Share_datatree:: provides the datatree backend for the horde share driver.
Class Horde_Share_kolab
Horde_Share_kolab in kolab.php
Horde_Share_kolab:: provides the kolab backend for the horde share driver.
Class Horde_Share_Object
Horde_Share_Object in Share.php
Abstract class for storing Share information.
Method Horde_Share_Object_datatree
Constructor.
Class Horde_Share_Object_datatree
Extension of the Horde_Share_Object class for storing share information in the DataTree driver.
Method Horde_Share_Object_kolab
Constructor.
Class Horde_Share_Object_kolab
Extension of the Horde_Share_Object class for handling Kolab share information.
Class Horde_Share_Object_sql
Extension of the Horde_Share_Object class for storing share information in the sql driver.
Method Horde_Share_Object_sql
Constructor.
Method Horde_Share_Object_sqlng
Constructor.
Class Horde_Share_Object_sqlng
Extension of the Horde_Share_Object class for storing share information in the Sqlng driver.
Method Horde_Share_Object_sql_hierarchical
Constructor. This is here primarily to make calling the parent constructor(s) from any subclasses cleaner.
Class Horde_Share_Object_sql_hierarchical
Horde_Share_Object_sql_hierarchical in sql_hierarchical.php
Class for storing Share information.
Class Horde_Share_sql
Horde_Share_sql in sql.php
Method Horde_Share_sqlng
Class Horde_Share_sqlng
Horde_Share_sqlng in sqlng.php
Constant HORDE_SHARE_SQL_FLAG_GROUPS
The share has group permissions
Constant HORDE_SHARE_SQL_FLAG_USERS
The share has user permissions
Class Horde_Share_sql_hierarchical
Horde_Share_sql_hierarchical in sql_hierarchical.php
i
top
Method inheritPermissions
Method initShareObject
Passes the available permissions to the share object.
k
top
Page kolab.php
kolab.php in kolab.php
l
top
Method listAllShares
Lists *all* shares for the current app/share, regardless of permissions.
Method listAllShares
Lists *all* shares for the current app/share, regardless of permissions.
Method listGroups
Returns an array containing all the groupids of the groups with access to this share.
Method listOwners
Return a list of users who have shares with the given permissions for the current user.
Method listShares
Returns an array of all shares that $userid has access to.
Method listShares
Returns an array of all shares that $userid has access to.
Method listShares
Returns an array of all shares that $userid has access to.
Method listShares
Returns an array of all shares that $userid has access to.
Method listUsers
Returns an array containing all the userids of the users with access to this share.
n
top
Method newShare
Override new share creation so we can allow for shares with empty share_names.
Method newShare
Returns a new share object.
r
top
Method removeGroup
Removes a group from this share.
Method removeGroupPermission
Removes a certain privilege from a group.
Method removeShare
Removes a share from the shares system permanently. This will recursively delete all child shares as well.
Method removeShare
Removes a share from the shares system permanently.
Method removeUser
Removes a user from this share.
Method removeUserPermission
Removes a certain privilege for a user from this share.
s
top
Method save
Saves the current attribute values.
Method serialize
Serialize this object.
Method set
Sets an attribute value in this object.
Method setFolder
Sets the folder for this storage object.
Method setParent
Set the parent object for this share.
Method setPermission
Sets the permissions on the share.
Method setPermission
Sets the permission of this share.
Method setPermission
Sets the permission of this share.
Method setPermission
Sets the permission of this share.
Method setShareOb
Associates a Share object with this share.
Method setShareOb
Associates a Share object with this share.
Page sql.php
sql.php in sql.php
Page sqlng.php
sqlng.php in sqlng.php
Page sql_hierarchical.php
sql_hierarchical.php in sql_hierarchical.php
Page Share.php
Share.php in Share.php
Method shutdown
Stores the object in the session cache.
Method singleton
Attempts to return a reference to a concrete Horde_Share instance.
u
top
Method unserialize
Reconstruct the object from serialized data.
a c d e g h i k l n r s u _