StringUtilityTest.php

Go to the documentation of this file.

<?php
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Core\Tests\Unit\Utility;
 
use ‪TYPO3\CMS\Core\Utility\StringUtility;
use TYPO3\TestingFramework\Core\Unit\UnitTestCase;
 
class ‪StringUtilityTest extends UnitTestCase
{
 
    public function ‪endsWithReturnsTrueForMatchingLastPartDataProvider()
    {
        return [
            'match last part of string' => ['hello world', 'world'],
            'match last char of string' => ['hello world', 'd'],
            'match whole string' => ['hello', 'hello'],
            'integer is part of string with same number' => ['24', 24],
            'string is part of integer with same number' => [24, '24'],
            'integer is part of string ending with same number' => ['please gimme beer, 24', 24]
        ];
    }
 
    public function ‪endsWithReturnsTrueForMatchingLastPart($string, $part)
    {
        self::assertTrue(‪StringUtility::endsWith($string, $part));
    }
 
    public function ‪endsWithReturnsFalseForNotMatchingLastPartDataProvider()
    {
        return [
            'no string match' => ['hello', 'bye'],
            'no case sensitive string match' => ['hello world', 'World'],
            'string is part but not last part' => ['hello world', 'worl'],
            'integer is not part of empty string' => ['', 0],
            'longer string is not part of shorter string' => ['a', 'aa'],
        ];
    }
 
    public function ‪endsWithReturnsFalseForNotMatchingLastPart($string, $part)
    {
        self::assertFalse(‪StringUtility::endsWith($string, $part));
    }
 
    public function ‪endsWithReturnsThrowsExceptionWithInvalidArgumentsDataProvider()
    {
        return [
            'array is not part of string' => ['string', [], 1347135545],
            'NULL is not part of string' => ['string', null, 1347135545],
            'empty string is not part of string' => ['string', '', 1347135545],
            'string is not part of array' => [[], 'string', 1347135544],
            'NULL is not part of array' => [[], null, 1347135544],
            'string is not part of NULL' => [null, 'string', 1347135544],
            'array is not part of NULL' => [null, [], 1347135544],
            'integer is not part of NULL' => [null, 0, 1347135544],
            'empty string is not part of NULL' => [null, '', 1347135544],
            'NULL is not part of empty string' => ['', null, 1347135545],
            'FALSE is not part of empty string' => ['', false, 1347135545],
            'empty string is not part of FALSE' => [false, '', 1347135545],
            'empty string is not part of integer' => [0, '', 1347135545],
            'string is not part of object' => [new \stdClass(), 'foo', 1347135544],
            'object is not part of string' => ['foo', new \stdClass(), 1347135545],
        ];
    }
 
    public function ‪endsWithReturnsThrowsExceptionWithInvalidArguments($string, $part, $expectedException)
    {
        $this->expectException(\InvalidArgumentException::class);
        $this->expectExceptionCode($expectedException);
 
        ‪StringUtility::endsWith($string, $part);
    }
 
    public function ‪beginsWithReturnsTrueForMatchingFirstPartDataProvider()
    {
        return [
            'match first part of string' => ['hello world', 'hello'],
            'match first char of string' => ['hello world', 'h'],
            'match whole string' => ['hello', 'hello'],
            'integer is part of string with same number' => ['24', 24],
            'string is part of integer with same number' => [24, '24'],
            'integer is part of string starting with same number' => ['24, please gimme beer', 24],
        ];
    }
 
    public function ‪beginsWithReturnsTrueForMatchingFirstPart($string, $part)
    {
        self::assertTrue(‪StringUtility::beginsWith($string, $part));
    }
 
    public function ‪beginsWithReturnsFalseForNotMatchingFirstPartDataProvider()
    {
        return [
            'no string match' => ['hello', 'bye'],
            'no case sensitive string match' => ['hello world', 'Hello'],
            'string in empty string' => ['', 'foo']
        ];
    }
 
    public function ‪beginsWithReturnsFalseForNotMatchingFirstPart($string, $part)
    {
        self::assertFalse(‪StringUtility::beginsWith($string, $part));
    }
 
