ILIAS\Refinery\String\MakeClickable Class Reference

Inheritance diagram for ILIAS\Refinery\String\MakeClickable:

Collaboration diagram for ILIAS\Refinery\String\MakeClickable:

Public Member Functions
	__construct ($open_in_new_tab=true)
	transform ($from)
	Perform the transformation. More...
Public Member Functions inherited from ILIAS\Refinery\Transformation
	applyTo (Result $result)
	Perform the transformation and reify possible failures. More...
	__invoke ($from)
	Transformations should be callable. More...

Protected Member Functions
	additionalAttributes ()

Private Member Functions
	replaceMatches (string $from, callable $replace)
	regexPos (string $regexp, string $string)
	requireString ($maybeHTML)
	shouldReplace (string $maybeHTML, int $startOfMatch, int $endOfMatch)
	match (string $pattern, string $haystack)
	replace (string $url, string $protocol)

Private Attributes
const	URL_PATTERN = '(^|[^[:alnum:]])(((https?:\/\/)|(www.))[^[:cntrl:][:space:]<>\'"]+)([^[:alnum:]]|$)'
bool	$open_in_new_tab

Detailed Description

Definition at line 28 of file MakeClickable.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Refinery\String\MakeClickable::__construct

(

$open_in_new_tab = true

)

Definition at line 37 of file MakeClickable.php.

References ILIAS\Refinery\String\MakeClickable\$open_in_new_tab.

    {
        $this->open_in_new_tab = $open_in_new_tab;
    }

Member Function Documentation

additionalAttributes()

ILIAS\Refinery\String\MakeClickable::additionalAttributes ( )

protected

Definition at line 123 of file MakeClickable.php.

Referenced by ILIAS\Refinery\String\MakeClickable\replace().

                                             : string
    {
        if ($this->open_in_new_tab) {
            return ' target="_blank" rel="noopener"';
        }

        return '';
    }

Here is the caller graph for this function:

match()

ILIAS\Refinery\String\MakeClickable::match ( string  $pattern, string  $haystack  )

private

Parameters

string

$pattern

Pattern without delimiters.

Returns

null|string[]

Definition at line 106 of file MakeClickable.php.

References null.

Referenced by ILIAS\Refinery\String\MakeClickable\regexPos(), ILIAS\Refinery\String\MakeClickable\replaceMatches(), and ILIAS\Refinery\String\MakeClickable\shouldReplace().

                                                             : ?array
    {
        $pattern = str_replace('@', '\@', $pattern);
        return 1 === preg_match('@' . $pattern . '@', $haystack, $matches) ? $matches : null;
    }

Here is the caller graph for this function:

regexPos()

ILIAS\Refinery\String\MakeClickable::regexPos ( string  $regexp, string  $string  )

private

Definition at line 73 of file MakeClickable.php.

References ILIAS\Refinery\String\MakeClickable\match(), and null.

Referenced by ILIAS\Refinery\String\MakeClickable\shouldReplace().

                                                             : int
    {
        $matches = $this->match($regexp, $string);
        if (null !== $matches) {
            return strpos($string, $matches[0]);
        }

        return strlen($string);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

replace()

ILIAS\Refinery\String\MakeClickable::replace ( string  $url, string  $protocol  )

private

Definition at line 112 of file MakeClickable.php.

References ILIAS\Refinery\String\MakeClickable\additionalAttributes().

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

                                                           : string
    {
        $maybeProtocol = !$protocol ? 'https://' : '';
        return sprintf(
            '<a%s href="%s">%s</a>',
            $this->additionalAttributes(),
            $maybeProtocol . $url,
            $url
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

replaceMatches()

ILIAS\Refinery\String\MakeClickable::replaceMatches ( string  $from, callable  $replace  )

private

Definition at line 53 of file MakeClickable.php.

References ILIAS\Refinery\String\MakeClickable\match(), and null.

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

                                                                    : string
    {
        $endOfLastMatch = 0;
        $stringParts = [];

        while (null !== ($matches = $this->match(self::URL_PATTERN, substr($from, $endOfLastMatch)))) {
            $startOfMatch = $endOfLastMatch + strpos(substr($from, $endOfLastMatch), $matches[0]);
            $endOfMatch = $startOfMatch + strlen($matches[1] . $matches[2]);

            $stringParts[] = substr($from, $endOfLastMatch, $startOfMatch - $endOfLastMatch);
            $stringParts[] = $matches[1] . $replace($startOfMatch, $endOfMatch, $matches[2], $matches[4]);

            $endOfLastMatch = $endOfMatch;
        }

        $stringParts[] = substr($from, $endOfLastMatch);

        return implode('', $stringParts);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

requireString()

ILIAS\Refinery\String\MakeClickable::requireString (   $maybeHTML )

private

Parameters

mixed

$maybeHTML

Returns

void

Definition at line 87 of file MakeClickable.php.

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

                                              : void
    {
        if (!is_string($maybeHTML)) {
            throw new ConstraintViolationException('not a string', 'not_a_string');
        }
    }

Here is the caller graph for this function:

shouldReplace()

ILIAS\Refinery\String\MakeClickable::shouldReplace ( string  $maybeHTML, int  $startOfMatch, int  $endOfMatch  )

private

Definition at line 94 of file MakeClickable.php.

References ILIAS\Refinery\String\MakeClickable\match(), null, and ILIAS\Refinery\String\MakeClickable\regexPos().

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

                                                                                         : bool
    {
        $isNotInAnchor = $this->regexPos('<a.*</a>', substr($maybeHTML, $endOfMatch)) <= $this->regexPos('</a>', substr($maybeHTML, $endOfMatch));
        $isNotATagAttribute = null === $this->match('^[^>]*[[:space:]][[:alpha:]]+<', strrev(substr($maybeHTML, 0, $startOfMatch)));

        return $isNotInAnchor && $isNotATagAttribute;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

transform()

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

References $url, ILIAS\Refinery\String\MakeClickable\replace(), ILIAS\Refinery\String\MakeClickable\replaceMatches(), ILIAS\Refinery\String\MakeClickable\requireString(), and ILIAS\Refinery\String\MakeClickable\shouldReplace().

                                    : string
    {
        $this->requireString($from);

        return $this->replaceMatches($from, fn(int $startOfMatch, int $endOfMatch, string $url, string $protocol): string => (
            $this->shouldReplace($from, $startOfMatch, $endOfMatch) ?
                $this->replace($url, $protocol) :
                $url
        ));
    }

Here is the call graph for this function:

Field Documentation

$open_in_new_tab

bool ILIAS\Refinery\String\MakeClickable::$open_in_new_tab

private

Definition at line 35 of file MakeClickable.php.

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

URL_PATTERN

const ILIAS\Refinery\String\MakeClickable::URL_PATTERN = '(^|[^[:alnum:]])(((https?:\/\/)|(www.))[^[:cntrl:][:space:]<>\'"]+)([^[:alnum:]]|$)'

private

Definition at line 33 of file MakeClickable.php.

---

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

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