Watermark
in package
implements
ModelInterface, ArrayAccess
Watermark Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- 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)
- $swaggerFormats : array<string|int, string>
- Array of property to format mappings. Used for (de)serialization
- $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() : array<string|int, mixed>
- Array of attributes where the key is the local name, and the value is the original name
- getDisplayAngle() : string|null
- Gets display_angle
- getEnabled() : string|null
- Gets enabled
- getFont() : string|null
- Gets font
- getFontColor() : string|null
- Gets font_color
- getFontSize() : string|null
- Gets font_size
- getId() : string|null
- Gets id
- getImageBase64() : string|null
- Gets image_base64
- getModelName() : string
- The original name of the model.
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getTransparency() : string|null
- Gets transparency
- getWatermarkText() : string|null
- Gets watermark_text
- 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.
- setDisplayAngle() : $this
- Sets display_angle
- setEnabled() : $this
- Sets enabled
- setFont() : $this
- Sets font
- setFontColor() : $this
- Sets font_color
- setFontSize() : $this
- Sets font_size
- setId() : $this
- Sets id
- setImageBase64() : $this
- Sets image_base64
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setTransparency() : $this
- Sets transparency
- setWatermarkText() : $this
- Sets watermark_text
- swaggerFormats() : array<string|int, mixed>
- Array of property to format mappings. Used for (de)serialization
- swaggerTypes() : array<string|int, mixed>
- Array of property to type mappings. Used for (de)serialization
- valid() : bool
- Validate all the properties in the model return true if all passed
Constants
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
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
= ['display_angle' => 'displayAngle', 'enabled' => 'enabled', 'font' => 'font', 'font_color' => 'fontColor', 'font_size' => 'fontSize', 'id' => 'id', 'image_base64' => 'imageBase64', 'transparency' => 'transparency', 'watermark_text' => 'watermarkText']
$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
= ['display_angle' => 'getDisplayAngle', 'enabled' => 'getEnabled', 'font' => 'getFont', 'font_color' => 'getFontColor', 'font_size' => 'getFontSize', 'id' => 'getId', 'image_base64' => 'getImageBase64', 'transparency' => 'getTransparency', 'watermark_text' => 'getWatermarkText']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['display_angle' => 'setDisplayAngle', 'enabled' => 'setEnabled', 'font' => 'setFont', 'font_color' => 'setFontColor', 'font_size' => 'setFontSize', 'id' => 'setId', 'image_base64' => 'setImageBase64', 'transparency' => 'setTransparency', 'watermark_text' => 'setWatermarkText']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['display_angle' => null, 'enabled' => null, 'font' => null, 'font_color' => null, 'font_size' => null, 'id' => null, 'image_base64' => null, 'transparency' => null, 'watermark_text' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'watermark'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['display_angle' => '?string', 'enabled' => '?string', 'font' => '?string', 'font_color' => '?string', 'font_size' => '?string', 'id' => '?string', 'image_base64' => '?string', 'transparency' => '?string', 'watermark_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()
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> —getDisplayAngle()
Gets display_angle
public
getDisplayAngle() : string|null
Return values
string|null —getEnabled()
Gets enabled
public
getEnabled() : string|null
Return values
string|null —getFont()
Gets font
public
getFont() : string|null
Return values
string|null —getFontColor()
Gets font_color
public
getFontColor() : string|null
Return values
string|null —getFontSize()
Gets font_size
public
getFontSize() : string|null
Return values
string|null —getId()
Gets id
public
getId() : string|null
Return values
string|null —getImageBase64()
Gets image_base64
public
getImageBase64() : string|null
Return values
string|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> —getTransparency()
Gets transparency
public
getTransparency() : string|null
Return values
string|null —getWatermarkText()
Gets watermark_text
public
getWatermarkText() : string|null
Return values
string|null —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 —setDisplayAngle()
Sets display_angle
public
setDisplayAngle(string|null $display_angle) : $this
Parameters
- $display_angle : string|null
Return values
$this —setEnabled()
Sets enabled
public
setEnabled(string|null $enabled) : $this
Parameters
- $enabled : string|null
Return values
$this —setFont()
Sets font
public
setFont(string|null $font) : $this
Parameters
- $font : string|null
-
The font to be used for the tab value. Supported Fonts: Arial, Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, Verdana, MSGothic, MSMincho, Default.
Return values
$this —setFontColor()
Sets font_color
public
setFontColor(string|null $font_color) : $this
Parameters
- $font_color : string|null
-
The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White.
Return values
$this —setFontSize()
Sets font_size
public
setFontSize(string|null $font_size) : $this
Parameters
- $font_size : string|null
-
The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72.
Return values
$this —setId()
Sets id
public
setId(string|null $id) : $this
Parameters
- $id : string|null
Return values
$this —setImageBase64()
Sets image_base64
public
setImageBase64(string|null $image_base64) : $this
Parameters
- $image_base64 : string|null
Return values
$this —setters()
Array of attributes to setter functions (for deserialization of responses)
public
static setters() : array<string|int, mixed>
Return values
array<string|int, mixed> —setTransparency()
Sets transparency
public
setTransparency(string|null $transparency) : $this
Parameters
- $transparency : string|null
Return values
$this —setWatermarkText()
Sets watermark_text
public
setWatermarkText(string|null $watermark_text) : $this
Parameters
- $watermark_text : string|null
Return values
$this —swaggerFormats()
Array of property to format mappings. Used for (de)serialization
public
static swaggerFormats() : array<string|int, mixed>
Return values
array<string|int, mixed> —swaggerTypes()
Array of property to type mappings. Used for (de)serialization
public
static swaggerTypes() : array<string|int, mixed>
Return values
array<string|int, mixed> —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