Documentation

Session
in package
implements ModelInterface, ArrayAccess, JsonSerializable

Session Class Doc Comment

Tags
category

Class

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
KIND_ACCOUNT  : mixed = 'account'
KIND_ANONYMOUS  : mixed = 'anonymous'
KIND_ANONYMOUS_TOKEN  : mixed = 'anonymous_token'
KIND_API_TOKEN  : mixed = 'api_token'
KIND_DELEGATED  : mixed = 'delegated'
KIND_OAUTH  : mixed = 'oauth'
KIND_SYSTEM  : mixed = 'system'
KIND_WORKSPACE  : mixed = 'workspace'

Properties

$attributeMap  : array<string|int, 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|int, string>
Array of attributes to getter functions (for serialization of requests)
$openAPIFormats  : array<string|int, string>
Array of property to format mappings. Used for (de)serialization
$openAPIModelName  : string
The original name of the model.
$openAPINullables  : array<string|int, bool>
Array of nullable properties. Used for (de)serialization
$openAPINullablesSetToNull  : array<string|int, bool>
If a nullable field gets set to null, insert it here
$openAPITypes  : array<string|int, string>
Array of property to type mappings. Used for (de)serialization
$setters  : array<string|int, 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|int, mixed>
Array of attributes where the key is the local name, and the value is the original name
getAccount()  : SessionAccount|null
Gets account
getExpires()  : DateTime|null
Gets expires
getKind()  : string|null
Gets kind
getKindAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getModelName()  : string
The original name of the model.
getNodeUuids()  : array<string|int, string>|null
Gets node_uuids
getRootNodeUuid()  : string|null
Gets root_node_uuid
getScopes()  : array<string|int, string>|null
Gets scopes
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getUsername()  : string|null
Gets username
getVersionUuids()  : array<string|int, string>|null
Gets version_uuids
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, mixed>
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|int, mixed>
Array of property to format mappings. Used for (de)serialization
openAPITypes()  : array<string|int, mixed>
Array of property to type mappings. Used for (de)serialization
setAccount()  : self
Sets account
setExpires()  : self
Sets expires
setKind()  : self
Sets kind
setNodeUuids()  : self
Sets node_uuids
setRootNodeUuid()  : self
Sets root_node_uuid
setScopes()  : self
Sets scopes
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setUsername()  : self
Sets username
setVersionUuids()  : self
Sets version_uuids
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|int, mixed>
Array of nullable properties
getOpenAPINullablesSetToNull()  : array<string|int, bool>
Array of nullable field names deliberately set to null
setIfExists()  : 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
setOpenAPINullablesSetToNull()  : void
Setter - Array of nullable field names deliberately set to null

Constants

DISCRIMINATOR

public mixed DISCRIMINATOR = null

KIND_ACCOUNT

public mixed KIND_ACCOUNT = 'account'

KIND_ANONYMOUS

public mixed KIND_ANONYMOUS = 'anonymous'

KIND_ANONYMOUS_TOKEN

public mixed KIND_ANONYMOUS_TOKEN = 'anonymous_token'

KIND_API_TOKEN

public mixed KIND_API_TOKEN = 'api_token'

KIND_DELEGATED

public mixed KIND_DELEGATED = 'delegated'

KIND_OAUTH

public mixed KIND_OAUTH = 'oauth'

KIND_SYSTEM

public mixed KIND_SYSTEM = 'system'

KIND_WORKSPACE

public mixed KIND_WORKSPACE = 'workspace'

Properties

$attributeMap

Array of attributes where the key is the local name, and the value is the original name

protected static array<string|int, string> $attributeMap = ['kind' => 'kind', 'username' => 'username', 'expires' => 'expires', 'scopes' => 'scopes', 'root_node_uuid' => 'root_node_uuid', 'node_uuids' => 'node_uuids', 'version_uuids' => 'version_uuids', 'account' => 'account']

$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|int, string> $getters = ['kind' => 'getKind', 'username' => 'getUsername', 'expires' => 'getExpires', 'scopes' => 'getScopes', 'root_node_uuid' => 'getRootNodeUuid', 'node_uuids' => 'getNodeUuids', 'version_uuids' => 'getVersionUuids', 'account' => 'getAccount']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['kind' => null, 'username' => null, 'expires' => 'date-time', 'scopes' => null, 'root_node_uuid' => 'uuid', 'node_uuids' => 'uuid', 'version_uuids' => 'uuid', 'account' => null]
Tags
phpstan-var

