Label
extends AbstractApiObject
in package
Label class for label specific definitions.
Tags
Table of Contents
- $id : id
- $required : required
- $format : string
- Defines the format that the returned label should have.
- $size : string
- Defines the size that the returned label should have.
- __construct() : void
- Label constructor.
- get_format() : string
- Getter method for format.
- get_id() : string|null
- Getter method for id.
- get_required_fields() : array<string|int, mixed>
- Getter method for id.
- get_size() : string
- Getter method for size.
- set_format() : void
- Setter method for format.
- set_id() : void
- Setter method for id.
- set_size() : void
- Setter method for size.
- to_array() : array<string|int, mixed>
- Getter method for parameter array.
- to_string() : string
- Getter method for string representation.
Properties
$id
protected
id
$id
$required
protected
required
$required
$format
Defines the format that the returned label should have.
private
string
$format
$size
Defines the size that the returned label should have.
private
string
$size
Methods
__construct()
Label constructor.
public
__construct([string $format = '' ][, string $size = '' ]) : void
Parameters
- $format : string = ''
- $size : string = ''
Return values
void —get_format()
Getter method for format.
public
get_format() : string
Tags
Return values
string —The label format.
get_id()
Getter method for id.
public
get_id() : string|null
Return values
string|null —The id.
get_required_fields()
Getter method for id.
public
get_required_fields() : array<string|int, mixed>
Return values
array<string|int, mixed> —The id.
get_size()
Getter method for size.
public
get_size() : string
Tags
Return values
string —The size.
set_format()
Setter method for format.
public
set_format(string $format) : void
Parameters
- $format : string
-
The format to set.
Tags
Return values
void —set_id()
Setter method for id.
public
set_id(string $id) : void
Parameters
- $id : string
-
The id to set.
Return values
void —set_size()
Setter method for size.
public
set_size(string $size) : void
Parameters
- $size : string
-
The size to set.
Tags
Return values
void —to_array()
Getter method for parameter array.
public
to_array() : array<string|int, mixed>
Return values
array<string|int, mixed> —The class object as array.
to_string()
Getter method for string representation.
public
to_string() : string
Return values
string —The object as string representation.