| /vendor/monolog/monolog/README.md |
|---|
| @@ -0,0 +1,95 @@ |
|---|
| # Monolog - Logging for PHP [](https://travis-ci.org/Seldaek/monolog) |
| |
| [](https://packagist.org/packages/monolog/monolog) |
| [](https://packagist.org/packages/monolog/monolog) |
| [](https://www.versioneye.com/php/monolog:monolog/references) |
| |
| |
| Monolog sends your logs to files, sockets, inboxes, databases and various |
| web services. See the complete list of handlers below. Special handlers |
| allow you to build advanced logging strategies. |
| |
| This library implements the [PSR-3](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-3-logger-interface.md) |
| interface that you can type-hint against in your own libraries to keep |
| a maximum of interoperability. You can also use it in your applications to |
| make sure you can always use another compatible logger at a later time. |
| As of 1.11.0 Monolog public APIs will also accept PSR-3 log levels. |
| Internally Monolog still uses its own level scheme since it predates PSR-3. |
| |
| ## Installation |
| |
| Install the latest version with |
| |
| ```bash |
| $ composer require monolog/monolog |
| ``` |
| |
| ## Basic Usage |
| |
| ```php |
| <?php |
| |
| use Monolog\Logger; |
| use Monolog\Handler\StreamHandler; |
| |
| // create a log channel |
| $log = new Logger('name'); |
| $log->pushHandler(new StreamHandler('path/to/your.log', Logger::WARNING)); |
| |
| // add records to the log |
| $log->addWarning('Foo'); |
| $log->addError('Bar'); |
| ``` |
| |
| ## Documentation |
| |
| - [Usage Instructions](doc/01-usage.md) |
| - [Handlers, Formatters and Processors](doc/02-handlers-formatters-processors.md) |
| - [Utility classes](doc/03-utilities.md) |
| - [Extending Monolog](doc/04-extending.md) |
| |
| ## Third Party Packages |
| |
| Third party handlers, formatters and processors are |
| [listed in the wiki](https://github.com/Seldaek/monolog/wiki/Third-Party-Packages). You |
| can also add your own there if you publish one. |
| |
| ## About |
| |
| ### Requirements |
| |
| - Monolog works with PHP 5.3 or above, and is also tested to work with HHVM. |
| |
| ### Submitting bugs and feature requests |
| |
| Bugs and feature request are tracked on [GitHub](https://github.com/Seldaek/monolog/issues) |
| |
| ### Framework Integrations |
| |
| - Frameworks and libraries using [PSR-3](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-3-logger-interface.md) |
| can be used very easily with Monolog since it implements the interface. |
| - [Symfony2](http://symfony.com) comes out of the box with Monolog. |
| - [Silex](http://silex.sensiolabs.org/) comes out of the box with Monolog. |
| - [Laravel 4 & 5](http://laravel.com/) come out of the box with Monolog. |
| - [Lumen](http://lumen.laravel.com/) comes out of the box with Monolog. |
| - [PPI](http://www.ppi.io/) comes out of the box with Monolog. |
| - [CakePHP](http://cakephp.org/) is usable with Monolog via the [cakephp-monolog](https://github.com/jadb/cakephp-monolog) plugin. |
| - [Slim](http://www.slimframework.com/) is usable with Monolog via the [Slim-Monolog](https://github.com/Flynsarmy/Slim-Monolog) log writer. |
| - [XOOPS 2.6](http://xoops.org/) comes out of the box with Monolog. |
| - [Aura.Web_Project](https://github.com/auraphp/Aura.Web_Project) comes out of the box with Monolog. |
| - [Nette Framework](http://nette.org/en/) can be used with Monolog via [Kdyby/Monolog](https://github.com/Kdyby/Monolog) extension. |
| - [Proton Micro Framework](https://github.com/alexbilbie/Proton) comes out of the box with Monolog. |
| |
| ### Author |
| |
| Jordi Boggiano - <j.boggiano@seld.be> - <http://twitter.com/seldaek><br /> |
| See also the list of [contributors](https://github.com/Seldaek/monolog/contributors) which participated in this project. |
| |
| ### License |
| |
| Monolog is licensed under the MIT License - see the `LICENSE` file for details |
| |
| ### Acknowledgements |
| |
| This library is heavily inspired by Python's [Logbook](http://packages.python.org/Logbook/) |
| library, although most concepts have been adjusted to fit to the PHP world. |
