Copied!

PaymentMethodUpdateStruct

PaymentMethodUpdateStruct.php : 27
Extends ValueObject

Structure containing data used to update a payment method.

The following example updates a payment method name to "Updated name":

$updateStruct = new PaymentMethodUpdateStruct();
$updateStruct->setName('eng-GB', 'Updated name');

$paymentMethod = $paymentMethodService->updatePaymentMethod($paymentMethod, $updateStruct);
Tags
See
PaymentMethodServiceInterface::updatePaymentMethod()

Methods

public__construct()

ValueObject.php : 30

Construct object optionally with a set of properties.

 
public __construct([array<string|int, mixed> $properties = [] ])

Readonly properties values must be set using $properties as they are not writable anymore after object has been created.

Parameters

Name Type Default value Description
$properties array<string|int, mixed> [] -

publicgetDescriptions()

PaymentMethodUpdateStruct.php : 83

Returns updated descriptions or null if the payment method descriptions should not be updated.

 
public getDescriptions() : array<string, string|null>|null

Return values

array<string, string|null>|null

publicgetIdentifier()

PaymentMethodUpdateStruct.php : 45

Returns updated identifier or null if the identifier should not be updated.

 
public getIdentifier() : string|null

Return values

string|null

publicgetNames()

PaymentMethodUpdateStruct.php : 63

Returns updated names or null if the payment method names should not be updated.

 
public getNames() : array<string, string|null>|null

Return values

array<string, string|null>|null

publicgetOptions()

PaymentMethodUpdateStruct.php : 119

Returns updated options or null if the payment method options should not be updated.

 
public getOptions() : MapInterface<string, mixed>|null

Return values

MapInterface<string, mixed>|null

publicisEnabled()

PaymentMethodUpdateStruct.php : 101

Returns updated enabled status or null if the enabled status should not be updated.

 
public isEnabled() : bool|null

Return values

bool|null

publicsetDescriptions()

PaymentMethodUpdateStruct.php : 93

Set new descriptions for the payment methods.

 
public setDescriptions(array<string, string|null>|null $descriptions) : void

Parameters

Name Type Default value Description
$descriptions array<string, string|null>|null - -

publicsetEnabled()

PaymentMethodUpdateStruct.php : 109

Sets new enabled status for the payment method.

 
public setEnabled(bool|null $enabled) : void

Parameters

Name Type Default value Description
$enabled bool|null - -

publicsetIdentifier()

PaymentMethodUpdateStruct.php : 53

Sets new identifier for the payment method.

 
public setIdentifier(string|null $identifier) : void

Parameters

Name Type Default value Description
$identifier string|null - -

publicsetNames()

PaymentMethodUpdateStruct.php : 73

Sets new names for the payment methods.

 
public setNames(array<string, string|null>|null $names) : void

Parameters

Name Type Default value Description
$names array<string, string|null>|null - -

publicsetOptions()

PaymentMethodUpdateStruct.php : 129

Sets new options for the payment method.

 
public setOptions(MapInterface<string, mixed>|null $options) : void

Parameters

Name Type Default value Description
$options MapInterface<string, mixed>|null - -

protectedgetProperties()

ValueObject.php : 50

Function where list of properties are returned.

 
protected getProperties([array<string|int, mixed> $dynamicProperties = [] ]) : array<string|int, mixed>

Used by attributes(), override to add dynamic properties

Parameters

Name Type Default value Description
$dynamicProperties array<string|int, mixed> []

Additional dynamic properties exposed on the object

Return values

array<string|int, mixed>