ILIAS\KeyValueStorage\Internal\Values Class Reference

Translates between the values a consumer works with and the strings a repository stores. More...

Collaboration diagram for ILIAS\KeyValueStorage\Internal\Values:

Public Member Functions
	__construct (Refinery $refinery)
	encode (mixed $value)
	decode (string $value)

Private Member Functions
	checkEncodable (mixed $value)

Private Attributes
Transformation	$encode
Transformation	$decode

Detailed Description

Translates between the values a consumer works with and the strings a repository stores.

Values are stored as JSON via Refinery encode/decode transformations. serialize()/unserialize() are never used, so reading a value can never instantiate an object.

Definition at line 37 of file Values.php.

Constructor & Destructor Documentation

__construct()

ILIAS\KeyValueStorage\Internal\Values::__construct

(

Refinery

$refinery

)

Definition at line 43 of file Values.php.

    {
        $this->encode = $refinery->encode()->json();
        $this->decode = $refinery->decode()->json();
    }

References ILIAS\KeyValueStorage\Internal\Values\decode(), and ILIAS\KeyValueStorage\Internal\Values\encode().

Here is the call graph for this function:

Member Function Documentation

checkEncodable()

ILIAS\KeyValueStorage\Internal\Values::checkEncodable ( mixed  $value )

private

Definition at line 79 of file Values.php.

                                                 : void
    {
        if ($value === null || \is_scalar($value)) {
            return;
        }
 
        if (\is_array($value)) {
            foreach ($value as $item) {
                $this->checkEncodable($item);
            }
 
            return;
        }
 
        if ($value instanceof \JsonSerializable) {
            $this->checkEncodable($value->jsonSerialize());
 
            return;
        }
 
        throw new \InvalidArgumentException(
            'Only null, scalars, arrays of those and objects implementing JsonSerializable can be stored, got '
            . \get_debug_type($value) . '.'
        );
    }

References ILIAS\KeyValueStorage\Internal\Values\checkEncodable().

Referenced by ILIAS\KeyValueStorage\Internal\Values\checkEncodable(), and ILIAS\KeyValueStorage\Internal\Values\encode().

Here is the call graph for this function:

Here is the caller graph for this function:

decode()

ILIAS\KeyValueStorage\Internal\Values::decode

(

string

$value

)

Exceptions

InvalidStoredValueException

if the stored string cannot be read back

Definition at line 70 of file Values.php.

                                         : mixed
    {
        try {
            return $this->decode->transform($value);
        } catch (\InvalidArgumentException $e) {
            throw new InvalidStoredValueException('The stored value is not valid JSON.', 0, $e);
        }
    }

References Vendor\Package\$e, and ILIAS\KeyValueStorage\Internal\Values\decode().

Referenced by ILIAS\KeyValueStorage\Internal\Values\__construct(), and ILIAS\KeyValueStorage\Internal\Values\decode().

Here is the call graph for this function:

Here is the caller graph for this function:

encode()

ILIAS\KeyValueStorage\Internal\Values::encode

(

mixed

$value

)

Exceptions

InvalidArgumentException if the value cannot be stored

Definition at line 52 of file Values.php.

                                        : string
    {
        $this->checkEncodable($value);
 
        try {
            return $this->encode->transform($value);
        } catch (\JsonException $e) {
            throw new \InvalidArgumentException(
                'The value could not be encoded: ' . $e->getMessage(),
                0,
                $e
            );
        }
    }

References Vendor\Package\$e, ILIAS\KeyValueStorage\Internal\Values\checkEncodable(), and ILIAS\KeyValueStorage\Internal\Values\encode().

Referenced by ILIAS\KeyValueStorage\Internal\Values\__construct(), and ILIAS\KeyValueStorage\Internal\Values\encode().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$decode

Transformation ILIAS\KeyValueStorage\Internal\Values::$decode

private

Definition at line 41 of file Values.php.

$encode

Transformation ILIAS\KeyValueStorage\Internal\Values::$encode

private

Definition at line 39 of file Values.php.

---

The documentation for this class was generated from the following file:

• components/ILIAS/KeyValueStorage/src/Internal/Values.php