class OrderByTest

Same name in other branches
  1. 9 core/tests/Drupal/Tests/Core/Database/OrderByTest.php \Drupal\Tests\Core\Database\OrderByTest
  2. 8.9.x core/tests/Drupal/Tests/Core/Database/OrderByTest.php \Drupal\Tests\Core\Database\OrderByTest
  3. 10 core/tests/Drupal/Tests/Core/Database/OrderByTest.php \Drupal\Tests\Core\Database\OrderByTest

Tests the orderBy() method of select queries.

@group Database

Hierarchy

Expanded class hierarchy of OrderByTest

File

core/tests/Drupal/Tests/Core/Database/OrderByTest.php, line 19

Namespace

Drupal\Tests\Core\Database
View source
class OrderByTest extends UnitTestCase {
    
    /**
     * The select query object to test.
     *
     * @var \Drupal\Core\Database\Query\Select
     */
    protected $query;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $mockPdo = $this->createMock(StubPDO::class);
        $connection = new StubConnection($mockPdo, []);
        $this->query = new Select($connection, 'test', NULL);
    }
    
    /**
     * Checks that invalid sort directions in ORDER BY get converted to ASC.
     */
    public function testInvalidDirection() : void {
        $this->query
            ->orderBy('test', 'invalid direction');
        $order_bys = $this->query
            ->getOrderBy();
        $this->assertEquals('ASC', $order_bys['test'], 'Invalid order by direction is converted to ASC.');
    }
    
    /**
     * Tests that fields passed for ordering get escaped properly.
     */
    public function testFieldEscaping() : void {
        $this->query
            ->orderBy('x; DROP table node; --');
        $sql = $this->query
            ->__toString();
        $this->assertStringEndsWith('ORDER BY xDROPtablenode ASC', $sql, 'Order by field is escaped correctly.');
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
ExpectDeprecationTrait::expectDeprecation public function Adds an expected deprecation.
ExpectDeprecationTrait::getCallableName private static function Returns a callable as a string suitable for inclusion in a message.
ExpectDeprecationTrait::setUpErrorHandler public function Sets up the test error handler.
ExpectDeprecationTrait::tearDownErrorHandler public function Tears down the test error handler.
OrderByTest::$query protected property The select query object to test.
OrderByTest::setUp protected function Overrides UnitTestCase::setUp
OrderByTest::testFieldEscaping public function Tests that fields passed for ordering get escaped properly.
OrderByTest::testInvalidDirection public function Checks that invalid sort directions in ORDER BY get converted to ASC.
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.
UnitTestCase::$root protected property The app root.
UnitTestCase::getClassResolverStub protected function Returns a stub class resolver.
UnitTestCase::getConfigFactoryStub public function Returns a stub config factory that behaves according to the passed array.
UnitTestCase::getConfigStorageStub public function Returns a stub config storage that returns the supplied configuration.
UnitTestCase::getContainerWithCacheTagsInvalidator protected function Sets up a container with a cache tags invalidator.
UnitTestCase::getStringTranslationStub public function Returns a stub translation manager that just returns the passed string.
UnitTestCase::setUpBeforeClass public static function

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