Maslosoft Mangan API

Name: Mangan
Brand: Maslosoft

Class Criteria

Criteria

This class is a helper for building MongoDB query arrays, it support three syntaxes for adding conditions:

'equals' syntax: $criteriaObject->fieldName = $value; // this will produce fieldName == value query
fieldName call syntax $criteriaObject->fieldName($operator, $value); // this will produce fieldName value
addCond method $criteriaObject->addCond($fieldName, $operator, $vale); // this will produce fieldName value

For operators list Criteria::$operators

Maslosoft\Mangan\Criteria implements Maslosoft\Mangan\Interfaces\CriteriaInterface, Maslosoft\Mangan\Interfaces\ModelAwareInterface uses Maslosoft\Mangan\Traits\Criteria\CursorAwareTrait, Maslosoft\Mangan\Traits\Criteria\DecoratableTrait, Maslosoft\Mangan\Traits\Criteria\LimitableTrait, Maslosoft\Mangan\Traits\ModelAwareTrait, Maslosoft\Mangan\Traits\Criteria\SelectableTrait, Maslosoft\Mangan\Traits\Criteria\SortableTrait

Namespace: Maslosoft\Mangan
Author: Ianaré Sévi
Author: Dariusz Górecki darek.krk@gmail.com
Author: Invenzzia Group, open-source division of CleverIT company http://www.invenzzia.org
Copyright: 2011 CleverIT http://www.cleverit.com.pl
License: BSD license
Located at Criteria.php

Methods summary

`public`	# `__construct( mixed\|Maslosoft\Mangan\Interfaces\CriteriaInterface\|Maslosoft\Mangan\Criteria\Conditions $criteria = null, Maslosoft\Addendum\Interfaces\AnnotatedInterface $model = null )` Constructor Example criteria: Constructor Example criteria: 'criteria' = array( 'conditions'=>array( 'fieldName1'=>array('greater' => 0), 'fieldName2'=>array('>=' => 10), 'fieldName3'=>array('<' => 10), 'fieldName4'=>array('lessEq' => 10), 'fieldName5'=>array('notEq' => 10), 'fieldName6'=>array('in' => array(10, 9)), 'fieldName7'=>array('notIn' => array(10, 9)), 'fieldName8'=>array('all' => array(10, 9)), 'fieldName9'=>array('size' => 10), 'fieldName10'=>array('exists'), 'fieldName11'=>array('notExists'), 'fieldName12'=>array('mod' => array(10, 9)), 'fieldName13'=>array('==' => 1) ), 'select'=>array('fieldName', 'fieldName2'), 'limit'=>10, 'offset'=>20, 'sort'=>array('fieldName1'=>Criteria::SortAsc, 'fieldName2'=>Criteria::SortDesc), ); Parameters `$criteria` `$model` to use for criteria decoration Since v1.0
`public Maslosoft\Mangan\Interfaces\CriteriaInterface`	# `mergeWith( null\|array\|Maslosoft\Mangan\Interfaces\CriteriaInterface $criteria )` Merge with other criteria - Field list operators will be merged - Limit and offet will be overriden - Select fields list will be merged - Sort fields list will be merged Merge with other criteria - Field list operators will be merged - Limit and offet will be overriden - Select fields list will be merged - Sort fields list will be merged Parameters `$criteria` Returns `Maslosoft\Mangan\Interfaces\CriteriaInterface` Since v1.0 Implementation of `Maslosoft\Mangan\Interfaces\Criteria\MergeableInterface::mergeWith()`
`public`	# `__call( $fieldName, $parameters )` If we have operator add it otherwise call parent implementation If we have operator add it otherwise call parent implementation Since v1.0
`public`	# `__get( $name )` Since v1.0.2
`public`	# `__set( $name, $value )` Since v1.0.2
`public array`	# `getConditions( )` Return query array Return query array Returns array query array Since v1.0
`public Maslosoft\Mangan\Criteria`	# `setConditions( array\|Maslosoft\Mangan\Criteria\Conditions $conditions )` Set conditions Set conditions Parameters `$conditions` Returns `Maslosoft\Mangan\Criteria`
`public`	# `addCond( string $fieldName, string $op, mixed $value )` Add condition If specified field already has a condition, values will be merged duplicates will be overriden by new values! Add condition If specified field already has a condition, values will be merged duplicates will be overriden by new values! NOTE: Should NOT be part of interface Parameters `$fieldName` `$op` operator `$value` Since v1.0

Methods inherited from Maslosoft\Mangan\Interfaces\Criteria\DecoratableInterface

decorateWith()

Methods inherited from Maslosoft\Mangan\Interfaces\Criteria\CursorAwareInterface

getUseCursor(), setUseCursor()

Methods inherited from Maslosoft\Mangan\Interfaces\ModelAwareInterface

getModel(), setModel()

Methods used from Maslosoft\Mangan\Traits\Criteria\CursorAwareTrait

getUseCursor(), setUseCursor()

Methods used from Maslosoft\Mangan\Traits\Criteria\DecoratableTrait

decorateWith(), getCd(), setCd()

Methods used from Maslosoft\Mangan\Traits\Criteria\LimitableTrait

getLimit(), getOffset(), limit(), offset(), setLimit(), setOffset()

Methods used from Maslosoft\Mangan\Traits\ModelAwareTrait

