Skip to content
This repository has been archived by the owner on Jan 31, 2020. It is now read-only.

Feature for passing parameters into navigation-partial. #8

Closed
wants to merge 1 commit into from
Closed

Feature for passing parameters into navigation-partial. #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
257 changes: 152 additions & 105 deletions src/Helper/Navigation/Breadcrumbs.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
<?php

/**
* Zend Framework (http://framework.zend.com/)
* Zend Framework (http://framework.zend.com/).
*
* @link http://github.com/zendframework/zf2 for the canonical source repository
*
* @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/

namespace Zend\View\Helper\Navigation;

use Zend\Navigation\AbstractContainer;
Expand All @@ -15,42 +16,43 @@
use Zend\View\Exception;

/**
* Helper for printing breadcrumbs
* Helper for printing breadcrumbs.
*/
class Breadcrumbs extends AbstractHelper
{
/**
* Whether last page in breadcrumb should be hyperlinked
* Whether last page in breadcrumb should be hyperlinked.
*
* @var bool
*/
protected $linkLast = false;

/**
* The minimum depth a page must have to be included when rendering
* The minimum depth a page must have to be included when rendering.
*
* @var int
*/
protected $minDepth = 1;

/**
* Partial view script to use for rendering menu
* Partial view script to use for rendering menu.
*
* @var string|array
*/
protected $partial;

/**
* Breadcrumbs separator string
* Breadcrumbs separator string.
*
* @var string
*/
protected $separator = ' &gt; ';

/**
* Helper entry point
* Helper entry point.
*
* @param string|AbstractContainer $container container to operate on
*
* @param string|AbstractContainer $container container to operate on
* @return Breadcrumbs
*/
public function __invoke($container = null)
Expand All @@ -63,12 +65,13 @@ public function __invoke($container = null)
}

/**
* Renders helper
* Renders helper.
*
* Implements {@link HelperInterface::render()}.
*
* @param AbstractContainer $container [optional] container to render. Default is
* to render the container registered in the helper.
* @param AbstractContainer $container [optional] container to render. Default is
* to render the container registered in the helper.
*
* @return string
*/
public function render($container = null)
Expand All @@ -83,10 +86,11 @@ public function render($container = null)

/**
* Renders breadcrumbs by chaining 'a' elements with the separator
* registered in the helper
* registered in the helper.
*
* @param AbstractContainer $container [optional] container to render. Default is
* to render the container registered in the helper.
*
* @param AbstractContainer $container [optional] container to render. Default is
* to render the container registered in the helper.
* @return string
*/
public function renderStraight($container = null)
Expand Down Expand Up @@ -119,8 +123,8 @@ public function renderStraight($container = null)
if ($parent instanceof AbstractPage) {
// prepend crumb to html
$html = $this->htmlify($parent)
. $this->getSeparator()
. $html;
.$this->getSeparator()
.$html;
}

if ($parent === $container) {
Expand All @@ -131,103 +135,82 @@ public function renderStraight($container = null)
$active = $parent;
}

return strlen($html) ? $this->getIndent() . $html : '';
return strlen($html) ? $this->getIndent().$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,
* so in the script it will be available in <code>$this->container</code>.
*
* @param AbstractContainer $container [optional] container to pass to view script.
* Default is to use the container registered
* in the helper.
* @param string|array $partial [optional] partial view script to use.
* Default is to use the partial registered
* in the helper. If an array is given, it
* is expected to contain two values; the
* partial view script to use, and the module
* where the script can be found.
* @throws Exception\RuntimeException if no partial provided
* 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.
* <code>echo 'Number of pages: ', count($this->container);</code>.
*
* @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, it is expected to contain two
* values; the partial view script to use,
* and the module where the script can be
* found.
*
* @return string
*
* @throws Exception\RuntimeException if no partial provided
* @throws Exception\InvalidArgumentException if partial is invalid array
* @return string helper output
*/
public function renderPartial($container = null, $partial = null)
{
$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'
);
}

