class PlaceholderGeneratorTest in Drupal 10

@coversDefaultClass \Drupal\Core\Render\PlaceholderGenerator @group Render

Hierarchy

• class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses \Drupal\Tests\PhpUnitCompatibilityTrait, \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, PhpUnitWarnings
  • class \Drupal\Tests\Core\Render\RendererTestBase
    • class \Drupal\Tests\Core\Render\PlaceholderGeneratorTest

File

core/tests/Drupal/Tests/Core/Render/PlaceholderGeneratorTest.php, line 12

Namespace

Drupal\Tests\Core\Render

class PlaceholderGeneratorTest extends RendererTestBase {

  /**
   * The tested placeholder generator.
   *
   * @var \Drupal\Core\Render\PlaceholderGenerator
   */
  protected $placeholderGenerator;

  /**
   * @covers ::createPlaceholder
   * @dataProvider providerCreatePlaceholderGeneratesValidHtmlMarkup
   *
   * Ensure that the generated placeholder markup is valid. If it is not, then
   * simply using DOMDocument on HTML that contains placeholders may modify the
   * placeholders' markup, which would make it impossible to replace the
   * placeholders: the placeholder markup in #attached versus that in the HTML
   * processed by DOMDocument would no longer match.
   */
  public function testCreatePlaceholderGeneratesValidHtmlMarkup(array $element) {
    $build = $this->placeholderGenerator
      ->createPlaceholder($element);
    $original_placeholder_markup = (string) $build['#markup'];
    $processed_placeholder_markup = Html::serialize(Html::load($build['#markup']));
    $this
      ->assertEquals($original_placeholder_markup, $processed_placeholder_markup);
  }

  /**
   * Create an element with #lazy_builder callback. Between two renders, cache
   * contexts nor tags sort change. Placeholder should generate same hash to not
   * be rendered twice.
   *
   * @covers ::createPlaceholder
   */
  public function testRenderPlaceholdersDifferentSortedContextsTags() {
    $contexts_1 = [
      'user',
      'foo',
    ];
    $contexts_2 = [
      'foo',
      'user',
    ];
    $tags_1 = [
      'current-temperature',
      'foo',
    ];
    $tags_2 = [
      'foo',
      'current-temperature',
    ];
    $test_element = [
      '#cache' => [
        'max-age' => Cache::PERMANENT,
      ],
      '#lazy_builder' => [
        'Drupal\\Tests\\Core\\Render\\PlaceholdersTest::callback',
        [
          'foo' => TRUE,
        ],
      ],
    ];
    $test_element['#cache']['contexts'] = $contexts_1;
    $test_element['#cache']['tags'] = $tags_1;
    $placeholder_element1 = $this->placeholderGenerator
      ->createPlaceholder($test_element);
    $test_element['#cache']['contexts'] = $contexts_2;
    $test_element['#cache']['tags'] = $tags_1;
    $placeholder_element2 = $this->placeholderGenerator
      ->createPlaceholder($test_element);
    $test_element['#cache']['contexts'] = $contexts_1;
    $test_element['#cache']['tags'] = $tags_2;
    $placeholder_element3 = $this->placeholderGenerator
      ->createPlaceholder($test_element);

    // Verify placeholder and specially hash are same with different contexts
    // order.
    $this
      ->assertSame((string) $placeholder_element1['#markup'], (string) $placeholder_element2['#markup']);

    // Verify placeholder and specially hash are same with different tags order.
    $this
      ->assertSame((string) $placeholder_element1['#markup'], (string) $placeholder_element3['#markup']);
  }

