PKP\Services\QueryBuilders\PKPAnnouncementQueryBuilder Class Reference

Inheritance diagram for PKP\Services\QueryBuilders\PKPAnnouncementQueryBuilder:

Public Member Functions
	filterByContextIds ($contextIds)
	filterByTypeIds ($typeIds)
	getCount ()
	getIds ()
	getQuery ()
	searchPhrase ($phrase)

Protected Attributes
	$contextIds = []
	$searchPhrase = ''
	$typeIds = []

Detailed Description

Definition at line 20 of file PKPAnnouncementQueryBuilder.inc.php.

Member Function Documentation

filterByContextIds()

PKP\Services\QueryBuilders\PKPAnnouncementQueryBuilder::filterByContextIds

(

$contextIds

)

Set contextIds filter

Parameters

array | int

$contextIds

Returns

\PKP\Services\QueryBuilders\PKPAnnouncementQueryBuilder

Definition at line 46 of file PKPAnnouncementQueryBuilder.inc.php.

References PKP\Services\QueryBuilders\PKPAnnouncementQueryBuilder\$contextIds.

filterByTypeIds()

PKP\Services\QueryBuilders\PKPAnnouncementQueryBuilder::filterByTypeIds

(

$typeIds

)

Set type filter

Parameters

array | int

$typeIds

Returns

\PKP\Services\QueryBuilders\PKPAnnouncementQueryBuilder

Definition at line 57 of file PKPAnnouncementQueryBuilder.inc.php.

References PKP\Services\QueryBuilders\PKPAnnouncementQueryBuilder\$typeIds.

getCount()

PKP\Services\QueryBuilders\PKPAnnouncementQueryBuilder::getCount

(

)

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

Returns

int

Implements PKP\Services\QueryBuilders\Interfaces\EntityQueryBuilderInterface.

Definition at line 77 of file PKPAnnouncementQueryBuilder.inc.php.

getIds()

PKP\Services\QueryBuilders\PKPAnnouncementQueryBuilder::getIds

(

)

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

Returns

array

Implements PKP\Services\QueryBuilders\Interfaces\EntityQueryBuilderInterface.

Definition at line 88 of file PKPAnnouncementQueryBuilder.inc.php.

getQuery()

PKP\Services\QueryBuilders\PKPAnnouncementQueryBuilder::getQuery

(

)

Execute query builder

Returns

object Query object

Implements PKP\Services\QueryBuilders\Interfaces\EntityQueryBuilderInterface.

Definition at line 101 of file PKPAnnouncementQueryBuilder.inc.php.

References HookRegistry\call(), and PKP\Services\QueryBuilders\PKPAnnouncementQueryBuilder\searchPhrase().

searchPhrase()

PKP\Services\QueryBuilders\PKPAnnouncementQueryBuilder::searchPhrase

(

$phrase

)

Set query search phrase

Parameters

string

$phrase

Returns

\APP\Services\QueryBuilders\SubmissionQueryBuilder

Definition at line 69 of file PKPAnnouncementQueryBuilder.inc.php.

Referenced by PKP\Services\QueryBuilders\PKPAnnouncementQueryBuilder\getQuery().

Field Documentation

$contextIds

array PKPAnnouncementQueryBuilder::$contextIds = []

protected

get announcements for one or more contexts

Definition at line 26 of file PKPAnnouncementQueryBuilder.inc.php.

Referenced by PKP\Services\QueryBuilders\PKPAnnouncementQueryBuilder\filterByContextIds().

$searchPhrase

string PKPAnnouncementQueryBuilder::$searchPhrase = ''

protected

get announcements matching one or more words in this phrase

Definition at line 32 of file PKPAnnouncementQueryBuilder.inc.php.

$typeIds

array PKPAnnouncementQueryBuilder::$typeIds = []

protected

get announcements with one of these typeIds

Definition at line 38 of file PKPAnnouncementQueryBuilder.inc.php.

Referenced by PKP\Services\QueryBuilders\PKPAnnouncementQueryBuilder\filterByTypeIds().

---

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

• PKPAnnouncementQueryBuilder.inc.php