Documentation

Action
in package
implements ModelInterface, ArrayAccess, JsonSerializable

Action 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
STATUS_ACTIVE  : mixed = 'ACTIVE'
STATUS_DELETED  : mixed = 'DELETED'

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
getCreatedAt()  : string|null
Gets created_at
getCreatedBy()  : string|null
Gets created_by
getDescription()  : string|null
Gets description
getEditable()  : bool|null
Gets editable
getFavourite()  : bool|null
Gets favourite
getFullPath()  : array<string|int, ActionFullPathInner>|null
Gets full_path
getMainType()  : string|null
Gets main_type
getModelName()  : string
The original name of the model.
getName()  : string|null
Gets name
getOutputHint()  : string|null
Gets output_hint
getParentUuid()  : string|null
Gets parent_uuid
getQuery()  : string|null
Gets query
getStatus()  : string|null
Gets status
getStatusAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getSubType()  : string|null
Gets sub_type
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getUpdatedAt()  : string|null
Gets updated_at
getUpdatedBy()  : string|null
Gets updated_by
getUuid()  : string|null
Gets uuid
getVersion()  : int|null
Gets version
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
setCreatedAt()  : self
Sets created_at
setCreatedBy()  : self
Sets created_by
setDescription()  : self
Sets description
setEditable()  : self
Sets editable
setFavourite()  : self
Sets favourite
setFullPath()  : self
Sets full_path
setMainType()  : self
Sets main_type
setName()  : self
Sets name
setOutputHint()  : self
Sets output_hint
setParentUuid()  : self
Sets parent_uuid
setQuery()  : self
Sets query
setStatus()  : self
Sets status
setSubType()  : self
Sets sub_type
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setUpdatedAt()  : self
Sets updated_at
setUpdatedBy()  : self
Sets updated_by
setUuid()  : self
Sets uuid
setVersion()  : self
Sets version
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

STATUS_ACTIVE

public mixed STATUS_ACTIVE = 'ACTIVE'

STATUS_DELETED

public mixed STATUS_DELETED = 'DELETED'

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 = ['uuid' => 'uuid', 'parent_uuid' => 'parent_uuid', 'name' => 'name', 'main_type' => 'main_type', 'sub_type' => 'sub_type', 'query' => 'query', 'description' => 'description', 'output_hint' => 'output_hint', 'favourite' => 'favourite', 'status' => 'status', 'version' => 'version', 'created_by' => 'created_by', 'created_at' => 'created_at', 'updated_by' => 'updated_by', 'updated_at' => 'updated_at', 'editable' => 'editable', 'full_path' => 'full_path']

