Element index for package Database

[ a ] [ b ] [ c ] [ d ] [ e ] [ f ] [ g ] [ h ] [ i ] [ k ] [ l ] [ m ] [ n ] [ o ] [ p ] [ q ] [ r ] [ s ] [ t ] [ u ] [ v ] [ _ ]

_

$_cascade: in file Generic.php, variable Generic::$_cascade
This is the list of external types to cascade deletions across. In the
$_fetchModeFunctions: in file MySQL.php, variable MySQL_Query::$_fetchModeFunctions

top

a

$accessfield: in file Table.php, variable DatabaseTable::$accessfield
Contains the column to search for access level values in the Sitellite CMS database manager.
$add_form_message: in file Table.php, variable DatabaseTable::$add_form_message
Contains the message to use for displaying the Add Record form in the Sitellite CMS.
$add_form_template: in file Table.php, variable DatabaseTable::$add_form_template
Contains the template to use for displaying the Add Record form in the Sitellite CMS.
$alt: in file Table.php, variable DatabaseTable::$alt
An alternate name to display for this table, which makes it nicer to read for people. By default the $alt is the $name with underscores converted to spaces and the first letter (of the first word only) capitalized.
abstractSql: in file SQL.php, method SQL::abstractSql()
An alias for the I18n get() method.
abstractSql: in file Database.php, method Database::abstractSql()
Creates an saf.Database.SQL object, which inherits all of its functionality from saf.I18n, and serves as an abstraction layer for database queries.
add: in file PropertySet.php, method PropertySet::add()
Adds the specified property.
add: in file NestedSet.php, method NestedSet::add()
Adds a new node (aka item) to the tree.
add: in file Manager.php, method DBM::add()
Add a new connection.
add: in file Generic.php, method Generic::add()
Inserts a record into the database with the specified values. If $isAuto is set, returns the primary key of the new record.
addFacet: in file Table.php, method DatabaseTable::addFacet()
Creates a "facet" about this widget based on one of its columns. See saf.Database.Facet for more info about those.
addItem: in file Facet.php, method DatabaseFacet::addItem()
Add an item to the list. Used internally by compile().
addRoot: in file NestedSet.php, method NestedSet::addRoot()
Adds a new root node to the tree.
addRule: in file Generic.php, method Generic::addRule()
Adds a MailForm rule that can be used by the validate() method to ensure that any incoming data passes certain "correctness" rules.

top

b

