PHPXRef 0.7.1 : Unnamed Project : Detail view of mssql_native_moodle

Class: mssql_native_moodle_database - X-Ref

Native mssql class representing moodle database interface.

Detects if all needed PHP stuff installed.
Note: can be used before connect()

return: mixed true if ok, string if something

get_dbfamily() X-Ref

Returns database family type - describes SQL dialect
Note: can be used before connect()

return: string db family name (mysql, postgres, mssql, oracle, etc.)

get_dbtype() X-Ref

Returns more specific database driver type
Note: can be used before connect()

return: string db type mysqli, pgsql, oci, mssql, sqlsrv

get_dblibrary() X-Ref

Returns general database library name
Note: can be used before connect()

return: string db type pdo, native

get_name() X-Ref

Returns localised database type name
Note: can be used before connect()

return: string

get_configuration_help() X-Ref

Returns localised database configuration help.
Note: can be used before connect()

return: string

diagnose() X-Ref

Diagnose database and tables, this function is used
to verify database and driver settings, db engine types, etc.

return: string null means everything ok, string means problem found.

connect($dbhost, $dbuser, $dbpass, $dbname, $prefix, array $dboptions=null) X-Ref

Connect to db
Must be called before other methods.

param: string $dbhost The database host.
param: string $dbuser The database username.
param: string $dbpass The database username's password.
param: string $dbname The name of the database being connected to.
param: mixed $prefix string means moodle db prefix, false used for external databases where prefix not used
param: array $dboptions driver specific options
return: bool true

dispose() X-Ref

Close database connection and release all resources
and memory (especially circular memory references).
Do NOT use connect() again, create a new instance if needed.

query_start($sql, array $params=null, $type, $extrainfo=null) X-Ref

Called before each db query.

param: string $sql
param: array array of parameters
param: int $type type of query
param: mixed $extrainfo driver specific extra information
return: void

query_end($result) X-Ref

Called immediately after each db query.

param: mixed db specific result
return: void

get_server_info() X-Ref

Returns database server info array

return: array Array containing 'description' and 'version' info

fix_table_names($sql) X-Ref

Converts short table name {tablename} to real table name
supporting temp tables (#) if detected

param: string sql
return: string sql

allowed_param_types() X-Ref

Returns supported query parameter types

return: int bitmask of accepted SQL_PARAMS_*

get_last_error() X-Ref

Returns last error reported by database engine.

return: string error message

get_tables($usecache=true) X-Ref

Return tables in database WITHOUT current prefix

param: bool $usecache if true, returns list of cached tables.
return: array of table names in lowercase and without prefix

get_indexes($table) X-Ref

Return table indexes - everything lowercased.

param: string $table The table we want to get indexes from.
return: array An associative array of indexes containing 'unique' flag and 'columns' being indexed

get_columns($table, $usecache=true) X-Ref

Returns datailed information about columns in table. This information is cached internally.

param: string $table name
param: bool $usecache
return: array array of database_column_info objects indexed with column names

normalise_value($column, $value) X-Ref

Normalise values based on varying RDBMS's dependencies (booleans, LOBs...)

param: database_column_info $column column metadata corresponding with the value we are going to normalise
param: mixed $value value we are going to normalise
return: mixed the normalised value

free_result($resource) X-Ref

Selectively call mssql_free_result(), avoiding some warnings without using the horrible @

param: mssql_resource $resource resource to be freed if possible

mssqltype2moodletype($mssql_type) X-Ref

Provides mapping between mssql native data types and moodle_database - database_column_info - ones)

param: string $mssql_type native mssql data type
return: string 1-char database_column_info data type

change_database_structure($sql, $tablenames = null) X-Ref

Do NOT use in code, to be used by database_manager only!

param: string|array $sql query
param: array|null $tablenames an array of xmldb table names affected by this request.
return: bool true

emulate_bound_params($sql, array $params=null) X-Ref

Very ugly hack which emulates bound parameters in queries
because the mssql driver doesn't support placeholders natively at all

execute($sql, array $params=null) X-Ref

Execute general sql query. Should be used only when no other method suitable.
Do NOT use this to make changes in db structure, use database_manager methods instead!

param: string $sql query
param: array $params query parameters
return: bool true

get_recordset_sql($sql, array $params=null, $limitfrom=0, $limitnum=0) X-Ref

Get a number of records as a moodle_recordset using a SQL statement.

Since this method is a little less readable, use of it should be restricted to
code where it's possible there might be large datasets being returned. For known
small datasets use get_records_sql - it leads to simpler code.

The return type is like:
param: string $sql the SQL select query to execute.
param: array $params array of sql parameters
param: int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
param: int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
return: moodle_recordset instance

create_recordset($result) X-Ref

No description

get_records_sql($sql, array $params=null, $limitfrom=0, $limitnum=0) X-Ref

Get a number of records as an array of objects using a SQL statement.

Return value is like:
param: string $sql the SQL select query to execute. The first column of this SELECT statement
param: array $params array of sql parameters
param: int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
param: int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
return: array of objects, or empty array if no records were found

get_fieldset_sql($sql, array $params=null) X-Ref

Selects records and return values (first field) as an array using a SQL statement.

