class CommonTestThemeHooks

Hook implementations for common_test.

Hierarchy

Expanded class hierarchy of CommonTestThemeHooks

File

core/modules/system/tests/modules/common_test/src/Hook/CommonTestThemeHooks.php, line 14

Namespace

Drupal\common_test\Hook
View source
class CommonTestThemeHooks {
  
  /**
   * Implements hook_theme().
   */
  public function theme() : array {
    return [
      'common_test_foo' => [
        'variables' => [
          'foo' => 'foo',
          'bar' => 'bar',
        ],
      ],
      'common_test_render_element' => [
        'render element' => 'foo',
      ],
    ];
  }
  
  /**
   * Implements hook_library_info_build().
   */
  public function libraryInfoBuild() : array {
    $libraries = [];
    if (\Drupal::state()->get('common_test.library_info_build_test')) {
      $libraries['dynamic_library'] = [
        'version' => '1.0',
        'css' => [
          'base' => [
            'common_test.css' => [],
          ],
        ],
      ];
    }
    return $libraries;
  }
  
  /**
   * Implements hook_library_info_alter().
   */
  public function libraryInfoAlter(&$libraries, $module) : void {
    if ($module === 'core' && isset($libraries['loadjs'])) {
      // Change the version of loadjs to 0.0.
      $libraries['loadjs']['version'] = '0.0';
      // Make loadjs depend on jQuery Form to test library dependencies.
      $libraries['loadjs']['dependencies'][] = 'core/internal.jquery.form';
    }
    // Alter the dynamically registered library definition.
    if ($module === 'common_test' && isset($libraries['dynamic_library'])) {
      $libraries['dynamic_library']['dependencies'] = [
        'core/jquery',
      ];
    }
  }
  
  /**
   * Implements hook_page_attachments().
   *
   * @see \Drupal\system\Tests\Common\PageRenderTest::assertPageRenderHookExceptions()
   */
  public function pageAttachments(array &$page) : void {
    $page['#attached']['library'][] = 'core/foo';
    $page['#attached']['library'][] = 'core/bar';
    $page['#cache']['tags'] = [
      'example',
    ];
    $page['#cache']['contexts'] = [
      'user.permissions',
    ];
    if (\Drupal::state()->get('common_test.hook_page_attachments.descendant_attached', FALSE)) {
      $page['content']['#attached']['library'][] = 'core/jquery';
    }
    if (\Drupal::state()->get('common_test.hook_page_attachments.render_array', FALSE)) {
      $page['something'] = [
        '#markup' => 'test',
      ];
    }
    if (\Drupal::state()->get('common_test.hook_page_attachments.early_rendering', FALSE)) {
      // Do some early rendering.
      $element = [
        '#markup' => '123',
      ];
      \Drupal::service('renderer')->render($element);
    }
  }
  
  /**
   * Implements hook_page_attachments_alter().
   *
   * @see \Drupal\system\Tests\Common\PageRenderTest::assertPageRenderHookExceptions()
   */
  public function pageAttachmentsAlter(array &$page) : void {
    // Remove a library that was added in common_test_page_attachments(), to
    // test that this hook can do what it claims to do.
    if (isset($page['#attached']['library']) && ($index = array_search('core/bar', $page['#attached']['library'])) && $index !== FALSE) {
      unset($page['#attached']['library'][$index]);
    }
    $page['#attached']['library'][] = 'core/baz';
    $page['#cache']['tags'] = [
      'example',
    ];
    $page['#cache']['contexts'] = [
      'user.permissions',
    ];
    if (\Drupal::state()->get('common_test.hook_page_attachments_alter.descendant_attached', FALSE)) {
      $page['content']['#attached']['library'][] = 'core/jquery';
    }
    if (\Drupal::state()->get('common_test.hook_page_attachments_alter.render_array', FALSE)) {
      $page['something'] = [
        '#markup' => 'test',
      ];
    }
  }
  
  /**
   * Implements hook_js_alter().
   *
   * @see \Drupal\KernelTests\Core\Asset\AttachedAssetsTest::testAlter()
   */
  public function jsAlter(&$javascript, AttachedAssetsInterface $assets, LanguageInterface $language) : void {
    // Attach alter.js above tableselect.js.
    $alter_js = \Drupal::service('extension.list.module')->getPath('common_test') . '/alter.js';
    if (array_key_exists($alter_js, $javascript) && array_key_exists('core/misc/tableselect.js', $javascript)) {
      $javascript[$alter_js]['weight'] = $javascript['core/misc/tableselect.js']['weight'] - 1;
    }
  }
  
  /**
   * Implements hook_js_settings_alter().
   *
   * @see \Drupal\system\Tests\Common\JavaScriptTest::testHeaderSetting()
   */
  public function jsSettingsAlter(&$settings, AttachedAssetsInterface $assets) : void {
    // Modify an existing setting.
    if (array_key_exists('pluralDelimiter', $settings)) {
      $settings['pluralDelimiter'] = '☃';
    }
    // Add a setting.
    $settings['foo'] = 'bar';
  }
  
  /**
   * Implements hook_preprocess().
   *
   * @see RenderTest::testDrupalRenderThemePreprocessAttached()
   */
  public function preprocess(&$variables, $hook) : void {
    if (!\Drupal::state()->get('theme_preprocess_attached_test', FALSE)) {
      return;
    }
    $variables['#attached']['library'][] = 'test/generic_preprocess';
  }
  
  /**
   * Implements hook_preprocess_HOOK().
   *
   * @see RenderTest::testDrupalRenderThemePreprocessAttached()
   */
  public function commonTestRenderElement(&$variables) : void {
    if (!\Drupal::state()->get('theme_preprocess_attached_test', FALSE)) {
      return;
    }
    $variables['#attached']['library'][] = 'test/specific_preprocess';
  }

}

Members

Title Sort descending Modifiers Object type Summary
CommonTestThemeHooks::commonTestRenderElement public function Implements hook_preprocess_HOOK().
CommonTestThemeHooks::jsAlter public function Implements hook_js_alter().
CommonTestThemeHooks::jsSettingsAlter public function Implements hook_js_settings_alter().
CommonTestThemeHooks::libraryInfoAlter public function Implements hook_library_info_alter().
CommonTestThemeHooks::libraryInfoBuild public function Implements hook_library_info_build().
CommonTestThemeHooks::pageAttachments public function Implements hook_page_attachments().
CommonTestThemeHooks::pageAttachmentsAlter public function Implements hook_page_attachments_alter().
CommonTestThemeHooks::preprocess public function Implements hook_preprocess().
CommonTestThemeHooks::theme public function Implements hook_theme().

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.