Class \Prado\Util\TDbLogRoute

TDbLogRoute class

TDbLogRoute stores log messages in a database table. To specify the database table, set \Prado\Util\setConnectionID to be the ID of a TDataSourceConfig module and \Prado\Util\setLogTableName. If they are not setting, an SQLite3 database named 'sqlite3.log' will be created and used under the runtime directory.

By default, the database table name is 'pradolog'. It has the following structure:

CREATE TABLE pradolog
 (
	log_id INTEGER NOT NULL PRIMARY KEY,
	level INTEGER,
	category VARCHAR(128),
	prefix VARCHAR(128),
	logtime VARCHAR(20),
	message VARCHAR(255)
  );

4.3.0 Notes: Add the prefix to the log table: ALTER TABLE pradolog ADD COLUMN prefix VARCHAR(128) AFTER category;

Class hierarchy

\Prado\Util\TDbLogRoute

\Prado\Util\TLogRoute

\Prado\TApplicationComponent

\Prado\TComponent

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

Methods summary
`public`	`__destruct() : mixed` Destructor. Disconnect the db connection.
`public`	`deleteDBLog([int\|null $level = null ][, null\|array<string\|int, mixed>\|string $categories = null ][, float\|null $minTime = null ][, float\|null $maxTime = null ]) : int` Deletes log items from the database that match the criteria.
`public`	`getAutoCreateLogTable() : bool`
`public`	`getConnectionID() : string`
`public`	`getDbConnection() : TDbConnection`
`public`	`getDBLogCount([int\|null $level = null ][, null\|array<string\|int, mixed>\|string $categories = null ][, float\|null $minTime = null ][, float\|null $maxTime = null ]) : string` Gets the number of logs in the database fitting the provided criteria.
`public`	`getDBLogs([int\|null $level = null ][, null\|array<string\|int, mixed>\|string $categories = null ][, float\|null $minTime = null ][, float\|null $maxTime = null ][, string $order = '' ][, string $limit = '' ]) : TDbDataReader` Gets the number of logs in the database fitting the provided criteria.
`public`	`getLogTableName() : string`
`public`	`getRetainPeriod() : float\|null`
`public`	`init(TXmlElement $config) : mixed` Initializes this module. This method is required by the IModule interface. It initializes the database for logging purpose.
`public`	`setAutoCreateLogTable(bool $value) : static`
`public`	`setConnectionID(string $value) : static` Sets the ID of a TDataSourceConfig module. The datasource module will be used to establish the DB connection for this log route.
`public`	`setLogTableName(string $value) : static` Sets the name of the DB table to store log content. Note, if \Prado\Util\setAutoCreateLogTable is false and you want to create the DB table manually by yourself, you need to make sure the DB table is of the following structure: (key CHAR(128) PRIMARY KEY, value BLOB, expire INT)
`public`	`setRetainPeriod(null\|int\|string $value) : static`
`public static`	`timespanToSeconds(string $timespan) : int\|null`
`protected`	`createDbConnection() : TDbConnection` Creates the DB connection.
`protected`	`createDbTable() : mixed` Creates the DB table for storing log messages.
`protected`	`getLogWhere(int\|null $level, null\|array<string\|int, mixed>\|string $categories, float\|null $minTime, float\|null $maxTime, mixed &$values) : string` Computes the where SQL clause based upon level, categories, minimum time and maximum time.
`protected`	`processLogs(array<string\|int, mixed> $logs, bool $final, array<string\|int, mixed> $meta) : mixed` Stores log messages into database.

Inherited methods
__call, __callStatic, __clone, __construct, __destruct, __get, __isset, __set, __sleep, __unset, __wakeup, addParsedObject, asa, attachBehavior, attachBehaviors, attachClassBehavior, attachEventHandler, callBehaviorsMethod, canGetProperty, canSetProperty, clearBehaviors, collectLogs, createdOnTemplate, detachBehavior, detachBehaviors, detachClassBehavior, detachEventHandler, disableBehavior, disableBehaviors, enableBehavior, enableBehaviors, evaluateExpression, evaluateStatements, filterLogs, formatLogMessage, fxAttachClassBehavior, fxDetachClassBehavior, getApplication, getAutoGlobalListen, getBehaviors, getBehaviorsEnabled, getCategories, getClassHierarchy, getDisplaySubSeconds, getEnabled, getEventHandlers, getLevels, getListeningToGlobalEvents, getLogColor, getLogCount, getLogPrefix, getPrefixCallback, getProcessInterval, getRequest, getResponse, getService, getSession, getSubProperty, getUser, hasEvent, hasEventHandler, hasMethod, hasProperty, init, isa, listen, publishAsset, publishFilePath, raiseEvent, setCategories, setDisplaySubSeconds, setEnabled, setLevels, setPrefixCallback, setProcessInterval, setSubProperty, unlisten, _getZappableSleepProps, getCallChain, getClassFxEvents, getLevelName, getLevelValue, getTime, instanceBehavior, processLogs, filter_prado_fx

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

Classes

Interfaces

Traits

Search results

Class \Prado\Util\TDbLogRoute

Class hierarchy