PHP Класс Craft\Neo_CriteriaModel

Наследование: extends craft\ElementCriteriaModel
Показать файл Открыть проект

Защищенные свойства (Protected)

Свойство Тип Описание
$filterOrder array This is important as changing the order can affect the results of certain filters, such as limit and offset. It also allows increased performance by allowing filters with high filtering potential to be run earlier.

Открытые методы

Метод Описание
__construct ( array | null $attributes = null ) Initialises the criteria model, forcing the element type to be a Neo block.
copy ( ) : Neo_CriteriaModel Returns a clone of the criteria model.
count ( ) : integer Returns the total number of elements matched by this criteria.
setAllElements ( array $elements ) Sets all the elements (blocks) to be filtered against in Live Preview mode.
setAttribute ( string $name, mixed $value ) : boolean Sets a filter value for the criteria model, then reruns Live Preview filtering.

Защищенные методы

Метод Описание
__ancestorDist ( array $elements, integer $value ) : array
__ancestorOf ( array $elements, Neo_BlockModel $value ) : array
__collapsed ( array $elements, Neo_BlockModel $value ) : array
__descendantDist ( array $elements, integer $value ) : array
__descendantOf ( array $elements, Neo_BlockModel $value ) : array
__fieldId ( array $elements, integer $value ) : array
__id ( array $elements, integer $value ) : array
__level ( array $elements, integer $value ) : array
__limit ( array $elements, integer $value ) : array
__nextSiblingOf ( array $elements, int\Neo_BlockModel $value ) : array
__offset ( array $elements, integer $value ) : array
__positionedAfter ( array $elements, int\Neo_BlockModel $value ) : array
__positionedBefore ( array $elements, int\Neo_BlockModel $value ) : array
__prevSiblingOf ( array $elements, int\Neo_BlockModel $value ) : array
__relatedTo ( array $elements, $value ) : array
__search ( array $elements, $value ) : array
__siblingOf ( array $elements, int\Neo_BlockModel $value ) : array
__status ( array $elements, Neo_BlockModel $value ) : array
__type ( array $elements, string $value ) : array
__typeId ( array $elements, integer $value ) : array
getState ( ) : array Returns all saved, private settings for the criteria model, to be used when copying.
setState ( array\Neo_CriteriaModel $state ) Sets all saved, private settings to the criteria model, to be used when copying.

Приватные методы

Метод Описание
_compareInt ( integer $value, string\int $comparison ) : boolean Compares an integer against a criteria model integer comparison string, or integer.
_getBlock ( int\Neo_BlockModel $block ) : bool\Neo_BlockModel Returns a block model given an ID, or an actual block model.
_indexOfBlock ( array $elements, Neo_BlockModel $block ) : integer Finds the position of a block inside a list of blocks.
_indexOfRootBlock ( array $elements, Neo_BlockModel $block ) : integer Finds the position of the block who is it's furthest ancestor to the passed block.
_runCriteria ( ) Runs Live Preview filtering and saves it's output to the criteria model.

Описание методов

__ancestorDist() защищенный Метод

protected __ancestorDist ( array $elements, integer $value ) : array
$elements array
$value integer
Результат array

__ancestorOf() защищенный Метод

protected __ancestorOf ( array $elements, Neo_BlockModel $value ) : array
$elements array
$value Neo_BlockModel
Результат array

__collapsed() защищенный Метод

protected __collapsed ( array $elements, Neo_BlockModel $value ) : array
$elements array
$value Neo_BlockModel
Результат array

__construct() публичный Метод

Initialises the criteria model, forcing the element type to be a Neo block.
public __construct ( array | null $attributes = null )
$attributes array | null

__descendantDist() защищенный Метод

protected __descendantDist ( array $elements, integer $value ) : array
$elements array
$value integer
Результат array

__descendantOf() защищенный Метод

protected __descendantOf ( array $elements, Neo_BlockModel $value ) : array
$elements array
$value Neo_BlockModel
Результат array

__fieldId() защищенный Метод

protected __fieldId ( array $elements, integer $value ) : array
$elements array
$value integer
Результат array

__id() защищенный Метод

protected __id ( array $elements, integer $value ) : array
$elements array
$value integer
Результат array

__level() защищенный Метод

protected __level ( array $elements, integer $value ) : array
$elements array
$value integer
Результат array

__limit() защищенный Метод

protected __limit ( array $elements, integer $value ) : array
$elements array
$value integer
Результат array

__nextSiblingOf() защищенный Метод

protected __nextSiblingOf ( array $elements, int\Neo_BlockModel $value ) : array
$elements array
$value int\Neo_BlockModel
Результат array

__offset() защищенный Метод

protected __offset ( array $elements, integer $value ) : array
$elements array
$value integer
Результат array

__positionedAfter() защищенный Метод

protected __positionedAfter ( array $elements, int\Neo_BlockModel $value ) : array
$elements array
$value int\Neo_BlockModel
Результат array

__positionedBefore() защищенный Метод

protected __positionedBefore ( array $elements, int\Neo_BlockModel $value ) : array
$elements array
$value int\Neo_BlockModel
Результат array

__prevSiblingOf() защищенный Метод

protected __prevSiblingOf ( array $elements, int\Neo_BlockModel $value ) : array
$elements array
$value int\Neo_BlockModel
Результат array

__relatedTo() защищенный Метод

protected __relatedTo ( array $elements, $value ) : array
$elements array
$value
Результат array

__search() защищенный Метод

protected __search ( array $elements, $value ) : array
$elements array
$value
Результат array

__siblingOf() защищенный Метод

protected __siblingOf ( array $elements, int\Neo_BlockModel $value ) : array
$elements array
$value int\Neo_BlockModel
Результат array

__status() защищенный Метод

protected __status ( array $elements, Neo_BlockModel $value ) : array
$elements array
$value Neo_BlockModel
Результат array

__type() защищенный Метод

protected __type ( array $elements, string $value ) : array
$elements array
$value string
Результат array

__typeId() защищенный Метод

protected __typeId ( array $elements, integer $value ) : array
$elements array
$value integer
Результат array

copy() публичный Метод

Returns a clone of the criteria model.
public copy ( ) : Neo_CriteriaModel
Результат Neo_CriteriaModel

count() публичный Метод

Fixes live preview mode which broke in Craft 2.6.2793 due to this method. If live preview mode is detected, it uses the old method which worked in live preview mode.
public count ( ) : integer
Результат integer

getState() защищенный Метод

Returns all saved, private settings for the criteria model, to be used when copying.
protected getState ( ) : array
Результат array

setAllElements() публичный Метод

This becomes the main data source for Live Preview, instead of the database.
public setAllElements ( array $elements )
$elements array

setAttribute() публичный Метод

Sets a filter value for the criteria model, then reruns Live Preview filtering.
public setAttribute ( string $name, mixed $value ) : boolean
$name string
$value mixed
Результат boolean

setState() защищенный Метод

Sets all saved, private settings to the criteria model, to be used when copying.
protected setState ( array\Neo_CriteriaModel $state )
$state array\Neo_CriteriaModel

Описание свойств

$filterOrder защищенное свойство

This is important as changing the order can affect the results of certain filters, such as limit and offset. It also allows increased performance by allowing filters with high filtering potential to be run earlier.
protected array $filterOrder
Результат array