[Horde_DataTree] element index

Package indexes

All elements
a b c d e f g m n o r s u _
_
top
Variable $_attributeCache
Cache of attributes for any objects created during this page request.
Variable $_data
DataTree::$_data in DataTree.php
Array of all data: indexed by id. The format is: array(id => 'name' => name, 'parent' => parent).
Variable $_dataCache
Cache of data for any objects created during this page request.
Variable $_db
Handle for the current database connection, used for reading.
Variable $_nameMap
DataTree::$_nameMap in DataTree.php
A hash that can be used to map a full object name (parent:child:object) to that object's unique ID.
Variable $_params
DataTree::$_params in DataTree.php
Hash containing connection parameters.
Variable $_sortHash
DataTree::$_sortHash in DataTree.php
Actual attribute sorting hash.
Variable $_tableCount
The number of copies of the horde_datatree_attributes table that we need to join on in the current query.
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 _add
DataTree::_add() in DataTree.php
Add an object.
Method _buildAttributeQuery
Builds a piece of an attribute query.
Method _cmp
DataTree::_cmp() in DataTree.php
Sort two objects by their order field, and if that is the same, alphabetically (case insensitive) by name.
Method _cmpSorted
DataTree::_cmpSorted() in DataTree.php
Sorts two objects by their sorter hash field.
Method _defineObjectClass
Dynamically determines the object class.
Method _exists
Check for existance of an object in a backend-specific manner.
Method _exists
Check for existance of an object in a backend-specific manner.
Method _extractOneLevel
Extract one level of data for a parent leaf, sorted first by their order and then by name. This function is a way to get a collection of $leaf's children.
Method _getAlias
Get an alias to horde_datatree_attributes, incrementing it if necessary.
Method _getId
Look up a datatree id by name.
Method _getId
Look up a datatree id by name.
Method _getName
Look up a datatree name by id.
Method _getName
Look up a datatree name by id.
Method _init
Attempts to open a connection to the SQL server.
Method _init
Init the object.
Method _reorder
DataTree::_reorder() in DataTree.php
Change order of children of an object.
a
top
Method add
Adds an object.
Method add
Add an object. Part of the DataTree API that must be overridden by subclasses.
Method add
DataTree::add() in DataTree.php
Adds an object.
b
top
Method buildAttributeQuery
Builds an attribute query. Here is an example $criteria array:
c
top
Method count
DataTree::count() in DataTree.php
Counts objects.
Method countByAttributes
Returns the number of objects matching a set of attribute criteria.
Method countByAttributes
Returns the number of objects matching a set of attribute criteria.
Method countByAttributes
Returns the number of objects matching a set of attribute criteria.
Method countValuesByAttributes
Returns the number of all of the available values matching the given criteria. Either attribute_name or attribute_key MUST be supplied, and both MAY be supplied.
d
top
Variable $data
DataTreeObject::$data in DataTree.php
Key-value hash that will be serialized.
Variable $datatree
This object's DataTree instance.
Method DataTree
DataTree::DataTree() in DataTree.php
Constructor.
Class DataTree
DataTree in DataTree.php
The DataTree:: class provides a common abstracted interface into the various backends for the Horde DataTree system.
Page DataTree.php
DataTree.php in DataTree.php
Method DataTreeObject
DataTreeObject constructor.
Class DataTreeObject
DataTreeObject in DataTree.php
Class that can be extended to save arbitrary information as part of a stored object.
Constant DATATREE_BUILD_COUNT
DATATREE_BUILD_COUNT in DataTree.php
Build a count only query.
Constant DATATREE_BUILD_SELECT
DATATREE_BUILD_SELECT in DataTree.php
Build a normal select query.
Constant DATATREE_BUILD_VALUES
DATATREE_BUILD_VALUES in DataTree.php
Build an attribute only query.
Constant DATATREE_BUILD_VALUES_COUNT
Constant DATATREE_FORMAT_FLAT
DATATREE_FORMAT_FLAT in DataTree.php
Get a full list - an array of keys.
Constant DATATREE_FORMAT_TREE
DATATREE_FORMAT_TREE in DataTree.php
List every object in an array, similar to PEAR/html/menu.php.
Class DataTree_null
DataTree_null in null.php
The DataTree_null:: class provides a dummy implementation of the DataTree:: API; no data will last beyond a single page request.
Constant DATATREE_ROOT
DATATREE_ROOT in DataTree.php
The root element (top-level parent) of each DataTree group.
Class DataTree_sql
DataTree_sql in sql.php
The DataTree_sql:: class provides an SQL implementation of the Horde DataTree system.
Method delete
DataTreeObject::delete() in DataTree.php
Delete this object from the backend permanently.
e
top
Method encodeName
DataTree::encodeName() in DataTree.php
Replace all occurences of ':' in an object name with '.'.
Method exists
DataTree::exists() in DataTree.php
Check if an object exists or not. The root element DATATREE_ROOT always exists.
f
top
Method factory
DataTree::factory() in DataTree.php
Attempts to return a concrete DataTree instance based on $driver.
g
top
Method get
DataTree::get() in DataTree.php
Export a list of objects.
Method get
DataTreeObject::get() in DataTree.php
Gets one of the attributes of the object, or null if it isn't defined.
Method getAttributes
Retrieves data for an object from the horde_datatree_attributes table.
Method getAttributes
Retrieve data for an object.
Method getAttributes
Retrieve data for an object from the horde_datatree_attributes table.
Method getAttributeValues
Returns a list of all of the available values of the given attribute name/key combination. Either attribute_name or attribute_key MUST be supplied, and both MAY be supplied.
Method getAttributeValues
Returns a list of all of the available values of the given attribute name/key combination. Either attribute_name or attribute_key MUST be supplied, and both MAY be supplied.
Method getByAttributes
Returns a set of object ids based on a set of attribute criteria.
Method getByAttributes
Returns a set of object ids based on a set of attribute criteria.
Method getByAttributes
Returns a set of object ids based on a set of attribute criteria.
Method getById
DataTree::getById() in DataTree.php
Export a list of objects just like get() above, but uses an object id to fetch the list of objects.
Method getChild
Returns a child of this object.
Method getData
DataTree::getData() in DataTree.php
Retrieve data for an object from the datatree_data field.
Method getData
Gets the data array.
Method getData
Retrieve data for an object from the datatree_data field.
Method getData
Retrieves data for an object from the datatree_data field.
Method getGroups
DataTree::getGroups() in DataTree.php
Returns a list of all groups (root nodes) of the data tree.
Method getGroups
Returns a list of all groups (root nodes) of the data tree.
Method getId
DataTree::getId() in DataTree.php
Get the id of an object from its name.
Method getId
DataTreeObject::getId() in DataTree.php
Gets the ID of this object.
Method getName
Gets the name of this object.
Method getName
DataTree::getName() in DataTree.php
Get the name of an object from its id.
Method getNumberOfChildren
Get the number of children an object has, only counting immediate children, not grandchildren, etc.
Method getObject
DataTree::getObject() in DataTree.php
Returns a DataTreeObject (or subclass) object of the data in the object defined by $object.
Method getObjectById
Returns a DataTreeObject (or subclass) object of the data in the object with the ID $id.
Method getObjects
DataTree::getObjects() in DataTree.php
Returns an array of DataTreeObject (or subclass) objects corresponding to the objects in $ids, with the object names as the keys of the array.
Method getOrder
DataTree::getOrder() in DataTree.php
Get the order position of an object.
Method getParam
DataTree::getParam() in DataTree.php
Returns a parameter of this DataTree instance.
Method getParent
DataTree::getParent() in DataTree.php
Returns a child's direct parent ID.
Method getParent
Returns this object's parent.
Method getParentById
Get a $child's direct parent ID.
Method getParentIdString
Get a parent ID string (id:cid format) for the specified object.
Method getParentList
Get a list of parents all the way up to the root object for $child.
Method getParents
DataTree::getParents() in DataTree.php
Get a list of parents all the way up to the root object for $child.
Method getShortName
DataTree::getShortName() in DataTree.php
Get the short name of an object, returns only the last portion of the full name. For display purposes only.
Method getShortName
Gets the short name of this object.
Method getSortedTree
Returns a tree sorted by the specified attribute name and/or key.
Method getSortedTree
Returns a tree sorted by the specified attribute name and/or key.
Method getSortedTree
Get a tree sorted by the specified attribute name and/or key.
Method getValuesByAttributes
Returns a list of all of the available values of the given criteria Either attribute_name or attribute_key MUST be supplied, and both MAY be supplied.
m
top
Method move
Move an object to a new parent.
Method move
Move an object to a new parent.
Method move
DataTree::move() in DataTree.php
Move an object to a new parent.
n
top
Variable $name
DataTreeObject::$name in DataTree.php
The unique name of this object.
Page null.php
null.php in null.php
o
top
Variable $order
DataTreeObject::$order in DataTree.php
If this object has ordering data, store it here.
r
top
Method remove
DataTree::remove() in DataTree.php
Removes an object.
Method remove
Removes an object.
Method remove
Removes an object.
Method removeByIds
Remove one or more objects by id. This function does *not* do
Method removeByIds
Removes one or more objects by id.
Method removeByNames
Removes one or more objects by name.
Method removeByNames
Remove one or more objects by name. This function does *not* do
Method removeUserData
Removes all DataTree objects owned by a certain user.
Method rename
Change an object's name.
Method rename
Change an object's name.
Method rename
DataTree::rename() in DataTree.php
Change an object's name.
Method reorder
Changes the order of the children of an object.
Method reorder
Change order of the children of an object.
Method reorder
DataTree::reorder() in DataTree.php
Changes the order of the children of an object.
s
top
Page sql.php
sql.php in sql.php
Method save
DataTreeObject::save() in DataTree.php
Saves any changes to this object to the backend permanently. New objects are added instead.
Method set
DataTreeObject::set() in DataTree.php
Sets one of the attributes of the object.
Method set
DataTree::set() in DataTree.php
Import a list of objects. Used by drivers to populate the internal $_data array.
Method setData
Sets the data array.
Method setDataTree
Sets the DataTree instance used to retrieve this object.
Method setName
Sets the name of this object.
Method setOrder
DataTree::setOrder() in DataTree.php
Explicitly set the order for a datatree object.
Method setOrder
Explicitly set the order for a datatree object.
Method setOrder
Explicitly set the order for a datatree object.
Method setOrder
Sets the order of this object in its object collection.
Method singleton
DataTree::singleton() in DataTree.php
Attempts to return a reference to a concrete DataTree instance based on $driver.
Method sortByAttributes
Sorts IDs by attribute values. IDs without attributes will be added to the end of the sorted list.
Method sortByAttributes
Sorts IDs by attribute values. IDs without attributes will be added to the end of the sorted list.
Method sortByAttributes
Sorts IDs by attribute values. IDs without attributes will be added to the end of the sorted list.
Method sortHash
DataTree::sortHash() in DataTree.php
Create attribute sort hash
u
top
Method updateData
Update the data in an object. Does not change the object's parent or name, just serialized data or attributes.
Method updateData
Update the data in an object. Does not change the object's parent or name, just serialized data.
Method updateData
DataTree::updateData() in DataTree.php
Update the data in an object. Does not change the object's parent or name, just serialized data or attributes.
a b c d e f g m n o r s u _