Routování: Více parametrů ve filtru

Někdy nastává situace, kdy je potřeba dostat do filtru routy více parametrů, ale na to neexistuje nativní implementace. Jednu hotovou Vám tady teď představím.

Problém

Jak dostanu do filtru jazyk, například na překlad stránky? Chci adresy takto:

• /cs/nejaky-clanek
• /en/some-article

use Nette\Application\Route;


$router[] = new Route('[!<lang>]/[!<article [a-z-]+>]', array(
    'presenter' => 'Article',
    'action' => 'default',
    'article' => array(
        Route::FILTER_IN => callback('ArticleModel::slugToId'),
        Route::FILTER_OUT => callback('ArticleModel::idToSlug')
    ),
    'lang' => 'cs',
));

ArticleModel

static function slugToId($slug)
{
    $translator = Nette\Environment::getService('ITranslator');
    // a jaký jazyk? vždyť ten je v adrese!
    // ale na proměnnou $lang z routeru zde nevidím!

    // a máme problém ...

    return $id;
}

V tomto okamžiku neznám jazyk, což je problém, protože nevím, jestli mám article překládat z „nejaky-clanek“, nebo „some-article“. Někteří by mohli namítat, že můžu prohledat i anglické i české názvy, ale to není moc hezké řešení.

A to je jenom velice jednoduchý příklad. Všechno může být v některých situacích mnohem komplikovanější.

Řešení

Myslím, že výsledný kód řekne více než tisíc slov :)

use Nette\Application\PresenterRequest;



class FilterRoute extends Nette\Application\Route
{
    const WAY_IN = 'in';
    const WAY_OUT = 'out';
        // překlad a vyhledání v databázi

    /** @var array */
    private $filters = array();



    /**
     * @param Nette\Web\IHttpRequest $httpRequest
     * @return Nette\Application\PresenterRequest|NULL
     */
    public function match(Nette\Web\IHttpRequest $httpRequest)
    {
        $appRequest = parent::match($httpRequest);
        if (!$appRequest) {
            return $appRequest;
        }

        if ($params = $this->doFilterParams($this->getRequestParams($appRequest), $appRequest, self::WAY_IN)) {
            return $this->setRequestParams($appRequest, $params);
        }

        return NULL;
    }



    /**
     * @param Nette\Application\PresenterRequest $appRequest
     * @param Nette\Web\Uri $refUri
     * @return string
     */
    public function constructUrl(PresenterRequest $appRequest, Nette\Web\Uri $refUri)
    {
        if ($params = $this->doFilterParams($this->getRequestParams($appRequest), $appRequest, self::WAY_OUT)) {
            $appRequest = $this->setRequestParams($appRequest, $params);
            return parent::constructUrl($appRequest, $refUri);
        }

        return NULL;
    }



    /**
     * @param string $param
     * @param callable $in
     * @param callable $out
     * @return SmarterRoute
     */
    public function addFilter($param, $in, $out = NULL)
    {
        $this->filters[$param] = array(
                self::WAY_IN => callback($in),
                self::WAY_OUT => $out ? callback($out) : NULL
            );

        return $this;
    }



    /**
     * @return array
     */
    public function getFilters()
    {
        return $this->filters;
    }



    /**
     * @param Nette\Application\PresenterRequest $appRequest
     * @return array
     */
    private function getRequestParams(PresenterRequest $appRequest)
    {
        $params = $appRequest->getParams();
        $metadata = $this->getDefaults();

        $presenter = $appRequest->getPresenterName();
        $params[self::PRESENTER_KEY] = $presenter;

        if (isset($metadata[self::MODULE_KEY])) { // try split into module and [submodule:]presenter parts
            $module = $metadata[self::MODULE_KEY];
            if (isset($module['fixity']) && strncasecmp($presenter, $module[self::VALUE] . ':', strlen($module[self::VALUE]) + 1) === 0) {
                $a = strlen($module[self::VALUE]);
            } else {
                $a = strrpos($presenter, ':');
            }

            if ($a === FALSE) {
                $params[self::MODULE_KEY] = '';
            } else {
                $params[self::MODULE_KEY] = substr($presenter, 0, $a);
                $params[self::PRESENTER_KEY] = substr($presenter, $a + 1);
            }
        }

        return $params;
    }



    /**
     * @param Nette\Application\PresenterRequest $appRequest
     * @param array $params
     * @return Nette\Application\PresenterRequest
     */
    private function setRequestParams(PresenterRequest $appRequest, array $params)
    {
        $metadata = $this->getDefaults();

        if (!isset($params[self::PRESENTER_KEY])) {
            throw new \InvalidStateException('Missing presenter in route definition.');
        }
        if (isset($metadata[self::MODULE_KEY])) {
            if (!isset($params[self::MODULE_KEY])) {
                throw new \InvalidStateException('Missing module in route definition.');
            }
            $presenter = $params[self::MODULE_KEY] . ':' . $params[self::PRESENTER_KEY];
            unset($params[self::MODULE_KEY], $params[self::PRESENTER_KEY]);

        } else {
            $presenter = $params[self::PRESENTER_KEY];
            unset($params[self::PRESENTER_KEY]);
        }

        $appRequest->setPresenterName($presenter);
        $appRequest->setParams($params);

        return $appRequest;
    }



    /**
     * @param array $params
     * @param Nette\Application\PresenterRequest $request
     * @param string $way
     */
    private function doFilterParams($params, PresenterRequest $request, $way)
    {
        // tady mám k dispozici všechny parametry
        foreach ($this->getFilters() as $param => $filters) {
            if (!isset($params[$param]) || !isset($filters[$way])) {
                continue; // param not found
            }

            $params[$param] = call_user_func($filters[$way], (string) $params[$param], $request);
            if ($params[$param] === NULL) {
                return NULL; // rejected by filter
            }
        }

        return $params;
    }

}

Použití

$router[] = $route = new FilterRoute('<presenter>/<action>', array(...));
$route->addFilter('id', 'PageModule::uriToId', 'PageModule::idToUrl');

upravená metoda v ArticleModel

static function slugToId($slug, Nette\Application\PresenterRequest $request)
{
        $translator = Nette\Environment::getService('ITranslator');
        $lang = $request->params['lang']; // zkratka na $request->getParams()

        // překlad a vyhledání v databázi

        return $id;
}

Fígl je v tom, že Router zpracuje adresu normálně a filtračním funkcím předává parametr i výsledný PresenterRequest a následně vracenými hodnotami přepíše původní.

---

Login to submit a comment