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

   1 <?php
   2
   3 /**
   4  * Zend Framework (http://framework.zend.com/)
   5  *
   6  * @link      http://github.com/zendframework/zf2 for the canonical source repository
   7  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
   8  * @license   http://framework.zend.com/license/new-bsd New BSD License
   9  */
  10
  11 namespace Zend\Log\Writer;
  12
  13 use DateTime;
  14 use Mongo;
  15 use MongoClient;
  16 use MongoDate;
  17 use Traversable;
  18 use Zend\Log\Exception;
  19 use Zend\Log\Formatter\FormatterInterface;
  20 use Zend\Stdlib\ArrayUtils;
  21
  22 /**
  23  * MongoDB log writer.
  24  */
  25 class MongoDB extends AbstractWriter
  26 {
  27     /**
  28      * MongoCollection instance
  29      *
  30      * @var MongoCollection
  31      */
  32     protected $mongoCollection;
  33
  34     /**
  35      * Options used for MongoCollection::save()
  36      *
  37      * @var array
  38      */
  39     protected $saveOptions;
  40
  41     /**
  42      * Constructor
  43      *
  44      * @param Mongo|MongoClient|array|Traversable $mongo
  45      * @param string|MongoDB $database
  46      * @param string $collection
  47      * @param array $saveOptions
  48      * @throws Exception\InvalidArgumentException
  49      */
  50     public function __construct($mongo, $database = null, $collection = null, array $saveOptions = array())
  51     {
  52         if ($mongo instanceof Traversable) {
  53             // Configuration may be multi-dimensional due to save options
  54             $mongo = ArrayUtils::iteratorToArray($mongo);
  55         }
  56         if (is_array($mongo)) {
  57             parent::__construct($mongo);
  58             $saveOptions = isset($mongo['save_options']) ? $mongo['save_options'] : array();
  59             $collection  = isset($mongo['collection']) ? $mongo['collection'] : null;
  60             $database    = isset($mongo['database']) ? $mongo['database'] : null;
  61             $mongo       = isset($mongo['mongo']) ? $mongo['mongo'] : null;
  62         }
  63
  64         if (null === $collection) {
  65             throw new Exception\InvalidArgumentException(
  66                     'The collection parameter cannot be empty'
  67             );
  68         }
  69
  70         if (null === $database) {
  71             throw new Exception\InvalidArgumentException(
  72                     'The database parameter cannot be empty'
  73             );
  74         }
  75
  76         if (!($mongo instanceof MongoClient || $mongo instanceof Mongo)) {
  77             throw new Exception\InvalidArgumentException(sprintf(
  78                 'Parameter of type %s is invalid; must be MongoClient or Mongo',
  79                 (is_object($mongo) ? get_class($mongo) : gettype($mongo))
  80             ));
  81         }
  82
  83         $this->mongoCollection = $mongo->selectCollection($database, $collection);
  84         $this->saveOptions     = $saveOptions;
  85     }
  86
  87     /**
  88      * This writer does not support formatting.
  89      *
  90      * @param string|FormatterInterface $formatter
  91      * @return WriterInterface
  92      */
  93     public function setFormatter($formatter)
  94     {
  95         return $this;
  96     }
  97
  98     /**
  99      * Write a message to the log.
 100      *
 101      * @param array $event Event data
 102      * @return void
 103      * @throws Exception\RuntimeException
 104      */
 105     protected function doWrite(array $event)
 106     {
 107         if (null === $this->mongoCollection) {
 108             throw new Exception\RuntimeException('MongoCollection must be defined');
 109         }
 110
 111         if (isset($event['timestamp']) && $event['timestamp'] instanceof DateTime) {
 112             $event['timestamp'] = new MongoDate($event['timestamp']->getTimestamp());
 113         }
 114
 115         $this->mongoCollection->save($event, $this->saveOptions);
 116     }
 117 }