You are here

Home » API reference » Drupal 10 » TaxonomyTermArgumentDepthTest.php

class TaxonomyTermArgumentDepthTest in Drupal 10

Same name in this branch
  1. 10 core/modules/taxonomy/tests/src/Functional/Views/TaxonomyTermArgumentDepthTest.php \Drupal\Tests\taxonomy\Functional\Views\TaxonomyTermArgumentDepthTest
  2. 10 core/modules/taxonomy/tests/src/Kernel/Views/TaxonomyTermArgumentDepthTest.php \Drupal\Tests\taxonomy\Kernel\Views\TaxonomyTermArgumentDepthTest
Same name and namespace in other branches
  1. 9 core/modules/taxonomy/tests/src/Kernel/Views/TaxonomyTermArgumentDepthTest.php \Drupal\Tests\taxonomy\Kernel\Views\TaxonomyTermArgumentDepthTest

Test the taxonomy term with depth argument.

@group taxonomy

Hierarchy

Expanded class hierarchy of TaxonomyTermArgumentDepthTest

File

core/modules/taxonomy/tests/src/Kernel/Views/TaxonomyTermArgumentDepthTest.php, line 12

Namespace

Drupal\Tests\taxonomy\Kernel\Views
View source 
class TaxonomyTermArgumentDepthTest extends TaxonomyTestBase {

  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'taxonomy',
    'taxonomy_test_views',
    'views',
    'node',
  ];

  /**
   * Views IDs used by this test.
   *
   * @var string[]
   */
  public static $testViews = [
    'test_argument_taxonomy_index_tid_depth',
  ];

  /**
   * The terms used in the test.
   *
   * @var \Drupal\taxonomy\TermInterface[]
   */
  protected $terms = [];

  /**
   * The view executable used in the test.
   *
   * @var \Drupal\views\ViewExecutable
   */
  protected $view;

  /**
   * {@inheritdoc}
   */
  protected function setUp($import_test_views = TRUE) : void {
    parent::setUp($import_test_views);

    // Install node_access schema in order to successfully re-save nodes.
    $this
      ->installSchema('node', [
      'node_access',
    ]);

    // Create a hierarchy 5 deep. Note the parent setup function creates two
    // top-level terms w/o children.
    $first = $this
      ->createTerm([
      'name' => 'First',
    ]);
    $second = $this
      ->createTerm([
      'name' => 'Second',
      'parent' => $first
        ->id(),
    ]);
    $third = $this
      ->createTerm([
      'name' => 'Third',
      'parent' => $second
        ->id(),
    ]);
    $fourth = $this
      ->createTerm([
      'name' => 'Fourth',
      'parent' => $third
        ->id(),
    ]);
    $fifth = $this
      ->createTerm([
      'name' => 'Fifth',
      'parent' => $fourth
        ->id(),
    ]);
    $this->terms = [
      $first,
      $second,
      $third,
      $fourth,
      $fifth,
    ];

    // Create a node w/o any terms.
    $settings = [
      'type' => 'article',
    ];
    $this->nodes[] = $this
      ->drupalCreateNode($settings);

    // Create a node with only the top level term.
    $settings['field_views_testing_tags'][0]['target_id'] = $first
      ->id();
    $this->nodes[] = $this
      ->drupalCreateNode($settings);

    // Create a node with only the third level term.
    $settings['field_views_testing_tags'][0]['target_id'] = $third
      ->id();
    $this->nodes[] = $this
      ->drupalCreateNode($settings);

    // Create a node with only the fifth level term.
    $settings['field_views_testing_tags'][0]['target_id'] = $fifth
      ->id();
    $this->nodes[] = $this
      ->drupalCreateNode($settings);
    $this->view = Views::getView(self::$testViews[0]);

    // Fix the created date to match the expectations of the order by in the
    // view. Node 1 should be the most recent node and node 6 should be the
    // oldest.
    $time = \Drupal::time();
    foreach ($this->nodes as $i => $node) {
      $node
        ->setCreatedTime($time
        ->getRequestTime() - $i)
        ->save();
    }
  }

  /**
   * Tests the terms with depth filter.
   */
  public function testTermWithDepthFilter() : void {

    // Default view has an empty value for this filter, so all nodes should be
    // returned.
    $expected = [
      [
        'nid' => 1,
      ],
      [
        'nid' => 2,
      ],
      [
        'nid' => 3,
      ],
      [
        'nid' => 4,
      ],
      [
        'nid' => 5,
      ],
      [
        'nid' => 6,
      ],
    ];
    $this
      ->executeView($this->view);
    $this
      ->assertIdenticalResultsetHelper($this->view, $expected, [
      'nid' => 'nid',
    ], 'assertIdentical');

    // Set filter to search on top-level term, with depth 0.
    $expected = [
      [
        'nid' => 4,
      ],
    ];
    $this
      ->assertTermWithDepthResult($expected, $this->terms[0]
      ->id(), 0);

    // Top-level term, depth 1.
    $expected = [
      [
        'nid' => 4,
      ],
    ];
    $this
      ->assertTermWithDepthResult($expected, $this->terms[0]
      ->id(), 1);

    // Top-level term, depth 2.
    $expected = [
      [
        'nid' => 4,
      ],
      [
        'nid' => 5,
      ],
    ];
    $this
      ->assertTermWithDepthResult($expected, $this->terms[0]
      ->id(), 2);

    // Top-level term, depth 9.
    $expected = [
      [
        'nid' => 4,
      ],
      [
        'nid' => 5,
      ],
      [
        'nid' => 6,
      ],
    ];
    $this
      ->assertTermWithDepthResult($expected, $this->terms[0]
      ->id(), 9);

    // Second-level term, depth 1.
    $expected = [
      [
        'nid' => 5,
      ],
    ];
    $this
      ->assertTermWithDepthResult($expected, $this->terms[1]
      ->id(), 1);

    // Third-level term, depth 0.
    $expected = [
      [
        'nid' => 5,
      ],
    ];
    $this
      ->assertTermWithDepthResult($expected, $this->terms[2]
      ->id(), 0);

    // Third-level term, depth 1.
    $expected = [
      [
        'nid' => 5,
      ],
    ];
    $this
      ->assertTermWithDepthResult($expected, $this->terms[2]
      ->id(), 1);

    // Third-level term, depth -2.
    $expected = [
      [
        'nid' => 4,
      ],
      [
        'nid' => 5,
      ],
    ];
    $this
      ->assertTermWithDepthResult($expected, $this->terms[2]
      ->id(), -2);

    // Third-level term, depth -9.
    $expected = [
      [
        'nid' => 4,
      ],
      [
        'nid' => 5,
      ],
    ];
    $this
      ->assertTermWithDepthResult($expected, $this->terms[2]
      ->id(), -9);

    // Fifth-level term, depth -9.
    $expected = [
      [
        'nid' => 4,
      ],
      [
        'nid' => 5,
      ],
      [
        'nid' => 6,
      ],
    ];
    $this
      ->assertTermWithDepthResult($expected, $this->terms[4]
      ->id(), -9);

    // Third-level term, depth -1.
    $expected = [
      [
        'nid' => 5,
      ],
    ];
    $this
      ->assertTermWithDepthResult($expected, $this->terms[2]
      ->id(), -1);

    // Third-level and second-level term, depth -1, using a plus sign.
    $expected = [
      [
        'nid' => 4,
      ],
      [
        'nid' => 5,
      ],
    ];
    $this
      ->assertTermWithDepthResult($expected, $this->terms[2]
      ->id() . '+' . $this->terms[1]
      ->id(), -1, TRUE);

    // Third-level and second-level term, depth -1, using a comma. Note that due
    // to performance the "and" meaning of comma is not supported.
    $expected = [
      [
        'nid' => 4,
      ],
      [
        'nid' => 5,
      ],
    ];
    $this
      ->assertTermWithDepthResult($expected, $this->terms[2]
      ->id() . ',' . $this->terms[1]
      ->id(), -1, TRUE);

    // Top-level term and second level term, depth 1, using a plus sign.
    $expected = [
      [
        'nid' => 4,
      ],
      [
        'nid' => 5,
      ],
    ];
    $this
      ->assertTermWithDepthResult($expected, $this->terms[0]
      ->id() . '+' . $this->terms[1]
      ->id(), 1, TRUE);

    // Top-level term and second level term, depth 1, using a comma. Note that
    // due to performance the "and" meaning of comma is not supported.
    $expected = [
      [
        'nid' => 4,
      ],
      [
        'nid' => 5,
      ],
    ];
    $this
      ->assertTermWithDepthResult($expected, $this->terms[0]
      ->id() . ',' . $this->terms[1]
      ->id(), 1, TRUE);
  }

  /**
   * Asserts the result of the view for the given arguments.
   *
   * @param array $expected
   *   The expected views result.
   * @param int|string $tid
   *   The term ID or IDs to use as an argument.
   * @param int $depth
   *   The depth to search.
   * @param bool $break_phrase
   *   Whether to break the argument up into multiple terms.
   *
   * @internal
   */
  protected function assertTermWithDepthResult(array $expected, $tid, int $depth, bool $break_phrase = FALSE) : void {
    $this->view
      ->destroy();
    $this->view
      ->initDisplay();
    $arguments = $this->view->displayHandlers
      ->get('default')
      ->getOption('arguments');
    $arguments['term_node_tid_depth']['depth'] = $depth;
    $arguments['term_node_tid_depth']['break_phrase'] = $break_phrase;
    $this->view->displayHandlers
      ->get('default')
      ->setOption('arguments', $arguments);
    $this
      ->executeView($this->view, [
      $tid,
    ]);
    $this
      ->assertIdenticalResultsetHelper($this->view, $expected, [
      'nid' => 'nid',
    ], 'assertIdentical');
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 1
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertNoField protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType
EntityReferenceTestTrait::createEntityReferenceField protected function Creates a field of an entity reference field storage on the specified bundle.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
KernelTestBase::$backupGlobals protected property Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes protected property Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist protected property Contains a few static class properties for performance.
KernelTestBase::$classLoader protected property
KernelTestBase::$configImporter protected property @todo Move into Config test base class. 3
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$preserveGlobalState protected property Do not forward any global state from the parent process to the processes that run the actual tests.
KernelTestBase::$root protected property The app root.
KernelTestBase::$runTestInSeparateProcess protected property Kernel tests are run in separate processes because they allow autoloading of code from extensions. Running the test in a separate process isolates this behavior from other tests. Subclasses should not override this property.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 4
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function 1
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::bootKernel private function Bootstraps a kernel for a test.
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test.
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 2
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable private static function Returns the modules to enable for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs database tables from a module schema definition.
KernelTestBase::prepareTemplate protected function
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 14
KernelTestBase::render protected function Renders a render array.
KernelTestBase::setInstallProfile protected function Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass public static function
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 1
KernelTestBase::stop protected function Stops test execution.
KernelTestBase::tearDown protected function 3
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__sleep public function Prevents serializing any properties.
NodeCreationTrait::createNode protected function Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title.
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.
RandomGeneratorTrait::$randomGenerator protected property The random generator.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers.
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate public function Callback for random string validation.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TaxonomyTermArgumentDepthTest::$modules protected static property Modules to enable. Overrides TaxonomyTestBase::$modules
TaxonomyTermArgumentDepthTest::$terms protected property The terms used in the test.
TaxonomyTermArgumentDepthTest::$testViews public static property Views IDs used by this test. Overrides ViewsKernelTestBase::$testViews
TaxonomyTermArgumentDepthTest::$view protected property The view executable used in the test.
TaxonomyTermArgumentDepthTest::assertTermWithDepthResult protected function Asserts the result of the view for the given arguments.
TaxonomyTermArgumentDepthTest::setUp protected function Overrides TaxonomyTestBase::setUp
TaxonomyTermArgumentDepthTest::testTermWithDepthFilter public function Tests the terms with depth filter.
TaxonomyTestBase::$nodes protected property Stores the nodes used for the different tests.
TaxonomyTestBase::$term1 protected property Stores the first term used in the different tests.
TaxonomyTestBase::$term2 protected property Stores the second term used in the different tests.
TaxonomyTestBase::$vocabulary protected property The vocabulary used for creating terms.
TaxonomyTestBase::createTerm protected function Creates and returns a taxonomy term.
TaxonomyTestBase::mockStandardInstall protected function Provides a workaround for the inability to use the standard profile.
TestRequirementsTrait::checkModuleRequirements private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements protected function Check module requirements for the Drupal use case.
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role.
UserCreationTrait::createRole protected function Creates a role with specified permissions.
UserCreationTrait::createUser protected function Create a user with a given set of permissions.
UserCreationTrait::grantPermissions protected function Grant permissions to a user role.
UserCreationTrait::setCurrentUser protected function Switch the current logged in user.
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user.
ViewResultAssertionTrait::assertIdenticalResultset protected function Verifies that a result set returned by a View matches expected values.
ViewResultAssertionTrait::assertIdenticalResultsetHelper protected function Performs View result assertions.
ViewResultAssertionTrait::assertNotIdenticalResultset protected function Verifies that a result set returned by a View differs from certain values.
ViewsKernelTestBase::dataSet protected function Returns a very simple test dataset.
ViewsKernelTestBase::executeView protected function Executes a view.
ViewsKernelTestBase::orderResultSet protected function Orders a nested array containing a result set based on a given column.
ViewsKernelTestBase::schemaDefinition protected function Returns the schema definition. 1
ViewsKernelTestBase::setUpFixtures protected function Sets up the configuration and schema of views and views_test_data modules. 1
ViewsKernelTestBase::viewsData protected function Returns the views data definition. 3