Documentation

PhonePoolLeaseDto
in package
implements ModelInterface, ArrayAccess, JsonSerializable

PhonePoolLeaseDto Class Doc Comment

Tags
category

Class

author

OpenAPI Generator team

link
https://openapi-generator.tech
implements

\ArrayAccess<string, mixed>

Interfaces, Classes, Traits and Enums

ModelInterface
Interface abstracting model access.
ArrayAccess
JsonSerializable

Table of Contents

DISCRIMINATOR  = null
PHONE_COUNTRY_AU  = 'AU'
PHONE_COUNTRY_CA  = 'CA'
PHONE_COUNTRY_CH  = 'CH'
PHONE_COUNTRY_EE  = 'EE'
PHONE_COUNTRY_FI  = 'FI'
PHONE_COUNTRY_GB  = 'GB'
PHONE_COUNTRY_HK  = 'HK'
PHONE_COUNTRY_IL  = 'IL'
PHONE_COUNTRY_NL  = 'NL'
PHONE_COUNTRY_PL  = 'PL'
PHONE_COUNTRY_PT  = 'PT'
PHONE_COUNTRY_SE  = 'SE'
PHONE_COUNTRY_US  = 'US'
$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
getExpiresAt()  : DateTime|null
Gets expires_at
getId()  : string
Gets id
getLeasedAt()  : DateTime
Gets leased_at
getLeaseName()  : string|null
Gets lease_name
getLeaseOwner()  : string|null
Gets lease_owner
getModelName()  : string
The original name of the model.
getPhoneCountry()  : string
Gets phone_country
getPhoneCountryAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getPhoneName()  : string|null
Gets phone_name
getPhoneNumber()  : string
Gets phone_number
getPhoneNumberId()  : string
Gets phone_number_id
getPoolId()  : string
Gets pool_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
setExpiresAt()  : self
Sets expires_at
setId()  : self
Sets id
setLeasedAt()  : self
Sets leased_at
setLeaseName()  : self
Sets lease_name
setLeaseOwner()  : self
Sets lease_owner
setPhoneCountry()  : self
Sets phone_country
setPhoneName()  : self
Sets phone_name
setPhoneNumber()  : self
Sets phone_number
setPhoneNumberId()  : self
Sets phone_number_id
setPoolId()  : self
Sets pool_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

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 = ['id' => 'id', 'pool_id' => 'poolId', 'phone_number_id' => 'phoneNumberId', 'phone_number' => 'phoneNumber', 'phone_country' => 'phoneCountry', 'phone_name' => 'phoneName', 'lease_name' => 'leaseName', 'lease_owner' => 'leaseOwner', 'leased_at' => 'leasedAt', 'expires_at' => 'expiresAt']

$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 = ['id' => 'getId', 'pool_id' => 'getPoolId', 'phone_number_id' => 'getPhoneNumberId', 'phone_number' => 'getPhoneNumber', 'phone_country' => 'getPhoneCountry', 'phone_name' => 'getPhoneName', 'lease_name' => 'getLeaseName', 'lease_owner' => 'getLeaseOwner', 'leased_at' => 'getLeasedAt', 'expires_at' => 'getExpiresAt']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['id' => 'uuid', 'pool_id' => 'uuid', 'phone_number_id' => 'uuid', 'phone_number' => null, 'phone_country' => null, 'phone_name' => null, 'lease_name' => null, 'lease_owner' => null, 'leased_at' => 'date-time', 'expires_at' => 'date-time']
Tags
phpstan-var

array<string, string|null>

psalm-var

array<string, string|null>

$openAPIModelName

The original name of the model.

protected static string $openAPIModelName = 'PhonePoolLeaseDto'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, mixed> $openAPINullables = ['id' => false, 'pool_id' => false, 'phone_number_id' => false, 'phone_number' => false, 'phone_country' => false, 'phone_name' => true, 'lease_name' => true, 'lease_owner' => true, 'leased_at' => false, 'expires_at' => 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 = ['id' => 'string', 'pool_id' => 'string', 'phone_number_id' => 'string', 'phone_number' => 'string', 'phone_country' => 'string', 'phone_name' => 'string', 'lease_name' => 'string', 'lease_owner' => 'string', 'leased_at' => '\\DateTime', 'expires_at' => '\\DateTime']

$setters

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

protected static array<string|int, string> $setters = ['id' => 'setId', 'pool_id' => 'setPoolId', 'phone_number_id' => 'setPhoneNumberId', 'phone_number' => 'setPhoneNumber', 'phone_country' => 'setPhoneCountry', 'phone_name' => 'setPhoneName', 'lease_name' => 'setLeaseName', 'lease_owner' => 'setLeaseOwner', 'leased_at' => 'setLeasedAt', 'expires_at' => 'setExpiresAt']

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> —

getExpiresAt()

Gets expires_at

public getExpiresAt() : DateTime|null
Return values
DateTime|null —

getLeasedAt()

Gets leased_at

public getLeasedAt() : DateTime
Return values
DateTime —

getLeaseName()

Gets lease_name

public getLeaseName() : string|null
Return values
string|null —

getLeaseOwner()

Gets lease_owner

public getLeaseOwner() : string|null
Return values
string|null —

getModelName()

The original name of the model.

public getModelName() : string
Return values
string —

getPhoneCountry()

Gets phone_country

public getPhoneCountry() : string
Return values
string —

getPhoneCountryAllowableValues()

Gets allowable values of the enum

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

getPhoneName()

Gets phone_name

public getPhoneName() : string|null
Return values
string|null —

getPhoneNumber()

Gets phone_number

public getPhoneNumber() : string
Return values
string —

getPhoneNumberId()

Gets phone_number_id

public getPhoneNumberId() : string
Return values
string —

getPoolId()

Gets pool_id

public getPoolId() : string
Return values
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) : 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> —

setExpiresAt()

Sets expires_at

public setExpiresAt(DateTime|null $expires_at) : self
Parameters
$expires_at : DateTime|null

expires_at

Return values
self —

setId()

Sets id

public setId(string $id) : self
Parameters
$id : string

id

Return values
self —

setLeasedAt()

Sets leased_at

public setLeasedAt(DateTime $leased_at) : self
Parameters
$leased_at : DateTime

leased_at

Return values
self —

setLeaseName()

Sets lease_name

public setLeaseName(string|null $lease_name) : self
Parameters
$lease_name : string|null

lease_name

Return values
self —

setLeaseOwner()

Sets lease_owner

public setLeaseOwner(string|null $lease_owner) : self
Parameters
$lease_owner : string|null

lease_owner

Return values
self —

setPhoneCountry()

Sets phone_country

public setPhoneCountry(string $phone_country) : self
Parameters
$phone_country : string

phone_country

Return values
self —

setPhoneName()

Sets phone_name

public setPhoneName(string|null $phone_name) : self
Parameters
$phone_name : string|null

phone_name

Return values
self —

setPhoneNumber()

Sets phone_number

public setPhoneNumber(string $phone_number) : self
Parameters
$phone_number : string

phone_number

Return values
self —

setPhoneNumberId()

Sets phone_number_id

public setPhoneNumberId(string $phone_number_id) : self
Parameters
$phone_number_id : string

phone_number_id

Return values
self —

setPoolId()

Sets pool_id

public setPoolId(string $pool_id) : self
Parameters
$pool_id : string

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

Search results