PKP\Services\QueryBuilders\Interfaces\EntityQueryBuilderInterface Interface Reference

Inheritance diagram for PKP\Services\QueryBuilders\Interfaces\EntityQueryBuilderInterface:

Public Member Functions
	getCount ()
	getIds ()
	getQuery ()

Detailed Description

Definition at line 19 of file EntityQueryBuilderInterface.inc.php.

Member Function Documentation

getCount()

PKP\Services\QueryBuilders\Interfaces\EntityQueryBuilderInterface::getCount

(

)

Get a count of the number of rows that match the select conditions configured in this query builder.

Returns

int

Implemented in PKP\Services\QueryBuilders\PKPUserQueryBuilder, PKP\Services\QueryBuilders\PKPSubmissionQueryBuilder, APP\Services\QueryBuilders\IssueQueryBuilder, PKP\Services\QueryBuilders\PKPEmailTemplateQueryBuilder, PKP\Services\QueryBuilders\PKPAuthorQueryBuilder, PKP\Services\QueryBuilders\PKPContextQueryBuilder, PKP\Services\QueryBuilders\PKPPublicationQueryBuilder, PKP\Services\QueryBuilders\PKPAnnouncementQueryBuilder, and APP\Services\QueryBuilders\GalleyQueryBuilder.

getIds()

PKP\Services\QueryBuilders\Interfaces\EntityQueryBuilderInterface::getIds

(

)

Get a list of ids that match the select conditions configured in this query builder.

Returns

array

Implemented in PKP\Services\QueryBuilders\PKPUserQueryBuilder, PKP\Services\QueryBuilders\PKPSubmissionQueryBuilder, APP\Services\QueryBuilders\IssueQueryBuilder, PKP\Services\QueryBuilders\PKPEmailTemplateQueryBuilder, PKP\Services\QueryBuilders\PKPAuthorQueryBuilder, PKP\Services\QueryBuilders\PKPContextQueryBuilder, PKP\Services\QueryBuilders\PKPPublicationQueryBuilder, PKP\Services\QueryBuilders\PKPAnnouncementQueryBuilder, and APP\Services\QueryBuilders\GalleyQueryBuilder.

getQuery()

PKP\Services\QueryBuilders\Interfaces\EntityQueryBuilderInterface::getQuery

(

)

Get a query builder with the applied select, where and join clauses based on builder's configuration

This returns an instance of Laravel's query builder.

Call the get method on a query builder to return an array of matching rows.

$qb = new \PKP\Services\QueryBuilders\PublicationQueryBuilder();
$result = $qb
  ->filterByContextIds(1)
  ->getQuery()
  ->get();

Or use the query builder to retrieve objects from a DAO. This example retrieves the first 20 matching Publications.

$qo = $qb
  ->filterByContextIds(1)
  ->getQuery();
$result = DAORegistry::getDAO('PublicationDAO')->retrieveRange(
  $qo->toSql(),
  $qo->getBindings(),
  new DBResultRange(20, null, 0);
);
$queryResults = new DAOResultFactory($result, $publicationDao, '_fromRow');
$iteratorOfObjects = $queryResults->toIterator();

Laravel's other query builder methods, such as first and pluck, can also be used.

$qb = new \PKP\Services\QueryBuilders\PublicationQueryBuilder();
$result = $qb
  ->filterByContextIds(1)
  ->getQuery()
  ->first();

See: https://laravel.com/docs/5.5/queries

Returns

Illuminate\Database\Query\Builder

Implemented in PKP\Services\QueryBuilders\PKPUserQueryBuilder, PKP\Services\QueryBuilders\PKPSubmissionQueryBuilder, APP\Services\QueryBuilders\IssueQueryBuilder, PKP\Services\QueryBuilders\PKPEmailTemplateQueryBuilder, PKP\Services\QueryBuilders\PKPContextQueryBuilder, PKP\Services\QueryBuilders\PKPAuthorQueryBuilder, PKP\Services\QueryBuilders\PKPAnnouncementQueryBuilder, and APP\Services\QueryBuilders\GalleyQueryBuilder.

Referenced by PKP\Services\QueryBuilders\PKPPublicationQueryBuilder\getDateBoundaries().

---

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

• EntityQueryBuilderInterface.inc.php