Copied!

MetadataAwareFieldValueTransformerInterface

MetadataAwareFieldValueTransformerInterface.php : 13
Interface
Extends FieldValueTransformerInterface

Methods

publicdecode()

FieldValueTransformerInterface.php : 29 
public decode(string $value, mixed $previousFieldValue, array<string, mixed> $metadata) : Value

Parameters

Name Type Default value Description
$value string - -
$previousFieldValue mixed - -
$metadata array<string, mixed> - -

Return values

Value

Tags
Throws
InvalidArgumentException

publicencode()

FieldValueTransformerInterface.php : 22 
public encode(Field $field) : EncodedFieldValue

Parameters

Name Type Default value Description
$field Field - -

Return values

EncodedFieldValue

Tags
Throws
InvalidArgumentException

publicgetFieldTypeIdentifier()

FieldValueTransformerInterface.php : 17 
public getFieldTypeIdentifier() : string

Return values

string

publichandleMetadataEncodingFailure()

MetadataAwareFieldValueTransformerInterface.php : 15 
public handleMetadataEncodingFailure(Throwable $exception) : MetadataEncodingFailureHandling

Parameters

Name Type Default value Description
$exception Throwable - -

Return values

MetadataEncodingFailureHandling

publicisMetadataRequired()

MetadataAwareFieldValueTransformerInterface.php : 19 
public isMetadataRequired(string $value, mixed $previousFieldValue) : bool

Parameters

Name Type Default value Description
$value string - -
$previousFieldValue mixed - -

Return values

bool