BreadcrumbsBuilder.php

<?php

/*
 * This file is part of the BreadcrumbsBundle.
 *
 * (c) Yonel Ceruto <yonelceruto@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Yceruto\Bundle\BreadcrumbsBundle;

use Symfony\Bundle\FrameworkBundle\Routing\Router;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\RequestStack;
use Symfony\Component\Routing\Matcher\TraceableUrlMatcher;

/**
 * This builder works in 2 modes:
 *
 *  * 2.3 compatibility mode where you must call setRequest whenever the Request changes.
 *  * 2.4+ mode where you must pass a RequestStack instance in the constructor.
 *
 * @author Yonel Ceruto <yonelceruto@gmail.com>
 */
class BreadcrumbsBuilder
{
    /**
     * @var RequestStack
     */
    private $requestStack;

    /**
     * @var Request
     */
    private $request;

    /**
     * @var Router
     */
    private $router;

    /**
     * @var TraceableUrlMatcher
     */
    private $matcher;

    public function __construct(Router $router, RequestStack $requestStack = null)
    {
        $this->router = $router;
        $this->requestStack = $requestStack;
    }

    /**
     * BC with SF 2.3
     *
     * @param Request|null $request
     */
    public function setRequest(Request $request = null)
    {
        $this->request = $request;
    }

    /**
     * Create a empty breadcrumb
     *
     * @return Breadcrumbs
     */
    public function create()
    {
        return new Breadcrumbs();
    }

    /**
     * Create a breadcrumb through current request path
     *
     * @return Breadcrumbs
     */
    public function createFromRequest()
    {
        if (empty($this->matcher)) {
            $this->matcher = new TraceableUrlMatcher($this->router->getRouteCollection(), $this->router->getContext());
        }

        $breadcrumbs = new Breadcrumbs();

        $parent = null;
        $paths = $this->getBreadcrumbsPaths();
        foreach ($paths as $path) {
            if ($node = $this->createBreadcrumbsNode($path, $parent)) {
                $breadcrumbs->addNode($node);
                $parent = $path;
            }
        }

        return $breadcrumbs;
    }

    /**
     * Get all breadcrumbs paths from current request path
     *
     * @return array of string
     */
    private function getBreadcrumbsPaths()
    {
        $parts = array();
        $pathInfo = trim($this->getRequest()->getPathInfo(), '/');

        if ($pathInfo) {
            $parts = explode('/', $pathInfo);
        }

        array_unshift($parts, '/');

        $path = '';
        $paths = array();
        foreach ($parts as $part) {
            $path .= $part;
            $paths[] = $path;

            if ('/' !== $part) {
                $path .= '/';
                $paths[] = $path;
            }
        }

        return $paths;
    }

    /**
     * Create a breadcrumbs node from path
     *
     * @param string $path
     * @param string $parent
     *
     * @return BreadcrumbsNode|bool
     */
    private function createBreadcrumbsNode($path, $parent)
    {
        // use $baseUrl for no prod environments e.g dev 'app_dev.php'
        $baseUrl = $this->getRequest()->getBaseUrl();

        $traces = $this->matcher->getTraces($path);
        foreach ($traces as $trace) {
            if (TraceableUrlMatcher::ROUTE_MATCHES == $trace['level']) {
                $label = $this->getLabel($path, $parent, $trace['name']);

                $node = new BreadcrumbsNode();
                $node->setLabel($label);
                $node->setPath($baseUrl.$path);

                return $node;
            }
        }

        return false;
    }

    private function getRequest()
    {
        return $this->requestStack ? $this->requestStack->getCurrentRequest() : $this->request;
    }

    /**
     * Get label
     *
     * @param $path
     * @param $parent
     * @param $name
     *
     * @return string
     */
    private function getLabel($path, $parent, $name)
    {
        $route = $this->router->getRouteCollection()->get($name);

        // get label through settings
        $label = $route->getDefault('breadcrumbs_label');

        if (empty($label)) {
            // get label through path
            $compiledRoute = $route->compile();
            $vars = $compiledRoute->getVariables();

            if (empty($vars)) {
                $label = substr($path, strlen($parent));
            } elseif (preg_match($compiledRoute->getRegex(), $path, $match)) {
                $label = $match[end($vars)];
            }
            $label = trim(preg_replace('[\W|_]', ' ', $label));

            if (is_numeric($label)) {
                $label = null;
            }
        }

        if (empty($label)) {
            // get label through route name
            $label = 'breadcrumbs.'.$name;

            return $label;
        }

        return $label;
    }
}