File Riak/Command/Builder/QueryIndex.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

<?php

namespace Basho\Riak\Command\Builder;

use Basho\Riak\Command;

/**
 * Used to query a secondary index in Riak.
 *
 * <code>
 * $command = (new Command\Builder\QueryIndex($riak))
 *   ->buildBucket('users')
 *   ->withIndex('users_name', 'Knuth')
 *   ->build();
 *
 * $response = $command->execute($command);
 *
 * $index_results = $response->getIndexResults();
 * </code>
 *
 * @author Alex Moore <amoore at basho d0t com>
 */
class QueryIndex extends Command\Builder implements Command\BuilderInterface
{
    use BucketTrait;
    use IndexTrait;

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

        return new Command\Indexes\Query($this);
    }

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

        if($this->isMatchQuery()) {
            $this->required('MatchValue');
        }
        else {
            $this->required('LowerBound');
            $this->required('UpperBound');
        }
    }
}

Namespaces

Classes

Interfaces

Traits

Exceptions