Documentation

LinkedDataFacts
in package
implements ModelInterface, ArrayAccess, JsonSerializable

LinkedDataFacts Class Doc Comment

Tags
description

What the server read from a file's content (an archive's entries, an image's size and EXIF)

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
getEntries()  : array<string|int, LinkedDataArchiveEntry>|null
Gets entries
getEntryCount()  : int|null
Gets entry_count
getHeight()  : int|null
Gets height
getLocation()  : bool|null
Gets location
getMetadataKept()  : string|null
Gets metadata_kept
getMetadataStripped()  : bool|null
Gets metadata_stripped
getModelName()  : string
The original name of the model.
getTakenOn()  : string|null
Gets taken_on
getters()  : array<string, string>
Array of attributes to getter functions (for serialization of requests)
getWidth()  : int|null
Gets width
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
setEntries()  : $this
Sets entries
setEntryCount()  : $this
Sets entry_count
setHeight()  : $this
Sets height
setLocation()  : $this
Sets location
setMetadataKept()  : $this
Sets metadata_kept
setMetadataStripped()  : $this
Sets metadata_stripped
setTakenOn()  : $this
Sets taken_on
setters()  : array<string, string>
Array of attributes to setter functions (for deserialization of responses)
setWidth()  : $this
Sets width
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 = ['entries' => 'entries', 'entry_count' => 'entry_count', 'width' => 'width', 'height' => 'height', 'taken_on' => 'taken_on', 'location' => 'location', 'metadata_stripped' => 'metadata_stripped', 'metadata_kept' => 'metadata_kept']

$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 = ['entries' => 'getEntries', 'entry_count' => 'getEntryCount', 'width' => 'getWidth', 'height' => 'getHeight', 'taken_on' => 'getTakenOn', 'location' => 'getLocation', 'metadata_stripped' => 'getMetadataStripped', 'metadata_kept' => 'getMetadataKept']

$openAPIFormats

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

protected static array<string, string|null> $openAPIFormats = ['entries' => null, 'entry_count' => 'int64', 'width' => 'int64', 'height' => 'int64', 'taken_on' => null, 'location' => null, 'metadata_stripped' => null, 'metadata_kept' => null]

$openAPIModelName

The original name of the model.

protected static string $openAPIModelName = 'LinkedDataFacts'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string, bool> $openAPINullables = ['entries' => false, 'entry_count' => false, 'width' => false, 'height' => false, 'taken_on' => false, 'location' => false, 'metadata_stripped' => false, 'metadata_kept' => 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 = ['entries' => '\BIMworks\Model\LinkedDataArchiveEntry[]', 'entry_count' => 'int', 'width' => 'int', 'height' => 'int', 'taken_on' => 'string', 'location' => 'bool', 'metadata_stripped' => 'bool', 'metadata_kept' => 'string']

$setters

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

protected static array<string, string> $setters = ['entries' => 'setEntries', 'entry_count' => 'setEntryCount', 'width' => 'setWidth', 'height' => 'setHeight', 'taken_on' => 'setTakenOn', 'location' => 'setLocation', 'metadata_stripped' => 'setMetadataStripped', 'metadata_kept' => 'setMetadataKept']

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>

getEntryCount()

Gets entry_count

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

getHeight()

Gets height

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

getLocation()

Gets location

public getLocation() : bool|null
Return values
bool|null

getMetadataKept()

Gets metadata_kept

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

getMetadataStripped()

Gets metadata_stripped

public getMetadataStripped() : bool|null
Return values
bool|null

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getTakenOn()

Gets taken_on

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

getters()

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

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

getWidth()

Gets width

public getWidth() : 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>

setEntryCount()

Sets entry_count

public setEntryCount(int|null $entry_count) : $this
Parameters
$entry_count : int|null

The entries of an archive

Return values
$this

setHeight()

Sets height

public setHeight(int|null $height) : $this
Parameters
$height : int|null

An image's height in pixels

Return values
$this

setLocation()

Sets location

public setLocation(bool|null $location) : $this
Parameters
$location : bool|null

The photo holds a GPS position

Return values
$this

setMetadataKept()

Sets metadata_kept

public setMetadataKept(string|null $metadata_kept) : $this
Parameters
$metadata_kept : string|null

Why strip_metadata kept them (a HEIC or TIFF is stored as it is)

Return values
$this

setMetadataStripped()

Sets metadata_stripped

public setMetadataStripped(bool|null $metadata_stripped) : $this
Parameters
$metadata_stripped : bool|null

The location and camera details were removed on upload (strip_metadata)

Return values
$this

setTakenOn()

Sets taken_on

public setTakenOn(string|null $taken_on) : $this
Parameters
$taken_on : string|null

When a photo was taken (EXIF), local time without a zone, for example 2024-05-17T10:11:12

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>

setWidth()

Sets width

public setWidth(int|null $width) : $this
Parameters
$width : int|null

An image's width in pixels

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