Merge branch 'release/0.1.0'

Author: silentworks

.gitignore

@@ -0,0 +1 @@
+/vendor/

DateTimeFileWriter.php

@@ -0,0 +1,153 @@
+<?php
+/**
+ * DateTime Log File Writer
+ *
+ * Use this custom log writer to output log messages
+ * to a daily, weekly, monthly, or yearly log file. Log
+ * files will inherently rotate based on the specified
+ * log file name format and the current time.
+ *
+ * USAGE
+ *
+ * $app = new \Slim\Slim(array(
+ *     'log.writer' => new \Slim\Logger\DateTimeFileWriter()
+ * ));
+ *
+ * SETTINGS
+ *
+ * You may customize this log writer by passing an array of
+ * settings into the class constructor. Available options
+ * are shown above the constructor method below.
+ *
+ * @author      Josh Lockhart <[email protected]>
+ * @copyright   2012 Josh Lockhart
+ * @version     0.1.0
+ *
+ * MIT LICENSE
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining
+ * a copy of this software and associated documentation files (the
+ * "Software"), to deal in the Software without restriction, including
+ * without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sublicense, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to
+ * the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+ * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+ * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+ * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+namespace Slim\Logger;
+
+class DateTimeFileWriter
+{
+    /**
+     * @const string
+     */
+    const VERSION = '0.1.0';
+
+    /**
+     * @var resource
+     */
+    protected $resource;
+
+    /**
+     * @var array
+     */
+    protected $settings;
+
+    /**
+     * Constructor
+     *
+     * Prepare this log writer. Available settings are:
+     *
+     * path:
+     * (string) The relative or absolute filesystem path to a writable directory.
+     *
+     * name_format:
+     * (string) The log file name format; parsed with `date()`.
+     *
+     * extension:
+     * (string) The file extention to append to the filename`.     
+     *
+     * message_format:
+     * (string) The log message format; available tokens are...
+     *     %label%      Replaced with the log message level (e.g. FATAL, ERROR, WARN).
+     *     %date%       Replaced with a ISO8601 date string for current timezone.
+     *     %message%    Replaced with the log message, coerced to a string.
+     *
+     * @param   array $settings
+     * @return  void
+     */
+    public function __construct($settings = array())
+    {
+        //Merge user settings
+        $this->settings = array_merge(array(
+            'path' => './logs',
+            'name_format' => 'Y-m-d',
+            'extension' => 'log',
+            'message_format' => '%label% - %date% - %message%'
+        ), $settings);
+
+        //Remove trailing slash from log path
+        $this->settings['path'] = rtrim($this->settings['path'], DIRECTORY_SEPARATOR);
+    }
+
+    /**
+     * Write to log
+     *
+     * @param   mixed $object
+     * @param   int   $level
+     * @return  void
+     */
+    public function write($object, $level)
+    {
+        //Determine label
+        $label = 'DEBUG';
+        switch ($level) {
+            case \Slim\Log::FATAL:
+                $label = 'FATAL';
+                break;
+            case \Slim\Log::ERROR:
+                $label = 'ERROR';
+                break;
+            case \Slim\Log::WARN:
+                $label = 'WARN';
+                break;
+            case \Slim\Log::INFO:
+                $label = 'INFO';
+                break;
+        }
+
+        //Get formatted log message
+        $message = str_replace(array(
+            '%label%',
+            '%date%',
+            '%message%'
+        ), array(
+            $label,
+            date('c'),
+            (string)$object
+        ), $this->settings['message_format']);
+
+        //Open resource handle to log file
+        if (!$this->resource) {
+            $filename = date($this->settings['name_format']);
+            if (! empty($this->settings['extension'])) {
+                $filename .= '.' . $this->settings['extension'];
+            }
+
+            $this->resource = fopen($this->settings['path'] . DIRECTORY_SEPARATOR . $filename, 'a');
+        }
+
+        //Output to resource
+        fwrite($this->resource, $message . PHP_EOL);
+    }
+}

README.md

@@ -2,3 +2,46 @@ Slim-Logger
 ===========
 
 A stand-alone logger class for use with the Slim Framework
+
+## How to Install
+
+#### using [Composer](http://getcomposer.org/)
+
+Create a composer.json file in your project root:
+    
+```json
+{
+    "require": {
+        "slim/logger": "0.1.*"
+    }
+}
+```
+
+Then run the following composer command:
+
+```bash
+$ php composer.phar install
+```
+
+### How to use
+    
+```php
+<?php
+require 'vendor/autoload.php';
+
+$app = new \Slim\Slim(array(
+    'log.writer' => new \Slim\Logger\DateTimeFileWriter()
+));
+```
+
+## Author
+
+[Josh Lockhart](https://github.com/codeguy)
+
+### Contributor
+
+[Andrew Smith](https://github.com/silentworks)
+
+## License
+
+MIT Public License

composer.json

@@ -0,0 +1,21 @@
+{
+    "name": "slim/logger",
+    "description": "Slim Framework logger",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Josh Lockhart",
+            "email": "[email protected]",
+            "homepage": "http://www.joshlockhart.com/"
+        }
+    ],
+    "require": {
+        "php": ">=5.3.0",
+        "slim/slim": ">=2.4.0"
+    },
+    "autoload": {
+        "psr-4": {
+            "Slim\\Logger\\": ""
+        }
+    }
+}