LinkedDataPolicy
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
LinkedDataPolicy 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
- getCategories() : array<string|int, string>|null
- Gets categories
- getDenied() : array<string|int, string>|null
- Gets denied
- getFamilies() : array<string|int, LinkedDataFileFamily>|null
- Gets families
- getIdentifierSystems() : array<string, string>|null
- Gets identifier_systems
- getMaxFileBytes() : int|null
- Gets max_file_bytes
- getMaxFilesPerRequest() : int|null
- Gets max_files_per_request
- getMaxInlineBytes() : int|null
- Gets max_inline_bytes
- getMaxTargetsPerRequest() : int|null
- Gets max_targets_per_request
- getModelName() : string
- The original name of the model.
- getRetentionDays() : int|null
- Gets retention_days
- getters() : array<string, string>
- Array of attributes to getter functions (for serialization of requests)
- getUrlSchemes() : array<string|int, string>|null
- Gets url_schemes
- 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
- setCategories() : $this
- Sets categories
- setDenied() : $this
- Sets denied
- setFamilies() : $this
- Sets families
- setIdentifierSystems() : $this
- Sets identifier_systems
- setMaxFileBytes() : $this
- Sets max_file_bytes
- setMaxFilesPerRequest() : $this
- Sets max_files_per_request
- setMaxInlineBytes() : $this
- Sets max_inline_bytes
- setMaxTargetsPerRequest() : $this
- Sets max_targets_per_request
- setRetentionDays() : $this
- Sets retention_days
- setters() : array<string, string>
- Array of attributes to setter functions (for deserialization of responses)
- setUrlSchemes() : $this
- Sets url_schemes
- 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
= ['families' => 'families', 'denied' => 'denied', 'max_file_bytes' => 'max_file_bytes', 'max_inline_bytes' => 'max_inline_bytes', 'max_files_per_request' => 'max_files_per_request', 'max_targets_per_request' => 'max_targets_per_request', 'categories' => 'categories', 'identifier_systems' => 'identifier_systems', 'url_schemes' => 'url_schemes', 'retention_days' => 'retention_days']
$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
= ['families' => 'getFamilies', 'denied' => 'getDenied', 'max_file_bytes' => 'getMaxFileBytes', 'max_inline_bytes' => 'getMaxInlineBytes', 'max_files_per_request' => 'getMaxFilesPerRequest', 'max_targets_per_request' => 'getMaxTargetsPerRequest', 'categories' => 'getCategories', 'identifier_systems' => 'getIdentifierSystems', 'url_schemes' => 'getUrlSchemes', 'retention_days' => 'getRetentionDays']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string, string|null>
$openAPIFormats
= ['families' => null, 'denied' => null, 'max_file_bytes' => 'int64', 'max_inline_bytes' => null, 'max_files_per_request' => null, 'max_targets_per_request' => null, 'categories' => null, 'identifier_systems' => null, 'url_schemes' => null, 'retention_days' => null]
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'LinkedDataPolicy'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string, bool>
$openAPINullables
= ['families' => false, 'denied' => false, 'max_file_bytes' => false, 'max_inline_bytes' => false, 'max_files_per_request' => false, 'max_targets_per_request' => false, 'categories' => false, 'identifier_systems' => false, 'url_schemes' => false, 'retention_days' => 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
= ['families' => '\BIMworks\Model\LinkedDataFileFamily[]', 'denied' => 'string[]', 'max_file_bytes' => 'int', 'max_inline_bytes' => 'int', 'max_files_per_request' => 'int', 'max_targets_per_request' => 'int', 'categories' => 'string[]', 'identifier_systems' => 'array<string,string>', 'url_schemes' => 'string[]', 'retention_days' => 'int']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string, string>
$setters
= ['families' => 'setFamilies', 'denied' => 'setDenied', 'max_file_bytes' => 'setMaxFileBytes', 'max_inline_bytes' => 'setMaxInlineBytes', 'max_files_per_request' => 'setMaxFilesPerRequest', 'max_targets_per_request' => 'setMaxTargetsPerRequest', 'categories' => 'setCategories', 'identifier_systems' => 'setIdentifierSystems', 'url_schemes' => 'setUrlSchemes', 'retention_days' => 'setRetentionDays']
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>getCategories()
Gets categories
public
getCategories() : array<string|int, string>|null
Return values
array<string|int, string>|nullgetDenied()
Gets denied
public
getDenied() : array<string|int, string>|null
Return values
array<string|int, string>|nullgetFamilies()
Gets families
public
getFamilies() : array<string|int, LinkedDataFileFamily>|null
Return values
array<string|int, LinkedDataFileFamily>|nullgetIdentifierSystems()
Gets identifier_systems
public
getIdentifierSystems() : array<string, string>|null
Return values
array<string, string>|nullgetMaxFileBytes()
Gets max_file_bytes
public
getMaxFileBytes() : int|null
Return values
int|nullgetMaxFilesPerRequest()
Gets max_files_per_request
public
getMaxFilesPerRequest() : int|null
Return values
int|nullgetMaxInlineBytes()
Gets max_inline_bytes
public
getMaxInlineBytes() : int|null
Return values
int|nullgetMaxTargetsPerRequest()
Gets max_targets_per_request
public
getMaxTargetsPerRequest() : int|null
Return values
int|nullgetModelName()
The original name of the model.
public
getModelName() : string
Return values
stringgetRetentionDays()
Gets retention_days
public
getRetentionDays() : int|null
Return values
int|nullgetters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string, string>
Return values
array<string, string>getUrlSchemes()
Gets url_schemes
public
getUrlSchemes() : array<string|int, string>|null
Return values
array<string|int, 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>setCategories()
Sets categories
public
setCategories(array<string|int, string>|null $categories) : $this
Parameters
- $categories : array<string|int, string>|null
-
The categories an item may have; "*" allows any
Return values
$thissetDenied()
Sets denied
public
setDenied(array<string|int, string>|null $denied) : $this
Parameters
- $denied : array<string|int, string>|null
-
The extensions never accepted, whatever the configuration
Return values
$thissetFamilies()
Sets families
public
setFamilies(array<string|int, LinkedDataFileFamily>|null $families) : $this
Parameters
- $families : array<string|int, LinkedDataFileFamily>|null
-
families
Return values
$thissetIdentifierSystems()
Sets identifier_systems
public
setIdentifierSystems(array<string, string>|null $identifier_systems) : $this
Parameters
- $identifier_systems : array<string, string>|null
-
The identifier systems this server knows, name to a URL template (
{value}is the identifier) that makes an identifier of that system a link
Return values
$thissetMaxFileBytes()
Sets max_file_bytes
public
setMaxFileBytes(int|null $max_file_bytes) : $this
Parameters
- $max_file_bytes : int|null
-
max_file_bytes
Return values
$thissetMaxFilesPerRequest()
Sets max_files_per_request
public
setMaxFilesPerRequest(int|null $max_files_per_request) : $this
Parameters
- $max_files_per_request : int|null
-
Items per LinkData call
Return values
$thissetMaxInlineBytes()
Sets max_inline_bytes
public
setMaxInlineBytes(int|null $max_inline_bytes) : $this
Parameters
- $max_inline_bytes : int|null
-
A text up to this size is kept in the item; a longer one is stored as a file
Return values
$thissetMaxTargetsPerRequest()
Sets max_targets_per_request
public
setMaxTargetsPerRequest(int|null $max_targets_per_request) : $this
Parameters
- $max_targets_per_request : int|null
-
max_targets_per_request
Return values
$thissetRetentionDays()
Sets retention_days
public
setRetentionDays(int|null $retention_days) : $this
Parameters
- $retention_days : int|null
-
How long a deleted item can be restored
Return values
$thissetters()
Array of attributes to setter functions (for deserialization of responses)
public
static setters() : array<string, string>
Return values
array<string, string>setUrlSchemes()
Sets url_schemes
public
setUrlSchemes(array<string|int, string>|null $url_schemes) : $this
Parameters
- $url_schemes : array<string|int, string>|null
-
url_schemes
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>