Log
extends EntityBase
in package
Entity for system logs
Tags
Table of Contents
Constants
- SEVERITY_FATAL = 'FATAL'
- Fatal, the component that logged this cannot do what it should
- SEVERITY_INFO = 'INFO'
- Information message used for debugging only
- SEVERITY_WARNING = 'WARNING'
- Warning message, something is not good, but non-fatal
Properties
- $localeCodes : array<string|int, mixed>
- List of locale codes ordered by translation fallback order per Cx instance
- $nestingCount : int
- Counts the nesting level of __call()
- $stringRepresentationBlank : bool
- Whether blank string representations are valid
- $stringRepresentationFields : array<string|int, mixed>
- List of fields that should be available in the string representation
- $stringRepresentationFormat : string
- Sprintf format for the string representation
- $validators : array<string|int, mixed>
- Initialize this array as follows: array( 'columName' => Zend_Validate )
- $virtual : bool
- Defines if an entity is virtual and therefore not persistable.
- $data : string
- $id : int
- $logger : string
- $message : string
- $severity : string
- $timestamp : datetime
Methods
- __call() : mixed
- Route methods like getName(), getType(), getDirectory(), etc.
- __construct() : mixed
- Creates a new log entry
- __get() : mixed
- This is an ugly solution to allow $this->cx to be available in all entity classes Since the entity's constructor is not called when an entity is loaded from DB this cannot be assigned there.
- __toString() : string
- Returns this entity's identifying value
- getComponentController() : SystemComponent
- Returns the component controller for this component
- getData() : string
- Get data
- getId() : int
- Get id
- getKeyAsString() : string
- Returns this entity's key
- getLogger() : string
- Get logger
- getMessage() : string
- Get message
- getSeverity() : string
- Get severity
- getTimestamp() : datetime
- Get timestamp
- getTranslatedFieldValue() : mixed
- Returns the value of a translatable field using fallback mechanisms
- initializeValidators() : mixed
- Set $this->validators
- isVirtual() : bool
- Returns the virtuality of the entity
- setData() : mixed
- Set data
- setLogger() : mixed
- Set logger
- setMessage() : mixed
- Set message
- setSeverity() : mixed
- Set severity
- setTimestamp() : mixed
- Set timestamp
- setVirtual() : mixed
- Set the virtuality of the entity
- validate() : mixed
- getFallbackLocaleCodes() : array<string|int, mixed>
- Returns a list of all locale codes ordered by fallback order
- getStringRepresentationBlank() : bool
- Whether blank string representations are valid
- getStringRepresentationFields() : array<string|int, mixed>
- Returns a list of fields available in the string representation
- getStringRepresentationFormat() : string
- Returns the sprintf() format for the string representation
Constants
SEVERITY_FATAL
Fatal, the component that logged this cannot do what it should
public
string
SEVERITY_FATAL
= 'FATAL'
SEVERITY_FATAL
SEVERITY_INFO
Information message used for debugging only
public
string
SEVERITY_INFO
= 'INFO'
SEVERITY_INFO
SEVERITY_WARNING
Warning message, something is not good, but non-fatal
public
string
SEVERITY_WARNING
= 'WARNING'
SEVERITY_WARNING
Properties
$localeCodes
List of locale codes ordered by translation fallback order per Cx instance
protected
static array<string|int, mixed>
$localeCodes
= array()
Array in the form: array(<instanceId> => array(<localeCode>, ...))
Tags
$nestingCount
Counts the nesting level of __call()
protected
static int
$nestingCount
= 0
$stringRepresentationBlank
Whether blank string representations are valid
protected
bool
$stringRepresentationBlank
= false
Whether blank string representations are valid
Tags
$stringRepresentationFields
List of fields that should be available in the string representation
protected
array<string|int, mixed>
$stringRepresentationFields
= array()
List of field names
Tags
$stringRepresentationFormat
Sprintf format for the string representation
protected
string
$stringRepresentationFormat
= ''
Sprintf format string
Tags
$validators
Initialize this array as follows: array( 'columName' => Zend_Validate )
protected
array<string|int, mixed>
$validators
= array()
$virtual
Defines if an entity is virtual and therefore not persistable.
protected
bool
$virtual
= false
Defaults to FALSE - not virtual.
$data
private
string
$data
$id
private
int
$id
$logger
private
string
$logger
$message
private
string
$message
$severity
private
string
$severity
$timestamp
private
datetime
$timestamp
Methods
__call()
Route methods like getName(), getType(), getDirectory(), etc.
public
__call(string $methodName, array<string|int, mixed> $arguments) : mixed
Parameters
- $methodName : string
-
Name of method to call
- $arguments : array<string|int, mixed>
-
List of arguments for the method to call
Tags
Return values
mixed —Return value of the method to call
__construct()
Creates a new log entry
public
__construct(string $severity, string $message, string $data) : mixed
Parameters
- $severity : string
-
Use one of the SEVERITY_* constants
- $message : string
-
A short message that describes this entry
- $data : string
-
Additional debug data
__get()
This is an ugly solution to allow $this->cx to be available in all entity classes Since the entity's constructor is not called when an entity is loaded from DB this cannot be assigned there.
public
__get(mixed $name) : mixed
Parameters
- $name : mixed
__toString()
Returns this entity's identifying value
public
__toString() : string
By default this returns the same as getKeyAsString(), but this method might get overridden by subclasses.
Return values
string —Identifying value for this entity
getComponentController()
Returns the component controller for this component
public
getComponentController() : SystemComponent
Return values
SystemComponentgetData()
Get data
public
getData() : string
Return values
string —$data
getId()
Get id
public
getId() : int
Return values
int —$id
getKeyAsString()
Returns this entity's key
public
final getKeyAsString([string $separator = '/' ]) : string
If this entity has a composite key, the fields are separated by $separator.
Parameters
- $separator : string = '/'
-
(optional) Separator for composite key fields, default "/"
Return values
string —Entity key as string
getLogger()
Get logger
public
getLogger() : string
Return values
string —$logger
getMessage()
Get message
public
getMessage() : string
Return values
string —$message
getSeverity()
Get severity
public
getSeverity() : string
Return values
string —$severity
getTimestamp()
Get timestamp
public
getTimestamp() : datetime
Return values
datetime —$timestamp
getTranslatedFieldValue()
Returns the value of a translatable field using fallback mechanisms
public
getTranslatedFieldValue(string $fieldName) : mixed
If the field is not translatable its value is returned anyway. Tries to return the value in the following locales (if non-empty):
- Current locale
- Default locale
- All other locales
Parameters
- $fieldName : string
-
Name of a translatable field
initializeValidators()
Set $this->validators
public
initializeValidators() : mixed
Validators can be found in lib/FRAMEWORK/Validator.class.php These will be executed if validate() is called
isVirtual()
Returns the virtuality of the entity
public
isVirtual() : bool
Return values
bool —TRUE if the entity is virtual, otherwise FALSE
setData()
Set data
public
setData(string $data) : mixed
Parameters
- $data : string
setLogger()
Set logger
public
setLogger(string $logger) : mixed
Parameters
- $logger : string
setMessage()
Set message
public
setMessage(string $message) : mixed
Parameters
- $message : string
setSeverity()
Set severity
public
setSeverity(string $severity) : mixed
Parameters
- $severity : string
setTimestamp()
Set timestamp
public
setTimestamp(datetime $timestamp) : mixed
Parameters
- $timestamp : datetime
setVirtual()
Set the virtuality of the entity
public
setVirtual(bool $virtual) : mixed
Parameters
- $virtual : bool
-
TRUE to set the entity as virtual or otherwise to FALSE
validate()
public
validate() : mixed
Tags
getFallbackLocaleCodes()
Returns a list of all locale codes ordered by fallback order
protected
getFallbackLocaleCodes() : array<string|int, mixed>
- First entry is the current locale
- Second entry is the default locale (if different from current, it's omitted otherwise)
- Then all other locales follow (in no particular order)
Tags
Return values
array<string|int, mixed> —List of locale codes
getStringRepresentationBlank()
Whether blank string representations are valid
protected
getStringRepresentationBlank() : bool
Return values
bool —Whether blank string representations are valid
getStringRepresentationFields()
Returns a list of fields available in the string representation
protected
getStringRepresentationFields() : array<string|int, mixed>
Return values
array<string|int, mixed> —List of field names
getStringRepresentationFormat()
Returns the sprintf() format for the string representation
protected
getStringRepresentationFormat() : string
Return values
string —sprintf() format string