Merge pull request #4 from rantonmattei/first-commit

First commit: license + README

LICENSE

@@ -1,6 +1,7 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 theorchard
+Copyright (c) 2015 Raphaël Antonmattei
+Copyright (c) 2015 The Orchard
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -0,0 +1,189 @@
+Monolog Cascade
+===============
+(coming soon...)
+
+What is Monolog Cascade?
+------------------------
+
+Monolog Cascade is a [Monolog](https://github.com/Seldaek/monolog) extension that allows you to set up and configure multiple loggers and handlers from a single config file.
+
+It's been inspired by the [`logging.config`](https://docs.python.org/3.4/library/logging.config.html?highlight=fileconfig#module-logging.config) Python module.
+
+
+------------
+
+
+Installation
+------------
+
+Add `monolog-cascade` as a requirement in your `composer.json` file or run
+```sh
+$ composer require theorchard/monolog-cascade
+```
+
+Note: Monolog Cascade requires PHP 5.3.9 or higher.
+
+Usage
+-----
+
+```php
+<?php
+use Cascade\MonoLogger;
+
+// configure your loggers
+MonoLogger::fileConfig('path/to/some/config.yaml');
+```
+
+Then just use your logger as shown below
+```php
+MonoLogger::getLogger('myApp')->info('Well, that works!');
+MonoLogger::getLogger('myApp')->error('Maybe not...');
+```
+
+Configuring your loggers
+------------------------
+Monolog Cascade supports the following config formats:
+ - Yaml
+ - JSON
+ - Php array
+
+### Configuration structure
+Here is a sample Yaml config file:
+```yaml
+
+formatters:
+    dashed:
+        class: Monolog\Formatter\LineFormatter
+        format: "%datetime%-%channel%.%level_name% - %message%\n"
+handlers:
+    console:
+        class: Monolog\Handler\StreamHandler
+        level: DEBUG
+        formatter: dashed
+        stream: php://stdout
+    info_file_handler:
+        class: Monolog\Handler\StreamHandler
+        level: INFO
+        formatter: dashed
+        stream: ./example_info.log
+loggers:
+    myLogger:
+        handlers: [console, info_file_handler]
+```
+
+More informations on how the Cascade config parser loads and reads the parameters:
+
+Only the `loggers` key is required. If `formatters` and `handlers` are ommitted, Monolog's default will be used. (see note at the bottom)
+
+Other keys are optional and would be interpreted as described below:
+
+- **_formatters_** - the derived associative array (from the Yaml or JSON) in which each key is the formatter identifier holds keys/values to configure your formatters.
+The only _reserved_ key is `class` and it should contain the classname of the formatter you would like to use. Other parameters will be interpreted as constructor parameters for that class and passed in when the formatter object is instanced by the Cascade config loader.<br />
+If some parameters are not present in the constructor, they will be treated as extra parameters and Cascade will try to interpret them should they match any custom handler functions that are able to use them. (see [Extra Parameters](#user-content-extra-parameters-other-than-constructors) section below)<br />
+
+    If `class` is not provided Cascade will default to `Monolog\Formatter\LineFormatter`
+
+- **_handlers_** - the derived associative array (from the Yaml or JSON) in which each key is the handler identifier holds keys/values to configure your handlers.<br />The following keys are _reserved_:
+    - `class` (optional): classname of the handler you would like to use
+    - `formatter` (optional): formatter identifier that you have defined
+
+    Other parameters will be interpreted as constructor parameters for that Handler class and passed in when the handler object is instantiated by the Cascade config loader.<br />
+    If some parameters are not present in the constructor, they will be interpreted as extra parameters and Cascade will try to interpret them should they match any custom handler functions that are able to use them. (see [Extra Parameters](#user-content-extra-parameters-other-than-constructors) section below)
+
+    If class is not provided Cascade will default to `Monolog\Handler\StreamHandler`
+
+- **_loggers_** - the derived array (from the Yaml or JSON) in which each key is the logger identifier contains only a `handlers` key. You can decide what handler(s) you would like you logger to use.
+
+#### Parameter case
+You can use either _underscored_ or _camelCased_ style in your config files, it does not matter. However, it is important that they match the names of the arguments from the constructor method.
+
+```php
+public function __construct($level = Logger::ERROR, $bubble = true, $appName = null)
+```
+
+Using a Yaml file:
+```yaml
+    level: ERROR,
+    bubble: true,
+    app_name: "some app that I wrote"
+```
+
+Cascade will _camelCase_ all the names of your parameters internally prior to be passed to the constructors.
+
+#### Optional keys
+`formatters` and `handlers` keys are optional. If ommitted Cascade will default to Monolog's default: `Monolog\Formatter\LineFormatter` and `Monolog\Handler\StreamHandler` to `stderr`
+
+#### Default parameters
+If a constructor method provides default value(s) in their declaration, Cascade will look it up and identify those parameters as optional with their default values. It can therefore be ommitted in your config file.
+
+#### Order of sections and params
+Order of the sections within the config file has no impact as long as they are formatted properly.
+<br />Order of parameters does not matter either.
+
+#### Extra parameters (other than constructor's)
+You may want to have your Formatters and/or Handlers consume values other than via the constructor. Some methods may be called to do additional set up when configuring your loggers. Cascade interprets those extra params 3 different ways and will try do so in that order:
+
+1. _Instance method_
+    <br />Your Formatter or Handler has a defined method that takes a param as input. In that case you can write it as follow in your config file:
+
+    ```yaml
+    formatters:
+      spaced:
+          class: Monolog\Formatter\LineFormatter
+          format: "%datetime% %channel%.%level_name%  %message%\n"
+          include_stacktraces: true
+    ```
+    In this example, the `LineFormatter` class has an `includeStackTrace` method that takes a boolean. This method will be called upon instantiation.<br />
+
+2. _Public member_
+    <br />Your Formatter or Handler has a public member that can be set.
+
+    ```yaml
+    formatters:
+        spaced:
+            class: Monolog\Formatter\SomeFormatter
+            some_public_member: "some value"
+    ```
+    In this example, the public member will be set to the passed in value upon instantiation.<br />
+
+3. _Custom handler function_
+    <br />See `FormatterLoader::initExtraOptionsHandlers` and `HandlerLoader::initExtraOptionsHandlers`. Those methods hold closures that can call instance methods if needed. The closure takes the instance and the parameter value as input.
+
+    ```php
+    self::$extraOptionHandlers = array(
+        '\Monolog\Formatter\LineFormatter' => array(
+            'includeStacktraces' => function ($instance, $include) {
+                $instance->includeStacktraces($include);
+            }
+        )
+    );
+    ```
+    You can add handlers at runtime if needed. (i.e. if you write your logger handler for instance)
+
+Running Tests
+-------------
+
+Just run Phpunit:
+```sh
+$ phpunit tests/
+```
+
+Contributing
+------------
+
+This extension is open source. Feel free to contribute and send a pull request!
+
+Make sure your code follows the [PSR-2](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md) standards, is documented and has unit tests.
+
+
+What's next?
+------------
+ - add support for `.ini` config files
+ - add support for namespaced Loggers with message propagation (through handler inheritance) so children loggers log messages using parent's handlers
+ - add more custom function handlers to cover all the possible options of the current Monolog Formatters and Handlers
+ - other suggestions?
+
+
+Symfony Users
+-------------
+You may want to use [MonologBundle](https://github.com/symfony/MonologBundle) as it integrates directly with your favorite framework.