param: string $sql The SQL query
param: array $params array of sql parameters
return: array of values

insert_record_raw($table, $params, $returnid=true, $bulk=false, $customsequence=false) X-Ref

Insert new record into database, as fast as possible, no safety checks, lobs not supported.

param: string $table name
param: mixed $params data record as object or array
param: bool $returnit return it of inserted record
param: bool $bulk true means repeated inserts expected
param: bool $customsequence true if 'id' included in $params, disables $returnid
return: bool|int true or new id

insert_record($table, $dataobject, $returnid=true, $bulk=false) X-Ref

Insert a record into a table and return the "id" field if required.

Some conversions and safety checks are carried out. Lobs are supported.
If the return ID isn't required, then this just reports success as true/false.
$data is an object containing needed data
param: string $table The database table to be inserted into
param: object $data A data object with values for one or more fields in the record
param: bool $returnid Should the id of the newly created record entry be returned? If this option is not requested then true/false is returned.
return: bool|int true or new id

import_record($table, $dataobject) X-Ref

Import a record into a table, id field is required.
Safety checks are NOT carried out. Lobs are supported.

param: string $table name of database table to be inserted into
param: object $dataobject A data object with values for one or more fields in the record
return: bool true

update_record_raw($table, $params, $bulk=false) X-Ref

Update record in database, as fast as possible, no safety checks, lobs not supported.

param: string $table name
param: mixed $params data record as object or array
param: bool true means repeated updates expected
return: bool true

update_record($table, $dataobject, $bulk=false) X-Ref

Update a record in a table

$dataobject is an object containing needed data
Relies on $dataobject having a variable "id" to
specify the record to update

param: string $table The database table to be checked against.
param: object $dataobject An object with contents equal to fieldname=>fieldvalue. Must have an entry for 'id' to map to the table specified.
param: bool true means repeated updates expected
return: bool true

set_field_select($table, $newfield, $newvalue, $select, array $params=null) X-Ref

Set a single field in every table record which match a particular WHERE clause.

param: string $table The database table to be checked against.
param: string $newfield the field to set.
param: string $newvalue the value to set the field to.
param: string $select A fragment of SQL to be used in a where clause in the SQL call.
param: array $params array of sql parameters
return: bool true

delete_records_select($table, $select, array $params=null) X-Ref

Delete one or more records from a table which match a particular WHERE clause.

param: string $table The database table to be checked against.
param: string $select A fragment of SQL to be used in a where clause in the SQL call (used to define the selection criteria).
param: array $params array of sql parameters
return: bool true

sql_cast_char2int($fieldname, $text=false) X-Ref

No description

sql_cast_char2real($fieldname, $text=false) X-Ref

No description

sql_ceil($fieldname) X-Ref

No description

get_collation() X-Ref

No description

sql_like($fieldname, $param, $casesensitive = true, $accentsensitive = true, $notlike = false, $escapechar = '\\') X-Ref

Returns 'LIKE' part of a query.

param: string $fieldname usually name of the table column
param: string $param usually bound query parameter (?, :named)
param: bool $casesensitive use case sensitive search
param: bool $accensensitive use accent sensitive search (not all databases support accent insensitive)
param: bool $notlike true means "NOT LIKE"
param: string $escapechar escape char for '%' and '_'
return: string SQL code fragment

sql_concat() X-Ref

No description

sql_concat_join($separator="' '", $elements=array() X-Ref

No description

sql_isempty($tablename, $fieldname, $nullablefield, $textfield) X-Ref

No description

sql_length($fieldname) X-Ref

Returns the SQL text to be used to calculate the length in characters of one expression.

param: string fieldname or expression to calculate its length in characters.
return: string the piece of SQL code to be used in the statement.

sql_order_by_text($fieldname, $numchars=32) X-Ref

No description

sql_position($needle, $haystack) X-Ref

Returns the SQL for returning searching one string for the location of another.

sql_substr($expr, $start, $length=false) X-Ref

Returns the proper substr() SQL text used to extract substrings from DB
NOTE: this was originally returning only function name

param: string $expr some string field, no aggregates
param: mixed $start integer or expression evaluating to int
param: mixed $length optional integer or expression evaluating to int
return: string sql fragment

replace_all_text_supported() X-Ref

Does this driver support tool_replace?

return: bool

session_lock_supported() X-Ref

No description

get_session_lock($rowid, $timeout) X-Ref

Obtain session lock

param: int $rowid id of the row with session record
param: int $timeout max allowed time to wait for the lock in seconds
return: bool success

release_session_lock($rowid) X-Ref

No description

begin_transaction() X-Ref

Driver specific start of real database transaction,
this can not be used directly in code.

return: void

commit_transaction() X-Ref

Driver specific commit of real database transaction,
this can not be used directly in code.

return: void

rollback_transaction() X-Ref

Driver specific abort of real database transaction,
this can not be used directly in code.

return: void

Copyright:	2009 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
License:	http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size:	1444 lines (54 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	3 files lib/dml/mssql_native_moodle_recordset.php lib/dml/mssql_native_moodle_temptables.php lib/dml/moodle_database.php

PHP Cross Reference of Unnamed Project

/lib/dml/ -> mssql_native_moodle_database.php (summary)

Defines 1 class