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 (string $delimiter, 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
string	$delimiter

Factory	$factory

Detailed Description

Split a string by delimiter into array.

Definition at line 32 of file SplitString.php.

Constructor & Destructor Documentation

◆ __construct()

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

Definition at line 39 of file SplitString.php.

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

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

Member Function Documentation

◆ applyTo()

ILIAS\Refinery\String\SplitString::applyTo ( Result $result )

@inheritDoc

Implements ILIAS\Refinery\Transformation.

Definition at line 61 of file SplitString.php.

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

References ILIAS\Data\Result\value().

Here is the call graph for this function:

◆ transform()

ILIAS\Refinery\String\SplitString::transform ( $from )

@inheritDoc

Returns: string[]

Implements ILIAS\Refinery\Transformation.

Definition at line 49 of file SplitString.php.

                                    : array
    {
        if (!is_string($from)) {
            throw new InvalidArgumentException(__METHOD__ . " the argument is not a string.");
        }
 
        return explode($this->delimiter, $from);
    }

Field Documentation

◆ $delimiter

string ILIAS\Refinery\String\SplitString::$delimiter

private

Definition at line 36 of file SplitString.php.

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

◆ $factory

Factory ILIAS\Refinery\String\SplitString::$factory