class SearchPageResourceTestBase

Same name and namespace in other branches
  1. 11.x core/modules/search/tests/src/Functional/Rest/SearchPageResourceTestBase.php \Drupal\Tests\search\Functional\Rest\SearchPageResourceTestBase
  2. 10 core/modules/search/tests/src/Functional/Rest/SearchPageResourceTestBase.php \Drupal\Tests\search\Functional\Rest\SearchPageResourceTestBase
  3. 8.9.x core/modules/search/tests/src/Functional/Rest/SearchPageResourceTestBase.php \Drupal\Tests\search\Functional\Rest\SearchPageResourceTestBase
  4. 8.9.x core/modules/rest/tests/src/Functional/EntityResource/SearchPage/SearchPageResourceTestBase.php \Drupal\Tests\rest\Functional\EntityResource\SearchPage\SearchPageResourceTestBase

Hierarchy

Expanded class hierarchy of SearchPageResourceTestBase

3 files declare their use of SearchPageResourceTestBase
SearchPageHalJsonAnonTest.php in core/modules/hal/tests/src/Functional/search/SearchPageHalJsonAnonTest.php
SearchPageHalJsonBasicAuthTest.php in core/modules/hal/tests/src/Functional/search/SearchPageHalJsonBasicAuthTest.php
SearchPageHalJsonCookieTest.php in core/modules/hal/tests/src/Functional/search/SearchPageHalJsonCookieTest.php

File

core/modules/search/tests/src/Functional/Rest/SearchPageResourceTestBase.php, line 8

Namespace

Drupal\Tests\search\Functional\Rest
View source
abstract class SearchPageResourceTestBase extends ConfigEntityResourceTestBase {
  
  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'node',
    'search',
  ];
  
  /**
   * {@inheritdoc}
   */
  protected static $entityTypeId = 'search_page';
  
  /**
   * @var \Drupal\search\SearchPageInterface
   */
  protected $entity;
  
  /**
   * {@inheritdoc}
   */
  protected function setUpAuthorization($method) {
    switch ($method) {
      case 'GET':
        $this->grantPermissionsToTestedRole([
          'access content',
        ]);
        break;

      case 'POST':
      case 'PATCH':
      case 'DELETE':
        $this->grantPermissionsToTestedRole([
          'administer search',
        ]);
        break;

    }
  }
  
  /**
   * {@inheritdoc}
   */
  protected function createEntity() {
    $search_page = SearchPage::create([
      'id' => 'hinode_search',
      'plugin' => 'node_search',
      'label' => 'Search of magnetic activity of the Sun',
      'path' => 'sun',
    ]);
    $search_page->save();
    return $search_page;
  }
  
  /**
   * {@inheritdoc}
   */
  protected function getExpectedNormalizedEntity() {
    return [
      'configuration' => [
        'rankings' => [],
      ],
      'dependencies' => [
        'module' => [
          'node',
        ],
      ],
      'id' => 'hinode_search',
      'label' => 'Search of magnetic activity of the Sun',
      'langcode' => 'en',
      'path' => 'sun',
      'plugin' => 'node_search',
      'status' => TRUE,
      'uuid' => $this->entity
        ->uuid(),
      'weight' => 0,
    ];
  }
  
  /**
   * {@inheritdoc}
   */
  protected function getNormalizedPostEntity() {
    // @todo Update in https://www.drupal.org/node/2300677.
    return [];
  }
  
  /**
   * {@inheritdoc}
   */
  protected function getExpectedUnauthorizedAccessMessage($method) {
    switch ($method) {
      case 'GET':
        return "The 'access content' permission is required.";
      default:
        return parent::getExpectedUnauthorizedAccessMessage($method);
    }
  }
  
  /**
   * {@inheritdoc}
   */
  protected function getExpectedUnauthorizedEntityAccessCacheability($is_authenticated) {
    // @see \Drupal\search\SearchPageAccessControlHandler::checkAccess()
    return parent::getExpectedUnauthorizedEntityAccessCacheability($is_authenticated)->addCacheTags([
      'config:search.page.hinode_search',
    ]);
  }

}

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