static $active_connections = array()
[line 166]
Stores the active connections. Indexed on $connection_name.
Tags:
static $begin_executed = false
[line 427]
Transactions (only use if your db supports it)
This is for transactions only to let query() know that a 'BEGIN' has been executed
Tags:
static $database_settings = array()
[line 161]
Stores the database settings
Tags:
static $db = null
[line 75]
Reference to the database object
Reference to the database object returned by PEAR MDB2::Connect()
Tags:
static $query_log = array()
[line 438]
Keep a log of queries executed if in development env
Tags:
static $table_info = array()
[line 109]
Table Info
Array to hold all the info about table columns. Indexed on $table_name.
Tags:
static $use_transactions = false
[line 433]
Transactions (only use if your db supports it) This will issue a rollback command if any sql fails.
Tags:
$aggregations = array("count","sum","avg","max","min")
[line 318]
SQL aggregate functions that may be applied to the associated table.
SQL defines aggregate functions AVG, COUNT, MAX, MIN and SUM. Not all of these functions are implemented by all DBMS's
Tags:
$auto_create_timestamps = array("created_at","created_on")
[line 281]
Names of automatic create timestamp columns
When a row containing one of these columns is created and $auto_timestamps is true, store the current date and time in the timestamp columns.
Tags:
$auto_delete_habtm = true
[line 421]
Auto delete $has_and_belongs_to_many associations
Tags:
$auto_save_associations = true
[line 246]
Whether or not to auto save defined associations if set
Tags:
$auto_save_habtm = true
[line 416]
Auto insert / update $has_and_belongs_to_many tables
Tags:
$auto_timestamps = true
[line 411]
Whether to automatically update timestamps in certain columns
Tags:
$auto_update_timestamps = array("updated_at","updated_on")
[line 269]
Names of automatic update timestamp columns
When a row containing one of these columns is updated and $auto_timestamps is true, update the contents of the timestamp columns with the current date and time.
Tags:
$belongs_to = null
[line 229]
Tags:
$builtin_validation_functions = array(
'validates_acceptance_of',
'validates_confirmation_of',
'validates_exclusion_of',
'validates_format_of',
'validates_inclusion_of',
'validates_length_of',
'validates_numericality_of',
'validates_presence_of',
'validates_uniqueness_of'
)
[line 392]
An array of all the builtin validation function calls.
Tags:
$class_name = null
[line 119]
Class name
Name of the child class. (this is optional and will automatically be determined) Normally set to the singular camel case form of the table name. May be overridden.
Tags:
$composed_of = null
[line 204]
Composite custom user created objects
Tags:
$connection_name = TRAX_ENV
[line 156]
Index into the $active_connections array
Name of the index to use to return or set the current db connection Mainly used if you want to connect to different databases between different models.
Tags:
$content_columns = null
[line 101]
Description of a row in the associated table in the database
Retrieved from the RDBMS by set_content_columns(). See DB_common::tableInfo() for the format. NOTE: Some RDBMS's don't return all values.
An additional element 'human_name' is added to each column by set_content_columns(). The actual value contained in each column is stored in an object variable with the name given by the 'name' element of the column description for each column.
NOTE:The information from the database about which columns are primary keys is not used. Instead, the primary keys in the table are listed in $primary_keys, which is maintained independently.
Tags:
$database_name = null
[line 146]
Database name override
Name of the database to use, if you are not using the value read from file config/database.ini
Tags:
$date_format = "Y-m-d"
[line 290]
Date format for use with auto timestamping
The format for this should be compatiable with the php date() function. http://www.php.net/date
Tags:
$default_error_messages = array(
'inclusion' => "is not included in the list",
'exclusion' => "is reserved",
'invalid' => "is invalid",
'confirmation' => "doesn't match confirmation",
'accepted ' => "must be accepted",
'empty' => "can't be empty",
'blank' => "can't be blank",
'too_long' => "is too long (max is %d characters)",
'too_short' => "is too short (min is %d characters)",
'wrong_length' => "is the wrong length (should be %d characters)",
'taken' => "has already been taken",
'not_a_number' => "is not a number",
'not_an_integer' => "is not an integer"
)
[line 373]
An array with all the default error messages.
Tags:
$display = 10
[line 346]
Pagination how many numbers in the list < 1 2 3 4 > >>
Tags:
$errors = array()
[line 368]
Description of non-fatal errors found
For every non-fatal error found, an element describing the error is added to $errors. Initialized to an empty array in valid() before validating object. When an error message is associated with a particular attribute, the message should be stored with the attribute name as its key. If the message is independent of attributes, store it with a numeric key beginning with 0.
Tags:
$fetch_mode = MDB2_FETCHMODE_ASSOC
[line 176]
Mode to use when fetching data from database
See the relevant PEAR MDB2 class documentation
Tags:
$force_reconnect = false
[line 183]
Force reconnect to database every page load
Tags:
$habtm_attributes = null
[line 235]
Tags:
$has_and_belongs_to_many = null
[line 223]
Tags:
$has_many = null
[line 211]
Tags:
$has_one = null
[line 217]
Tags:
$index_on = "id"
[line 191]
find_all() returns an array of objects, each object index is off of this field
Tags:
$lock_optimistically = true
[line 198]
Not yet implemented (page 222 Rails books)
Tags:
$new_record = true
[line 257]
Whether this object represents a new record
true => This object was created without reading a row from the database, so use SQL 'INSERT' to put it in the database. false => This object was a row read from the database, so use SQL 'UPDATE' to update database with new values.
Tags:
$pagination_count = 0
[line 351]
Tags:
$preserve_null_dates = true
[line 308]
Whether to keep date/datetime fields NULL if not set
true => If date field is not set it try to preserve NULL false => Don't try to preserve NULL if field is already NULL
Tags:
$primary_keys = array("id")
[line 335]
Primary key of the associated table
Array element(s) name the primary key column(s), as used to specify the row to be updated or deleted. To be a primary key a column must be listed both here and in $content_columns. NOTE:This field is maintained by hand. It is not derived from the table description read from the database.
Tags:
$rows_per_page_default = 20
[line 341]
Default for how many rows to return from find_all()
Tags:
$save_associations = array()
[line 240]
Tags:
$table_name = null
[line 129]
Table name
Name of the table in the database associated with the subclass. Normally set to the pluralized lower case underscore form of the class name by the constructor. May be overridden.
Tags:
$table_prefix = null
[line 137]
Table prefix
Name to prefix to the $table_name. May be overridden.
Tags:
$time_format = "H:i:s"
[line 299]
Time format for use with auto timestamping
The format for this should be compatiable with the php date() function. http://www.php.net/date
Tags:
constructor __construct [line 456]
ActiveRecord __construct(
[string[]
$attributes = null])
|
|
Construct an ActiveRecord object
- Establish a connection to the database
- Find the name of the table associated with this object
- Read description of this table from the database
- Optionally apply update information to column attributes
Tags:
Parameters:
method add_error [line 3173]
void add_error(
string
$error, [string
$key = null])
|
|
Add or overwrite description of an error to the list of errors
Tags:
Parameters:
method add_habtm_records [line 2034]
void add_habtm_records(
$this_foreign_value)
|
|
Tags:
Parameters:
method add_record [line 1686]
Insert a new row in the table associated with this object
Build an SQL INSERT statement getting the table name from $table_name, the column names from $content_columns and the values from object variables. Send the insert to the RDBMS.
Tags:
method add_record_or_update_record [line 1647]
boolean add_record_or_update_record(
)
|
|
Create or update a row in the table
If this object represents a new row in the table, insert it. Otherwise, update the exiting row. before_?() and after_?() routines will be called depending on whether the row is new.
Tags:
method after_create [line 2770]
Is called after save() on new objects that havent been saved yet (no record exists).
Tags:
method after_delete [line 2794]
Is called after delete().
Tags:
method after_save [line 2758]
Is called after save (regardless of whether its a create or update save).
Tags:
method after_update [line 2782]
Is called after save() on existing objects that has a record.
Tags:
method after_validation [line 2722]
Is called after validate().
Tags:
method after_validation_on_create [line 2734]
void after_validation_on_create(
)
|
|
Is called after validate() on new objects that haven't been saved yet (no record exists).
Tags:
method after_validation_on_update [line 2746]
void after_validation_on_update(
)
|
|
Is called after validate() on existing objects that has a record.
Tags:
method aggregate_all [line 956]
void aggregate_all(
$aggregate_type, [string[]
$parameters = null], string
$agrregrate_type)
|
|
Implement *_all() functions (SQL aggregate functions)
Apply one of the SQL aggregate functions to a column of the table associated with this object. The SQL aggregate functions are AVG, COUNT, MAX, MIN and SUM. Not all DBMS's implement all of these functions.
Tags:
Parameters:
method attribute_is_string [line 2558]
void attribute_is_string(
string
$attribute, [
$column = null])
|
|
Determine if passed in attribute (table column) is a string
Tags:
Parameters:
method before_create [line 2764]
Is called before save() on new objects that havent been saved yet (no record exists).
Tags:
method before_delete [line 2788]
Is called before delete().
Tags:
method before_save [line 2752]
Is called before save() (regardless of whether its a create or update save)
Tags:
method before_update [line 2776]
Is called before save() on existing objects that has a record.
Tags:
method before_validation [line 2716]
void before_validation(
)
|
|
Is called before validate().
Tags:
method before_validation_on_create [line 2728]
void before_validation_on_create(
)
|
|
Is called before validate() on new objects that haven't been saved yet (no record exists).
Tags:
method before_validation_on_update [line 2740]
void before_validation_on_update(
)
|
|
Is called before validate() on existing objects that has a record.
Tags:
method begin [line 1090]
Only used if you want to do transactions and your db supports transactions
Tags:
method build_sql [line 1234]
void build_sql(
[
$conditions = null], [
$order = null], [
$limit = null], [
$joins = null])
|
|
Builds a sql statement.
Tags:
Parameters:
method check_datetime [line 2112]
mixed check_datetime(
string
$field, mixed
$value)
|
|
Apply automatic timestamp updates
If automatic timestamps are in effect (as indicated by $auto_timestamps == true) and the column named in the $field argument is of type "timestamp" and matches one of the names in auto_create_timestamps or auto_update_timestamps(as selected by $new_record), then return the current date and time as a string formatted to insert in the database. Otherwise return $value.
Tags:
Parameters:
method column_attribute_exists [line 1048]
boolean column_attribute_exists(
string
$attribute)
|
|
Check whether a column exists in the associated table
When called, $content_columns lists the columns in the table described by this object.
Tags:
Parameters:
method column_for_attribute [line 1015]
void column_for_attribute(
$attribute)
|
|
get the attributes for a specific column.
Tags:
Parameters:
method column_type [line 1031]
void column_type(
$attribute)
|
|
get the columns data type.
Tags:
Parameters:
method commit [line 1101]
Only used if you want to do transactions and your db supports transactions
Tags:
method create [line 1548]
void create(
$attributes, [
$dont_validate = false])
|
|
Tags:
Parameters:
method delete [line 1917]
void delete(
[
$id = null])
|
|
Deletes the record with the given $id or if you have done a $model = $model->find($id), then $model->delete() it will delete the record it just loaded from the find() without passing anything to delete(). If an array of ids is provided, all ids in array are deleted.
Tags:
Parameters:
method delete_all [line 1981]
boolean delete_all(
[string
$conditions = null])
|
|
Delete from table all rows that match argument
Delete the row(s), if any, matching the argument.
Tags:
Parameters:
method delete_all_habtm_records [line 2079]
void delete_all_habtm_records(
$other_table_name,
$this_foreign_value)
|
|
Tags:
Parameters:
method delete_habtm_records [line 2069]
void delete_habtm_records(
$this_foreign_value)
|
|
Tags:
Parameters:
method escape [line