Class craft\log\FileTarget

Inheritance: craft\log\FileTarget » yii\log\FileTarget » yii\log\Target » yii\base\Component » yii\base\BaseObject
Implements: yii\base\Configurable
Available since version: 3.0
Source Code: https://github.com/craftcms/cms/blob/master/src/log/FileTarget.php

Class FileTarget

Public Properties
Property	Type	Description	Defined By
`$categories`	array	List of message categories that this target is interested in.	yii\log\Target
`$dirMode`	integer	The permission to be set for newly created directories.	yii\log\FileTarget
`$enableRotation`	boolean	Whether log files should be rotated when they reach a certain maximum size.	yii\log\FileTarget
`$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
`$fileMode`	integer	The permission to be set for newly created log files.	yii\log\FileTarget
`$logFile`	string	Log file path or path alias.	yii\log\FileTarget
`$logVars`	array	List of the PHP predefined variables that should be logged in a message.	yii\log\Target
`$maxFileSize`	integer	Maximum log file size, in kilo-bytes.	yii\log\FileTarget
`$maxLogFiles`	integer	Number of log files used for rotation.	yii\log\FileTarget
`$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
`$prefix`	callable	A PHP callable that returns a string to be prefixed to every exported message.	yii\log\Target
`$rotateByCopy`	boolean	Whether to rotate log files by copy and truncate in contrast to rotation by renaming files.	yii\log\FileTarget

Public 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 a file.	yii\log\FileTarget
`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\Target
`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\base\BaseObject
`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
Method	Description	Defined By
`getContextMessage()`	Generates the context information to be logged.	craft\log\FileTarget
`getTime()`	Returns formatted ('Y-m-d H:i:s') timestamp for message.	yii\log\Target
`rotateFiles()`	Rotates log files.	yii\log\FileTarget

Method Details

`getContextMessage()` protected method #

Generates the context information to be logged.

The default implementation will dump user information, system variables, etc.

protected string getContextMessage ( )

return	string	The context information. If an empty string, it means no context information.

Method Details

getContextMessage() protected method #

`getContextMessage()` protected method #