FormattableMarkupTest.php

<?php

namespace Drupal\Tests\Component\Render;

use Drupal\Component\Render\FormattableMarkup;
use PHPUnit\Framework\TestCase;
use Symfony\Bridge\PhpUnit\ExpectDeprecationTrait;

/**
 * Tests the TranslatableMarkup class.
 *
 * @coversDefaultClass \Drupal\Component\Render\FormattableMarkup
 * @group utility
 */
class FormattableMarkupTest extends TestCase {
    use ExpectDeprecationTrait;
    
    /**
     * The error message of the last error in the error handler.
     *
     * @var string
     */
    protected $lastErrorMessage;
    
    /**
     * The error number of the last error in the error handler.
     *
     * @var int
     */
    protected $lastErrorNumber;
    
    /**
     * @covers ::__toString
     * @covers ::jsonSerialize
     */
    public function testToString() {
        $string = 'Can I please have a @replacement';
        $formattable_string = new FormattableMarkup($string, [
            '@replacement' => 'kitten',
        ]);
        $text = (string) $formattable_string;
        $this->assertEquals('Can I please have a kitten', $text);
        $text = $formattable_string->jsonSerialize();
        $this->assertEquals('Can I please have a kitten', $text);
    }
    
    /**
     * @covers ::count
     */
    public function testCount() {
        $string = 'Can I please have a @replacement';
        $formattable_string = new FormattableMarkup($string, [
            '@replacement' => 'kitten',
        ]);
        $this->assertEquals(strlen($string), $formattable_string->count());
    }
    
    /**
     * @covers ::__toString
     * @dataProvider providerTestNullPlaceholder
     * @group legacy
     */
    public function testNullPlaceholder(string $expected, string $string, array $arguments, string $expected_deprecation) : void {
        $this->expectDeprecation($expected_deprecation);
        $this->assertEquals($expected, (string) new FormattableMarkup($string, $arguments));
    }
    
    /**
     * Data provider for FormattableMarkupTest::testNullPlaceholder().
     *
     * @return array
     */
    public function providerTestNullPlaceholder() {
        return [
            [
                '',
                '@empty',
                [
                    '@empty' => NULL,
                ],
                'Deprecated NULL placeholder value for key (@empty) in: "@empty". This will throw a PHP error in drupal:11.0.0. See https://www.drupal.org/node/3318826',
            ],
            [
                '',
                ':empty',
                [
                    ':empty' => NULL,
                ],
                'Deprecated NULL placeholder value for key (:empty) in: ":empty". This will throw a PHP error in drupal:11.0.0. See https://www.drupal.org/node/3318826',
            ],
            [
                '<em class="placeholder"></em>',
                '%empty',
                [
                    '%empty' => NULL,
                ],
                'Deprecated NULL placeholder value for key (%%empty) in: "%%empty". This will throw a PHP error in drupal:11.0.0. See https://www.drupal.org/node/3318826',
            ],
        ];
    }
    
    /**
     * Custom error handler that saves the last error.
     *
     * We need this custom error handler because we cannot rely on the error to
     * exception conversion as __toString is never allowed to leak any kind of
     * exception.
     *
     * @param int $error_number
     *   The error number.
     * @param string $error_message
     *   The error message.
     */
    public function errorHandler($error_number, $error_message) {
        $this->lastErrorNumber = $error_number;
        $this->lastErrorMessage = $error_message;
    }
    
    /**
     * @covers ::__toString
     * @dataProvider providerTestUnexpectedPlaceholder
     */
    public function testUnexpectedPlaceholder($string, $arguments, $error_number, $error_message) {
        // We set a custom error handler because of https://github.com/sebastianbergmann/phpunit/issues/487
        set_error_handler([
            $this,
            'errorHandler',
        ]);
        // We want this to trigger an error.
        $markup = new FormattableMarkup($string, $arguments);
        // Cast it to a string which will generate the errors.
        $output = (string) $markup;
        restore_error_handler();
        // The string should not change.
        $this->assertEquals($string, $output);
        $this->assertEquals($error_number, $this->lastErrorNumber);
        $this->assertEquals($error_message, $this->lastErrorMessage);
    }
    
    /**
     * Data provider for FormattableMarkupTest::testUnexpectedPlaceholder().
     *
     * @return array
     */
    public function providerTestUnexpectedPlaceholder() {
        return [
            [
                'Non alpha starting character: ~placeholder',
                [
                    '~placeholder' => 'replaced',
                ],
                E_USER_WARNING,
                'Invalid placeholder (~placeholder) with string: "Non alpha starting character: ~placeholder"',
            ],
            [
                'Alpha starting character: placeholder',
                [
                    'placeholder' => 'replaced',
                ],
                E_USER_WARNING,
                'Invalid placeholder (placeholder) with string: "Alpha starting character: placeholder"',
            ],
            // Ensure that where the placeholder is located in the string is
            // irrelevant.
[
                'placeholder',
                [
                    'placeholder' => 'replaced',
                ],
                E_USER_WARNING,
                'Invalid placeholder (placeholder) with string: "placeholder"',
            ],
        ];
    }
    
    /**
     * @group legacy
     */
    public function testNoReplacementUnsupportedVariable() {
        $this->expectDeprecation('Support for keys without a placeholder prefix is deprecated in Drupal 9.1.0 and will be removed in Drupal 10.0.0. Invalid placeholder (foo) with string: "No replacements"');
        $markup = new FormattableMarkup('No replacements', [
            'foo' => 'bar',
        ]);
        // Cast it to a string which will generate the deprecation notice.
        $output = (string) $markup;
    }

}