ILIAS\Refinery\String\Encoding\Encoding Class Reference

Inheritance diagram for ILIAS\Refinery\String\Encoding\Encoding:

Collaboration diagram for ILIAS\Refinery\String\Encoding\Encoding:

Public Member Functions
	__construct (private string $from_encoding, private string $to_encoding)
	transform ($from)
	Perform the transformation. 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...

Data Fields
const	UTF_8 = 'UTF-8'
const	ISO_8859_1 = 'ISO-8859-1'
const	US_ASCII = 'US-ASCII'
const	ASCII = self::US_ASCII
const	LATIN_1 = self::ISO_8859_1

Detailed Description

Definition at line 28 of file Encoding.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Refinery\String\Encoding\Encoding::__construct	(	private string	$from_encoding,
		private string	$to_encoding
	)

Definition at line 41 of file Encoding.php.

      {
    }

Member Function Documentation

transform()

ILIAS\Refinery\String\Encoding\Encoding::transform

(

$from

)

Perform the transformation.

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

Parameters

mixed

$from

Returns

mixed

Exceptions

InvalidArgumentException

if the argument could not be transformed

Implements ILIAS\Refinery\Transformation.

Definition at line 47 of file Encoding.php.

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

Field Documentation

ASCII

const ILIAS\Refinery\String\Encoding\Encoding::ASCII = self::US_ASCII

Definition at line 38 of file Encoding.php.

Referenced by ILIAS\Refinery\String\Encoding\Group\asciiToUtf8().

ISO_8859_1

const ILIAS\Refinery\String\Encoding\Encoding::ISO_8859_1 = 'ISO-8859-1'

Definition at line 34 of file Encoding.php.

LATIN_1

const ILIAS\Refinery\String\Encoding\Encoding::LATIN_1 = self::ISO_8859_1

Definition at line 39 of file Encoding.php.

Referenced by ILIAS\Refinery\String\Encoding\Group\latin1ToUtf8().

US_ASCII

const ILIAS\Refinery\String\Encoding\Encoding::US_ASCII = 'US-ASCII'

Definition at line 35 of file Encoding.php.

UTF_8

const ILIAS\Refinery\String\Encoding\Encoding::UTF_8 = 'UTF-8'

Definition at line 33 of file Encoding.php.

Referenced by ILIAS\Refinery\String\Encoding\Group\asciiToUtf8(), and ILIAS\Refinery\String\Encoding\Group\latin1ToUtf8().

---

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

• components/ILIAS/Refinery/src/String/Encoding/Encoding.php