class AlterTest

Same name in this branch
  1. 10 core/modules/system/tests/src/Kernel/Common/AlterTest.php \Drupal\Tests\system\Kernel\Common\AlterTest
  2. 10 core/modules/system/tests/src/Functional/Form/AlterTest.php \Drupal\Tests\system\Functional\Form\AlterTest
Same name in other branches
  1. 9 core/modules/system/tests/src/Functional/Form/AlterTest.php \Drupal\Tests\system\Functional\Form\AlterTest
  2. 9 core/modules/system/tests/src/Functional/Common/AlterTest.php \Drupal\Tests\system\Functional\Common\AlterTest
  3. 9 core/tests/Drupal/KernelTests/Core/Database/AlterTest.php \Drupal\KernelTests\Core\Database\AlterTest
  4. 8.9.x core/modules/system/tests/src/Functional/Form/AlterTest.php \Drupal\Tests\system\Functional\Form\AlterTest
  5. 8.9.x core/modules/system/tests/src/Functional/Common/AlterTest.php \Drupal\Tests\system\Functional\Common\AlterTest
  6. 8.9.x core/tests/Drupal/KernelTests/Core/Database/AlterTest.php \Drupal\KernelTests\Core\Database\AlterTest
  7. 11.x core/modules/system/tests/src/Kernel/Common/AlterTest.php \Drupal\Tests\system\Kernel\Common\AlterTest
  8. 11.x core/modules/system/tests/src/Functional/Form/AlterTest.php \Drupal\Tests\system\Functional\Form\AlterTest
  9. 11.x core/tests/Drupal/KernelTests/Core/Database/AlterTest.php \Drupal\KernelTests\Core\Database\AlterTest

Tests the hook_query_alter capabilities of the Select builder.

@group Database

Hierarchy

Expanded class hierarchy of AlterTest

See also

database_test_query_alter()

File

core/tests/Drupal/KernelTests/Core/Database/AlterTest.php, line 13

Namespace

Drupal\KernelTests\Core\Database
View source
class AlterTest extends DatabaseTestBase {
    
    /**
     * Tests that we can do basic alters.
     */
    public function testSimpleAlter() : void {
        $query = $this->connection
            ->select('test');
        $query->addField('test', 'name');
        $query->addField('test', 'age', 'age');
        $query->addTag('database_test_alter_add_range');
        $result = $query->execute()
            ->fetchAll();
        $this->assertCount(2, $result, 'Returned the correct number of rows.');
    }
    
    /**
     * Tests that we can alter the joins on a query.
     */
    public function testAlterWithJoin() : void {
        $query = $this->connection
            ->select('test_task');
        $tid_field = $query->addField('test_task', 'tid');
        $task_field = $query->addField('test_task', 'task');
        $query->orderBy($task_field);
        $query->addTag('database_test_alter_add_join');
        $result = $query->execute();
        $records = $result->fetchAll();
        $this->assertCount(2, $records, 'Returned the correct number of rows.');
        $this->assertEquals('George', $records[0]->name, 'Correct data retrieved.');
        $this->assertEquals(4, $records[0]->{$tid_field}, 'Correct data retrieved.');
        $this->assertEquals('sing', $records[0]->{$task_field}, 'Correct data retrieved.');
        $this->assertEquals('George', $records[1]->name, 'Correct data retrieved.');
        $this->assertEquals(5, $records[1]->{$tid_field}, 'Correct data retrieved.');
        $this->assertEquals('sleep', $records[1]->{$task_field}, 'Correct data retrieved.');
    }
    
    /**
     * Tests that we can alter a query's conditionals.
     */
    public function testAlterChangeConditional() : void {
        $query = $this->connection
            ->select('test_task');
        $tid_field = $query->addField('test_task', 'tid');
        $pid_field = $query->addField('test_task', 'pid');
        $task_field = $query->addField('test_task', 'task');
        $people_alias = $query->join('test', 'people', "[test_task].[pid] = [people].[id]");
        $name_field = $query->addField($people_alias, 'name', 'name');
        $query->condition('test_task.tid', '1');
        $query->orderBy($tid_field);
        $query->addTag('database_test_alter_change_conditional');
        $result = $query->execute();
        $records = $result->fetchAll();
        $this->assertCount(1, $records, 'Returned the correct number of rows.');
        $this->assertEquals('John', $records[0]->{$name_field}, 'Correct data retrieved.');
        $this->assertEquals(2, $records[0]->{$tid_field}, 'Correct data retrieved.');
        $this->assertEquals(1, $records[0]->{$pid_field}, 'Correct data retrieved.');
        $this->assertEquals('sleep', $records[0]->{$task_field}, 'Correct data retrieved.');
    }
    
