Index of all elements
abcdefghijklmnopqrstuvwx_
a
- $adapter
- in file Cache.php, variable Cache::$adapter
- $alias_attribute
- in file Model.php, variable Model::$alias_attribute
Allows you to create aliases for attributes.
- $attributes
- in file Serialization.php, variable Serialization::$attributes
- $attribute_name
- in file Relationship.php, variable AbstractRelationship::$attribute_name
Name to be used that will trigger call to the relationship.
- $attr_accessible
- in file Model.php, variable Model::$attr_accessible
Whitelist of attributes that are checked from mass-assignment calls such as constructing a model or using update_attributes.
- $attr_protected
- in file Model.php, variable Model::$attr_protected
Blacklist of attributes that cannot be mass-assigned.
- $auto_increment
- in file Column.php, variable Column::$auto_increment
True if this column is set to auto_increment.
- AbstractRelationship
- in file Relationship.php, class AbstractRelationship
Abstract class that all relationships must extend from.
- accepts_limit_and_order_for_update_and_delete
- in file SqliteAdapter.php, method SqliteAdapter::accepts_limit_and_order_for_update_and_delete()
- accepts_limit_and_order_for_update_and_delete
- in file MysqlAdapter.php, method MysqlAdapter::accepts_limit_and_order_for_update_and_delete()
- accepts_limit_and_order_for_update_and_delete
- in file Connection.php, method Connection::accepts_limit_and_order_for_update_and_delete()
Specifies whether or not adapter can use LIMIT/ORDER clauses with DELETE & UPDATE operations
- ActiveRecordException
- in file Exceptions.php, class ActiveRecordException
Generic base exception for all ActiveRecord specific errors.
- add
- in file Validations.php, method Errors::add()
Add an error message.
- add
- in file Reflections.php, method Reflections::add()
Instantiates a new ReflectionClass for the given class.
- add_condition
- in file Utils.php, method Utils::add_condition()
- add_on_blank
- in file Validations.php, method Errors::add_on_blank()
Adds the error message only if the attribute value was null or an empty string.
- add_on_empty
- in file Validations.php, method Errors::add_on_empty()
Adds an error message only if the attribute value is empty.
- all
- in file Model.php, method Model::all()
Alias for self::find('all').
- all
- in file Utils.php, function all()
Returns true if all values in $haystack === $needle
- append_record_to_associate
- in file Relationship.php, method AbstractRelationship::append_record_to_associate()
- ArraySerializer
- in file Serialization.php, class ArraySerializer
Array serializer.
- array_flatten
- in file Utils.php, function array_flatten()
- assign_attribute
- in file Model.php, method Model::assign_attribute()
Assign a value to an attribute.
- attributes
- in file Model.php, method Model::attributes()
Returns a copy of the model's attributes hash.
- attribute_is_dirty
- in file Model.php, method Model::attribute_is_dirty()
Check if a particular attribute has been modified since loading the model.
- attribute_of
- in file DateTime.php, method DateTime::attribute_of()
top
top
c
- $callback
- in file Table.php, variable Table::$callback
A instance of CallBack for this model/table
- $class
- in file Table.php, variable Table::$class
- $class_name
- in file Relationship.php, variable AbstractRelationship::$class_name
Class name of the associated model.
- $columns
- in file Table.php, variable Table::$columns
- $conn
- in file Table.php, variable Table::$conn
- $connection
- in file Model.php, variable Model::$connection
Set to the name of the connection this Model should use.
- $connection
- in file Connection.php, variable Connection::$connection
The PDO connection object.
- Cache
- in file Cache.php, class Cache
Cache::get('the-cache-key', function() {
- CallBack
- in file CallBack.php, class CallBack
Callbacks allow the programmer to hook into the life cycle of a Model.
- camelize
- in file Inflector.php, method Inflector::camelize()
Turn a string into its camelized version.
- cast
- in file Column.php, method Column::cast()
Casts a value to the column's type.
- classify
- in file Utils.php, function classify()
- clear
- in file Validations.php, method Errors::clear()
Clears out all error messages.
- clear_cache
- in file Table.php, method Table::clear_cache()
- clear_model
- in file Validations.php, method Errors::clear_model()
Nulls $model so we don't get pesky circular references. $model is only needed during the validation process and so can be safely cleared once that is done.
- collect
- in file Utils.php, function collect()
- Column
- in file Column.php, class Column
Class for a table column.
- columns
- in file Connection.php, method Connection::columns()
Retrieves column meta data for the specified table.
- commit
- in file Connection.php, method Connection::commit()
Commits the current transaction.
- Config
- in file Config.php, class Config
Manages configuration options for ActiveRecord.
- ConfigException
- in file Exceptions.php, class ConfigException
Thrown for configuration problems.
- Connection
- in file Connection.php, class Connection
The base class for database connection adapters.
- connection
- in file Model.php, method Model::connection()
Retrieve the connection for this model.
- ConnectionManager
- in file ConnectionManager.php, class ConnectionManager
Singleton to manage any and all database connections.
- construct_inner_join_sql
- in file Relationship.php, method AbstractRelationship::construct_inner_join_sql()
Creates INNER JOIN SQL for associations.
- count
- in file Model.php, method Model::count()
Get a count of qualifying records.
- create
- in file Model.php, method Model::create()
Creates a model and saves it to the database.
- create_association
- in file Relationship.php, method AbstractRelationship::create_association()
Creates a new instance of Model and invokes save.
- create_association
- in file Relationship.php, method HasMany::create_association()
- create_association
- in file Relationship.php, method InterfaceRelationship::create_association()
- create_column
- in file MysqlAdapter.php, method MysqlAdapter::create_column()
- create_column
- in file PgsqlAdapter.php, method PgsqlAdapter::create_column()
- create_column
- in file OciAdapter.php, method OciAdapter::create_column()
- create_column
- in file SqliteAdapter.php, method SqliteAdapter::create_column()
- create_conditions_from_keys
- in file Relationship.php, method AbstractRelationship::create_conditions_from_keys()
- create_conditions_from_underscored_string
- in file SQLBuilder.php, method SQLBuilder::create_conditions_from_underscored_string()
Converts a string like "id_and_name_or_z" into a conditions value like array("id=? AND name=? OR z=?", values, ...).
- create_hash_from_underscored_string
- in file SQLBuilder.php, method SQLBuilder::create_hash_from_underscored_string()
Like create_conditions_from_underscored_string but returns a hash of name => value array instead.
- create_joins
- in file Table.php, method Table::create_joins()
- CsvSerializer
- in file Serialization.php, class CsvSerializer
CSV serializer.
top
d
- $DATETIME_FORMAT
- in file Serialization.php, variable Serialization::$DATETIME_FORMAT
The default format to serialize DateTime objects to.
- $db
- in file Model.php, variable Model::$db
Set to the name of the database this Model's table is in.
- $db_name
- in file Table.php, variable Table::$db_name
Name of the database (optional)
- $default
- in file Column.php, variable Column::$default
The default value of the column.
- $DEFAULT_ERROR_MESSAGES
- in file Validations.php, variable Errors::$DEFAULT_ERROR_MESSAGES
- $DEFAULT_FORMAT
- in file DateTime.php, variable DateTime::$DEFAULT_FORMAT
Default format used for format() and __toString()
- $DEFAULT_PORT
- in file MysqlAdapter.php, variable MysqlAdapter::$DEFAULT_PORT
- $DEFAULT_PORT
- in file PgsqlAdapter.php, variable PgsqlAdapter::$DEFAULT_PORT
- $DEFAULT_PORT
- in file Connection.php, variable Connection::$DEFAULT_PORT
Default port.
- $DEFAULT_PORT
- in file OciAdapter.php, variable OciAdapter::$DEFAULT_PORT
- $delegate
- in file Model.php, variable Model::$delegate
Delegates calls to a relationship.
- $delimiter
- in file Serialization.php, variable CsvSerializer::$delimiter
- $dsn_params
- in file OciAdapter.php, variable OciAdapter::$dsn_params
- DatabaseException
- in file Exceptions.php, class DatabaseException
Thrown when there was an error performing a database operation.
- DATE
- in file Column.php, class constant Column::DATE
- DateTime
- in file DateTime.php, class DateTime
An extension of PHP's DateTime class to provide dirty flagging and easier formatting options.
- DATETIME
- in file Column.php, class constant Column::DATETIME
- datetime_to_string
- in file OciAdapter.php, method OciAdapter::datetime_to_string()
- datetime_to_string
- in file Connection.php, method Connection::datetime_to_string()
Return a date time formatted into the database's datetime format.
- date_to_string
- in file OciAdapter.php, method OciAdapter::date_to_string()
- date_to_string
- in file Connection.php, method Connection::date_to_string()
Return a date time formatted into the database's date format.
- DECIMAL
- in file Column.php, class constant Column::DECIMAL
- delete
- in file SQLBuilder.php, method SQLBuilder::delete()
- delete
- in file Model.php, method Model::delete()
Deletes this model from the database and returns true if successful.
- delete
- in file Table.php, method Table::delete()
- delete_all
- in file Model.php, method Model::delete_all()
Deletes records matching conditions in $options
- denamespace
- in file Utils.php, function denamespace()
Strips a class name of any namespaces and namespace operator.
- destroy
- in file Reflections.php, method Reflections::destroy()
Destroys the cached ReflectionClass.
- dirty_attributes
- in file Model.php, method Model::dirty_attributes()
Returns hash of attributes that have been modified since loading the model.
- drop_connection
- in file ConnectionManager.php, method ConnectionManager::drop_connection()
Drops the connection from the connection manager. Does not actually close it since there is no close method in PDO.
top
top
f
- $foreign_key
- in file Relationship.php, variable AbstractRelationship::$foreign_key
Name of the foreign key.
- $FORMATS
- in file DateTime.php, variable DateTime::$FORMATS
Pre-defined format strings.
- find
- in file Table.php, method Table::find()
- find
- in file Model.php, method Model::find()
Find records in the database.
- find_by_pk
- in file Model.php, method Model::find_by_pk()
Finder method which will find by a single or array of primary keys for this model.
- find_by_sql
- in file Table.php, method Table::find_by_sql()
- find_by_sql
- in file Model.php, method Model::find_by_sql()
Find using a raw SELECT query.
- first
- in file Model.php, method Model::first()
Alias for self::find('first').
- flag_dirty
- in file Model.php, method Model::flag_dirty()
Flags an attribute as dirty.
- flush
- in file Memcache.php, method Memcache::flush()
- flush
- in file Cache.php, method Cache::flush()
- format
- in file DateTime.php, method DateTime::format()
Formats the DateTime to the specified format.
- full_messages
- in file Validations.php, method Errors::full_messages()
Returns all the error messages as an array.
top
g
- get
- in file Reflections.php, method Reflections::get()
Get a cached ReflectionClass.
- get
- in file Cache.php, method Cache::get()
- getIterator
- in file Validations.php, method Errors::getIterator()
Returns an iterator to the error messages.
- get_callbacks
- in file CallBack.php, method CallBack::get_callbacks()
Returns all the callbacks registered for a callback type.
- get_called_class
- in file Singleton.php, method Singleton::get_called_class()
Similar to a get_called_class() for a child class to invoke.
- get_column_by_inflected_name
- in file Table.php, method Table::get_column_by_inflected_name()
- get_connection
- in file Expressions.php, method Expressions::get_connection()
Returns the connection object.
- get_connection
- in file ConnectionManager.php, method ConnectionManager::get_connection()
If $name is null then the default connection will be returned.
- get_connection
- in file Config.php, method Config::get_connection()
Returns a connection string if found otherwise null.
- get_connections
- in file Config.php, method Config::get_connections()
Returns the connection strings array.
- get_date_format
- in file Config.php, method Config::get_date_format()
- get_default_connection
- in file Config.php, method Config::get_default_connection()
Returns the name of the default connection.
- get_default_connection_string
- in file Config.php, method Config::get_default_connection_string()
Returns the default connection string or null if there is none.
- get_format
- in file DateTime.php, method DateTime::get_format()
Returns the format string.
- get_fully_qualified_table_name
- in file Table.php, method Table::get_fully_qualified_table_name()
- get_logger
- in file Config.php, method Config::get_logger()
Returns the logger
- get_logging
- in file Config.php, method Config::get_logging()
Return whether or not logging is on
- get_model_directory
- in file Config.php, method Config::get_model_directory()
Returns the model directory.
- get_namespaces
- in file Utils.php, function get_namespaces()
- get_next_sequence_value
- in file OciAdapter.php, method OciAdapter::get_next_sequence_value()
- get_primary_key
- in file Model.php, method Model::get_primary_key()
Retrieve the primary key name.
- get_raw_errors
- in file Validations.php, method Errors::get_raw_errors()
Returns the internal errors object.
- get_real_attribute_name
- in file Model.php, method Model::get_real_attribute_name()
Returns the actual attribute name if $name is aliased.
- get_record
- in file Validations.php, method Validations::get_record()
- get_relationship
- in file Table.php, method Table::get_relationship()
Retrieve a relationship object for this table. Strict as true will throw an error if the relationship name does not exist.
- get_sequence_name
- in file Connection.php, method Connection::get_sequence_name()
Return a default sequence name for the specified table.
- get_sequence_name
- in file PgsqlAdapter.php, method PgsqlAdapter::get_sequence_name()
- get_table
- in file Relationship.php, method AbstractRelationship::get_table()
- get_validation_rules
- in file Model.php, method Model::get_validation_rules()
Returns array of validator data for this Model.
- get_values_for
- in file Model.php, method Model::get_values_for()
Returns an associative array containing values for all the attributes in $attributes
- get_where_values
- in file SQLBuilder.php, method SQLBuilder::get_where_values()
- group
- in file SQLBuilder.php, method SQLBuilder::group()
top
top
i
- $includes_with_class_name_element
- in file Serialization.php, variable Serialization::$includes_with_class_name_element
Set this to true if the serializer needs to create a nested array keyed on the name of the included classes such as for xml serialization.
- $include_root
- in file Serialization.php, variable ArraySerializer::$include_root
- $include_root
- in file Serialization.php, variable JsonSerializer::$include_root
- $inflected_name
- in file Column.php, variable Column::$inflected_name
The inflected name of this columns .. hyphens/spaces will be => _.
- Inflector
- in file Inflector.php, class Inflector
- initialize
- in file Cache.php, method Cache::initialize()
Initializes the cache.
- initialize
- in file Config.php, method Config::initialize()
Allows config initialization using a closure.
- insert
- in file SQLBuilder.php, method SQLBuilder::insert()
- insert
- in file Table.php, method Table::insert()
- insert_id
- in file Connection.php, method Connection::insert_id()
Retrieve the insert id of the last model saved.
- instance
- in file Singleton.php, method Singleton::instance()
Static method for instantiating a singleton object.
- instance
- in file Inflector.php, method Inflector::instance()
Get an instance of the Inflector class.
- instance
- in file Connection.php, method Connection::instance()
Retrieve a database connection.
- INTEGER
- in file Column.php, class constant Column::INTEGER
- InterfaceRelationship
- in file Relationship.php, class InterfaceRelationship
Interface for a table relationship.
- invoke
- in file CallBack.php, method CallBack::invoke()
Invokes a callback.
- is_a
- in file Utils.php, method Utils::is_a()
- is_blank
- in file Utils.php, method Utils::is_blank()
- is_dirty
- in file Model.php, method Model::is_dirty()
Returns true if the model has been modified.
- is_empty
- in file Validations.php, method Errors::is_empty()
Returns true if there are no error messages.
- is_hash
- in file Utils.php, function is_hash()
Somewhat naive way to determine if an array is a hash.
- is_invalid
- in file Model.php, method Model::is_invalid()
Runs validations and returns true if invalid.
- is_invalid
- in file Validations.php, method Errors::is_invalid()
Returns true if the specified attribute had any error messages.
- is_lower
- in file Inflector.php, method Inflector::is_lower()
Determines if a string contains all lowercase characters.
- is_new_record
- in file Model.php, method Model::is_new_record()
Determine if the model is a new record.
- is_odd
- in file Utils.php, method Utils::is_odd()
- is_options_hash
- in file Model.php, method Model::is_options_hash()
Determines if the specified array is a valid ActiveRecord options array.
- is_poly
- in file Relationship.php, method AbstractRelationship::is_poly()
What is this relationship's cardinality?
- is_readonly
- in file Model.php, method Model::is_readonly()
Determine if the model is in read-only mode.
- is_upper
- in file Inflector.php, method Inflector::is_upper()
Determines if a string contains all uppercase characters.
- is_valid
- in file Model.php, method Model::is_valid()
Run validations on model and returns whether or not model passed validation.
top
top
top
l
- $last_query
- in file Connection.php, variable Connection::$last_query
The last query run.
- $last_sql
- in file Table.php, variable Table::$last_sql
- $length
- in file Column.php, variable Column::$length
The maximum length of this column.
- last
- in file Model.php, method Model::last()
Alias for self::find('last')
- limit
- in file SqliteAdapter.php, method SqliteAdapter::limit()
- limit
- in file PgsqlAdapter.php, method PgsqlAdapter::limit()
- limit
- in file OciAdapter.php, method OciAdapter::limit()
- limit
- in file Connection.php, method Connection::limit()
Adds a limit clause to the SQL query.
- limit
- in file MysqlAdapter.php, method MysqlAdapter::limit()
- limit
- in file SQLBuilder.php, method SQLBuilder::limit()
- load
- in file Table.php, method Table::load()
- load
- in file Relationship.php, method BelongsTo::load()
- load
- in file Relationship.php, method AbstractRelationship::load()
This will load the related model data.
- load
- in file Relationship.php, method HasAndBelongsToMany::load()
- load
- in file Relationship.php, method HasMany::load()
- load_eagerly
- in file Relationship.php, method BelongsTo::load_eagerly()
- load_eagerly
- in file Relationship.php, method HasMany::load_eagerly()
top
top
n
- $name
- in file Column.php, variable Column::$name
The true name of this column.
- $nullable
- in file Column.php, variable Column::$nullable
True if this column allows null.
- native_database_types
- in file PgsqlAdapter.php, method PgsqlAdapter::native_database_types()
- native_database_types
- in file SqliteAdapter.php, method SqliteAdapter::native_database_types()
- native_database_types
- in file OciAdapter.php, method OciAdapter::native_database_types()
- native_database_types
- in file MysqlAdapter.php, method MysqlAdapter::native_database_types()
- native_database_types
- in file Connection.php, method Connection::native_database_types()
- next_sequence_value
- in file PgsqlAdapter.php, method PgsqlAdapter::next_sequence_value()
- next_sequence_value
- in file Connection.php, method Connection::next_sequence_value()
Return SQL for getting the next value in a sequence.
- next_sequence_value
- in file OciAdapter.php, method OciAdapter::next_sequence_value()
top
top
p
- $PDO_OPTIONS
- in file Connection.php, variable Connection::$PDO_OPTIONS
Default PDO options to set for each connection.
- $pk
- in file Column.php, variable Column::$pk
True if this column is a primary key.
- $pk
- in file Table.php, variable Table::$pk
- $poly_relationship
- in file Relationship.php, variable AbstractRelationship::$poly_relationship
Is the relationship single or multi.
- $primary_key
- in file Relationship.php, variable HasMany::$primary_key
- $primary_key
- in file Model.php, variable Model::$primary_key
Set this to override the default primary key name if different from default name of "id".
- $protocol
- in file Connection.php, variable Connection::$protocol
The name of the protocol that is used.
- ParameterMarker
- in file Expressions.php, class constant Expressions::ParameterMarker
- parse_connection_url
- in file Connection.php, method Connection::parse_connection_url()
Use this for any adapters that can take connection info in the form below to set the adapters connection info.
- PgsqlAdapter
- in file PgsqlAdapter.php, class PgsqlAdapter
Adapter for Postgres (not completed yet)
- pk_conditions
- in file Model.php, method Model::pk_conditions()
Returns a hash containing the names => values of the primary key.
- pluralize
- in file Utils.php, method Utils::pluralize()
- pluralize_if
- in file Utils.php, method Utils::pluralize_if()
top
q
- $QUOTE_CHARACTER
- in file OciAdapter.php, variable OciAdapter::$QUOTE_CHARACTER
- $QUOTE_CHARACTER
- in file PgsqlAdapter.php, variable PgsqlAdapter::$QUOTE_CHARACTER
- $QUOTE_CHARACTER
- in file Connection.php, variable Connection::$QUOTE_CHARACTER
The quote character for stuff like column and field names.
- query
- in file Model.php, method Model::query()
Helper method to run arbitrary queries against the model's database connection.
- query
- in file Connection.php, method Connection::query()
Execute a raw SQL query on the database.
- query_and_attach_related_models_eagerly
- in file Relationship.php, method AbstractRelationship::query_and_attach_related_models_eagerly()
Eagerly loads relationships for $models.
- query_and_fetch
- in file Connection.php, method Connection::query_and_fetch()
Execute a raw SQL query and fetch the results.
- query_and_fetch_one
- in file Connection.php, method Connection::query_and_fetch_one()
Execute a query that returns maximum of one row with one field and return it.
- query_column_info
- in file SqliteAdapter.php, method SqliteAdapter::query_column_info()
- query_column_info
- in file PgsqlAdapter.php, method PgsqlAdapter::query_column_info()
- query_column_info
- in file MysqlAdapter.php, method MysqlAdapter::query_column_info()
- query_column_info
- in file OciAdapter.php, method OciAdapter::query_column_info()
- query_column_info
- in file Connection.php, method Connection::query_column_info()
Query for column meta info and return statement handle.
- query_for_tables
- in file SqliteAdapter.php, method SqliteAdapter::query_for_tables()
- query_for_tables
- in file PgsqlAdapter.php, method PgsqlAdapter::query_for_tables()
- query_for_tables
- in file MysqlAdapter.php, method MysqlAdapter::query_for_tables()
- query_for_tables
- in file OciAdapter.php, method OciAdapter::query_for_tables()
- query_for_tables
- in file Connection.php, method Connection::query_for_tables()
Query for all tables in the current database. The result must only contain one column which has the name of the table.
- quote_name
- in file Connection.php, method Connection::quote_name()
Quote a name like table names and field names.
top
r
- $raw_type
- in file Column.php, variable Column::$raw_type
The raw database specific type.
- read
- in file Memcache.php, method Memcache::read()
- readonly
- in file Model.php, method Model::readonly()
Flag model as readonly.
- ReadOnlyException
- in file Exceptions.php, class ReadOnlyException
Thrown when attempting to perform a write operation on a Model that is in read-only mode.
- read_attribute
- in file Model.php, method Model::read_attribute()
Retrieves an attribute's value or a relationship object based on the name passed. If the attribute accessed is 'id' then it will return the model's primary key no matter what the actual attribute name is for the primary key.
- RecordNotFound
- in file Exceptions.php, class RecordNotFound
Thrown when a record cannot be found.
- reestablish_connection
- in file Model.php, method Model::reestablish_connection()
Re-establishes the database connection with a new connection.
- reestablish_connection
- in file Table.php, method Table::reestablish_connection()
- Reflections
- in file Reflections.php, class Reflections
Simple class that caches reflections of classes.
- register
- in file CallBack.php, method CallBack::register()
Register a new callback.
- RelationshipException
- in file Exceptions.php, class RelationshipException
Thrown for relationship exceptions.
- reload
- in file Model.php, method Model::reload()
Reloads the attributes and relationships of this object from the database.
- reset_dirty
- in file Model.php, method Model::reset_dirty()
Resets the dirty array.
- reverse_order
- in file SQLBuilder.php, method SQLBuilder::reverse_order()
Reverses an order clause.
- rollback
- in file Connection.php, method Connection::rollback()
Rollback a transaction.
- rules
- in file Validations.php, method Validations::rules()
Returns validator data.
top
s
- $sequence
- in file Model.php, variable Model::$sequence
Set this to explicitly specify the sequence name for the table.
- $sequence
- in file Column.php, variable Column::$sequence
Name of the sequence to use for this column if any.
- $sequence
- in file Table.php, variable Table::$sequence
Name of the sequence for this table (optional). Defaults to {$table}_seq
- save
- in file Model.php, method Model::save()
Save the model to the database.
- select
- in file SQLBuilder.php, method SQLBuilder::select()
- Serialization
- in file Serialization.php, class Serialization
Base class for Model serializers.
- setDate
- in file DateTime.php, method DateTime::setDate()
- setISODate
- in file DateTime.php, method DateTime::setISODate()
- setTime
- in file DateTime.php, method DateTime::setTime()
- setTimestamp
- in file DateTime.php, method DateTime::setTimestamp()
- set_attributes
- in file Model.php, method Model::set_attributes()
Mass update the model with data from an attributes hash.
- set_cache
- in file Config.php, method Config::set_cache()
Sets the url for the cache server to enable query caching.
- set_class_name
- in file Relationship.php, method AbstractRelationship::set_class_name()
- set_connection
- in file Expressions.php, method Expressions::set_connection()
Sets the connection object. It is highly recommended to set this so we can use the adapter's native escaping mechanism.
- set_connections
- in file Config.php, method Config::set_connections()
Sets the list of database connection strings.
- set_date_format
- in file Config.php, method Config::set_date_format()
- set_default_connection
- in file Config.php, method Config::set_default_connection()
Set the name of the default connection.
- set_encoding
- in file MysqlAdapter.php, method MysqlAdapter::set_encoding()
- set_encoding
- in file PgsqlAdapter.php, method PgsqlAdapter::set_encoding()
- set_encoding
- in file OciAdapter.php, method OciAdapter::set_encoding()
- set_encoding
- in file SqliteAdapter.php, method SqliteAdapter::set_encoding()
- set_encoding
- in file Connection.php, method Connection::set_encoding()
Executes query to specify the character set for this connection.
- set_inferred_class_name
- in file Relationship.php, method AbstractRelationship::set_inferred_class_name()
Infers the $this->class_name based on $this->attribute_name.
- set_keys
- in file Relationship.php, method HasMany::set_keys()
- set_logger
- in file Config.php, method Config::set_logger()
Sets the logger object for future SQL logging
- set_logging
- in file Config.php, method Config::set_logging()
Turn on/off logging
- set_model_directory
- in file Config.php, method Config::set_model_directory()
Sets the directory where models are located.
- set_relationship_from_eager_load
- in file Model.php, method Model::set_relationship_from_eager_load()
Add a model to the given named ($name) relationship.
- set_timestamps
- in file Model.php, method Model::set_timestamps()
Updates a model's timestamps.
- Singleton
- in file Singleton.php, class Singleton
This implementation of the singleton pattern does not conform to the strong definition given by the "Gang of Four." The __construct() method has not be privatized so that a singleton pattern is capable of being achieved; however, multiple instantiations are also possible. This allows the user more freedom with this pattern.
- singularize
- in file Utils.php, method Utils::singularize()
- size
- in file Validations.php, method Errors::size()
Returns the number of error messages there are.
- SQLBuilder
- in file SQLBuilder.php, class SQLBuilder
Helper class for building sql statements progmatically.
- SqliteAdapter
- in file SqliteAdapter.php, class SqliteAdapter
Adapter for SQLite.
- squeeze
- in file Utils.php, method Utils::squeeze()
- StandardInflector
- in file Inflector.php, class StandardInflector
- STRING
- in file Column.php, class constant Column::STRING
- string_to_datetime
- in file OciAdapter.php, method OciAdapter::string_to_datetime()
- string_to_datetime
- in file Connection.php, method Connection::string_to_datetime()
Converts a string representation of a datetime into a DateTime object.
- supports_sequences
- in file OciAdapter.php, method OciAdapter::supports_sequences()
- supports_sequences
- in file PgsqlAdapter.php, method PgsqlAdapter::supports_sequences()
- supports_sequences
- in file Connection.php, method Connection::supports_sequences()
Tells you if this adapter supports sequences or not.
top
t
- $table
- in file Table.php, variable Table::$table
Name of the table.
- $table_name
- in file Model.php, variable Model::$table_name
Set this to explicitly specify the model's table name if different from inferred name.
- $type
- in file Column.php, variable Column::$type
The type of this column: STRING, INTEGER, ...
- $TYPE_MAPPING
- in file Column.php, variable Column::$TYPE_MAPPING
Map a type to an column type.
- Table
- in file Table.php, class Table
Manages reading and writing to a database table.
- table
- in file Model.php, method Model::table()
Returns the Table object for this model.
- tableize
- in file Inflector.php, method StandardInflector::tableize()
- tables
- in file Connection.php, method Connection::tables()
Returns all tables for the current database.
- table_name
- in file Model.php, method Model::table_name()
Retrieves the name of the table for this Model.
- TIME
- in file Column.php, class constant Column::TIME
- to_a
- in file Serialization.php, method Serialization::to_a()
Returns the attributes array.
- to_array
- in file Model.php, method Model::to_array()
Returns an Array representation of this model.
- to_array
- in file Validations.php, method Errors::to_array()
Returns all the error messages as an array, including error key.
- to_csv
- in file Model.php, method Model::to_csv()
Returns an CSV representation of this model.
- to_json
- in file Model.php, method Model::to_json()
Returns a JSON representation of this model.
- to_s
- in file SQLBuilder.php, method SQLBuilder::to_s()
Returns the SQL string.
- to_s
- in file Expressions.php, method Expressions::to_s()
- to_s
- in file Serialization.php, method CsvSerializer::to_s()
- to_s
- in file Serialization.php, method XmlSerializer::to_s()
- to_s
- in file Serialization.php, method JsonSerializer::to_s()
- to_s
- in file Serialization.php, method Serialization::to_s()
Performs the serialization.
- to_s
- in file Serialization.php, method ArraySerializer::to_s()
- to_xml
- in file Model.php, method Model::to_xml()
Returns an XML representation of this model.
- transaction
- in file Connection.php, method Connection::transaction()
Starts a transaction.
- transaction
- in file Model.php, method Model::transaction()
Executes a block of code inside a database transaction.
top
u
- uncamelize
- in file Inflector.php, method Inflector::uncamelize()
Convert a camelized string to a lowercase, underscored string.
- UndefinedPropertyException
- in file Exceptions.php, class UndefinedPropertyException
Thrown when attempting to access an invalid property on a Model.
- underscorify
- in file Inflector.php, method Inflector::underscorify()
Convert a string with space into a underscored equivalent.
- unset_non_finder_options
- in file Relationship.php, method AbstractRelationship::unset_non_finder_options()
- update
- in file SQLBuilder.php, method SQLBuilder::update()
- update
- in file Table.php, method Table::update()
- update_all
- in file Model.php, method Model::update_all()
Updates records using set in $options
- update_attribute
- in file Model.php, method Model::update_attribute()
Updates a single attribute and saves the record without going through the normal validation procedure.
- update_attributes
- in file Model.php, method Model::update_attributes()
Mass update the model with an array of attribute data and saves to the database.
- Utils
- in file Utils.php, class Utils
Some internal utility functions.
top
v
- $valid_association_options
- in file Relationship.php, variable AbstractRelationship::$valid_association_options
List of valid options for relationships.
- $valid_association_options
- in file Relationship.php, variable HasMany::$valid_association_options
Valid options to use for a HasMany relationship.
- $VALID_CALLBACKS
- in file CallBack.php, variable CallBack::$VALID_CALLBACKS
List of available callbacks.
- $VALID_OPTIONS
- in file Model.php, variable Model::$VALID_OPTIONS
A list of valid finder options.
- validate
- in file Validations.php, method Validations::validate()
Runs the validators.
- validates_exclusion_of
- in file Validations.php, method Validations::validates_exclusion_of()
This is the opposite of validates_include_of.
- validates_format_of
- in file Validations.php, method Validations::validates_format_of()
Validates that a value is matches a regex.
- validates_inclusion_of
- in file Validations.php, method Validations::validates_inclusion_of()
Validates that a value is included the specified array.
- validates_inclusion_or_exclusion_of
- in file Validations.php, method Validations::validates_inclusion_or_exclusion_of()
Validates that a value is in or out of a specified list of values.
- validates_length_of
- in file Validations.php, method Validations::validates_length_of()
Validates the length of a value.
- validates_numericality_of
- in file Validations.php, method Validations::validates_numericality_of()
Validates that a value is numeric.
- validates_presence_of
- in file Validations.php, method Validations::validates_presence_of()
Validates a field is not null and not blank.
- validates_size_of
- in file Validations.php, method Validations::validates_size_of()
Alias of validates_length_of
- validates_uniqueness_of
- in file Validations.php, method Validations::validates_uniqueness_of()
Validates the uniqueness of a value.
- Validations
- in file Validations.php, class Validations
Manages validations for a Model.
- ValidationsArgumentError
- in file Exceptions.php, class ValidationsArgumentError
Thrown for validations exceptions.
- values
- in file Expressions.php, method Expressions::values()
Returns all the values currently bound.
- values_for
- in file Model.php, method Model::values_for()
Helper to return a hash of values for the specified attributes.
- values_for_pk
- in file Model.php, method Model::values_for_pk()
Helper that creates an array of values for the primary key(s).
- variablize
- in file Inflector.php, method StandardInflector::variablize()
- variablize
- in file Inflector.php, method Inflector::variablize()
top
top
x
- XmlSerializer
- in file Serialization.php, class XmlSerializer
XML serializer.
top
_
- __call
- in file Model.php, method Model::__call()
Enables the use of build|create for associations.
- __callStatic
- in file Model.php, method Model::__callStatic()
Enables the use of dynamic finders.
- __clone
- in file Model.php, method Model::__clone()
- __construct
- in file Relationship.php, method HasMany::__construct()
Constructs a HasMany relationship.
- __construct
- in file Relationship.php, method HasAndBelongsToMany::__construct()
- __construct
- in file Relationship.php, method AbstractRelationship::__construct()
Constructs a relationship.
- __construct
- in file Relationship.php, method BelongsTo::__construct()
- __construct
- in file Relationship.php, method InterfaceRelationship::__construct()
- __construct
- in file Serialization.php, method Serialization::__construct()
Constructs a Serialization object.
- __construct
- in file Validations.php, method Errors::__construct()
Constructs an Errors object.
- __construct
- in file Validations.php, method Validations::__construct()
Constructs a Validations object.
- __construct
- in file Table.php, method Table::__construct()
- __construct
- in file SqliteAdapter.php, method SqliteAdapter::__construct()
- __construct
- in file Serialization.php, method XmlSerializer::__construct()
- __construct
- in file SQLBuilder.php, method SQLBuilder::__construct()
Constructor.
- __construct
- in file CallBack.php, method CallBack::__construct()
Creates a CallBack.
- __construct
- in file OciAdapter.php, method OciAdapter::__construct()
- __construct
- in file Exceptions.php, method UndefinedPropertyException::__construct()
Sets the exception message to show the undefined property's name.
- __construct
- in file Exceptions.php, method ReadOnlyException::__construct()
Sets the exception message to show the undefined property's name.
- __construct
- in file Exceptions.php, method DatabaseException::__construct()
- __construct
- in file Connection.php, method Connection::__construct()
Class Connection is a singleton. Access it via instance().
- __construct
- in file Memcache.php, method Memcache::__construct()
- __construct
- in file Expressions.php, method Expressions::__construct()
- __construct
- in file Model.php, method Model::__construct()
Constructs a model.
- __get
- in file Validations.php, method Errors::__get()
Retrieve error messages for an attribute.
- __get
- in file Model.php, method Model::__get()
Magic method which delegates to read_attribute(). This handles firing off getter methods, as they are not checked/invoked inside of read_attribute(). This circumvents the problem with a getter being accessed with the same name as an actual attribute.
- __isset
- in file Model.php, method Model::__isset()
Determines if an attribute exists for this Model.
- __set
- in file Model.php, method Model::__set()
Magic allows un-defined attributes to set via $attributes.
- __toString
- in file Validations.php, method Errors::__toString()
Convert all error messages to a String.
- __toString
- in file DateTime.php, method DateTime::__toString()
- __toString
- in file Serialization.php, method Serialization::__toString()
Returns the serialized object as a string.
- __toString
- in file SQLBuilder.php, method SQLBuilder::__toString()
Returns the SQL string.
- __wakeup
- in file Model.php, method Model::__wakeup()
top