// put breadcrumb pages in model
$model = [
'pages' => [],
'separator' => $this->getSeparator()
];
$active = $this->findActive($container);
if ($active) {
$active = $active['page'];
$model['pages'][] = $active;
while ($parent = $active->getParent()) {
if ($parent instanceof AbstractPage) {
$model['pages'][] = $parent;
} else {
break;
}

if ($parent === $container) {
// break if at the root of the given container
break;
}

$active = $parent;
}
$model['pages'] = array_reverse($model['pages']);
}

/** @var \Zend\View\Helper\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 two values: partial view '
. 'script and module where script can be found'
);
}

return $partialHelper($partial[0], $model);
}

return $partialHelper($partial, $model);
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.
* <code>echo 'Number of pages: ', count($this->container);</code>.
*
* 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, it is expected to contain two
* values; the partial view script to use,
* and the module where the script can be
* found.
*
* @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);
}

/**
* Sets whether last page in breadcrumbs should be hyperlinked
* Sets whether last page in breadcrumbs should be hyperlinked.
*
* @param bool $linkLast whether last page should be hyperlinked
*
* @param bool $linkLast whether last page should be hyperlinked
* @return Breadcrumbs
*/
public function setLinkLast($linkLast)
{
$this->linkLast = (bool) $linkLast;

return $this;
}

/**
* Returns whether last page in breadcrumbs should be hyperlinked
* Returns whether last page in breadcrumbs should be hyperlinked.
*
* @return bool
*/
Expand All @@ -237,13 +220,14 @@ public function getLinkLast()
}

/**
* Sets which partial view script to use for rendering menu
* Sets which partial view script to use for rendering menu.
*
* @param string|array $partial partial view script or null. If an array is
* given, it is expected to contain two
* values; the partial view script to use,
* and the module where the script can be
* found.
*
* @param string|array $partial partial view script or null. If an array is
* given, it is expected to contain two
* values; the partial view script to use,
* and the module where the script can be
* found.
* @return Breadcrumbs
*/
public function setPartial($partial)
Expand All @@ -256,7 +240,7 @@ public function setPartial($partial)
}

/**
* Returns partial view script to use for rendering menu
* Returns partial view script to use for rendering menu.
*
* @return string|array|null
*/
Expand All @@ -266,9 +250,10 @@ public function getPartial()
}

/**
* Sets breadcrumb separator
* Sets breadcrumb separator.
*
* @param string $separator separator string
*
* @param string $separator separator string
* @return Breadcrumbs
*/
public function setSeparator($separator)
Expand All @@ -281,12 +266,74 @@ public function setSeparator($separator)
}

/**
* Returns breadcrumb separator
* Returns breadcrumb separator.
*
* @return string breadcrumb separator
* @return string breadcrumb separator
*/
public function getSeparator()
{
return $this->separator;
}

/**
* Render a partial with the given "model".
*
* @param array $params
* @param null|AbstractContainer $container
* @param null|string|array $partial
*
* @return 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 breadcrumbs: No partial view script provided'
);
}
$model = array_merge($params, ['pages' => []], ['separator' => $this->getSeparator()]);
$active = $this->findActive($container);
if ($active) {
$active = $active['page'];
$model['pages'][] = $active;
while ($parent = $active->getParent()) {
if ($parent instanceof AbstractPage) {
$model['pages'][] = $parent;
} else {
break;
}
if ($parent === $container) {
// break if at the root of the given container
break;
}
$active = $parent;
}
$model['pages'] = array_reverse($model['pages']);
}
/** @var \Zend\View\Helper\Partial $partialHelper */
$partialHelper = $this->view->plugin('partial');
if (is_array($partial)) {
if (count($partial) != 2) {
throw new Exception\InvalidArgumentException(
'Unable to render breadcrumbs: A view partial supplied as '
.'an array must contain two values: partial view '
.'script and module where script can be found'
);
}

return $partialHelper($partial[0], $model);
}

return $partialHelper($partial, $model);
}
}
Loading