  /**
   * @return array
   */
  public function providerCreatePlaceholderGeneratesValidHtmlMarkup() {
    return [
      'multiple-arguments' => [
        [
          '#lazy_builder' => [
            'Drupal\\Tests\\Core\\Render\\PlaceholdersTest::callback',
            [
              'foo',
              'bar',
            ],
          ],
        ],
      ],
      'special-character-&' => [
        [
          '#lazy_builder' => [
            'Drupal\\Tests\\Core\\Render\\PlaceholdersTest::callback',
            [
              'foo&bar',
            ],
          ],
        ],
      ],
      'special-character-"' => [
        [
          '#lazy_builder' => [
            'Drupal\\Tests\\Core\\Render\\PlaceholdersTest::callback',
            [
              'foo"bar',
            ],
          ],
        ],
      ],
      'special-character-<' => [
        [
          '#lazy_builder' => [
            'Drupal\\Tests\\Core\\Render\\PlaceholdersTest::callback',
            [
              'foo<bar',
            ],
          ],
        ],
      ],
      'special-character->' => [
        [
          '#lazy_builder' => [
            'Drupal\\Tests\\Core\\Render\\PlaceholdersTest::callback',
            [
              'foo>bar',
            ],
          ],
        ],
      ],
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
PhpUnitWarnings::$deprecationWarnings	private static	property	Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning	public	function	Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
PlaceholderGeneratorTest::$placeholderGenerator	protected	property	The tested placeholder generator. Overrides RendererTestBase::$placeholderGenerator
PlaceholderGeneratorTest::providerCreatePlaceholderGeneratesValidHtmlMarkup	public	function
PlaceholderGeneratorTest::testCreatePlaceholderGeneratesValidHtmlMarkup	public	function	@covers ::createPlaceholder @dataProvider providerCreatePlaceholderGeneratesValidHtmlMarkup
PlaceholderGeneratorTest::testRenderPlaceholdersDifferentSortedContextsTags	public	function	Create an element with #lazy_builder callback. Between two renders, cache contexts nor tags sort change. Placeholder should generate same hash to not be rendered twice.
RendererTestBase::$cacheContextsManager	protected	property
RendererTestBase::$cacheFactory	protected	property
RendererTestBase::$controllerResolver	protected	property	The mocked controller resolver.
RendererTestBase::$currentUserRole	protected	property	The simulated "current" user role, for use in tests with cache contexts.
RendererTestBase::$elementInfo	protected	property	The mocked element info.
RendererTestBase::$memoryCache	protected	property
RendererTestBase::$renderCache	protected	property	The tested render cache.
RendererTestBase::$renderer	protected	property	The tested renderer.
RendererTestBase::$rendererConfig	protected	property	The mocked renderer configuration.
RendererTestBase::$requestStack	protected	property
RendererTestBase::$themeManager	protected	property	The mocked theme manager.
RendererTestBase::assertRenderCacheItem	protected	function	Asserts a render cache item.
RendererTestBase::randomContextValue	protected	function	Generates a random context value for the placeholder tests.
RendererTestBase::setUp	protected	function	Overrides UnitTestCase::setUp	3
RendererTestBase::setupMemoryCache	protected	function	Sets up a memory-based render cache back-end.
RendererTestBase::setUpRequest	protected	function	Sets up a request object on the request stack.
RendererTestBase::setUpUnusedCache	protected	function	Sets up a render cache back-end that is asserted to be never used.
UnitTestCase::$randomGenerator	protected	property	The random generator.
UnitTestCase::$root	protected	property	The app root.	1
UnitTestCase::getClassResolverStub	protected	function	Returns a stub class resolver.
UnitTestCase::getConfigFactoryStub	public	function	Returns a stub config factory that behaves according to the passed array.
UnitTestCase::getConfigStorageStub	public	function	Returns a stub config storage that returns the supplied configuration.
UnitTestCase::getContainerWithCacheTagsInvalidator	protected	function	Sets up a container with a cache tags invalidator.
UnitTestCase::getRandomGenerator	protected	function	Gets the random generator for the utility methods.
UnitTestCase::getStringTranslationStub	public	function	Returns a stub translation manager that just returns the passed string.
UnitTestCase::randomMachineName	public	function	Generates a unique random string containing letters and numbers.
UnitTestCase::setUpBeforeClass	public static	function