array<string, string|null>

psalm-var

array<string, string|null>

$openAPIModelName

The original name of the model.

protected static string $openAPIModelName = 'Session'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, bool> $openAPINullables = ['kind' => false, 'username' => false, 'expires' => false, 'scopes' => false, 'root_node_uuid' => false, 'node_uuids' => false, 'version_uuids' => false, 'account' => false]

$openAPINullablesSetToNull

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

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

$openAPITypes

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

protected static array<string|int, string> $openAPITypes = ['kind' => 'string', 'username' => 'string', 'expires' => '\DateTime', 'scopes' => 'string[]', 'root_node_uuid' => 'string', 'node_uuids' => 'string[]', 'version_uuids' => 'string[]', 'account' => '\BIMworks\Model\SessionAccount']

$setters

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

protected static array<string|int, string> $setters = ['kind' => 'setKind', 'username' => 'setUsername', 'expires' => 'setExpires', 'scopes' => 'setScopes', 'root_node_uuid' => 'setRootNodeUuid', 'node_uuids' => 'setNodeUuids', 'version_uuids' => 'setVersionUuids', 'account' => 'setAccount']

Methods

__construct()

Constructor

public __construct([array<string|int, mixed>|null $data = null ]) : mixed
Parameters
$data : array<string|int, mixed>|null = 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|int, mixed>
Return values
array<string|int, mixed>

getExpires()

Gets expires

public getExpires() : DateTime|null
Return values
DateTime|null

getKind()

Gets kind

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

getKindAllowableValues()

Gets allowable values of the enum

public getKindAllowableValues() : array<string|int, string>
Return values
array<string|int, string>

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getNodeUuids()

Gets node_uuids

public getNodeUuids() : array<string|int, string>|null
Return values
array<string|int, string>|null

getRootNodeUuid()

Gets root_node_uuid

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

getScopes()

Gets scopes

public getScopes() : array<string|int, string>|null
Return values
array<string|int, string>|null

getters()

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

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

getUsername()

Gets username

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

getVersionUuids()

Gets version_uuids

public getVersionUuids() : array<string|int, string>|null
Return values
array<string|int, 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

jsonSerialize()

Serializes the object to a value that can be serialized natively by json_encode().

public jsonSerialize() : mixed
Tags
link
https://www.php.net/manual/en/jsonserializable.jsonserialize.php
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, mixed>
Return values
array<string|int, mixed> —

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|null $offset, mixed $value) : void
Parameters
$offset : int|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|int, mixed>
Return values
array<string|int, mixed>

openAPITypes()

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

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

setExpires()

Sets expires

public setExpires(DateTime|null $expires) : self
Parameters
$expires : DateTime|null

When the credential expires (UTC)

Return values
self

setKind()

Sets kind

public setKind(string|null $kind) : self
Parameters
$kind : string|null

What the credential is

Return values
self

setNodeUuids()

Sets node_uuids

public setNodeUuids(array<string|int, string>|null $node_uuids) : self
Parameters
$node_uuids : array<string|int, string>|null

For a nodes token (CreateNodesToken), the Nodes it names

Return values
self

setRootNodeUuid()

Sets root_node_uuid

public setRootNodeUuid(string|null $root_node_uuid) : self
Parameters
$root_node_uuid : string|null

The Node it is rooted at; absent for a nodes or versions token, which has none

Return values
self

setScopes()

Sets scopes

public setScopes(array<string|int, string>|null $scopes) : self
Parameters
$scopes : array<string|int, string>|null

The scopes it grants; absent when it is unscoped

Return values
self

setters()

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

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

setUsername()

Sets username

public setUsername(string|null $username) : self
Parameters
$username : string|null

The account (or, for an API token, the account that created it)

Return values
self

setVersionUuids()

Sets version_uuids

public setVersionUuids(array<string|int, string>|null $version_uuids) : self
Parameters
$version_uuids : array<string|int, string>|null

For a versions token (CreateVersionsToken), the Versions it names

Return values
self

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

getOpenAPINullablesSetToNull()

Array of nullable field names deliberately set to null

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

setIfExists()

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

setOpenAPINullablesSetToNull()

Setter - Array of nullable field names deliberately set to null

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

Search results