ProcessLogger::formatLogText()

Format log line txt

This protected method is for hooks to monitor and it is likely not intended to be called directly.

Internal usage

// basic internal usage
$string = $processLogger->formatLogText(string $text);

// internal usage with all arguments
$string = $processLogger->formatLogText(string $text, string $logName = '');

Arguments

NameType(s)Description
$textstring
$logName (optional)string

Return value

string


Hooking ProcessLogger::formatLogText(…)

You can add your own hook events that are executed either before or after the ProcessLogger::formatLogText(…) 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 ProcessLogger::formatLogText(…) method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.

$this->addHookBefore('ProcessLogger::formatLogText', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $ProcessLogger = $event->object;

  // Get values of arguments sent to hook (and optionally modify them)
  $text = $event->arguments(0);
  $logName = $event->arguments(1);

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
  $event->arguments(0, $text);
  $event->arguments(1, $logName);
});

Hooking after

The 'after' hooks are called immediately after each ProcessLogger::formatLogText(…) method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

$this->addHookAfter('ProcessLogger::formatLogText', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $ProcessLogger = $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)
  $text = $event->arguments(0);
  $logName = $event->arguments(1);

  /* Your code here, perhaps modifying the return value */

  // Populate back return value, if you have modified it
  $event->return = $return;
});

ProcessLogger methods and properties

API reference based on ProcessWire core version 3.0.251