LocalProductServiceInterface

LocalProductServiceInterface.php : 21 Copy path

Interface

Extends ProductServiceInterface

Methods¶

createProduct() ¶

LocalProductServiceInterface.php : 40 Copy path

public createProduct(ProductCreateStruct $createStruct) : ProductInterface

Parameters

Name	Type	Default value	Description
$createStruct	ProductCreateStruct	-	-

Return values

ProductInterface

Tags

createProductVariants() ¶

LocalProductServiceInterface.php : 48 Copy path

public createProductVariants(ProductInterface $product, iterable<string|int, ProductVariantCreateStruct> $createStructs) : void

Parameters

Name	Type	Default value	Description
$product	ProductInterface	-	-
$createStructs	iterable<string\|int, ProductVariantCreateStruct>	-	-

Tags

deleteProduct() ¶

LocalProductServiceInterface.php : 77 Copy path

public deleteProduct(ProductInterface $product) : void

Parameters

Name	Type	Default value	Description
$product	ProductInterface	-	-

Tags

deleteProductTranslation() ¶

LocalProductServiceInterface.php : 89 Copy path

public deleteProductTranslation(ProductInterface $product, Language $language) : void

Parameters

Name	Type	Default value	Description
$product	ProductInterface	-	-
$language	Language	-	-

Tags

deleteProductVariantsByBaseProduct() ¶

LocalProductServiceInterface.php : 84 Copy path

public deleteProductVariantsByBaseProduct(ProductInterface $baseProduct) : array<string|int, string>

Parameters

Name	Type	Default value	Description
$baseProduct	ProductInterface	-	-

Return values

array<string|int, string>

Tags

findProducts() ¶

ProductServiceInterface.php : 29 Copy path

public findProducts(ProductQuery $query[, LanguageSettings|null $languageSettings = null ]) : ProductListInterface

Parameters

Name	Type	Default value	Description
$query	ProductQuery	-	-
$languageSettings	LanguageSettings\|null	null	-

Return values

ProductListInterface

findProductVariants() ¶

ProductServiceInterface.php : 39 Copy path

public findProductVariants(ProductInterface $product[, ProductVariantQuery|null $query = null ]) : ProductVariantListInterface

Parameters

Name	Type	Default value	Description
$product	ProductInterface	-	-
$query	ProductVariantQuery\|null	null	-

Return values

ProductVariantListInterface

getProduct() ¶

ProductServiceInterface.php : 27 Copy path

Loads product with given code.

public getProduct(string $code[, LanguageSettings|null $settings = null ]) : ProductInterface

Parameters

Name	Type	Default value	Description
$code	string	-	-
$settings	LanguageSettings\|null	null	-

Return values

ProductInterface

Tags

getProductFromContent() ¶

LocalProductServiceInterface.php : 34 Copy path

Returns product associated with given Content.

public getProductFromContent(Content $content) : ProductInterface

Parameters

Name	Type	Default value	Description
$content	Content	-	-

Return values

ProductInterface

Tags

getProductVariant() ¶

ProductServiceInterface.php : 37 Copy path

Loads product variant with given code.

public getProductVariant(string $code[, LanguageSettings|null $settings = null ]) : ProductVariantInterface

Parameters

Name	Type	Default value	Description
$code	string	-	-
$settings	LanguageSettings\|null	null	-

Return values

ProductVariantInterface

Tags

isProduct() ¶

LocalProductServiceInterface.php : 26 Copy path

Checks if Content is a product.

public isProduct(Content $content) : bool

Parameters

Name	Type	Default value	Description
$content	Content	-	-

Return values

bool

newProductCreateStruct() ¶

LocalProductServiceInterface.php : 50 Copy path

public newProductCreateStruct(ProductTypeInterface $productType, string $mainLanguageCode) : ProductCreateStruct

Parameters

Name	Type	Default value	Description
$productType	ProductTypeInterface	-	-
$mainLanguageCode	string	-	-

Return values

ProductCreateStruct

newProductUpdateStruct() ¶

LocalProductServiceInterface.php : 55 Copy path

public newProductUpdateStruct(ProductInterface $product) : ProductUpdateStruct

Parameters

Name	Type	Default value	Description
$product	ProductInterface	-	-

Return values

ProductUpdateStruct

updateProduct() ¶

LocalProductServiceInterface.php : 62 Copy path

public updateProduct(ProductUpdateStruct $updateStruct) : ProductInterface

Parameters

Name	Type	Default value	Description
$updateStruct	ProductUpdateStruct	-	-

Return values

ProductInterface

Tags

updateProductVariant() ¶

LocalProductServiceInterface.php : 69 Copy path

public updateProductVariant(ProductVariantInterface $productVariant, ProductVariantUpdateStruct $updateStruct) : ProductVariantInterface

Parameters

Name	Type	Default value	Description
$productVariant	ProductVariantInterface	-	-
$updateStruct	ProductVariantUpdateStruct	-	-

Return values

ProductVariantInterface