GemsTracker library API
Back to top  

Logging class to log access to certaint controller/actions

author Menno Dekker
package Gems
subpackage AccessLog
copyright Copyright (c) 2011 Erasmus MC
license New BSD License

 Methods

Convenience calls to the log method:

__call(string $name, array $arguments) : \Gems_AccessLog

When you try to call 'log' + anything it will be interpreted as a call to the log method where the part following log is the action and the first argument is the respondentId. When you want to utilize the full power of the logging system, use the log method directly.

see
deprecated Since 1.7.1

Parameters

$name

string

$arguments

array

Returns

\Gems_AccessLog

__construct() 

__construct(\Zend_Cache_Core $cache, \Zend_Db_Adapter_Abstract $db, \Gems_Loader $loader) 

Parameters

$cache

\Zend_Cache_Core

$db

\Zend_Db_Adapter_Abstract

$loader

\Gems_Loader

_logEntry() 

_logEntry(\Zend_Controller_Request_Abstract $request, string $actionId, boolean $changed, mixed $message, mixed $data, integer $respondentId) : boolean
deprecated Since 1.7.2

Parameters

$request

\Zend_Controller_Request_Abstract

$actionId

string

$changed

boolean

$message

mixed

$data

mixed

$respondentId

integer

Returns

booleanTrue when a log entry was stored

Return an instance of the \Gems_AccesLog class

getLog() : \Gems_AccessLog
Static
deprecated since 1.7.1 Use accessLog source variable instead

Returns

\Gems_AccessLog

Logs the action for the current user with optional message and respondent id

log(string $action, \Zend_Controller_Request_Abstract $request = null, string $message = null, \<type> $respondentId = null, boolean $force = false) : \Gems_AccessLog
deprecated Since version 1.7.1: use logChange or logRequest

Parameters

$action

string

$request

\Zend_Controller_Request_Abstract

$message

string

An optional message to log with the action

$respondentId

\<type>

$force

boolean

Should we force the logentry to be inserted or should we try to skip duplicates? Default = false

Returns

\Gems_AccessLog

Logs the action for the current user with optional message and respondent id

logChange(\Zend_Controller_Request_Abstract $request, mixed $message = null, mixed $data = null, integer $respondentId = null) : boolean

Parameters

$request

\Zend_Controller_Request_Abstract

$message

mixed

$data

mixed

$respondentId

integer

Returns

booleanTrue when a log entry was stored

logEntry() 

logEntry(\Zend_Controller_Request_Abstract $request, string $actionId, boolean $changed, mixed $message, mixed $data, integer $respondentId) : boolean

Parameters

$request

\Zend_Controller_Request_Abstract

$actionId

string

$changed

boolean

$message

mixed

$data

mixed

$respondentId

integer

Returns

booleanTrue when a log entry was stored

Logs the action for the current user with optional message and respondent id

logRequest(\Zend_Controller_Request_Abstract $request, mixed $message = null, mixed $data = null, integer $respondentId = null) : boolean

Parameters

$request

\Zend_Controller_Request_Abstract

$message

mixed

$data

mixed

$respondentId

integer

Returns

booleanTrue when a log entry was stored

getAction() 

getAction(string $action) : array

Parameters

$action

string

Returns

array

The curent flash messenger messages

getMessages() : array

Returns

array

Load the actions into memory from the cache

_getActionsCache() 

Load the actions into memory from the database (and cache them)

_getActionsDb() 

Stores the current log entry

_storeLogEntry(\Zend_Controller_Request_Abstract $request, array $row, boolean $force) : boolean

Parameters

$request

\Zend_Controller_Request_Abstract

$row

array

$force

boolean

Should we force the logentry to be inserted or should we try to skip duplicates?

Returns

booleanTrue when a log entry was stored

Remove password and pwd contents and clean up message status data and single item arrays

_toCleanArray(array $data) : mixed

Parameters

$data

array

Returns

mixed

Converts data types for storage

_toJson(mixed $data) : string

Parameters

$data

mixed

Returns

string

Send a warning, if not already done

_warn() 
staticvar boolean $warn

 Properties

 

$_actions

$_actions : \Gems_Util_AccessLogActions

Default

false
 

$_cache

$_cache : \Zend_Cache_Core

Default

 

$_cacheId

$_cacheId : string

Default

 

$_db

$_db : \Zend_Db_Adapter_Abstract

Default

 

$_loader

$_loader : \Gems_Loader

Default

 

$_log

$_log : \Gems_AccessLog

Default

Static
 

$_messenger

$_messenger : \Zend_Controller_Action_Helper_FlashMessenger

Default

 

Data fields that contain a organization id

$_organizationIdFields : array

Default

array('gr2o_id_organization', 'gr2t_id_organization', 'gap_id_organization', 'gto_id_organization', 'gor_id_organization', 'gla_organization', 'grco_organization')
 

Cache for respondent id

$_respondentId : integer

Default

 

Data fields that contain a respondent id

$_respondentIdFields : array

Default

array('grs_id_user', 'gr2o_id_user', 'gr2t_id_user', 'gap_id_user', 'gto_id_respondent', 'grr_id_respondent', 'gla_respondent_id', 'grco_id_to')
 

$_sessionStore

$_sessionStore : \Zend_Session_Namespace

Default