Documentation

ExtractCodesOptions
in package
implements ModelInterface, ArrayAccess, JsonSerializable

ExtractCodesOptions Class Doc Comment

Tags
category

Class

description

Options for extracting verification codes from email or SMS content. Use method to control extraction strategy and allowFallback to control strictness.

author

OpenAPI Generator team

link
https://openapi-generator.tech
implements

\ArrayAccess<string, mixed>

Interfaces, Classes, Traits and Enums

ModelInterface
Interface abstracting model access.
ArrayAccess
JsonSerializable

Table of Contents

DISCRIMINATOR  = null
METHOD_AUTO  = 'AUTO'
METHOD_LLM  = 'LLM'
METHOD_OCR  = 'OCR'
METHOD_OCR_THEN_LLM  = 'OCR_THEN_LLM'
METHOD_PATTERN  = 'PATTERN'
$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, mixed>
Array of nullable properties. Used for (de)serialization
$openAPINullablesSetToNull  : array<string|int, mixed>
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)
__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
getAllowFallback()  : bool|null
Gets allow_fallback
getCustomPatterns()  : array<string|int, string>|null
Gets custom_patterns
getMaxCandidates()  : int|null
Gets max_candidates
getMaxLength()  : int|null
Gets max_length
getMethod()  : string|null
Gets method
getMethodAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getMinLength()  : int|null
Gets min_length
getModelName()  : string
The original name of the model.
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
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
setAllowFallback()  : self
Sets allow_fallback
setCustomPatterns()  : self
Sets custom_patterns
setMaxCandidates()  : self
Sets max_candidates
setMaxLength()  : self
Sets max_length
setMethod()  : self
Sets method
setMinLength()  : self
Sets min_length
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
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 = ['method' => 'method', 'allow_fallback' => 'allowFallback', 'min_length' => 'minLength', 'max_length' => 'maxLength', 'max_candidates' => 'maxCandidates', 'custom_patterns' => 'customPatterns']

$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 = ['method' => 'getMethod', 'allow_fallback' => 'getAllowFallback', 'min_length' => 'getMinLength', 'max_length' => 'getMaxLength', 'max_candidates' => 'getMaxCandidates', 'custom_patterns' => 'getCustomPatterns']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['method' => null, 'allow_fallback' => null, 'min_length' => 'int32', 'max_length' => 'int32', 'max_candidates' => 'int32', 'custom_patterns' => 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 = 'ExtractCodesOptions'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, mixed> $openAPINullables = ['method' => true, 'allow_fallback' => false, 'min_length' => false, 'max_length' => false, 'max_candidates' => false, 'custom_patterns' => true]

$openAPINullablesSetToNull

If a nullable field gets set to null, insert it here

protected array<string|int, mixed> $openAPINullablesSetToNull = []

$openAPITypes

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

protected static array<string|int, string> $openAPITypes = ['method' => 'string', 'allow_fallback' => 'bool', 'min_length' => 'int', 'max_length' => 'int', 'max_candidates' => 'int', 'custom_patterns' => 'string[]']

$setters

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

protected static array<string|int, string> $setters = ['method' => 'setMethod', 'allow_fallback' => 'setAllowFallback', 'min_length' => 'setMinLength', 'max_length' => 'setMaxLength', 'max_candidates' => 'setMaxCandidates', 'custom_patterns' => 'setCustomPatterns']

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

Return values
mixed —

__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> —

getAllowFallback()

Gets allow_fallback

public getAllowFallback() : bool|null
Return values
bool|null —

getCustomPatterns()

Gets custom_patterns

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

getMaxCandidates()

Gets max_candidates

public getMaxCandidates() : int|null
Return values
int|null —

getMaxLength()

Gets max_length

public getMaxLength() : int|null
Return values
int|null —

getMethod()

Gets method

public getMethod() : string|null
Return values
string|null —

getMethodAllowableValues()

Gets allowable values of the enum

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

getMinLength()

Gets min_length

public getMinLength() : int|null
Return values
int|null —

getModelName()

The original name of the model.

public getModelName() : string
Return values
string —

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 $offset) : bool
Parameters
$offset : int

Offset

Return values
bool —

offsetGet()

Gets offset.

public offsetGet(int $offset) : mixed|null
Parameters
$offset : int

Offset

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

Return values
void —

offsetUnset()

Unsets offset.

public offsetUnset(int $offset) : void
Parameters
$offset : int

Offset

Return values
void —

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> —

setAllowFallback()

Sets allow_fallback

public setAllowFallback(bool|null $allow_fallback) : self
Parameters
$allow_fallback : bool|null

Allow fallback to deterministic pattern extraction when the selected method is unavailable.

Return values
self —

setCustomPatterns()

Sets custom_patterns

public setCustomPatterns(array<string|int, string>|null $custom_patterns) : self
Parameters
$custom_patterns : array<string|int, string>|null

Optional custom regex patterns for code extraction. Each pattern should have either one capture group for the code or match the full code directly.

Return values
self —

setMaxCandidates()

Sets max_candidates

public setMaxCandidates(int|null $max_candidates) : self
Parameters
$max_candidates : int|null

Maximum number of code candidates to return. Best candidate is also returned separately.

Return values
self —

setMaxLength()

Sets max_length

public setMaxLength(int|null $max_length) : self
Parameters
$max_length : int|null

Maximum code length to consider.

Return values
self —

setMethod()

Sets method

public setMethod(string|null $method) : self
Parameters
$method : string|null

Extraction strategy for verification codes. Unsupported strategies may fall back when allowFallback is true.

Return values
self —

setMinLength()

Sets min_length

public setMinLength(int|null $min_length) : self
Parameters
$min_length : int|null

Minimum code length to consider. Typical OTP values are between 4 and 8 characters.

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> —

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
Return values
void —

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>
Return values
void —

Search results