TaggingTest.php

Same filename in other branches
  1. 9 core/tests/Drupal/KernelTests/Core/Database/TaggingTest.php
  2. 10 core/tests/Drupal/KernelTests/Core/Database/TaggingTest.php
  3. 11.x core/tests/Drupal/KernelTests/Core/Database/TaggingTest.php

Namespace

Drupal\KernelTests\Core\Database

File

core/tests/Drupal/KernelTests/Core/Database/TaggingTest.php

View source
<?php

namespace Drupal\KernelTests\Core\Database;


/**
 * Tests the tagging capabilities of the Select builder.
 *
 * Tags are a way to flag queries for alter hooks so they know
 * what type of query it is, such as "node_access".
 *
 * @group Database
 */
class TaggingTest extends DatabaseTestBase {
    
    /**
     * Confirms that a query has a tag added to it.
     */
    public function testHasTag() {
        $query = $this->connection
            ->select('test');
        $query->addField('test', 'name');
        $query->addField('test', 'age', 'age');
        $query->addTag('test');
        $this->assertTrue($query->hasTag('test'), 'hasTag() returned true.');
        $this->assertFalse($query->hasTag('other'), 'hasTag() returned false.');
    }
    
    /**
     * Tests query tagging "has all of these tags" functionality.
     */
    public function testHasAllTags() {
        $query = $this->connection
            ->select('test');
        $query->addField('test', 'name');
        $query->addField('test', 'age', 'age');
        $query->addTag('test');
        $query->addTag('other');
        $this->assertTrue($query->hasAllTags('test', 'other'), 'hasAllTags() returned true.');
        $this->assertFalse($query->hasAllTags('test', 'stuff'), 'hasAllTags() returned false.');
    }
    
    /**
     * Tests query tagging "has at least one of these tags" functionality.
     */
    public function testHasAnyTag() {
        $query = $this->connection
            ->select('test');
        $query->addField('test', 'name');
        $query->addField('test', 'age', 'age');
        $query->addTag('test');
        $this->assertTrue($query->hasAnyTag('test', 'other'), 'hasAnyTag() returned true.');
        $this->assertFalse($query->hasAnyTag('other', 'stuff'), 'hasAnyTag() returned false.');
    }
    
    /**
     * Confirms that an extended query has a tag added to it.
     */
    public function testExtenderHasTag() {
        $query = $this->connection
            ->select('test')
            ->extend('Drupal\\Core\\Database\\Query\\SelectExtender');
        $query->addField('test', 'name');
        $query->addField('test', 'age', 'age');
        $query->addTag('test');
        $this->assertTrue($query->hasTag('test'), 'hasTag() returned true.');
        $this->assertFalse($query->hasTag('other'), 'hasTag() returned false.');
    }
    
    /**
     * Tests extended query tagging "has all of these tags" functionality.
     */
    public function testExtenderHasAllTags() {
        $query = $this->connection
            ->select('test')
            ->extend('Drupal\\Core\\Database\\Query\\SelectExtender');
        $query->addField('test', 'name');
        $query->addField('test', 'age', 'age');
        $query->addTag('test');
        $query->addTag('other');
        $this->assertTrue($query->hasAllTags('test', 'other'), 'hasAllTags() returned true.');
        $this->assertFalse($query->hasAllTags('test', 'stuff'), 'hasAllTags() returned false.');
    }
    
    /**
     * Tests extended query tagging "has at least one of these tags" functionality.
     */
    public function testExtenderHasAnyTag() {
        $query = $this->connection
            ->select('test')
            ->extend('Drupal\\Core\\Database\\Query\\SelectExtender');
        $query->addField('test', 'name');
        $query->addField('test', 'age', 'age');
        $query->addTag('test');
        $this->assertTrue($query->hasAnyTag('test', 'other'), 'hasAnyTag() returned true.');
        $this->assertFalse($query->hasAnyTag('other', 'stuff'), 'hasAnyTag() returned false.');
    }
    
    /**
     * Tests that we can attach metadata to a query object.
     *
     * This is how we pass additional context to alter hooks.
     */
    public function testMetaData() {
        $query = $this->connection
            ->select('test');
        $query->addField('test', 'name');
        $query->addField('test', 'age', 'age');
        $data = [
            'a' => 'A',
            'b' => 'B',
        ];
        $query->addMetaData('test', $data);
        $return = $query->getMetaData('test');
        $this->assertEqual($data, $return, 'Correct metadata returned.');
        $return = $query->getMetaData('nothere');
        $this->assertNull($return, 'Non-existent key returned NULL.');
    }

}

Classes

Title Deprecated Summary
TaggingTest Tests the tagging capabilities of the Select builder.

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