ExportTransformerOptions
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
ExportTransformerOptions Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- DISCRIMINATOR = null
- FORMAT_CSV = 'CSV'
- FORMAT_EXCEL = 'EXCEL'
- FORMAT_JSON = 'JSON'
- FORMAT_XML = 'XML'
- $attributeMap : array<string|int, string>
- Array of attributes where the key is the local name, and the value is the original name
- $container : array<string|int, mixed>
- Associative array for storing property values
- $getters : array<string|int, string>
- Array of attributes to getter functions (for serialization of requests)
- $openAPIFormats : array<string|int, string>
- Array of property to format mappings. Used for (de)serialization
- $openAPIModelName : string
- The original name of the model.
- $openAPINullables : array<string|int, mixed>
- Array of nullable properties. Used for (de)serialization
- $openAPINullablesSetToNull : array<string|int, mixed>
- If a nullable field gets set to null, insert it here
- $openAPITypes : array<string|int, string>
- Array of property to type mappings. Used for (de)serialization
- $setters : array<string|int, string>
- Array of attributes to setter functions (for deserialization of responses)
- __construct() : mixed
- Constructor
- __toString() : string
- Gets the string presentation of the object
- attributeMap() : array<string|int, mixed>
- Array of attributes where the key is the local name, and the value is the original name
- getAiMappingId() : string|null
- Gets ai_mapping_id
- getAiTransformId() : string|null
- Gets ai_transform_id
- getArraySeparator() : string|null
- Gets array_separator
- getAttachmentId() : string|null
- Gets attachment_id
- getBefore() : DateTime|null
- Gets before
- getDelimiter() : string|null
- Gets delimiter
- getEmailId() : string|null
- Gets email_id
- getFlattenArrays() : bool
- Gets flatten_arrays
- getFormat() : string
- Gets format
- getFormatAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getInboxId() : string|null
- Gets inbox_id
- getIncludeMetaData() : bool
- Gets include_meta_data
- getIncludeMetaDataColumns() : array<string|int, string>|null
- Gets include_meta_data_columns
- getModelName() : string
- The original name of the model.
- getPhoneId() : string|null
- Gets phone_id
- getSince() : DateTime|null
- Gets since
- getSmsId() : string|null
- Gets sms_id
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- isNullable() : bool
- Checks if a property is nullable
- isNullableSetToNull() : bool
- Checks if a nullable property is set to null.
- jsonSerialize() : mixed
- Serializes the object to a value that can be serialized natively by json_encode().
- listInvalidProperties() : array<string|int, mixed>
- Show all the invalid properties with reasons.
- offsetExists() : bool
- Returns true if offset exists. False otherwise.
- offsetGet() : mixed|null
- Gets offset.
- offsetSet() : void
- Sets value based on offset.
- offsetUnset() : void
- Unsets offset.
- openAPIFormats() : array<string|int, mixed>
- Array of property to format mappings. Used for (de)serialization
- openAPITypes() : array<string|int, mixed>
- Array of property to type mappings. Used for (de)serialization
- setAiMappingId() : self
- Sets ai_mapping_id
- setAiTransformId() : self
- Sets ai_transform_id
- setArraySeparator() : self
- Sets array_separator
- setAttachmentId() : self
- Sets attachment_id
- setBefore() : self
- Sets before
- setDelimiter() : self
- Sets delimiter
- setEmailId() : self
- Sets email_id
- setFlattenArrays() : self
- Sets flatten_arrays
- setFormat() : self
- Sets format
- setInboxId() : self
- Sets inbox_id
- setIncludeMetaData() : self
- Sets include_meta_data
- setIncludeMetaDataColumns() : self
- Sets include_meta_data_columns
- setPhoneId() : self
- Sets phone_id
- setSince() : self
- Sets since
- setSmsId() : self
- Sets sms_id
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- toHeaderValue() : string
- Gets a header-safe presentation of the object
- valid() : bool
- Validate all the properties in the model return true if all passed
- openAPINullables() : array<string|int, mixed>
- Array of nullable properties
- getOpenAPINullablesSetToNull() : array<string|int, bool>
- Array of nullable field names deliberately set to null
- setIfExists() : void
- Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the $this->openAPINullablesSetToNull array
- setOpenAPINullablesSetToNull() : void
- Setter - Array of nullable field names deliberately set to null
Constants
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
FORMAT_CSV
public
mixed
FORMAT_CSV
= 'CSV'
FORMAT_EXCEL
public
mixed
FORMAT_EXCEL
= 'EXCEL'
FORMAT_JSON
public
mixed
FORMAT_JSON
= 'JSON'
FORMAT_XML
public
mixed
FORMAT_XML
= 'XML'
Properties
$attributeMap
Array of attributes where the key is the local name, and the value is the original name
protected
static array<string|int, string>
$attributeMap
= ['ai_transform_id' => 'aiTransformId', 'ai_mapping_id' => 'aiMappingId', 'flatten_arrays' => 'flattenArrays', 'since' => 'since', 'before' => 'before', 'format' => 'format', 'inbox_id' => 'inboxId', 'phone_id' => 'phoneId', 'email_id' => 'emailId', 'sms_id' => 'smsId', 'attachment_id' => 'attachmentId', 'include_meta_data' => 'includeMetaData', 'delimiter' => 'delimiter', 'array_separator' => 'arraySeparator', 'include_meta_data_columns' => 'includeMetaDataColumns']
$container
Associative array for storing property values
protected
array<string|int, mixed>
$container
= []
$getters
Array of attributes to getter functions (for serialization of requests)
protected
static array<string|int, string>
$getters
= ['ai_transform_id' => 'getAiTransformId', 'ai_mapping_id' => 'getAiMappingId', 'flatten_arrays' => 'getFlattenArrays', 'since' => 'getSince', 'before' => 'getBefore', 'format' => 'getFormat', 'inbox_id' => 'getInboxId', 'phone_id' => 'getPhoneId', 'email_id' => 'getEmailId', 'sms_id' => 'getSmsId', 'attachment_id' => 'getAttachmentId', 'include_meta_data' => 'getIncludeMetaData', 'delimiter' => 'getDelimiter', 'array_separator' => 'getArraySeparator', 'include_meta_data_columns' => 'getIncludeMetaDataColumns']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['ai_transform_id' => 'uuid', 'ai_mapping_id' => 'uuid', 'flatten_arrays' => null, 'since' => 'date-time', 'before' => 'date-time', 'format' => null, 'inbox_id' => 'uuid', 'phone_id' => 'uuid', 'email_id' => 'uuid', 'sms_id' => 'uuid', 'attachment_id' => null, 'include_meta_data' => null, 'delimiter' => null, 'array_separator' => null, 'include_meta_data_columns' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'ExportTransformerOptions'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['ai_transform_id' => true, 'ai_mapping_id' => true, 'flatten_arrays' => false, 'since' => true, 'before' => true, 'format' => false, 'inbox_id' => true, 'phone_id' => true, 'email_id' => true, 'sms_id' => true, 'attachment_id' => true, 'include_meta_data' => false, 'delimiter' => true, 'array_separator' => true, 'include_meta_data_columns' => true]
$openAPINullablesSetToNull
If a nullable field gets set to null, insert it here
protected
array<string|int, mixed>
$openAPINullablesSetToNull
= []
$openAPITypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPITypes
= ['ai_transform_id' => 'string', 'ai_mapping_id' => 'string', 'flatten_arrays' => 'bool', 'since' => '\\DateTime', 'before' => '\\DateTime', 'format' => 'string', 'inbox_id' => 'string', 'phone_id' => 'string', 'email_id' => 'string', 'sms_id' => 'string', 'attachment_id' => 'string', 'include_meta_data' => 'bool', 'delimiter' => 'string', 'array_separator' => 'string', 'include_meta_data_columns' => 'string[]']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['ai_transform_id' => 'setAiTransformId', 'ai_mapping_id' => 'setAiMappingId', 'flatten_arrays' => 'setFlattenArrays', 'since' => 'setSince', 'before' => 'setBefore', 'format' => 'setFormat', 'inbox_id' => 'setInboxId', 'phone_id' => 'setPhoneId', 'email_id' => 'setEmailId', 'sms_id' => 'setSmsId', 'attachment_id' => 'setAttachmentId', 'include_meta_data' => 'setIncludeMetaData', 'delimiter' => 'setDelimiter', 'array_separator' => 'setArraySeparator', 'include_meta_data_columns' => 'setIncludeMetaDataColumns']
Methods
__construct()
Constructor
public
__construct([array<string|int, mixed> $data = null ]) : mixed
Parameters
- $data : array<string|int, mixed> = null
-
Associated array of property values initializing the model
Return values
mixed —__toString()
Gets the string presentation of the object
public
__toString() : string
Return values
string —attributeMap()
Array of attributes where the key is the local name, and the value is the original name
public
static attributeMap() : array<string|int, mixed>
Return values
array<string|int, mixed> —getAiMappingId()
Gets ai_mapping_id
public
getAiMappingId() : string|null
Return values
string|null —getAiTransformId()
Gets ai_transform_id
public
getAiTransformId() : string|null
Return values
string|null —getArraySeparator()
Gets array_separator
public
getArraySeparator() : string|null
Return values
string|null —getAttachmentId()
Gets attachment_id
public
getAttachmentId() : string|null
Return values
string|null —getBefore()
Gets before
public
getBefore() : DateTime|null
Return values
DateTime|null —getDelimiter()
Gets delimiter
public
getDelimiter() : string|null
Return values
string|null —getEmailId()
Gets email_id
public
getEmailId() : string|null
Return values
string|null —getFlattenArrays()
Gets flatten_arrays
public
getFlattenArrays() : bool
Return values
bool —getFormat()
Gets format
public
getFormat() : string
Return values
string —getFormatAllowableValues()
Gets allowable values of the enum
public
getFormatAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getInboxId()
Gets inbox_id
public
getInboxId() : string|null
Return values
string|null —getIncludeMetaData()
Gets include_meta_data
public
getIncludeMetaData() : bool
Return values
bool —getIncludeMetaDataColumns()
Gets include_meta_data_columns
public
getIncludeMetaDataColumns() : array<string|int, string>|null
Return values
array<string|int, string>|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getPhoneId()
Gets phone_id
public
getPhoneId() : string|null
Return values
string|null —getSince()
Gets since
public
getSince() : DateTime|null
Return values
DateTime|null —getSmsId()
Gets sms_id
public
getSmsId() : string|null
Return values
string|null —getters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —isNullable()
Checks if a property is nullable
public
static isNullable(string $property) : bool
Parameters
- $property : string
Return values
bool —isNullableSetToNull()
Checks if a nullable property is set to null.
public
isNullableSetToNull(string $property) : bool
Parameters
- $property : string
Return values
bool —jsonSerialize()
Serializes the object to a value that can be serialized natively by json_encode().
public
jsonSerialize() : mixed
Tags
Return values
mixed —Returns data which can be serialized by json_encode(), which is a value of any type other than a resource.
listInvalidProperties()
Show all the invalid properties with reasons.
public
listInvalidProperties() : array<string|int, mixed>
Return values
array<string|int, mixed> —invalid properties with reasons
offsetExists()
Returns true if offset exists. False otherwise.
public
offsetExists(int $offset) : bool
Parameters
- $offset : int
-
Offset
Return values
bool —offsetGet()
Gets offset.
public
offsetGet(int $offset) : mixed|null
Parameters
- $offset : int
-
Offset
Return values
mixed|null —offsetSet()
Sets value based on offset.
public
offsetSet(int|null $offset, mixed $value) : void
Parameters
- $offset : int|null
-
Offset
- $value : mixed
-
Value to be set
Return values
void —offsetUnset()
Unsets offset.
public
offsetUnset(int $offset) : void
Parameters
- $offset : int
-
Offset
Return values
void —openAPIFormats()
Array of property to format mappings. Used for (de)serialization
public
static openAPIFormats() : array<string|int, mixed>
Return values
array<string|int, mixed> —openAPITypes()
Array of property to type mappings. Used for (de)serialization
public
static openAPITypes() : array<string|int, mixed>
Return values
array<string|int, mixed> —setAiMappingId()
Sets ai_mapping_id
public
setAiMappingId(string|null $ai_mapping_id) : self
Parameters
- $ai_mapping_id : string|null
-
ai_mapping_id
Return values
self —setAiTransformId()
Sets ai_transform_id
public
setAiTransformId(string|null $ai_transform_id) : self
Parameters
- $ai_transform_id : string|null
-
ai_transform_id
Return values
self —setArraySeparator()
Sets array_separator
public
setArraySeparator(string|null $array_separator) : self
Parameters
- $array_separator : string|null
-
array_separator
Return values
self —setAttachmentId()
Sets attachment_id
public
setAttachmentId(string|null $attachment_id) : self
Parameters
- $attachment_id : string|null
-
attachment_id
Return values
self —setBefore()
Sets before
public
setBefore(DateTime|null $before) : self
Parameters
- $before : DateTime|null
-
before
Return values
self —setDelimiter()
Sets delimiter
public
setDelimiter(string|null $delimiter) : self
Parameters
- $delimiter : string|null
-
delimiter
Return values
self —setEmailId()
Sets email_id
public
setEmailId(string|null $email_id) : self
Parameters
- $email_id : string|null
-
email_id
Return values
self —setFlattenArrays()
Sets flatten_arrays
public
setFlattenArrays(bool $flatten_arrays) : self
Parameters
- $flatten_arrays : bool
-
flatten_arrays
Return values
self —setFormat()
Sets format
public
setFormat(string $format) : self
Parameters
- $format : string
-
format
Return values
self —setInboxId()
Sets inbox_id
public
setInboxId(string|null $inbox_id) : self
Parameters
- $inbox_id : string|null
-
inbox_id
Return values
self —setIncludeMetaData()
Sets include_meta_data
public
setIncludeMetaData(bool $include_meta_data) : self
Parameters
- $include_meta_data : bool
-
include_meta_data
Return values
self —setIncludeMetaDataColumns()
Sets include_meta_data_columns
public
setIncludeMetaDataColumns(array<string|int, string>|null $include_meta_data_columns) : self
Parameters
- $include_meta_data_columns : array<string|int, string>|null
-
include_meta_data_columns
Return values
self —setPhoneId()
Sets phone_id
public
setPhoneId(string|null $phone_id) : self
Parameters
- $phone_id : string|null
-
phone_id
Return values
self —setSince()
Sets since
public
setSince(DateTime|null $since) : self
Parameters
- $since : DateTime|null
-
since
Return values
self —setSmsId()
Sets sms_id
public
setSmsId(string|null $sms_id) : self
Parameters
- $sms_id : string|null
-
sms_id
Return values
self —setters()
Array of attributes to setter functions (for deserialization of responses)
public
static setters() : array<string|int, mixed>
Return values
array<string|int, mixed> —toHeaderValue()
Gets a header-safe presentation of the object
public
toHeaderValue() : string
Return values
string —valid()
Validate all the properties in the model return true if all passed
public
valid() : bool
Return values
bool —True if all properties are valid
openAPINullables()
Array of nullable properties
protected
static openAPINullables() : array<string|int, mixed>
Return values
array<string|int, mixed> —getOpenAPINullablesSetToNull()
Array of nullable field names deliberately set to null
private
getOpenAPINullablesSetToNull() : array<string|int, bool>
Return values
array<string|int, bool> —setIfExists()
Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the $this->openAPINullablesSetToNull array
private
setIfExists(string $variableName, array<string|int, mixed> $fields, mixed $defaultValue) : void
Parameters
- $variableName : string
- $fields : array<string|int, mixed>
- $defaultValue : mixed
Return values
void —setOpenAPINullablesSetToNull()
Setter - Array of nullable field names deliberately set to null
private
setOpenAPINullablesSetToNull(array<string|int, bool> $openAPINullablesSetToNull) : void
Parameters
- $openAPINullablesSetToNull : array<string|int, bool>