UpgradeSyntaxResult
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
UpgradeSyntaxResult Class Doc Comment
Tags
Table of Contents
Interfaces
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Constants
- DISCRIMINATOR : mixed = null
- LANGUAGE_BCL : mixed = 'BCL'
- LANGUAGE_BQL : mixed = 'BQL'
- LANGUAGE_BVL : mixed = 'BVL'
- STATUS_NOT_REWRITTEN : mixed = 'NOT_REWRITTEN'
- STATUS_REWRITTEN : mixed = 'REWRITTEN'
- STATUS_UNCHANGED : mixed = 'UNCHANGED'
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
- getChanges() : array<string|int, string>|null
- Gets changes
- getError() : string|null
- Gets error
- getId() : string|null
- Gets id
- getLanguage() : string|null
- Gets language
- getLanguageAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getModelName() : string
- The original name of the model.
- getStatus() : string|null
- Gets status
- getStatusAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getters() : array<string, string>
- Array of attributes to getter functions (for serialization of requests)
- getText() : string|null
- Gets text
- 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
- setChanges() : $this
- Sets changes
- setError() : $this
- Sets error
- setId() : $this
- Sets id
- setLanguage() : $this
- Sets language
- setStatus() : $this
- Sets status
- setters() : array<string, string>
- Array of attributes to setter functions (for deserialization of responses)
- setText() : $this
- Sets text
- 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
LANGUAGE_BCL
public
mixed
LANGUAGE_BCL
= 'BCL'
LANGUAGE_BQL
public
mixed
LANGUAGE_BQL
= 'BQL'
LANGUAGE_BVL
public
mixed
LANGUAGE_BVL
= 'BVL'
STATUS_NOT_REWRITTEN
public
mixed
STATUS_NOT_REWRITTEN
= 'NOT_REWRITTEN'
STATUS_REWRITTEN
public
mixed
STATUS_REWRITTEN
= 'REWRITTEN'
STATUS_UNCHANGED
public
mixed
STATUS_UNCHANGED
= 'UNCHANGED'
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
= ['id' => 'id', 'language' => 'language', 'status' => 'status', 'text' => 'text', 'changes' => 'changes', 'error' => 'error']
$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
= ['id' => 'getId', 'language' => 'getLanguage', 'status' => 'getStatus', 'text' => 'getText', 'changes' => 'getChanges', 'error' => 'getError']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string, string|null>
$openAPIFormats
= ['id' => null, 'language' => null, 'status' => null, 'text' => null, 'changes' => null, 'error' => null]
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'UpgradeSyntaxResult'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string, bool>
$openAPINullables
= ['id' => false, 'language' => false, 'status' => false, 'text' => false, 'changes' => false, 'error' => 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
= ['id' => 'string', 'language' => 'string', 'status' => 'string', 'text' => 'string', 'changes' => 'string[]', 'error' => 'string']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string, string>
$setters
= ['id' => 'setId', 'language' => 'setLanguage', 'status' => 'setStatus', 'text' => 'setText', 'changes' => 'setChanges', 'error' => 'setError']
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>getChanges()
Gets changes
public
getChanges() : array<string|int, string>|null
Return values
array<string|int, string>|nullgetError()
Gets error
public
getError() : string|null
Return values
string|nullgetId()
Gets id
public
getId() : string|null
Return values
string|nullgetLanguage()
Gets language
public
getLanguage() : string|null
Return values
string|nullgetLanguageAllowableValues()
Gets allowable values of the enum
public
static getLanguageAllowableValues() : array<string|int, string>
Return values
array<string|int, string>getModelName()
The original name of the model.
public
getModelName() : string
Return values
stringgetStatus()
Gets status
public
getStatus() : string|null
Return values
string|nullgetStatusAllowableValues()
Gets allowable values of the enum
public
static getStatusAllowableValues() : array<string|int, string>
Return values
array<string|int, string>getters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string, string>
Return values
array<string, string>getText()
Gets text
public
getText() : 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>setChanges()
Sets changes
public
setChanges(array<string|int, string>|null $changes) : $this
Parameters
- $changes : array<string|int, string>|null
-
The changes made, in order, such as
IN → UNITandlength → \"length\"; empty unless REWRITTEN
Return values
$thissetError()
Sets error
public
setError(string|null $error) : $this
Parameters
- $error : string|null
-
Only for NOT_REWRITTEN, the 3.0 parser's message:
line L:C: …
Return values
$thissetId()
Sets id
public
setId(string|null $id) : $this
Parameters
- $id : string|null
-
The input's id, when it had one
Return values
$thissetLanguage()
Sets language
public
setLanguage(string|null $language) : $this
Parameters
- $language : string|null
-
language
Return values
$thissetStatus()
Sets status
public
setStatus(string|null $status) : $this
Parameters
- $status : string|null
-
UNCHANGED: the text parses in 3.0 as it is.REWRITTEN:textis the text in the 3.0 syntax, andchangeslists what changed.NOT_REWRITTEN: the text does not parse in 3.0 for a reason that is not a known syntax change;textis the input, unchanged, anderrorsays where it fails
Return values
$thissetters()
Array of attributes to setter functions (for deserialization of responses)
public
static setters() : array<string, string>
Return values
array<string, string>setText()
Sets text
public
setText(string|null $text) : $this
Parameters
- $text : string|null
-
The text to use in 3.0
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>