Enables creation of logs, logging of events, and management of logs.

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the WireLog class also inherits all the methods and properties of: Wire.

Common / Retrieval / Manipulation

Common

Name Return Summary  
$log->error(string $text) $this Record an error message in the error log (errors.txt)
$log->message(string $text) $this Record an informational or 'success' message in the message log (messages.txt)
$log->save(string $name, string $text) bool Save text to a named log
$log->warning(string $text) $this Record a warning message in the warnings log (warnings.txt)

Retrieval

Name Return Summary  
$log->getEntries($name) array Return given number of entries from end of log file, with each entry as an associative array of components
$log->getFilename(string $name) string Get the full filename (including path) for the given log name
$log->getLines(string $name) array Return the given number of entries from the end of log file
$log->getLogs() array Return array of all logs, sorted by name
$log->getTotalEntries(string $name) int Get the total number of entries present in the given log

Manipulation

Name Return Summary  
$log->delete(string $name) bool Delete a log file
$log->prune(string $name, int $days) int Prune log file to contain only entries from last [n] days

Additional methods and properties

In addition to the methods and properties above, WireLog also inherits the methods and properties of these classes: