' . PHP_EOL
+ . $myIndent . '' . PHP_EOL;
+ }
+ $html = rtrim($html, PHP_EOL);
+ }
+
+ return $html;
+ }
+
+ /**
+ * Renders the given $container by invoking the partial view helper.
+ *
+ * The container will simply be passed on as a model to the view script
+ * as-is, and will be available in the partial script as 'container', e.g.
+ * echo 'Number of pages: ', count($this->container);.
+ *
+ * @param null|AbstractContainer $container [optional] container to pass to view
+ * script. Default is to use the container registered in the helper.
+ * @param null|string|array $partial [optional] partial view script to use.
+ * Default is to use the partial registered in the helper. If an array
+ * is given, the first value is used for the partial view script.
+ * @return string
+ * @throws Exception\RuntimeException If no partial provided.
+ * @throws Exception\InvalidArgumentException If partial is invalid array.
+ */
+ public function renderPartial($container = null, $partial = null)
+ {
+ return $this->renderPartialModel([], $container, $partial);
+ }
+
+ /**
+ * Renders the given $container by invoking the partial view helper with the given parameters as the model.
+ *
+ * The container will simply be passed on as a model to the view script
+ * as-is, and will be available in the partial script as 'container', e.g.
+ * echo 'Number of pages: ', count($this->container);.
+ *
+ * Any parameters provided will be passed to the partial via the view model.
+ *
+ * @param null|AbstractContainer $container [optional] container to pass to view
+ * script. Default is to use the container registered in the helper.
+ * @param null|string|array $partial [optional] partial view script to use.
+ * Default is to use the partial registered in the helper. If an array
+ * is given, the first value is used for the partial view script.
+ * @return string
+ * @throws Exception\RuntimeException If no partial provided.
+ * @throws Exception\InvalidArgumentException If partial is invalid array.
+ */
+ public function renderPartialWithParams(array $params = [], $container = null, $partial = null)
+ {
+ return $this->renderPartialModel($params, $container, $partial);
+ }
+
+ /**
+ * Renders the inner-most sub menu for the active page in the $container.
+ *
+ * This is a convenience method which is equivalent to the following call:
+ *
+ * renderMenu($container, array(
+ * 'indent' => $indent,
+ * 'ulClass' => $ulClass,
+ * 'minDepth' => null,
+ * 'maxDepth' => null,
+ * 'onlyActiveBranch' => true,
+ * 'renderParents' => false,
+ * 'liActiveClass' => $liActiveClass
+ * ));
+ *
+ *
+ * @param AbstractContainer|null $container [optional] container to render.
+ * Default is to render the container registered in the helper.
+ * @param string $ulClass [optional] CSS class to use for UL element.
+ * Default is to use the value from {@link getUlClass()}.
+ * @param string|int $indent [optional] indentation as a string or number
+ * of spaces. Default is to use the value retrieved from
+ * {@link getIndent()}.
+ * @param string $liActiveClass [optional] CSS class to use for UL
+ * element. Default is to use the value from {@link getUlClass()}.
+ * @return string
+ */
+ public function renderSubMenu(
+ ?AbstractContainer $container = null,
+ $ulClass = null,
+ $indent = null,
+ $liActiveClass = null
+ ) {
+ return $this->renderMenu($container, [
+ 'indent' => $indent,
+ 'ulClass' => $ulClass,
+ 'minDepth' => null,
+ 'maxDepth' => null,
+ 'onlyActiveBranch' => true,
+ 'renderParents' => false,
+ 'escapeLabels' => true,
+ 'addClassToListItem' => false,
+ 'liActiveClass' => $liActiveClass,
+ ]);
+ }
+
+ /**
+ * Returns an HTML string containing an 'a' element for the given page if
+ * the page's href is not empty, and a 'span' element if it is empty.
+ *
+ * Overrides {@link AbstractHelper::htmlify()}.
+ *
+ * @param AbstractPage $page page to generate HTML for
+ * @param bool $escapeLabel Whether or not to escape the label
+ * @param bool $addClassToListItem Whether or not to add the page class to the list item
+ * @return string
+ */
+ public function htmlify(AbstractPage $page, $escapeLabel = true, $addClassToListItem = false)
+ {
+ // get attribs for element
+ $attribs = [
+ 'id' => $page->getId(),
+ 'title' => $this->translate($page->getTitle(), $page->getTextDomain()),
+ ];
+
+ if ($addClassToListItem === false) {
+ $attribs['class'] = $page->getClass();
+ }
+
+ // does page have a href?
+ $href = $page->getHref();
+ if ($href) {
+ $element = 'a';
+ $attribs['href'] = $href;
+ $attribs['target'] = $page->getTarget();
+ } else {
+ $element = 'span';
+ }
+
+ if ($page->isActive()) {
+ $attribs['aria-current'] = 'page';
+ }
+
+ $html = '<' . $element . $this->htmlAttribs($attribs) . '>';
+ $label = $this->translate($page->getLabel(), $page->getTextDomain());
+
+ if ($escapeLabel === true) {
+ /** @var EscapeHtml $escaper */
+ $escaper = $this->view->plugin('escapeHtml');
+ $html .= $escaper($label);
+ } else {
+ $html .= $label;
+ }
+
+ $html .= '';
+ return $html;
+ }
+
+ /**
+ * Normalizes given render options.
+ *
+ * @param array $options [optional] options to normalize
+ * @return array
+ */
+ protected function normalizeOptions(array $options = [])
+ {
+ if (isset($options['indent'])) {
+ $options['indent'] = $this->getWhitespace($options['indent']);
+ } else {
+ $options['indent'] = $this->getIndent();
+ }
+
+ if (isset($options['ulClass']) && $options['ulClass'] !== null) {
+ $options['ulClass'] = (string) $options['ulClass'];
+ } else {
+ $options['ulClass'] = $this->getUlClass();
+ }
+
+ if (array_key_exists('minDepth', $options)) {
+ if (null !== $options['minDepth']) {
+ $options['minDepth'] = (int) $options['minDepth'];
+ }
+ } else {
+ $options['minDepth'] = $this->getMinDepth();
+ }
+
+ if ($options['minDepth'] < 0 || $options['minDepth'] === null) {
+ $options['minDepth'] = 0;
+ }
+
+ if (array_key_exists('maxDepth', $options)) {
+ if (null !== $options['maxDepth']) {
+ $options['maxDepth'] = (int) $options['maxDepth'];
+ }
+ } else {
+ $options['maxDepth'] = $this->getMaxDepth();
+ }
+
+ if (! isset($options['onlyActiveBranch'])) {
+ $options['onlyActiveBranch'] = $this->getOnlyActiveBranch();
+ }
+
+ if (! isset($options['escapeLabels'])) {
+ $options['escapeLabels'] = $this->escapeLabels;
+ }
+
+ if (! isset($options['renderParents'])) {
+ $options['renderParents'] = $this->getRenderParents();
+ }
+
+ if (! isset($options['addClassToListItem'])) {
+ $options['addClassToListItem'] = $this->getAddClassToListItem();
+ }
+
+ if (isset($options['liActiveClass']) && $options['liActiveClass'] !== null) {
+ $options['liActiveClass'] = (string) $options['liActiveClass'];
+ } else {
+ $options['liActiveClass'] = $this->getLiActiveClass();
+ }
+
+ return $options;
+ }
+
+ /**
+ * Sets a flag indicating whether labels should be escaped.
+ *
+ * @param bool $flag [optional] escape labels
+ * @return self
+ */
+ public function escapeLabels($flag = true)
+ {
+ $this->escapeLabels = (bool) $flag;
+ return $this;
+ }
+
+ /**
+ * Enables/disables page class applied to
element.
+ *
+ * @param bool $flag [optional] page class applied to
element Default
+ * is true.
+ * @return self fluent interface, returns self
+ */
+ public function setAddClassToListItem($flag = true)
+ {
+ $this->addClassToListItem = (bool) $flag;
+ return $this;
+ }
+
+ /**
+ * Returns flag indicating whether page class should be applied to
element.
+ *
+ * By default, this value is false.
+ *
+ * @return bool whether parents should be rendered
+ */
+ public function getAddClassToListItem()
+ {
+ return $this->addClassToListItem;
+ }
+
+ /**
+ * Sets a flag indicating whether only active branch should be rendered.
+ *
+ * @param bool $flag [optional] render only active branch.
+ * @return self
+ */
+ public function setOnlyActiveBranch($flag = true)
+ {
+ $this->onlyActiveBranch = (bool) $flag;
+ return $this;
+ }
+
+ /**
+ * Returns a flag indicating whether only active branch should be rendered.
+ *
+ * By default, this value is false, meaning the entire menu will be
+ * be rendered.
+ *
+ * @return bool
+ */
+ public function getOnlyActiveBranch()
+ {
+ return $this->onlyActiveBranch;
+ }
+
+ /**
+ * Sets which partial view script to use for rendering menu.
+ *
+ * @param string|array $partial partial view script or null. If an array
+ * is given, the first value is used for the partial view script.
+ * @return self
+ */
+ public function setPartial($partial)
+ {
+ if (null === $partial || is_string($partial) || is_array($partial)) {
+ $this->partial = $partial;
+ }
+
+ return $this;
+ }
+
+ /**
+ * Returns partial view script to use for rendering menu.
+ *
+ * @return string|array|null
+ */
+ public function getPartial()
+ {
+ return $this->partial;
+ }
+
+ /**
+ * Enables/disables rendering of parents when only rendering active branch.
+ *
+ * See {@link setOnlyActiveBranch()} for more information.
+ *
+ * @param bool $flag [optional] render parents when rendering active branch.
+ * @return self
+ */
+ public function setRenderParents($flag = true)
+ {
+ $this->renderParents = (bool) $flag;
+ return $this;
+ }
+
+ /**
+ * Returns flag indicating whether parents should be rendered when rendering only the active branch.
+ *
+ * By default, this value is true.
+ *
+ * @return bool
+ */
+ public function getRenderParents()
+ {
+ return $this->renderParents;
+ }
+
+ /**
+ * Sets CSS class to use for the first 'ul' element when rendering.
+ *
+ * @param string $ulClass CSS class to set
+ * @return self
+ */
+ public function setUlClass($ulClass)
+ {
+ if (is_string($ulClass)) {
+ $this->ulClass = $ulClass;
+ }
+ return $this;
+ }
+
+ /**
+ * Returns CSS class to use for the first 'ul' element when rendering.
+ *
+ * @return string
+ */
+ public function getUlClass()
+ {
+ return $this->ulClass;
+ }
+
+ /**
+ * Sets CSS class to use for the active 'li' element when rendering.
+ *
+ * @param string $liActiveClass CSS class to set
+ * @return self
+ */
+ public function setLiActiveClass($liActiveClass)
+ {
+ if (is_string($liActiveClass)) {
+ $this->liActiveClass = $liActiveClass;
+ }
+ return $this;
+ }
+
+ /**
+ * Returns CSS class to use for the active 'li' element when rendering.
+ *
+ * @return string
+ */
+ public function getLiActiveClass()
+ {
+ return $this->liActiveClass;
+ }
+
+ /**
+ * Render a partial with the given "model".
+ *
+ * @param null|AbstractContainer $container
+ * @param null|string|array $partial
+ * @return Partial|string
+ * @throws Exception\RuntimeException If no partial provided.
+ * @throws Exception\InvalidArgumentException If partial is invalid array.
+ */
+ protected function renderPartialModel(array $params, $container, $partial)
+ {
+ $this->parseContainer($container);
+ if (null === $container) {
+ $container = $this->getContainer();
+ }
+
+ if (null === $partial) {
+ $partial = $this->getPartial();
+ }
+
+ if (empty($partial)) {
+ throw new Exception\RuntimeException(
+ 'Unable to render menu: No partial view script provided'
+ );
+ }
+
+ $model = array_merge($params, ['container' => $container]);
+
+ /** @var Partial $partialHelper */
+ $partialHelper = $this->view->plugin('partial');
+ if (is_array($partial)) {
+ if (count($partial) !== 2) {
+ throw new Exception\InvalidArgumentException(
+ 'Unable to render menu: A view partial supplied as '
+ . 'an array must contain one value: the partial view script'
+ );
+ }
+
+ return $partialHelper($partial[0], $model);
+ }
+
+ return $partialHelper($partial, $model);
+ }
+}
diff --git a/src/View/Helper/Navigation.php b/src/View/Helper/Navigation.php
new file mode 100644
index 00000000..14f6cecc
--- /dev/null
+++ b/src/View/Helper/Navigation.php
@@ -0,0 +1,352 @@
+setContainer($container);
+ }
+
+ return $this;
+ }
+
+ /**
+ * Magic overload: Proxy to other navigation helpers or the container
+ *
+ * Examples of usage from a view script or layout:
+ *
+ * // proxy to Menu helper and render container:
+ * echo $this->navigation()->menu();
+ *
+ * // proxy to Breadcrumbs helper and set indentation:
+ * $this->navigation()->breadcrumbs()->setIndent(8);
+ *
+ * // proxy to container and find all pages with 'blog' route:
+ * $blogPages = $this->navigation()->findAllByRoute('blog');
+ *
+ *
+ * @param string|class-string $method helper name or method name in container
+ * @param array $arguments [optional] arguments to pass
+ * @throws Exception\ExceptionInterface If proxying to a helper, and the
+ * helper is not an instance of the
+ * interface specified in
+ * {@link findHelper()}.
+ * @throws ExceptionInterface If method does not exist in container.
+ * @return mixed returns what the proxied call returns
+ */
+ public function __call($method, array $arguments = [])
+ {
+ // check if call should proxy to another helper
+ $helper = $this->findHelper($method, false);
+ if ($helper) {
+ if (method_exists($helper, 'setServiceLocator') && $this->getServiceLocator()) {
+ $helper->setServiceLocator($this->getServiceLocator());
+ }
+ return call_user_func_array($helper, $arguments);
+ }
+
+ // default behaviour: proxy call to container
+ return parent::__call($method, $arguments);
+ }
+
+ /**
+ * Renders helper
+ *
+ * @param AbstractContainer $container
+ * @return string
+ * @throws Exception\RuntimeException
+ */
+ public function render($container = null)
+ {
+ return $this->findHelper($this->getDefaultProxy())->render($container);
+ }
+
+ /**
+ * Returns the helper matching $proxy
+ *
+ * The helper must implement the interface {@link NavigationHelper}.
+ *
+ * @param string|class-string $proxy helper name
+ * @param bool $strict [optional] whether exceptions should be
+ * thrown if something goes
+ * wrong. Default is true.
+ * @throws Exception\RuntimeException If $strict is true and helper cannot be found.
+ * @return NavigationHelper|false helper instance
+ * @psalm-return ($strict is true ? NavigationHelper : NavigationHelper|false)
+ */
+ public function findHelper($proxy, $strict = true)
+ {
+ $plugins = $this->getPluginManager();
+ if (! $plugins->has($proxy)) {
+ if ($strict) {
+ throw new Exception\RuntimeException(sprintf(
+ 'Failed to find plugin for %s',
+ $proxy
+ ));
+ }
+
+ return false;
+ }
+
+ $helper = $plugins->get($proxy);
+ assert($helper instanceof NavigationHelper);
+ $container = $this->getContainer();
+ $hash = spl_object_hash($container) . spl_object_hash($helper);
+
+ if (! isset($this->injected[$hash])) {
+ $helper->setContainer();
+ $this->inject($helper);
+ $this->injected[$hash] = true;
+ } else {
+ if ($this->getInjectContainer()) {
+ $helper->setContainer($container);
+ }
+ }
+
+ return $helper;
+ }
+
+ /**
+ * Injects container, ACL, and translator to the given $helper if this
+ * helper is configured to do so
+ *
+ * @param NavigationHelper $helper helper instance
+ * @return void
+ */
+ protected function inject(NavigationHelper $helper)
+ {
+ if ($this->getInjectContainer() && ! $helper->hasContainer()) {
+ $helper->setContainer($this->getContainer());
+ }
+
+ if ($this->getInjectAcl()) {
+ if (! $helper->hasAcl()) {
+ $helper->setAcl($this->getAcl());
+ }
+ if (! $helper->hasRole()) {
+ $helper->setRole($this->getRole());
+ }
+ }
+
+ if ($this->getInjectTranslator() && ! $helper->hasTranslator()) {
+ $helper->setTranslator(
+ $this->getTranslator(),
+ $this->getTranslatorTextDomain()
+ );
+ }
+ }
+
+ /**
+ * Sets the default proxy to use in {@link render()}
+ *
+ * @param string $proxy default proxy
+ * @return Navigation
+ */
+ public function setDefaultProxy($proxy)
+ {
+ $this->defaultProxy = (string) $proxy;
+ return $this;
+ }
+
+ /**
+ * Returns the default proxy to use in {@link render()}
+ *
+ * @return string
+ */
+ public function getDefaultProxy()
+ {
+ return $this->defaultProxy;
+ }
+
+ /**
+ * Sets whether container should be injected when proxying
+ *
+ * @param bool $injectContainer
+ * @return Navigation
+ */
+ public function setInjectContainer($injectContainer = true)
+ {
+ $this->injectContainer = (bool) $injectContainer;
+ return $this;
+ }
+
+ /**
+ * Returns whether container should be injected when proxying
+ *
+ * @return bool
+ */
+ public function getInjectContainer()
+ {
+ return $this->injectContainer;
+ }
+
+ /**
+ * Sets whether ACL should be injected when proxying
+ *
+ * @param bool $injectAcl
+ * @return Navigation
+ */
+ public function setInjectAcl($injectAcl = true)
+ {
+ $this->injectAcl = (bool) $injectAcl;
+ return $this;
+ }
+
+ /**
+ * Returns whether ACL should be injected when proxying
+ *
+ * @return bool
+ */
+ public function getInjectAcl()
+ {
+ return $this->injectAcl;
+ }
+
+ /**
+ * Sets whether translator should be injected when proxying
+ *
+ * @param bool $injectTranslator
+ * @return Navigation
+ */
+ public function setInjectTranslator($injectTranslator = true)
+ {
+ $this->injectTranslator = (bool) $injectTranslator;
+ return $this;
+ }
+
+ /**
+ * Returns whether translator should be injected when proxying
+ *
+ * @return bool
+ */
+ public function getInjectTranslator()
+ {
+ return $this->injectTranslator;
+ }
+
+ /**
+ * Set manager for retrieving navigation helpers
+ *
+ * @return Navigation
+ */
+ public function setPluginManager(PluginManager $plugins)
+ {
+ $renderer = $this->getView();
+ if ($renderer) {
+ $plugins->setRenderer($renderer);
+ }
+ $this->plugins = $plugins;
+
+ return $this;
+ }
+
+ /**
+ * Retrieve plugin loader for navigation helpers
+ *
+ * Lazy-loads an instance of Navigation\HelperLoader if none currently
+ * registered.
+ *
+ * @return PluginManager
+ */
+ public function getPluginManager()
+ {
+ $pluginManager = $this->plugins;
+ if ($pluginManager === null) {
+ $pluginManager = new PluginManager($this->getServiceLocator());
+ $this->setPluginManager($pluginManager);
+ }
+
+ return $pluginManager;
+ }
+
+ /**
+ * Set the View object
+ *
+ * @return self
+ */
+ public function setView(Renderer $view)
+ {
+ parent::setView($view);
+ if ($view && $this->plugins) {
+ $this->plugins->setRenderer($view);
+ }
+ return $this;
+ }
+}
diff --git a/src/View/Helper/PluginManager.php b/src/View/Helper/PluginManager.php
new file mode 100644
index 00000000..28c34499
--- /dev/null
+++ b/src/View/Helper/PluginManager.php
@@ -0,0 +1,87 @@
+
+ */
+class PluginManager extends HelperPluginManager
+{
+ /** {@inheritDoc} */
+ protected $instanceOf = AbstractHelper::class;
+
+ /**
+ * Default aliases
+ *
+ * @var array
+ */
+ protected $aliases = [
+ 'breadcrumbs' => Breadcrumbs::class,
+ 'links' => Links::class,
+ 'menu' => Menu::class,
+ 'sitemap' => Sitemap::class,
+
+ // Legacy Zend Framework aliases
+ 'Zend\View\Helper\Navigation\Breadcrumbs' => Breadcrumbs::class,
+ 'Zend\View\Helper\Navigation\Links' => Links::class, // phpcs:ignore
+ 'Zend\View\Helper\Navigation\Menu' => Menu::class,
+ 'Zend\View\Helper\Navigation\Sitemap' => Sitemap::class,
+
+ // v2 normalized FQCNs
+ 'zendviewhelpernavigationbreadcrumbs' => Breadcrumbs::class,
+ 'zendviewhelpernavigationlinks' => Links::class,
+ 'zendviewhelpernavigationmenu' => Menu::class,
+ 'zendviewhelpernavigationsitemap' => Sitemap::class,
+ ];
+
+ /**
+ * Default factories
+ *
+ * {@inheritDoc}
+ */
+ protected $factories = [
+ Breadcrumbs::class => InvokableFactory::class,
+ Links::class => InvokableFactory::class,
+ Menu::class => InvokableFactory::class,
+ Sitemap::class => InvokableFactory::class,
+
+ // v2 canonical FQCNs
+ 'laminasviewhelpernavigationbreadcrumbs' => InvokableFactory::class,
+ 'laminasviewhelpernavigationlinks' => InvokableFactory::class,
+ 'laminasviewhelpernavigationmenu' => InvokableFactory::class,
+ 'laminasviewhelpernavigationsitemap' => InvokableFactory::class,
+ ];
+
+ /**
+ * @param ContainerInterface $configOrContainerInstance
+ * @psalm-param ServiceManagerConfiguration $v3config
+ */
+ public function __construct($configOrContainerInstance = null, array $v3config = [])
+ {
+ /** @psalm-suppress MissingClosureParamType */
+ $this->initializers[] = function (ContainerInterface $container, $instance): void {
+ if (! $instance instanceof AbstractHelper) {
+ return;
+ }
+
+ $instance->setServiceLocator($this->creationContext);
+ };
+
+ parent::__construct($configOrContainerInstance, $v3config);
+ }
+}
diff --git a/src/View/Helper/Sitemap.php b/src/View/Helper/Sitemap.php
new file mode 100644
index 00000000..aea14cc0
--- /dev/null
+++ b/src/View/Helper/Sitemap.php
@@ -0,0 +1,458 @@
+ tag
+ *
+ * @var string
+ */
+ public const SITEMAP_NS = 'http://www.sitemaps.org/schemas/sitemap/0.9';
+
+ /**
+ * Schema URL
+ *
+ * @var string
+ */
+ public const SITEMAP_XSD = 'http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd';
+
+ /**
+ * Whether XML output should be formatted
+ *
+ * @var bool
+ */
+ protected $formatOutput = false;
+
+ /**
+ * Server url
+ *
+ * @var string
+ */
+ protected $serverUrl;
+
+ /**
+ * List of urls in the sitemap
+ *
+ * @var array
+ */
+ protected $urls = [];
+
+ /**
+ * Whether sitemap should be validated using Laminas\Validate\Sitemap\*
+ *
+ * @var bool
+ */
+ protected $useSitemapValidators = true;
+
+ /**
+ * Whether sitemap should be schema validated when generated
+ *
+ * @var bool
+ */
+ protected $useSchemaValidation = false;
+
+ /**
+ * Whether the XML declaration should be included in XML output
+ *
+ * @var bool
+ */
+ protected $useXmlDeclaration = true;
+
+ /**
+ * Helper entry point
+ *
+ * @param string|AbstractContainer $container container to operate on
+ * @return Sitemap
+ */
+ public function __invoke($container = null)
+ {
+ if (null !== $container) {
+ $this->setContainer($container);
+ }
+
+ return $this;
+ }
+
+ /**
+ * Renders helper
+ *
+ * Implements {@link HelperInterface::render()}.
+ *
+ * @param AbstractContainer $container [optional] container to render. Default is
+ * to render the container registered in the helper.
+ * @return string
+ */
+ public function render($container = null)
+ {
+ $dom = $this->getDomSitemap($container);
+ $xml = $this->getUseXmlDeclaration() ?
+ $dom->saveXML() :
+ $dom->saveXML($dom->documentElement);
+
+ return rtrim($xml, PHP_EOL);
+ }
+
+ /**
+ * Returns a DOMDocument containing the Sitemap XML for the given container
+ *
+ * @param AbstractContainer|null $container [optional] container to get
+ * breadcrumbs from, defaults
+ * to what is registered in the
+ * helper
+ * @return DOMDocument DOM representation of the
+ * container
+ * @throws Exception\RuntimeException If schema validation is on
+ * and the sitemap is invalid
+ * according to the sitemap
+ * schema, or if sitemap
+ * validators are used and the
+ * loc element fails validation.
+ */
+ public function getDomSitemap(?AbstractContainer $container = null)
+ {
+ // Reset the urls
+ $this->urls = [];
+
+ if (null === $container) {
+ $container = $this->getContainer();
+ }
+
+ $locValidator = null;
+ $lastmodValidator = null;
+ $changefreqValidator = null;
+ $priorityValidator = null;
+
+ // check if we should validate using our own validators
+ if ($this->getUseSitemapValidators()) {
+ // create validators
+ $locValidator = new Loc();
+ $lastmodValidator = new Lastmod();
+ $changefreqValidator = new Changefreq();
+ $priorityValidator = new Priority();
+ }
+
+ // create document
+ $dom = new DOMDocument('1.0', 'UTF-8');
+ $dom->formatOutput = $this->getFormatOutput();
+
+ // ...and urlset (root) element
+ $urlSet = $dom->createElementNS(self::SITEMAP_NS, 'urlset');
+ $dom->appendChild($urlSet);
+
+ // create iterator
+ $iterator = new RecursiveIteratorIterator($container, RecursiveIteratorIterator::SELF_FIRST);
+
+ $maxDepth = $this->getMaxDepth();
+ if (is_int($maxDepth)) {
+ $iterator->setMaxDepth($maxDepth);
+ }
+ $minDepth = $this->getMinDepth();
+ if (! is_int($minDepth) || $minDepth < 0) {
+ $minDepth = 0;
+ }
+
+ // iterate container
+ foreach ($iterator as $page) {
+ if ($iterator->getDepth() < $minDepth || ! $this->accept($page)) {
+ // page should not be included
+ continue;
+ }
+
+ // get absolute url from page
+ if (! $url = $this->url($page)) {
+ // skip page if it has no url (rare case)
+ // or already is in the sitemap
+ continue;
+ }
+
+ // create url node for this page
+ $urlNode = $dom->createElementNS(self::SITEMAP_NS, 'url');
+ $urlSet->appendChild($urlNode);
+
+ if (
+ $this->getUseSitemapValidators()
+ && ! $locValidator->isValid($url)
+ ) {
+ throw new Exception\RuntimeException(sprintf(
+ 'Encountered an invalid URL for Sitemap XML: "%s"',
+ $url
+ ));
+ }
+
+ // put url in 'loc' element
+ $urlNode->appendChild($dom->createElementNS(self::SITEMAP_NS, 'loc', $url));
+
+ // add 'lastmod' element if a valid lastmod is set in page
+ if (isset($page->lastmod)) {
+ $lastmod = strtotime((string) $page->lastmod);
+
+ // prevent 1970-01-01...
+ if ($lastmod !== false) {
+ $lastmod = date('c', $lastmod);
+ }
+
+ if (
+ ! $this->getUseSitemapValidators()
+ || $lastmodValidator->isValid($lastmod)
+ ) {
+ // Cast $lastmod to string in case no validation was used
+ $urlNode->appendChild(
+ $dom->createElementNS(self::SITEMAP_NS, 'lastmod', (string) $lastmod)
+ );
+ }
+ }
+
+ // add 'changefreq' element if a valid changefreq is set in page
+ if (isset($page->changefreq)) {
+ $changefreq = $page->changefreq;
+ if (
+ ! $this->getUseSitemapValidators() ||
+ $changefreqValidator->isValid($changefreq)
+ ) {
+ $urlNode->appendChild(
+ $dom->createElementNS(self::SITEMAP_NS, 'changefreq', $changefreq)
+ );
+ }
+ }
+
+ // add 'priority' element if a valid priority is set in page
+ if (isset($page->priority)) {
+ $priority = $page->priority;
+ if (
+ ! $this->getUseSitemapValidators() ||
+ $priorityValidator->isValid($priority)
+ ) {
+ $urlNode->appendChild(
+ $dom->createElementNS(self::SITEMAP_NS, 'priority', $priority)
+ );
+ }
+ }
+ }
+
+ // validate using schema if specified
+ if ($this->getUseSchemaValidation()) {
+ ErrorHandler::start();
+ $test = $dom->schemaValidate(self::SITEMAP_XSD);
+ $error = ErrorHandler::stop();
+ if (! $test) {
+ throw new Exception\RuntimeException(sprintf(
+ 'Sitemap is invalid according to XML Schema at "%s"',
+ self::SITEMAP_XSD
+ ), 0, $error);
+ }
+ }
+
+ return $dom;
+ }
+
+ /**
+ * Returns an escaped absolute URL for the given page
+ *
+ * @return null|string
+ */
+ public function url(AbstractPage $page)
+ {
+ $href = $page->getHref();
+
+ if (! isset($href[0])) {
+ // no href
+ return '';
+ } elseif ($href[0] === '/') {
+ // href is relative to root; use serverUrl helper
+ $url = $this->getServerUrl() . $href;
+ } elseif (preg_match('/^[a-z]+:/im', (string) $href)) {
+ // scheme is given in href; assume absolute URL already
+ $url = (string) $href;
+ } else {
+ // href is relative to current document; use url helpers
+ $basePathHelper = $this->getView()->plugin('basepath');
+ $curDoc = $basePathHelper();
+ $curDoc = '/' === $curDoc ? '' : trim($curDoc, '/');
+ $url = rtrim($this->getServerUrl(), '/') . '/'
+ . $curDoc
+ . (empty($curDoc) ? '' : '/') . $href;
+ }
+
+ if (! in_array($url, $this->urls)) {
+ $this->urls[] = $url;
+ return $this->xmlEscape($url);
+ }
+
+ return null;
+ }
+
+ /**
+ * Escapes string for XML usage
+ *
+ * @param string $string
+ * @return string
+ */
+ protected function xmlEscape($string)
+ {
+ $escaper = $this->view->plugin('escapeHtml');
+ return $escaper($string);
+ }
+
+ /**
+ * Sets whether XML output should be formatted
+ *
+ * @param bool $formatOutput
+ * @return Sitemap
+ */
+ public function setFormatOutput($formatOutput = true)
+ {
+ $this->formatOutput = (bool) $formatOutput;
+ return $this;
+ }
+
+ /**
+ * Returns whether XML output should be formatted
+ *
+ * @return bool
+ */
+ public function getFormatOutput()
+ {
+ return $this->formatOutput;
+ }
+
+ /**
+ * Sets server url (scheme and host-related stuff without request URI)
+ *
+ * E.g. http://www.example.com
+ *
+ * @param string $serverUrl
+ * @return Sitemap
+ * @throws Exception\InvalidArgumentException
+ */
+ public function setServerUrl($serverUrl)
+ {
+ $uri = Uri\UriFactory::factory($serverUrl);
+ $uri->setFragment('');
+ $uri->setPath('');
+ $uri->setQuery('');
+
+ if ($uri->isValid()) {
+ $this->serverUrl = $uri->toString();
+ } else {
+ throw new Exception\InvalidArgumentException(sprintf(
+ 'Invalid server URL: "%s"',
+ $serverUrl
+ ));
+ }
+
+ return $this;
+ }
+
+ /**
+ * Returns server URL
+ *
+ * @return string
+ */
+ public function getServerUrl()
+ {
+ if (! isset($this->serverUrl)) {
+ $serverUrlHelper = $this->getView()->plugin('serverUrl');
+ $this->serverUrl = $serverUrlHelper();
+ }
+
+ return $this->serverUrl;
+ }
+
+ /**
+ * Sets whether sitemap should be validated using Laminas\Validate\Sitemap_*
+ *
+ * @param bool $useSitemapValidators
+ * @return Sitemap
+ */
+ public function setUseSitemapValidators($useSitemapValidators)
+ {
+ $this->useSitemapValidators = (bool) $useSitemapValidators;
+ return $this;
+ }
+
+ /**
+ * Returns whether sitemap should be validated using Laminas\Validate\Sitemap_*
+ *
+ * @return bool
+ */
+ public function getUseSitemapValidators()
+ {
+ return $this->useSitemapValidators;
+ }
+
+ /**
+ * Sets whether sitemap should be schema validated when generated
+ *
+ * @param bool $schemaValidation
+ * @return Sitemap
+ */
+ public function setUseSchemaValidation($schemaValidation)
+ {
+ $this->useSchemaValidation = (bool) $schemaValidation;
+ return $this;
+ }
+
+ /**
+ * Returns true if sitemap should be schema validated when generated
+ *
+ * @return bool
+ */
+ public function getUseSchemaValidation()
+ {
+ return $this->useSchemaValidation;
+ }
+
+ /**
+ * Sets whether the XML declaration should be used in output
+ *
+ * @param bool $useXmlDecl
+ * @return Sitemap
+ */
+ public function setUseXmlDeclaration($useXmlDecl)
+ {
+ $this->useXmlDeclaration = (bool) $useXmlDecl;
+ return $this;
+ }
+
+ /**
+ * Returns whether the XML declaration should be used in output
+ *
+ * @return bool
+ */
+ public function getUseXmlDeclaration()
+ {
+ return $this->useXmlDeclaration;
+ }
+}
diff --git a/src/View/HelperConfig.php b/src/View/HelperConfig.php
index 6d903ad8..55bdc434 100644
--- a/src/View/HelperConfig.php
+++ b/src/View/HelperConfig.php
@@ -4,12 +4,12 @@
namespace Laminas\Navigation\View;
+use Laminas\Navigation\View\Helper\Navigation as NavigationHelper;
use Laminas\ServiceManager\Config;
use Laminas\ServiceManager\ConfigInterface;
use Laminas\ServiceManager\Factory\InvokableFactory;
use Laminas\ServiceManager\ServiceManager;
use Laminas\Stdlib\ArrayUtils;
-use Laminas\View\Helper\Navigation as NavigationHelper;
use Psr\Container\ContainerInterface;
use ReflectionProperty;
use Traversable;
diff --git a/src/View/NavigationHelperFactory.php b/src/View/NavigationHelperFactory.php
index 81e4f5b4..587bddae 100644
--- a/src/View/NavigationHelperFactory.php
+++ b/src/View/NavigationHelperFactory.php
@@ -4,9 +4,9 @@
namespace Laminas\Navigation\View;
+use Laminas\Navigation\View\Helper\Navigation as NavigationHelper;
use Laminas\ServiceManager\FactoryInterface;
use Laminas\ServiceManager\ServiceLocatorInterface;
-use Laminas\View\Helper\Navigation as NavigationHelper;
use Psr\Container\ContainerInterface;
use ReflectionProperty;
diff --git a/test/ServiceFactoryTest.php b/test/ServiceFactoryTest.php
index 7adc9412..f3dc6cca 100644
--- a/test/ServiceFactoryTest.php
+++ b/test/ServiceFactoryTest.php
@@ -128,7 +128,7 @@ public function testConstructedNavigationFactoryInjectRouterAndMatcher(): void
{
$builder = $this->getMockBuilder(ConstructedNavigationFactory::class);
$builder->setConstructorArgs([__DIR__ . '/_files/navigation_mvc.xml'])
- ->setMethods(['injectComponents']);
+ ->onlyMethods(['injectComponents']);
$factory = $builder->getMock();
diff --git a/test/TestAsset/ArrayTranslator.php b/test/TestAsset/ArrayTranslator.php
new file mode 100644
index 00000000..979b87a7
--- /dev/null
+++ b/test/TestAsset/ArrayTranslator.php
@@ -0,0 +1,23 @@
+translations);
+ }
+}
diff --git a/test/View/Helper/AbstractHelperTest.php b/test/View/Helper/AbstractHelperTest.php
new file mode 100644
index 00000000..6f70d48c
--- /dev/null
+++ b/test/View/Helper/AbstractHelperTest.php
@@ -0,0 +1,97 @@
+helper = new NavigationHelper\Breadcrumbs();
+ parent::setUp();
+ }
+
+ protected function tearDown(): void
+ {
+ parent::tearDown();
+
+ $this->helper->setDefaultAcl(null);
+ $this->helper->setAcl(null);
+ $this->helper->setDefaultRole(null);
+ $this->helper->setRole(null);
+ }
+
+ public function testHasACLChecksDefaultACL(): void
+ {
+ $aclContainer = $this->getAcl();
+ $acl = $aclContainer['acl'];
+
+ $this->assertEquals(false, $this->helper->hasACL());
+ $this->helper->setDefaultAcl($acl);
+ $this->assertEquals(true, $this->helper->hasAcl());
+ }
+
+ public function testHasACLChecksMemberVariable(): void
+ {
+ $aclContainer = $this->getAcl();
+ $acl = $aclContainer['acl'];
+
+ $this->assertEquals(false, $this->helper->hasAcl());
+ $this->helper->setAcl($acl);
+ $this->assertEquals(true, $this->helper->hasAcl());
+ }
+
+ public function testHasRoleChecksDefaultRole(): void
+ {
+ $aclContainer = $this->getAcl();
+ $role = $aclContainer['role'];
+
+ $this->assertEquals(false, $this->helper->hasRole());
+ $this->helper->setDefaultRole($role);
+ $this->assertEquals(true, $this->helper->hasRole());
+ }
+
+ public function testHasRoleChecksMemberVariable(): void
+ {
+ $aclContainer = $this->getAcl();
+ $role = $aclContainer['role'];
+
+ $this->assertEquals(false, $this->helper->hasRole());
+ $this->helper->setRole($role);
+ $this->assertEquals(true, $this->helper->hasRole());
+ }
+
+ public function testEventManagerIsNullByDefault(): void
+ {
+ $this->assertNull($this->helper->getEventManager());
+ }
+
+ public function testFallBackForContainerNames(): void
+ {
+ // Register navigation service with name equal to the documentation
+ $this->serviceManager->setAllowOverride(true);
+ $this->serviceManager->setService(
+ 'navigation',
+ $this->serviceManager->get('Navigation')
+ );
+ $this->serviceManager->setAllowOverride(false);
+
+ $this->helper->setServiceLocator($this->serviceManager);
+
+ $this->helper->setContainer('navigation');
+ $this->assertInstanceOf(
+ Navigation::class,
+ $this->helper->getContainer()
+ );
+
+ $this->helper->setContainer('default');
+ $this->assertInstanceOf(
+ Navigation::class,
+ $this->helper->getContainer()
+ );
+ }
+}
diff --git a/test/View/Helper/AbstractTestCase.php b/test/View/Helper/AbstractTestCase.php
new file mode 100644
index 00000000..dbb1bd05
--- /dev/null
+++ b/test/View/Helper/AbstractTestCase.php
@@ -0,0 +1,210 @@
+nav1 = new Navigation($config['nav_test1']);
+ $this->nav2 = new Navigation($config['nav_test2']);
+ $this->nav3 = new Navigation($config['nav_test3']);
+
+ // setup view
+ $view = new PhpRenderer();
+ $resolver = $view->resolver();
+ assert($resolver instanceof TemplatePathStack);
+ $resolver->addPath(__DIR__ . '/_files/mvc/views');
+
+ // inject view into test subject helper
+ $this->helper->setView($view);
+
+ // set nav1 in helper as default
+ $this->helper->setContainer($this->nav1);
+
+ // setup service manager
+ $smConfig = [
+ 'modules' => [],
+ 'module_listener_options' => [
+ 'config_cache_enabled' => false,
+ 'cache_dir' => 'data/cache',
+ 'module_paths' => [],
+ 'extra_config' => [
+ 'service_manager' => [
+ 'factories' => [
+ 'config' => static fn(): array => [
+ 'navigation' => [
+ 'default' => $config['nav_test1'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ];
+
+ $sm = $this->serviceManager = new ServiceManager();
+ $sm->setAllowOverride(true);
+
+ (new ServiceManagerConfig())->configureServiceManager($sm);
+
+ $routerConfig = new Config((new RouterConfigProvider())->getDependencyConfig());
+ $routerConfig->configureServiceManager($sm);
+
+ $sm->setService('ApplicationConfig', $smConfig);
+ $moduleManager = $sm->get('ModuleManager');
+ self::assertInstanceOf(ModuleManager::class, $moduleManager);
+ $moduleManager->loadModules();
+ $application = $sm->get('Application');
+ self::assertInstanceOf(Application::class, $application);
+ $application->bootstrap();
+ $sm->setFactory('Navigation', DefaultNavigationFactory::class);
+
+ $sm->setService('nav1', $this->nav1);
+ $sm->setService('nav2', $this->nav2);
+
+ $sm->setAllowOverride(false);
+ $application->getMvcEvent()->setRouteMatch(new RouteMatch([
+ 'controller' => 'post',
+ 'action' => 'view',
+ 'id' => '1337',
+ ]));
+ }
+
+ /**
+ * Returns the expected contents of the given $filename
+ */
+ protected function getExpectedFileContents(string $filename): string
+ {
+ return file_get_contents(__DIR__ . '/_files/expected/' . $filename);
+ }
+
+ /**
+ * @return array{acl: Acl, role: 'special'}
+ */
+ protected function getAcl(): array
+ {
+ $acl = new Acl();
+
+ $acl->addRole(new GenericRole('guest'));
+ $acl->addRole(new GenericRole('member'), 'guest');
+ $acl->addRole(new GenericRole('admin'), 'member');
+ $acl->addRole(new GenericRole('special'), 'member');
+
+ $acl->addResource(new GenericResource('guest_foo'));
+ $acl->addResource(new GenericResource('member_foo'), 'guest_foo');
+ $acl->addResource(new GenericResource('admin_foo'));
+ $acl->addResource(new GenericResource('special_foo'), 'member_foo');
+
+ $acl->allow('guest', 'guest_foo');
+ $acl->allow('member', 'member_foo');
+ $acl->allow('admin', 'admin_foo');
+ $acl->allow('special', 'special_foo');
+ $acl->allow('special', 'admin_foo', 'read');
+
+ return ['acl' => $acl, 'role' => 'special'];
+ }
+
+ protected function getTranslator(): Translator
+ {
+ $loader = new ArrayTranslator();
+ $loader->translations = [
+ 'Page 1' => 'Side 1',
+ 'Page 1.1' => 'Side 1.1',
+ 'Page 2' => 'Side 2',
+ 'Page 2.3' => 'Side 2.3',
+ 'Page 2.3.3.1' => 'Side 2.3.3.1',
+ 'Home' => 'Hjem',
+ 'Go home' => 'Gå hjem',
+ ];
+ $translator = new Translator();
+ $translator->getPluginManager()->setService('default', $loader);
+ $translator->addTranslationFile('default', __FILE__);
+ return $translator;
+ }
+
+ protected function getTranslatorWithTextDomain(): Translator
+ {
+ $loader1 = new ArrayTranslator();
+ $loader1->translations = [
+ 'Page 1' => 'TextDomain1 1',
+ 'Page 1.1' => 'TextDomain1 1.1',
+ 'Page 2' => 'TextDomain1 2',
+ 'Page 2.3' => 'TextDomain1 2.3',
+ 'Page 2.3.3' => 'TextDomain1 2.3.3',
+ 'Page 2.3.3.1' => 'TextDomain1 2.3.3.1',
+ ];
+
+ $loader2 = new ArrayTranslator();
+ $loader2->translations = [
+ 'Page 1' => 'TextDomain2 1',
+ 'Page 1.1' => 'TextDomain2 1.1',
+ 'Page 2' => 'TextDomain2 2',
+ 'Page 2.3' => 'TextDomain2 2.3',
+ 'Page 2.3.3' => 'TextDomain2 2.3.3',
+ 'Page 2.3.3.1' => 'TextDomain2 2.3.3.1',
+ ];
+
+ $translator = new Translator();
+ $translator->getPluginManager()->setService('default1', $loader1);
+ $translator->getPluginManager()->setService('default2', $loader2);
+ $translator->addTranslationFile('default1', __FILE__, 'LaminasTest_1');
+ $translator->addTranslationFile('default2', __FILE__, 'LaminasTest_2');
+ return $translator;
+ }
+}
diff --git a/test/View/Helper/BreadcrumbsTest.php b/test/View/Helper/BreadcrumbsTest.php
new file mode 100644
index 00000000..c12a4d52
--- /dev/null
+++ b/test/View/Helper/BreadcrumbsTest.php
@@ -0,0 +1,250 @@
+helper = new Breadcrumbs();
+ parent::setUp();
+ }
+
+ public function testCanRenderStraightFromServiceAlias(): void
+ {
+ $this->helper->setServiceLocator($this->serviceManager);
+
+ $returned = $this->helper->renderStraight('Navigation');
+ $this->assertEquals($returned, $this->getExpectedFileContents('bc/default.html'));
+ }
+
+ public function testCanRenderPartialFromServiceAlias(): void
+ {
+ $this->helper->setPartial('bc.phtml');
+ $this->helper->setServiceLocator($this->serviceManager);
+
+ $returned = $this->helper->renderPartial('Navigation');
+ $this->assertEquals($returned, $this->getExpectedFileContents('bc/partial.html'));
+ }
+
+ public function testHelperEntryPointWithoutAnyParams(): void
+ {
+ $returned = $this->helper->__invoke();
+ $this->assertEquals($this->helper, $returned);
+ $this->assertEquals($this->nav1, $returned->getContainer());
+ }
+
+ public function testHelperEntryPointWithContainerParam(): void
+ {
+ $returned = $this->helper->__invoke($this->nav2);
+ $this->assertEquals($this->helper, $returned);
+ $this->assertEquals($this->nav2, $returned->getContainer());
+ }
+
+ public function testHelperEntryPointWithContainerStringParam(): void
+ {
+ $this->helper->setServiceLocator($this->serviceManager);
+
+ $returned = $this->helper->__invoke('nav1');
+ $this->assertEquals($this->helper, $returned);
+ $this->assertEquals($this->nav1, $returned->getContainer());
+ }
+
+ public function testNullOutContainer(): void
+ {
+ $old = $this->helper->getContainer();
+ $this->helper->setContainer();
+ $new = $this->helper->getContainer();
+
+ $this->assertNotEquals($old, $new);
+ }
+
+ public function testSetSeparator(): void
+ {
+ $this->helper->setSeparator('foo');
+
+ $expected = $this->getExpectedFileContents('bc/separator.html');
+ $this->assertEquals($expected, $this->helper->render());
+ }
+
+ public function testSetMaxDepth(): void
+ {
+ $this->helper->setMaxDepth(1);
+
+ $expected = $this->getExpectedFileContents('bc/maxdepth.html');
+ $this->assertEquals($expected, $this->helper->render());
+ }
+
+ public function testSetMinDepth(): void
+ {
+ $this->helper->setMinDepth(1);
+
+ $expected = '';
+ $this->assertEquals($expected, $this->helper->render($this->nav2));
+ }
+
+ public function testLinkLastElement(): void
+ {
+ $this->helper->setLinkLast(true);
+
+ $expected = $this->getExpectedFileContents('bc/linklast.html');
+ $this->assertEquals($expected, $this->helper->render());
+ }
+
+ public function testSetIndent(): void
+ {
+ $this->helper->setIndent(8);
+
+ $expected = ' helper->render(), 0, strlen($expected));
+
+ $this->assertEquals($expected, $actual);
+ }
+
+ public function testRenderSuppliedContainerWithoutInterfering(): void
+ {
+ $this->helper->setMinDepth(0);
+
+ $rendered1 = $this->getExpectedFileContents('bc/default.html');
+ $rendered2 = 'Site 2';
+
+ $expected = [
+ 'registered' => $rendered1,
+ 'supplied' => $rendered2,
+ 'registered_again' => $rendered1,
+ ];
+
+ $actual = [
+ 'registered' => $this->helper->render(),
+ 'supplied' => $this->helper->render($this->nav2),
+ 'registered_again' => $this->helper->render(),
+ ];
+
+ $this->assertEquals($expected, $actual);
+ }
+
+ public function testUseAclResourceFromPages(): void
+ {
+ $acl = $this->getAcl();
+ $this->helper->setAcl($acl['acl']);
+ $this->helper->setRole($acl['role']);
+
+ $expected = $this->getExpectedFileContents('bc/acl.html');
+ $this->assertEquals($expected, $this->helper->render());
+ }
+
+ public function testTranslationUsingLaminasTranslate(): void
+ {
+ if (! extension_loaded('intl')) {
+ $this->markTestSkipped('ext/intl not enabled');
+ }
+
+ $this->helper->setTranslator($this->getTranslator());
+
+ $expected = $this->getExpectedFileContents('bc/translated.html');
+ $this->assertEquals($expected, $this->helper->render());
+ }
+
+ public function testTranslationUsingLaminasTranslateAndCustomTextDomain(): void
+ {
+ if (! extension_loaded('intl')) {
+ $this->markTestSkipped('ext/intl not enabled');
+ }
+
+ $this->helper->setTranslator($this->getTranslatorWithTextDomain());
+
+ $expected = $this->getExpectedFileContents('bc/textdomain.html');
+ $test = $this->helper->render($this->nav3);
+
+ $this->assertEquals(trim($expected), trim($test));
+ }
+
+ public function testTranslationUsingLaminasTranslateAdapter(): void
+ {
+ if (! extension_loaded('intl')) {
+ $this->markTestSkipped('ext/intl not enabled');
+ }
+
+ $translator = $this->getTranslator();
+ $this->helper->setTranslator($translator);
+
+ $expected = $this->getExpectedFileContents('bc/translated.html');
+ $this->assertEquals($expected, $this->helper->render());
+ }
+
+ public function testDisablingTranslation(): void
+ {
+ $translator = $this->getTranslator();
+ $this->helper->setTranslator($translator);
+ $this->helper->setTranslatorEnabled(false);
+
+ $expected = $this->getExpectedFileContents('bc/default.html');
+ $this->assertEquals($expected, $this->helper->render());
+ }
+
+ public function testRenderingPartial(): void
+ {
+ $this->helper->setPartial('bc.phtml');
+
+ $expected = $this->getExpectedFileContents('bc/partial.html');
+ $this->assertEquals($expected, $this->helper->render());
+ }
+
+ public function testRenderingPartialWithSeparator(): void
+ {
+ $this->helper->setPartial('bc_separator.phtml')->setSeparator(' / ');
+
+ $expected = trim($this->getExpectedFileContents('bc/partialwithseparator.html'));
+ $this->assertEquals($expected, $this->helper->render());
+ }
+
+ public function testRenderingPartialBySpecifyingAnArrayAsPartial(): void
+ {
+ $this->helper->setPartial(['bc.phtml', 'application']);
+
+ $expected = $this->getExpectedFileContents('bc/partial.html');
+ $this->assertEquals($expected, $this->helper->render());
+ }
+
+ public function testRenderingPartialShouldFailOnInvalidPartialArray(): void
+ {
+ $this->helper->setPartial(['bc.phtml']);
+ $this->expectException(InvalidArgumentException::class);
+ $this->helper->render();
+ }
+
+ public function testRenderingPartialWithParams(): void
+ {
+ $this->helper->setPartial('bc_with_partial_params.phtml')->setSeparator(' / ');
+ $expected = $this->getExpectedFileContents('bc/partial_with_params.html');
+ $actual = $this->helper->renderPartialWithParams(['variable' => 'test value']);
+ $this->assertEquals($expected, $actual);
+ }
+
+ public function testLastBreadcrumbShouldBeEscaped(): void
+ {
+ $container = new Navigation([
+ [
+ 'label' => 'Live & Learn',
+ 'uri' => '#',
+ 'active' => true,
+ ],
+ ]);
+
+ $expected = 'Live & Learn';
+ $actual = $this->helper->setMinDepth(0)->render($container);
+
+ $this->assertEquals($expected, $actual);
+ }
+}
diff --git a/test/View/Helper/LinksTest.php b/test/View/Helper/LinksTest.php
new file mode 100644
index 00000000..ae8b876d
--- /dev/null
+++ b/test/View/Helper/LinksTest.php
@@ -0,0 +1,726 @@
+helper = new Links();
+ parent::setUp();
+
+ // doctype fix (someone forgot to clean up after their unit tests)
+ $renderer = $this->helper->getView();
+ assert($renderer instanceof PhpRenderer);
+ $helper = $renderer->plugin(Doctype::class);
+ $this->doctypeHelper = $helper;
+ $this->doctypeHelper->setDoctype(
+ Doctype::HTML4_LOOSE
+ );
+
+ // disable all active pages
+ foreach ($this->helper->findAllByActive(true) as $page) {
+ $page->active = false;
+ }
+ }
+
+ public function testCanRenderFromServiceAlias(): void
+ {
+ $this->helper->setServiceLocator($this->serviceManager);
+
+ $returned = $this->helper->render('Navigation');
+ $this->assertEquals($returned, $this->getExpectedFileContents('links/default.html'));
+ }
+
+ public function testHelperEntryPointWithoutAnyParams(): void
+ {
+ $returned = $this->helper->__invoke();
+ $this->assertEquals($this->helper, $returned);
+ $this->assertEquals($this->nav1, $returned->getContainer());
+ }
+
+ public function testHelperEntryPointWithContainerParam(): void
+ {
+ $returned = $this->helper->__invoke($this->nav2);
+ $this->assertEquals($this->helper, $returned);
+ $this->assertEquals($this->nav2, $returned->getContainer());
+ }
+
+ public function testDoNotRenderIfNoPageIsActive(): void
+ {
+ $this->assertEquals('', $this->helper->render());
+ }
+
+ public function testDetectRelationFromStringPropertyOfActivePage(): void
+ {
+ $active = $this->helper->findOneByLabel('Page 2');
+ $active->addRel('example', 'http://www.example.com/');
+ $found = $this->helper->findRelation($active, 'rel', 'example');
+
+ $expected = [
+ 'type' => UriPage::class,
+ 'href' => 'http://www.example.com/',
+ 'label' => null,
+ ];
+
+ $actual = [
+ 'type' => $found !== null ? $found::class : self::class,
+ 'href' => $found->getHref(),
+ 'label' => $found->getLabel(),
+ ];
+
+ $this->assertEquals($expected, $actual);
+ }
+
+ public function testDetectRelationFromPageInstancePropertyOfActivePage(): void
+ {
+ $active = $this->helper->findOneByLabel('Page 2');
+ $active->addRel('example', AbstractPage::factory([
+ 'uri' => 'http://www.example.com/',
+ 'label' => 'An example page',
+ ]));
+ $found = $this->helper->findRelExample($active);
+
+ $expected = [
+ 'type' => UriPage::class,
+ 'href' => 'http://www.example.com/',
+ 'label' => 'An example page',
+ ];
+
+ $actual = [
+ 'type' => $found::class,
+ 'href' => $found->getHref(),
+ 'label' => $found->getLabel(),
+ ];
+
+ $this->assertEquals($expected, $actual);
+ }
+
+ public function testDetectRelationFromArrayPropertyOfActivePage(): void
+ {
+ $active = $this->helper->findOneByLabel('Page 2');
+ $active->addRel('example', [
+ 'uri' => 'http://www.example.com/',
+ 'label' => 'An example page',
+ ]);
+ $found = $this->helper->findRelExample($active);
+
+ $expected = [
+ 'type' => UriPage::class,
+ 'href' => 'http://www.example.com/',
+ 'label' => 'An example page',
+ ];
+
+ $actual = [
+ 'type' => $found::class,
+ 'href' => $found->getHref(),
+ 'label' => $found->getLabel(),
+ ];
+
+ $this->assertEquals($expected, $actual);
+ }
+
+ public function testDetectRelationFromArrayObjectInstancePropertyOfActivePage(): void
+ {
+ $active = $this->helper->findOneByLabel('Page 2');
+ $active->addRel('example', new ArrayObject([
+ 'uri' => 'http://www.example.com/',
+ 'label' => 'An example page',
+ ]));
+ $found = $this->helper->findRelExample($active);
+
+ $expected = [
+ 'type' => UriPage::class,
+ 'href' => 'http://www.example.com/',
+ 'label' => 'An example page',
+ ];
+
+ $actual = [
+ 'type' => $found::class,
+ 'href' => $found->getHref(),
+ 'label' => $found->getLabel(),
+ ];
+
+ $this->assertEquals($expected, $actual);
+ }
+
+ public function testDetectMultipleRelationsFromArrayPropertyOfActivePage(): void
+ {
+ $active = $this->helper->findOneByLabel('Page 2');
+
+ $active->addRel('alternate', [
+ [
+ 'label' => 'foo',
+ 'uri' => 'bar',
+ ],
+ [
+ 'label' => 'baz',
+ 'uri' => 'bat',
+ ],
+ ]);
+
+ $found = $this->helper->findRelAlternate($active);
+
+ $expected = ['type' => 'array', 'count' => 2];
+ $actual = ['type' => gettype($found), 'count' => count($found)];
+ $this->assertEquals($expected, $actual);
+ }
+
+ public function testDetectMultipleRelationsFromArrayObjectPropertyOfActivePage(): void
+ {
+ $active = $this->helper->findOneByLabel('Page 2');
+
+ $active->addRel('alternate', new ArrayObject([
+ [
+ 'label' => 'foo',
+ 'uri' => 'bar',
+ ],
+ [
+ 'label' => 'baz',
+ 'uri' => 'bat',
+ ],
+ ]));
+
+ $found = $this->helper->findRelAlternate($active);
+
+ $expected = ['type' => 'array', 'count' => 2];
+ $actual = ['type' => gettype($found), 'count' => count($found)];
+ $this->assertEquals($expected, $actual);
+ }
+
+ public function testExtractingRelationsFromPageProperties(): void
+ {
+ $types = [
+ 'alternate',
+ 'stylesheet',
+ 'start',
+ 'next',
+ 'prev',
+ 'contents',
+ 'index',
+ 'glossary',
+ 'copyright',
+ 'chapter',
+ 'section',
+ 'subsection',
+ 'appendix',
+ 'help',
+ 'bookmark',
+ ];
+
+ $samplePage = AbstractPage::factory([
+ 'label' => 'An example page',
+ 'uri' => 'http://www.example.com/',
+ ]);
+
+ $active = $this->helper->findOneByLabel('Page 2');
+ $expected = [];
+ $actual = [];
+
+ foreach ($types as $type) {
+ $active->addRel($type, $samplePage);
+ $found = $this->helper->findRelation($active, 'rel', $type);
+
+ $expected[$type] = $samplePage->getLabel();
+ $actual[$type] = $found->getLabel();
+
+ $active->removeRel($type);
+ }
+
+ $this->assertEquals($expected, $actual);
+ }
+
+ public function testFindStartPageByTraversal(): void
+ {
+ $active = $this->helper->findOneByLabel('Page 2.1');
+ $expected = 'Home';
+ $actual = $this->helper->findRelStart($active)->getLabel();
+ $this->assertEquals($expected, $actual);
+ }
+
+ public function testDoNotFindStartWhenGivenPageIsTheFirstPage(): void
+ {
+ $active = $this->helper->findOneByLabel('Home');
+ $actual = $this->helper->findRelStart($active);
+ $this->assertNull($actual, 'Should not find any start page');
+ }
+
+ public function testFindNextPageByTraversalShouldFindChildPage(): void
+ {
+ $active = $this->helper->findOneByLabel('Page 2');
+ $expected = 'Page 2.1';
+ $actual = $this->helper->findRelNext($active)->getLabel();
+ $this->assertEquals($expected, $actual);
+ }
+
+ public function testFindNextPageByTraversalShouldFindSiblingPage(): void
+ {
+ $active = $this->helper->findOneByLabel('Page 2.1');
+ $expected = 'Page 2.2';
+ $actual = $this->helper->findRelNext($active)->getLabel();
+ $this->assertEquals($expected, $actual);
+ }
+
+ public function testFindNextPageByTraversalShouldWrap(): void
+ {
+ $active = $this->helper->findOneByLabel('Page 2.2.2');
+ $expected = 'Page 2.3';
+ $actual = $this->helper->findRelNext($active)->getLabel();
+ $this->assertEquals($expected, $actual);
+ }
+
+ public function testFindPrevPageByTraversalShouldFindParentPage(): void
+ {
+ $active = $this->helper->findOneByLabel('Page 2.1');
+ $expected = 'Page 2';
+ $actual = $this->helper->findRelPrev($active)->getLabel();
+ $this->assertEquals($expected, $actual);
+ }
+
+ public function testFindPrevPageByTraversalShouldFindSiblingPage(): void
+ {
+ $active = $this->helper->findOneByLabel('Page 2.2');
+ $expected = 'Page 2.1';
+ $actual = $this->helper->findRelPrev($active)->getLabel();
+ $this->assertEquals($expected, $actual);
+ }
+
+ public function testFindPrevPageByTraversalShouldWrap(): void
+ {
+ $active = $this->helper->findOneByLabel('Page 2.3');
+ $expected = 'Page 2.2.2';
+ $actual = $this->helper->findRelPrev($active)->getLabel();
+ $this->assertEquals($expected, $actual);
+ }
+
+ public function testShouldFindChaptersFromFirstLevelOfPagesInContainer(): void
+ {
+ $active = $this->helper->findOneByLabel('Page 2.3');
+ $found = $this->helper->findRelChapter($active);
+
+ $expected = ['Page 1', 'Page 2', 'Page 3', 'Zym'];
+ $actual = [];
+ foreach ($found as $page) {
+ $actual[] = $page->getLabel();
+ }
+
+ $this->assertEquals($expected, $actual);
+ }
+
+ public function testFindingChaptersShouldExcludeSelfIfChapter(): void
+ {
+ $active = $this->helper->findOneByLabel('Page 2');
+ $found = $this->helper->findRelChapter($active);
+
+ $expected = ['Page 1', 'Page 3', 'Zym'];
+ $actual = [];
+ foreach ($found as $page) {
+ $actual[] = $page->getLabel();
+ }
+
+ $this->assertEquals($expected, $actual);
+ }
+
+ public function testFindSectionsWhenActiveChapterPage(): void
+ {
+ $active = $this->helper->findOneByLabel('Page 2');
+ $found = $this->helper->findRelSection($active);
+ $expected = ['Page 2.1', 'Page 2.2', 'Page 2.3'];
+ $actual = [];
+ foreach ($found as $page) {
+ $actual[] = $page->getLabel();
+ }
+ $this->assertEquals($expected, $actual);
+ }
+
+ public function testDoNotFindSectionsWhenActivePageIsASection(): void
+ {
+ $active = $this->helper->findOneByLabel('Page 2.2');
+ $found = $this->helper->findRelSection($active);
+ $this->assertNull($found);
+ }
+
+ public function testDoNotFindSectionsWhenActivePageIsASubsection(): void
+ {
+ $active = $this->helper->findOneByLabel('Page 2.2.1');
+ $found = $this->helper->findRelation($active, 'rel', 'section');
+ $this->assertNull($found);
+ }
+
+ public function testFindSubsectionWhenActivePageIsSection(): void
+ {
+ $active = $this->helper->findOneByLabel('Page 2.2');
+ $found = $this->helper->findRelSubsection($active);
+
+ $expected = ['Page 2.2.1', 'Page 2.2.2'];
+ $actual = [];
+ foreach ($found as $page) {
+ $actual[] = $page->getLabel();
+ }
+ $this->assertEquals($expected, $actual);
+ }
+
+ public function testDoNotFindSubsectionsWhenActivePageIsASubSubsection(): void
+ {
+ $active = $this->helper->findOneByLabel('Page 2.2.1');
+ $found = $this->helper->findRelSubsection($active);
+ $this->assertNull($found);
+ }
+
+ public function testDoNotFindSubsectionsWhenActivePageIsAChapter(): void
+ {
+ $active = $this->helper->findOneByLabel('Page 2');
+ $found = $this->helper->findRelSubsection($active);
+ $this->assertNull($found);
+ }
+
+ public function testFindRevSectionWhenPageIsSection(): void
+ {
+ $active = $this->helper->findOneByLabel('Page 2.2');
+ $found = $this->helper->findRevSection($active);
+ $this->assertEquals('Page 2', $found->getLabel());
+ }
+
+ public function testFindRevSubsectionWhenPageIsSubsection(): void
+ {
+ $active = $this->helper->findOneByLabel('Page 2.2.1');
+ $found = $this->helper->findRevSubsection($active);
+ $this->assertEquals('Page 2.2', $found->getLabel());
+ }
+
+ public function testAclFiltersAwayPagesFromPageProperty(): void
+ {
+ $acl = new Acl\Acl();
+ $acl->addRole(new Role\GenericRole('member'));
+ $acl->addRole(new Role\GenericRole('admin'));
+ $acl->addResource(new Resource\GenericResource('protected'));
+ $acl->allow('admin', 'protected');
+ $this->helper->setAcl($acl);
+ $this->helper->setRole($acl->getRole('member'));
+
+ $samplePage = AbstractPage::factory([
+ 'label' => 'An example page',
+ 'uri' => 'http://www.example.com/',
+ 'resource' => 'protected',
+ ]);
+
+ $active = $this->helper->findOneByLabel('Home');
+ $expected = [
+ 'alternate' => false,
+ 'stylesheet' => false,
+ 'start' => false,
+ 'next' => 'Page 1',
+ 'prev' => false,
+ 'contents' => false,
+ 'index' => false,
+ 'glossary' => false,
+ 'copyright' => false,
+ 'chapter' => 'array(4)',
+ 'section' => false,
+ 'subsection' => false,
+ 'appendix' => false,
+ 'help' => false,
+ 'bookmark' => false,
+ ];
+ $actual = [];
+
+ foreach ($expected as $type => $discard) {
+ $active->addRel($type, $samplePage);
+
+ $found = $this->helper->findRelation($active, 'rel', $type);
+ if (null === $found) {
+ $actual[$type] = false;
+ } elseif (is_array($found)) {
+ $actual[$type] = 'array(' . count($found) . ')';
+ } else {
+ $actual[$type] = $found->getLabel();
+ }
+ }
+
+ $this->assertEquals($expected, $actual);
+ }
+
+ public function testAclFiltersAwayPagesFromContainerSearch(): void
+ {
+ $acl = new Acl\Acl();
+ $acl->addRole(new Role\GenericRole('member'));
+ $acl->addRole(new Role\GenericRole('admin'));
+ $acl->addResource(new Resource\GenericResource('protected'));
+ $acl->allow('admin', 'protected');
+ $this->helper->setAcl($acl);
+ $this->helper->setRole($acl->getRole('member'));
+
+ $this->helper->getContainer();
+ $container = $this->helper->getContainer();
+ $iterator = new RecursiveIteratorIterator(
+ $container,
+ RecursiveIteratorIterator::SELF_FIRST
+ );
+ foreach ($iterator as $page) {
+ $page->resource = 'protected';
+ }
+ $this->helper->setContainer($container);
+
+ $this->helper->findOneByLabel('Home');
+ $search = [
+ 'start' => 'Page 1',
+ 'next' => 'Page 1',
+ 'prev' => 'Page 1.1',
+ 'chapter' => 'Home',
+ 'section' => 'Page 1',
+ 'subsection' => 'Page 2.2',
+ ];
+
+ $expected = [];
+ $actual = [];
+
+ foreach ($search as $type => $active) {
+ $expected[$type] = false;
+
+ $active = $this->helper->findOneByLabel($active);
+ $found = $this->helper->findRelation($active, 'rel', $type);
+
+ if (null === $found) {
+ $actual[$type] = false;
+ } elseif (is_array($found)) {
+ $actual[$type] = 'array(' . count($found) . ')';
+ } else {
+ $actual[$type] = $found->getLabel();
+ }
+ }
+
+ $this->assertEquals($expected, $actual);
+ }
+
+ public function testFindRelationMustSpecifyRelOrRev(): void
+ {
+ $active = $this->helper->findOneByLabel('Home');
+ try {
+ $this->helper->findRelation($active, 'foo', 'bar');
+ $this->fail('An invalid value was given, but a '
+ . 'Laminas\View\Exception\InvalidArgumentException was not thrown');
+ } catch (View\Exception\ExceptionInterface $e) {
+ $this->assertStringContainsString('Invalid argument: $rel', $e->getMessage());
+ }
+ }
+
+ public function testRenderLinkMustSpecifyRelOrRev(): void
+ {
+ $active = $this->helper->findOneByLabel('Home');
+ try {
+ $this->helper->renderLink($active, 'foo', 'bar');
+ $this->fail('An invalid value was given, but a '
+ . 'Laminas\View\Exception\InvalidArgumentException was not thrown');
+ } catch (View\Exception\ExceptionInterface $e) {
+ $this->assertStringContainsString('Invalid relation attribute', $e->getMessage());
+ }
+ }
+
+ public function testFindAllRelations(): void
+ {
+ $expectedRelations = [
+ 'alternate' => ['Forced page'],
+ 'stylesheet' => ['Forced page'],
+ 'start' => ['Forced page'],
+ 'next' => ['Forced page'],
+ 'prev' => ['Forced page'],
+ 'contents' => ['Forced page'],
+ 'index' => ['Forced page'],
+ 'glossary' => ['Forced page'],
+ 'copyright' => ['Forced page'],
+ 'chapter' => ['Forced page'],
+ 'section' => ['Forced page'],
+ 'subsection' => ['Forced page'],
+ 'appendix' => ['Forced page'],
+ 'help' => ['Forced page'],
+ 'bookmark' => ['Forced page'],
+ 'canonical' => ['Forced page'],
+ 'home' => ['Forced page'],
+ ];
+
+ // build expected result
+ $expected = [
+ 'rel' => $expectedRelations,
+ 'rev' => $expectedRelations,
+ ];
+
+ // find active page and create page to use for relations
+ $active = $this->helper->findOneByLabel('Page 1');
+ $forcedRelation = new UriPage([
+ 'label' => 'Forced page',
+ 'uri' => '#',
+ ]);
+
+ // add relations to active page
+ foreach ($expectedRelations as $type => $discard) {
+ $active->addRel($type, $forcedRelation);
+ $active->addRev($type, $forcedRelation);
+ }
+
+ // build actual result
+ $actual = $this->helper->findAllRelations($active);
+ foreach ($actual as $attrib => $relations) {
+ foreach ($relations as $type => $pages) {
+ foreach ($pages as $key => $page) {
+ $actual[$attrib][$type][$key] = $page->getLabel();
+ }
+ }
+ }
+
+ $this->assertEquals($expected, $actual);
+ }
+
+ // @codingStandardsIgnoreStart
+ /**
+ * @return string[]
+ *
+ * @psalm-return array{1: 'alternate', 2: 'stylesheet', 4: 'start', 8: 'next', 16: 'prev', 32: 'contents', 64: 'index', 128: 'glossary', 512: 'chapter', 1024: 'section', 2048: 'subsection', 4096: 'appendix', 8192: 'help', 16384: 'bookmark', 32768: 'canonical'}
+ */
+ private function _getFlags(): array
+ {
+ // @codingStandardsIgnoreEnd
+ return [
+ Links::RENDER_ALTERNATE => 'alternate',
+ Links::RENDER_STYLESHEET => 'stylesheet',
+ Links::RENDER_START => 'start',
+ Links::RENDER_NEXT => 'next',
+ Links::RENDER_PREV => 'prev',
+ Links::RENDER_CONTENTS => 'contents',
+ Links::RENDER_INDEX => 'index',
+ Links::RENDER_GLOSSARY => 'glossary',
+ Links::RENDER_CHAPTER => 'chapter',
+ Links::RENDER_SECTION => 'section',
+ Links::RENDER_SUBSECTION => 'subsection',
+ Links::RENDER_APPENDIX => 'appendix',
+ Links::RENDER_HELP => 'help',
+ Links::RENDER_BOOKMARK => 'bookmark',
+ Links::RENDER_CUSTOM => 'canonical',
+ ];
+ }
+
+ public function testSingleRenderFlags(): void
+ {
+ $active = $this->helper->findOneByLabel('Home');
+ $active->active = true;
+
+ $expected = [];
+ $actual = [];
+
+ // build expected and actual result
+ foreach ($this->_getFlags() as $newFlag => $type) {
+ // add forced relation
+ $active->addRel($type, 'http://www.example.com/');
+ $active->addRev($type, 'http://www.example.com/');
+
+ $this->helper->setRenderFlag($newFlag);
+ $expectedOutput = '' . PHP_EOL
+ . '';
+ $actualOutput = $this->helper->render();
+
+ $expected[$type] = $expectedOutput;
+ $actual[$type] = $actualOutput;
+
+ // remove forced relation
+ $active->removeRel($type);
+ $active->removeRev($type);
+ }
+
+ $this->assertEquals($expected, $actual);
+ }
+
+ public function testRenderFlagBitwiseOr(): void
+ {
+ $newFlag = Links::RENDER_NEXT |
+ Links::RENDER_PREV;
+ $this->helper->setRenderFlag($newFlag);
+ $active = $this->helper->findOneByLabel('Page 1.1');
+ $active->active = true;
+
+ // test data
+ $expected = ''
+ . PHP_EOL
+ . '';
+ $actual = $this->helper->render();
+
+ $this->assertEquals($expected, $actual);
+ }
+
+ public function testIndenting(): void
+ {
+ $active = $this->helper->findOneByLabel('Page 1.1');
+ $newFlag = Links::RENDER_NEXT |
+ Links::RENDER_PREV;
+ $this->helper->setRenderFlag($newFlag);
+ $this->helper->setIndent(' ');
+ $active->active = true;
+
+ // build expected and actual result
+ $expected = ' '
+ . PHP_EOL
+ . ' ';
+ $actual = $this->helper->render();
+
+ $this->assertEquals($expected, $actual);
+ }
+
+ public function testSetMaxDepth(): void
+ {
+ $this->helper->setMaxDepth(1);
+ $this->helper->findOneByLabel('Page 2.3.3')->setActive(); // level 2
+ $flag = Links::RENDER_NEXT;
+
+ $expected = '';
+ $actual = $this->helper->setRenderFlag($flag)->render();
+
+ $this->assertEquals($expected, $actual);
+ }
+
+ public function testSetMinDepth(): void
+ {
+ $this->helper->setMinDepth(2);
+ $this->helper->findOneByLabel('Page 2.3')->setActive(); // level 1
+ $flag = Links::RENDER_NEXT;
+
+ $expected = '';
+ $actual = $this->helper->setRenderFlag($flag)->render();
+
+ $this->assertEquals($expected, $actual);
+ }
+
+ /** @inheritDoc */
+ protected function getExpectedFileContents(string $filename): string
+ {
+ return str_replace("\n", PHP_EOL, parent::getExpectedFileContents($filename));
+ }
+}
diff --git a/test/View/Helper/MenuTest.php b/test/View/Helper/MenuTest.php
new file mode 100644
index 00000000..e6610754
--- /dev/null
+++ b/test/View/Helper/MenuTest.php
@@ -0,0 +1,609 @@
+helper = new Menu();
+ parent::setUp();
+ }
+
+ public function testCanRenderMenuFromServiceAlias(): void
+ {
+ $this->helper->setServiceLocator($this->serviceManager);
+
+ $returned = $this->helper->renderMenu('Navigation');
+ $this->assertEquals($returned, $this->getExpectedFileContents('menu/default1.html'));
+ }
+
+ public function testCanRenderPartialFromServiceAlias(): void
+ {
+ $this->helper->setPartial('menu.phtml');
+ $this->helper->setServiceLocator($this->serviceManager);
+
+ $returned = $this->helper->renderPartial('Navigation');
+ $this->assertEquals($returned, $this->getExpectedFileContents('menu/partial.html'));
+ }
+
+ public function testHelperEntryPointWithoutAnyParams(): void
+ {
+ $returned = $this->helper->__invoke();
+ $this->assertEquals($this->helper, $returned);
+ $this->assertEquals($this->nav1, $returned->getContainer());
+ }
+
+ public function testHelperEntryPointWithContainerParam(): void
+ {
+ $returned = $this->helper->__invoke($this->nav2);
+ $this->assertEquals($this->helper, $returned);
+ $this->assertEquals($this->nav2, $returned->getContainer());
+ }
+
+ public function testNullingOutContainerInHelper(): void
+ {
+ $this->helper->setContainer();
+ $this->assertEquals(0, count($this->helper->getContainer()));
+ }
+
+ public function testSetIndentAndOverrideInRenderMenu(): void
+ {
+ $this->helper->setIndent(8);
+
+ $expected = [
+ 'indent4' => $this->getExpectedFileContents('menu/indent4.html'),
+ 'indent8' => $this->getExpectedFileContents('menu/indent8.html'),
+ ];
+
+ $renderOptions = [
+ 'indent' => 4,
+ ];
+
+ $actual = [
+ 'indent4' => rtrim($this->helper->renderMenu(null, $renderOptions), PHP_EOL),
+ 'indent8' => rtrim($this->helper->renderMenu(), PHP_EOL),
+ ];
+
+ $this->assertEquals($expected, $actual);
+ }
+
+ public function testRenderSuppliedContainerWithoutInterfering(): void
+ {
+ $rendered1 = $this->getExpectedFileContents('menu/default1.html');
+ $rendered2 = $this->getExpectedFileContents('menu/default2.html');
+ $expected = [
+ 'registered' => $rendered1,
+ 'supplied' => $rendered2,
+ 'registered_again' => $rendered1,
+ ];
+
+ $actual = [
+ 'registered' => $this->helper->render(),
+ 'supplied' => $this->helper->render($this->nav2),
+ 'registered_again' => $this->helper->render(),
+ ];
+
+ $this->assertEquals($expected, $actual);
+ }
+
+ public function testUseAclRoleAsString(): void
+ {
+ $acl = $this->getAcl();
+ $this->helper->setAcl($acl['acl']);
+ $this->helper->setRole('member');
+
+ $expected = $this->getExpectedFileContents('menu/acl_string.html');
+ $this->assertEquals($expected, $this->helper->render());
+ }
+
+ public function testFilterOutPagesBasedOnAcl(): void
+ {
+ $acl = $this->getAcl();
+ $this->helper->setAcl($acl['acl']);
+ $this->helper->setRole($acl['role']);
+
+ $expected = $this->getExpectedFileContents('menu/acl.html');
+ $actual = $this->helper->render();
+
+ $this->assertEquals($expected, $actual);
+ }
+
+ public function testDisablingAcl(): void
+ {
+ $acl = $this->getAcl();
+ $this->helper->setAcl($acl['acl']);
+ $this->helper->setRole($acl['role']);
+ $this->helper->setUseAcl(false);
+
+ $expected = $this->getExpectedFileContents('menu/default1.html');
+ $actual = $this->helper->render();
+
+ $this->assertEquals($expected, $actual);
+ }
+
+ public function testUseAnAclRoleInstanceFromAclObject(): void
+ {
+ $acl = $this->getAcl();
+ $this->helper->setAcl($acl['acl']);
+ $this->helper->setRole($acl['acl']->getRole('member'));
+
+ $expected = $this->getExpectedFileContents('menu/acl_role_interface.html');
+ $this->assertEquals($expected, $this->helper->render());
+ }
+
+ public function testUseConstructedAclRolesNotFromAclObject(): void
+ {
+ $acl = $this->getAcl();
+ $this->helper->setAcl($acl['acl']);
+ $this->helper->setRole(new GenericRole('member'));
+
+ $expected = $this->getExpectedFileContents('menu/acl_role_interface.html');
+ $this->assertEquals($expected, $this->helper->render());
+ }
+
+ public function testSetUlCssClass(): void
+ {
+ $this->helper->setUlClass('My_Nav');
+ $expected = $this->getExpectedFileContents('menu/css.html');
+ $this->assertEquals($expected, $this->helper->render($this->nav2));
+ }
+
+ public function testSetLiActiveCssClass(): void
+ {
+ $this->helper->setLiActiveClass('activated');
+ $expected = $this->getExpectedFileContents('menu/css2.html');
+ $this->assertEquals(trim($expected), $this->helper->render($this->nav2));
+ }
+
+ public function testOptionEscapeLabelsAsTrue(): void
+ {
+ $options = [
+ 'escapeLabels' => true,
+ ];
+
+ $container = new Navigation($this->nav2->toArray());
+ $container->addPage([
+ 'label' => 'Badges 1',
+ 'uri' => 'badges',
+ ]);
+
+ $expected = $this->getExpectedFileContents('menu/escapelabels_as_true.html');
+ $actual = $this->helper->renderMenu($container, $options);
+
+ $this->assertEquals($expected, $actual);
+ }
+
+ public function testOptionEscapeLabelsAsFalse(): void
+ {
+ $options = [
+ 'escapeLabels' => false,
+ ];
+
+ $container = new Navigation($this->nav2->toArray());
+ $container->addPage([
+ 'label' => 'Badges 1',
+ 'uri' => 'badges',
+ ]);
+
+ $expected = $this->getExpectedFileContents('menu/escapelabels_as_false.html');
+ $actual = $this->helper->renderMenu($container, $options);
+
+ $this->assertEquals($expected, $actual);
+ }
+
+ public function testTranslationUsingLaminasTranslate(): void
+ {
+ if (! extension_loaded('intl')) {
+ $this->markTestSkipped('ext/intl not enabled');
+ }
+
+ $translator = $this->getTranslator();
+ $this->helper->setTranslator($translator);
+
+ $expected = $this->getExpectedFileContents('menu/translated.html');
+ $this->assertEquals($expected, $this->helper->render());
+ }
+
+ public function testTranslationUsingLaminasTranslateWithTextDomain(): void
+ {
+ if (! extension_loaded('intl')) {
+ $this->markTestSkipped('ext/intl not enabled');
+ }
+
+ $translator = $this->getTranslatorWithTextDomain();
+ $this->helper->setTranslator($translator);
+
+ $expected = $this->getExpectedFileContents('menu/textdomain.html');
+ $test = $this->helper->render($this->nav3);
+ $this->assertEquals(trim($expected), trim($test));
+ }
+
+ public function testTranslationUsingLaminasTranslateAdapter(): void
+ {
+ if (! extension_loaded('intl')) {
+ $this->markTestSkipped('ext/intl not enabled');
+ }
+
+ $translator = $this->getTranslator();
+ $this->helper->setTranslator($translator);
+
+ $expected = $this->getExpectedFileContents('menu/translated.html');
+ $this->assertEquals($expected, $this->helper->render());
+ }
+
+ public function testDisablingTranslation(): void
+ {
+ $translator = $this->getTranslator();
+ $this->helper->setTranslator($translator);
+ $this->helper->setTranslatorEnabled(false);
+
+ $expected = $this->getExpectedFileContents('menu/default1.html');
+ $this->assertEquals($expected, $this->helper->render());
+ }
+
+ public function testRenderingPartial(): void
+ {
+ $this->helper->setPartial('menu.phtml');
+
+ $expected = $this->getExpectedFileContents('menu/partial.html');
+ $actual = $this->helper->render();
+
+ $this->assertEquals($expected, $actual);
+ }
+
+ public function testRenderingPartialBySpecifyingAnArrayAsPartial(): void
+ {
+ $this->helper->setPartial(['menu.phtml', 'application']);
+
+ $expected = $this->getExpectedFileContents('menu/partial.html');
+ $actual = $this->helper->render();
+
+ $this->assertEquals($expected, $actual);
+ }
+
+ public function testRenderingPartialWithParams(): void
+ {
+ $this->helper->setPartial(['menu_with_partial_params.phtml', 'application']);
+ $expected = $this->getExpectedFileContents('menu/partial_with_params.html');
+ $actual = $this->helper->renderPartialWithParams(['variable' => 'test value']);
+ $this->assertEquals($expected, $actual);
+ }
+
+ public function testRenderingPartialShouldFailOnInvalidPartialArray(): void
+ {
+ $this->helper->setPartial(['menu.phtml']);
+ $this->expectException(InvalidArgumentException::class);
+ $this->helper->render();
+ }
+
+ public function testSetMaxDepth(): void
+ {
+ $this->helper->setMaxDepth(1);
+
+ $expected = $this->getExpectedFileContents('menu/maxdepth.html');
+ $actual = $this->helper->renderMenu();
+
+ $this->assertEquals($expected, $actual);
+ }
+
+ public function testSetMinDepth(): void
+ {
+ $this->helper->setMinDepth(1);
+
+ $expected = $this->getExpectedFileContents('menu/mindepth.html');
+ $actual = $this->helper->renderMenu();
+
+ $this->assertEquals($expected, $actual);
+ }
+
+ public function testSetBothDepts(): void
+ {
+ $this->helper->setMinDepth(1)->setMaxDepth(2);
+
+ $expected = $this->getExpectedFileContents('menu/bothdepts.html');
+ $actual = $this->helper->renderMenu();
+
+ $this->assertEquals($expected, $actual);
+ }
+
+ public function testSetOnlyActiveBranch(): void
+ {
+ $this->helper->setOnlyActiveBranch(true);
+
+ $expected = $this->getExpectedFileContents('menu/onlyactivebranch.html');
+ $actual = $this->helper->renderMenu();
+
+ $this->assertEquals($expected, $actual);
+ }
+
+ public function testSetRenderParents(): void
+ {
+ $this->helper->setOnlyActiveBranch(true)->setRenderParents(false);
+
+ $expected = $this->getExpectedFileContents('menu/onlyactivebranch_noparents.html');
+ $actual = $this->helper->renderMenu();
+
+ $this->assertEquals($expected, $actual);
+ }
+
+ public function testSetOnlyActiveBranchAndMinDepth(): void
+ {
+ $this->helper->setOnlyActiveBranch()->setMinDepth(1);
+
+ $expected = $this->getExpectedFileContents('menu/onlyactivebranch_mindepth.html');
+ $actual = $this->helper->renderMenu();
+
+ $this->assertEquals($expected, $actual);
+ }
+
+ public function testOnlyActiveBranchAndMaxDepth(): void
+ {
+ $this->helper->setOnlyActiveBranch()->setMaxDepth(2);
+
+ $expected = $this->getExpectedFileContents('menu/onlyactivebranch_maxdepth.html');
+ $actual = $this->helper->renderMenu();
+
+ $this->assertEquals($expected, $actual);
+ }
+
+ public function testOnlyActiveBranchAndBothDepthsSpecified(): void
+ {
+ $this->helper->setOnlyActiveBranch()->setMinDepth(1)->setMaxDepth(2);
+
+ $expected = $this->getExpectedFileContents('menu/onlyactivebranch_bothdepts.html');
+ $actual = $this->helper->renderMenu();
+
+ $this->assertEquals($expected, $actual);
+ }
+
+ public function testOnlyActiveBranchNoParentsAndBothDepthsSpecified(): void
+ {
+ $this->helper->setOnlyActiveBranch()
+ ->setMinDepth(1)
+ ->setMaxDepth(2)
+ ->setRenderParents(false);
+
+ $expected = $this->getExpectedFileContents('menu/onlyactivebranch_np_bd.html');
+ $actual = $this->helper->renderMenu();
+
+ $this->assertEquals($expected, $actual);
+ }
+
+ // @codingStandardsIgnoreStart
+ private function _setActive(string $label): void
+ {
+ // @codingStandardsIgnoreEnd
+ $container = $this->helper->getContainer();
+
+ foreach ($container->findAllByActive(true) as $page) {
+ $page->setActive(false);
+ }
+
+ if ($p = $container->findOneByLabel($label)) {
+ $p->setActive(true);
+ }
+ }
+
+ public function testOnlyActiveBranchNoParentsActiveOneBelowMinDepth(): void
+ {
+ $this->_setActive('Page 2');
+
+ $this->helper->setOnlyActiveBranch()
+ ->setMinDepth(1)
+ ->setMaxDepth(1)
+ ->setRenderParents(false);
+
+ $expected = $this->getExpectedFileContents('menu/onlyactivebranch_np_bd2.html');
+ $actual = $this->helper->renderMenu();
+
+ $this->assertEquals($expected, $actual);
+ }
+
+ public function testRenderSubMenuShouldOverrideOptions(): void
+ {
+ $this->helper->setOnlyActiveBranch(false)
+ ->setMinDepth(1)
+ ->setMaxDepth(2)
+ ->setRenderParents(true);
+
+ $expected = $this->getExpectedFileContents('menu/onlyactivebranch_noparents.html');
+ $actual = $this->helper->renderSubMenu();
+
+ $this->assertEquals($expected, $actual);
+ }
+
+ public function testOptionMaxDepth(): void
+ {
+ $options = [
+ 'maxDepth' => 1,
+ ];
+
+ $expected = $this->getExpectedFileContents('menu/maxdepth.html');
+ $actual = $this->helper->renderMenu(null, $options);
+
+ $this->assertEquals($expected, $actual);
+ }
+
+ public function testOptionMinDepth(): void
+ {
+ $options = [
+ 'minDepth' => 1,
+ ];
+
+ $expected = $this->getExpectedFileContents('menu/mindepth.html');
+ $actual = $this->helper->renderMenu(null, $options);
+
+ $this->assertEquals($expected, $actual);
+ }
+
+ public function testOptionBothDepts(): void
+ {
+ $options = [
+ 'minDepth' => 1,
+ 'maxDepth' => 2,
+ ];
+
+ $expected = $this->getExpectedFileContents('menu/bothdepts.html');
+ $actual = $this->helper->renderMenu(null, $options);
+
+ $this->assertEquals($expected, $actual);
+ }
+
+ public function testOptionOnlyActiveBranch(): void
+ {
+ $options = [
+ 'onlyActiveBranch' => true,
+ ];
+
+ $expected = $this->getExpectedFileContents('menu/onlyactivebranch.html');
+ $actual = $this->helper->renderMenu(null, $options);
+
+ $this->assertEquals($expected, $actual);
+ }
+
+ public function testOptionOnlyActiveBranchNoParents(): void
+ {
+ $options = [
+ 'onlyActiveBranch' => true,
+ 'renderParents' => false,
+ ];
+
+ $expected = $this->getExpectedFileContents('menu/onlyactivebranch_noparents.html');
+ $actual = $this->helper->renderMenu(null, $options);
+
+ $this->assertEquals($expected, $actual);
+ }
+
+ public function testOptionOnlyActiveBranchAndMinDepth(): void
+ {
+ $options = [
+ 'minDepth' => 1,
+ 'onlyActiveBranch' => true,
+ ];
+
+ $expected = $this->getExpectedFileContents('menu/onlyactivebranch_mindepth.html');
+ $actual = $this->helper->renderMenu(null, $options);
+
+ $this->assertEquals($expected, $actual);
+ }
+
+ public function testOptionOnlyActiveBranchAndMaxDepth(): void
+ {
+ $options = [
+ 'maxDepth' => 2,
+ 'onlyActiveBranch' => true,
+ ];
+
+ $expected = $this->getExpectedFileContents('menu/onlyactivebranch_maxdepth.html');
+ $actual = $this->helper->renderMenu(null, $options);
+
+ $this->assertEquals($expected, $actual);
+ }
+
+ public function testOptionOnlyActiveBranchAndBothDepthsSpecified(): void
+ {
+ $options = [
+ 'minDepth' => 1,
+ 'maxDepth' => 2,
+ 'onlyActiveBranch' => true,
+ ];
+
+ $expected = $this->getExpectedFileContents('menu/onlyactivebranch_bothdepts.html');
+ $actual = $this->helper->renderMenu(null, $options);
+
+ $this->assertEquals($expected, $actual);
+ }
+
+ public function testOptionOnlyActiveBranchNoParentsAndBothDepthsSpecified(): void
+ {
+ $options = [
+ 'minDepth' => 2,
+ 'maxDepth' => 2,
+ 'onlyActiveBranch' => true,
+ 'renderParents' => false,
+ ];
+
+ $expected = $this->getExpectedFileContents('menu/onlyactivebranch_np_bd.html');
+ $actual = $this->helper->renderMenu(null, $options);
+
+ $this->assertEquals($expected, $actual);
+ }
+
+ public function testRenderingWithoutPageClassToLi(): void
+ {
+ $container = new Navigation($this->nav2->toArray());
+ $container->addPage([
+ 'label' => 'Class test',
+ 'uri' => 'test',
+ 'class' => 'foobar',
+ ]);
+
+ $expected = $this->getExpectedFileContents('menu/addclasstolistitem_as_false.html');
+ $actual = $this->helper->renderMenu($container);
+
+ $this->assertEquals(trim($expected), trim($actual));
+ }
+
+ public function testRenderingWithPageClassToLi(): void
+ {
+ $options = [
+ 'addClassToListItem' => true,
+ ];
+
+ $container = new Navigation($this->nav2->toArray());
+ $container->addPage([
+ 'label' => 'Class test',
+ 'uri' => 'test',
+ 'class' => 'foobar',
+ ]);
+
+ $expected = $this->getExpectedFileContents('menu/addclasstolistitem_as_true.html');
+ $actual = $this->helper->renderMenu($container, $options);
+
+ $this->assertEquals(trim($expected), trim($actual));
+ }
+
+ public function testRenderDeepestMenuWithPageClassToLi(): void
+ {
+ $options = [
+ 'addClassToListItem' => true,
+ 'onlyActiveBranch' => true,
+ 'renderParents' => false,
+ ];
+
+ /** @var array[] $pages */
+ $pages = $this->nav2->toArray();
+ $pages[1]['class'] = 'foobar';
+ $container = new Navigation($pages);
+
+ $expected = $this->getExpectedFileContents('menu/onlyactivebranch_addclasstolistitem.html');
+ $actual = $this->helper->renderMenu($container, $options);
+
+ $this->assertEquals(trim($expected), trim($actual));
+ }
+
+ /** @inheritDoc */
+ protected function getExpectedFileContents(string $filename): string
+ {
+ return str_replace("\n", PHP_EOL, parent::getExpectedFileContents($filename));
+ }
+}
diff --git a/test/View/Helper/NavigationTest.php b/test/View/Helper/NavigationTest.php
new file mode 100644
index 00000000..b7881c0d
--- /dev/null
+++ b/test/View/Helper/NavigationTest.php
@@ -0,0 +1,586 @@
+helper = new Navigation();
+ parent::setUp();
+ }
+
+ public function testHelperEntryPointWithoutAnyParams(): void
+ {
+ $returned = $this->helper->__invoke();
+ self::assertEquals($this->helper, $returned);
+ self::assertEquals($this->nav1, $returned->getContainer());
+ }
+
+ public function testHelperEntryPointWithContainerParam(): void
+ {
+ $returned = $this->helper->__invoke($this->nav2);
+ self::assertEquals($this->helper, $returned);
+ self::assertEquals($this->nav2, $returned->getContainer());
+ }
+
+ public function testAcceptAclShouldReturnGracefullyWithUnknownResource(): void
+ {
+ // setup
+ $acl = $this->getAcl();
+ $this->helper->setAcl($acl['acl']);
+ $this->helper->setRole($acl['role']);
+
+ $accepted = $this->helper->accept(
+ new Page\Uri([
+ 'resource' => 'unknownresource',
+ 'privilege' => 'someprivilege',
+ ], false)
+ );
+
+ self::assertEquals($accepted, false);
+ }
+
+ public function testShouldProxyToMenuHelperByDefault(): void
+ {
+ $this->helper->setContainer($this->nav1);
+ $this->helper->setServiceLocator(new ServiceManager());
+
+ // result
+ $expected = $this->getExpectedFileContents('menu/default1.html');
+ $actual = $this->helper->render();
+
+ self::assertEquals($expected, $actual);
+ }
+
+ public function testHasContainer(): void
+ {
+ $oldContainer = $this->helper->getContainer();
+ $this->helper->setContainer(null);
+ self::assertFalse($this->helper->hasContainer());
+ $this->helper->setContainer($oldContainer);
+ }
+
+ public function testInjectingContainer(): void
+ {
+ // setup
+ $this->helper->setContainer($this->nav2);
+ $this->helper->setServiceLocator(new ServiceManager());
+ $expected = [
+ 'menu' => $this->getExpectedFileContents('menu/default2.html'),
+ 'breadcrumbs' => $this->getExpectedFileContents('bc/default.html'),
+ ];
+ $actual = [];
+
+ // result
+ $actual['menu'] = $this->helper->render();
+ $this->helper->setContainer($this->nav1);
+ $actual['breadcrumbs'] = $this->helper->breadcrumbs()->render();
+
+ self::assertEquals($expected, $actual);
+ }
+
+ public function testDisablingContainerInjection(): void
+ {
+ // setup
+ $this->helper->setServiceLocator(new ServiceManager());
+ $this->helper->setInjectContainer(false);
+ $this->helper->menu()->setContainer(null);
+ $this->helper->breadcrumbs()->setContainer(null);
+ $this->helper->setContainer($this->nav2);
+
+ // result
+ $expected = [
+ 'menu' => '',
+ 'breadcrumbs' => '',
+ ];
+ $actual = [
+ 'menu' => $this->helper->render(),
+ 'breadcrumbs' => $this->helper->breadcrumbs()->render(),
+ ];
+
+ self::assertEquals($expected, $actual);
+ }
+
+ public function testMultipleNavigationsAndOneMenuDisplayedTwoTimes(): void
+ {
+ $this->helper->setServiceLocator(new ServiceManager());
+ $expected = $this->helper->setContainer($this->nav1)->menu()->getContainer();
+ $this->helper->setContainer($this->nav2)->menu()->getContainer();
+ $actual = $this->helper->setContainer($this->nav1)->menu()->getContainer();
+
+ self::assertEquals($expected, $actual);
+ }
+
+ public function testServiceManagerIsUsedToRetrieveContainer(): void
+ {
+ $container = new Container();
+ $serviceManager = new ServiceManager();
+ $serviceManager->setService('navigation', $container);
+
+ new View\HelperPluginManager($serviceManager);
+
+ $this->helper->setServiceLocator($serviceManager);
+ $this->helper->setContainer('navigation');
+
+ $expected = $this->helper->getContainer();
+ $actual = $container;
+ self::assertEquals($expected, $actual);
+ }
+
+ public function testInjectingAcl(): void
+ {
+ // setup
+ $acl = $this->getAcl();
+ $this->helper->setAcl($acl['acl']);
+ $this->helper->setRole($acl['role']);
+ $this->helper->setServiceLocator(new ServiceManager());
+
+ $expected = $this->getExpectedFileContents('menu/acl.html');
+ $actual = $this->helper->render();
+
+ self::assertEquals($expected, $actual);
+ }
+
+ public function testDisablingAclInjection(): void
+ {
+ // setup
+ $acl = $this->getAcl();
+ $this->helper->setAcl($acl['acl']);
+ $this->helper->setRole($acl['role']);
+ $this->helper->setInjectAcl(false);
+ $this->helper->setServiceLocator(new ServiceManager());
+
+ $expected = $this->getExpectedFileContents('menu/default1.html');
+ $actual = $this->helper->render();
+
+ self::assertEquals($expected, $actual);
+ }
+
+ public function testInjectingTranslator(): void
+ {
+ if (! extension_loaded('intl')) {
+ self::markTestSkipped('ext/intl not enabled');
+ }
+
+ $this->helper->setTranslator($this->getTranslator());
+ $this->helper->setServiceLocator(new ServiceManager());
+
+ $expected = $this->getExpectedFileContents('menu/translated.html');
+ $actual = $this->helper->render();
+
+ self::assertEquals($expected, $actual);
+ }
+
+ public function testDisablingTranslatorInjection(): void
+ {
+ $this->helper->setTranslator($this->getTranslator());
+ $this->helper->setInjectTranslator(false);
+ $this->helper->setServiceLocator(new ServiceManager());
+
+ $expected = $this->getExpectedFileContents('menu/default1.html');
+ $actual = $this->helper->render();
+
+ self::assertEquals($expected, $actual);
+ }
+
+ public function testTranslatorMethods(): void
+ {
+ $translatorMock = $this->createMock(Translator::class);
+ $this->helper->setTranslator($translatorMock, 'foo');
+
+ self::assertEquals($translatorMock, $this->helper->getTranslator());
+ self::assertEquals('foo', $this->helper->getTranslatorTextDomain());
+ self::assertTrue($this->helper->hasTranslator());
+ self::assertTrue($this->helper->isTranslatorEnabled());
+
+ $this->helper->setTranslatorEnabled(false);
+ self::assertFalse($this->helper->isTranslatorEnabled());
+ }
+
+ public function testSpecifyingDefaultProxy(): void
+ {
+ $expected = [
+ 'breadcrumbs' => $this->getExpectedFileContents('bc/default.html'),
+ 'menu' => $this->getExpectedFileContents('menu/default1.html'),
+ ];
+ $actual = [];
+
+ // result
+ $this->helper->setServiceLocator(new ServiceManager());
+ $this->helper->setDefaultProxy('breadcrumbs');
+ $actual['breadcrumbs'] = $this->helper->render($this->nav1);
+ $this->helper->setDefaultProxy('menu');
+ $actual['menu'] = $this->helper->render($this->nav1);
+
+ self::assertEquals($expected, $actual);
+ }
+
+ public function testGetAclReturnsNullIfNoAclInstance(): void
+ {
+ self::assertNull($this->helper->getAcl());
+ }
+
+ public function testGetAclReturnsAclInstanceSetWithSetAcl(): void
+ {
+ $acl = new Acl\Acl();
+ $this->helper->setAcl($acl);
+ self::assertEquals($acl, $this->helper->getAcl());
+ }
+
+ public function testGetAclReturnsAclInstanceSetWithSetDefaultAcl(): void
+ {
+ $acl = new Acl\Acl();
+ AbstractHelper::setDefaultAcl($acl);
+ $actual = $this->helper->getAcl();
+ AbstractHelper::setDefaultAcl(null);
+ self::assertEquals($acl, $actual);
+ }
+
+ public function testSetDefaultAclAcceptsNull(): void
+ {
+ $acl = new Acl\Acl();
+ AbstractHelper::setDefaultAcl($acl);
+ AbstractHelper::setDefaultAcl(null);
+ self::assertNull($this->helper->getAcl());
+ }
+
+ public function testSetDefaultAclAcceptsNoParam(): void
+ {
+ $acl = new Acl\Acl();
+ AbstractHelper::setDefaultAcl($acl);
+ AbstractHelper::setDefaultAcl();
+ self::assertNull($this->helper->getAcl());
+ }
+
+ public function testSetRoleAcceptsString(): void
+ {
+ $this->helper->setRole('member');
+ self::assertEquals('member', $this->helper->getRole());
+ }
+
+ public function testSetRoleAcceptsRoleInterface(): void
+ {
+ $role = new Role\GenericRole('member');
+ $this->helper->setRole($role);
+ self::assertEquals($role, $this->helper->getRole());
+ }
+
+ public function testSetRoleAcceptsNull(): void
+ {
+ $this->helper->setRole('member')->setRole(null);
+ self::assertNull($this->helper->getRole());
+ }
+
+ public function testSetRoleAcceptsNoParam(): void
+ {
+ $this->helper->setRole('member')->setRole();
+ self::assertNull($this->helper->getRole());
+ }
+
+ public function testSetRoleThrowsExceptionWhenGivenAnInt(): void
+ {
+ try {
+ $this->helper->setRole(1337);
+ self::fail('An invalid argument was given, but a '
+ . 'Laminas\View\Exception\InvalidArgumentException was not thrown');
+ } catch (View\Exception\ExceptionInterface $e) {
+ self::assertStringContainsString('$role must be a string', $e->getMessage());
+ }
+ }
+
+ public function testSetRoleThrowsExceptionWhenGivenAnArbitraryObject(): void
+ {
+ try {
+ $this->helper->setRole(new stdClass());
+ self::fail('An invalid argument was given, but a '
+ . 'Laminas\View\Exception\InvalidArgumentException was not thrown');
+ } catch (View\Exception\ExceptionInterface $e) {
+ self::assertStringContainsString('$role must be a string', $e->getMessage());
+ }
+ }
+
+ public function testSetDefaultRoleAcceptsString(): void
+ {
+ $expected = 'member';
+ AbstractHelper::setDefaultRole($expected);
+ $actual = $this->helper->getRole();
+ AbstractHelper::setDefaultRole(null);
+ self::assertEquals($expected, $actual);
+ }
+
+ public function testSetDefaultRoleAcceptsRoleInterface(): void
+ {
+ $expected = new Role\GenericRole('member');
+ AbstractHelper::setDefaultRole($expected);
+ $actual = $this->helper->getRole();
+ AbstractHelper::setDefaultRole(null);
+ self::assertEquals($expected, $actual);
+ }
+
+ public function testSetDefaultRoleAcceptsNull(): void
+ {
+ AbstractHelper::setDefaultRole(null);
+ self::assertNull($this->helper->getRole());
+ }
+
+ public function testSetDefaultRoleAcceptsNoParam(): void
+ {
+ AbstractHelper::setDefaultRole();
+ self::assertNull($this->helper->getRole());
+ }
+
+ public function testSetDefaultRoleThrowsExceptionWhenGivenAnInt(): void
+ {
+ try {
+ AbstractHelper::setDefaultRole(1337);
+ self::fail('An invalid argument was given, but a '
+ . 'Laminas\View\Exception\InvalidArgumentException was not thrown');
+ } catch (View\Exception\ExceptionInterface $e) {
+ self::assertStringContainsString('$role must be', $e->getMessage());
+ }
+ }
+
+ public function testSetDefaultRoleThrowsExceptionWhenGivenAnArbitraryObject(): void
+ {
+ try {
+ AbstractHelper::setDefaultRole(new stdClass());
+ self::fail('An invalid argument was given, but a '
+ . 'Laminas\View\Exception\InvalidArgumentException was not thrown');
+ } catch (View\Exception\ExceptionInterface $e) {
+ self::assertStringContainsString('$role must be', $e->getMessage());
+ }
+ }
+
+ public function testMagicToStringShouldNotThrowException(): void
+ {
+ set_error_handler(function (int $code, string $message) {
+ $this->errorHandlerMessage = $message;
+ });
+
+ $this->helper->menu()->setPartial([1337]);
+ $this->helper->__toString();
+ restore_error_handler();
+
+ self::assertStringContainsString('array must contain', $this->errorHandlerMessage);
+ }
+
+ public function testPageIdShouldBeNormalized(): void
+ {
+ $nl = PHP_EOL;
+
+ $container = new Container([
+ [
+ 'label' => 'Page 1',
+ 'id' => 'p1',
+ 'uri' => 'p1',
+ ],
+ [
+ 'label' => 'Page 2',
+ 'id' => 'p2',
+ 'uri' => 'p2',
+ ],
+ ]);
+
+ $expected = '
\ No newline at end of file
diff --git a/test/View/Helper/_files/expected/menu/acl_role_interface.html b/test/View/Helper/_files/expected/menu/acl_role_interface.html
new file mode 100644
index 00000000..9d07eaa3
--- /dev/null
+++ b/test/View/Helper/_files/expected/menu/acl_role_interface.html
@@ -0,0 +1,62 @@
+
\ No newline at end of file
diff --git a/test/View/Helper/_files/expected/menu/acl_string.html b/test/View/Helper/_files/expected/menu/acl_string.html
new file mode 100644
index 00000000..9d07eaa3
--- /dev/null
+++ b/test/View/Helper/_files/expected/menu/acl_string.html
@@ -0,0 +1,62 @@
+
\ No newline at end of file
diff --git a/test/View/Helper/_files/expected/menu/addclasstolistitem_as_false.html b/test/View/Helper/_files/expected/menu/addclasstolistitem_as_false.html
new file mode 100644
index 00000000..e86b0fae
--- /dev/null
+++ b/test/View/Helper/_files/expected/menu/addclasstolistitem_as_false.html
@@ -0,0 +1,14 @@
+
\ No newline at end of file
diff --git a/test/View/Helper/_files/expected/menu/css.html b/test/View/Helper/_files/expected/menu/css.html
new file mode 100644
index 00000000..8de4109c
--- /dev/null
+++ b/test/View/Helper/_files/expected/menu/css.html
@@ -0,0 +1,11 @@
+
\ No newline at end of file
diff --git a/test/View/Helper/_files/expected/menu/css2.html b/test/View/Helper/_files/expected/menu/css2.html
new file mode 100644
index 00000000..f8cc4c02
--- /dev/null
+++ b/test/View/Helper/_files/expected/menu/css2.html
@@ -0,0 +1,11 @@
+
\ No newline at end of file
diff --git a/test/View/Helper/_files/expected/menu/default2.html b/test/View/Helper/_files/expected/menu/default2.html
new file mode 100644
index 00000000..183f5f2a
--- /dev/null
+++ b/test/View/Helper/_files/expected/menu/default2.html
@@ -0,0 +1,11 @@
+
\ No newline at end of file
diff --git a/test/View/Helper/_files/expected/menu/escapelabels_as_false.html b/test/View/Helper/_files/expected/menu/escapelabels_as_false.html
new file mode 100644
index 00000000..4f40aea6
--- /dev/null
+++ b/test/View/Helper/_files/expected/menu/escapelabels_as_false.html
@@ -0,0 +1,14 @@
+
\ No newline at end of file
diff --git a/test/View/Helper/_files/expected/menu/escapelabels_as_true.html b/test/View/Helper/_files/expected/menu/escapelabels_as_true.html
new file mode 100644
index 00000000..d7b56b10
--- /dev/null
+++ b/test/View/Helper/_files/expected/menu/escapelabels_as_true.html
@@ -0,0 +1,14 @@
+
\ No newline at end of file
diff --git a/test/View/Helper/_files/expected/menu/indent4.html b/test/View/Helper/_files/expected/menu/indent4.html
new file mode 100644
index 00000000..553e0731
--- /dev/null
+++ b/test/View/Helper/_files/expected/menu/indent4.html
@@ -0,0 +1,81 @@
+
\ No newline at end of file
diff --git a/test/View/Helper/_files/expected/menu/indent8.html b/test/View/Helper/_files/expected/menu/indent8.html
new file mode 100644
index 00000000..1a75d7ce
--- /dev/null
+++ b/test/View/Helper/_files/expected/menu/indent8.html
@@ -0,0 +1,81 @@
+
\ No newline at end of file
diff --git a/test/View/Helper/_files/expected/menu/maxdepth.html b/test/View/Helper/_files/expected/menu/maxdepth.html
new file mode 100644
index 00000000..1731bdac
--- /dev/null
+++ b/test/View/Helper/_files/expected/menu/maxdepth.html
@@ -0,0 +1,44 @@
+
\ No newline at end of file
diff --git a/test/View/Helper/_files/expected/menu/mindepth.html b/test/View/Helper/_files/expected/menu/mindepth.html
new file mode 100644
index 00000000..94cf81ef
--- /dev/null
+++ b/test/View/Helper/_files/expected/menu/mindepth.html
@@ -0,0 +1,60 @@
+
\ No newline at end of file
diff --git a/test/View/Helper/_files/expected/menu/onlyactivebranch.html b/test/View/Helper/_files/expected/menu/onlyactivebranch.html
new file mode 100644
index 00000000..49d98838
--- /dev/null
+++ b/test/View/Helper/_files/expected/menu/onlyactivebranch.html
@@ -0,0 +1,31 @@
+
\ No newline at end of file
diff --git a/test/View/Helper/_files/expected/menu/onlyactivebranch_addclasstolistitem.html b/test/View/Helper/_files/expected/menu/onlyactivebranch_addclasstolistitem.html
new file mode 100644
index 00000000..9514e408
--- /dev/null
+++ b/test/View/Helper/_files/expected/menu/onlyactivebranch_addclasstolistitem.html
@@ -0,0 +1,11 @@
+
\ No newline at end of file
diff --git a/test/View/Helper/_files/expected/menu/onlyactivebranch_maxdepth.html b/test/View/Helper/_files/expected/menu/onlyactivebranch_maxdepth.html
new file mode 100644
index 00000000..0e181df7
--- /dev/null
+++ b/test/View/Helper/_files/expected/menu/onlyactivebranch_maxdepth.html
@@ -0,0 +1,26 @@
+
\ No newline at end of file
diff --git a/test/View/Helper/_files/expected/menu/onlyactivebranch_mindepth.html b/test/View/Helper/_files/expected/menu/onlyactivebranch_mindepth.html
new file mode 100644
index 00000000..56c86efe
--- /dev/null
+++ b/test/View/Helper/_files/expected/menu/onlyactivebranch_mindepth.html
@@ -0,0 +1,26 @@
+
\ No newline at end of file
diff --git a/test/View/Helper/_files/expected/menu/onlyactivebranch_noparents.html b/test/View/Helper/_files/expected/menu/onlyactivebranch_noparents.html
new file mode 100644
index 00000000..b4eda0b1
--- /dev/null
+++ b/test/View/Helper/_files/expected/menu/onlyactivebranch_noparents.html
@@ -0,0 +1,8 @@
+
\ No newline at end of file
diff --git a/test/View/Helper/_files/expected/menu/onlyactivebranch_np_bd.html b/test/View/Helper/_files/expected/menu/onlyactivebranch_np_bd.html
new file mode 100644
index 00000000..4e6690b4
--- /dev/null
+++ b/test/View/Helper/_files/expected/menu/onlyactivebranch_np_bd.html
@@ -0,0 +1,8 @@
+
\ No newline at end of file
diff --git a/test/View/Helper/_files/expected/menu/onlyactivebranch_np_bd2.html b/test/View/Helper/_files/expected/menu/onlyactivebranch_np_bd2.html
new file mode 100644
index 00000000..a6ba4c07
--- /dev/null
+++ b/test/View/Helper/_files/expected/menu/onlyactivebranch_np_bd2.html
@@ -0,0 +1,11 @@
+
\ No newline at end of file
diff --git a/test/View/Helper/_files/expected/menu/partial.html b/test/View/Helper/_files/expected/menu/partial.html
new file mode 100644
index 00000000..356c5a19
--- /dev/null
+++ b/test/View/Helper/_files/expected/menu/partial.html
@@ -0,0 +1,2 @@
+Is a container: yes
+Pages: Home, Page 1, Page 2, Page 3, Zym
\ No newline at end of file
diff --git a/test/View/Helper/_files/expected/menu/partial_with_params.html b/test/View/Helper/_files/expected/menu/partial_with_params.html
new file mode 100644
index 00000000..9edc0b02
--- /dev/null
+++ b/test/View/Helper/_files/expected/menu/partial_with_params.html
@@ -0,0 +1,3 @@
+test value
+Is a container: yes
+Pages: Home, Page 1, Page 2, Page 3, Zym
\ No newline at end of file
diff --git a/test/View/Helper/_files/expected/menu/textdomain.html b/test/View/Helper/_files/expected/menu/textdomain.html
new file mode 100644
index 00000000..1ef39baa
--- /dev/null
+++ b/test/View/Helper/_files/expected/menu/textdomain.html
@@ -0,0 +1,48 @@
+