templates/3rdParty/pla/lib/ds.php

Properties

Description

Classes and functions for communication of Data Stores

Classes

DS

Properties

 
 
Yes 
No 

Description

This abstract class provides the basic variables and methods.

Methods

__construct, connect, getAuthType, getErrorMessage, getErrorNum, getIndex, getLogin, getMethod, getName, getPassword, getValue, inactivityTime, isDefaultKey, isDefaultSetting, isLoggedIn, isReadOnly, isSessionValid, isVisible, login, logout, query, setDefaults, setLogin, setValue, untested,

__construct(   $index, ) : n/a

Arguments

Name Type Description Default
$index n/a

Return value

Type Description
n/a n/a

connect(   $method,   $debug = false, ) : n/a

Description

This will make the connection to the datasource

Arguments

Name Type Description Default
$method n/a
$debug n/a false

Return value

Type Description
n/a n/a

getAuthType( ) : n/a

Description

Return the authentication type for this object

Return value

Type Description
n/a n/a

getErrorMessage( ) : n/a

Description

Return error details from previous operation

Return value

Type Description
n/a n/a

getErrorNum( ) : n/a

Return value

Type Description
n/a n/a

getIndex( ) : n/a

Return value

Type Description
n/a n/a

getLogin(   $method = null, ) : n/a

Description

Get the login name of the user logged into this datastore's connection method If this returns null, we are not logged in.
If this returns '', we are logged in with anonymous

Arguments

Name Type Description Default
$method n/a null

Return value

Type Description
n/a n/a

getMethod(   $method = null, ) : string

Description

Work out which connection method to use.
If a method is passed, then it will be passed back. If no method is passed, then we'll check to see if the user is logged in. If they are, then 'user' is used, otherwise 'anon' is used.

Arguments

Name Type Description Default
$method n/a null

Return value

Type Description
string Connection Method

getName( ) : n/a

Description

Get the name of this datastore

Return value

Type Description
n/a n/a

getPassword(   $method = null, ) : n/a

Description

Get the login password of the user logged into this datastore's connection method

Arguments

Name Type Description Default
$method n/a null

Return value

Type Description
n/a n/a

getValue(   $key,   $setting,   $fatal = true, ) : n/a

Description

Return a configuration value

Arguments

Name Type Description Default
$key n/a
$setting n/a
$fatal n/a true

Return value

Type Description
n/a n/a

inactivityTime( ) : n/a

Description

Return the time left in seconds until this connection times out. If there is not timeout, this function will return null.

Return value

Type Description
n/a n/a

isDefaultKey(   $key, ) : n/a

Arguments

Name Type Description Default
$key n/a

Return value

Type Description
n/a n/a

isDefaultSetting(   $key,   $setting, ) : n/a

Arguments

Name Type Description Default
$key n/a
$setting n/a

Return value

Type Description
n/a n/a

isLoggedIn(   $method = null, ) : n/a

Description

Return if this datastore's connection method has been logged into

Arguments

Name Type Description Default
$method n/a null

Return value

Type Description
n/a n/a

isReadOnly( ) : n/a

Return value

Type Description
n/a n/a

isSessionValid( ) : n/a

Description

This method should be overridden in application specific ds files

Return value

Type Description
n/a n/a

isVisible( ) : n/a

Description

Functions that return the condition of the datasource

Return value

Type Description
n/a n/a

login(   $user = null,   $pass = null,   $method = null, ) : n/a

Description

Login to the datastore method: default = anon, connect to ds using bind_id not auth_id.
method: 'user', connect with auth_id method: '', any custom extra connection to ds.

Arguments

Name Type Description Default
$user n/a null
$pass n/a null
$method n/a null

Return value

Type Description
n/a n/a

logout(   $method = null, ) : n/a

Description

Logout of this datastore's connection method

Arguments

Name Type Description Default
$method n/a null

Return value

Type Description
n/a n/a

query(   $query,   $method,   $index = null,   $debug = false, ) : n/a

Description

Query the datasource

Arguments

Name Type Description Default
$query n/a
$method n/a
$index n/a null
$debug n/a false

Return value

Type Description
n/a n/a

setDefaults(   $defaults, ) : n/a

Description

Functions that set and verify object configuration details

Arguments

Name Type Description Default
$defaults n/a

Return value

Type Description
n/a n/a

setLogin(   $user,   $pass,   $method = null, ) : n/a

Description

Set the login details of the user logged into this datastore's connection method

Arguments

Name Type Description Default
$user n/a
$pass n/a
$method n/a null

Return value

Type Description
n/a n/a

setValue(   $key,   $setting,   $value, ) : n/a

Description

Set a configuration value

Arguments

Name Type Description Default
$key n/a
$setting n/a
$value n/a

Return value

Type Description
n/a n/a

untested( ) : n/a

Description

Return the untested config items

Return value

Type Description
n/a n/a

Properties

$custom, $default, $index, $type,

  protected  $custom =




  protected  $default =




  protected  $index =




  protected  $type =




Datastore

Properties

 
 
No 
No 

Description

The list of database sources

Methods

Instance, InstanceId, InstanceName, __construct, getServerList, newServer, setValue,

Instance(   $index = null, ) : object

Description

Return an object Instance of a configured database.

Arguments

Name Type Description Default
$index n/a null

Return value

Type Description
object Datastore instance object.

InstanceId(   $id = null, ) : object

Description

Return an object Instance of a configured database.

Arguments

Name Type Description Default
$id n/a null

Return value

Type Description
object Datastore instance object.

InstanceName(   $name = null, ) : object

Description

Return an object Instance of a configured database.

Arguments

Name Type Description Default
$name n/a null

Return value

Type Description
object Datastore instance object.

__construct( ) : n/a

Return value

Type Description
n/a n/a

getServerList(   $isVisible = true, ) : array

Description

Get a list of all the configured servers.

Arguments

Name Type Description Default
$isVisible n/a true

Return value

Type Description
array list of all configured servers.

newServer(   $type, ) : n/a

Description

Create a new database object

Arguments

Name Type Description Default
$type n/a

Return value

Type Description
n/a n/a

setValue(   $key,   $setting,   $value, ) : n/a

Description

Set values for a database object.

Arguments

Name Type Description Default
$key n/a
$setting n/a
$value n/a

Return value

Type Description
n/a n/a

Properties

$default, $index, $objects,

  private  $default =




  private  $index =




  private  $objects = array()




Documentation was generated by phpDocumentor 2.0.1 .

Namespaces

  • global

    Packages