Sabre\DAV\StringUtil Class Reference

String utility. More...

Collaboration diagram for Sabre\DAV\StringUtil:

Static Public Member Functions
static	textMatch ($haystack, $needle, $collation, $matchType='contains')
	Checks if a needle occurs in a haystack ;) More...
static	ensureUTF8 ($input)
	This method takes an input string, checks if it's not valid UTF-8 and attempts to convert it to UTF-8 if it's not. More...

Detailed Description

String utility.

This class is mainly used to implement the 'text-match' filter, used by both the CalDAV calendar-query REPORT, and CardDAV addressbook-query REPORT. Because they both need it, it was decided to put it in Sabre instead.

Copyright

Copyright (C) fruux GmbH (https://fruux.com/)

Author

Evert Pot (http://evertpot.com/) http://sabre.io/license/ Modified BSD License

Definition at line 16 of file StringUtil.php.

Member Function Documentation

ensureUTF8()

static Sabre\DAV\StringUtil::ensureUTF8 (   $input )

static

This method takes an input string, checks if it's not valid UTF-8 and attempts to convert it to UTF-8 if it's not.

Note that currently this can only convert ISO-8559-1 to UTF-8 (latin-1), anything else will likely fail.

Parameters

string

$input

Returns

string

Definition at line 79 of file StringUtil.php.

References $input.

Referenced by Sabre\CardDAV\AddressBook\createFile(), Sabre\CardDAV\Card\put(), Sabre\DAV\StringUtilTest\testEnsureUTF8_ascii(), Sabre\DAV\StringUtilTest\testEnsureUTF8_latin1(), and Sabre\DAV\StringUtilTest\testEnsureUTF8_utf8().

                                       {

        $encoding = mb_detect_encoding($input, ['UTF-8', 'ISO-8859-1'], true);

        if ($encoding === 'ISO-8859-1') {
            return utf8_encode($input);
        } else {
            return $input;
        }

    }

Here is the caller graph for this function:

textMatch()

static Sabre\DAV\StringUtil::textMatch (   $haystack,   $needle,   $collation,   $matchType = 'contains'  )

static

Checks if a needle occurs in a haystack ;)

Parameters

string	$haystack
string	$needle
string	$collation
string	$matchType

Returns

bool

Definition at line 27 of file StringUtil.php.

Referenced by Sabre\DAV\StringUtilTest\testBadCollation(), Sabre\DAV\StringUtilTest\testBadMatchType(), Sabre\DAV\StringUtilTest\testTextMatch(), Sabre\CardDAV\Plugin\validateParamFilters(), Sabre\CalDAV\CalendarQueryValidator\validateTextMatch(), and Sabre\CardDAV\Plugin\validateTextMatches().

                                                                                       {

        switch ($collation) {

            case 'i;ascii-casemap' :
                // default strtolower takes locale into consideration
                // we don't want this.
                $haystack = str_replace(range('a', 'z'), range('A', 'Z'), $haystack);
                $needle = str_replace(range('a', 'z'), range('A', 'Z'), $needle);
                break;

            case 'i;octet' :
                // Do nothing
                break;

            case 'i;unicode-casemap' :
                $haystack = mb_strtoupper($haystack, 'UTF-8');
                $needle = mb_strtoupper($needle, 'UTF-8');
                break;

            default :
                throw new Exception\BadRequest('Collation type: ' . $collation . ' is not supported');

        }

        switch ($matchType) {

            case 'contains' :
                return strpos($haystack, $needle) !== false;
            case 'equals' :
                return $haystack === $needle;
            case 'starts-with' :
                return strpos($haystack, $needle) === 0;
            case 'ends-with' :
                return strrpos($haystack, $needle) === strlen($haystack) - strlen($needle);
            default :
                throw new Exception\BadRequest('Match-type: ' . $matchType . ' is not supported');

        }

    }

Here is the caller graph for this function:

---

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

• libs/composer/vendor/sabre/dav/lib/DAV/StringUtil.php