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)
	@inheritDoc More...

	applyTo (Result $result)
	@inheritDoc More...

Public Member Functions inherited from ILIAS\Refinery\Transformation
	transform ($from)
	Perform the transformation. More...

	applyTo (Result $result)
	Perform the transformation and reify possible failures. More...

	__invoke ($from)
	Transformations should be callable. More...

Private Attributes
array	$labels

Factory	$factory

Detailed Description

Adds to any array keys for each value.

Definition at line 32 of file AddLabels.php.

Constructor & Destructor Documentation

◆ __construct()

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

Parameters

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

Definition at line 44 of file AddLabels.php.

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

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

Member Function Documentation

◆ applyTo()

ILIAS\Refinery\Container\AddLabels::applyTo ( Result $result )

@inheritDoc

Implements ILIAS\Refinery\Transformation.

Definition at line 70 of file AddLabels.php.

                                           : Result
    {
        $dataValue = $result->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;
    }

References ILIAS\Data\Result\value().

Here is the call graph for this function:

◆ transform()

ILIAS\Refinery\Container\AddLabels::transform ( $from )

@inheritDoc

Returns: array<int|string, mixed>

Implements ILIAS\Refinery\Transformation.

Definition at line 54 of file AddLabels.php.

                                    : array
    {
        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

Factory ILIAS\Refinery\Container\AddLabels::$factory

private

Definition at line 38 of file AddLabels.php.

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

◆ $labels

array ILIAS\Refinery\Container\AddLabels::$labels