Merge branch 'fluoresceco-twig-extension'

README.md

@@ -3,17 +3,16 @@
 hashidsBundle
 =============
 
-##This is a bundle to use http://www.hashids.org/ as a service
+## This is a bundle to use http://www.hashids.org/ as a service
 
 ## Installation
 
-
 #### Symfony 2.1.x <= 2.4.x: Composer
 
 [Composer](http://packagist.org/about-composer) is a project dependency manager for PHP. You have to list
 your dependencies in a `composer.json` file:
 
-``` json
+```json
 {
     "require": {
         "cayetanosoriano/hashids-bundle": "dev-master"
@@ -22,7 +21,7 @@ your dependencies in a `composer.json` file:
 ```
 To actually install in your project, download the composer binary and run it:
 
-``` bash
+```bash
 wget http://getcomposer.org/composer.phar
 # or
 curl -O http://getcomposer.org/composer.phar
@@ -34,7 +33,7 @@ php composer.phar install
 
 Finally, enable the bundle in the kernel:
 
-``` php
+```php
 <?php
 // app/AppKernel.php
 
@@ -49,16 +48,17 @@ public function registerBundles()
 ```
 
 ## Configuration
-###Add the following to your config.yml
-```
+
+### Add the following to your config.yml
+```yaml
 cayetanosoriano_hashids:
     salt: "randomsalt" #optional
     min_hash_length: 10 #optional
     alphabet: "abcd..." #optional
 ```
 
 ### Then use the service
-```
+```php
 $kcy = $this->get('hashids');
 ```
 
@@ -112,6 +112,24 @@ public function viewAction(User $user)
 ```
 
 ### license
+=======
+### Twig extension
+
+#### Declare the service to your services.yml
+```yaml
+twig.hashids_extension:
+    class: cayetanosoriano\HashidsBundle\Twig\HashidsExtension
+    arguments: ["@hashids"]
+    public: false
+    tags: [{ name: twig.extension }]
+```
+
+#### Use the extension in your Twig templates
+```twig
+<a href="{{ path('user_profile', {'hashid': user.id|hashid_encode}) }}">View Profile</a>
+```
+
+### License
 ```
 Copyright (c) 2015 neoshadybeat[at]gmail.com
 

Twig/HashidsExtension.php

@@ -0,0 +1,46 @@
+<?php
+
+namespace cayetanosoriano\HashidsBundle\Twig;
+
+use Hashids\Hashids;
+
+/**
+ * Twig extension to allow encoding and decoding Hashids
+ *
+ * @author Jaik Dean <jaik@fluoresce.co>
+ */
+class HashidsExtension extends \Twig_Extension
+{
+    /**
+     * @var Hashids\Hashids;
+     */
+    private $hashids;
+
+    public function __construct(Hashids $hashids)
+    {
+        $this->hashids = $hashids;
+    }
+
+    public function getFilters()
+    {
+        return [
+            new \Twig_SimpleFilter('hashid_encode', [$this, 'encode']),
+            new \Twig_SimpleFilter('hashid_decode', [$this, 'decode']),
+        ];
+    }
+
+    public function encode($number)
+    {
+        return $this->hashids->encode($number);
+    }
+
+    public function decode($hash)
+    {
+        return $this->hashids->decode($hash);
+    }
+
+    public function getName()
+    {
+        return 'hashids_extension';
+    }
+}