Official Riak Client for PHP
  • Namespace
  • Class
  • Tree

Namespaces

  • Basho
    • Riak
      • Api
        • Http
          • Translator
      • Command
        • Bucket
        • Builder
          • MapReduce
          • Search
          • TimeSeries
        • DataType
          • Counter
          • Map
          • Set
        • Indexes
        • MapReduce
        • Object
        • Search
          • Index
          • Schema
        • Stats
        • TimeSeries
          • Query
      • DataType
      • Node
        • Builder
      • Search
      • TimeSeries

Classes

  • AssociateIndex
  • DeleteIndex
  • DissociateIndex
  • FetchIndex
  • FetchObjects
  • FetchSchema
  • StoreIndex
  • StoreSchema

Class FetchObjects

Builds the command to fetch a collection of objects from Riak using Yokozuna search

Basho\Riak\Command\Builder
Extended by Basho\Riak\Command\Builder\Search\FetchObjects implements Basho\Riak\Command\BuilderInterface
Namespace: Basho\Riak\Command\Builder\Search
Author: Christopher Mancini
Located at Riak/Command/Builder/Search/FetchObjects.php

Methods summary

public
# __construct( Basho\Riak $riak )

Overrides

Basho\Riak\Command\Builder::__construct
public Basho\Riak\Command\Search\Fetch;
# build( )

Command build

Command build

Returns

Basho\Riak\Command\Search\Fetch;

Implementation of

Basho\Riak\Command\BuilderInterface::build()
public boolean
# validate( )

Validate command

Validate command

Returns

boolean

Throws

Builder\Exception

Overrides

Basho\Riak\Command\Builder::validate
public
# withIndexName( $name )
public
# getIndexName( )
public string
# getQuery( )

Returns

string
public integer
# getMaxRows( )

Returns

integer
public integer
# getStartRow( )

Returns

integer
public string
# getFilterQuery( )

Returns

string
public string
# getSortField( )

Returns

string
public string
# getDefaultField( )

Returns

string
public string
# getDefaultOperation( )

Returns

string
public string
# getReturnFields( )

Returns

string
public
# withQuery( $query )
public
# withMaxRows( $rows )
public
# withStartRow( $row_num )
public
# withSortField( $field_name )
public
# withFilterQuery( $filter_query )
public
# withDefaultField( $default_field )
public
# withDefaultOperation( $default_operation )
public
# withReturnFields( $return_fields )

Methods inherited from Basho\Riak\Command\Builder

getConnection(), getParameters(), getVerbose(), required(), withParameter(), withParameters(), withVerboseMode()

Constants summary

Constants inherited from Basho\Riak\Command\BuilderInterface

COMMAND

Properties summary

protected string $default_field
# ''
protected string $default_operation
# ''
protected string $index_name
# ''

Properties inherited from Basho\Riak\Command\Builder

$headers, $parameters, $riak, $verbose

Official Riak Client for PHP API documentation generated by ApiGen