ILIAS\Refinery\String\SplitString Class Reference

Split a string by delimiter into array. More...

Inheritance diagram for ILIAS\Refinery\String\SplitString:

Collaboration diagram for ILIAS\Refinery\String\SplitString:

Public Member Functions
	__construct ($delimiter, Factory $factory)
	transform ($from)
	Perform the transformation.Please use this for transformations. It's more performant than calling invoke. Exceptions More...
	__invoke ($from)
	Transformations should be callable.This MUST do the same as transform. 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...

Protected Attributes
	$delimiter

Private Attributes
	$factory

Detailed Description

Split a string by delimiter into array.

Definition at line 13 of file SplitString.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Refinery\String\SplitString::__construct	(		$delimiter,
		Factory	$factory
	)

Parameters

string	$delimiter
Factory	$factory

Definition at line 29 of file SplitString.php.

References ILIAS\Refinery\String\SplitString\$delimiter, and ILIAS\Refinery\String\SplitString\$factory.

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

Member Function Documentation

__invoke()

ILIAS\Refinery\String\SplitString::__invoke

(

$from

)

Transformations should be callable.This MUST do the same as transform.

Exceptions

Implements ILIAS\Refinery\Transformation.

Definition at line 50 of file SplitString.php.

References ILIAS\Refinery\String\SplitString\transform().

    {
        return $this->transform($from);
    }

Here is the call graph for this function:

applyTo()

ILIAS\Refinery\String\SplitString::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 58 of file SplitString.php.

References ILIAS\Data\Result\value().

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

        $value = explode($this->delimiter, $dataValue);
        return $this->factory->ok($value);
    }

Here is the call graph for this function:

transform()

ILIAS\Refinery\String\SplitString::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 38 of file SplitString.php.

Referenced by ILIAS\Refinery\String\SplitString\__invoke().

    {
        if (!is_string($from)) {
            throw new \InvalidArgumentException(__METHOD__ . " the argument is not a string.");
        }

        return explode($this->delimiter, $from);
    }

Here is the caller graph for this function:

Field Documentation

$delimiter

ILIAS\Refinery\String\SplitString::$delimiter

protected

Definition at line 18 of file SplitString.php.

Referenced by ILIAS\Refinery\String\SplitString\__construct().

$factory

ILIAS\Refinery\String\SplitString::$factory

private

Definition at line 23 of file SplitString.php.

Referenced by ILIAS\Refinery\String\SplitString\__construct().

---

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

• src/Refinery/String/SplitString.php