Docs For Class CRUDites

CRUDites

Description

CRUDités - ezSQL - MySQL utility wrapper

CRUDités is an extension of the great and well known ezSQL class. It's expecially written for MySQL Database. Depends on ezSQL_core and ezSQL_mysql

author: Marco "DWJ" Solazzi <hello@dwightjack.com>
version: 0.2b
copyright: Copyright © 2008-2009, Marco Solazzi
link: http://www.dwightjack.com
license: Dual licensed under the MIT (http://www.opensource.org/licenses/mit-license.php) and GPL (http://www.opensource.org/licenses/gpl-2.0.php) licenses.

Located in /class.crudites.php (line 16)

ezSQL_mysql
   |
   --CRUDites

Variable Summary

string $current_primary

array $current_table

mixed $dbprefix

string $dbprefix_placeholder

array $options

array $tables

mixed $table_bind

Method Summary

Methods legend:
Class method
Works on bound tables only (see here for usage)

CRUDites __construct ([string $dbuser = ''], [string $dbpassword = ''], [string $dbname = ''], [string $dbhost = 'localhost'], [string $prefix = false])

void add_table (string $table, [array $fields = null], [string $primary = 'id'], [bool $override = false])

void add_tables ([array $array = array()], [bool $override = false])

string array_to_string ([array $array = null], [ $inner_glue = '='], [ $outer_glue = ' AND '], [bool $recurse = true], string $innerglue, string $outerglue)

void bind (strin $table)

string build_query (string $table, array $value_array, string $type, mixed $where, [bool $compat = false], bool $all)

mixed check_quotes (mixed $var)

int count ([string|array $where = ''])

int count_rows ([string $table = null], [string|array $where = ''])

bool delete ([string|array $where = ''], [ $col = null], string $table)

bool delete_from (string $table, [string|array $where = ''])

bool|int exists ([string $val = ''], [string $col = null], [string $return = false])

array flat_array (array $array, [mixed $key1 = 0], [mixed $key2 = 1])

array|bool get_col_values ([string $table = null], string $field)

array|bool get_data ([array $queryArray = array()], [constant $output = OBJECT])

mixed get_option (string $var)

array get_pair (string $table, string $key1, string $key2, [string $where = ""])

array|bool get_table ([string $table = null], [constant $output = OBJECT])

mixed get_value ([string $table = null], string $field, [string|array $where = null])

array|bool get_where (mixed $string[,)

string implode (string $glue, array $array)

string insert_query (string $table, array $value_array, [bool $compat = false])

bool insert_unique (string $value, string $query)

bool insert_unique_to (string $table, string|array $field, string $value, string $query)

string mysql_curdate ()

string mysql_date_format ([string $string = null], [string $input = null], [string $output = null])

string mysql_now ()

array pair (string $key1, string $key2, [string $where = ""])

bool|int row_exists ([string $table = null], string|array $field, [string $value = ""], [string $return = false])

string select_query ([array $array = array()])

array|bool select_rows ([array $array = array()], [constant $output = OBJECT])

bool send_query (string $query, [bool $isupdate = false])

void set_option (string $var, string $value)

bool set_value ([string $table = null], string $field, string $value, [string|array $where = null])

bool store (array $value_array)

string strptime_to_timestamp ([array $array = null])

string table_name ([string $table = ''])

string to_timestamp (string $string, string $format)

string update_query (string $table, array $value_array, mixed $where, [bool $all = false], [bool $compat = false])

Variables

string $current_primary = null (line 51)

var: Primary key for current bound table, if exists
access: protected

array $current_table = null (line 45)

var: Array listing fields' names of current bound table
access: protected

mixed $dbprefix = false (line 21)

var: Tables prefix
access: protected

string $dbprefix_placeholder = "#__" (line 27)

var: Placeholder to use in queries if database prefix is used
access: protected

array $options = array(
'date_locale' => '%d/%m/%Y',
'time_locale' => '%H:%M:%S',
'datetime_locale' => '%d/%m/%Y %H:%M:%S'
) (line 57)

var: Utility options like date format
access: protected

array $tables = array() (line 39)

var: Array of bindable tables
access: protected

mixed $table_bind = false (line 33)

var: Table to which queries are bound
access: protected

Methods

Constructor __construct (line 73)

Constructor function

CRUDites __construct ([string $dbuser = ''], [string $dbpassword = ''], [string $dbname = ''], [string $dbhost = 'localhost'], [string $prefix = false])

string $dbuser: Database username
string $dbpassword: Database password
string $dbname: Database name
string $dbhost: (Optional) Database host, defaults to localhost
string $prefix: (Optional) Tables' prefix, defaults to none

add_table (line 716)

Adds a table to the internal table reference

Example:

$db->add_table(
'#__my_table',
array(
'id',
'name',
'surname'
)
);

void add_table (string $table, [array $fields = null], [string $primary = 'id'], [bool $override = false])

string $table: Table name (with or without prefix)
array $fields: An array containing all table fields
string $primary: (Optional) Table primary key (defaults to 'id')
bool $override: (Optional) If set to true any already added table with the same name will be overwritten. Defaults to false

add_tables (line 747)

Same as add_table(), but accepts as first arguments a multidimensional associative array with tables' names as keys and field array as value.

Primary key can be marked inside the field array as a associative key __primary => 'fieldname'

Example:

$db->add_tables(array(
'#__my_table' => array (
'id',
'name',
'surname',
'__primary' => 'id'
),
'#__my_second_table' => array (
[...]
)
));

see: CRUDites::add_table()

void add_tables ([array $array = array()], [bool $override = false])

array $array: The multidimensional associative array of tables to insert
bool $override: (Optional) If set to true any already added table with the same name will be overwritten. Defaults to false.

array_to_string (line 98)

Converts an array to a string with parameters, by combining keys and values.

Values which are arrays may be imploded as a comma separated string

Inspired by Joomla 1.5 Framework

string array_to_string ([array $array = null], [ $inner_glue = '='], [ $outer_glue = ' AND '], [bool $recurse = true], string $innerglue, string $outerglue)

array $array: Input array
string $innerglue: (Optional) String to place between each key and value. Defaults to "="
string $outerglue: (Optional) String to place between each key/value pair. Defaults to " AND "
bool $recurse: (Optional) If set to true it will implode array values which are arrays in a comma separated string. Defaults to true
$inner_glue
$outer_glue

bind (line 765)

Selects a table from the internal table reference store to be use with binding methods, if it exists

Example:

$db->bind('#__my_table');

void bind (strin $table)

strin $table: Name of selected table

build_query (line 436)

Returns either an update or insert query based on param $type

string build_query (string $table, array $value_array, string $type, mixed $where, [bool $compat = false], bool $all)

string $table: Table name
array $value_array: An array where keys are table fields' names and values are fields' values to update
string $type: Type of query. Allowed values are update or insert
mixed $where: (Not needed if type is insert) Conditional string or array ('fieldname'=>'fieldvalue') to define rows to be updated
bool $all: (Optional. Not needed if type is insert) Uses a compatibility routine with old versions of CRUDites
bool $compat: (Optional) Uses a compatibility routine with old versions of CRUDites

check_quotes (line 125)

Checks if a string is correctly escaped and quoted for SQL queries

access: protected

mixed check_quotes (mixed $var)

mixed $var: A variable to check

count (line 796)

Counts the number of rows from bound table

return: Number of rows
see: CRUDites::count_rows()

int count ([string|array $where = ''])

string|array $where: (Optional) where statement

count_rows (line 570)

Counts number of rows with optional where statement

see: CRUDites::select_query()

int count_rows ([string $table = null], [string|array $where = ''])

string $table: Table name
string|array $where: (Optional) Where statement

delete (line 850)

Deletes a row from bound table

return: True when row is successfully deleted

bool delete ([string|array $where = ''], [ $col = null], string $table)

string $table: Table name
string|array $where: (Optional) Where statement as string or as an array of field => fieldvalue
$col

delete_from (line 627)

Deletes a row from passed in table

return: True when row is successfully deleted

bool delete_from (string $table, [string|array $where = ''])

string $table: Table name
string|array $where: (Optional) Where statement as string or as an array of field => fieldvalue

exists (line 808)

Returns true or number of occurrence of a row if it exists

bool|int exists ([string $val = ''], [string $col = null], [string $return = false])

string $val: Value to search for
string $col: (Optional) Field to use for search. Defaults to primary key of bound table
string $return: (Optional) If set to true will return the number of occurrence of the searched values, else will return just true (defaults to false)

flat_array (line 258)

Takes a multidimensional array and returns an array with one value as key and another as value

Example:

$inputArray = array(
0 => array('one','two','three'),
1 => array('four','five','six')
);
$flatArray = $db->flat_array($inputArray);
print_r($flatArray);
Array (
'one' => 'two',
'four' => 'five'
)

array flat_array (array $array, [mixed $key1 = 0], [mixed $key2 = 1])

array $array: Input Array
mixed $key1: (Optional) Key of elements to use as keys. Defaults to 0
mixed $key2: (Optional) Key of elements to use as values. Defaults to 1

get_col_values (line 676)

Returns an array of values from a single column

return: An array of values or false on error

array|bool get_col_values ([string $table = null], string $field)

string $table: Table name
string $field: Table column to return

get_data (line 479)

Returns an array of database rows, either in object or array format

return: Returns an array with database rows or false on no results
see: get_results()
see: CRUDites::select_query()

array|bool get_data ([array $queryArray = array()], [constant $output = OBJECT])

array $queryArray: An array containing required statements
constant $output: (Optional) Type of rows in the list. May be OBJECT,ARRAY_N (array with numeric index) or ARRAY_A (associative array). Defaults to OBJECT

get_option (line 277)

Gets an option value

return: Option value or null
see: $option

mixed get_option (string $var)

string $var: Option name

get_pair (line 557)

Returns an array with two given database columns as array keys and values

Example:

$results = $db->get_pair("my_table","id","name","surname='Doe'")
print_r($results);
Array (
1 => 'John',
2 => 'Jack',
4 => ...
)

see: CRUDites::flat_array()
see: CRUDites::get_where()

array get_pair (string $table, string $key1, string $key2, [string $where = ""])

string $table: Table name
string $key1: Column name to use as key in the resulting array
string $key2: Column name to use as value in the resulting array
string $where: (Optional) Condition to filter results

get_table (line 497)

Returns an array with all rows and colums from a give table

return: Returns an array with database rows or false on no results
see: CRUDites::get_data()

array|bool get_table ([string $table = null], [constant $output = OBJECT])

string $table: Table to use
constant $output: (Optional) Type of rows in the list. May be OBJECT,ARRAY_N (array with numeric index) or ARRAY_A (associative array). Defaults to OBJECT

get_value (line 644)

Gets a single value from a single row from a table

mixed get_value ([string $table = null], string $field, [string|array $where = null])

string $table: Table name
string $field: Field to return
string|array $where: (Optional) Where statement as string or as an array of field => fieldvalue

get_where (line 516)

Returns an array of database rows

Example:

$results = $db->get_where("name","my_table","surname='Doe'");
//will output an array of objects
//to get all columns use this syntax
$results = $db->get_where("my_table","surname='Doe'");

Works like get_data() but accepts a variable number of strin arguments

return: Returns an array with database rows or false on no results
see: CRUDites::get_data()

array|bool get_where (mixed $string[,)

mixed $string[,: $string2...] Select statements. May be what to select, from which table and where, or just from which table and where. An additional last argument may be the output format

implode (line 140)

String safe version of PHP implode function

see: CRUDites::check_quotes()

string implode (string $glue, array $array)

string $glue: String to use to join array elements
array $array: Input array

insert_query (line 362)

Returns an insert query

string insert_query (string $table, array $value_array, [bool $compat = false])

string $table: Table name
array $value_array: An array where keys are table fields' names and values are fields' values to store
bool $compat: (Optional) Uses a compatibility routine with old versions of CRUDites

insert_unique (line 836)

Inserts a row in the bound table only if there's no other row with passed in value in current primary key

return: True on query success

bool insert_unique (string $value, string $query)

string $value: Value to search for in primary key
string $query: Insert query

insert_unique_to (line 611)

Inserts a row in the table only if there's no other row with passed in column value

return: True on query success
see: CRUDites::row_exists()

bool insert_unique_to (string $table, string|array $field, string $value, string $query)

string $table: Table name
string|array $field: Field to use for search or array with field => fieldvalue
string $value: (Optional) Value to search for if $field is a string
string $query: Insert query

mysql_curdate (line 161)

Returns current date in a MySQL DATE formatted string (yyyy-mm-dd)

string mysql_curdate ()

mysql_date_format (line 174)

Formats a formatted date or datetime to MySQL date or datetime

string mysql_date_format ([string $string = null], [string $input = null], [string $output = null])

string $string: String to format
string $input: Input format. May be a default locale (date,time or datetime) or a strptime allowed format strptime
string $output: MySQL output format. May be mysql_date, mysql_time, mysql_datetime or any date allowed format date

mysql_now (line 152)

Returns current date and time in a MySQL DATE formatted string (yyyy-mm-dd 00:00:00)

string mysql_now ()

pair (line 825)

Returns an array with two given table columns as array keys and values

see: CRUDites::get_pair()

array pair (string $key1, string $key2, [string $where = ""])

string $key1: Column name to use as key in the resulting array
string $key2: Column name to use as value in the resulting array
string $where: (Optional) Condition to filter results

row_exists (line 585)

Returns true or number of occurrence of a row if it exists

see: CRUDites::count_rows()

bool|int row_exists ([string $table = null], string|array $field, [string $value = ""], [string $return = false])

string $table: Table name
string|array $field: Field to use for search or array with field => fieldvalue
string $value: (Optional) Value to search for if $field is a string
string $return: (Optional) If set to true will return the number of occurrence of the searched values, else will return just true (defaults to false)

select_query (line 333)

Returns a select query with options

Example:

Available statements (could be in random order)
$query1 = $db->select_query(array(
'select' => 'id,name,surname',
'from' => 'customer_names',
'where' => 'id >= 1'
));
$query2 = $db->select_query(array(
'select' => 'id,surname',
'from' => 'customer_names',
'where' => array('name'=>'Bob','city' => 'London'),
'order' => 'name ASC,id ASC ',
'limit' => 2 //just two rows
));
If select statement is not specified all columns will be retrieved

string select_query ([array $array = array()])

array $array: An array containing required statements

select_rows (line 784)

Returns an array of database rows from bound table

If no params are passed in all rows from the bound table are returned as an array of objects

return: Returns an array with database rows or false on no results
see: CRUDites::get_data()

array|bool select_rows ([array $array = array()], [constant $output = OBJECT])

array $array: (Optional) An array containing select statements
constant $output: (Optional) Type of rows in the list. May be OBJECT,ARRAY_N (array with numeric index) or ARRAY_A (associative array). Defaults to OBJECT

send_query (line 459)

Submits passed in query string to the database

return: Returns true if query succeeded else false

bool send_query (string $query, [bool $isupdate = false])

string $query: Query to submit
bool $isupdate: (Optional) Set this parameter to true if query is an update query. Defaults to false

set_option (line 287)

Sets an option

void set_option (string $var, string $value)

string $var: Option name
string $value: Value of the option

set_value (line 661)

Sets value of a single field in a table

return: True on query success

bool set_value ([string $table = null], string $field, string $value, [string|array $where = null])

string $table: Table name
string $field: Field to return
string $value: Value to set
string|array $where: (Optional) Where statement as string or as an array of field => fieldvalue

store (line 886)

Stores data in the bound table, either inserting a new row or updateing an existing one.

If in passed in data array is present a key with same name as the current primary key, row is updated, else a new row will be stored

Example:

// add a new table and bind the object to it
$db->add_table('#__my_table',
array(
'id',
'name'
),
'id' //id is the primary key
);
$db->bind('#__my_table');
// adds a new row
$new_row = array('name'=>'John');
$db->store($new_row);
// update a row
$new_row = array('id'=>2,'name'=>'Mark');
$db->store($new_row);

return: True if query is successful, else false

bool store (array $value_array)

array $value_array: An array containing fields as keys and fields value as values

strptime_to_timestamp (line 222)

Converts and array generated by strptime to a timestamp

access: protected

string strptime_to_timestamp ([array $array = null])

array $array: (Optional) Input array, if none is pass current timestamp will be returned

table_name (line 300)

Gets a table name by applying prefix placeholder (#__) subsitution if needed

access: protected

string table_name ([string $table = ''])

string $table: Table name

to_timestamp (line 211)

Converts a passed in date/time string to timestamp

see: CRUDites::mysql_date_format()

string to_timestamp (string $string, string $format)

string $string: Input string
string $format: Input string format. May be a default locale (date,time or datetime) or a strptime allowed format strptime

update_query (line 399)

Returns an update query

string update_query (string $table, array $value_array, mixed $where, [bool $all = false], [bool $compat = false])

string $table: Table name
array $value_array: An array where keys are table fields' names and values are fields' values to update
mixed $where: Conditional string or array ('fieldname'=>'fieldvalue') to define rows to be updated
bool $all: (Optional) Uses a compatibility routine with old versions of CRUDites
bool $compat: (Optional) Uses a compatibility routine with old versions of CRUDites

Documentation generated by phpDocumentor 1.4.2