ILIAS\Refinery\Container\AddLabels Class Reference

Adds to any array keys for each value. More...

Inheritance diagram for ILIAS\Refinery\Container\AddLabels:

Collaboration diagram for ILIAS\Refinery\Container\AddLabels:

Public Member Functions
	__construct (array $labels, Factory $factory)
	transform ($from)
	Perform the transformation.Please use this for transformations. It's more performant than calling invoke. Exceptions More...
	applyTo (Result $data)
	Perform the transformation and reify possible failures.If $data->isError(), the method MUST do nothing. It MUST transform the value in $data like it would transform $data provided to transform. It must reify every exception thrown in this process by returning a Result that isError() and contains the exception that happened.If you simply need to implement a transformation you most probably want to implement transform and derive this via the trait DeriveTransformationInterface.If you simply want to call the transformation, you most probably want to use transform, since it simply throws exceptions that occurred while doing the transformation.If you are implementing some entity that performs processing of input data at some boundary, the reification of exceptions might help you to write cleaner code. Parameters Result $data Returns Result More...
Public Member Functions inherited from ILIAS\Refinery\Transformation
	__invoke ($from)
	Transformations should be callable. More...

Protected Attributes
	$labels

Private Attributes
	$factory

Detailed Description

Adds to any array keys for each value.

Definition at line 14 of file AddLabels.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Refinery\Container\AddLabels::__construct	(	array	$labels,
		Factory	$factory
	)

Parameters

	string[]	| int[] $labels
Factory | null	$factory

Definition at line 32 of file AddLabels.php.

References ILIAS\Refinery\Container\AddLabels\$factory, and ILIAS\Refinery\Container\AddLabels\$labels.

    {
        $this->labels = $labels;
        $this->factory = $factory;
    }

Member Function Documentation

applyTo()

ILIAS\Refinery\Container\AddLabels::applyTo

(

Result

$data

)

Perform the transformation and reify possible failures.If $data->isError(), the method MUST do nothing. It MUST transform the value in $data like it would transform $data provided to transform. It must reify every exception thrown in this process by returning a Result that isError() and contains the exception that happened.If you simply need to implement a transformation you most probably want to implement transform and derive this via the trait DeriveTransformationInterface.If you simply want to call the transformation, you most probably want to use transform, since it simply throws exceptions that occurred while doing the transformation.If you are implementing some entity that performs processing of input data at some boundary, the reification of exceptions might help you to write cleaner code.

Parameters

Result

$data

Returns

Result

Implements ILIAS\Refinery\Transformation.

Definition at line 57 of file AddLabels.php.

References $result, and ILIAS\Data\Result\value().

                                          : Result
    {
        $dataValue = $data->value();
        if (false === is_array($dataValue)) {
            $exception = new \InvalidArgumentException(__METHOD__ . " argument is not an array.");
            return $this->factory->error($exception);
        }

        if (count($dataValue) != count($this->labels)) {
            $exception = new \InvalidArgumentException(__METHOD__ . " number of items in arrays are not equal.");
            return $this->factory->error($exception);
        }

        $value = array_combine($this->labels, $dataValue);
        $result = $this->factory->ok($value);

        return $result;
    }

Here is the call graph for this function:

transform()

ILIAS\Refinery\Container\AddLabels::transform

(

$from

)

Perform the transformation.Please use this for transformations. It's more performant than calling invoke.

Exceptions

Implements ILIAS\Refinery\Transformation.

Definition at line 41 of file AddLabels.php.

    {
        if (!is_array($from)) {
            throw new \InvalidArgumentException(__METHOD__ . " argument is not an array.");
        }

        if (count($from) != count($this->labels)) {
            throw new \InvalidArgumentException(__METHOD__ . " number of items in arrays are not equal.");
        }

        return array_combine($this->labels, $from);
    }

Field Documentation

$factory

ILIAS\Refinery\Container\AddLabels::$factory

private

Definition at line 26 of file AddLabels.php.

Referenced by ILIAS\Refinery\Container\AddLabels\__construct().

$labels

ILIAS\Refinery\Container\AddLabels::$labels

protected

Definition at line 21 of file AddLabels.php.

Referenced by ILIAS\Refinery\Container\AddLabels\__construct().

---

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

• src/Refinery/Container/AddLabels.php