Copied!

DateBasedHideServiceInterface

DateBasedHideServiceInterface.php : 15
Interface
Extends DateBasedEntriesListInterface

Methods

publiccountScheduledEntries()

DateBasedEntriesListInterface.php : 50 
public countScheduledEntries() : int

Return values

int

publiccountScheduledEntriesInDateRange()

DateBasedEntriesListInterface.php : 64

Return number of scheduled entries for given date range with optional skipping entries to the given $sinceId.

 
public countScheduledEntriesInDateRange(DateTimeInterface $start, DateTimeInterface $end[, array<string|int, Language> $languages = [] ][, int|null $sinceId = null ]) : int

Parameters

Name Type Default value Description
$start DateTimeInterface - -
$end DateTimeInterface - -
$languages array<string|int, Language> [] -
$sinceId int|null null -

Return values

int

publiccountScheduledEntriesToProcess()

DateBasedEntriesListInterface.php : 52 
public countScheduledEntriesToProcess() : int

Return values

int

publicgetScheduledEntriesByIds()

DateBasedEntriesListInterface.php : 22 
public getScheduledEntriesByIds(array<string|int, int> $scheduledEntriesIds) : array<string|int, ScheduledEntry>

Parameters

Name Type Default value Description
$scheduledEntriesIds array<string|int, int> - -

Return values

array<string|int, ScheduledEntry>

publicgetScheduledEntriesInDateRange()

DateBasedEntriesListInterface.php : 42

Return scheduled entries for given date range with optional skipping entries to the given $sinceId.

 
public getScheduledEntriesInDateRange(DateTimeInterface $start, DateTimeInterface $end[, array<string|int, Language> $languages = [] ][, int|null $sinceId = null ][, int $limit = 25 ]) : array<string|int, ScheduledEntry>

Parameters

Name Type Default value Description
$start DateTimeInterface - -
$end DateTimeInterface - -
$languages array<string|int, Language> [] -
$sinceId int|null null -
$limit int 25 -

Return values

array<string|int, ScheduledEntry>

publicgetScheduledEntriesToProcess()

DateBasedEntriesListInterface.php : 29 
public getScheduledEntriesToProcess([int $limit = 25 ]) : array<string|int, ScheduledEntry>

Parameters

Name Type Default value Description
$limit int 25 -

Return values

array<string|int, ScheduledEntry>

publicgetScheduledHide()

DateBasedHideServiceInterface.php : 46 
public getScheduledHide(int $contentId) : ScheduledEntry

Parameters

Name Type Default value Description
$contentId int - -

Return values

ScheduledEntry

Tags
Throws
NotFoundException

publicisScheduledHide()

DateBasedHideServiceInterface.php : 30 
public isScheduledHide(int $contentId) : bool

Parameters

Name Type Default value Description
$contentId int - -

Return values

bool

publicscheduleHide()

DateBasedHideServiceInterface.php : 23 
public scheduleHide(int $contentId, DateTimeInterface $when) : ScheduledEntry

Parameters

Name Type Default value Description
$contentId int - -
$when DateTimeInterface - -

Return values

ScheduledEntry

publicunscheduleHide()

DateBasedHideServiceInterface.php : 28 
public unscheduleHide(int $contentId) : bool

Parameters

Name Type Default value Description
$contentId int - -

Return values

bool

publicupdateScheduledHide()

DateBasedHideServiceInterface.php : 38 
public updateScheduledHide(ScheduledEntry $scheduledEntry, DateTimeInterface $when) : ScheduledEntry

Parameters

Name Type Default value Description
$scheduledEntry ScheduledEntry - -
$when DateTimeInterface - -

Return values

ScheduledEntry