Maslosoft Mangan API
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 <?php
/**
* This software package is licensed under AGPL or Commercial license.
*
* @package maslosoft/mangan
* @licence AGPL or Commercial
* @copyright Copyright (c) Piotr Masełkowski <pmaselkowski@gmail.com>
* @copyright Copyright (c) Maslosoft
* @copyright Copyright (c) Others as mentioned in code
* @link https://maslosoft.com/mangan/
*/
namespace Maslosoft\Mangan\Interfaces;
/**
* Use this interface to associate Criteria with model. This could be used
* together with DataProvider, or finders with custom methods setting criteria.
*
* Example usage. Define `published` method:
* ```
* public function published()
* {
* $this->getDbCriteria()->published = true;
* return $this;
* }
* ```
*
* Then this could be used with dataprovider:
* ```
* new DataProvider((new Page)->published());
* ```
*
* NOTE: It is recommended to use CriteriaAwareInterface
*
* @see CriteriaInterface
* @author Piotr Maselkowski <pmaselkowski at gmail.com>
*/
interface WithCriteriaInterface
{
/**
* Returns the mongo criteria associated with this model.
* @param boolean $createIfNull whether to create a criteria instance if it does not exist. Defaults to true.
* @return CriteriaInterface the query criteria that is associated with this model.
* This criteria is mainly used by {@link scopes named scope} feature to accumulate
* different criteria specifications.
* @since v1.0
*/
public function getDbCriteria($createIfNull = true);
/**
* Set current object, this will override previous criteria
*
* @param CriteriaInterface|array $criteria
* @since v1.0
*/
public function setDbCriteria($criteria);
}
API documentation generated by ApiGen