File Riak/Command/Builder/UpdateMap.php | Official Riak Client for PHP

  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

<?php

namespace Basho\Riak\Command\Builder;

use Basho\Riak;
use Basho\Riak\Command;

/**
 * @author Christopher Mancini <cmancini at basho d0t com>
 */
class UpdateMap extends Command\Builder implements Command\BuilderInterface
{
    use LocationTrait;

    protected $remove = [];

    /**
     * @var array
     */
    protected $registers = [];

    /**
     * @var array
     */
    protected $flags = [];

    /**
     * @var IncrementCounter[]
     */
    protected $counters = [];

    /**
     * @var UpdateSet[]
     */
    protected $sets = [];

    /**
     * @var UpdateMap[]
     */
    protected $maps = [];

    /**
     * Similar to Vector Clocks, the context allows us to determine the state of a CRDT Set
     *
     * @var string
     */
    protected $context = '';

    public function removeRegister($key)
    {
        $this->remove($key, Riak\DataType\Map::REGISTER);

        return $this;
    }

    protected function remove($key, $type)
    {
        $this->remove[] = sprintf('%s_%s', $key, $type);
    }

    public function removeFlag($key)
    {
        $this->remove($key, Riak\DataType\Map::FLAG);

        return $this;
    }

    public function removeCounter($key)
    {
        $this->remove($key, Riak\DataType\Counter::TYPE);

        return $this;
    }

    public function removeSet($key)
    {
        $this->remove($key, Riak\DataType\Set::TYPE);

        return $this;
    }

    public function removeMap($key)
    {
        $this->remove($key, Riak\DataType\Map::TYPE);

        return $this;
    }

    /**
     * @param $key
     * @param $value
     *
     * @return $this
     */
    public function updateRegister($key, $value)
    {
        $this->update($key, Riak\DataType\Map::REGISTER, $value);

        return $this;
    }

    protected function update($key, $type, $value)
    {
        $property = "{$type}s";
        $this->{$property}[sprintf('%s_%s', $key, $type)] = $value;
    }

    /**
     * @param $key
     * @param bool $state
     *
     * @return $this
     */
    public function updateFlag($key, $state = TRUE)
    {
        $this->update($key, Riak\DataType\Map::FLAG, $state);

        return $this;
    }

    /**
     * @param $key
     * @param IncrementCounter $builder
     *
     * @return $this
     */
    public function updateCounter($key, IncrementCounter $builder)
    {
        $this->update($key, Riak\DataType\Counter::TYPE, $builder);

        return $this;
    }

    /**
     * @param $key
     * @param UpdateSet $builder
     *
     * @return $this
     */
    public function updateSet($key, UpdateSet $builder)
    {
        $this->update($key, Riak\DataType\Set::TYPE, $builder);

        return $this;
    }

    /**
     * @param $key
     * @param UpdateMap $builder
     *
     * @return $this
     */
    public function updateMap($key, UpdateMap $builder)
    {
        $this->update($key, Riak\DataType\Map::TYPE, $builder);

        return $this;
    }

    /**
     * @param $context
     *
     * @return $this
     */
    public function withContext($context)
    {
        $this->context = $context;

        return $this;
    }

    /**
     * {@inheritdoc}
     *
     * @return Command\DataType\Map\Store
     */
    public function build()
    {
        $this->validate();

        return new Command\DataType\Map\Store($this);
    }

    /**
     * {@inheritdoc}
     */
    public function validate()
    {
        $this->required('Bucket');

        $count_remove = count($this->remove);
        $count_registers = count($this->registers);
        $count_flags = count($this->flags);
        $count_counters = count($this->counters);
        $count_sets = count($this->sets);
        $count_maps = count($this->maps);

        if ($count_remove + $count_registers + $count_flags + $count_counters + $count_sets + $count_maps < 1) {
            throw new Exception('At least one add, remove, or update operation needs to be defined.');
        }

        if ($count_remove) {
            $this->required('Location');
            $this->required('Context');
        }

        // if we are performing a remove on a nested set, Location and context are required
        if ($count_sets) {
            foreach ($this->sets as $set) {
                if (count($set->getRemoveAll())) {
                    $this->required('Location');
                    $this->required('Context');
                    break;
                }
            }
        }


        // if we are performing a remove, Location and context are required
        if ($count_remove) {
            $this->required('Location');
            $this->required('Context');
        }
    }

    public function getRemove()
    {
        return $this->remove;
    }

    /**
     * @return array
     */
    public function getRegisters()
    {
        return $this->registers;
    }

    /**
     * @return array
     */
    public function getFlags()
    {
        return $this->flags;
    }

    /**
     * @return IncrementCounter[]
     */
    public function getCounters()
    {
        return $this->counters;
    }

    /**
     * @return UpdateSet[]
     */
    public function getSets()
    {
        return $this->sets;
    }

    /**
     * @return UpdateMap[]
     */
    public function getMaps()
    {
        return $this->maps;
    }

    /**
     * getContext
     *
     * @return string
     */
    public function getContext()
    {
        return $this->context;
    }
}

Namespaces

Classes

Interfaces

Traits

Exceptions