    public function ‪beginsWithReturnsInvalidArgumentDataProvider()
    {
        return [
            'array is not part of string' => ['string', [], 1347135547],
            'NULL is not part of string' => ['string', null, 1347135547],
            'empty string is not part of string' => ['string', '', 1347135547],
            'string is not part of array' => [[], 'string', 1347135546],
            'NULL is not part of array' => [[], null, 1347135546],
            'string is not part of NULL' => [null, 'string', 1347135546],
            'array is not part of NULL' => [null, [], 1347135546],
            'integer is not part of NULL' => [null, 0, 1347135546],
            'empty string is not part of NULL' => [null, '', 1347135546],
            'NULL is not part of empty string' => ['', null, 1347135547],
            'FALSE is not part of empty string' => ['', false, 1347135547],
            'empty string is not part of FALSE' => [false, '', 1347135547],
            'empty string is not part of integer' => [0, '', 1347135547],
            'string is not part of object' => [new \stdClass(), 'foo', 1347135546],
            'object is not part of string' => ['foo', new \stdClass(), 1347135547],
        ];
    }
 
    public function ‪beginsWithReturnsThrowsExceptionWithInvalidArguments($string, $part, $expectedException)
    {
        $this->expectException(\InvalidArgumentException::class);
        $this->expectExceptionCode($expectedException);
 
        ‪StringUtility::beginsWith($string, $part);
    }
 
    public function ‪getUniqueIdReturnsIdWithPrefix()
    {
        $id = ‪StringUtility::getUniqueId('NEW');
        self::assertEquals('NEW', substr($id, 0, 3));
    }
 
    public function ‪getUniqueIdReturnsIdWithoutDot()
    {
        self::assertStringNotContainsString('.', ‪StringUtility::getUniqueId());
    }
 
    public function ‪escapeCssSelector(string $selector, string $expectedValue)
    {
        self::assertEquals($expectedValue, ‪StringUtility::escapeCssSelector($selector));
    }
 
    public function ‪escapeCssSelectorDataProvider(): array
    {
        return [
            ['data.field', 'data\\.field'],
            ['#theId', '\\#theId'],
            ['.theId:hover', '\\.theId\\:hover'],
            ['.theId:hover', '\\.theId\\:hover'],
            ['input[name=foo]', 'input\\[name\\=foo\\]'],
        ];
    }
 
    public function ‪removeByteOrderMark(string $input, string $expectedValue): void
    {
        // assertContains is necessary as one test contains non-string characters
        self::assertSame($expectedValue, ‪StringUtility::removeByteOrderMark(hex2bin($input)));
    }
 
    public function ‪removeByteOrderMarkDataProvider(): array
    {
        return [
            'BOM gets removed' => [
                'efbbbf424f4d2061742074686520626567696e6e696e6720676574732072656d6f766564',
                'BOM at the beginning gets removed'
            ],
            'No BOM available' => [
                '4e6f20424f4d20617661696c61626c65',
                'No BOM available',
            ],
        ];
    }
 
    public function ‪searchStringWildcard($haystack, $needle, $result)
    {
        self::assertSame($result, ‪StringUtility::searchStringWildcard($haystack, $needle));
    }
 
    public function ‪searchStringWildcardDataProvider(): array
    {
        return [
            'Simple wildcard single character with *' => [
                'TYPO3',
                'TY*O3',
                true
            ],
            'Simple wildcard multiple character with *' => [
                'TYPO3',
                'T*P*3',
                true
            ],
            'Simple wildcard multiple character for one placeholder with *' => [
                'TYPO3',
                'T*3',
                true
            ],
            'Simple wildcard single character with ?' => [
                'TYPO3',
                'TY?O3',
                true
            ],
            'Simple wildcard multiple character with ?' => [
                'TYPO3',
                'T?P?3',
                true
            ],
            'Simple wildcard multiple character for one placeholder with ?' => [
                'TYPO3',
                'T?3',
                false
            ],
            'RegExp' => [
                'TYPO3',
                '/^TYPO(\d)$/',
                true
            ],
        ];
    }
 
