class SortTest

Same name in this branch
  1. 11.x core/modules/views/tests/src/Kernel/Handler/SortTest.php \Drupal\Tests\views\Kernel\Handler\SortTest
  2. 11.x core/tests/Drupal/Tests/PhpCs/SortTest.php \Drupal\Tests\PhpCs\SortTest
  3. 11.x core/tests/Drupal/Tests/CSpell/SortTest.php \Drupal\Tests\CSpell\SortTest
Same name and namespace in other branches
  1. 9 core/modules/jsonapi/tests/src/Unit/Query/SortTest.php \Drupal\Tests\jsonapi\Unit\Query\SortTest
  2. 9 core/modules/views/tests/src/Kernel/Handler/SortTest.php \Drupal\Tests\views\Kernel\Handler\SortTest
  3. 9 core/tests/Drupal/Tests/PhpCs/SortTest.php \Drupal\Tests\PhpCs\SortTest
  4. 8.9.x core/modules/jsonapi/tests/src/Unit/Query/SortTest.php \Drupal\Tests\jsonapi\Unit\Query\SortTest
  5. 8.9.x core/modules/views/tests/src/Kernel/Handler/SortTest.php \Drupal\Tests\views\Kernel\Handler\SortTest
  6. 10 core/modules/jsonapi/tests/src/Unit/Query/SortTest.php \Drupal\Tests\jsonapi\Unit\Query\SortTest
  7. 10 core/modules/views/tests/src/Kernel/Handler/SortTest.php \Drupal\Tests\views\Kernel\Handler\SortTest
  8. 10 core/tests/Drupal/Tests/PhpCs/SortTest.php \Drupal\Tests\PhpCs\SortTest
  9. 10 core/tests/Drupal/Tests/CSpell/SortTest.php \Drupal\Tests\CSpell\SortTest

@coversDefaultClass \Drupal\jsonapi\Query\Sort @group jsonapi

@internal

Hierarchy

Expanded class hierarchy of SortTest

File

core/modules/jsonapi/tests/src/Unit/Query/SortTest.php, line 20

Namespace

Drupal\Tests\jsonapi\Unit\Query
View source 
class SortTest extends UnitTestCase {
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $container = new Container();
        $cache_context_manager = $this->prophesize(CacheContextsManager::class);
        $cache_context_manager->assertValidTokens(Argument::any())
            ->willReturn(TRUE);
        $container->set('cache_contexts_manager', $cache_context_manager->reveal());
        \Drupal::setContainer($container);
    }
    
    /**
     * @covers ::createFromQueryParameter
     * @dataProvider parameterProvider
     */
    public function testCreateFromQueryParameter($input, $expected) : void {
        $sort = Sort::createFromQueryParameter($input);
        foreach ($sort->fields() as $index => $sort_field) {
            $this->assertEquals($expected[$index]['path'], $sort_field['path']);
            $this->assertEquals($expected[$index]['direction'], $sort_field['direction']);
            $this->assertEquals($expected[$index]['langcode'], $sort_field['langcode']);
        }
    }
    
    /**
     * Provides a suite of shortcut sort parameters and their expected expansions.
     */
    public static function parameterProvider() {
        return [
            [
                'lorem',
                [
                    [
                        'path' => 'lorem',
                        'direction' => 'ASC',
                        'langcode' => NULL,
                    ],
                ],
            ],
            [
                '-lorem',
                [
                    [
                        'path' => 'lorem',
                        'direction' => 'DESC',
                        'langcode' => NULL,
                    ],
                ],
            ],
            [
                '-lorem,ipsum',
                [
                    [
                        'path' => 'lorem',
                        'direction' => 'DESC',
                        'langcode' => NULL,
                    ],
                    [
                        'path' => 'ipsum',
                        'direction' => 'ASC',
                        'langcode' => NULL,
                    ],
                ],
            ],
            [
                '-lorem,-ipsum',
                [
                    [
                        'path' => 'lorem',
                        'direction' => 'DESC',
                        'langcode' => NULL,
                    ],
                    [
                        'path' => 'ipsum',
                        'direction' => 'DESC',
                        'langcode' => NULL,
                    ],
                ],
            ],
            [
                [
                    [
                        'path' => 'lorem',
                        'langcode' => NULL,
                    ],
                    [
                        'path' => 'ipsum',
                        'langcode' => 'ca',
                    ],
                    [
                        'path' => 'dolor',
                        'direction' => 'ASC',
                        'langcode' => 'ca',
                    ],
                    [
                        'path' => 'sit',
                        'direction' => 'DESC',
                        'langcode' => 'ca',
                    ],
                ],
                [
                    [
                        'path' => 'lorem',
                        'direction' => 'ASC',
                        'langcode' => NULL,
                    ],
                    [
                        'path' => 'ipsum',
                        'direction' => 'ASC',
                        'langcode' => 'ca',
                    ],
                    [
                        'path' => 'dolor',
                        'direction' => 'ASC',
                        'langcode' => 'ca',
                    ],
                    [
                        'path' => 'sit',
                        'direction' => 'DESC',
                        'langcode' => 'ca',
                    ],
                ],
            ],
        ];
    }
    
    /**
     * @covers ::createFromQueryParameter
     * @dataProvider badParameterProvider
     */
    public function testCreateFromQueryParameterFail($input) : void {
        $this->expectException(BadRequestHttpException::class);
        Sort::createFromQueryParameter($input);
    }
    
    /**
     * Data provider for testCreateFromQueryParameterFail.
     */
    public static function badParameterProvider() {
        return [
            [
                [
                    [
                        'lorem',
                    ],
                ],
            ],
            [
                '',
            ],
        ];
    }

}

Members

Title 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.
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.
SortTest::badParameterProvider public static function Data provider for testCreateFromQueryParameterFail.
SortTest::parameterProvider public static function Provides a suite of shortcut sort parameters and their expected expansions.
SortTest::setUp protected function Overrides UnitTestCase::setUp
SortTest::testCreateFromQueryParameter public function @covers ::createFromQueryParameter
@dataProvider parameterProvider
SortTest::testCreateFromQueryParameterFail public function @covers ::createFromQueryParameter
@dataProvider badParameterProvider
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.