You are here

Home » API reference » Menu Link (Field) 8 » MenuLinkFieldKernelTest.php

class MenuLinkFieldKernelTest in Menu Link (Field) 8

Tests the menu link field.

@group menu_link

Hierarchy

Expanded class hierarchy of MenuLinkFieldKernelTest

File

tests/src/Kernel/MenuLinkFieldKernelTest.php, line 18

Namespace

Drupal\Tests\menu_link\Kernel
View source 
class MenuLinkFieldKernelTest extends KernelTestBase {

  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'menu_link',
    'entity_test',
    'field',
    'user',
    'system',
    'language',
  ];

  /**
   * Test fields creation.
   */
  protected function createFields() : void {
    $this
      ->installEntitySchema('user');
    $this
      ->installEntitySchema('entity_test_mul');
    FieldStorageConfig::create([
      'field_name' => 'field_menu_link',
      'entity_type' => 'entity_test_mul',
      'type' => 'menu_link',
    ])
      ->save();
    FieldConfig::create([
      'field_name' => 'field_menu_link',
      'entity_type' => 'entity_test_mul',
      'bundle' => 'entity_test_mul',
    ])
      ->save();
    FieldStorageConfig::create([
      'field_name' => 'field_menu_link2',
      'entity_type' => 'entity_test_mul',
      'type' => 'menu_link',
      'settings' => [
        'menu_link_per_translation' => TRUE,
      ],
    ])
      ->save();
    FieldConfig::create([
      'field_name' => 'field_menu_link2',
      'entity_type' => 'entity_test_mul',
      'bundle' => 'entity_test_mul',
    ])
      ->save();
  }
  protected function enableMultilingual() : void {
    ConfigurableLanguage::createFromLangcode('es')
      ->save();
    $this->container
      ->get('kernel')
      ->rebuildContainer();
  }

  /**
   * {@inheritdoc}
   */
  public function testMenuTreeSave() : void {
    $entity_test_mul = EntityTestMul::create([
      'type' => 'entity_test_mul',
      'name' => 'test',
      'field_menu_link' => [
        'menu_name' => 'test_menu',
        'title' => 'test title',
        'description' => 'test description',
      ],
    ]);
    $entity_test_mul
      ->save();

    /** @var \Drupal\Core\Menu\MenuLinkTree $menu_tree */
    $menu_tree = \Drupal::service('menu.link_tree');
    $parameters = new MenuTreeParameters();
    $parameters
      ->addCondition('title', 'test title');
    $result = $menu_tree
      ->load('test_menu', $parameters);
    self::assertCount(1, $result);
    $menu_link = reset($result);
    self::assertEquals(1, $menu_link->depth);
    self::assertFalse($menu_link->hasChildren);
    self::assertEquals('test title', $menu_link->link
      ->getTitle());
    self::assertEquals('', $menu_link->link
      ->getParent());
    self::assertEquals('test description', $menu_link->link
      ->getDescription());
    self::assertEquals('test_menu', $menu_link->link
      ->getMenuName());
    self::assertTrue($menu_link->link
      ->getUrlObject()
      ->isRouted());
    self::assertEquals('entity.entity_test_mul.canonical', $menu_link->link
      ->getUrlObject()
      ->getRouteName());
    self::assertEquals([
      'entity_test_mul' => $entity_test_mul
        ->id(),
    ], $menu_link->link
      ->getUrlObject()
      ->getRouteParameters());

    // Add another entity as a child of the first one.
    $entity_test_mul2 = EntityTestMul::create([
      'type' => 'entity_test_mul',
      'name' => 'test',
      'field_menu_link' => [
        'menu_name' => 'test_menu',
        'parent' => $menu_link->link
          ->getPluginId(),
        'title' => 'test title 2',
        'description' => 'test description 2',
      ],
    ]);
    $entity_test_mul2
      ->save();
    $parameters = new MenuTreeParameters();
    $parameters
      ->addCondition('title', 'test title 2');
    $result = $menu_tree
      ->load('test_menu', $parameters);
    self::assertCount(1, $result);
    $menu_link2 = reset($result);
    self::assertEquals(2, $menu_link2->depth);
    self::assertFalse($menu_link2->hasChildren);
    self::assertEquals('test title 2', $menu_link2->link
      ->getTitle());
    self::assertEquals($menu_link->link
      ->getPluginId(), $menu_link2->link
      ->getParent());
    self::assertEquals('test description 2', $menu_link2->link
      ->getDescription());
    self::assertEquals('test_menu', $menu_link2->link
      ->getMenuName());
    self::assertTrue($menu_link2->link
      ->getUrlObject()
      ->isRouted());
    self::assertEquals('entity.entity_test_mul.canonical', $menu_link2->link
      ->getUrlObject()
      ->getRouteName());
    self::assertEquals([
      'entity_test_mul' => $entity_test_mul2
        ->id(),
    ], $menu_link2->link
      ->getUrlObject()
      ->getRouteParameters());
  }

  /**
   * Test the title/description translation.
   */
  public function testTitleAndDescriptionTranslation() : void {
    $this
      ->enableMultilingual();
    $entity_test_mul = EntityTestMul::create([
      'type' => 'entity_test_mul',
      'name' => 'test',
      'field_menu_link' => [
        'menu_name' => 'test_menu',
        'title' => 'test title EN',
        'description' => 'test description EN',
      ],
    ]);
    $entity_test_mul
      ->save();

    /** @var \Drupal\Core\Menu\MenuLinkTree $menu_tree */
    $menu_tree = \Drupal::service('menu.link_tree');
    $parameters = new MenuTreeParameters();
    $result = $menu_tree
      ->load('test_menu', $parameters);
    self::assertCount(1, $result);
    $menu_link = reset($result);
    self::assertEquals(1, $menu_link->depth);
    self::assertFalse($menu_link->hasChildren);
    self::assertEquals('test title EN', $menu_link->link
      ->getTitle());
    self::assertEquals('', $menu_link->link
      ->getParent());
    self::assertEquals('test description EN', $menu_link->link
      ->getDescription());
    self::assertEquals('test_menu', $menu_link->link
      ->getMenuName());
    self::assertTrue($menu_link->link
      ->getUrlObject()
      ->isRouted());
    self::assertEquals('entity.entity_test_mul.canonical', $menu_link->link
      ->getUrlObject()
      ->getRouteName());
    self::assertEquals([
      'entity_test_mul' => $entity_test_mul
        ->id(),
    ], $menu_link->link
      ->getUrlObject()
      ->getRouteParameters());
    $entity_test_mul_es = $entity_test_mul
      ->addTranslation('es');
    $entity_test_mul_es
      ->set('field_menu_link', [
      'menu_name' => 'test_menu',
      'title' => 'test title ES',
      'description' => 'test description ES',
    ]);
    $entity_test_mul_es
      ->save();

    // Load the default language aka. EN.
    $parameters = new MenuTreeParameters();
    $result = $menu_tree
      ->load('test_menu', $parameters);
    self::assertCount(1, $result);
    $menu_link = reset($result);
    self::assertEquals(1, $menu_link->depth);
    self::assertFalse($menu_link->hasChildren);
    self::assertEquals('test title EN', $menu_link->link
      ->getTitle());
    self::assertEquals('', $menu_link->link
      ->getParent());
    self::assertEquals('test description EN', $menu_link->link
      ->getDescription());
    self::assertEquals('test_menu', $menu_link->link
      ->getMenuName());
    self::assertTrue($menu_link->link
      ->getUrlObject()
      ->isRouted());
    self::assertEquals('entity.entity_test_mul.canonical', $menu_link->link
      ->getUrlObject()
      ->getRouteName());
    self::assertEquals([
      'entity_test_mul' => $entity_test_mul
        ->id(),
    ], $menu_link->link
      ->getUrlObject()
      ->getRouteParameters());
    self::assertEquals('test description EN', $menu_link->link
      ->getUrlObject()
      ->getOptions()['attributes']['title']);

    // Load the ES version.
    $reflection = new \ReflectionClass(\Drupal::languageManager());
    $property = $reflection
      ->getProperty('negotiatedLanguages');
    $property
      ->setAccessible(TRUE);
    $property
      ->setValue(\Drupal::languageManager(), [
      LanguageInterface::TYPE_CONTENT => ConfigurableLanguage::load('es'),
    ]);
    self::assertEquals('es', \Drupal::languageManager()
      ->getCurrentLanguage(LanguageInterface::TYPE_CONTENT)
      ->getId());
    $parameters = new MenuTreeParameters();
    $result = $menu_tree
      ->load('test_menu', $parameters);
    self::assertCount(1, $result);
    $menu_link_es = reset($result);
    self::assertEquals('test title ES', $menu_link_es->link
      ->getTitle());
    self::assertEquals('', $menu_link_es->link
      ->getParent());
    self::assertEquals('test description ES', $menu_link_es->link
      ->getDescription());
    self::assertEquals('test_menu', $menu_link_es->link
      ->getMenuName());
    self::assertTrue($menu_link_es->link
      ->getUrlObject()
      ->isRouted());
    self::assertEquals('entity.entity_test_mul.canonical', $menu_link_es->link
      ->getUrlObject()
      ->getRouteName());
    self::assertEquals([
      'entity_test_mul' => $entity_test_mul
        ->id(),
    ], $menu_link_es->link
      ->getUrlObject()
      ->getRouteParameters());
    self::assertEquals('test description ES', $menu_link_es->link
      ->getUrlObject()
      ->getOptions()['attributes']['title']);
    self::assertEquals('es', $menu_link_es->link
      ->getUrlObject()
      ->getOptions()['language']
      ->getId());
  }

  /**
   * Tests the capability to provide multiple menu links and translate them.
   */
  public function testTranslationWithMultipleMenuItems() : void {
    $this
      ->enableMultilingual();
    $entity_test_mul = EntityTestMul::create([
      'type' => 'entity_test_mul',
      'name' => 'test',
      'field_menu_link2' => [
        'menu_name' => 'test_menu',
        'title' => 'test title EN',
        'description' => 'test description EN',
      ],
    ]);
    $entity_test_mul
      ->save();
    $entity_test_mul_es = $entity_test_mul
      ->addTranslation('es');
    $entity_test_mul_es
      ->set('field_menu_link2', [
      'menu_name' => 'test_menu_es',
      'title' => 'test title ES',
      'description' => 'test description ES',
    ]);
    $entity_test_mul_es
      ->save();

    /** @var \Drupal\Core\Menu\MenuLinkTree $menu_tree */
    $menu_tree = \Drupal::service('menu.link_tree');
    $parameters = new MenuTreeParameters();
    $result = $menu_tree
      ->load('test_menu', $parameters);
    self::assertCount(1, $result);
    $menu_link = reset($result);
    self::assertEquals(1, $menu_link->depth);
    self::assertFalse($menu_link->hasChildren);
    self::assertEquals('test title EN', $menu_link->link
      ->getTitle());
    self::assertEquals('', $menu_link->link
      ->getParent());
    self::assertEquals('test description EN', $menu_link->link
      ->getDescription());
    self::assertEquals('test_menu', $menu_link->link
      ->getMenuName());
    self::assertTrue($menu_link->link
      ->getUrlObject()
      ->isRouted());
    self::assertEquals('entity.entity_test_mul.canonical', $menu_link->link
      ->getUrlObject()
      ->getRouteName());
    self::assertEquals([
      'entity_test_mul' => $entity_test_mul
        ->id(),
    ], $menu_link->link
      ->getUrlObject()
      ->getRouteParameters());
    self::assertEquals('test description EN', $menu_link->link
      ->getUrlObject()
      ->getOptions()['attributes']['title']);
    $parameters = new MenuTreeParameters();
    $result = $menu_tree
      ->load('test_menu_es', $parameters);
    self::assertCount(1, $result);
    $menu_link_es = reset($result);
    self::assertEquals('test title ES', $menu_link_es->link
      ->getTitle());
    self::assertEquals('', $menu_link_es->link
      ->getParent());
    self::assertEquals('test description ES', $menu_link_es->link
      ->getDescription());
    self::assertEquals('test_menu_es', $menu_link_es->link
      ->getMenuName());
    self::assertTrue($menu_link_es->link
      ->getUrlObject()
      ->isRouted());
    self::assertEquals('entity.entity_test_mul.canonical', $menu_link_es->link
      ->getUrlObject()
      ->getRouteName());
    self::assertEquals([
      'entity_test_mul' => $entity_test_mul
        ->id(),
    ], $menu_link_es->link
      ->getUrlObject()
      ->getRouteParameters());
    self::assertEquals('test description ES', $menu_link_es->link
      ->getUrlObject()
      ->getOptions()['attributes']['title']);
    self::assertEquals('es', $menu_link_es->link
      ->getUrlObject()
      ->getOptions()['language']
      ->getId());
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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 the raw text IS NOT found escaped on the 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::getUrl protected function Get the current URL from the cURL handler. 1
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.
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose protected function
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.
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. 7
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
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. 6
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 private function Bootstraps a kernel for a test.
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.
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. 1
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable private static function Returns the modules to enable 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::isTestInIsolation Deprecated protected function Returns whether the current test method is running in a separate process.
KernelTestBase::prepareTemplate protected function
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 26
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::setUp protected function 347
KernelTestBase::setUpBeforeClass public static function 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 2
KernelTestBase::stop 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 Deprecated public function BC: Automatically resolve former KernelTestBase class properties.
KernelTestBase::__sleep public function Prevents serializing any properties.
MenuLinkFieldKernelTest::$modules protected static property Modules to enable. Overrides KernelTestBase::$modules
MenuLinkFieldKernelTest::createFields protected function Test fields creation.
MenuLinkFieldKernelTest::enableMultilingual protected function
MenuLinkFieldKernelTest::testMenuTreeSave public function
MenuLinkFieldKernelTest::testTitleAndDescriptionTranslation public function Test the title/description translation.
MenuLinkFieldKernelTest::testTranslationWithMultipleMenuItems public function Tests the capability to provide multiple menu links and translate them.
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.
RandomGeneratorTrait::$randomGenerator protected property The random generator.
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. 1
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 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 private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements protected function Check module requirements for the Drupal use case. 1
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.