Overview

Namespaces

  • Webmozart
    • KeyValueStore
      • Api
      • Decorator
      • Util

Classes

  • AbstractRedisStore
  • ArrayStore
  • DbalStore
  • JsonFileStore
  • MongoDbStore
  • NullStore
  • PhpRedisStore
  • PredisStore
  • RiakStore
  • SerializingArrayStore
  • Overview
  • Namespace
  • Class
  1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: 292: 293: 294: 295: 296: 297: 298: 299: 300: 301: 302: 303: 304: 305: 306: 307: 308: 309: 310: 311: 312: 313: 314: 
<?php

/*
 * This file is part of the vendor/project package.
 *
 * (c) Bernhard Schussek <bschussek@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Webmozart\KeyValueStore;

use Closure;
use Exception;
use MongoDB\BSON\Binary;
use MongoDB\Collection;
use MongoDB\Driver\Exception\UnexpectedValueException;
use Webmozart\KeyValueStore\Api\KeyValueStore;
use Webmozart\KeyValueStore\Api\NoSuchKeyException;
use Webmozart\KeyValueStore\Api\ReadException;
use Webmozart\KeyValueStore\Api\UnserializationFailedException;
use Webmozart\KeyValueStore\Api\UnsupportedValueException;
use Webmozart\KeyValueStore\Api\WriteException;
use Webmozart\KeyValueStore\Util\KeyUtil;
use Webmozart\KeyValueStore\Util\Serializer;

/**
 * A key-value-store backed by MongoDB.
 *
 * @since 1.0
 *
 * @author Bernhard Schussek <hello@webmozart.io>
 */
class MongoDbStore implements KeyValueStore
{
    /**
     * Flag: Disable serialization.
     */
    const NO_SERIALIZE = 1;

    /**
     * Flag: Support storage of binary data.
     */
    const SUPPORT_BINARY = 2;

    private static $typeMap = array(
        'root' => 'array',
        'document' => 'array',
        'array' => 'array',
    );

    /**
     * @var Collection
     */
    private $collection;

    /**
     * @var Closure
     */
    private $serialize;

    /**
     * @var Closure
     */
    private $unserialize;

    public function __construct(Collection $collection, $flags = 0)
    {
        $this->collection = $collection;

        if ($flags & self::NO_SERIALIZE) {
            if ($flags & self::SUPPORT_BINARY) {
                $this->serialize = function ($unserialized) {
                    if (!is_string($unserialized)) {
                        throw UnsupportedValueException::forValue($unserialized, $this);
                    }

                    return new Binary($unserialized, Binary::TYPE_GENERIC);
                };
                $this->unserialize = function (Binary $serialized) {
                    return $serialized->getData();
                };
            } else {
                $this->serialize = function ($unserialized) {
                    if (!is_scalar($unserialized) && !is_array($unserialized) && null !== $unserialized) {
                        throw UnsupportedValueException::forValue($unserialized, $this);
                    }

                    return $unserialized;
                };
                $this->unserialize = function ($serialized) {
                    return $serialized;
                };
            }
        } else {
            if ($flags & self::SUPPORT_BINARY) {
                $this->serialize = function ($unserialized) {
                    return new Binary(
                        Serializer::serialize($unserialized),
                        Binary::TYPE_GENERIC
                    );
                };
                $this->unserialize = function (Binary $serialized) {
                    return Serializer::unserialize($serialized->getData());
                };
            } else {
                $this->serialize = function ($unserialized) {
                    return Serializer::serialize($unserialized);
                };
                $this->unserialize = function ($serialized) {
                    return Serializer::unserialize($serialized);
                };
            }
        }
    }

    /**
     * {@inheritdoc}
     */
    public function set($key, $value)
    {
        KeyUtil::validate($key);

        $serialized = $this->serialize->__invoke($value);

        try {
            $this->collection->replaceOne(
                array('_id' => $key),
                array('_id' => $key, 'value' => $serialized),
                array('upsert' => true)
            );
        } catch (UnexpectedValueException $e) {
            throw UnsupportedValueException::forType('binary', $this, 0, $e);
        } catch (Exception $e) {
            throw WriteException::forException($e);
        }
    }

