Ibexa >
Contracts >
Shipping >
ShippingMethodServiceInterface

ShippingMethodServiceInterface

ShippingMethodServiceInterface.php : 21 Copy path

Interface

Methods¶

createShippingMethod() ¶

ShippingMethodServiceInterface.php : 55 Copy path

public createShippingMethod(ShippingMethodCreateStruct $createStruct) : ShippingMethodInterface

Parameters

Name	Type	Default value	Description
$createStruct	ShippingMethodCreateStruct	-	-

Return values

ShippingMethodInterface

Tags

deleteShippingMethod() ¶

ShippingMethodServiceInterface.php : 72 Copy path

public deleteShippingMethod(ShippingMethodInterface $shippingMethod) : void

Parameters

Name	Type	Default value	Description
$shippingMethod	ShippingMethodInterface	-	-

Tags

deleteShippingMethodTranslation() ¶

ShippingMethodServiceInterface.php : 76 Copy path

public deleteShippingMethodTranslation(ShippingMethodDeleteTranslationStruct $struct) : void

Parameters

Name	Type	Default value	Description
$struct	ShippingMethodDeleteTranslationStruct	-	-

findShippingMethods() ¶

ShippingMethodServiceInterface.php : 46 Copy path

public findShippingMethods([ShippingMethodQuery|null $query = null ][, array<string|int, string>|null $prioritizedLanguages = null ]) : ShippingMethodListInterface

Parameters

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

Return values

ShippingMethodListInterface

getShippingMethod() ¶

ShippingMethodServiceInterface.php : 28 Copy path

public getShippingMethod(string $identifier[, array<string|int, string>|null $prioritizedLanguages = null ]) : ShippingMethodInterface

Parameters

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

Return values

ShippingMethodInterface

Tags

getShippingMethodById() ¶

ShippingMethodServiceInterface.php : 38 Copy path

public getShippingMethodById(int $id[, array<string|int, string>|null $prioritizedLanguages = null ]) : ShippingMethodInterface

Parameters

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

Return values

ShippingMethodInterface

Tags

isShippingMethodUsed() ¶

ShippingMethodServiceInterface.php : 78 Copy path

public isShippingMethodUsed(ShippingMethodInterface $shippingMethod) : bool

Parameters

Name	Type	Default value	Description
$shippingMethod	ShippingMethodInterface	-	-

Return values

bool

newShippingMethodCreateStruct() ¶

ShippingMethodServiceInterface.php : 80 Copy path

public newShippingMethodCreateStruct(string $identifier) : ShippingMethodCreateStruct

Parameters

Name	Type	Default value	Description
$identifier	string	-	-

Return values

ShippingMethodCreateStruct

newShippingMethodUpdateStruct() ¶

ShippingMethodServiceInterface.php : 84 Copy path

public newShippingMethodUpdateStruct() : ShippingMethodUpdateStruct

Return values

ShippingMethodUpdateStruct

updateShippingMethod() ¶

ShippingMethodServiceInterface.php : 63 Copy path

public updateShippingMethod(ShippingMethodInterface $shippingMethod, ShippingMethodUpdateStruct $updateStruct) : ShippingMethodInterface

Parameters

Name	Type	Default value	Description
$shippingMethod	ShippingMethodInterface	-	-
$updateStruct	ShippingMethodUpdateStruct	-	-

Return values

ShippingMethodInterface