Class \Prado\Util\TLogRoute

TLogRoute class.

TLogRoute is the base class for all log route classes. A log route object retrieves log messages from a logger and sends it somewhere, such as files, emails. The messages being retrieved may be filtered first before being sent to the destination. The filters include log level filter and log category filter.

To specify level filter, set \Prado\Util\setLevels property, which takes a string of comma-separated desired level names (e.g. 'Error, Debug'). To specify category filter, set \Prado\Util\setCategories property, which takes a string of comma-separated desired category names (e.g. 'Prado\Web, Prado\IO').

The categories filter can use '!' or '~', e.g. '!Prado\Web\UI' or '~Prado\Web\UI', to exclude categories. Added 4.3.0.

Level filter and category filter are combinational, i.e., only messages satisfying both filter conditions will they be returned.

Class hierarchy

\Prado\Util\TLogRoute

\Prado\TApplicationComponent

\Prado\TComponent

Author: Qiang Xue <qiang.xue@gmail.com>
Author: Brad Anderson <belisoful@icloud.com>
Since: 3.0

Methods summary
`public`	`collectLogs([TLogger $logger = null ][, bool $final = false ]) : mixed` Retrieves log messages from logger to log route specific destination.
`public`	`filterLogs(array<string\|int, mixed> &$logs) : mixed` This filters the logs to calculate the delta and total times. It also calculates the Profile times based upon the begin and end logged profile logs
`public`	`formatLogMessage(array<string\|int, mixed> $log) : string` Formats a log message given different fields.
`public`	`getCategories() : array<string\|int, mixed>`
`public`	`getDisplaySubSeconds() : bool`
`public`	`getEnabled() : bool`
`public`	`getLevels() : int\|null`
`public static`	`getLogColor(float $normalizedTime) : array<string\|int, mixed>` Given $normalizedTime between 0 and 1 will produce an associated color. Lowest values (~0) are black, then blue, green, yellow, orange, and red at 1.
`public`	`getLogCount() : int`
`public`	`getLogPrefix(array<string\|int, mixed> $log) : string`
`public`	`getPrefixCallback() : callable`
`public`	`getProcessInterval() : int`
`public`	`init(TXmlElement $config) : mixed` Initializes the route.
`public`	`setCategories(array<string\|int, mixed>\|string $categories) : static`
`public`	`setDisplaySubSeconds(bool\|string $value) : static`
`public`	`setEnabled(bool\|callable $value) : static` This can be a boolean or a callable in the format: ```php $route->setEnabled( function(TLogRoute $route):bool { return !Prado::getUser()?->getIsGuest() } ); ```
`public`	`setLevels(int\|string $levels) : static`
`public`	`setPrefixCallback(callable $value) : static` This is the application callback for changing the prefix in the format of: ```php $route->setPrefixCallback(function(array $log, string $prefix) { return $prefix . '[my data]'; }); ```
`public`	`setProcessInterval(int $value) : static`
`protected`	`getLevelName(int $level) : string`
`protected`	`getLevelValue(string $level) : int`
`protected`	`getTime(float $timestamp) : string`
`protected abstract`	`processLogs(array<string\|int, mixed> $logs, bool $final, array<string\|int, mixed> $meta) : mixed` Processes log messages and sends them to specific destination. Derived child classes must implement this method.

Inherited methods
__call, __callStatic, __clone, __construct, __destruct, __get, __isset, __set, __sleep, __unset, __wakeup, addParsedObject, asa, attachBehavior, attachBehaviors, attachClassBehavior, attachEventHandler, callBehaviorsMethod, canGetProperty, canSetProperty, clearBehaviors, createdOnTemplate, detachBehavior, detachBehaviors, detachClassBehavior, detachEventHandler, disableBehavior, disableBehaviors, enableBehavior, enableBehaviors, evaluateExpression, evaluateStatements, fxAttachClassBehavior, fxDetachClassBehavior, getApplication, getAutoGlobalListen, getBehaviors, getBehaviorsEnabled, getClassHierarchy, getEventHandlers, getListeningToGlobalEvents, getRequest, getResponse, getService, getSession, getSubProperty, getUser, hasEvent, hasEventHandler, hasMethod, hasProperty, isa, listen, publishAsset, publishFilePath, raiseEvent, setSubProperty, unlisten, _getZappableSleepProps, getCallChain, getClassFxEvents, instanceBehavior, filter_prado_fx

Inherited constants
`\Prado\TApplicationComponent::FX_CACHE_FILE, \Prado\TComponent::GLOBAL_RAISE_EVENT_LISTENER`

Classes

Interfaces

Traits

Search results

Class \Prado\Util\TLogRoute

Class hierarchy