Documentation

LinkedDataItemSpec
in package
implements ModelInterface, ArrayAccess, JsonSerializable

LinkedDataItemSpec Class Doc Comment

Tags
description

One item to link. Its value is `url`, `text`, `identifier` or, for a FILE, a `file` part

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
getCategory()  : string|null
Gets category
getContentType()  : string|null
Gets content_type
getDescription()  : string|null
Gets description
getFilename()  : string|null
Gets filename
getIdentifier()  : LinkedDataIdentifier|null
Gets identifier
getKind()  : LinkedDataKind
Gets kind
getModelName()  : string
The original name of the model.
getStream()  : int|null
Gets stream
getStripMetadata()  : bool|null
Gets strip_metadata
getters()  : array<string, string>
Array of attributes to getter functions (for serialization of requests)
getText()  : string|null
Gets text
getTitle()  : string|null
Gets title
getUrl()  : string|null
Gets url
getValidUntil()  : string|null
Gets valid_until
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
setCategory()  : $this
Sets category
setContentType()  : $this
Sets content_type
setDescription()  : $this
Sets description
setFilename()  : $this
Sets filename
setIdentifier()  : $this
Sets identifier
setKind()  : $this
Sets kind
setStream()  : $this
Sets stream
setStripMetadata()  : $this
Sets strip_metadata
setters()  : array<string, string>
Array of attributes to setter functions (for deserialization of responses)
setText()  : $this
Sets text
setTitle()  : $this
Sets title
setUrl()  : $this
Sets url
setValidUntil()  : $this
Sets valid_until
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 = ['kind' => 'kind', 'title' => 'title', 'description' => 'description', 'category' => 'category', 'valid_until' => 'valid_until', 'url' => 'url', 'text' => 'text', 'identifier' => 'identifier', 'filename' => 'filename', 'content_type' => 'content_type', 'stream' => 'stream', 'strip_metadata' => 'strip_metadata']

$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 = ['kind' => 'getKind', 'title' => 'getTitle', 'description' => 'getDescription', 'category' => 'getCategory', 'valid_until' => 'getValidUntil', 'url' => 'getUrl', 'text' => 'getText', 'identifier' => 'getIdentifier', 'filename' => 'getFilename', 'content_type' => 'getContentType', 'stream' => 'getStream', 'strip_metadata' => 'getStripMetadata']

$openAPIFormats

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

protected static array<string, string|null> $openAPIFormats = ['kind' => null, 'title' => null, 'description' => null, 'category' => null, 'valid_until' => null, 'url' => null, 'text' => null, 'identifier' => null, 'filename' => null, 'content_type' => null, 'stream' => null, 'strip_metadata' => null]

$openAPIModelName

The original name of the model.

protected static string $openAPIModelName = 'LinkedDataItemSpec'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string, bool> $openAPINullables = ['kind' => false, 'title' => false, 'description' => false, 'category' => false, 'valid_until' => false, 'url' => false, 'text' => false, 'identifier' => false, 'filename' => false, 'content_type' => false, 'stream' => false, 'strip_metadata' => 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 = ['kind' => '\BIMworks\Model\LinkedDataKind', 'title' => 'string', 'description' => 'string', 'category' => 'string', 'valid_until' => 'string', 'url' => 'string', 'text' => 'string', 'identifier' => '\BIMworks\Model\LinkedDataIdentifier', 'filename' => 'string', 'content_type' => 'string', 'stream' => 'int', 'strip_metadata' => 'bool']

$setters

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

protected static array<string, string> $setters = ['kind' => 'setKind', 'title' => 'setTitle', 'description' => 'setDescription', 'category' => 'setCategory', 'valid_until' => 'setValidUntil', 'url' => 'setUrl', 'text' => 'setText', 'identifier' => 'setIdentifier', 'filename' => 'setFilename', 'content_type' => 'setContentType', 'stream' => 'setStream', 'strip_metadata' => 'setStripMetadata']

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>

getCategory()

Gets category

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

getContentType()

Gets content_type

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

getDescription()

Gets description

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

getFilename()

Gets filename

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

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getStripMetadata()

Gets strip_metadata

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

getters()

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

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

getTitle()

Gets title

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

getValidUntil()

Gets valid_until

public getValidUntil() : string|null
Return values
string|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>

setCategory()

Sets category

public setCategory(string|null $category) : $this
Parameters
$category : string|null

One of the policy's categories

Return values
$this

setContentType()

Sets content_type

public setContentType(string|null $content_type) : $this
Parameters
$content_type : string|null

The media type the client declares (FILE); the server decides from the content

Return values
$this

setDescription()

Sets description

public setDescription(string|null $description) : $this
Parameters
$description : string|null

description

Return values
$this

setFilename()

Sets filename

public setFilename(string|null $filename) : $this
Parameters
$filename : string|null

The file name (FILE); the file part's own name when absent

Return values
$this

setStream()

Sets stream

public setStream(int|null $stream) : $this
Parameters
$stream : int|null

The position of the item's file among the file parts (FILE); by default the FILE items take the parts in order

Return values
$this

setStripMetadata()

Sets strip_metadata

public setStripMetadata(bool|null $strip_metadata) : $this
Parameters
$strip_metadata : bool|null

Remove a photo's location and camera details, losslessly and keeping its orientation (JPEG, PNG, WebP); a HEIC or TIFF is stored as it is, and facts.metadata_kept says why

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>

setText()

Sets text

public setText(string|null $text) : $this
Parameters
$text : string|null

The text (TEXT); a long one is stored as a file and the item keeps a preview

Return values
$this

setTitle()

Sets title

public setTitle(string|null $title) : $this
Parameters
$title : string|null

Without one, the file name without its extension, the URL's host, the identifier's system and value, or the text's first line

Return values
$this

setUrl()

Sets url

public setUrl(string|null $url) : $this
Parameters
$url : string|null

A URL with one of the policy's schemes (URL)

Return values
$this

setValidUntil()

Sets valid_until

public setValidUntil(string|null $valid_until) : $this
Parameters
$valid_until : string|null

A date, yyyy-mm-dd

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