Class: NestedSet
- Package: saf.Database
An implementation of the Nested Set algorithm, which allows hierarchies and
trees to be stored efficiently in a relational database table structure.
Usage Example
<?php
$ns = new NestedSet ('table_name');
// create a new collection (you only need to call this once)
$res = $ns->create (array (
'name' => 'char(32) not null',
'position' => 'char(32) not null',
));
if (! $res) {
die ($ns->error);
}
// add a document root (you can have as many as you want)
$res = $ns->addRoot (array (
'id' => 'index',
'name' => 'Employee Directory',
'position' => '',
));
if (! $res) {
die ($ns->error);
}
// omitting error checking from here down
// add some items
$ns->add ('index', array (
'id' => 'joe_smith',
'name' => 'Joe Smith',
'position' => 'Boss',
));
$ns->add ('joe_smith', array (
'id' => 'sam_jones',
'name' => 'Samantha Jones',
'position' => 'Assistant',
));
// view the path to sam_jones
info ($ns->path ('sam_jones'));
// delete joe_smith
$ns->delete ('joe_smith');
// promote sam_jones
$ns->edit ('sam_jones', array (
'position' => 'Boss',
));
?>
Properties
$connection
- Access: public
The current connection resource.
$path
- Access: public
Path to the Berkeley Database.
$mode
- Access: public
Mode to use when opening the database (corresponds to
the modes available to the dba_open () function.
$handler
- Access: public
The database implementation used (db2, db3, gdbm, etc.).
$persistent
- Access: public
A 1 or 0 (true or false, and true by default), specifying whether
to establish a persistent connection or not.
$transactions = 0
- Access: public
Boolean value denoting whether to enable transactions in the
current database.
$driver
- Access: public
Contains the name of the database driver being used.
$host
- Access: public
Contains the name of the database host.
$name
- Access: public
Contains the name of the database being used.
$user
- Access: public
Contains the username used to connect to the current database.
$pass
- Access: public
Contains the password used to connect to the current database.
$dbd
- Access: private
Contains the loaded database driver.
$error
- Access: public
Error message, in case of error.
$sql = ''
- Access: public
Contains the SQL query to be executed.
$rows
- Access: public
Contains the number of rows returned by the previous fetch() call.
$lastid
- Access: public
Contains the lastid() of the last insert query sent to the execute()
method.
$tables = false
- Access: public
Contains a list of tables in the database. Set by getTables().
$pearEmu = false
$sequenceFormat = '%s_seq'
$fetchMode = DB_FETCHMODE_OBJECT
$result = ''
- Access: public
Contains the result identifier for the current execution.
$field = ''
- Access: public
Currently unused.
$_fetchModeFunctions = array (
DB_FETCHMODE_ASSOC => 'mysql_fetch_array',
DB_FETCHMODE_OBJECT => 'mysql_fetch_object',
)
DB_FETCHMODE_ASSOC => 'mysql_fetch_array',
DB_FETCHMODE_OBJECT => 'mysql_fetch_object',
)
$typemap = array (
'bpchar' => 'text',
'char' => 'text',
'varchar' => 'text',
'text' => 'textarea',
'date' => 'date',
'time' => 'time',
'timestamp' => 'datetime',
'.*' => 'text',
// arrays
// booleans
// blobs
)
'bpchar' => 'text',
'char' => 'text',
'varchar' => 'text',
'text' => 'textarea',
'date' => 'date',
'time' => 'time',
'timestamp' => 'datetime',
'.*' => 'text',
// arrays
// booleans
// blobs
)
- Access: public
Contains a key/value list of database types (regular
expressions are used here to save repeating ourselves) and their
corresponding MailForm widget types.
$column
- Access: public
Column name of the facet.
$title
- Access: public
Dispaly name of the facet.
$extra
- Access: public
Extra info about the facet.
$tableObj
- Access: public
DatabaseTable object.
$items = array ()
- Access: public
List of options in the facet.
$type = 'normal'
- Access: public
Type of the facet. Possible values are 'normal', 'self_ref', 'date', and 'time'.
This value is auto-determined by compile(), but can be customized as well.
$table
- Access: public
Table name.
$fields = array ()
- Access: public
Field list.
$pkey = ''
Primary key field.
$fkey = ''
Optional name of a foreign key field, for use in simplified find() calls.
$listFields = '*'
The list of fields to return on find(). Default is '*' to return all fields.
$isAuto = true
Whether the pkey is auto-incrementing or not.
$orderBy = ''
Contains the "order by" clause value (ie. "name asc") for calls to find().
$groupBy = ''
Contains the "group by" clause value (ie. "name asc") for calls to find().
$limit = false
Contains the "limit" clause value for calls to find().
$offset = false
Contains the "offset" clause value for calls to find().
$invalid = array ()
A list of invalid fields and their corresponding error messages,
from the previous validate() call.
$usePermissions = false
Determines whether to automatically add access control to find(), count(),
and get() calls.
$multilingual = false
Enables automatic translation of items pulled from the database through
Sitellite's new multilingual capabilities.
$_cascade = array ()
This is the list of external types to cascade deletions across. In the
case of external objects, the keys are the object names and the values
are the referencing field in the external object's table. In the case
of join tables for many-to-many relationships, the keys are simply
numeric and the value is an array containing the join table name and the
name of the field referring to the current object's primary key field.
Ordinarily, these values are set automatically via the load() method,
and the relationships are defined in an INI file.
$server
- Access: public
The name of the server to connect to.
$port
- Access: public
The port to use to connect to the server.
$rdn
- Access: public
The rdn (username, essentially) to use to bind to
the connection.
$password
- Access: public
The password to use to bind to the connection.
$secure
- Access: public
Whether to use TLS for LDAP connections.
$resource
- Access: public
The current search resource.
$firstCalled
- Access: public
Says whether or not the first search result entry has
been returned.
$errno
- Access: public
The errno of the previous error.
$connections = array ()
- Access: public
Connection list.
$current
- Access: public
Active tree root ID.
$key
- Access: public
Primary key field name.
$root
- Access: public
Root field name.
$left
- Access: public
Left field name.
$right
- Access: public
Right field name.
$order
- Access: public
Sorting order field name.
$level
- Access: public
Level field name.
$indexes = array ()
- Access: public
Index list.
Methods
NestedSet ($table = 'sitellite_page', $key = 'id', $root = 'ns_root', $left = 'ns_left', $right = 'ns_right', $order = 'ns_order', $level = 'ns_level')
- Access: public
Constructor method. If your table was created by this class, then you
probably only need to specify the $table and $key.
create ($fields = array ())
- Access: public
- Return: boolean
Creates a new table with the specified fields (not including the nested
set-specific fields (ns_root, ns_left, etc.
root ($val = false)
- Access: public
- Return: string
Gets or sets the current root node. Gets the root if $val is
false, and sets it if it's not, returning the previous root
in this case.
addRoot ($values = array (), $setCurrent = true)
- Access: public
- Return: boolean
Adds a new root node to the tree.
add ($pid, $values = array ())
- Access: public
- Return: boolean
Adds a new node (aka item) to the tree.
edit ($id, $newValues = array ())
- Access: public
- Return: boolean
Modifies the specified item.
delete ($id, $recursive = false)
- Access: public
- Return: boolean
Removes the specified node (item). If $recursive is true
then it also removes all nodes below the specified node.
move ($id, $newParentId)
- Access: public
- Return: boolean
Moves the specified node (item) to under the specified parent ID.
rename ($id, $newId)
- Access: public
- Return: boolean
Renames the specified node (item).
get ($id, $fields = array ())
- Access: public
- Return: object
Retrieves the specified node. $fields allows you to optionally specify
which fields you want to retrieve. If left empty, it returns all of
them.
getRoots ($fields = array ())
- Access: public
- Return: array of objects
Retrieves all of the root nodes. $fields allows you to optionally specify
which fields you want to retrieve. If left empty, it returns all of
them.
find ($queries = array (), $fields = array (), $limit = 0, $offset = 0, $orderBy = false, $sort = 'ASC', $count = false)
- Access: public
- Return: array of objects
Performs a search on the tree. $fields allows you to optionally specify
which fields you want to retrieve. If left empty, it returns only the
key field.
siblings ($id)
- Access: public
- Return: array
Returns an array of the IDs of the sibling nodes of the specified node.
children ($id, $recursive = false)
- Access: public
- Return: array
Returns an array of the IDs of the child nodes of the specified node.
If $recursive is set to true, then the sorting is done by the ns_left
field instead of ns_order, so that the nodes are returned in the order
of the parents to which they belong.
path ($id, $fields = array ())
- Access: public
- Return: array of objects
Returns an array of the parent nodes of the specified node. This is
also known as a breadcrumb trail.
parent ($id, $fields = array ())
- Access: public
- Return: object
Returns the parent nodes of the specified node.
isParent ($pid, $id)
- Access: public
- Return: boolean
Checks whether $pid is a parent of $id.
_fields ($fields, $else = '*')
- Access: private
_where ($queries)
- Access: private
_set ($set)
- Access: private
_addRightNode ($sid, $values)
- Access: private