API Documentation
\

\AiCommon

A class to manage Common needs. For this project, this is used as a gateway to the database layer.

Summary

Methods
Properties
Constants
__construct()
$mAutoDbMethod
$mDbMethod
$mDb
No constants found
No protected methods found
$mDbHost
$mDbName
$mDbUser
$mDbPass
N/A
No private methods found
No private properties found
N/A

Properties

$mAutoDbMethod

$mAutoDbMethod : string

Database system utilized if the argument to the constructor is blank. This only ever needs to get reset through the constructor for testing.

Under normal circumstances, leave the constructor argument blank, and this will be used. Valid values with the default distribution are 'pgsql' 'mysql' or 'oracle'

Type

string

$mDbMethod

$mDbMethod : string

Database system utilized by instances of this class.

Type

string

$mDb

$mDb : \AiDb

An instance of the database

Type

\AiDb

$mDbHost

$mDbHost : string

Database host name

Type

string

$mDbName

$mDbName : string

Database schema name

Type

string

$mDbUser

$mDbUser : string

Database username

Type

string

$mDbPass

$mDbPass : string

Database password

Type

string

Methods

__construct()

__construct(string $dbMethod)

Class constructor.

Creates an instance

Parameters

string $dbMethod

Specify a different DBMS to use. This is for testing only. Normal use would have $mAutoDbMethod defined and this class instantiated with a blank constructor.