Inheritance diagram for AbstractCriteria:

Public Member Functions
	getMapperInterfaceName ()

	addField ($field, $alias=null)

	addFilter ($name, $field, $condition=null, $type='and')

	addOrder ($field, $direction=self::SORT_ORDER_DESC, $unShift=false)

	setLimit ($offset, $size)

	removeField ($field, $isAlias=false)

	removeAllFields ()

	removeFilter ($name)

	removeAllFilters ()

	getCriteriaList ()

	getFilters ()

	getOrders ()

	getLimit ()

	getPart ($name, $default=null)

	toArray ()

	reset ()

Protected Attributes
	$data

	$mapperInterfaceName

Additional Inherited Members
Data Fields inherited from CriteriaInterface
const	PART_FIELDS = 'fields'

const	PART_FILTERS = 'filters'

const	PART_ORDERS = 'orders'

const	PART_CRITERIA_LIST = 'criteria_list'

const	PART_LIMIT = 'limit'

const	SORT_ORDER_ASC = 'ASC'

const	SORT_ORDER_DESC = 'DESC'

Detailed Description

Class AbstractCriteria

Definition at line 13 of file AbstractCriteria.php.

Member Function Documentation

◆ addField()

addField	(	$field,
		$alias = `null`
	)

Add field to select

Parameters

string \| array	$field
string \| null	$alias

Returns: void

Implements CriteriaInterface.

Definition at line 56 of file AbstractCriteria.php.

     {
         if ($field === '*') {
             $this->data[self::PART_FIELDS]['list'] = [$field];
         } else {
             if (is_array($field)) {
                 foreach ($field as $key => $value) {
                     $this->addField($value, is_string($key) ? $key : null);
                 }
             } else {
                 if ($alias === null) {
                     $this->data[self::PART_FIELDS]['list'][$field] = $field;
                 } else {
                     $this->data[self::PART_FIELDS]['list'][$alias] = $field;
                 }
             }
         }
     }

◆ addFilter()

addFilter	(	$name,
		$field,
		$condition = `null`,
		$type = `'and'`
	)

Add field filter to collection

If $condition integer or string - exact value will be filtered ('eq' condition)

If $condition is array - one of the following structures is expected:


["from" => $fromValue, "to" => $toValue]
["eq" => $equalValue]
["neq" => $notEqualValue]
["like" => $likeValue]
["in" => [$inValues]]
["nin" => [$notInValues]]
["notnull" => $valueIsNotNull]
["null" => $valueIsNull]
["moreq" => $moreOrEqualValue]
["gt" => $greaterValue]
["lt" => $lessValue]
["gteq" => $greaterOrEqualValue]
["lteq" => $lessOrEqualValue]
["finset" => $valueInSet]

If non matched - sequential parallel arrays are expected and OR conditions
will be built using above mentioned structure.

Example:
$field = ['age', 'name'];
$condition = [42, ['like' => 'Mage']];
$type = 'or';
 The above would find where age equal to 42 OR name like Mage%.

Parameters

  
    string $name 
    string | array $field 
    string | int | array $condition 
    string $type 
  
  

Exceptions

Implements CriteriaInterface.

Definition at line 116 of file AbstractCriteria.php.

     {
         if (isset($this->data[self::PART_FILTERS]['list'][$name])) {
             throw new \Exception(
                 (string)new \Magento\Framework\Phrase(
                     'Filter already exists in Criteria object: %1',
                     [$name]
                 )
             );
         }
         $filter = new DataObject();
         // implements ArrayAccess
         $filter['name'] = $name;
         $filter['field'] = $field;
         $filter['condition'] = $condition;
         $filter['type'] = strtolower($type);
         $this->data[self::PART_FILTERS]['list'][$name] = $filter;
     }

◆ addOrder()

addOrder	(	$field,
		$direction = `self::SORT_ORDER_DESC`,
		$unShift = `false`
	)

self::setOrder() alias

Parameters

string	$field
string	$direction
bool	$unShift

Returns: void

Implements CriteriaInterface.

Definition at line 143 of file AbstractCriteria.php.

     {
         $direction = strtoupper($direction) == self::SORT_ORDER_ASC ? self::SORT_ORDER_ASC : self::SORT_ORDER_DESC;
         unset($this->data[self::PART_ORDERS]['list'][$field]);
         // avoid ordering by the same field twice
         if ($unShift) {
             $orders = [$field => $direction];
             foreach ($this->data[self::PART_ORDERS]['list'] as $key => $dir) {
                 $orders[$key] = $dir;
             }
             $this->data[self::PART_ORDERS]['list'] = $orders;
         } else {
             $this->data[self::PART_ORDERS]['list'][$field] = $direction;
         }
     }

◆ getCriteriaList()

getCriteriaList ( )

Get Criteria objects added to current Composite Criteria

Returns: array

Implements CriteriaInterface.

Definition at line 232 of file AbstractCriteria.php.

     {
         return $this->data[self::PART_CRITERIA_LIST]['list'];
     }

◆ getFilters()

