shipcloud PHP Client

DeclaredValue extends AbstractApiObject
in package

DeclaredValue class

Tags
category

Class

author

Daniel Muenter info@msltns.com

version
0.0.1
since
0.0.1
license

GPL 3 This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, version 3, as published by the Free Software Foundation. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

Table of Contents

$id  : id
$required  : required
$amount  : float
$currency  : string
__construct()  : void
Properties constructor.
get_amount()  : float
Getter method for amount.
get_currency()  : float
Getter method for currency.
get_id()  : string|null
Getter method for id.
get_required_fields()  : array<string|int, mixed>
Getter method for id.
set_amount()  : void
Setter method for amount.
set_currency()  : void
Setter method for currency.
set_id()  : void
Setter method for id.
to_array()  : array<string|int, mixed>
Getter method for parameter array.
to_string()  : string
Getter method for string representation.

Properties

Methods

__construct()

Properties constructor.

public __construct(float $amount, string $currency) : void
Parameters
$amount : float
$currency : string
Tags
throws
ApiException
Return values
void —

get_amount()

Getter method for amount.

public get_amount() : float
Return values
float —

The amount.

get_currency()

Getter method for currency.

public get_currency() : float
Return values
float —

The currency.

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.

set_amount()

Setter method for amount.

public set_amount(float $amount) : void
Parameters
$amount : float

The amount to set.

Tags
throws
ApiException
Return values
void —

set_currency()

Setter method for currency.

public set_currency(string $currency) : void
Parameters
$currency : string

The amount to set.

Tags
throws
ApiException
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 —

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.

Search results