BDB: in file BDB.php, class BDB
BDB is a very minimal wrapper around the Berkeley Database functions in PHP. Its purpose is simply to create an object oriented interface to those functions.
BDB: in file BDB.php, method BDB::BDB()
Constructor Method. Establishes a connection to the database, which can be verified by an if ($dbd->connection) {.
begin: in file PgSQL.php, method PgSQL_Query::begin()
Issues a mysql "begin" statement, beginning a transaction.
begin: in file MySQL.php, method MySQL_Query::begin()
Issues a mysql "begin" statement, beginning a transaction.
bind: in file LDAP.php, method LDAP::bind()
Verifies the $rdn and $password.
BDB.php: procedural page BDB.php

top

c

$collection: in file PropertySet.php, variable PropertySet::$collection
Name of the collection PropertySet should map onto. Usually this is the name of another database table.
$column: in file Facet.php, variable DatabaseFacet::$column
Column name of the facet.
$columns: in file Table.php, variable DatabaseTable::$columns
An array of MailForm widgets created based on the $info data.
$connection: in file MySQL.php, variable MySQL_Driver::$connection
Contains the database connection resource.
$connection: in file PgSQL.php, variable PgSQL_Driver::$connection
Contains the database connection resource.
$connection: in file LDAP.php, variable LDAP::$connection
The current connection resource.
$connection: in file MySQL.php, variable MySQL_Query::$connection
The resource ID for the database connection to be queried.
$connection: in file PgSQL.php, variable PgSQL_Query::$connection
The resource ID for the database connection to be queried.
$connection: in file BDB.php, variable BDB::$connection
This is a Berkeley Database connection resource returned by the dba_open () or dba_popen () function.
$connection: in file Query.php, variable Query::$connection
Contains a local copy of the database connection resource.
$connection: in file Database.php, variable Database::$connection
Contains the database connection resource.
$connections: in file Manager.php, variable DBM::$connections
Connection list.
$current: in file Manager.php, variable DBM::$current
Current connection.
$current: in file NestedSet.php, variable NestedSet::$current
Active tree root ID.
changeType: in file Table.php, method DatabaseTable::changeType()
PLEASE NOTE: This method is deprecated in favour of the built-in changeType() method in the base MF_Widget class.
children: in file NestedSet.php, method NestedSet::children()
Returns an array of the IDs of the child nodes of the specified node.
clear: in file Generic.php, method Generic::clear()
Reset all of the above properties.
close: in file PgSQL.php, method PgSQL_Driver::close()
Disconnects from the database. This method is usually unnecessary since connections should be automatically terminated or should persist after the script finishes executing, depending on your settings.
close: in file MySQL.php, method MySQL_Driver::close()
Disconnects from the database. This method is usually unnecessary since connections should be automatically terminated or should persist after the script finishes executing, depending on your settings.
close: in file LDAP.php, method LDAP::close()
Closes the connection to the server.
close: in file BDB.php, method BDB::close()
Disconnects from the database.
close: in file Database.php, method Database::close()
Disconnects from the database. This method is usually unnecessary since connections should be automatically terminated or should persist after the script finishes executing, depending on your settings.
commit: in file PgSQL.php, method PgSQL_Query::commit()
Issues a mysql "commit" statement, committing the current transaction.
commit: in file MySQL.php, method MySQL_Query::commit()
Issues a mysql "commit" statement, committing the current transaction.
compile: in file Facet.php, method DatabaseFacet::compile()
Compile the facet options from the database.
connect: in file Database.php, method Database::connect()
Connects to the database. A connection is automatically created when a new Database object is created, so there is no need to use this method unless you need to disconnect and reconnect again.
connect: in file PgSQL.php, method PgSQL_Driver::connect()
Establishes a connection with the database
connect: in file LDAP.php, method LDAP::connect()
Connects to the server.
connect: in file MySQL.php, method MySQL_Driver::connect()
Establishes a connection with the database
count: in file Generic.php, method Generic::count()
Returns the number of matches for a given set of parameters. Accepts the same input as find().
create: in file NestedSet.php, method NestedSet::create()
Creates a new table with the specified fields (not including the nested set-specific fields (ns_root, ns_left, etc.
createSequence: in file Database.php, method Database::createSequence()
createSequence: in file MySQL.php, method MySQL_Driver::createSequence()
createSequence: in file PgSQL.php, method PgSQL_Driver::createSequence()

top

d

$datefield: in file Table.php, variable DatabaseTable::$datefield
Contains the column to search for date values in the Sitellite CMS database manager.
$db: in file Table.php, variable DatabaseTable::$db
Contains a reference to the database connection resource.
$driver: in file Database.php, variable Database::$driver
Contains the name of the database driver being used.
Database: in file Database.php, class Database
Database is a database abstraction class; a unified means of accessing different relational database systems. It is accompanied by a second class called Query, and relies on driver classes to provide all the database specific functionality.
Database: in file Database.php, method Database::Database()
Constructor method. Establishes a connection to the specified database system.
DatabaseFacet: in file Facet.php, class DatabaseFacet
A package for generating multi-faceted browsing interfaces for web sites. A facet will look something like this:
DatabaseFacet: in file Facet.php, method DatabaseFacet::DatabaseFacet()
Constructor method.
DatabaseTable: in file Table.php, class DatabaseTable
DatabaseTable is an extension of the Database class, which provides high-level functions, such as fetchAll(), that aim to lessen the need to type common queries out each time you use them.
DatabaseTable: in file Table.php, method DatabaseTable::DatabaseTable()
Constructor method.
Database.php: procedural page Database.php
DBM: in file Manager.php, class DBM
Database connection manager.
DBM: in file Manager.php, method DBM::DBM()
Constructor method.
dbm_add: in file Manager.php, function dbm_add()
Add a new connection. Alias of DBM::add().
dbm_get_current: in file Manager.php, function dbm_get_current()
Retrieves the currently active database object. Alias of DBM::getCurrent().
dbm_remove: in file Manager.php, function dbm_remove()
Remove a connection. Alias of DBM::remove()
dbm_set_current: in file Manager.php, function dbm_set_current()
Set the specified connection to be the currently active one. Alias of DBM::setCurrent().
db_create_sequence: in file Database.php, function db_create_sequence()
db_drop_sequence: in file Database.php, function db_drop_sequence()
db_error: in file Database.php, function db_error()
Returns the error message, if an error occurred during the last query.
db_err_sql: in file Database.php, function db_err_sql()
Returns the erroneous SQL statement, if an error occurred during the last query.
db_execute: in file Database.php, function db_execute()
Similar to db_fetch(), but used for SQL statements that return no
db_fetch: in file Database.php, function db_fetch()
Returns the results of a single database query. Returns false if no results are returned, or on error. Returns an object if there is only one result. Returns an array of objects if there are multiple results.
DB_FETCHMODE_ASSOC: in file Database.php, constant DB_FETCHMODE_ASSOC
DB_FETCHMODE_OBJECT: in file Database.php, constant DB_FETCHMODE_OBJECT
db_fetch_array: in file Database.php, function db_fetch_array()
Same as db_fetch(), except it always returns an array, including
db_fetch_mode: in file Database.php, function db_fetch_mode()
db_get_sequence_name: in file Database.php, function db_get_sequence_name()
db_lastid: in file Database.php, function db_lastid()
Returns the last inserted value from an insert to a table with an auto-incrementing primary key.
db_next_id: in file Database.php, function db_next_id()
db_pairs: in file Database.php, function db_pairs()
Similar to db_shift_array(), except it returns an associative array of the first two columns of the query results, where the first column is the key and the second column is the value.
db_pear_emu: in file Database.php, function db_pear_emu()
db_query: in file Database.php, function db_query()
Alias of the query() method above.
db_quote: in file Database.php, function db_quote()
Returns the specified string as a value quoted and ready for insertion into an SQL statement. This is called automatically on bind values.
db_rows: in file Database.php, function db_rows()
Returns the number of rows from the last executed query.
db_shift: in file Database.php, function db_shift()
Similar to db_shift(), but only returns the first column of the first result. Returns false on error or if there are no results.
db_shift_array: in file Database.php, function db_shift_array()
Same as db_fetch_array(), except it returns an array of the first value of each object (like db_shift() does for a single result).
db_single: in file Database.php, function db_single()
Similar to db_fetch(), but only returns a single result as an object, even if there are multiple results. Returns false on error or if there are no results.
db_table: in file Database.php, function db_table()
Alias of the table() method above.
delete: in file Table.php, method DatabaseTable::delete()
Creates an DELETE query from the key value or values provided.
delete: in file BDB.php, method BDB::delete()
Deletes a record from the database.
delete: in file PropertySet.php, method PropertySet::delete()
Deletes the specified property, or all properties for the current entity, if $properties is unspecified.
delete: in file NestedSet.php, method NestedSet::delete()
Removes the specified node (item). If $recursive is true then it also removes all nodes below the specified node.
delete_all: in file BDB.php, method BDB::delete_all()
dropSequence: in file MySQL.php, method MySQL_Driver::dropSequence()
dropSequence: in file Database.php, method Database::dropSequence()
dropSequence: in file PgSQL.php, method PgSQL_Driver::dropSequence()

top

e

$edit_form_message

in file Table.php, variable DatabaseTable::$edit_form_message
Contains the message to use for displaying the Edit Record form in the Sitellite CMS.

$edit_form_template

in file Table.php, variable DatabaseTable::$edit_form_template
Contains the template to use for displaying the Edit Record form in the Sitellite CMS.

$entity

in file PropertySet.php, variable PropertySet::$entity
ID of the item from the collection which properties should map onto.

$errno

in file Table.php, variable DatabaseTable::$errno
Contains the error number if there is one, or false otherwise.

$errno

in file LDAP.php, variable LDAP::$errno
The errno of the previous error.

$error

in file Table.php, variable DatabaseTable::$error
Contains the error message if there is one, or false otherwise.

$error

in file Manager.php, variable DBM::$error
Error message, in case of error.

$error

in file PropertySet.php, variable PropertySet::$error
Will contain an error message if one occurs.

$error

in file NestedSet.php, variable NestedSet::$error
Error message, in case of error.

$error

in file Database.php, variable Database::$error
Contains the error message if an error occurs here. For most uses however, you will want to use the error() method of the Query object instead.

$error

in file Generic.php, variable Generic::$error
Contains an error message, if one occurs.

$error

in file LDAP.php, variable LDAP::$error
The message of the previous error.

$extra

in file Facet.php, variable DatabaseFacet::$extra
Extra info about the facet.

edit

in file NestedSet.php, method NestedSet::edit()
Modifies the specified item.

errno

in file Query.php, method Query::errno()
Returns the database error number in case of error. This number will be database-specific, and in some cases may even be a string. Please refer to your database documentation for a list of values and their meanings.

errno

in file MySQL.php, method MySQL_Query::errno()
Returns the database error number in case of error.

errno

in file PgSQL.php, method PgSQL_Query::errno()
Returns the database error number in case of error. Always returns

for this driver, since there is no such function in the PostgreSQL

extension.

error

in file Query.php, method Query::error()
Returns the database error message in case of error. This message will be database-specific. Please refer to your database documentation for a list of messages and their meanings.

error

in file PgSQL.php, method PgSQL_Query::error()
Returns the database error message in case of error.

error

in file MySQL.php, method MySQL_Query::error()
Returns the database error message in case of error.

execute

in file Database.php, method Database::execute()
Executes a single query against the database and returns true

execute

in file MySQL.php, method MySQL_Query::execute()
Executes the current SQL query.

execute

in file Query.php, method Query::execute()
Executes the current SQL query.

execute

in file PgSQL.php, method PgSQL_Query::execute()
Executes the current SQL query.

exists

in file Generic.php, method Generic::exists()
Determines whether an item with the specified primary key exists.

exists

in file BDB.php, method BDB::exists()
Checks if a key/value pair exists in the database.

top

f

$facets: in file Table.php, variable DatabaseTable::$facets
$fetchMode: in file Database.php, variable Database::$fetchMode
$field: in file PgSQL.php, variable PgSQL_Query::$field
Currently unused.
$field: in file MySQL.php, variable MySQL_Query::$field
Currently unused.
$field: in file Query.php, variable Query::$field
Currently unused.
$fields: in file Generic.php, variable Generic::$fields
List of all fields for this table.
$fields: in file NestedSet.php, variable NestedSet::$fields
Field list.
$firstCalled: in file LDAP.php, variable LDAP::$firstCalled
Says whether or not the first search result entry has been returned.
$fkey: in file Generic.php, variable Generic::$fkey
Optional name of a foreign key field, for use in simplified find() calls.
Facet.php: procedural page Facet.php
fetch: in file Query.php, method Query::fetch()
Returns the next row of data from the current query, always in the form of an object, with each column as its properties.
fetch: in file BDB.php, method BDB::fetch()
Retrieves a value corresponding to the provided key, from the database. Returns false on error.
fetch: in file Table.php, method DatabaseTable::fetch()
Creates a SELECT query based on the key given to it.
fetch: in file PgSQL.php, method PgSQL_Query::fetch()
Returns the next row of data from the current query, always in the form of an object, with each column as its properties.
fetch: in file MySQL.php, method MySQL_Query::fetch()
Returns the next row of data from the current query, always in the form of an object, with each column as its properties.
fetch: in file LDAP.php, method LDAP::fetch()
Fetches the next record in the search results as an associative array. Returns false when there are no more results.
fetch: in file Database.php, method Database::fetch()
Executes a single query against the database and returns either
fetchAll: in file Table.php, method DatabaseTable::fetchAll()
Creates a SELECT query without a WHERE clause, returning all columns from the table. $columns is an optional array of columns to return. $ascdesc can be either 'asc' or 'desc'. Returns an array of objects, or false on failure.
fetchArray: in file Query.php, method Query::fetchArray()
Returns the next row of data from the current query as an associative array, because sometimes an object isn't appropriate.
fetchXML: in file Query.php, method Query::fetchXML()
Returns the next row of data from the current query in XML format, so that it can easily be repurposed with XSL stylesheets or shared with external sources.
field: in file Query.php, method Query::field()
Returns the name of the specified column in the table currently being queried.
field: in file PgSQL.php, method PgSQL_Query::field()
Returns the name of the specified column in the table currently being queried.
field: in file MySQL.php, method MySQL_Query::field()
Returns the name of the specified column in the table currently being queried.
find: in file NestedSet.php, method NestedSet::find()
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.
find: in file Generic.php, method Generic::find()
Find objects with the specified values. $fid can be the ID of a field from the $fkey column, or a hash or object with a list of clauses (ie. array ('section' => 'Sports')).
firstkey: in file BDB.php, method BDB::firstkey()
Retrieves the first key in the database.
foreignKey: in file Generic.php, method Generic::foreignKey()
Set or reset the $foreignKey property.
free: in file MySQL.php, method MySQL_Query::free()
Tells the database system to let go of its data from the previous query.
free: in file LDAP.php, method LDAP::free()
Clears the current search result resource.
free: in file PgSQL.php, method PgSQL_Query::free()
Tells the database system to let go of its data from the previous query.
free: in file Query.php, method Query::free()
Tells the database system to let go of its data from the previous query.

top

g

$groupBy: in file Generic.php, variable Generic::$groupBy
Contains the "group by" clause value (ie. "name asc") for calls to find().
Generic.php: procedural page Generic.php
Generic: in file Generic.php, method Generic::Generic()
Constructor method.
Generic: in file Generic.php, class Generic
A generic object class for extending. Makes it easy to write quick object wrappers
get: in file Generic.php, method Generic::get()
Returns a single object with the specified $id.
get: in file PropertySet.php, method PropertySet::get()
Retrieves the specified property, or all properties for the current
get: in file NestedSet.php, method NestedSet::get()
Retrieves the specified node. $fields allows you to optionally specify which fields you want to retrieve. If left empty, it returns all of them.
getAll: in file Database.php, method Database::getAll()
getCurrent: in file Manager.php, method DBM::getCurrent()
Retrieves the currently active database object.
getEntries: in file LDAP.php, method LDAP::getEntries()
Returns all of the results of the current search as one big associative array of objects.
getFetchMode: in file Database.php, method Database::getFetchMode()
getInfo: in file Table.php, method DatabaseTable::getInfo()
Gets all the info it can from the database about this table and
getInfo: in file PgSQL.php, method PgSQL_DatabaseTable::getInfo()
Gets all the info it can from the database about this table and its columns, stores it in the $info property, and parses it into an associative array ($columns) of MailForm widgets.
getInfo: in file MySQL.php, method MySQL_DatabaseTable::getInfo()
Gets all the info it can from the database about this table and its columns, stores it in the $info property, and parses it into an associative array ($columns) of MailForm widgets.
getList: in file Generic.php, method Generic::getList()
Deprecated, use find().
getPkey: in file MySQL.php, method MySQL_DatabaseTable::getPkey()
Gets the name of the primary key field for this table using the results of getInfo() (see below). Used by the constructor method to set the $pkey property if a primary key column was not specified.
getPkey: in file Table.php, method DatabaseTable::getPkey()
Gets the name of the primary key field for this table using the results of getInfo() (see below). Used by the constructor method to set the $pkey property if a primary key column was not specified.
getPkey: in file PgSQL.php, method PgSQL_DatabaseTable::getPkey()
Gets the name of the primary key field for this table using the results of getInfo() (see below). Used by the constructor method to set the $pkey property if a primary key column was not specified.
getRefInfo: in file PgSQL.php, method PgSQL_DatabaseTable::getRefInfo()
Uses the global $tables array (Sitellite CMS specific) to get the primary key, referencing column, display column, and a true or false self-reference value, when given a Ref column name and its corresponding table.
getRefInfo: in file MySQL.php, method MySQL_DatabaseTable::getRefInfo()
Uses the global $tables array (Sitellite CMS specific) to get the primary key, referencing column, display column, and a true or false self-reference value, when given a Ref column name and its corresponding table.
getRefInfo: in file Table.php, method DatabaseTable::getRefInfo()
Uses the global $tables array (Sitellite CMS specific) to get
getRoots: in file NestedSet.php, method NestedSet::getRoots()
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.
getSequenceName: in file Database.php, method Database::getSequenceName()
getTables: in file PgSQL.php, method PgSQL_Driver::getTables()
Retrieves a list of tables in the database and places them in the $tables property, which is an array. Returns the list of names on success and false on failure.
getTables: in file Database.php, method Database::getTables()
Retrieves a list of tables in the database and places them in the $tables property, which is an array. Returns true on success and false on failure.
getTables: in file MySQL.php, method MySQL_Driver::getTables()
Retrieves a list of tables in the database and places them in the $tables property, which is an array. Returns the list of names on success and false on failure.
groupBy: in file Generic.php, method Generic::groupBy()
Set or reset the $groupBy property.

top

h

$handler: in file BDB.php, variable BDB::$handler
The database implementation used (db2, db3, gdbm, etc.).
$host: in file PgSQL.php, variable PgSQL_Driver::$host
Contains the name of the database host.
$host: in file Database.php, variable Database::$host
Contains the name of the database host.
$host: in file MySQL.php, variable MySQL_Driver::$host
Contains the name of the database host.

top

i

$indexes: in file NestedSet.php, variable NestedSet::$indexes
Index list.
$info: in file Table.php, variable DatabaseTable::$info
The unparsed info from the database about this table and its columns.
$invalid: in file Generic.php, variable Generic::$invalid
A list of invalid fields and their corresponding error messages, from the previous validate() call.
$isAuto: in file Generic.php, variable Generic::$isAuto
Whether the pkey is auto-incrementing or not.
$items: in file Facet.php, variable DatabaseFacet::$items
List of options in the facet.
insert: in file Table.php, method DatabaseTable::insert()
Creates an INSERT query from the columns provided. Returns the lastid() of the query, or the $columns[$this->pkey] value if there is no sequential key in this table, or false on failure.
insert: in file BDB.php, method BDB::insert()
Insert a new key/value pair into the database.
isParent: in file NestedSet.php, method NestedSet::isParent()
Checks whether $pid is a parent of $id.

top

k

$key: in file NestedSet.php, variable NestedSet::$key
Primary key field name.

top

l

$lastid: in file Database.php, variable Database::$lastid
Contains the lastid() of the last insert query sent to the execute() method.
$left: in file NestedSet.php, variable NestedSet::$left
Left field name.
$level: in file NestedSet.php, variable NestedSet::$level
Level field name.
$limit: in file Generic.php, variable Generic::$limit
Contains the "limit" clause value for calls to find().
$listFields: in file Generic.php, variable Generic::$listFields
The list of fields to return on find(). Default is '*' to return all fields.
LDAP.php: procedural page LDAP.php
lastid: in file Query.php, method Query::lastid()
Returns the row ID generated by the database during the previous SQL insert query.
lastid: in file PgSQL.php, method PgSQL_Query::lastid()
Returns the row ID generated by the database during the previous SQL insert query.
lastid: in file MySQL.php, method MySQL_Query::lastid()
Returns the row ID generated by the database during the previous SQL insert query.
LDAP: in file LDAP.php, class LDAP
A wrapper around the PHP LDAP extension.
LDAP: in file LDAP.php, method LDAP::LDAP()
Constructor method. Connects to the server and binds the username and password.
limit: in file Generic.php, method Generic::limit()
Set or reset the $limit property.
listFields: in file Generic.php, method Generic::listFields()
Set or reset the $listFields property.
load: in file Generic.php, method Generic::load()
Loads a series of objects that are dynamically generated from an INI file.

top

m

$mode: in file BDB.php, variable BDB::$mode
Mode to use when opening the database (corresponds to the modes available to the dba_open () function.
MySQL.php: procedural page MySQL.php
Manager.php: procedural page Manager.php
makeObj: in file Generic.php, method Generic::makeObj()
Returns the currently active object.
makeObj: in file LDAP.php, method LDAP::makeObj()
Convert the returned attributes into the properties of an object.
makeStruct: in file Generic.php, method Generic::makeStruct()
Makes a valid array hash out of the specified $vals, using the $fields list as a reference.
modify: in file Generic.php, method Generic::modify()
Updates the specified record with the new values.
move: in file NestedSet.php, method NestedSet::move()
Moves the specified node (item) to under the specified parent ID.
MySQL_DatabaseTable: in file MySQL.php, class MySQL_DatabaseTable
MySQL_DatabaseTable provides all of the MySQL-specific functionality for the saf.Database.Table package.
MySQL_Driver: in file MySQL.php, method MySQL_Driver::MySQL_Driver()
Constructor method.
MySQL_Driver: in file MySQL.php, class MySQL_Driver
MySQL_Driver provides all of the MySQL-specific functionality for Database objects. It is accessed through the Database class API.
MySQL_Query: in file MySQL.php, class MySQL_Query
MySQL_Driver is the Database driver for the MySQL database system.
MySQL_Query: in file MySQL.php, method MySQL_Query::MySQL_Query()
Constructor method.

top

n

$name: in file MySQL.php, variable MySQL_Driver::$name
Contains the name of the database being used.
$name: in file Table.php, variable DatabaseTable::$name
The name of the table.
$name: in file Database.php, variable Database::$name
Contains the name of the database being used.
$name: in file PgSQL.php, variable PgSQL_Driver::$name
Contains the name of the database being used.
NestedSet.php: procedural page NestedSet.php
NestedSet: in file NestedSet.php, class NestedSet
An implementation of the Nested Set algorithm, which allows hierarchies and trees to be stored efficiently in a relational database table structure.
NestedSet: in file NestedSet.php, method NestedSet::NestedSet()
Constructor method. If your table was created by this class, then you probably only need to specify the $table and $key.
nextId: in file Database.php, method Database::nextId()
nextId: in file PgSQL.php, method PgSQL_Driver::nextId()
nextId: in file MySQL.php, method MySQL_Driver::nextId()
nextkey: in file BDB.php, method BDB::nextkey()
Retrieves the next key in the database. Used with firstkey to loop through records.

top

o

$offset: in file Generic.php, variable Generic::$offset
Contains the "offset" clause value for calls to find().
$order: in file NestedSet.php, variable NestedSet::$order
Sorting order field name.
$orderBy: in file Generic.php, variable Generic::$orderBy
Contains the "order by" clause value (ie. "name asc") for calls to find().
$orderfield: in file Table.php, variable DatabaseTable::$orderfield
Contains the column to order search results by in the Sitellite CMS database manager.
offset: in file Generic.php, method Generic::offset()
Set or reset the $offset property.
optimize: in file BDB.php, method BDB::optimize()
Optimizes the database.
orderBy: in file Generic.php, method Generic::orderBy()
Set or reset the $orderBy property.

top

p

$pass: in file PgSQL.php, variable PgSQL_Driver::$pass
Contains the password used to connect to the current database.
$pass: in file Database.php, variable Database::$pass
Contains the password used to connect to the current database.
$pass: in file MySQL.php, variable MySQL_Driver::$pass
Contains the password used to connect to the current database.
$password: in file LDAP.php, variable LDAP::$password
The password to use to bind to the connection.
$path: in file BDB.php, variable BDB::$path
Path to the Berkeley Database.
$pearEmu: in file Database.php, variable Database::$pearEmu
$persistent: in file PgSQL.php, variable PgSQL_Driver::$persistent
A 1 or 0 (true or false, and true by default), specifying whether to establish a persistent connection or not.
$persistent: in file BDB.php, variable BDB::$persistent
Whether or not to use persistence when connecting to the database.
$persistent: in file MySQL.php, variable MySQL_Driver::$persistent
A 1 or 0 (true or false, and true by default), specifying whether to establish a persistent connection or not.
$pkey: in file Table.php, variable DatabaseTable::$pkey
The name of the primary key field. This property is also duplicated in the $primary_key property, which is a reference to this one.
$pkey: in file Generic.php, variable Generic::$pkey
Primary key field.
$port: in file LDAP.php, variable LDAP::$port
The port to use to connect to the server.
PgSQL.php: procedural page PgSQL.php
PropertySet.php: procedural page PropertySet.php
parent: in file NestedSet.php, method NestedSet::parent()
Returns the parent nodes of the specified node.
path: in file NestedSet.php, method NestedSet::path()
Returns an array of the parent nodes of the specified node. This is also known as a breadcrumb trail.
PgSQL_DatabaseTable: in file PgSQL.php, class PgSQL_DatabaseTable
PgSQL_DatabaseTable provides all of the PgSQL-specific functionality for the saf.Database.Table package.
PgSQL_Driver: in file PgSQL.php, method PgSQL_Driver::PgSQL_Driver()
Constructor method.
PgSQL_Driver: in file PgSQL.php, class PgSQL_Driver
PgSQL_Driver provides all of the PgSQL-specific functionality for Database objects. It is accessed through the Database class API.
PgSQL_Query: in file PgSQL.php, method PgSQL_Query::PgSQL_Query()
Constructor method.
PgSQL_Query: in file PgSQL.php, class PgSQL_Query
PgSQL_Driver is the Database driver for the PostgreSQL database system.
pkey: in file Generic.php, method Generic::pkey()
Retrieves the primary key value of the currently active object.
PropertySet: in file PropertySet.php, class PropertySet
Simple class for adding arbitrary properties to existing data structures, usually properties that change frequently (ie. new properties are added or removed or updated a lot).
PropertySet: in file PropertySet.php, method PropertySet::PropertySet()
Constructor method.

top

q

$queryfield: in file Table.php, variable DatabaseTable::$queryfield
Contains the column to search for any string values in the Sitellite CMS database manager.
Query.php: procedural page Query.php
Query: in file Query.php, class Query
Query is the counterpart class to Database. It provides the framework
Query: in file Query.php, method Query::Query()
Constructor method.
query: in file Database.php, method Database::query()
Creates and returns a Query object.
query: in file PgSQL.php, method PgSQL_Driver::query()
Creates and returns a Query object.
query: in file Generic.php, method Generic::query()
Allows you to pass SQL queries directly to the database, which are first passed to SimpleTemplate with $this. This allows for queries like 'SELECT * FROM {table} WHERE {pkey} = ?'.
query: in file MySQL.php, method MySQL_Driver::query()
Creates and returns a Query object.
quote: in file Database.php, method Database::quote()
quote: in file MySQL.php, method MySQL_Driver::quote()
quote: in file PgSQL.php, method PgSQL_Driver::quote()

top

r

$rdn: in file LDAP.php, variable LDAP::$rdn
The rdn (username, essentially) to use to bind to the connection.
$resource: in file LDAP.php, variable LDAP::$resource
The current search resource.
$result: in file PgSQL.php, variable PgSQL_Query::$result
Contains the result identifier for the current execution.
$result: in file Query.php, variable Query::$result
Contains the result identifier for the current execution.
$result: in file MySQL.php, variable MySQL_Query::$result
Contains the result identifier for the current execution.
$right: in file NestedSet.php, variable NestedSet::$right
Right field name.
$root: in file NestedSet.php, variable NestedSet::$root
Root field name.
$rows: in file Table.php, variable DatabaseTable::$rows
The number of rows returned by the previous query.
$rows: in file Database.php, variable Database::$rows
Contains the number of rows returned by the previous fetch() call.
raiseError: in file MySQL.php, method MySQL_Driver::raiseError()
raiseError: in file PgSQL.php, method PgSQL_Driver::raiseError()
remove: in file Generic.php, method Generic::remove()
Deletes the specified record from the database.
remove: in file Manager.php, method DBM::remove()
Remove a connection.
rename: in file NestedSet.php, method NestedSet::rename()
Renames the specified node (item).
replace: in file BDB.php, method BDB::replace()
Replaces the value of an existing pair with the new value provided.
rollback: in file PgSQL.php, method PgSQL_Query::rollback()
Issues a mysql "rollback" statement, rolling back the current transaction.
rollback: in file MySQL.php, method MySQL_Query::rollback()
Issues a mysql "rollback" statement, rolling back the current transaction.
root: in file NestedSet.php, method NestedSet::root()
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.
rows: in file MySQL.php, method MySQL_Query::rows()
Returns the number of rows affected or found by the current query.
rows: in file Query.php, method Query::rows()
Returns the number of rows affected or found by the current query.
rows: in file PgSQL.php, method PgSQL_Query::rows()
Returns the number of rows affected or found by the current query.

top

s

$secure: in file LDAP.php, variable LDAP::$secure
Whether to use TLS for LDAP connections.
$sequenceFormat: in file Database.php, variable Database::$sequenceFormat
$server: in file LDAP.php, variable LDAP::$server
The name of the server to connect to.
$sql: in file PgSQL.php, variable PgSQL_Query::$sql
Contains the SQL query to be executed.
$sql: in file MySQL.php, variable MySQL_Query::$sql
Contains the SQL query to be executed.
$sql: in file Table.php, variable DatabaseTable::$sql
The sql from the previous query, if an error occurred.
$sql: in file Query.php, variable Query::$sql
Contains the SQL query to be executed.
$statusfield: in file Table.php, variable DatabaseTable::$statusfield
Contains the column to search for status values in the Sitellite CMS database manager.
shell.php: procedural page shell.php
SQL.php: procedural page SQL.php
save: in file Generic.php, method Generic::save()
Saves the currently active object to the database.
search: in file LDAP.php, method LDAP::search()
Queries the database.
set: in file Generic.php, method Generic::set()
Sets a property of the currently active object.
set: in file PropertySet.php, method PropertySet::set()
Adds or updates (if already exists) the specified property.
setCurrent: in file Manager.php, method DBM::setCurrent()
Set the specified connection to be the currently active one.
setCurrent: in file Generic.php, method Generic::setCurrent()
Sets the currently "active" object. The current object can be used for internal method calls without having to specify the ID or values of an object to those methods.
setFetchMode: in file Database.php, method Database::setFetchMode()
setOption: in file Database.php, method Database::setOption()
shift: in file Generic.php, method Generic::shift()
This method acts the same way db_shift() does, which is to return the first column value of the result of a find() call only, as a string.
shift: in file Database.php, method Database::shift()
Executes a single query against the database and returns the
show: in file Facet.php, method DatabaseFacet::show()
Render the facet to HTML.
siblings: in file NestedSet.php, method NestedSet::siblings()
Returns an array of the IDs of the sibling nodes of the specified node.
single: in file Database.php, method Database::single()
Executes a single query against the database and returns a
single: in file Generic.php, method Generic::single()
This method acts the same way db_single() does, which is to return the first result of a find() call only, as an object. This method takes the same parameters as find(). Returns false if there is no matching row.
SQL: in file SQL.php, class SQL
SQL extends I18n to become an SQL abstraction layer for Sitellite.
SQL: in file SQL.php, method SQL::SQL()
Constructor Method.
sync: in file BDB.php, method BDB::sync()
Synchronizes the database. This usually writes the database to disk.

top

t

$table: in file NestedSet.php, variable NestedSet::$table
Table name.
$table: in file Generic.php, variable Generic::$table
Table name.
$tableObj: in file Facet.php, variable DatabaseFacet::$tableObj
DatabaseTable object.
$tables: in file Database.php, variable Database::$tables
Contains a list of tables in the database. Set by getTables().
$title: in file Facet.php, variable DatabaseFacet::$title
Dispaly name of the facet.
$transactions: in file Database.php, variable Database::$transactions
Boolean value denoting whether to enable transactions in the current database.
$treefield: in file Table.php, variable DatabaseTable::$treefield
Contains the column that makes a self-reference (a reference to the primary key of its own table), which can be used in the Sitellite CMS database manager to show a tree representation of this table.
$type: in file Facet.php, variable DatabaseFacet::$type
Type of the facet. Possible values are 'normal', 'self_ref', 'date', and 'time'.
$typemap: in file Table.php, variable DatabaseTable::$typemap
Contains a key/value list of database types (regular expressions are used here to save repeating ourselves) and their corresponding MailForm widget types. Used internally by the drivers.
$typemap: in file PgSQL.php, variable PgSQL_DatabaseTable::$typemap
Contains a key/value list of database types (regular expressions are used here to save repeating ourselves) and their corresponding MailForm widget types.
$typemap: in file MySQL.php, variable MySQL_DatabaseTable::$typemap
Contains a key/value list of database types (regular expressions are used here to save repeating ourselves) and their corresponding MailForm widget types.
Table.php: procedural page Table.php
table: in file Database.php, method Database::table()
Creates and returns a DatabaseTable object. $pkey is the name of the primary key column. Automatically loads the saf.Database.Table package on calling, instead of loading the extra package at the start.
tableExists: in file Database.php, method Database::tableExists()
Determines whether the specified table exists or not by comparing it to the $tables list. If $tables is not set, then it will call getTables() automatically as well.
toXML: in file Query.php, method Query::toXML()
Returns the given result object represented as XML.

top

u

$usePermissions: in file Generic.php, variable Generic::$usePermissions
Determines whether to automatically add access control to find(), count(), and get() calls.
$user: in file PgSQL.php, variable PgSQL_Driver::$user
Contains the username used to connect to the current database.
$user: in file MySQL.php, variable MySQL_Driver::$user
Contains the username used to connect to the current database.
$user: in file Database.php, variable Database::$user
Contains the username used to connect to the current database.
update: in file Table.php, method DatabaseTable::update()
Creates an UPDATE query from the $keyval and $columns provided.
update: in file PropertySet.php, method PropertySet::update()
Updates the specified property.

top

v

val: in file Generic.php, method Generic::val()
Retrieves a property of the currently active object.
validate: in file Generic.php, method Generic::validate()
Validates the specified data list against the list of rules added via addRule(). Lists the invalid rules in the $invalid list, and returns true or false whether the values passed or not.

top

Packages

Classes

Files

Element index for package Database

_

a

b

c

d

e

f

g

h

i

k

l

m

n

o

p

q

r

s

t

u

v