FormEncoder
in package
implements
FormEncoderInterface
Class FormEncoder
FormEncoder is a vital part of the library. Our API expects form-data for all requests, but some fields may contain
JSON data (for example, /api/v5/customers/create method works like that). FormEncoder is our custom serializer that
converts request instances to form-data and uses Liip serializer under the hood to fill some fields with JSON data.
Tags
Table of Contents
Interfaces
- FormEncoderInterface
- Interface FormEncoderInterface
Methods
- __construct() : mixed
- FormEncoder constructor.
- encode() : string
- Encodes provided object into a form data
- encodeArray() : array<string|int, mixed>
- Encodes provided object into an array
- getSerializer() : SerializerInterface
- Returns underlying serializer instance.
Methods
__construct()
FormEncoder constructor.
public
__construct(SerializerInterface $serializer[, Reader|null $annotationReader = null ]) : mixed
Parameters
- $serializer : SerializerInterface
- $annotationReader : Reader|null = null
encode()
Encodes provided object into a form data
public
encode(mixed $object[, string $type = '' ]) : string
Parameters
- $object : mixed
- $type : string = ''
Tags
Return values
stringencodeArray()
Encodes provided object into an array
public
encodeArray(mixed $object[, string $type = '' ]) : array<string|int, mixed>
Parameters
- $object : mixed
- $type : string = ''
Tags
Return values
array<string|int, mixed>getSerializer()
Returns underlying serializer instance.
public
getSerializer() : SerializerInterface