Copied!

SiteServiceInterface

SiteServiceInterface.php : 17
Interface

Methods

publiccountSites()

SiteServiceInterface.php : 32 
public countSites([SiteQuery|null $query = null ]) : int

Parameters

Name Type Default value Description
$query SiteQuery|null null -

Return values

int

publiccreateSite()

SiteServiceInterface.php : 19 
public createSite(SiteCreateStruct $createStruct) : Site

Parameters

Name Type Default value Description
$createStruct SiteCreateStruct - -

Return values

Site

publicdeleteSite()

SiteServiceInterface.php : 23 
public deleteSite(Site $site) : void

Parameters

Name Type Default value Description
$site Site - -

publicloadPages()

SiteServiceInterface.php : 37 
public loadPages([SiteQuery|null $query = null ][, int $offset = 0 ][, int $limit = -1 ]) : array{count: int, items: string[]}

Parameters

Name Type Default value Description
$query SiteQuery|null null -
$offset int 0 -
$limit int -1 -

Return values

array{count: int, items: string[]}

publicloadSite()

SiteServiceInterface.php : 28 
public loadSite(int $id) : Site

Parameters

Name Type Default value Description
$id int - -

Return values

Site

Tags
Throws
NotFoundException

publicloadSites()

SiteServiceInterface.php : 30 
public loadSites([SiteQuery|null $query = null ]) : SiteList

Parameters

Name Type Default value Description
$query SiteQuery|null null -

Return values

SiteList

publicupdateSite()

SiteServiceInterface.php : 21 
public updateSite(Site $site, SiteUpdateStruct $siteUpdateStruct) : Site

Parameters

Name Type Default value Description
$site Site - -
$siteUpdateStruct SiteUpdateStruct - -

Return values

Site