    public function ‪multibyteStringPadReturnsSameValueAsStrPadForAsciiStringsDataProvider(): \Generator
    {
        yield 'Pad right to 10 with string with uneven length' => ['ABC', 10, ' ', STR_PAD_RIGHT];
        yield 'Pad left to 10  with string with uneven length' => ['ABC', 10, ' ', STR_PAD_LEFT];
        yield 'Pad both to 10  with string with uneven length' => ['ABC', 10, ' ', STR_PAD_BOTH];
        yield 'Pad right to 10 with string with uneven length and 2 character padding' => ['ABC', 10, '12', STR_PAD_RIGHT];
        yield 'Pad left to 10 with string with uneven length and 2 character padding' => ['ABC', 10, '12', STR_PAD_LEFT];
        yield 'Pad both to 10 with string with uneven length and 2 character padding' => ['ABC', 10, '12', STR_PAD_BOTH];
 
        yield 'Pad right to 10 with string with even length' => ['AB', 10, ' ', STR_PAD_RIGHT];
        yield 'Pad left to 10  with string with even length' => ['AB', 10, ' ', STR_PAD_LEFT];
        yield 'Pad both to 10  with string with even length' => ['AB', 10, ' ', STR_PAD_BOTH];
        yield 'Pad right to 10 with string with even length and 2 character padding' => ['AB', 10, '12', STR_PAD_RIGHT];
        yield 'Pad left to 10 with string with even length and 2 character padding' => ['AB', 10, '12', STR_PAD_LEFT];
        yield 'Pad both to 10 with string with even length and 2 character padding' => ['AB', 10, '12', STR_PAD_BOTH];
    }
 
    public function ‪multibyteStringPadReturnsSameValueAsStrPadForAsciiStrings(string $string, int $length, string $pad_string, int $pad_type): void
    {
        self::assertEquals(
            str_pad($string, $length, $pad_string, $pad_type),
            ‪StringUtility::multibyteStringPad($string, $length, $pad_string, $pad_type)
        );
    }
 
    public function ‪multibyteStringPadReturnsCorrectResultsMultibyteDataProvider(): \Generator
    {
        yield 'Pad right to 8 with string with uneven length' => ['häh     ', 'häh', 8, ' ', STR_PAD_RIGHT];
        yield 'Pad left to 8  with string with uneven length' => ['     häh', 'häh', 8, ' ', STR_PAD_LEFT];
        yield 'Pad both to 8  with string with uneven length' => ['  häh   ', 'häh', 8, ' ', STR_PAD_BOTH];
        yield 'Pad right to 8 with string with uneven length and 2 character padding' => ['hühäöäöä', 'hüh', 8, 'äö', STR_PAD_RIGHT];
        yield 'Pad left to 8 with string with uneven length and 2 character padding'  => ['äöäöähüh', 'hüh', 8, 'äö', STR_PAD_LEFT];
        yield 'Pad both to 8 with string with uneven length and 2 character padding'  => ['äöhühäöä', 'hüh', 8, 'äö', STR_PAD_BOTH];
 
        yield 'Pad right to 8 with string with even length' => ['hä      ', 'hä', 8, ' ', STR_PAD_RIGHT];
        yield 'Pad left to 8  with string with even length' => ['      hä', 'hä', 8, ' ', STR_PAD_LEFT];
        yield 'Pad both to 8  with string with even length' => ['   hä   ', 'hä', 8, ' ', STR_PAD_BOTH];
        yield 'Pad right to 8 with string with even length and 2 character padding with MB char' => ['hüäöäöäö', 'hü', 8, 'äö', STR_PAD_RIGHT];
        yield 'Pad left to 8 with string with even length and 2 character padding with MB char'  => ['äöäöäöhü', 'hü', 8, 'äö', STR_PAD_LEFT];
        yield 'Pad both to 8 with string with even length and 2 character padding with MB char'  => ['äöähüäöä', 'hü', 8, 'äö', STR_PAD_BOTH];
    }
 
    public function ‪multibyteStringPadReturnsCorrectResultsMultibyte(string $expectedResult, string $string, int $length, string $pad_string, int $pad_type): void
    {
        self::assertEquals(
            $expectedResult,
            ‪StringUtility::multibyteStringPad($string, $length, $pad_string, $pad_type)
        );
    }
}