API Documentation
\

\ MonkeyDatabase

MySQL database and query managing class

Summary

Methods
Properties
Constants
Get()
Set()
Push()
Pop()
__construct()
AddFirst()
AddLast()
First()
Last()
Clear()
IsEmpty()
Count()
RemoveFirst()
RemoveLast()
Backwards()
Objects()
ObjectIterator()
GetDebug()
Instance()
Create()
CreateConnection()
Query()
GetResults()
IsEmptyResult()
GetRowCount()
IsMalformedQuery()
GetQuery()
RowsAffected()
$Instance
No constants found
No protected methods found
$_list
$_databaseConnection
$_databaseSelected
$_cachedResults
$_queries
$_rowsAffected
N/A
_GetIndex()
No private properties found
N/A

Properties

$_list

$_list :

Type

$_databaseConnection

$_databaseConnection :

Type

$_databaseSelected

$_databaseSelected :

Type

$_cachedResults

$_cachedResults :

Type

$_queries

$_queries :

Type

$_rowsAffected

$_rowsAffected :

Type

Methods

Get()

Get(integer  $index) : \mysql_query

Returns the query statement at $index

Parameters

integer $index

Returns

\mysql_query

Set()

Set(integer  $index, object  $object)

Sets the value at the specified index

Parameters

integer $index
object $object

Push()

Push(object  $object)

Pushes a value onto the end of the stack

Parameters

object $object

Pop()

Pop() : object

Pops the value on the end of the stack

Returns

object

__construct()

__construct()

AddFirst()

AddFirst(object  $object)

Adds an object into the beginning of the list

Parameters

object $object

AddLast()

AddLast(object  $object)

Adds an object on the end of the list

Parameters

object $object

First()

First() : object

Returns the first object from the list

Returns

object

Last()

Last() : object

Returns the last object from the list

Returns

object

Clear()

Clear() : integer

Clears this object's objects

Returns

integer

IsEmpty()

IsEmpty() : boolean

Returns true if the object is empty or false if it isn't

Returns

boolean

Count()

Count() : integer

Returns the number of objects in this object

Returns

integer

RemoveFirst()

RemoveFirst() : object

Removes the first object from the list and returns it

Returns

object

RemoveLast()

RemoveLast() : object

Removes the last object from the list and returns it

Returns

object

Backwards()

Backwards() : array

Returns the list backwards

Returns

array —

object

Objects()

Objects() : array

Returns the list

Returns

array —

object

ObjectIterator()

ObjectIterator() : \ArrayIterator

Return new ArrayIterator of object

Returns

\ArrayIterator

GetDebug()

GetDebug()

Returns the debug information to the immediate buffer

Instance()

Instance(  $host = '',   $username = '',   $password = '',   $dbname = '') : \MonkeyDatabase

Return singleton instance of class

Parameters

$host
$username
$password
$dbname

Returns

\MonkeyDatabase

Create()

Create(string  $host, string  $username, string  $password, string  $dbname) : \MonkeyDatabase

Returns a new MonkeyDatabase with a database connection

Parameters

string $host
string $username
string $password
string $dbname

Returns

\MonkeyDatabase

CreateConnection()

CreateConnection(string  $host, string  $username, string  $password, string  $dbname) : boolean

Attempts to connect to the database

Parameters

string $host
string $username
string $password
string $dbname

Returns

boolean

Query()

Query(string  $query, boolean  $returnResults = true) : array

Will perform a query and return the results

Parameters

string $query
boolean $returnResults

Returns

array —

string

GetResults()

GetResults(integer  $index) : array

Returns the result from a stored query

Parameters

integer $index

Returns

array —

string

IsEmptyResult()

IsEmptyResult(integer  $index) : boolean

Returns true if empty result set.

Parameters

integer $index

Returns

boolean

GetRowCount()

GetRowCount(integer  $index) : integer

Returns the number of rows for the given query

Parameters

integer $index

Returns

integer

IsMalformedQuery()

IsMalformedQuery(integer  $index) : boolean

Returns true or false on whether or not the input query was malformed

Parameters

integer $index

Returns

boolean

GetQuery()

GetQuery(integer  $index)

Alias of Get, see Get for more information

Parameters

integer $index

RowsAffected()

RowsAffected(integer  $index) : integer

Return the number of affected rows

Parameters

integer $index

Returns

integer

_GetIndex()

_GetIndex(integer  $index) : integer

Get valid index

Parameters

integer $index

Returns

integer