getModel(), setModel()

Methods used from Maslosoft\Mangan\Traits\Criteria\SelectableTrait

getSelect(), select(), setSelect()

Methods used from Maslosoft\Mangan\Traits\Criteria\SortableTrait

getSort(), setSort(), sort()

Constants summary

`string`	`SortAsc` Sort Ascending Sort Ascending	# `Maslosoft\Mangan\SortInterface::SortAsc`
`string`	`SortDesc` Sort Descending Sort Descending	# `Maslosoft\Mangan\SortInterface::SortDesc`
`string`	`SORT_ASC` Sort Ascending Sort Ascending Deprecated since version 4.0.7	# `Maslosoft\Mangan\SortInterface::SortAsc`
`string`	`SORT_DESC` Sort Descending Sort Descending Deprecated since version 4.0.7	# `Maslosoft\Mangan\SortInterface::SortDesc`

Properties summary

`public static array`	`$operators` $operators supported operators lists $operators supported operators lists Since v1.0	# [ // Comparison // Matches values that are equal to a specified value. 'eq' => '$eq', 'equals' => '$eq', '==' => '$eq', // Matches values that are greater than a specified value. 'gt' => '$gt', 'greater' => '$gt', '>' => '$gt', // Matches values that are greater than or equal to a specified value. 'gte' => '$gte', 'greatereq' => '$gte', '>=' => '$gte', // Matches values that are less than a specified value. 'lt' => '$lt', 'less' => '$lt', '<' => '$lt', // Matches values that are less than or equal to a specified value. 'lte' => '$lte', 'lesseq' => '$lte', '<=' => '$lte', // Matches all values that are not equal to a specified value. 'ne' => '$ne', 'noteq' => '$ne', '!=' => '$ne', '<>' => '$ne', // Matches any of the values specified in an array. 'in' => '$in', // Matches none of the values specified in an array. 'notin' => '$nin', // Logical // Joins query clauses with a logical OR returns all documents that match the conditions of either clause. 'or' => '$or', // Joins query clauses with a logical AND returns all documents that match the conditions of both clauses. 'and' => '$and', // Inverts the effect of a query expression and returns documents that do not match the query expression. 'not' => '$not', // Joins query clauses with a logical NOR returns all documents that fail to match both clauses. 'nor' => '$nor', // Element // Matches documents that have the specified field. 'exists' => '$exists', 'notexists' => '$exists', // Selects documents if a field is of the specified type. 'type' => '$type', // Evaluation // Performs a modulo operation on the value of a field and selects documents with a specified result. 'mod' => '$mod', '%' => '$mod', // Selects documents where values match a specified regular expression. 'regex' => '$regex', // Performs text search. 'text' => '$text', // Matches documents that satisfy a JavaScript expression. 'where' => '$where', // Geospatial // Selects geometries within a bounding GeoJSON geometry. The `2dsphere` and `2d` indexes support $geoWithin. 'geoWithin' => '$geoWithin', // Selects geometries that intersect with a GeoJSON geometry. The `2dsphere` index supports $geoIntersects. 'geoIntersects' => '$geoIntersects', // Returns geospatial objects in proximity to a point. Requires a geospatial index. The `2dsphere` and `2d` indexes support $near. 'near' => '$near', // Returns geospatial objects in proximity to a point on a sphere. Requires a geospatial index. The `2dsphere` and `2d` indexes support $nearSphere. 'nearSphere' => '$nearSphere', // Array // Matches arrays that contain all elements specified in the query. 'all' => '$all', // Selects documents if element in the array field matches all the specified $elemMatch conditions. 'elemmatch' => '$elemMatch', // Selects documents if the array field is a specified size. 'size' => '$size', // Comments 'comment' => '$comment' ]

Properties used from Maslosoft\Mangan\Traits\ModelAwareTrait

$model

API documentation generated by ApiGen

Maslosoft Mangan API

Namespaces

Classes

Class Criteria

Methods summary

Parameters

Since

Parameters

Returns

Since

Implementation of

Since

Since

Since

Returns

Since

Parameters

Returns

Parameters

Since

Methods inherited from Maslosoft\Mangan\Interfaces\Criteria\SortableInterface

Methods inherited from Maslosoft\Mangan\Interfaces\Criteria\SelectableInterface

Methods inherited from Maslosoft\Mangan\Interfaces\Criteria\LimitableInterface

Methods inherited from Maslosoft\Mangan\Interfaces\Criteria\DecoratableInterface

Methods inherited from Maslosoft\Mangan\Interfaces\Criteria\CursorAwareInterface

Methods inherited from Maslosoft\Mangan\Interfaces\ModelAwareInterface

Methods used from Maslosoft\Mangan\Traits\Criteria\CursorAwareTrait

Methods used from Maslosoft\Mangan\Traits\Criteria\DecoratableTrait

Methods used from Maslosoft\Mangan\Traits\Criteria\LimitableTrait

Methods used from Maslosoft\Mangan\Traits\ModelAwareTrait

Methods used from Maslosoft\Mangan\Traits\Criteria\SelectableTrait

Methods used from Maslosoft\Mangan\Traits\Criteria\SortableTrait

Constants summary

Deprecated

Deprecated

Properties summary

Since

Properties used from Maslosoft\Mangan\Traits\ModelAwareTrait

Contact us