Copied!

DateBasedPublishServiceInterface

DateBasedPublishServiceInterface.php : 15
Interface
Extends DateBasedEntriesListInterface

Methods

publiccountScheduledEntries()

DateBasedEntriesListInterface.php : 48 
public countScheduledEntries() : int

Return values

int

publiccountScheduledEntriesInDateRange()

DateBasedEntriesListInterface.php : 62

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 : 50 
public countScheduledEntriesToProcess() : int

Return values

int

publiccountUserScheduledVersions()

DateBasedPublishServiceInterface.php : 60 
public countUserScheduledVersions() : int

Return values

int

publiccountVersionsEntriesForContent()

DateBasedPublishServiceInterface.php : 62 
public countVersionsEntriesForContent(int $contentId) : int

Parameters

Name Type Default value Description
$contentId int - -

Return values

int

publicgetScheduledEntriesByIds()

DateBasedEntriesListInterface.php : 20 
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 : 40

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 : 27 
public getScheduledEntriesToProcess([int $limit = 25 ]) : array<string|int, ScheduledEntry>

Parameters

Name Type Default value Description
$limit int 25 -

Return values

array<string|int, ScheduledEntry>

publicgetScheduledPublish()

DateBasedPublishServiceInterface.php : 43 
public getScheduledPublish(int $versionId) : ScheduledEntry

Parameters

Name Type Default value Description
$versionId int - -

Return values

ScheduledEntry

Tags
Throws
NotFoundException

publicgetScheduledVersions()

DateBasedPublishServiceInterface.php : 48 
public getScheduledVersions([int $page = 0 ][, int $limit = 25 ]) : array<string|int, ScheduledEntry>

Parameters

Name Type Default value Description
$page int 0 -
$limit int 25 -

Return values

array<string|int, ScheduledEntry>

publicgetUserScheduledVersions()

DateBasedPublishServiceInterface.php : 53 
public getUserScheduledVersions(int $page, int $limit) : array<string|int, ScheduledEntry>

Parameters

Name Type Default value Description
$page int - -
$limit int - -

Return values

array<string|int, ScheduledEntry>

publicgetVersionsEntriesForContent()

DateBasedPublishServiceInterface.php : 58 
public getVersionsEntriesForContent(int $contentId[, int $page = 0 ][, int $limit = 25 ]) : array<string|int, ScheduledEntry>

Parameters

Name Type Default value Description
$contentId int - -
$page int 0 -
$limit int 25 -

Return values

array<string|int, ScheduledEntry>

publicisScheduledPublish()

DateBasedPublishServiceInterface.php : 27 
public isScheduledPublish(int $versionId) : bool

Parameters

Name Type Default value Description
$versionId int - -

Return values

bool

publicschedulePublish()

DateBasedPublishServiceInterface.php : 23 
public schedulePublish(VersionInfo $versionInfo, DateTimeInterface $when) : ScheduledEntry

Parameters

Name Type Default value Description
$versionInfo VersionInfo - -
$when DateTimeInterface - -

Return values

ScheduledEntry

publicunschedulePublish()

DateBasedPublishServiceInterface.php : 25 
public unschedulePublish(int $versionId) : bool

Parameters

Name Type Default value Description
$versionId int - -

Return values

bool

publicupdateScheduledPublish()

DateBasedPublishServiceInterface.php : 35 
public updateScheduledPublish(ScheduledEntry $scheduledEntry, DateTimeInterface $when) : ScheduledEntry

Parameters

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

Return values

ScheduledEntry