Documentation

CompareCounts
in package
implements ModelInterface, ArrayAccess, JsonSerializable

CompareCounts Class Doc Comment

Tags
author

OpenAPI Generator team

link
https://openapi-generator.tech
implements

Table of Contents

Interfaces

ModelInterface
Interface abstracting model access.
ArrayAccess
JsonSerializable

Constants

DISCRIMINATOR  : mixed = null

Properties

$attributeMap  : array<string, 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, string>
Array of attributes to getter functions (for serialization of requests)
$openAPIFormats  : array<string, string|null>
Array of property to format mappings. Used for (de)serialization
$openAPIModelName  : string
The original name of the model.
$openAPINullables  : array<string, bool>
Array of nullable properties. Used for (de)serialization
$openAPINullablesSetToNull  : array<string, bool>
If a nullable field gets set to null, insert it here
$openAPITypes  : array<string, string>
Array of property to type mappings. Used for (de)serialization
$setters  : array<string, string>
Array of attributes to setter functions (for deserialization of responses)

Methods

__construct()  : mixed
Constructor
__toString()  : string
Gets the string presentation of the object
attributeMap()  : array<string, string>
Array of attributes where the key is the local name, and the value is the original name
getAdded()  : int|null
Gets added
getChanged()  : int|null
Gets changed
getIgnored()  : int|null
Gets ignored
getModelName()  : string
The original name of the model.
getRemoved()  : int|null
Gets removed
getters()  : array<string, string>
Array of attributes to getter functions (for serialization of requests)
getUnchanged()  : int|null
Gets unchanged
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, string>
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, string|null>
Array of property to format mappings. Used for (de)serialization
openAPITypes()  : array<string, string>
Array of property to type mappings. Used for (de)serialization
setAdded()  : $this
Sets added
setChanged()  : $this
Sets changed
setIgnored()  : $this
Sets ignored
setRemoved()  : $this
Sets removed
setters()  : array<string, string>
Array of attributes to setter functions (for deserialization of responses)
setUnchanged()  : $this
Sets unchanged
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, bool>
Array of nullable properties
fillIfExists()  : 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
getOpenAPINullablesSetToNull()  : array<string, bool>
Array of nullable field names deliberately set to null
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, string> $attributeMap = ['added' => 'added', 'removed' => 'removed', 'changed' => 'changed', 'unchanged' => 'unchanged', 'ignored' => 'ignored']

$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, string> $getters = ['added' => 'getAdded', 'removed' => 'getRemoved', 'changed' => 'getChanged', 'unchanged' => 'getUnchanged', 'ignored' => 'getIgnored']

$openAPIFormats

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

protected static array<string, string|null> $openAPIFormats = ['added' => null, 'removed' => null, 'changed' => null, 'unchanged' => null, 'ignored' => null]

$openAPIModelName

The original name of the model.

protected static string $openAPIModelName = 'CompareCounts'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string, bool> $openAPINullables = ['added' => false, 'removed' => false, 'changed' => false, 'unchanged' => false, 'ignored' => false]

$openAPINullablesSetToNull

If a nullable field gets set to null, insert it here

protected array<string, bool> $openAPINullablesSetToNull = []

$openAPITypes

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

protected static array<string, string> $openAPITypes = ['added' => 'int', 'removed' => 'int', 'changed' => 'int', 'unchanged' => 'int', 'ignored' => 'int']

$setters

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

protected static array<string, string> $setters = ['added' => 'setAdded', 'removed' => 'setRemoved', 'changed' => 'setChanged', 'unchanged' => 'setUnchanged', 'ignored' => 'setIgnored']

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

__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, string>
Return values
array<string, string>

getAdded()

Gets added

public getAdded() : int|null
Return values
int|null

getChanged()

Gets changed

public getChanged() : int|null
Return values
int|null

getIgnored()

Gets ignored

public getIgnored() : int|null
Return values
int|null

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getRemoved()

Gets removed

public getRemoved() : int|null
Return values
int|null

getters()

Array of attributes to getter functions (for serialization of requests)

public static getters() : array<string, string>
Return values
array<string, string>

getUnchanged()

Gets unchanged

public getUnchanged() : int|null
Return values
int|null

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, string>
Return values
array<string|int, string> —

invalid properties with reasons

offsetExists()

Returns true if offset exists. False otherwise.

public offsetExists(int|string $offset) : bool
Parameters
$offset : int|string

Offset

Return values
bool

offsetGet()

Gets offset.

public offsetGet(int|string $offset) : mixed|null
Parameters
$offset : int|string

Offset

Attributes
#[ReturnTypeWillChange]
Return values
mixed|null

offsetSet()

Sets value based on offset.

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

Offset

$value : mixed

Value to be set

offsetUnset()

Unsets offset.

public offsetUnset(int|string $offset) : void
Parameters
$offset : int|string

Offset

openAPIFormats()

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

public static openAPIFormats() : array<string, string|null>
Return values
array<string, string|null>

openAPITypes()

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

public static openAPITypes() : array<string, string>
Return values
array<string, string>

setAdded()

Sets added

public setAdded(int|null $added) : $this
Parameters
$added : int|null

added

Return values
$this

setChanged()

Sets changed

public setChanged(int|null $changed) : $this
Parameters
$changed : int|null

changed

Return values
$this

setIgnored()

Sets ignored

public setIgnored(int|null $ignored) : $this
Parameters
$ignored : int|null

ignored

Return values
$this

setRemoved()

Sets removed

public setRemoved(int|null $removed) : $this
Parameters
$removed : int|null

removed

Return values
$this

setters()

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

public static setters() : array<string, string>
Return values
array<string, string>

setUnchanged()

Sets unchanged

public setUnchanged(int|null $unchanged) : $this
Parameters
$unchanged : int|null

unchanged

Return values
$this

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, bool>
Return values
array<string, bool>

fillIfExists()

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 fillIfExists(string $variableName, array<string|int, mixed> $fields, mixed $defaultValue) : void
Parameters
$variableName : string
$fields : array<string|int, mixed>
$defaultValue : mixed

getOpenAPINullablesSetToNull()

Array of nullable field names deliberately set to null

private getOpenAPINullablesSetToNull() : array<string, bool>
Return values
array<string, bool>

setOpenAPINullablesSetToNull()

Setter - Array of nullable field names deliberately set to null

private setOpenAPINullablesSetToNull(array<string, bool> $openAPINullablesSetToNull) : void
Parameters
$openAPINullablesSetToNull : array<string, bool>
On this page

Search results