class OrderByTest

Same name and namespace in other branches
  1. 9 core/tests/Drupal/Tests/Core/Database/OrderByTest.php \Drupal\Tests\Core\Database\OrderByTest
  2. 10 core/tests/Drupal/Tests/Core/Database/OrderByTest.php \Drupal\Tests\Core\Database\OrderByTest
  3. 11.x 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 13

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() {
        $connection = $this->getMockBuilder('Drupal\\Core\\Database\\Connection')
            ->disableOriginalConstructor()
            ->getMockForAbstractClass();
        $this->query = new Select('test', NULL, $connection);
    }
    
    /**
     * Checks that invalid sort directions in ORDER BY get converted to ASC.
     */
    public function testInvalidDirection() {
        $this->query
            ->orderBy('test', 'invalid direction');
        $order_bys = $this->query
            ->getOrderBy();
        $this->assertEquals($order_bys['test'], 'ASC', 'Invalid order by direction is converted to ASC.');
    }
    
    /**
     * Tests that fields passed for ordering get escaped properly.
     */
    public function testFieldEscaping() {
        $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 Deprecated Modifiers Object type Summary Overriden Title Overrides
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.
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
UnitTestCase::$randomGenerator protected property The random generator.
UnitTestCase::$root protected property The app root. 1
UnitTestCase::assertArrayEquals protected function Asserts if two arrays are equal by sorting them first.
UnitTestCase::getBlockMockWithMachineName Deprecated protected function Mocks a block with a block plugin. 1
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::getRandomGenerator protected function Gets the random generator for the utility methods.
UnitTestCase::getStringTranslationStub public function Returns a stub translation manager that just returns the passed string.
UnitTestCase::randomMachineName public function Generates a unique random string containing letters and numbers.

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