interface/modules/zend_modules/library/Zend/Log/Writer/Db.php

   1 <?php
   2 /**
   3  * Zend Framework (http://framework.zend.com/)
   4  *
   5  * @link      http://github.com/zendframework/zf2 for the canonical source repository
   6  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
   7  * @license   http://framework.zend.com/license/new-bsd New BSD License
   8  */
   9
  10 namespace Zend\Log\Writer;
  11
  12 use Traversable;
  13 use Zend\Db\Adapter\Adapter;
  14 use Zend\Log\Exception;
  15 use Zend\Log\Formatter;
  16 use Zend\Log\Formatter\Db as DbFormatter;
  17
  18 class Db extends AbstractWriter
  19 {
  20     /**
  21      * Db adapter instance
  22      *
  23      * @var Adapter
  24      */
  25     protected $db;
  26
  27     /**
  28      * Table name
  29      *
  30      * @var string
  31      */
  32     protected $tableName;
  33
  34     /**
  35      * Relates database columns names to log data field keys.
  36      *
  37      * @var null|array
  38      */
  39     protected $columnMap;
  40
  41     /**
  42      * Field separator for sub-elements
  43      *
  44      * @var string
  45      */
  46     protected $separator = '_';
  47
  48     /**
  49      * Constructor
  50      *
  51      * We used the Adapter instead of Zend\Db for a performance reason.
  52      *
  53      * @param Adapter|array|Traversable $db
  54      * @param string $tableName
  55      * @param array $columnMap
  56      * @param string $separator
  57      * @throws Exception\InvalidArgumentException
  58      */
  59     public function __construct($db, $tableName = null, array $columnMap = null, $separator = null)
  60     {
  61         if ($db instanceof Traversable) {
  62             $db = iterator_to_array($db);
  63         }
  64
  65         if (is_array($db)) {
  66             parent::__construct($db);
  67             $separator = isset($db['separator']) ? $db['separator'] : null;
  68             $columnMap = isset($db['column']) ? $db['column'] : null;
  69             $tableName = isset($db['table']) ? $db['table'] : null;
  70             $db        = isset($db['db']) ? $db['db'] : null;
  71         }
  72
  73         if (!$db instanceof Adapter) {
  74             throw new Exception\InvalidArgumentException('You must pass a valid Zend\Db\Adapter\Adapter');
  75         }
  76
  77         $tableName = (string) $tableName;
  78         if ('' === $tableName) {
  79             throw new Exception\InvalidArgumentException('You must specify a table name. Either directly in the constructor, or via options');
  80         }
  81
  82         $this->db        = $db;
  83         $this->tableName = $tableName;
  84         $this->columnMap = $columnMap;
  85
  86         if (!empty($separator)) {
  87             $this->separator = $separator;
  88         }
  89
  90         $this->setFormatter(new DbFormatter());
  91     }
  92
  93     /**
  94      * Remove reference to database adapter
  95      *
  96      * @return void
  97      */
  98     public function shutdown()
  99     {
 100         $this->db = null;
 101     }
 102
 103     /**
 104      * Write a message to the log.
 105      *
 106      * @param array $event event data
 107      * @return void
 108      * @throws Exception\RuntimeException
 109      */
 110     protected function doWrite(array $event)
 111     {
 112         if (null === $this->db) {
 113             throw new Exception\RuntimeException('Database adapter is null');
 114         }
 115
 116         $event = $this->formatter->format($event);
 117
 118         // Transform the event array into fields
 119         if (null === $this->columnMap) {
 120             $dataToInsert = $this->eventIntoColumn($event);
 121         } else {
 122             $dataToInsert = $this->mapEventIntoColumn($event, $this->columnMap);
 123         }
 124
 125         $statement = $this->db->query($this->prepareInsert($this->db, $this->tableName, $dataToInsert));
 126         $statement->execute($dataToInsert);
 127
 128     }
 129
 130     /**
 131      * Prepare the INSERT SQL statement
 132      *
 133      * @param  Adapter $db
 134      * @param  string $tableName
 135      * @param  array $fields
 136      * @return string
 137      */
 138     protected function prepareInsert(Adapter $db, $tableName, array $fields)
 139     {
 140         $keys = array_keys($fields);
 141         $sql = 'INSERT INTO ' . $db->platform->quoteIdentifier($tableName) . ' (' .
 142             implode(",",array_map(array($db->platform, 'quoteIdentifier'), $keys)) . ') VALUES (' .
 143             implode(",",array_map(array($db->driver, 'formatParameterName'), $keys)) . ')';
 144
 145         return $sql;
 146     }
 147
 148     /**
 149      * Map event into column using the $columnMap array
 150      *
 151      * @param  array $event
 152      * @param  array $columnMap
 153      * @return array
 154      */
 155     protected function mapEventIntoColumn(array $event, array $columnMap = null)
 156     {
 157         if (empty($event)) {
 158             return array();
 159         }
 160
 161         $data = array();
 162         foreach ($event as $name => $value) {
 163             if (is_array($value)) {
 164                 foreach ($value as $key => $subvalue) {
 165                     if (isset($columnMap[$name][$key])) {
 166                         $data[$columnMap[$name][$key]] = $subvalue;
 167                     }
 168                 }
 169             } elseif (isset($columnMap[$name])) {
 170                 $data[$columnMap[$name]] = $value;
 171             }
 172         }
 173         return $data;
 174     }
 175
 176     /**
 177      * Transform event into column for the db table
 178      *
 179      * @param  array $event
 180      * @return array
 181      */
 182     protected function eventIntoColumn(array $event)
 183     {
 184         if (empty($event)) {
 185             return array();
 186         }
 187
 188         $data = array();
 189         foreach ($event as $name => $value) {
 190             if (is_array($value)) {
 191                 foreach ($value as $key => $subvalue) {
 192                     $data[$name . $this->separator . $key] = $subvalue;
 193                 }
 194             } else {
 195                 $data[$name] = $value;
 196             }
 197         }
 198         return $data;
 199     }
 200 }