Log a message for this class
Message is saved to a log file in ProcessWire's logs path to a file with the same name as the class, converted to hyphenated lowercase.
Example
$this->log("This message will be logged"); Usage
// basic usage
$wireLog = $fileValidatorModule->log();
// usage with all arguments
$wireLog = $fileValidatorModule->log(string $str = '', array $options = []);Arguments
| Name | Type(s) | Description |
|---|---|---|
str (optional) | string | Text to log, or omit to just return the name of the log |
options (optional) | array | Optional extras to include:
|
Return value
WireLog null
Hooking FileValidatorModule::log(…)
You can add your own hook events that are executed either before or after the File method is executed. Examples of both are included below. A good place for hook code such as this is in your /site/ready.php file.
Hooking before
The 'before' hooks are called immediately before each File method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.
$this->addHookBefore('FileValidatorModule::log', function(HookEvent $event) {
// Get the object the event occurred on, if needed
$FileValidatorModule = $event->object;
// Get values of arguments sent to hook (and optionally modify them)
$str = $event->arguments(0);
$options = $event->arguments(1);
/* Your code here, perhaps modifying arguments */
// Populate back arguments (if you have modified them)
$event->arguments(0, $str);
$event->arguments(1, $options);
}); Hooking after
The 'after' hooks are called immediately after each File method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.
$this->addHookAfter('FileValidatorModule::log', function(HookEvent $event) {
// Get the object the event occurred on, if needed
$FileValidatorModule = $event->object;
// An 'after' hook can retrieve and/or modify the return value
$return = $event->return;
// Get values of arguments sent to hook (if needed)
$str = $event->arguments(0);
$options = $event->arguments(1);
/* Your code here, perhaps modifying the return value */
// Populate back return value, if you have modified it
$event->return = $return;
}); FileValidatorModule methods and properties
API reference based on ProcessWire core version 3.0.236