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 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 <?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\Adapters;
use Countable;
use Iterator;
use Maslosoft\Mangan\Interfaces\SortInterface;
/**
* @author Piotr Maselkowski <pmaselkowski at gmail.com>
*/
interface FinderCursorInterface extends Iterator, Countable
{
/**
* Limit to `$num` results
*
* Note that cursor must have only limit method,
* do not use LimitableInterface etc.
*
* @param integer $num
* @return static
*/
public function limit($num);
/**
* Skip `$num` number of results
* @param int $num
* @return static
*/
public function skip($num);
/**
* Sort by fields
*
* Keys are field names, values are sort directions.
*
* Example:
* ```
* $fields = [
* 'username' => SortInterface::Asc
* ];
* ```
*
* @see SortInterface
* @param array $fields
* @return static
*/
public function sort(array $fields);
/**
* Select fields, this accepts array with field names and boolean values
* indicating whether to return those fields.
*
* Example:
* ```
* $fields = [
* 'username' => true
* ];
* ```
*
* @param array $fields
* @return static
*/
public function fields(array $fields);
}
API documentation generated by ApiGen