Documentation

UpdateWorkspaceRequest
in package
implements ModelInterface, ArrayAccess, JsonSerializable

UpdateWorkspaceRequest 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

CLEAR_CURRENT_SPACE  : mixed = 'current_space'
CLEAR_FEATURE_VISIBILITY  : mixed = 'feature_visibility'
CLEAR_FILTER  : mixed = 'filter'
CLEAR_SCOPES  : mixed = 'scopes'
DISCRIMINATOR  : mixed = null

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
getClear()  : array<string|int, string>|null
Gets clear
getClearAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getCurrentSpace()  : array<string, mixed>|null
Gets current_space
getFeatureVisibility()  : array<string, mixed>|null
Gets feature_visibility
getFilter()  : string|null
Gets filter
getLoadAllModelsInitially()  : bool|null
Gets load_all_models_initially
getModelName()  : string
The original name of the model.
getName()  : string|null
Gets name
getScopes()  : array<string|int, string>|null
Gets scopes
getSubPath()  : string|null
Gets sub_path
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getUuid()  : string
Gets uuid
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
setClear()  : self
Sets clear
setCurrentSpace()  : self
Sets current_space
setFeatureVisibility()  : self
Sets feature_visibility
setFilter()  : self
Sets filter
setLoadAllModelsInitially()  : self
Sets load_all_models_initially
setName()  : self
Sets name
setScopes()  : self
Sets scopes
setSubPath()  : self
Sets sub_path
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setUuid()  : self
Sets uuid
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 = ['uuid' => 'uuid', 'name' => 'name', 'scopes' => 'scopes', 'filter' => 'filter', 'load_all_models_initially' => 'load_all_models_initially', 'current_space' => 'current_space', 'feature_visibility' => 'feature_visibility', 'sub_path' => 'sub_path', 'clear' => 'clear']

$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', 'name' => 'getName', 'scopes' => 'getScopes', 'filter' => 'getFilter', 'load_all_models_initially' => 'getLoadAllModelsInitially', 'current_space' => 'getCurrentSpace', 'feature_visibility' => 'getFeatureVisibility', 'sub_path' => 'getSubPath', 'clear' => 'getClear']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['uuid' => 'uuid', 'name' => null, 'scopes' => null, 'filter' => null, 'load_all_models_initially' => null, 'current_space' => null, 'feature_visibility' => null, 'sub_path' => null, 'clear' => 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 = 'UpdateWorkspaceRequest'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, bool> $openAPINullables = ['uuid' => false, 'name' => false, 'scopes' => true, 'filter' => false, 'load_all_models_initially' => false, 'current_space' => true, 'feature_visibility' => true, 'sub_path' => false, 'clear' => 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', 'name' => 'string', 'scopes' => 'string[]', 'filter' => 'string', 'load_all_models_initially' => 'bool', 'current_space' => 'array<string,mixed>', 'feature_visibility' => 'array<string,mixed>', 'sub_path' => 'string', 'clear' => 'string[]']

$setters

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

protected static array<string|int, string> $setters = ['uuid' => 'setUuid', 'name' => 'setName', 'scopes' => 'setScopes', 'filter' => 'setFilter', 'load_all_models_initially' => 'setLoadAllModelsInitially', 'current_space' => 'setCurrentSpace', 'feature_visibility' => 'setFeatureVisibility', 'sub_path' => 'setSubPath', 'clear' => 'setClear']

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>

getClear()

Gets clear

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

getClearAllowableValues()

Gets allowable values of the enum

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

getCurrentSpace()

Gets current_space

public getCurrentSpace() : array<string, mixed>|null
Return values
array<string, mixed>|null

getFeatureVisibility()

Gets feature_visibility

public getFeatureVisibility() : array<string, mixed>|null
Return values
array<string, mixed>|null

getLoadAllModelsInitially()

Gets load_all_models_initially

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

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getScopes()

Gets scopes

public getScopes() : array<string|int, string>|null
Return values
array<string|int, 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>

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>

setClear()

Sets clear

public setClear(array<string|int, string>|null $clear) : self
Parameters
$clear : array<string|int, string>|null

Fields to remove (scopes: the workspace becomes unscoped, or inherits its parent's)

Return values
self

setCurrentSpace()

Sets current_space

public setCurrentSpace(array<string, mixed>|null $current_space) : self
Parameters
$current_space : array<string, mixed>|null

{get_clause, label_template}: how the web app names the space a visitor is in

Return values
self

setFeatureVisibility()

Sets feature_visibility

public setFeatureVisibility(array<string, mixed>|null $feature_visibility) : self
Parameters
$feature_visibility : array<string, mixed>|null

{mode: allow | deny, features: [...]}: the features a visitor sees

Return values
self

setFilter()

Sets filter

public setFilter(string|null $filter) : self
Parameters
$filter : string|null

A BQL condition that limits the objects a visitor sees

Return values
self

setLoadAllModelsInitially()

Sets load_all_models_initially

public setLoadAllModelsInitially(bool|null $load_all_models_initially) : self
Parameters
$load_all_models_initially : bool|null

Load every model when a visitor opens it

Return values
self

setName()

Sets name

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

The new name

Return values
self

setScopes()

Sets scopes

public setScopes(array<string|int, string>|null $scopes) : self
Parameters
$scopes : array<string|int, string>|null

What a visitor may do, as scope wire names; unscoped (or the parent's) when null

Return values
self

setSubPath()

Sets sub_path

public setSubPath(string|null $sub_path) : self
Parameters
$sub_path : string|null

For a sub-workspace: the folder in its parent's actions that becomes its own

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>

setUuid()

Sets uuid

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

The workspace

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