hautelook/templated-uri-bundle

Symfony2 Bundle that provides a RFC-6570 compatible router and URL Generator.

3.5.0 2023-01-19 19:11 UTC

Requires

• php: ^5.4|^7.0|^8.0
• hautelook/templated-uri-router: ^2.0|^3.0|^4.0
• symfony/framework-bundle: ^2.8|^3.0|^4.0|^5.0|^6.0

Requires (Dev)

• phpunit/phpunit: ^4.8.36|^5.0|^6.0|^7.0

MIT

• Baldur Rensch

• json
• xml
• Symfony2
• url
• uri
• HATEOAS
• RFC 6570

README

Symfony Bundle for the https://github.com/hautelook/TemplatedUriRouter library. hautelook/TemplatedUriRouter provides a RFC-6570 compatible Symfony router and URL Generator.

Installation

Assuming you have installed composer, run the following command:

$ composer require hautelook/templated-uri-bundle

Now add the bundle to your Kernel:

<?php
// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
        new Hautelook\TemplatedUriBundle\HautelookTemplatedUriBundle(),
        // ...
    );
}

If you are using Symfony Flex, this bundle is added automatically to your bundles.php file.

Usage

The bundle exposes a router service (hautelook.router.template) that will generate RFC-6570 compliant URLs. Here is a sample on how you could use it:

$templateLink = $container->get('hautelook.router.template')->generate('hautelook_demo_route',
    array(
        'page'   => '{page}',
        'sort'   => array('{sort}'),
        'filter' => array('{filter}'),
    )
);

This will produce a link similar to:

/demo?{&page}{&sort*}{&filter*}