Documentation

OcrRequest
in package
implements ArrayAccess

OcrRequest Class Doc Comment

Tags
category

Class

author

Swagger Codegen team

link
https://github.com/swagger-api/swagger-codegen

Interfaces, Classes, Traits and Enums

ArrayAccess

Table of Contents

DISCRIMINATOR  = null
$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)
$setters  : array<string|int, string>
Array of attributes to setter functions (for deserialization of responses)
$swaggerModelName  : string
The original name of the model.
$swaggerTypes  : array<string|int, string>
Array of property to type mappings. Used for (de)serialization
__construct()  : mixed
Constructor
__toString()  : string
Gets the string presentation of the object
attributeMap()  : mixed
getOcrLanguage()  : string
Gets ocr_language
getPageSelection()  : string
Gets page_selection
getSetPageOrientation()  : string
Gets set_page_orientation
getShowFrames()  : string
Gets show_frames
getShowText()  : string
Gets show_text
getSkipPagesHavingExistingExtractableText()  : string
Gets skip_pages_having_existing_extractable_text
getters()  : mixed
listInvalidProperties()  : array<string|int, mixed>
show all the invalid properties with reasons.
offsetExists()  : bool
Returns true if offset exists. False otherwise.
offsetGet()  : mixed
Gets offset.
offsetSet()  : void
Sets value based on offset.
offsetUnset()  : void
Unsets offset.
setOcrLanguage()  : $this
Sets ocr_language
setPageSelection()  : $this
Sets page_selection
setSetPageOrientation()  : $this
Sets set_page_orientation
setShowFrames()  : $this
Sets show_frames
setShowText()  : $this
Sets show_text
setSkipPagesHavingExistingExtractableText()  : $this
Sets skip_pages_having_existing_extractable_text
setters()  : mixed
swaggerTypes()  : mixed
valid()  : bool
validate all the properties in the model return true if all passed

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 = ['ocr_language' => 'ocrLanguage', 'page_selection' => 'pageSelection', 'set_page_orientation' => 'setPageOrientation', 'show_frames' => 'showFrames', 'show_text' => 'showText', 'skip_pages_having_existing_extractable_text' => 'skipPagesHavingExistingExtractableText']

$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 = ['ocr_language' => 'getOcrLanguage', 'page_selection' => 'getPageSelection', 'set_page_orientation' => 'getSetPageOrientation', 'show_frames' => 'getShowFrames', 'show_text' => 'getShowText', 'skip_pages_having_existing_extractable_text' => 'getSkipPagesHavingExistingExtractableText']

$setters

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

protected static array<string|int, string> $setters = ['ocr_language' => 'setOcrLanguage', 'page_selection' => 'setPageSelection', 'set_page_orientation' => 'setSetPageOrientation', 'show_frames' => 'setShowFrames', 'show_text' => 'setShowText', 'skip_pages_having_existing_extractable_text' => 'setSkipPagesHavingExistingExtractableText']

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'ocrRequest'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['ocr_language' => 'string', 'page_selection' => 'string', 'set_page_orientation' => 'string', 'show_frames' => 'string', 'show_text' => 'string', 'skip_pages_having_existing_extractable_text' => 'string']

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()

public static attributeMap() : mixed
Return values
mixed

getOcrLanguage()

Gets ocr_language

public getOcrLanguage() : string
Return values
string

getPageSelection()

Gets page_selection

public getPageSelection() : string
Return values
string

getSetPageOrientation()

Gets set_page_orientation

public getSetPageOrientation() : string
Return values
string

getShowFrames()

Gets show_frames

public getShowFrames() : string
Return values
string

getShowText()

Gets show_text

public getShowText() : string
Return values
string

getSkipPagesHavingExistingExtractableText()

Gets skip_pages_having_existing_extractable_text

public getSkipPagesHavingExistingExtractableText() : string
Return values
string

getters()

public static getters() : mixed
Return values
mixed

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

Offset

Return values
mixed

offsetSet()

Sets value based on offset.

public offsetSet(int $offset, mixed $value) : void
Parameters
$offset : int

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

setOcrLanguage()

Sets ocr_language

public setOcrLanguage(string $ocr_language) : $this
Parameters
$ocr_language : string
Return values
$this

setPageSelection()

Sets page_selection

public setPageSelection(string $page_selection) : $this
Parameters
$page_selection : string
Return values
$this

setSetPageOrientation()

Sets set_page_orientation

public setSetPageOrientation(string $set_page_orientation) : $this
Parameters
$set_page_orientation : string
Return values
$this

setShowFrames()

Sets show_frames

public setShowFrames(string $show_frames) : $this
Parameters
$show_frames : string
Return values
$this

setShowText()

Sets show_text

public setShowText(string $show_text) : $this
Parameters
$show_text : string
Return values
$this

setSkipPagesHavingExistingExtractableText()

Sets skip_pages_having_existing_extractable_text

public setSkipPagesHavingExistingExtractableText(string $skip_pages_having_existing_extractable_text) : $this
Parameters
$skip_pages_having_existing_extractable_text : string
Return values
$this

setters()

public static setters() : mixed
Return values
mixed

swaggerTypes()

public static swaggerTypes() : mixed
Return values
mixed

valid()

validate all the properties in the model return true if all passed

public valid() : bool
Return values
bool

True if all properteis are valid

Search results