Copied!

CatalogServiceInterface

CatalogServiceInterface.php : 19

Methods

publiccopyCatalog()

CatalogServiceInterface.php : 64
public copyCatalog(CatalogInterface $catalog, CatalogCopyStruct $copyStruct) : CatalogInterface

Parameters

Name Type Default value Description
$catalog CatalogInterface - -
$copyStruct CatalogCopyStruct - -

Return values

CatalogInterface

publiccreateCatalog()

CatalogServiceInterface.php : 38
public createCatalog(CatalogCreateStruct $createStruct) : CatalogInterface

Parameters

Name Type Default value Description
$createStruct CatalogCreateStruct - -

Return values

CatalogInterface

Tags
Throws
InvalidArgumentException
Throws
UnauthorizedException

publicdeleteCatalog()

CatalogServiceInterface.php : 54
public deleteCatalog(CatalogInterface $catalog) : void

Parameters

Name Type Default value Description
$catalog CatalogInterface - -
Tags
Throws
UnauthorizedException
Throws
NotFoundException

publicdeleteCatalogTranslation()

CatalogServiceInterface.php : 69
public deleteCatalogTranslation(CatalogDeleteTranslationStruct $struct) : void

Parameters

Name Type Default value Description
$struct CatalogDeleteTranslationStruct - -

publicfindCatalogs()

CatalogServiceInterface.php : 21
public findCatalogs([CatalogQuery|null $query = null ]) : CatalogListInterface

Parameters

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

Return values

CatalogListInterface

publicgetCatalog()

CatalogServiceInterface.php : 62
public getCatalog(int $id[, array<string|int, string>|null $prioritizedLanguages = null ]) : CatalogInterface

Parameters

Name Type Default value Description
$id int - -
$prioritizedLanguages array<string|int, string>|null null -

Return values

CatalogInterface

Tags
Throws
NotFoundException
Throws
UnauthorizedException

publicgetCatalogByIdentifier()

CatalogServiceInterface.php : 29
public getCatalogByIdentifier(string $identifier[, array<string|int, string>|null $prioritizedLanguages = null ]) : CatalogInterface

Parameters

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

Return values

CatalogInterface

Tags
Throws
UnauthorizedException
Throws
NotFoundException

publicupdateCatalog()

CatalogServiceInterface.php : 45
public updateCatalog(CatalogInterface $catalog, CatalogUpdateStruct $updateStruct) : CatalogInterface

Parameters

Name Type Default value Description
$catalog CatalogInterface - -
$updateStruct CatalogUpdateStruct - -

Return values

CatalogInterface

Tags
Throws
UnauthorizedException
Throws
InvalidArgumentException
Throws
NotFoundException