CMS Made Simple API

Connection

in package

• CMS

A class defining a database connection, and mechanisms for working with a database.

Tags

author

Robert Campbell

copyright

Copyright (c) 2015, Robert Campbell calguy1000@cmsmadesimple.org

since

2.2

Table of Contents

Constants

ERROR_CONNECT  = 'CONNECT'

This constant defines an error with connecting to the database.

ERROR_DATADICT  = 'DATADICTIONARY'

This constant defines an error in a datadictionary command.

ERROR_EXECUTE  = 'EXECUTE'

This constant defines an error with an execute statement.

ERROR_TRANSACTION  = 'TRANSACTION'

This constant defines an error with a transaction.

Properties

$query_count  : int

$query_time_total  : float

Methods

__construct()  : mixed

Construct a new Connection.

Affected_Rows()  : int

Output the number of rows affected by the last query.

BeginTrans()  : mixed

Begin a transaction

Close()  : mixed

An alias for Disconnect.

CommitTrans()  : mixed

Commit a simple transaction.

CompleteTrans()  : mixed

Complete a smart transaction.

concat()  : string

output the mysql expression for a string concatenation.

Connect()  : bool

Open the database connection.

CreateSequence()  : bool

Create a new sequence table.

Date()  : int

An Alias for the UnixDate method.

DBDate()  : string

Convert a date into something that is suitable for writing to a database.

DBTimeStamp()  : string

A utility method to convert a unix timestamp into a database specific string suitable for use in queries.

DbType()  : string

Return the database type.

Disconnect()  : mixed

Close the database connection.

DropSequence()  : bool

Drop a sequence table

ErrorMsg()  : string

Return a string describing the latest error (if any)

ErrorNo()  : int

Return the latest error number (if any)

Execute()  : ResultSet

Execute an SQL Command

FailTrans()  : mixed

Mark a transaction as failed.

GenID()  : int

For use with sequence tables, this method will generate a new ID value.

GetAll()  : array<string|int, mixed>

An alias for the GetArray method.

GetArray()  : array<string|int, mixed>

Execute an SQL Commmand and return all of the results as an array.

GetAssoc()  : mixed

A method to return an associative array.

GetCol()  : array<string|int, mixed>

Execute an SQL statement that returns one column, and return all of the matches as an array.

GetOne()  : mixed

Execute an SQL statement and return a single value.

GetRow()  : array<string|int, mixed>

Exeute an SQL statement that returns one row of results, and return that row as an associative array.

HasFailedTrans()  : bool

Test if a transaction has failed.

IfNull()  : string

Output the mysql expression to test if an item is null.

Initialize()  : Connection

Create a new database connection object.

Insert_ID()  : int

Return the numeric ID of the last insert query into a table with an auto-increment field.

IsConnected()  : bool

Test if the connection object is connected to the database.

NewDataDictionary()  : DataDictionary

Create a new data dictionary object.

Prepare()  : Statement

Create a prepared statement object.

QMagic()  : string

Quote a string magically using the magic quotes flag.

qstr()  : string

Quote a string in a database agnostic manner.

RollbackTrans()  : mixed

Roll back a simple transaction.

SelectLimit()  : ResultSet

Execute an SQL Select and limit the output.

SetDebugCallback()  : mixed

Set the debug callback.

SetDebugMode()  : mixed

Toggle debug mode.

SetErrorHandler()  : mixed

Set an error handler function

StartTrans()  : mixed

Begin a smart transaction

Time()  : int

An alias for the UnixTimestamp method.

UnixDate()  : int

Generate a unix timestamp representing the current date at midnight.

UnixTimeStamp()  : int

A convenience method for converting a database specific string representing a date and time into a unix timestamp.