PHPackages                             gbhorwood/cloverlogger - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Logging & Monitoring](/categories/logging)
4. /
5. gbhorwood/cloverlogger

ActiveLibrary[Logging & Monitoring](/categories/logging)

gbhorwood/cloverlogger
======================

Logger for Fruitbat/Cloverhitch/Kludgetastic

1.0.1(10mo ago)057↓50%MITPHPPHP ^8.1

Since Jun 30Pushed 3mo agoCompare

[ Source](https://github.com/gbhorwood/Cloverlogger)[ Packagist](https://packagist.org/packages/gbhorwood/cloverlogger)[ RSS](/packages/gbhorwood-cloverlogger/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (2)Dependencies (2)Versions (4)Used By (0)

Cloverlogger
============

[](#cloverlogger)

Cloverlogger is a simple file logger for php projects. Cloverlogger is an internal project for Fruitbat Studios/Cloverhitch Technologies/Kludgetastic Implementations.

Installation
------------

[](#installation)

Installation is done via composer:

```
composer require gbhorwood/cloverlogger
```

Once installed it is *highly* recommended to publish the configuration file.

```
/vendor/bin/cloverlogger-publish-config
```

Configuration
-------------

[](#configuration)

The published configuration file lives in the root directory of your project and is called `cloverlogger.conf`

The default config file looks like this.

```
;;;
; Config file for Gbhorwood\Cloverlogger
; https://github.com/gbhorwood/Cloverlogger

FILE=/tmp/cloverlogger
SEPARATOR="::"

```

**`FILE`** Sets the file Cloverlogger writes to.

**`SEPARATOR`** Sets the character(s) used to delimit fields in a log line

Usage
-----

[](#usage)

A basic usage of cloverlogger looks like:

```
require_once __DIR__ . '/../vendor/autoload.php';

use Gbhorwood\Cloverlogger\Logger as clover;

clover::info("message", "more message");
```

There are two things to note here:

**method name**: The method name can be anything: `info`, `debug`, `mySpecialLogMessages`. The method name is stored in log line, allowing you to easily find relevant logs. For instance, if you are logging information on about your email library, you could use the method `emailLibLog()`, then find all the logs for that feature by `grep`ing the logfile for that method name.

**arguments**: The method can take an arbitrary number of messages. Each message will be written in the log line, delimted by the `SEPARATOR` character.

Logged lines
------------

[](#logged-lines)

Lines logged by Cloverlogger follow the pattern:

```
::::::::::::

```

Calling Cloverlogger like so:

```
1