    /**
     * {@inheritdoc}
     */
    public function get($key, $default = null)
    {
        KeyUtil::validate($key);

        try {
            $document = $this->collection->findOne(
                array('_id' => $key),
                array('typeMap' => self::$typeMap)
            );
        } catch (Exception $e) {
            throw ReadException::forException($e);
        }

        if (null === $document) {
            return $default;
        }

        return $this->unserialize->__invoke($document['value']);
    }

    /**
     * {@inheritdoc}
     */
    public function getOrFail($key)
    {
        KeyUtil::validate($key);

        try {
            $document = $this->collection->findOne(
                array('_id' => $key),
                array('typeMap' => self::$typeMap)
            );
        } catch (Exception $e) {
            throw ReadException::forException($e);
        }

        if (null === $document) {
            throw NoSuchKeyException::forKey($key);
        }

        return $this->unserialize->__invoke($document['value']);
    }

    /**
     * {@inheritdoc}
     */
    public function getMultiple(array $keys, $default = null)
    {
        KeyUtil::validateMultiple($keys);

        $values = array_fill_keys($keys, $default);

        try {
            $cursor = $this->collection->find(
                array('_id' => array('$in' => array_values($keys))),
                array('typeMap' => self::$typeMap)
            );

            foreach ($cursor as $document) {
                $values[$document['_id']] = $this->unserialize->__invoke($document['value']);
            }
        } catch (UnserializationFailedException $e) {
            throw $e;
        } catch (Exception $e) {
            throw ReadException::forException($e);
        }

        return $values;
    }

    /**
     * {@inheritdoc}
     */
    public function getMultipleOrFail(array $keys)
    {
        KeyUtil::validateMultiple($keys);

        $values = array();

        try {
            $cursor = $this->collection->find(
                array('_id' => array('$in' => array_values($keys))),
                array('typeMap' => self::$typeMap)
            );

            foreach ($cursor as $document) {
                $values[$document['_id']] = $this->unserialize->__invoke($document['value']);
            }
        } catch (UnserializationFailedException $e) {
            throw $e;
        } catch (Exception $e) {
            throw ReadException::forException($e);
        }

        $notFoundKeys = array_diff($keys, array_keys($values));

        if (count($notFoundKeys) > 0) {
            throw NoSuchKeyException::forKeys($notFoundKeys);
        }

        return $values;
    }

    /**
     * {@inheritdoc}
     */
    public function remove($key)
    {
        KeyUtil::validate($key);

        try {
            $result = $this->collection->deleteOne(array('_id' => $key));
            $deletedCount = $result->getDeletedCount();
        } catch (Exception $e) {
            throw WriteException::forException($e);
        }

        return $deletedCount > 0;
    }

    /**
     * {@inheritdoc}
     */
    public function exists($key)
    {
        KeyUtil::validate($key);

        try {
            $count = $this->collection->count(array('_id' => $key));
        } catch (Exception $e) {
            throw ReadException::forException($e);
        }

        return $count > 0;

    }

    /**
     * {@inheritdoc}
     */
    public function clear()
    {
        try {
            $this->collection->drop();
        } catch (Exception $e) {
            throw WriteException::forException($e);
        }
    }

    /**
     * {@inheritdoc}
     */
    public function keys()
    {
        try {
            $cursor = $this->collection->find(array(), array(
                'projection' => array('_id' => 1)
            ));

            $keys = array();

            foreach ($cursor as $document) {
                $keys[] = $document['_id'];
            }
        } catch (Exception $e) {
            throw ReadException::forException($e);
        }

        return $keys;
    }
}
Webmozart Key-Value Store API API documentation generated by ApiGen