phpgearbox / string

     *

     * @throws PcreException   When PCRE Error occurs.

     */

    public function regexExtract($pattern, $options = '')

    {

        // Define the array that will be filled by preg_match().

        $matches = [];

        // Ensure the options contain the "u" modifier.

        if (!$this->newSelf($options)->contains('u')) $options .= 'u';

        // Build the expression

        $expression =

            $this->regexDelimiter.

            $pattern.

            $this->regexDelimiter.

            $options

        ;

        // Run the expression

        $result = preg_match($expression, $this->scalarString, $matches);

        // If no errors return the $matches array

        if ($result !== false) return $this->newSelfs($matches);

        // Otherwise throw with last known PCRE Error.

        throw new PcreException();

    }

    /**

     * Replaces all occurrences of $pattern in $str by $replacement.

     *

     * @throws PcreException       When PCRE Error occurs.

     */

    public function regexReplace($pattern, $replacement, $options = '')

    {

        // The original regexReplace method in danielstjules/Stringy used

        // mb_ereg_replace() which supports an "r" flag, PCRE does not.

        if ($options === 'msr') $options = 'ms';

        // Ensure the options contain the "u" modifier.

        if (!$this->newSelf($options)->contains('u')) $options .= 'u';

        // Build the expression

        $expression =

            $this->regexDelimiter.

            $pattern.

            $this->regexDelimiter.

            $options

        ;

        // Run the regular expression replacement

        $replaced = preg_replace($expression, $replacement, $this->scalarString);

        // If no errors return the replacement

        if ($replaced !== null) return $this->newSelf($replaced);

        // Otherwise throw with last known PCRE Error.

        throw new PcreException();

    }

    /**

     * Splits the string with the provided regular expression.