Pkg_router

Description

Stock Joomla! routing is primitive at best. Moyo basically took the Symfony 2 router and ported it to Joomla using the Nooku / Koowa framework.

Pkg_router was created by Moyo Web Architects and is currently used in several major projects.

Requirements

Joomla 3.X . Untested in Joomla 2.5.
Koowa 0.9 or 1.0 (as yet, Koowa 2 is not supported)
PHP 5.3.10 or better

Installation

Installation is done through composer. In your composer.json file, you should add the following lines to the repositories section:

for this repository;

{
    "name": "moyo/router",
    "type": "vcs",
    "url": "https://github.com/kedweber/pkg_router.git"
}

or from the official repository;

{
    "name": "moyo/router",
    "type": "vcs",
    "url": "https://github.com/moyoweb/pkg_router.git"
}

The require section of your composer.json file should contain the following lines:

    "moyo/router": "3.0.*"

Afterwards, one just needs to run the command composer update from the root of your Joomla project, followed by the composer install command after the composer.lock file is generated in the first step.

jsymlinker

Another option, currently only available for Moyo developers, is by using the jsymlink script from the Moyo Git Tools.

Usage

A routing.yml is required at the following location: administrator/config/router/routing.yml. Also see: http://symfony.com/doc/current/book/routing.html Make sure to provide the defaults option and view.

Example

Let's take our own Article package for example. The standard URLs for articles are as follow: index.php?option=com_article&view=article&id=1. Now if we want a pretty URL we need to add it to the routing.yml file:

article:
    path: '/{_locale}/article/{slug}.{format}'
    defaults:
        option: com_articles
        view: article
    requirements: null