FileLog::save()

Save the given log entry string

Usage

// basic usage
$bool = $fileLog->save(string $str);

// usage with all arguments
$bool = $fileLog->save(string $str, array $options = []);

Arguments

NameType(s)Description
$strstring
$options (optional)array

options to modify behavior (Added 3.0.143

  • allowDups (bool): Allow duplicating same log entry in same runtime/request? Default:true
  • mergeDups (int): Merge previous duplicate entries that also appear near end of file? To enable, specify int for quantity of bytes to consider from EOF, value of 1024 or higher Default:0, disabled
  • maxTries (int): If log entry fails to save, maximum times to re-try Default:20
  • maxTriesDelay (int): Micro seconds (millionths of a second) to delay between re-tries Default:2000

Return value

bool

Success state: true if log written, false if not.

FileLog methods and properties

API reference based on ProcessWire core version 3.0.251