Class yii\log\SyslogTarget
Inheritance | yii\log\SyslogTarget » yii\log\Target » yii\base\Component » yii\base\BaseObject |
---|---|
Implements | yii\base\Configurable |
Available since version | 2.0 |
SyslogTarget writes log to syslog.
Public Properties
隐藏继承的属性 Hide inherited properties
属性Property | 类型 Type | 简介 Description | 定义在 Defined By |
---|---|---|---|
$behaviors | yii\base\Behavior[] | List of behaviors attached to this component | yii\base\Component |
$categories | array | List of message categories that this target is interested in. | yii\log\Target |
$enabled | boolean|callable | A boolean value or a callable to obtain the value from. | yii\log\Target |
$except | array | List of message categories that this target is NOT interested in. | yii\log\Target |
$exportInterval | integer | How many messages should be accumulated before they are exported. | yii\log\Target |
$facility | integer | Syslog facility. | yii\log\SyslogTarget |
$identity | string | Syslog identity | yii\log\SyslogTarget |
$levels | integer | The message levels that this target is interested in. | yii\log\Target |
$logVars | array | List of the PHP predefined variables that should be logged in a message. | yii\log\Target |
$maskVars | array | List of the PHP predefined variables that should NOT be logged "as is" and should always be replaced
with a mask *** before logging, when exist. |
yii\log\Target |
$messages | array | The messages that are retrieved from the logger so far by this log target. | yii\log\Target |
$microtime | boolean | Whether to log time with microseconds. | yii\log\Target |
$options | integer | Openlog options. | yii\log\SyslogTarget |
$prefix | callable | A PHP callable that returns a string to be prefixed to every exported message. | yii\log\Target |
Public Methods
隐藏继承的方法 Hide inherited methods
方法 Method | 简介 Description | 定义在 Defined By |
---|---|---|
__call() | Calls the named method which is not a class method. | yii\base\BaseObject |
__clone() | This method is called after the object is created by cloning an existing one. | yii\base\Component |
__construct() | Constructor. | yii\base\BaseObject |
__get() | Returns the value of an object property. | yii\base\BaseObject |
__isset() | Checks if a property is set, i.e. defined and not null. | yii\base\BaseObject |
__set() | Sets value of an object property. | yii\base\BaseObject |
__unset() | Sets an object property to null. | yii\base\BaseObject |
attachBehavior() | Attaches a behavior to this component. | yii\base\Component |
attachBehaviors() | Attaches a list of behaviors to the component. | yii\base\Component |
behaviors() | Returns a list of behaviors that this component should behave as. | yii\base\Component |
canGetProperty() | Returns a value indicating whether a property can be read. | yii\base\BaseObject |
canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\BaseObject |
className() | Returns the fully qualified name of this class. | yii\base\BaseObject |
collect() | Processes the given log messages. | yii\log\Target |
detachBehavior() | Detaches a behavior from the component. | yii\base\Component |
detachBehaviors() | Detaches all behaviors from the component. | yii\base\Component |
ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. | yii\base\Component |
export() | Writes log messages to syslog. | yii\log\SyslogTarget |
filterMessages() | Filters the given messages according to their categories and levels. | yii\log\Target |
formatMessage() | Formats a log message for display as a string. | yii\log\SyslogTarget |
getBehavior() | Returns the named behavior object. | yii\base\Component |
getBehaviors() | Returns all behaviors attached to this component. | yii\base\Component |
getEnabled() | Check whether the log target is enabled. | yii\log\Target |
getLevels() | yii\log\Target | |
getMessagePrefix() | Returns a string to be prefixed to the given message. | yii\log\Target |
hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. | yii\base\Component |
hasMethod() | Returns a value indicating whether a method is defined. | yii\base\BaseObject |
hasProperty() | Returns a value indicating whether a property is defined. | yii\base\BaseObject |
init() | Initializes the object. | yii\log\SyslogTarget |
off() | Detaches an existing event handler from this component. | yii\base\Component |
on() | Attaches an event handler to an event. | yii\base\Component |
setEnabled() | Sets a value indicating whether this log target is enabled. | yii\log\Target |
setLevels() | Sets the message levels that this target is interested in. | yii\log\Target |
trigger() | Triggers an event. | yii\base\Component |
Protected Methods
隐藏继承的方法 Hide inherited methods
方法 Method | 简介 Description | 定义在 Defined By |
---|---|---|
getContextMessage() | Generates the context information to be logged. | yii\log\Target |
getTime() | Returns formatted ('Y-m-d H:i:s') timestamp for message. | yii\log\Target |
属性详情 Property Details
Syslog facility.
Syslog identity
Openlog options. This is a bitfield passed as the $option
parameter to openlog().
Defaults to null
which means to use the default options LOG_ODELAY | LOG_PID
.
请参阅 https://secure.php.net/openlog for available options.
方法详情 Method Details
Writes log messages to syslog.
Starting from version 2.0.14, this method throws LogRuntimeException in case the log can not be exported.
public void export ( ) | ||
throws | yii\log\LogRuntimeException |
---|
Formats a log message for display as a string.
public string formatMessage ( $message ) | ||
$message | array | The log message to be formatted. The message structure follows that in yii\log\Logger::$messages. |
return | string | The formatted message |
---|
Initializes the object.
This method is invoked at the end of the constructor after the object is initialized with the given configuration.
public void init ( ) |