Copied!

SiteContextInstanceServiceInterface

SiteContextInstanceServiceInterface.php : 22
Interface

Methods

publiccreateSiteContext()

SiteContextInstanceServiceInterface.php : 55
public createSiteContext(SiteContextCreateStruct $createStruct) : SiteContextInterface

Parameters

Name Type Default value Description
$createStruct SiteContextCreateStruct - -

Return values

SiteContextInterface

Tags
Throws
NotFoundException
Throws
ValidationFailedException
Throws
InvalidArgumentException
Throws
InvalidArgumentValue
Throws
UnauthorizedException

publicdeleteSiteContext()

SiteContextInstanceServiceInterface.php : 77
public deleteSiteContext(SiteContextInterface $siteContext) : void

Parameters

Name Type Default value Description
$siteContext SiteContextInterface - -
Tags
Throws
InvalidArgumentException
Throws
NotFoundException
Throws
UnauthorizedException

publicdeleteSiteContextTranslation()

SiteContextInstanceServiceInterface.php : 83
public deleteSiteContextTranslation(SiteContextInterface $siteContext, string $languageCode) : void

Parameters

Name Type Default value Description
$siteContext SiteContextInterface - -
$languageCode string - -
Tags
Throws
NotFoundException
Throws
UnauthorizedException

publicfindSiteContexts()

SiteContextInstanceServiceInterface.php : 43
public findSiteContexts([SiteContextQuery|null $query = null ][, iterable<string|int, string>|null $prioritizedLanguages = null ]) : SiteContextCollectionInterface

Parameters

Name Type Default value Description
$query SiteContextQuery|null null -
$prioritizedLanguages iterable<string|int, string>|null null -

Return values

SiteContextCollectionInterface

Tags
Throws
InvalidArgumentException
Throws
ValidationFailedException
Throws
NotFoundException

publicgetSiteContext()

SiteContextInstanceServiceInterface.php : 31
public getSiteContext(string $identifier[, iterable<string|int, string>|null $prioritizedLanguages = null ]) : SiteContextInterface

Parameters

Name Type Default value Description
$identifier string - -
$prioritizedLanguages iterable<string|int, string>|null null -

Return values

SiteContextInterface

Tags
Throws
InvalidArgumentException
Throws
NotFoundException
Throws
UnauthorizedException

publicnewSiteContextCreateStruct()

SiteContextInstanceServiceInterface.php : 57
public newSiteContextCreateStruct(string $identifier) : SiteContextCreateStruct

Parameters

Name Type Default value Description
$identifier string - -

Return values

SiteContextCreateStruct

publicnewSiteContextUpdateStruct()

SiteContextInstanceServiceInterface.php : 59
public newSiteContextUpdateStruct(SiteContextInterface $siteContext) : SiteContextUpdateStruct

Parameters

Name Type Default value Description
$siteContext SiteContextInterface - -

Return values

SiteContextUpdateStruct

publicupdateSiteContext()

SiteContextInstanceServiceInterface.php : 67
public updateSiteContext(SiteContextInterface $siteContext, SiteContextUpdateStruct $updateStruct) : SiteContextInterface

Parameters

Name Type Default value Description
$siteContext SiteContextInterface - -
$updateStruct SiteContextUpdateStruct - -

Return values

SiteContextInterface

Tags
Throws
InvalidArgumentException
Throws
NotFoundException
Throws
ValidationFailedException
Throws
UnauthorizedException