[Horde_Rdo] element index

Package indexes

All elements
a b c d e f g h i k l m n o p q r s t u v w x _
_
top
Variable $_adapter
Global adapter object.
Variable $_bindParams
Bind parameters
Variable $_classname
What class should this Mapper create for objects? Defaults to the Mapper subclass' name minus "Mapper". So if the Rdo_Mapper subclass is UserMapper, it will default to trying to create User objects.
Variable $_columns
Variable $_current
Current object
Variable $_db
Mysqli database connection object.
Variable $_db
PDO database connection object.
Variable $_defaultSortRules
Default sorting rules to use for all queries made with this
Variable $_eof
Are we at the end of the list?
Variable $_fields
Variable $_fields
This object's fields.
Variable $_index
Current list offset.
Variable $_inflector
Global inflector object.
Variable $_lastInsertId
Last generated insert_id.
Variable $_lazyFields
Fields that should only be read from the database when they are accessed.
Variable $_lazyRelationships
Relationships that should only be read from the database when they are accessed.
Variable $_mapper
The Horde_Rdo_Mapper instance associated with this Rdo object. The Mapper takes care of all backend access.
Variable $_mapper
Rdo Mapper
Variable $_metadata
Variable $_options
Options for this Adapter.
Variable $_pluralizationRules
Rules for pluralizing English nouns.
Variable $_relationships
Relationships for this entity.
Variable $_result
Result resource
Variable $_setTimestamps
If this is true and fields named created and updated are present, Rdo will automatically set creation and last updated timestamps. Timestamps are always GMT for portability.
Variable $_singularEqualsPlural
Variable $_singularizationRules
Rules for singularizing English nouns.
Variable $_sortby
Variable $_sql
SQL query to run
Variable $_statement
Variable $_string
SQL literal string.
Variable $_table
The name of the database table (or view, etc.) that holds this Mapper's objects.
Variable $_table
Variable $_values
Method _connect
Build a connection string and connect to the database server.
Method _connect
Build a connection string and connect to the database server.
Method _connect
Build a connection string and connect to the database server.
Method _connect
Build a connection string and connect to the database server.
Method _connect
Build a connection string and connect to the database server.
Method _connect
Build a connection string and connect to the database server.
Method _fillJoinPlaceholders
Take a query array and replace @field@ placeholders with values that will match in the load query.
Method _fillPlaceholders
Take a query array and replace @field@ placeholders with values from this object.
Method _from
Method _join
Method _lastInsertId
Method _lastInsertId
Method _lastInsertId
Method _lastInsertId
Method _limit
Method _limit
Method _limit
Method _limit
Method _orderBy
Method _prefix
Callback for array_walk to prefix all elements of an array with a given prefix.
Method _prepare
Prepare a statement for MySQLi - we have to detect data types to call bind_param() correctly.
Method _select
Method _where
Method __clone
When Rdo objects are cloned, unset the unique id that identifies them so that they can be modified and saved to the backend as new objects. If you don't really want a new object, don't clone.
Method __construct
Constructor.
Method __construct
New Horde_Rdo_Iterator for iterating over Rdo objects.
Method __construct
Horde_Rdo_Adapter constructor. Sets options and sets up a connection if necessary.
Method __construct
Get the appropriate DML object and call the parent constructor.
Method __construct
Method __construct
Instantiate a literal, which is just a string stored as an instance member variable.
Method __construct
Get the appropriate DML object and call the parent constructor.
Method __construct
Method __construct
Method __construct
Constructor. Can be called directly by a programmer, or is called in Horde_Rdo_Mapper::map(). Takes an associative array of initial object values.
Method __construct
Get the appropriate DML object and call the parent constructor.
Method __construct
Get the appropriate DML object and call the parent constructor.
Method __construct
Method __construct
Get the appropriate DML object and call the parent constructor.
Method __construct
Get the appropriate DML object and call the parent constructor.
Method __destruct
Destructor - release any resources.
Method __destruct
Free any resources that are open.
Method __destruct
Method __destruct
Free any resources that are open.
Method __get
Accessor for any fields that we want some logic around.
Method __get
Provide read-only, on-demand access to several properties. This method will only be called for properties that aren't already present; once a property is fetched once it is cached and returned directly on any subsequent access.
Method __get
Fetch fields that haven't yet been loaded. Lazy-loaded fields and lazy-loaded relationships are handled this way. Once a field is retrieved, it is cached in the $_fields array so it doesn't need to be fetched again.
Method __isset
Allow using isset($rdo->foo) to check for field or relationship presence.
Method __set
Set a field's value.
Method __set_state
Method __toString
Method __unset
Allow using unset($rdo->foo) to unset a basic field. Relationships cannot be unset in this way.
Variable $_relationships
Variable $_relationships
Variable $_relationships
Variable $_table
Variable $_table
Variable $_table
ItemMapper::$_table in Clotho.php
Variable $_table
Variable $_table
a
top
Method addField
Method addFields
Method addRelationship
Method addTest
Page Adapter.php
Adapter.php in Adapter.php
Page AllTests.php
AllTests.php in AllTests.php
b
top
Method beginTransaction
Method beginTransaction
Method beginTransaction
Page Base.php
Base.php in Base.php
Page Builder.php
Builder.php in Builder.php
c
top
Variable $conjunction
Method clearSort
Method combineWith
Method commit
Method commit
Method commit
Method count
Count objects that match $query.
Method count
Method create
Create a new object in the backend with $fields as initial values.
Method create
Turn any of the acceptable query shorthands into a full Horde_Rdo_Query object. If you pass an existing Horde_Rdo_Query object in, it will be cloned before it's returned so that it can be safely modified.
Method create
Create a backend object.
Method current
Implementation of the current() method for iterator.
Method current
Return the current value.
Class Constant CUSTOM
Custom relationships defined by a query. These can be any of the 4 basic relationship types (one-to-one, one-to-many, many-to-one, many-to-many), but also carry additional qualifiers.
Page clothoData.php
clothoData.php in clothoData.php
Page CountTest.php
CountTest.php in CountTest.php
Page Cursor.php
Cursor.php in Cursor.php
Page Cursor.php
Cursor.php in Cursor.php
Class Calendar
Calendar in Clotho.php
Calendars
Class CalendarMapper
CalendarMapper in Clotho.php
Calendar Mapper.
Class Clotho_Mapper
Clotho_Mapper in Clotho.php
Base Mapper class for Clotho - defines getAdapter() so subclasses stay simple.
Page Clotho.php
Clotho.php in Clotho.php
d
top
Variable $dml
DML query generator.
Method delete
Deletes a record from the backend. $object can be either a primary key, an Rdo_Query object, or an Rdo object.
Method delete
Delete this object from the backend.
Method delete
Delete one or more objects from the database.
Page DumpXmlTest.php
DumpXmlTest.php in DumpXmlTest.php
Class Dependency
Dependency in Clotho.php
Dependencies
Class DependencyMapper
DependencyMapper in Clotho.php
Dependency Mapper.
e
top
Method execute
Use for INSERT, UPDATE, DELETE, and other queries that don't return rows. Returns number of affected rows.
Method execute
Use for INSERT, UPDATE, DELETE, and other queries that don't return rows. Returns number of affected rows.
Method execute
Use for INSERT, UPDATE, DELETE, and other queries that don't return rows. Returns number of affected rows.
Method exists
Method exists
Check if at least one object matches $query.
Page Exception.php
Exception.php in Exception.php
f
top
Variable $fields
Method factory
Method fetch
Method find
Find can be called in several ways.
Class Constant FIND_ALL
Find mode for returning all results. Even if no results are found an empty iterator will be returned.
Class Constant FIND_FIRST
Find mode for returning just the first matching result. The backend will limit the search if possible, and only a single object will be returned (or null).
g
top
Method getAdapter
ProxyMapper::getAdapter() in rdo-model.php
Method getAdapter
Method getAdapter
Get the global adapter object.
Method getAdapter
Method getAdapter
getAdapter() must be overridden by Horde_Rdo_Mapper subclasses if they don't provide $adapter in some other way (by calling setAdapter() or on construction, for example), and there is no global Adapter.
Method getCount
Method getField
Method getFields
Method getInflector
Get the global inflector object.
Method getIterator
Implement the IteratorAggregate interface. Looping over an Rdo object goes through each property of the object in turn.
Method getMapper
Get a Mapper instance that can be used to manage this object. The Mapper instance can come from a few places:
Method getOption
Get one of the options for this Adapter.
Method getQuery
Query generator.
Method getTables
Method getTables
Method getTables
Method getTables
Method getTables
Method getTest
Return the database-specific version of a test.
Method getTest
Return the database-specific version of a test.
Method getAdapter
h
top
Method hasField
Class Horde_Rdo
Horde_Rdo in Rdo.php
Horde_Rdo (Rampage Data Objects) namespace - holds constants and global Rdo functions.
Class Horde_Rdo_Adapter
Horde_Rdo_Adapter in Adapter.php
Database adapter abstract parent class for Rdo.
Class Horde_Rdo_Adapter_Mysqli
MySQL Improved Horde_Rdo adapter
Class Horde_Rdo_Adapter_Mysqli_Cursor
Class Horde_Rdo_Adapter_Oci8
Class Horde_Rdo_Adapter_Pdo
PDO Horde_Rdo_Adapter generic implementation. Provides most functionality but must be extended with a concrete implementation to fill in database-specific details.
Class Horde_Rdo_Adapter_Pdo_Cursor
Class Horde_Rdo_Adapter_Pdo_Mssql
MS-SQL PDO Horde_Rdo adapter
Class Horde_Rdo_Adapter_Pdo_Mysql
MySQL PDO Horde_Rdo adapter
Class Horde_Rdo_Adapter_Pdo_Oci
OCI PDO Horde_Rdo adapter
Class Horde_Rdo_Adapter_Pdo_Pgsql
PostgreSQL PDO Horde_Rdo adapter
Class Horde_Rdo_Adapter_Pdo_Sqlite
Sqlite PDO Horde_Rdo adapter
Class Horde_Rdo_Base
Horde_Rdo_Base in Base.php
Horde_Rdo_Base abstract class (Rampage Data Objects). Entity classes extend this baseline.
Class Horde_Rdo_Exception
Horde_Rdo_Exception in Exception.php
Rdo Exception class.
Class Horde_Rdo_Inflector
Horde_Rdo_Inflector in Inflector.php
Rdo Inflector class.
Class Horde_Rdo_Iterator
Horde_Rdo_Iterator in Iterator.php
Iterator for Horde_Rdo_Base objects that allows relationships and decorated objects to be handled gracefully.
Class Horde_Rdo_List
Horde_Rdo_List in List.php
Iterator for collections of Rdo objects.
Class Horde_Rdo_Mapper
Horde_Rdo_Mapper in Mapper.php
Rdo Mapper class. Controls mapping of entity obects (instances of Horde_Rdo_Base) from and to Horde_Rdo_Adapters.
Class Horde_Rdo_Model
Horde_Rdo_Model in Model.php
Class Horde_Rdo_Query
Horde_Rdo_Query in Query.php
Class Horde_Rdo_Query_Builder
Horde_Rdo query building abstract base
Class Horde_Rdo_Query_Builder_Mssql
Class Horde_Rdo_Query_Builder_Mysql
Class Horde_Rdo_Query_Builder_Oracle
Class Horde_Rdo_Query_Builder_Pgsql
Class Horde_Rdo_Query_Builder_Sqlite
Class Horde_Rdo_Query_Literal
Horde_Rdo literal query string object.
Class Horde_Rdo_AllTests
Horde_Rdo_AllTests in AllTests.php
Class Horde_Rdo_InflectorTest
Horde_Rdo_InflectorTest in InflectorTest.php
i
top
Class Constant INTEGER
Page Inflector.php
Inflector.php in Inflector.php
Page Iterator.php
Iterator.php in Iterator.php
Page InflectorTest.php
InflectorTest.php in InflectorTest.php
Class Item
Item in Clotho.php
Items
Class ItemMapper
ItemMapper in Clotho.php
Item Mapper
k
top
Method key
Implementation of the key() method for iterator.
Method key
Return the current key.
l
top
Variable $limit
Variable $limitOffset
Method limit
Restrict the query to a subset of the results.
Method listFields
Method load
Fill the model using the mapper's backend.
Method loadModel
Get a description of the database table that $model is going to reflect.
Method loadModel
Get a description of the database table that $model is going to reflect.
Method loadModel
Get a description of the database table that $model is going to reflect.
Method loadModel
Get a description of the database table that $model is going to reflect.
Method loadModel
Get a description of the database table that $model is going to reflect.
Method loadModel
Get a description of the database table that $model is going to reflect.
Method loadModel
Get a description of the database table that $model is going to reflect.
Page List.php
List.php in List.php
Page Literal.php
Literal.php in Literal.php
m
top
Variable $mapper
Variable $mapper
Class Constant MANY_TO_MANY
Many-to-many relationships (this object relates to many objects, each of which relate to many objects of this type).
Class Constant MANY_TO_ONE
Many-to-one relationships (this object is one of many children of a single parent).
Method map
Create an instance of $this->_classname from a set of data.
Method mapperToEntity
Transform a mapper class to and entity class name.
Method mapperToTable
Transform a mapper instance to a database table name.
Page Mysqli.php
Mysqli.php in Mysqli.php
Page Mssql.php
Mssql.php in Mssql.php
Page Mysql.php
Mysql.php in Mysql.php
Page Mapper.php
Mapper.php in Mapper.php
Page Model.php
Model.php in Model.php
Page Mssql.php
Mssql.php in Mssql.php
Page Mysql.php
Mysql.php in Mysql.php
Method main
n
top
Method next
Move to the next key in the iterator.
Method next
Implementation of the next() method.
Class Constant NUMBER
o
top
Class Constant ONE_TO_MANY
One-to-many relationships (this object has many children).
Class Constant ONE_TO_ONE
One-to-one relationships.
Page Oci8.php
Oci8.php in Oci8.php
Page Oci.php
Oci.php in Oci.php
Page Oracle.php
Oracle.php in Oracle.php
p
top
Method pluralize
Singular English word to pluralize.
Class Proxy
Proxy in rdo-model.php
This class will stand in for our table for generating the Model.
Class ProxyMapper
ProxyMapper in rdo-model.php
This class will stand in for our table's Mapper.
Page Pgsql.php
Pgsql.php in Pgsql.php
Page Pdo.php
Pdo.php in Pdo.php
Page Pgsql.php
Pgsql.php in Pgsql.php
Constant PHPUnit_MAIN_METHOD
PHPUnit_MAIN_METHOD in AllTests.php
q
top
Method query
Use for SELECT and anything that returns rows.
Method queryCol
Return a single column from a query.
Method queryOne
Return a single value from a query. Useful for quickly getting a value such as with a COUNT(*) query.
Method quoteIdentifier
Escape an identifier, such as a table or column name, for safe use in queries.
Method quoteIdentifier
Escape an identifier, such as a table or column name, for safe use in queries.
Method quoteIdentifier
Escape an identifier, such as a table or column name, for safe use in queries.
Method quoteIdentifier
Escape an identifier, such as a table or column name, for safe use in queries.
Method quoteIdentifier
Escape an identifier, such as a table or column name, for safe use in queries.
Method quoteIdentifier
Escape an identifier, such as a table or column name, for safe use in queries.
Page Query.php
Query.php in Query.php
r
top
Variable $relationships
Page Rdo.php
Rdo.php in Rdo.php
Page rdo-model.php
rdo-model.php in rdo-model.php
Method rewind
Implementation of the rewind() method for iterator.
Method rewind
Reset to the first key.
Method rollBack
Method rollBack
Method rollBack
Page RelationshipTest.php
RelationshipTest.php in RelationshipTest.php
Class Resource
Resource in Clotho.php
Resources
Class ResourceAvailability
ResourceAvailability in Clotho.php
ResourceAvailability
Class ResourceAvailabilityMapper
ResourceAvailability Mapper.
Class ResourceMapper
ResourceMapper in Clotho.php
Resource Mapper.
s
top
Page Sqlite.php
Sqlite.php in Sqlite.php
Page Sqlite.php
Sqlite.php in Sqlite.php
Method save
Save any changes to the backend.
Method select
Use for SELECT and anything that returns rows.
Method select
Use for SELECT and anything that returns rows.
Method select
Use for SELECT and anything that returns rows.
Method selectCol
Return a single column from a query.
Method selectCol
Return a single column from a query.
Method selectCol
Return a single column from a query.
Method selectOne
Return a single value from a query. Useful for quickly getting a value such as with a COUNT(*) query.
Method selectOne
Return a single value from a query. Useful for quickly getting a value such as with a COUNT(*) query.
Method selectOne
Return a single value from a query. Useful for quickly getting a value such as with a COUNT(*) query.
Method setAdapter
Set a global database adapter.
Method setAdapter
Associate an adapter with this mapper. Not needed in the general case if getAdapter() is overridden in the concrete Mapper implementation.
Method setFields
Method setFieldType
Method setInflector
Set a custom global inflector.
Method setMapper
Method setMapper
Method setMapper
Associate this Rdo object with the Mapper instance that will manage it. Called automatically by Horde_Rdo_Mapper:map().
Method setOption
Set one of the options for this Adapter.
Method singularize
Plural English word to singularize.
Method sortBy
Add a sorting rule.
Method sortBy
Set a default sort field and order for all queries done with this Mapper.
Class Constant SORT_ASC
Ascending sort order
Class Constant SORT_DESC
Descending sort order
Class Constant STRING
Method setUp
Method suite
t
top
Variable $table
Variable $tests
Page Task.php
Task.php in Task.php
Method tableToMapper
Transform a table name to a mapper class name.
Class Task
Task in Task.php
Class TaskMapper
TaskMapper in Task.php
Class Constant TEXT
Method testInflection
Method toXml
XmlItem::toXml() in DumpXmlTest.php
Return an XML representation of this object. The default implementation is unlikely to be useful in most cases and should be overridden by subclasses to be domain-appropriate.
u
top
Page User.php
User.php in User.php
Method update
Updates a record in the backend. $object can be either a primary key or an Rdo object. If $object is an Rdo instance then $fields will be ignored as values will be pulled from the object.
Method update
Updates a backend object.
Class User
User in User.php
Class UserMapper
UserMapper in User.php
v
top
Method valid
Implementation of the valid() method for iterator
Method valid
Check array bounds.
w
top
Variable $words
Horde_Rdo_InflectorTest::$words in InflectorTest.php
x
top
Class XmlItem
XmlItem in DumpXmlTest.php
Items
Class XmlItemMapper
XmlItemMapper in DumpXmlTest.php
Item Mapper
a b c d e f g h i k l m n o p q r s t u v w x _