Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\system\Tests\Menu;
Chris@0: 
Chris@0: @trigger_error(__NAMESPACE__ . '\AssertMenuActiveTrailTrait is deprecated in Drupal 8.4.0 and will be removed before Drupal 9.0.0. Instead, use \Drupal\Tests\system\Functional\Menu\AssertMenuActiveTrailTrait', E_USER_DEPRECATED);
Chris@0: 
Chris@0: use Drupal\Core\Url;
Chris@0: 
Chris@0: /**
Chris@0:  * Provides test assertions for verifying the active menu trail.
Chris@0:  *
Chris@0:  * @deprecated Scheduled for removal in Drupal 9.0.0.
Chris@0:  *   Use \Drupal\Tests\system\Functional\Menu\AssertMenuActiveTrailTrait instead.
Chris@0:  */
Chris@0: trait AssertMenuActiveTrailTrait {
Chris@0: 
Chris@0:   /**
Chris@0:    * Assert that active trail exists in a menu tree output.
Chris@0:    *
Chris@0:    * @param array $tree
Chris@0:    *   An associative array whose keys are link paths and whose
Chris@0:    *   values are link titles (not sanitized) of an expected active trail in a
Chris@0:    *   menu tree output on the page.
Chris@0:    * @param bool $last_active
Chris@0:    *   Whether the last link in $tree is expected to be active (TRUE)
Chris@0:    *   or just to be in the active trail (FALSE).
Chris@0:    */
Chris@0:   protected function assertMenuActiveTrail($tree, $last_active) {
Chris@0:     end($tree);
Chris@0:     $active_link_path = key($tree);
Chris@0:     $active_link_title = array_pop($tree);
Chris@0:     $xpath = '';
Chris@0:     if ($tree) {
Chris@0:       $i = 0;
Chris@0:       foreach ($tree as $link_path => $link_title) {
Chris@0:         $part_xpath = (!$i ? '//' : '/following-sibling::ul/descendant::');
Chris@0:         $part_xpath .= 'li[contains(@class, :class)]/a[contains(@href, :href) and contains(text(), :title)]';
Chris@0:         $part_args = [
Chris@0:           ':class' => 'menu-item--active-trail',
Chris@0:           ':href' => Url::fromUri('base:' . $link_path)->toString(),
Chris@0:           ':title' => $link_title,
Chris@0:         ];
Chris@0:         $xpath .= $this->buildXPathQuery($part_xpath, $part_args);
Chris@0:         $i++;
Chris@0:       }
Chris@0:       $elements = $this->xpath($xpath);
Chris@0:       $this->assertTrue(!empty($elements), 'Active trail to current page was found in menu tree.');
Chris@0: 
Chris@0:       // Append prefix for active link asserted below.
Chris@0:       $xpath .= '/following-sibling::ul/descendant::';
Chris@0:     }
Chris@0:     else {
Chris@0:       $xpath .= '//';
Chris@0:     }
Chris@0:     $xpath_last_active = ($last_active ? 'and contains(@class, :class-active)' : '');
Chris@0:     $xpath .= 'li[contains(@class, :class-trail)]/a[contains(@href, :href) ' . $xpath_last_active . 'and contains(text(), :title)]';
Chris@0:     $args = [
Chris@0:       ':class-trail' => 'menu-item--active-trail',
Chris@0:       ':class-active' => 'is-active',
Chris@0:       ':href' => Url::fromUri('base:' . $active_link_path)->toString(),
Chris@0:       ':title' => $active_link_title,
Chris@0:     ];
Chris@0:     $elements = $this->xpath($xpath, $args);
Chris@0:     $this->assertTrue(!empty($elements), format_string('Active link %title was found in menu tree, including active trail links %tree.', [
Chris@0:       '%title' => $active_link_title,
Chris@0:       '%tree' => implode(' » ', $tree),
Chris@0:     ]));
Chris@0:   }
Chris@0: 
Chris@0: }