    /**
     * Tests that we can alter the fields of a query.
     */
    public function testAlterChangeFields() : void {
        $query = $this->connection
            ->select('test');
        $name_field = $query->addField('test', 'name');
        $age_field = $query->addField('test', 'age', 'age');
        $query->orderBy('name');
        $query->addTag('database_test_alter_change_fields');
        $record = $query->execute()
            ->fetch();
        $this->assertEquals('George', $record->{$name_field}, 'Correct data retrieved.');
        $this->assertFalse(isset($record->{$age_field}), 'Age field not found, as intended.');
    }
    
    /**
     * Tests that we can alter expressions in the query.
     */
    public function testAlterExpression() : void {
        $query = $this->connection
            ->select('test');
        $name_field = $query->addField('test', 'name');
        $age_field = $query->addExpression("[age]*2", 'double_age');
        $query->condition('age', 27);
        $query->addTag('database_test_alter_change_expressions');
        $result = $query->execute();
        // Ensure that we got the right record.
        $record = $result->fetch();
        $this->assertEquals('George', $record->{$name_field}, 'Fetched name is correct.');
        $this->assertEquals(27 * 3, $record->{$age_field}, 'Fetched age expression is correct.');
    }
    
    /**
     * Tests that we can remove a range() value from a query.
     *
     * This also tests hook_query_TAG_alter().
     */
    public function testAlterRemoveRange() : void {
        $query = $this->connection
            ->select('test');
        $query->addField('test', 'name');
        $query->addField('test', 'age', 'age');
        $query->range(0, 2);
        $query->addTag('database_test_alter_remove_range');
        $num_records = count($query->execute()
            ->fetchAll());
        $this->assertEquals(4, $num_records, 'Returned the correct number of rows.');
    }
    
    /**
     * Tests that we can do basic alters on subqueries.
     */
    public function testSimpleAlterSubquery() : void {
        // Create a sub-query with an alter tag.
        $subquery = $this->connection
            ->select('test', 'p');
        $subquery->addField('p', 'name');
        $subquery->addField('p', 'id');
        // Pick out George.
        $subquery->condition('age', 27);
        $subquery->addExpression("[age]*2", 'double_age');
        // This query alter should change it to age * 3.
        $subquery->addTag('database_test_alter_change_expressions');
        // Create a main query and join to sub-query.
        $query = $this->connection
            ->select('test_task', 'tt');
        $query->join($subquery, 'pq', '[pq].[id] = [tt].[pid]');
        $age_field = $query->addField('pq', 'double_age');
        $name_field = $query->addField('pq', 'name');
        $record = $query->execute()
            ->fetch();
        $this->assertEquals('George', $record->{$name_field}, 'Fetched name is correct.');
        $this->assertEquals(27 * 3, $record->{$age_field}, 'Fetched age expression is correct.');
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
AlterTest::testAlterChangeConditional public function Tests that we can alter a query's conditionals.
AlterTest::testAlterChangeFields public function Tests that we can alter the fields of a query.
AlterTest::testAlterExpression public function Tests that we can alter expressions in the query.
AlterTest::testAlterRemoveRange public function Tests that we can remove a range() value from a query.
AlterTest::testAlterWithJoin public function Tests that we can alter the joins on a query.
AlterTest::testSimpleAlter public function Tests that we can do basic alters.
AlterTest::testSimpleAlterSubquery public function Tests that we can do basic alters on subqueries.
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 raw text IS NOT found escaped on 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.
DatabaseTestBase::$connection protected property The database connection for testing.
DatabaseTestBase::$modules protected static property Modules to install. Overrides KernelTestBase::$modules 3
DatabaseTestBase::ensureSampleDataNull public function Sets up tables for NULL handling.
DatabaseTestBase::setUp protected function Overrides KernelTestBase::setUp 1
DatabaseTestSchemaDataTrait::addSampleData protected function Sets up our sample data.
DatabaseTestSchemaInstallTrait::installSampleSchema protected function Sets up our sample table schema.
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. 6
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking. 3
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$keyValue protected property The key_value service that must persist between container rebuilds.
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. 9
KernelTestBase::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 7
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 protected function Bootstraps a kernel for a test. 1
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. 1
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 install.
KernelTestBase::getModulesToEnable private static function Returns the modules to install 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::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 27
KernelTestBase::render protected function Renders a render array. 1
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 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 2
KernelTestBase::stop Deprecated protected function Stops test execution.
KernelTestBase::tearDown protected function 6
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__get public function
KernelTestBase::__sleep public function Prevents serializing any properties.
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::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 Deprecated public function Callback for random string validation.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements Deprecated private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements Deprecated protected function Check module requirements for the Drupal use case.
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.

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