SQL

backup

Backs up the entire database to a given file.

Return Value: true if successful.

static backup($file, $ = [])

compareTables

Returns a list of SQL commands required to turn one table into another.

Return Value: An array of SQL calls to perform to turn Table A into Table B.

static compareTables($table_a, $table_b)

connect

Sets up the internal connections to the MySQL server(s).

static connect()

delete

Deletes a row in the given table

Return Value: true if successful (even if no rows match)

static delete($table, $id)

describeTable

Gives in depth information about a MySQL table's structure and keys.

Return Value: An array of table information or null if the table doesn't exist.

static describeTable($table)

drawColumnSelectOptions

Draws the <select> options of all the columns in a table.

static drawColumnSelectOptions($table, $default = null, $sorting = false)

drawTableSelectOptions

Draws the <select> options for all of tables in the database excluding bigtree_ prefixed tables.

static drawTableSelectOptions($default = null)

dumpTable

Returns an array of INSERT statements for the rows of a given table.
The INSERT statements will be binary safe with binary columns requested in hex.

Return Value: An array.

static dumpTable($table)

escape

Equivalent to mysql_real_escape_string.
Escapes non-string values by first encoding them as JSON.

Return Value: Escaped string

static escape($string)

exists

Checks to see if an entry exists for given key/value pairs.

Return Value: true if a row already exists that matches the passed in key/value pairs.

static exists($table, $values, $ignored_id = null)

fetch

Equivalent to calling mysql_fetch_assoc on a query.
If a query string is passed rather than a chained call it will return a single row after executing the query.

Return Value: A row from the active query (or false if no more rows exist)

fetch($query, $parameters)

fetchAll

Returns all remaining rows for the active query.
If a query string is passed rather than a chained call it will return the results after executing the query.

Return Value: An array of rows from the active query.

fetchAll($query, $parameters)

fetchAllSingle

Equivalent to the fetchAll method but only the first column of each row is returned.

Return Value: An array of the first column of each row from the active query.

fetchAllSingle($query, $parameters)

fetchSingle

Equivalent to the fetch method but only the first column of the row is returned.

Return Value: The first column from the returned row.

fetchSingle($query, $parameters)

insert

Inserts a row into the database and returns the primary key

Return Value: Primary key of the inserted row or null if failed

static insert($table, $values)

insertID

Equivalent to calling mysql_insert_id.

Return Value: The primary key for the most recently inserted row.

static insertID()

nextColumnDefinition

Return the next SQL name definition from a string.

Return Value: A string.

static nextColumnDefinition($string)

prepareData

Processes form data into values understandable by the MySQL table.

Return Value: Array of data safe for MySQL.

static prepareData($table, $data, $existing_description = null)

query

Queries the MySQL server(s).
If you pass additional parameters "?" characters in your query statement
will be replaced with escaped values in the order they are found.

Return Value: Another instance of BigTree\SQL for chaining fetch, fetchAll, insertID, or rows methods.

static query($query, $...)

rows

Equivalent to calling mysql_num_rows.

Return Value: Number of rows for the active query.

rows($query)

tableExists

Determines whether a SQL table exists.

Return Value: true if table exists, otherwise false.

static tableExists($table)

unique

Retrieves a unique version of a given field for a table.
Appends trailing numbers to the string until a unique version is found (i.e. value-2)
Useful for creating unique routes.

Return Value: Unique version of value.

static unique($table, $field, $value, $id = null, $inverse = false)

update

Updates a row in the database

Return Value: true if successful (even if no rows match)

static update($table, $id, $values)