Documentation

ContactProjection
in package
implements ModelInterface, ArrayAccess, JsonSerializable

ContactProjection Class Doc Comment

Tags
category

Class

description

Email contact for address book

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
$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
getCompany()  : string|null
Gets company
getCreatedAt()  : DateTime
Gets created_at
getEmailAddress()  : string|null
Gets email_address
getEmailAddresses()  : array<string|int, string>|null
Gets email_addresses
getFirstName()  : string|null
Gets first_name
getGroupId()  : string|null
Gets group_id
getId()  : string
Gets id
getLastName()  : string|null
Gets last_name
getModelName()  : string
The original name of the model.
getOptOut()  : bool|null
Gets opt_out
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
setCompany()  : self
Sets company
setCreatedAt()  : self
Sets created_at
setEmailAddress()  : self
Sets email_address
setEmailAddresses()  : self
Sets email_addresses
setFirstName()  : self
Sets first_name
setGroupId()  : self
Sets group_id
setId()  : self
Sets id
setLastName()  : self
Sets last_name
setOptOut()  : self
Sets opt_out
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 = ['email_address' => 'emailAddress', 'email_addresses' => 'emailAddresses', 'first_name' => 'firstName', 'last_name' => 'lastName', 'company' => 'company', 'opt_out' => 'optOut', 'created_at' => 'createdAt', 'id' => 'id', 'group_id' => 'groupId']

$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 = ['email_address' => 'getEmailAddress', 'email_addresses' => 'getEmailAddresses', 'first_name' => 'getFirstName', 'last_name' => 'getLastName', 'company' => 'getCompany', 'opt_out' => 'getOptOut', 'created_at' => 'getCreatedAt', 'id' => 'getId', 'group_id' => 'getGroupId']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['email_address' => null, 'email_addresses' => null, 'first_name' => null, 'last_name' => null, 'company' => null, 'opt_out' => null, 'created_at' => 'date-time', 'id' => 'uuid', 'group_id' => 'uuid']
Tags
phpstan-var

array<string, string|null>

psalm-var

array<string, string|null>

$openAPIModelName

The original name of the model.

protected static string $openAPIModelName = 'ContactProjection'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, mixed> $openAPINullables = ['email_address' => true, 'email_addresses' => true, 'first_name' => true, 'last_name' => true, 'company' => true, 'opt_out' => true, 'created_at' => false, 'id' => false, 'group_id' => 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 = ['email_address' => 'string', 'email_addresses' => 'string[]', 'first_name' => 'string', 'last_name' => 'string', 'company' => 'string', 'opt_out' => 'bool', 'created_at' => '\\DateTime', 'id' => 'string', 'group_id' => 'string']

$setters

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

protected static array<string|int, string> $setters = ['email_address' => 'setEmailAddress', 'email_addresses' => 'setEmailAddresses', 'first_name' => 'setFirstName', 'last_name' => 'setLastName', 'company' => 'setCompany', 'opt_out' => 'setOptOut', 'created_at' => 'setCreatedAt', 'id' => 'setId', 'group_id' => 'setGroupId']

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>

getCompany()

Gets company

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

getCreatedAt()

Gets created_at

public getCreatedAt() : DateTime
Return values
DateTime

getEmailAddress()

Gets email_address

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

getEmailAddresses()

Gets email_addresses

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

getFirstName()

Gets first_name

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

getGroupId()

Gets group_id

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

getLastName()

Gets last_name

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

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getOptOut()

Gets opt_out

public getOptOut() : bool|null
Return values
bool|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

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>

setCompany()

Sets company

public setCompany(string|null $company) : self
Parameters
$company : string|null

company

Return values
self

setCreatedAt()

Sets created_at

public setCreatedAt(DateTime $created_at) : self
Parameters
$created_at : DateTime

created_at

Return values
self

setEmailAddress()

Sets email_address

public setEmailAddress(string|null $email_address) : self
Parameters
$email_address : string|null

email_address

Return values
self

setEmailAddresses()

Sets email_addresses

public setEmailAddresses(array<string|int, string>|null $email_addresses) : self
Parameters
$email_addresses : array<string|int, string>|null

email_addresses

Return values
self

setFirstName()

Sets first_name

public setFirstName(string|null $first_name) : self
Parameters
$first_name : string|null

first_name

Return values
self

setGroupId()

Sets group_id

public setGroupId(string|null $group_id) : self
Parameters
$group_id : string|null

group_id

Return values
self

setId()

Sets id

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

id

Return values
self

setLastName()

Sets last_name

public setLastName(string|null $last_name) : self
Parameters
$last_name : string|null

last_name

Return values
self

setOptOut()

Sets opt_out

public setOptOut(bool|null $opt_out) : self
Parameters
$opt_out : bool|null

opt_out

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