getFilters ( )

Get list of filters

Returns: array

Implements CriteriaInterface.

Definition at line 242 of file AbstractCriteria.php.

     {
         return $this->data[self::PART_FILTERS]['list'];
     }

◆ getLimit()

getLimit ( )

Get limit (['offset', 'page'])

Returns: array

Implements CriteriaInterface.

Definition at line 263 of file AbstractCriteria.php.

     {
         return $this->data[self::PART_LIMIT];
     }

◆ getMapperInterfaceName()

getMapperInterfaceName ( )

Get associated Mapper Interface name

Exceptions

Implements CriteriaInterface.

Definition at line 36 of file AbstractCriteria.php.

     {
         if (!$this->mapperInterfaceName) {
             throw new \Exception(
                 (string)new \Magento\Framework\Phrase(
                     'Missed Mapper Interface for Criteria Interface: %1',
                     [get_class($this)]
                 )
             );
         }
         return $this->mapperInterfaceName;
     }

◆ getOrders()

getOrders ( )

Get ordering criteria

Returns: array

Implements CriteriaInterface.

Definition at line 252 of file AbstractCriteria.php.

     {
         return $this->data[self::PART_ORDERS]['list'];
     }

◆ getPart()

getPart	(	$name,
		$default = `null`
	)

Retrieve criteria part

Parameters

string	$name
mixed	$default

Returns: mixed

Implements CriteriaInterface.

Definition at line 275 of file AbstractCriteria.php.

     {
         return $this->data[$name] ?? $default;
     }

◆ removeAllFields()

removeAllFields ( )

Removes all fields from select

Returns: void

Implements CriteriaInterface.

Definition at line 199 of file AbstractCriteria.php.

     {
         $this->data[self::PART_FIELDS]['list'] = [];
     }

◆ removeAllFilters()

removeAllFilters ( )

Removes all filters

Returns: void

Implements CriteriaInterface.

Definition at line 222 of file AbstractCriteria.php.

     {
         $this->data[self::PART_FILTERS]['list'] = [];
     }

◆ removeField()

removeField	(	$field,
		$isAlias = `false`
	)

Removes field from select

Parameters

string \| null	$field
bool	$isAlias	Alias identifier

Returns: void

Implements CriteriaInterface.

Definition at line 178 of file AbstractCriteria.php.

     {
         if ($isAlias) {
             if (isset($this->data[self::PART_FIELDS]['list'][$field])) {
                 unset($this->data[self::PART_FIELDS]['list'][$field]);
             }
         } else {
             foreach ($this->data[self::PART_FIELDS]['list'] as $key => $value) {
                 if ($value === $field) {
                     unset($this->data[self::PART_FIELDS]['list'][$key]);
                     break;
                 }
             }
         }
     }

◆ removeFilter()

removeFilter ( $name )

Removes filter by name

Parameters

string $name

Returns: void

Implements CriteriaInterface.

Definition at line 210 of file AbstractCriteria.php.

     {
         if (isset($this->data[self::PART_FILTERS]['list'][$name])) {
             unset($this->data[self::PART_FILTERS]['list'][$name]);
         }
     }

◆ reset()

reset ( )

Reset criteria

Returns: void

Implements CriteriaInterface.

Definition at line 295 of file AbstractCriteria.php.

     {
         $this->data = [
             self::PART_FIELDS => ['list' => []],
             self::PART_FILTERS => ['list' => []],
             self::PART_ORDERS => ['list' => []],
             self::PART_CRITERIA_LIST => ['list' => []],
         ];
     }

◆ setLimit()

setLimit	(	$offset,
		$size
	)

Set Query limit

Parameters

int	$offset
int	$size

Returns: void

Implements CriteriaInterface.

Definition at line 166 of file AbstractCriteria.php.

     {
         $this->data[self::PART_LIMIT] = [$offset, $size];
     }

◆ toArray()

toArray ( )

Return all criteria parts as array

Returns: array

Implements CriteriaInterface.

Definition at line 285 of file AbstractCriteria.php.

     {
         return $this->data;
     }

Field Documentation

◆ $data

$data

protected

Initial value:

= [
        self::PART_FIELDS => ['list' => []],
        self::PART_FILTERS => ['list' => []],
        self::PART_ORDERS => ['list' => []],
        self::PART_CRITERIA_LIST => ['list' => []],
    ]

Definition at line 18 of file AbstractCriteria.php.

◆ $mapperInterfaceName

$mapperInterfaceName

protected

Definition at line 28 of file AbstractCriteria.php.

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

vendor/magento/framework/Data/AbstractCriteria.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addField()

◆ addFilter()

◆ addOrder()

◆ getCriteriaList()

◆ getFilters()

◆ getLimit()

◆ getMapperInterfaceName()

◆ getOrders()

◆ getPart()

◆ removeAllFields()

◆ removeAllFilters()

◆ removeField()

◆ removeFilter()

◆ reset()

◆ setLimit()

◆ toArray()

Field Documentation

◆ $data

◆ $mapperInterfaceName