LinkedDataCounts
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
LinkedDataCounts Class Doc Comment
Tags
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
- getByFamily() : array<string, array<string|int, int>>|null
- Gets by_family
- getCheck() : array<string|int, int>|null
- Gets check
- getCounts() : LinkedDataCountTotals|null
- Gets counts
- getLater() : array<string|int, int>|null
- Gets later
- getMarkers() : array<string|int, LinkedDataMarker>|null
- Gets markers
- getModelName() : string
- The original name of the model.
- getNodeUuid() : string|null
- Gets node_uuid
- getObjects() : array<string|int, int>|null
- Gets objects
- getters() : array<string, string>
- Array of attributes to getter functions (for serialization of requests)
- getVersion() : int|null
- Gets version
- getVersionUuid() : string|null
- Gets version_uuid
- 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
- setByFamily() : $this
- Sets by_family
- setCheck() : $this
- Sets check
- setCounts() : $this
- Sets counts
- setLater() : $this
- Sets later
- setMarkers() : $this
- Sets markers
- setNodeUuid() : $this
- Sets node_uuid
- setObjects() : $this
- Sets objects
- setters() : array<string, string>
- Array of attributes to setter functions (for deserialization of responses)
- setVersion() : $this
- Sets version
- setVersionUuid() : $this
- Sets version_uuid
- 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
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
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
= ['version_uuid' => 'version_uuid', 'version' => 'version', 'node_uuid' => 'node_uuid', 'objects' => 'objects', 'check' => 'check', 'later' => 'later', 'by_family' => 'by_family', 'markers' => 'markers', 'counts' => 'counts']
$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
= ['version_uuid' => 'getVersionUuid', 'version' => 'getVersion', 'node_uuid' => 'getNodeUuid', 'objects' => 'getObjects', 'check' => 'getCheck', 'later' => 'getLater', 'by_family' => 'getByFamily', 'markers' => 'getMarkers', 'counts' => 'getCounts']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string, string|null>
$openAPIFormats
= ['version_uuid' => 'uuid', 'version' => null, 'node_uuid' => 'uuid', 'objects' => null, 'check' => null, 'later' => null, 'by_family' => null, 'markers' => null, 'counts' => null]
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'LinkedDataCounts'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string, bool>
$openAPINullables
= ['version_uuid' => false, 'version' => false, 'node_uuid' => false, 'objects' => false, 'check' => false, 'later' => false, 'by_family' => false, 'markers' => false, 'counts' => 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
= ['version_uuid' => 'string', 'version' => 'int', 'node_uuid' => 'string', 'objects' => 'int[]', 'check' => 'int[]', 'later' => 'int[]', 'by_family' => 'array<string,int[]>', 'markers' => '\BIMworks\Model\LinkedDataMarker[]', 'counts' => '\BIMworks\Model\LinkedDataCountTotals']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string, string>
$setters
= ['version_uuid' => 'setVersionUuid', 'version' => 'setVersion', 'node_uuid' => 'setNodeUuid', 'objects' => 'setObjects', 'check' => 'setCheck', 'later' => 'setLater', 'by_family' => 'setByFamily', 'markers' => 'setMarkers', 'counts' => 'setCounts']
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
stringattributeMap()
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>getByFamily()
Gets by_family
public
getByFamily() : array<string, array<string|int, int>>|null
Return values
array<string, array<string|int, int>>|nullgetCheck()
Gets check
public
getCheck() : array<string|int, int>|null
Return values
array<string|int, int>|nullgetCounts()
Gets counts
public
getCounts() : LinkedDataCountTotals|null
Return values
LinkedDataCountTotals|nullgetLater()
Gets later
public
getLater() : array<string|int, int>|null
Return values
array<string|int, int>|nullgetMarkers()
Gets markers
public
getMarkers() : array<string|int, LinkedDataMarker>|null
Return values
array<string|int, LinkedDataMarker>|nullgetModelName()
The original name of the model.
public
getModelName() : string
Return values
stringgetNodeUuid()
Gets node_uuid
public
getNodeUuid() : string|null
Return values
string|nullgetObjects()
Gets objects
public
getObjects() : array<string|int, int>|null
Return values
array<string|int, int>|nullgetters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string, string>
Return values
array<string, string>getVersion()
Gets version
public
getVersion() : int|null
Return values
int|nullgetVersionUuid()
Gets version_uuid
public
getVersionUuid() : string|null
Return values
string|nullisNullable()
Checks if a property is nullable
public
static isNullable(string $property) : bool
Parameters
- $property : string
Return values
boolisNullableSetToNull()
Checks if a nullable property is set to null.
public
isNullableSetToNull(string $property) : bool
Parameters
- $property : string
Return values
booljsonSerialize()
Serializes the object to a value that can be serialized natively by json_encode().
public
jsonSerialize() : mixed
Tags
Attributes
- #[ReturnTypeWillChange]
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, 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
booloffsetGet()
Gets offset.
public
offsetGet(int|string $offset) : mixed|null
Parameters
- $offset : int|string
-
Offset
Attributes
- #[ReturnTypeWillChange]
Return values
mixed|nulloffsetSet()
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>setByFamily()
Sets by_family
public
setByFamily(array<string, array<string|int, int>>|null $by_family) : $this
Parameters
- $by_family : array<string, array<string|int, int>>|null
-
The objects per file family (PDF, IMAGES, ...), or per kind for what is not a file (URL, TEXT, IDENTIFIER)
Return values
$thissetCheck()
Sets check
public
setCheck(array<string|int, int>|null $check) : $this
Parameters
- $check : array<string|int, int>|null
-
Those of them with a link to check
Return values
$thissetCounts()
Sets counts
public
setCounts(LinkedDataCountTotals|null $counts) : $this
Parameters
- $counts : LinkedDataCountTotals|null
-
counts
Return values
$thissetLater()
Sets later
public
setLater(array<string|int, int>|null $later) : $this
Parameters
- $later : array<string|int, int>|null
-
With include_later, the objects whose only links were made on later Versions
Return values
$thissetMarkers()
Sets markers
public
setMarkers(array<string|int, LinkedDataMarker>|null $markers) : $this
Parameters
- $markers : array<string|int, LinkedDataMarker>|null
-
markers
Return values
$thissetNodeUuid()
Sets node_uuid
public
setNodeUuid(string|null $node_uuid) : $this
Parameters
- $node_uuid : string|null
-
node_uuid
Return values
$thissetObjects()
Sets objects
public
setObjects(array<string|int, int>|null $objects) : $this
Parameters
- $objects : array<string|int, int>|null
-
The objects with linked data
Return values
$thissetters()
Array of attributes to setter functions (for deserialization of responses)
public
static setters() : array<string, string>
Return values
array<string, string>setVersion()
Sets version
public
setVersion(int|null $version) : $this
Parameters
- $version : int|null
-
version
Return values
$thissetVersionUuid()
Sets version_uuid
public
setVersionUuid(string|null $version_uuid) : $this
Parameters
- $version_uuid : string|null
-
version_uuid
Return values
$thistoHeaderValue()
Gets a header-safe presentation of the object
public
toHeaderValue() : string
Return values
stringvalid()
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>