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
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.