QueryColumn
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
QueryColumn Class Doc Comment
Tags
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
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
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
stringattributeMap()
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|nullgetAggregate()
Gets aggregate
public
getAggregate() : string|null
Return values
string|nullgetAlias()
Gets alias
public
getAlias() : string|null
Return values
string|nullgetColumns()
Gets columns
public
getColumns() : array<string|int, QueryColumn>|null
Return values
array<string|int, QueryColumn>|nullgetGroupKey()
Gets group_key
public
getGroupKey() : bool|null
Return values
bool|nullgetHidden()
Gets hidden
public
getHidden() : bool|null
Return values
bool|nullgetItem()
Gets item
public
getItem() : int|null
Return values
int|nullgetKind()
Gets kind
public
getKind() : string|null
Return values
string|nullgetLabel()
Gets label
public
getLabel() : string|null
Return values
string|nullgetModelName()
The original name of the model.
public
getModelName() : string
Return values
stringgetPath()
Gets path
public
getPath() : array<string|int, string>|null
Return values
array<string|int, string>|nullgetSource()
Gets source
public
getSource() : string|null
Return values
string|nullgetters()
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|nullisNullable()
Checks if a property is nullable
public
static isNullable(string $property) : bool
Parameters
- $property : string
Return values
boolisNullableSetToNull()
Checks if a nullable property is set to null.
public
isNullableSetToNull(string $property) : bool
Parameters
- $property : string
Return values
booljsonSerialize()
Serializes the object to a value that can be serialized natively by json_encode().
public
jsonSerialize() : mixed
Tags
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, 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
booloffsetGet()
Gets offset.
public
offsetGet(int|string $offset) : mixed|null
Parameters
- $offset : int|string
-
Offset
Attributes
- #[ReturnTypeWillChange]
Return values
mixed|nulloffsetSet()
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
$thissetAggregate()
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
$thissetAlias()
Sets alias
public
setAlias(string|null $alias) : $this
Parameters
- $alias : string|null
-
The
ASalias of the item, null without one
Return values
$thissetColumns()
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
$thissetGroupKey()
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
$thissetHidden()
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
$thissetItem()
Sets item
public
setItem(int|null $item) : $this
Parameters
- $item : int|null
-
The index of the item in the
GETlist (or in its relation's list). Absent for an entry the server added, such as theqidofforce_get_qid
Return values
$thissetKind()
Sets kind
public
setKind(string|null $kind) : $this
Parameters
- $kind : string|null
-
The feature family, for styling (attribute, property, quantity, calculated, type, ...)
Return values
$thissetLabel()
Sets label
public
setLabel(string|null $label) : $this
Parameters
- $label : string|null
-
The header to show, the alias or else the text
Return values
$thissetPath()
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
$thissetSource()
Sets source
public
setSource(string|null $source) : $this
Parameters
- $source : string|null
-
The item as BQL text, without its alias
Return values
$thissetters()
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
$thistoHeaderValue()
Gets a header-safe presentation of the object
public
toHeaderValue() : string
Return values
stringvalid()
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>