$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 = ['uuid' => 'getUuid', 'parent_uuid' => 'getParentUuid', 'name' => 'getName', 'main_type' => 'getMainType', 'sub_type' => 'getSubType', 'query' => 'getQuery', 'description' => 'getDescription', 'output_hint' => 'getOutputHint', 'favourite' => 'getFavourite', 'status' => 'getStatus', 'version' => 'getVersion', 'created_by' => 'getCreatedBy', 'created_at' => 'getCreatedAt', 'updated_by' => 'getUpdatedBy', 'updated_at' => 'getUpdatedAt', 'editable' => 'getEditable', 'full_path' => 'getFullPath']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['uuid' => 'uuid', 'parent_uuid' => 'uuid', 'name' => null, 'main_type' => null, 'sub_type' => null, 'query' => null, 'description' => null, 'output_hint' => null, 'favourite' => null, 'status' => null, 'version' => null, 'created_by' => null, 'created_at' => null, 'updated_by' => null, 'updated_at' => null, 'editable' => null, 'full_path' => 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 = 'Action'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, bool> $openAPINullables = ['uuid' => false, 'parent_uuid' => false, 'name' => false, 'main_type' => false, 'sub_type' => false, 'query' => true, 'description' => true, 'output_hint' => true, 'favourite' => false, 'status' => false, 'version' => true, 'created_by' => false, 'created_at' => false, 'updated_by' => true, 'updated_at' => true, 'editable' => false, 'full_path' => 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 = ['uuid' => 'string', 'parent_uuid' => 'string', 'name' => 'string', 'main_type' => 'string', 'sub_type' => 'string', 'query' => 'string', 'description' => 'string', 'output_hint' => 'string', 'favourite' => 'bool', 'status' => 'string', 'version' => 'int', 'created_by' => 'string', 'created_at' => 'string', 'updated_by' => 'string', 'updated_at' => 'string', 'editable' => 'bool', 'full_path' => '\BIMworks\Model\ActionFullPathInner[]']

$setters

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

protected static array<string|int, string> $setters = ['uuid' => 'setUuid', 'parent_uuid' => 'setParentUuid', 'name' => 'setName', 'main_type' => 'setMainType', 'sub_type' => 'setSubType', 'query' => 'setQuery', 'description' => 'setDescription', 'output_hint' => 'setOutputHint', 'favourite' => 'setFavourite', 'status' => 'setStatus', 'version' => 'setVersion', 'created_by' => 'setCreatedBy', 'created_at' => 'setCreatedAt', 'updated_by' => 'setUpdatedBy', 'updated_at' => 'setUpdatedAt', 'editable' => 'setEditable', 'full_path' => 'setFullPath']

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>

getCreatedAt()

Gets created_at

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

getCreatedBy()

Gets created_by

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

getDescription()

Gets description

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

getEditable()

Gets editable

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

getFavourite()

Gets favourite

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

getMainType()

Gets main_type

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

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getName()

Gets name

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

getOutputHint()

Gets output_hint

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

getParentUuid()

Gets parent_uuid

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

getQuery()

Gets query

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

getStatus()

Gets status

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

getStatusAllowableValues()

Gets allowable values of the enum

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

getSubType()

Gets sub_type

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

getUpdatedAt()

Gets updated_at

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

getUpdatedBy()

Gets updated_by

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

getUuid()

Gets uuid

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

getVersion()

Gets version

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

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>

setCreatedAt()

Sets created_at

public setCreatedAt(string|null $created_at) : self
Parameters
$created_at : string|null

created_at

Return values
self

setCreatedBy()

Sets created_by

public setCreatedBy(string|null $created_by) : self
Parameters
$created_by : string|null

created_by

Return values
self

setDescription()

Sets description

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

description

Return values
self

setEditable()

Sets editable

public setEditable(bool|null $editable) : self
Parameters
$editable : bool|null

editable

Return values
self

setFavourite()

Sets favourite

public setFavourite(bool|null $favourite) : self
Parameters
$favourite : bool|null

favourite

Return values
self

setFullPath()

Sets full_path

public setFullPath(array<string|int, ActionFullPathInner>|null $full_path) : self
Parameters
$full_path : array<string|int, ActionFullPathInner>|null

From the action up to the caller's folder

Return values
self

setMainType()

Sets main_type

public setMainType(string|null $main_type) : self
Parameters
$main_type : string|null

main_type

Return values
self

setName()

Sets name

public setName(string|null $name) : self
Parameters
$name : string|null

name

Return values
self

setOutputHint()

Sets output_hint

public setOutputHint(string|null $output_hint) : self
Parameters
$output_hint : string|null

output_hint

Return values
self

setParentUuid()

Sets parent_uuid

public setParentUuid(string|null $parent_uuid) : self
Parameters
$parent_uuid : string|null

parent_uuid

Return values
self

setQuery()

Sets query

public setQuery(string|null $query) : self
Parameters
$query : string|null

The text

Return values
self

setStatus()

Sets status

public setStatus(string|null $status) : self
Parameters
$status : string|null

status

Return values
self

setSubType()

Sets sub_type

public setSubType(string|null $sub_type) : self
Parameters
$sub_type : string|null

sub_type

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>

setUpdatedAt()

Sets updated_at

public setUpdatedAt(string|null $updated_at) : self
Parameters
$updated_at : string|null

updated_at

Return values
self

setUpdatedBy()

Sets updated_by

public setUpdatedBy(string|null $updated_by) : self
Parameters
$updated_by : string|null

updated_by

Return values
self

setUuid()

Sets uuid

public setUuid(string|null $uuid) : self
Parameters
$uuid : string|null

uuid

Return values
self

setVersion()

Sets version

public setVersion(int|null $version) : self
Parameters
$version : int|null

version

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