Documentation

TextToActionResult
in package

BIMworks

implements ModelInterface, ArrayAccess, JsonSerializable

TextToActionResult Class Doc Comment

Interfaces

ModelInterface: Interface abstracting model access.
ArrayAccess
JsonSerializable

Constants

DISCRIMINATOR : mixed = null
LANGUAGE_BCL : mixed = 'BCL'
LANGUAGE_BQL : mixed = 'BQL'
LANGUAGE_BVL : mixed = 'BVL'

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
getDescription() : string|null: Gets description
getInputArcheType() : string|null: Gets input_arche_type
getLanguage() : string: Gets language
getLanguageAllowableValues() : array<string|int, string>: Gets allowable values of the enum
getMainType() : string: Gets main_type
getModelName() : string: The original name of the model.
getOutputShape() : string|null: Gets output_shape
getQuery() : string: Gets query
getters() : array<string|int, mixed>: Array of attributes to getter functions (for serialization of requests)
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
setDescription() : self: Sets description
setInputArcheType() : self: Sets input_arche_type
setLanguage() : self: Sets language
setMainType() : self: Sets main_type
setOutputShape() : self: Sets output_shape
setQuery() : self: Sets query
setters() : array<string|int, mixed>: Array of attributes to setter functions (for deserialization of responses)
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

DISCRIMINATOR


    public
        mixed
    DISCRIMINATOR
    = null

LANGUAGE_BCL


    public
        mixed
    LANGUAGE_BCL
    = 'BCL'

LANGUAGE_BQL


    public
        mixed
    LANGUAGE_BQL
    = 'BQL'

LANGUAGE_BVL


    public
        mixed
    LANGUAGE_BVL
    = 'BVL'

$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
     = ['language' => 'language', 'query' => 'query', 'main_type' => 'main_type', 'description' => 'description', 'output_shape' => 'output_shape', 'input_arche_type' => 'input_arche_type']

$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
     = ['language' => 'getLanguage', 'query' => 'getQuery', 'main_type' => 'getMainType', 'description' => 'getDescription', 'output_shape' => 'getOutputShape', 'input_arche_type' => 'getInputArcheType']

$openAPIFormats

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


        protected
        static    array<string|int, string>
    $openAPIFormats
     = ['language' => null, 'query' => null, 'main_type' => null, 'description' => null, 'output_shape' => null, 'input_arche_type' => null]

$openAPIModelName

The original name of the model.


        protected
        static    string
    $openAPIModelName
     = 'TextToActionResult'

$openAPINullables

Array of nullable properties. Used for (de)serialization


        protected
        static    array<string|int, bool>
    $openAPINullables
     = ['language' => false, 'query' => false, 'main_type' => false, 'description' => false, 'output_shape' => false, 'input_arche_type' => 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
     = ['language' => 'string', 'query' => 'string', 'main_type' => 'string', 'description' => 'string', 'output_shape' => 'string', 'input_arche_type' => 'string']

$setters

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


        protected
        static    array<string|int, string>
    $setters
     = ['language' => 'setLanguage', 'query' => 'setQuery', 'main_type' => 'setMainType', 'description' => 'setDescription', 'output_shape' => 'setOutputShape', 'input_arche_type' => 'setInputArcheType']

__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>

getDescription()

Gets description


    public
                    getDescription() : string|null

Return values

string|null

getInputArcheType()

Gets input_arche_type


    public
                    getInputArcheType() : string|null

Return values

string|null

getLanguage()

Gets language


    public
                    getLanguage() : string

Return values

string

getLanguageAllowableValues()

Gets allowable values of the enum


    public
                    getLanguageAllowableValues() : array<string|int, string>

Return values

array<string|int, string>

getMainType()

Gets main_type


    public
                    getMainType() : string

Return values

string

getModelName()

The original name of the model.


    public
                    getModelName() : string

Return values

string

getOutputShape()

Gets output_shape


    public
                    getOutputShape() : string|null

Return values

string|null

getQuery()

Gets query


    public
                    getQuery() : string

Return values

string

getters()

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


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

Return values

array<string|int, mixed>

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

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

#[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>

setDescription()

Sets description


    public
                    setDescription(string|null $description) : self

Parameters

$description : string|null: The input text, as the description of the action

Return values

self

setInputArcheType()

Sets input_arche_type


    public
                    setInputArcheType(string|null $input_arche_type) : self

Parameters

$input_arche_type : string|null: For a query, the kind of input it runs on (ONE_SET_OF_QIDS)

Return values

self

setLanguage()

Sets language


    public
                    setLanguage(string $language) : self

Parameters

$language : string: The language of query, and so the call that runs it: BQL with Query, BVL with ResolveBvl, BCL with Check

Return values

self

setMainType()

Sets main_type


    public
                    setMainType(string $main_type) : self

Parameters

$main_type : string: The action type as the actions tree stores it (QUERY3, BVL, CHECK3), to save the answer as an action

Return values

self

setOutputShape()

Sets output_shape


    public
                    setOutputShape(string|null $output_shape) : self

Parameters

$output_shape : string|null: For a query, the shape of its result: SCALAR, COMPLEX, LIST_OF_SCALAR or LIST_OF_COMPLEX (one record per object or group, the usual one)

Return values

self

setQuery()

Sets query


    public
                    setQuery(string $query) : self

Parameters

$query : string: The action's code, formatted

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>

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>

TextToActionResult in package BIMworks implements ModelInterface, ArrayAccess, JsonSerializable

Tags

Table of Contents

Interfaces

Constants

Properties

Methods

Constants

DISCRIMINATOR

LANGUAGE_BCL

LANGUAGE_BQL

LANGUAGE_BVL

Properties

$attributeMap

$container

$getters

$openAPIFormats

Tags

$openAPIModelName

$openAPINullables

$openAPINullablesSetToNull

$openAPITypes

$setters

Methods

__construct()

Parameters

__toString()

Return values

attributeMap()

Return values

getDescription()

Return values

getInputArcheType()

Return values

getLanguage()

Return values

getLanguageAllowableValues()

Return values

getMainType()

Return values

getModelName()

Return values

getOutputShape()

Return values

getQuery()

Return values

getters()

Return values

isNullable()

Parameters

Return values

isNullableSetToNull()

Parameters

Return values

jsonSerialize()

Tags

Attributes

Return values

listInvalidProperties()

Return values

offsetExists()

Parameters

Return values

offsetGet()

Parameters

Attributes

Return values

offsetSet()

Parameters

offsetUnset()

Parameters

openAPIFormats()

Return values

openAPITypes()

Return values

setDescription()

Parameters

Return values

setInputArcheType()

Parameters

TextToActionResult
in package

BIMworks

implements ModelInterface, ArrayAccess, JsonSerializable