Documentation

TextSearchRequest
in package
implements ModelInterface, ArrayAccess, JsonSerializable

TextSearchRequest 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_ATTRIBUTE  : mixed = 'attribute'
KIND_CLASSIFICATION  : mixed = 'classification'
KIND_LAYER  : mixed = 'layer'
KIND_MATERIAL  : mixed = 'material'
KIND_PROPERTY  : mixed = 'property'
KIND_QUANTITY  : mixed = 'quantity'

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
getFuzzy()  : bool|null
Gets fuzzy
getKind()  : string|null
Gets kind
getKindAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getMaxEdits()  : int|null
Gets max_edits
getMaxQidsPerGroup()  : int|null
Gets max_qids_per_group
getModelName()  : string
The original name of the model.
getModels()  : array<string|int, ModelIdentifier>
Gets models
getName()  : string|null
Gets name
getPrefix()  : bool|null
Gets prefix
getQuery()  : string
Gets query
getSearchNames()  : bool|null
Gets search_names
getSearchValues()  : bool|null
Gets search_values
getSet()  : string|null
Gets set
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getType()  : string|null
Gets type
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
setFuzzy()  : self
Sets fuzzy
setKind()  : self
Sets kind
setMaxEdits()  : self
Sets max_edits
setMaxQidsPerGroup()  : self
Sets max_qids_per_group
setModels()  : self
Sets models
setName()  : self
Sets name
setPrefix()  : self
Sets prefix
setQuery()  : self
Sets query
setSearchNames()  : self
Sets search_names
setSearchValues()  : self
Sets search_values
setSet()  : self
Sets set
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setType()  : self
Sets type
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

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 = ['models' => 'models', 'query' => 'query', 'fuzzy' => 'fuzzy', 'max_edits' => 'max_edits', 'prefix' => 'prefix', 'search_values' => 'search_values', 'search_names' => 'search_names', 'kind' => 'kind', 'set' => 'set', 'name' => 'name', 'type' => 'type', 'max_qids_per_group' => 'max_qids_per_group']

$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 = ['models' => 'getModels', 'query' => 'getQuery', 'fuzzy' => 'getFuzzy', 'max_edits' => 'getMaxEdits', 'prefix' => 'getPrefix', 'search_values' => 'getSearchValues', 'search_names' => 'getSearchNames', 'kind' => 'getKind', 'set' => 'getSet', 'name' => 'getName', 'type' => 'getType', 'max_qids_per_group' => 'getMaxQidsPerGroup']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['models' => null, 'query' => null, 'fuzzy' => null, 'max_edits' => null, 'prefix' => null, 'search_values' => null, 'search_names' => null, 'kind' => null, 'set' => null, 'name' => null, 'type' => null, 'max_qids_per_group' => 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 = 'TextSearchRequest'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, bool> $openAPINullables = ['models' => false, 'query' => false, 'fuzzy' => false, 'max_edits' => false, 'prefix' => false, 'search_values' => false, 'search_names' => false, 'kind' => false, 'set' => false, 'name' => false, 'type' => false, 'max_qids_per_group' => 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 = ['models' => '\BIMworks\Model\ModelIdentifier[]', 'query' => 'string', 'fuzzy' => 'bool', 'max_edits' => 'int', 'prefix' => 'bool', 'search_values' => 'bool', 'search_names' => 'bool', 'kind' => 'string', 'set' => 'string', 'name' => 'string', 'type' => 'string', 'max_qids_per_group' => 'int']

$setters

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

protected static array<string|int, string> $setters = ['models' => 'setModels', 'query' => 'setQuery', 'fuzzy' => 'setFuzzy', 'max_edits' => 'setMaxEdits', 'prefix' => 'setPrefix', 'search_values' => 'setSearchValues', 'search_names' => 'setSearchNames', 'kind' => 'setKind', 'set' => 'setSet', 'name' => 'setName', 'type' => 'setType', 'max_qids_per_group' => 'setMaxQidsPerGroup']

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>

getFuzzy()

Gets fuzzy

public getFuzzy() : bool|null
Return values
bool|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>

getMaxEdits()

Gets max_edits

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

getMaxQidsPerGroup()

Gets max_qids_per_group

public getMaxQidsPerGroup() : int|null
Return values
int|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

getPrefix()

Gets prefix

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

getSearchNames()

Gets search_names

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

getSearchValues()

Gets search_values

public getSearchValues() : bool|null
Return values
bool|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>

getType()

Gets type

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

setFuzzy()

Sets fuzzy

public setFuzzy(bool|null $fuzzy) : self
Parameters
$fuzzy : bool|null

Allow small spelling differences

Return values
self

setKind()

Sets kind

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

Only this kind of feature

Return values
self

setMaxEdits()

Sets max_edits

public setMaxEdits(int|null $max_edits) : self
Parameters
$max_edits : int|null

For fuzzy: the number of edits allowed (1 when 0 or absent)

Return values
self

setMaxQidsPerGroup()

Sets max_qids_per_group

public setMaxQidsPerGroup(int|null $max_qids_per_group) : self
Parameters
$max_qids_per_group : int|null

At most this many qids per group; negative for all

Return values
self

setName()

Sets name

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

Only this feature name

Return values
self

setPrefix()

Sets prefix

public setPrefix(bool|null $prefix) : self
Parameters
$prefix : bool|null

Match the start of words

Return values
self

setQuery()

Sets query

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

The words to find

Return values
self

setSearchNames()

Sets search_names

public setSearchNames(bool|null $search_names) : self
Parameters
$search_names : bool|null

Search the names

Return values
self

setSearchValues()

Sets search_values

public setSearchValues(bool|null $search_values) : self
Parameters
$search_values : bool|null

Search the values

Return values
self

setSet()

Sets set

public setSet(string|null $set) : self
Parameters
$set : string|null

Only this property or quantity set

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>

setType()

Sets type

public setType(string|null $type) : self
Parameters
$type : string|null

Only objects of this IFC type

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