Request Class Reference

Inheritance diagram for Request:

Data Structures
class	MapperTest

Public Member Functions
	__construct ( $name, $indexName, QueryInterface $query, $from=null, $size=null, array $dimensions=[], array $buckets=[])
	getName ()
	getIndex ()
	getDimensions ()
	getAggregation ()
	getQuery ()
	getFrom ()
	getSize ()

Protected Attributes
	$name
	$index
	$buckets
	$query
	$from
	$size
	$dimensions

Detailed Description

Search Request

@codeCoverageIgnore @api

Since

100.0.2

Definition at line 19 of file Request.php.

Constructor & Destructor Documentation

__construct()

__construct	(		$name,
			$indexName,
		QueryInterface	$query,
			$from = null,
			$size = null,
		array	$dimensions = [],
		array	$buckets = []
	)

Parameters

string	$name
string	$indexName
QueryInterface	$query
int | null	$from
int | null	$size
	Dimension[]	$dimensions
	RequestBucketInterface[]	$buckets

Definition at line 67 of file Request.php.

      {
        $this->name = $name;
        $this->index = $indexName;
        $this->query = $query;
        $this->from = $from;
        $this->size = $size;
        $this->buckets = $buckets;
        $this->dimensions = $dimensions;
    }

Member Function Documentation

getAggregation()

getAggregation

(

)

{Get Aggregation Buckets

Returns

RequestBucketInterface[]

}

Implements RequestInterface.

Definition at line 112 of file Request.php.

    {
        return $this->buckets;
    }

getDimensions()

getDimensions

(

)

{Get all dimensions

Returns

Dimension[]

}

Implements RequestInterface.

Definition at line 104 of file Request.php.

    {
        return $this->dimensions;
    }

getFrom()

getFrom

(

)

{Get From

Returns

int|null

}

Implements RequestInterface.

Definition at line 128 of file Request.php.

    {
        return $this->from;
    }

getIndex()

getIndex

(

)

{Get Index name

Returns

string

}

Implements RequestInterface.

Definition at line 96 of file Request.php.

    {
        return $this->index;
    }

getName()

getName

(

)

{Get Name

Returns

string

}

Implements RequestInterface.

Definition at line 88 of file Request.php.

    {
        return $this->name;
    }

getQuery()

getQuery

(

)

{Get Main Request Query

Returns

QueryInterface

}

Implements RequestInterface.

Definition at line 120 of file Request.php.

    {
        return $this->query;
    }

getSize()

getSize

(

)

{Get Size

Returns

int|null

}

Implements RequestInterface.

Definition at line 136 of file Request.php.

    {
        return $this->size;
    }

Field Documentation

$buckets

$buckets

protected

Definition at line 34 of file Request.php.

$dimensions

$dimensions

protected

Definition at line 56 of file Request.php.

$from

$from

protected

Definition at line 46 of file Request.php.

$index

$index

protected

Definition at line 29 of file Request.php.

$name

$name

protected

Definition at line 24 of file Request.php.

$query

$query

protected

Definition at line 41 of file Request.php.

$size

$size

protected

Definition at line 51 of file Request.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/framework/Search/Request.php