Pair implements ArrayCopyable, Arrayable, Jsonable Uses ArrayTrait, JsonTrait
A pair of a string key and a string value.
Interfaces, Classes and Traits
- ArrayCopyable
- Interface to declare instances can be converted into/from arrays.
- Arrayable
- Interface to declare that instances can be converted into an array.
- Jsonable
- Interface to declare that instances can be converted into JSON strings.
Table of Contents
- __construct() : mixed
- Constructor.
- copyFromArray() : mixed
- Copy the content of the given array into this object.
- copyToArray() : mixed
- Copy the content of this object into the given array.
- fromArray() : static
- Convert an array into an instance of this class.
- fromJson() : static
- Convert a JSON string into an instance of this class.
- getKey() : string
- Get the key.
- getValue() : string
- Get the value.
- setKey() : Pair
- Set the key.
- setValue() : Pair
- Set the value.
- toArray() : array<string|int, mixed>
- Convert this object into an array.
- toJson() : string
- Convert this object into a JSON string.
Methods
__construct()
Constructor.
public
__construct([string $key = null ][, string $value = null ]) : mixed
Parameters
- $key : string = null
-
The key.
- $value : string = null
-
The value.
Return values
mixed —copyFromArray()
Copy the content of the given array into this object.
public
copyFromArray(array<string|int, mixed> &$array) : mixed
Parameters
- $array : array<string|int, mixed>
Return values
mixed —copyToArray()
Copy the content of this object into the given array.
public
copyToArray(array<string|int, mixed> &$array) : mixed
Parameters
- $array : array<string|int, mixed>
Return values
mixed —fromArray()
Convert an array into an instance of this class.
public
static fromArray([array<string|int, mixed> $array = null ]) : static
This static function returns a new instance of this class.
If $array is null, null is returned.
Parameters
- $array : array<string|int, mixed> = null
-
An array
Return values
static —An instance of this class.
fromJson()
Convert a JSON string into an instance of this class.
public
static fromJson(string $json) : static
This static function returns a new instance of this class.
If $json is null or the type of $json is not string,
null is returned.
Parameters
- $json : string
-
A JSON string.
Return values
static —An instance of this class.
getKey()
Get the key.
public
getKey() : string
Return values
string —The key.
getValue()
Get the value.
public
getValue() : string
Return values
string —The value.
setKey()
Set the key.
public
setKey(string $key) : Pair
Parameters
- $key : string
-
The key.
Return values
Pair —$this object.
setValue()
Set the value.
public
setValue(string $value) : Pair
Parameters
- $value : string
-
The value.
Return values
Pair —$this object.
toArray()
Convert this object into an array.
public
toArray() : array<string|int, mixed>
Return values
array<string|int, mixed> —An array.
toJson()
Convert this object into a JSON string.
public
toJson(int $options) : string
Parameters
- $options : int
-
Options passed to
json_encode(). This parameter is optional and its default value is 0.
Return values
string —A JSON string.