Documentation

TaggedValue implements ArrayCopyable, Arrayable, Jsonable Uses ArrayTrait, JsonTrait

A string value with a language tag.

Tags
see
https://en.wikipedia.org/wiki/IETF_language_tag

Language Tag

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.
getTag()  : string
Get the language tag.
getValue()  : string
Get the value.
setTag()  : TaggedValue
Set the language tag.
setValue()  : TaggedValue
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 $tag = null ][, string $value = null ]) : mixed
Parameters
$tag : string = null

The language tag. This parameter is optional. Its default value is null.

$value : string = null

The value. This parameter is optional. Its default value is null.

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.

getTag()

Get the language tag.

public getTag() : string
Return values
string —

The language tag.

getValue()

Get the value.

public getValue() : string
Return values
string —

The value.

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.

Search results