PKP\Services\Interfaces\EntityReadInterface Interface Reference

Public Member Functions
	get ($id)
	getCount ($args=[])
	getIds ($args=[])
	getMany ($args=[])
	getMax ($args=[])
	getQueryBuilder ($args=[])

Detailed Description

Definition at line 17 of file EntityReadInterface.inc.php.

Member Function Documentation

get()

PKP\Services\Interfaces\EntityReadInterface::get

(

$id

)

Get one object of the entity type by its ID

Parameters

int

$id

Returns

object

getCount()

PKP\Services\Interfaces\EntityReadInterface::getCount

(

$args = []

)

Get a count of the number of objects matching $args

Parameters

array

$args

Assoc array describing which rows should be counted

Returns

int

getIds()

PKP\Services\Interfaces\EntityReadInterface::getIds

(

$args = []

)

Get a list of ids matching $args

Parameters

array

$args

Assoc array describing which ids should be retrieved

Returns

array

getMany()

PKP\Services\Interfaces\EntityReadInterface::getMany

(

$args = []

)

Get a collection of objects limited, filtered and sorted by $args

Parameters

array

$args

Assoc array describing which objects should be retrieved

Returns

\Iterator

getMax()

PKP\Services\Interfaces\EntityReadInterface::getMax

(

$args = []

)

Get the max count of objects matching $args

This method is identical to self::getCount() except that any pagination arguments such as count or offset will be ignored.

Usually, this is used with self::getMany() to return the total number of items available according to the selection criteria.

Parameters

array

$args

Assoc array describing which objects should be counted

Returns

int

getQueryBuilder()

PKP\Services\Interfaces\EntityReadInterface::getQueryBuilder

(

$args = []

)

Get a QueryBuilder for this entity configured according to the $args passed

Parameters

array

$args

Assoc array describing how the querybuilder should be configured.

Returns

Object

---

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

• EntityReadInterface.inc.php