ILIAS\Refinery\String\CaseOfLabel Class Reference

Class CaseOfLabel. More...

Inheritance diagram for ILIAS\Refinery\String\CaseOfLabel:

Collaboration diagram for ILIAS\Refinery\String\CaseOfLabel:

Public Member Functions
	__construct (string $language_key)
	transform ($from)
	@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...

Protected Attributes
array	$not_capitalize

Private Member Functions
	buildPatterns (array $words)
	buildPattern (string $word)
	replaceHelper (array $result)

Private Attributes
string	$language_key

Detailed Description

Class CaseOfLabel.

Format a text for the title capitalization presentation (Specification at https://docu.ilias.de/goto_docu_pg_1430_42.html)

Throws a LogicException in the transform method, if a not supported language is passed

Definition at line 36 of file CaseOfLabel.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Refinery\String\CaseOfLabel::__construct

(

string

$language_key

)

Definition at line 184 of file CaseOfLabel.php.

    {
        $this->language_key = $language_key;
    }

References ILIAS\Refinery\String\CaseOfLabel\$language_key.

Member Function Documentation

buildPattern()

ILIAS\Refinery\String\CaseOfLabel::buildPattern ( string  $word )

private

Definition at line 229 of file CaseOfLabel.php.

                                               : string
    {
        // Before the word muss be the start of the string or a space
        // After the word muss be the end of the string or a space
        // Ignore case to include the uppercase in the first step before
        return "/(\s|^)" . preg_quote($word, '/') . "(\s|$)/i";
    }

Referenced by ILIAS\Refinery\String\CaseOfLabel\buildPatterns().

Here is the caller graph for this function:

buildPatterns()

ILIAS\Refinery\String\CaseOfLabel::buildPatterns ( array  $words )

private

Definition at line 220 of file CaseOfLabel.php.

                                                : array
    {
        return array_reduce($words, function (array $patterns, string $word): array {
            $patterns[$this->buildPattern($word)] = [ $this, "replaceHelper" ];
 
            return $patterns;
        }, []);
    }

References ILIAS\Refinery\String\CaseOfLabel\buildPattern().

Referenced by ILIAS\Refinery\String\CaseOfLabel\transform().

Here is the call graph for this function:

Here is the caller graph for this function:

replaceHelper()

ILIAS\Refinery\String\CaseOfLabel::replaceHelper ( array  $result )

private

Definition at line 237 of file CaseOfLabel.php.

                                                 : string
    {
        return strtolower($result[0] ?? "");
    }

transform()

ILIAS\Refinery\String\CaseOfLabel::transform

(

$from

)

@inheritDoc

Exceptions

LogicException

Implements ILIAS\Refinery\Transformation.

Definition at line 194 of file CaseOfLabel.php.

                                    : string
    {
        if (!is_string($from)) {
            throw new InvalidArgumentException(__METHOD__ . " the argument is not a string.");
        }
 
        if (empty($this->language_key)) {
            throw new LogicException("Please specify a language for the title capitalization");
        }
 
        if (!isset($this->not_capitalize[$this->language_key])) {
            throw new LogicException("Language " . $this->language_key . " is not supported for the title capitalization");
        }
 
        // First write the first letter of each word to uppercase
        $to = ucwords(strtolower($from));
 
        // Then replace all special words and write it again to lowercase
        $to = preg_replace_callback_array($this->buildPatterns($this->not_capitalize[$this->language_key]), $to);
 
        // Finally the first letter of the whole string muss be always uppercase
        $to = ucfirst($to);
 
        return $to;
    }

References ILIAS\Refinery\String\CaseOfLabel\buildPatterns().

Here is the call graph for this function:

Field Documentation

$language_key

string ILIAS\Refinery\String\CaseOfLabel::$language_key

private

Definition at line 41 of file CaseOfLabel.php.

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

$not_capitalize

array ILIAS\Refinery\String\CaseOfLabel::$not_capitalize

protected

Definition at line 43 of file CaseOfLabel.php.

---

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

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