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: 
<?php

/*
 * This file is part of the webmozart/key-value-store 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 Basho\Riak\Riak;
use Exception;
use Webmozart\KeyValueStore\Api\KeyValueStore;
use Webmozart\KeyValueStore\Api\NoSuchKeyException;
use Webmozart\KeyValueStore\Api\ReadException;
use Webmozart\KeyValueStore\Api\WriteException;
use Webmozart\KeyValueStore\Util\KeyUtil;
use Webmozart\KeyValueStore\Util\Serializer;

/**
 * A key-value store backed by a Riak client.
 *
 * @since  1.0
 *
 * @author Bernhard Schussek <bschussek@gmail.com>
 */
class RiakStore implements KeyValueStore
{
    /**
     * @var string
     */
    private $bucketName;

    /**
     * @var Riak
     */
    private $client;

    /**
     * Creates a store backed by a Riak client.
     *
     * If no client is passed, a new one is created using the default server
     * "127.0.0.1" and the default port 8098.
     *
     * @param string    $bucketName The name of the Riak bucket to use.
     * @param Riak|null $client     The client used to connect to Riak.
     */
    public function __construct($bucketName, Riak $client = null)
    {
        $this->bucketName = $bucketName;
        $this->client = $client ?: new Riak();
    }

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

        $serialized = Serializer::serialize($value);

        try {
            $this->client->bucket($this->bucketName)->newBinary($key, $serialized)->store();
        } catch (Exception $e) {
            throw WriteException::forException($e);
        }
    }

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

        try {
            $object = $this->client->bucket($this->bucketName)->getBinary($key);
            $exists = $object->exists();
        } catch (Exception $e) {
            throw ReadException::forException($e);
        }

        if (!$exists) {
            return $default;
        }

        return Serializer::unserialize($object->getData());
    }

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

        try {
            $object = $this->client->bucket($this->bucketName)->getBinary($key);
            $exists = $object->exists();
        } catch (Exception $e) {
            throw ReadException::forException($e);
        }

        if (!$exists) {
            throw NoSuchKeyException::forKey($key);
        }

        return Serializer::unserialize($object->getData());
    }

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

        $values = array();

        try {
            $bucket = $this->client->bucket($this->bucketName);

            foreach ($keys as $key) {
                $object = $bucket->getBinary($key);

                $values[$key] = $object->exists() ? $object->getData() : false;
            }
        } catch (Exception $e) {
            throw ReadException::forException($e);
        }

        foreach ($values as $key => $value) {
            $values[$key] = false === $value
                ? $default
                : Serializer::unserialize($value);
        }

        return $values;
    }

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

        $values = array();
        $notFoundKeys = array();

        try {
            $bucket = $this->client->bucket($this->bucketName);

            foreach ($keys as $key) {
                $values[$key] = $bucket->getBinary($key);

                if (!$values[$key]->exists()) {
                    $notFoundKeys[] = $key;
                }
            }
        } catch (Exception $e) {
            throw ReadException::forException($e);
        }

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

        foreach ($values as $key => $object) {
            $values[$key] = Serializer::unserialize($object->getData());
        }

        return $values;
    }

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

        try {
            $object = $this->client->bucket($this->bucketName)->get($key);

            if (!$object->exists()) {
                return false;
            }

            $object->delete();
        } catch (Exception $e) {
            throw WriteException::forException($e);
        }

        return true;
    }

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

        try {
            return $this->client->bucket($this->bucketName)->get($key)->exists();
        } catch (Exception $e) {
            throw ReadException::forException($e);
        }
    }

    /**
     * {@inheritdoc}
     */
    public function clear()
    {
        try {
            $bucket = $this->client->bucket($this->bucketName);

            foreach ($bucket->getKeys() as $key) {
                $bucket->get($key)->delete();
            }
        } catch (Exception $e) {
            throw WriteException::forException($e);
        }
    }

    /**
     * {@inheritdoc}
     */
    public function keys()
    {
        try {
            return $this->client->bucket($this->bucketName)->getKeys();
        } catch (Exception $e) {
            throw ReadException::forException($e);
        }
    }
}
Webmozart Key-Value Store API API documentation generated by ApiGen