Documentation

QueryColumn
in package
implements ModelInterface, ArrayAccess, JsonSerializable

QueryColumn Class Doc Comment

Tags
description

One entry of the columns table of a query answer: a `GET` item, its alias, and where its value is in a record. Clients label a column with `label` and read its values at `path`, so they need not know where BIM.works writes each kind of feature, or what an alias does to that (an alias names the column; for some features it is also the record key, which `path` then says)

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
getAdded()  : bool|null
Gets added
getAggregate()  : string|null
Gets aggregate
getAlias()  : string|null
Gets alias
getColumns()  : array<string|int, QueryColumn>|null
Gets columns
getGroupKey()  : bool|null
Gets group_key
getHidden()  : bool|null
Gets hidden
getItem()  : int|null
Gets item
getKind()  : string|null
Gets kind
getLabel()  : string|null
Gets label
getModelName()  : string
The original name of the model.
getPath()  : array<string|int, string>|null
Gets path
getSource()  : string|null
Gets source
getters()  : array<string, string>
Array of attributes to getter functions (for serialization of requests)
getUnit()  : string|null
Gets unit
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
setAdded()  : $this
Sets added
setAggregate()  : $this
Sets aggregate
setAlias()  : $this
Sets alias
setColumns()  : $this
Sets columns
setGroupKey()  : $this
Sets group_key
setHidden()  : $this
Sets hidden
setItem()  : $this
Sets item
setKind()  : $this
Sets kind
setLabel()  : $this
Sets label
setPath()  : $this
Sets path
setSource()  : $this
Sets source
setters()  : array<string, string>
Array of attributes to setter functions (for deserialization of responses)
setUnit()  : $this
Sets unit
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 = ['item' => 'item', 'alias' => 'alias', 'source' => 'source', 'label' => 'label', 'path' => 'path', 'kind' => 'kind', 'aggregate' => 'aggregate', 'unit' => 'unit', 'group_key' => 'groupKey', 'hidden' => 'hidden', 'added' => 'added', 'columns' => 'columns']

$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 = ['item' => 'getItem', 'alias' => 'getAlias', 'source' => 'getSource', 'label' => 'getLabel', 'path' => 'getPath', 'kind' => 'getKind', 'aggregate' => 'getAggregate', 'unit' => 'getUnit', 'group_key' => 'getGroupKey', 'hidden' => 'getHidden', 'added' => 'getAdded', 'columns' => 'getColumns']

$openAPIFormats

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

protected static array<string, string|null> $openAPIFormats = ['item' => null, 'alias' => null, 'source' => null, 'label' => null, 'path' => null, 'kind' => null, 'aggregate' => null, 'unit' => null, 'group_key' => null, 'hidden' => null, 'added' => null, 'columns' => null]

$openAPIModelName

The original name of the model.

protected static string $openAPIModelName = 'QueryColumn'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string, bool> $openAPINullables = ['item' => false, 'alias' => true, 'source' => false, 'label' => false, 'path' => false, 'kind' => false, 'aggregate' => false, 'unit' => false, 'group_key' => false, 'hidden' => false, 'added' => false, 'columns' => 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 = ['item' => 'int', 'alias' => 'string', 'source' => 'string', 'label' => 'string', 'path' => 'string[]', 'kind' => 'string', 'aggregate' => 'string', 'unit' => 'string', 'group_key' => 'bool', 'hidden' => 'bool', 'added' => 'bool', 'columns' => '\BIMworks\Model\QueryColumn[]']

$setters

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

protected static array<string, string> $setters = ['item' => 'setItem', 'alias' => 'setAlias', 'source' => 'setSource', 'label' => 'setLabel', 'path' => 'setPath', 'kind' => 'setKind', 'aggregate' => 'setAggregate', 'unit' => 'setUnit', 'group_key' => 'setGroupKey', 'hidden' => 'setHidden', 'added' => 'setAdded', 'columns' => 'setColumns']

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>

getAdded()

Gets added

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

getAggregate()

Gets aggregate

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

getAlias()

Gets alias

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

getGroupKey()

Gets group_key

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

getHidden()

Gets hidden

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

getItem()

Gets item

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

getKind()

Gets kind

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

getLabel()

Gets label

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

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getPath()

Gets path

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

getSource()

Gets source

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

getUnit()

Gets unit

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

setAdded()

Sets added

public setAdded(bool|null $added) : $this
Parameters
$added : bool|null

True for an entry the server added rather than the query

Return values
$this

setAggregate()

Sets aggregate

public setAggregate(string|null $aggregate) : $this
Parameters
$aggregate : string|null

The aggregate's keyword (COUNT, SUM, COLLECT, ...), on an aggregate column

Return values
$this

setAlias()

Sets alias

public setAlias(string|null $alias) : $this
Parameters
$alias : string|null

The AS alias of the item, null without one

Return values
$this

setColumns()

Sets columns

public setColumns(array<string|int, QueryColumn>|null $columns) : $this
Parameters
$columns : array<string|int, QueryColumn>|null

The items inside a relation, or the features of a COLLECT, relative to one element of this column's value

Return values
$this

setGroupKey()

Sets group_key

public setGroupKey(bool|null $group_key) : $this
Parameters
$group_key : bool|null

True for a group key of a grouped result

Return values
$this

setHidden()

Sets hidden

public setHidden(bool|null $hidden) : $this
Parameters
$hidden : bool|null

True for an item the workspace's feature visibility hides; it has no values

Return values
$this

setItem()

Sets item

public setItem(int|null $item) : $this
Parameters
$item : int|null

The index of the item in the GET list (or in its relation's list). Absent for an entry the server added, such as the qid of force_get_qid

Return values
$this

setKind()

Sets kind

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

The feature family, for styling (attribute, property, quantity, calculated, type, ...)

Return values
$this

setLabel()

Sets label

public setLabel(string|null $label) : $this
Parameters
$label : string|null

The header to show, the alias or else the text

Return values
$this

setPath()

Sets path

public setPath(array<string|int, string>|null $path) : $this
Parameters
$path : array<string|int, string>|null

The keys from the record (for a nested column, from one element of its parent's value) to the value. An array because keys can hold dots. * stands for every key at that level, and an array met on the way holds one value per element. Absent when the item writes nothing into the records (a feature hidden by the workspace)

Return values
$this

setSource()

Sets source

public setSource(string|null $source) : $this
Parameters
$source : string|null

The item as BQL text, without its alias

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>

setUnit()

Sets unit

public setUnit(string|null $unit) : $this
Parameters
$unit : string|null

The unit of the item's UNIT clause, as written

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