Documentation

GetStatementsRequest
in package
implements ArrayAccess, JsonSerializable, ModelInterface

GetStatementsRequest Class Doc Comment.

Tags
category

Class

description

Request values for list of a statements.

author

OpenAPI Generator team

see
https://openapi-generator.tech
implements

\ArrayAccess<string, mixed>

Interfaces, Classes, Traits and Enums

ArrayAccess
JsonSerializable
ModelInterface
Interface abstracting model access.

Table of Contents

DISCRIMINATOR  = null
STATEMENT_LINE_ADDITIONAL  = 'ADDITIONAL'
STATEMENT_LINE_MAIN  = 'MAIN'
STATEMENT_LINE_MT940  = 'MT940'
$attributeMap  : array<string|int, mixed>
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, mixed>
Array of attributes to getter functions (for serialization of requests).
$openAPIFormats  : array<string|int, mixed>
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, mixed>
Array of property to type mappings. Used for (de)serialization.
$setters  : array<string|int, mixed>
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.
getAccountNumber()  : string
Gets accountNumber.
getCurrency()  : null|string
Gets currency.
getDateFrom()  : null|DateTime
Gets dateFrom.
getDateTo()  : null|DateTime
Gets dateTo.
getModelName()  : string
The original name of the model.
getStatementLine()  : null|string
Gets statementLine.
getStatementLineAllowableValues()  : array<string|int, string>
Gets allowable values of the enum.
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()  : null|mixed
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.
setAccountNumber()  : self
Sets accountNumber.
setCurrency()  : self
Sets currency.
setDateFrom()  : self
Sets dateFrom.
setDateTo()  : self
Sets dateTo.
setStatementLine()  : self
Sets statementLine.
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

Properties

$attributeMap

Array of attributes where the key is the local name, and the value is the original name.

protected static array<string|int, mixed> $attributeMap = ['accountNumber' => 'accountNumber', 'currency' => 'currency', 'statementLine' => 'statementLine', 'dateFrom' => 'dateFrom', 'dateTo' => 'dateTo']

$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, mixed> $getters = ['accountNumber' => 'getAccountNumber', 'currency' => 'getCurrency', 'statementLine' => 'getStatementLine', 'dateFrom' => 'getDateFrom', 'dateTo' => 'getDateTo']

$openAPIFormats

Array of property to format mappings. Used for (de)serialization.

protected static array<string|int, mixed> $openAPIFormats = ['accountNumber' => null, 'currency' => null, 'statementLine' => null, 'dateFrom' => 'date', 'dateTo' => 'date']
Tags
phpstan-var

array<string, string|null>

psalm-var

array<string, string|null>

$openAPIModelName

The original name of the model.

protected static string $openAPIModelName = 'getStatements_request'

$openAPINullables

Array of nullable properties. Used for (de)serialization.

protected static array<string|int, mixed> $openAPINullables = ['accountNumber' => false, 'currency' => false, 'statementLine' => false, 'dateFrom' => false, 'dateTo' => false]

$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, mixed> $openAPITypes = ['accountNumber' => 'string', 'currency' => 'string', 'statementLine' => 'string', 'dateFrom' => '\\DateTime', 'dateTo' => '\\DateTime']

$setters

Array of attributes to setter functions (for deserialization of responses).

protected static array<string|int, mixed> $setters = ['accountNumber' => 'setAccountNumber', 'currency' => 'setCurrency', 'statementLine' => 'setStatementLine', 'dateFrom' => 'setDateFrom', 'dateTo' => 'setDateTo']

Methods

__construct()

Constructor.

public __construct([null|array<string|int, mixed> $data = null ]) : mixed
Parameters
$data : null|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>

getAccountNumber()

Gets accountNumber.

public getAccountNumber() : string
Return values
string

getCurrency()

Gets currency.

public getCurrency() : null|string
Return values
null|string

getDateFrom()

Gets dateFrom.

public getDateFrom() : null|DateTime
Return values
null|DateTime

getDateTo()

Gets dateTo.

public getDateTo() : null|DateTime
Return values
null|DateTime

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getStatementLine()

Gets statementLine.

public getStatementLine() : null|string
Return values
null|string

getStatementLineAllowableValues()

Gets allowable values of the enum.

public getStatementLineAllowableValues() : array<string|int, string>
Return values
array<string|int, string>

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

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) : null|mixed
Parameters
$offset : int

Offset

Return values
null|mixed

offsetSet()

Sets value based on offset.

public offsetSet(null|int $offset, mixed $value) : void
Parameters
$offset : null|int

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>

setAccountNumber()

Sets accountNumber.

public setAccountNumber(string $accountNumber) : self
Parameters
$accountNumber : string

accountNumber

Return values
self

setCurrency()

Sets currency.

public setCurrency(null|string $currency) : self
Parameters
$currency : null|string

currency of the requested currency folder

Return values
self

setDateFrom()

Sets dateFrom.

public setDateFrom(null|DateTime $dateFrom) : self
Parameters
$dateFrom : null|DateTime

date limit from

Return values
self

setDateTo()

Sets dateTo.

public setDateTo(null|DateTime $dateTo) : self
Parameters
$dateTo : null|DateTime

date limit to

Return values
self

setStatementLine()

Sets statementLine.

public setStatementLine(null|string $statementLine) : self
Parameters
$statementLine : null|string

statement line identification

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>
Return values
void

Search results