philetaylor / hashids-bundle
Bundle for integration of hashids lib to the container
Installs: 7 226
Dependents: 0
Suggesters: 0
Security: 0
Stars: 1
Watchers: 3
Forks: 20
Type:symfony-bundle
Requires
- hashids/hashids: ^4
- symfony/framework-bundle: >= 2.1.0
README
hashidsBundle
This is a bundle to use http://www.hashids.org/ as a service
Installation
Symfony 2.1.x <= 2.4.x: Composer
Composer is a project dependency manager for PHP. You have to list
your dependencies in a composer.json
file:
{ "require": { "cayetanosoriano/hashids-bundle": "dev-master" } }
To actually install in your project, download the composer binary and run it:
wget http://getcomposer.org/composer.phar
# or
curl -O http://getcomposer.org/composer.phar
php composer.phar install
Step 2: Enable the bundle
Finally, enable the bundle in the kernel:
<?php // app/AppKernel.php public function registerBundles() { $bundles = array( // ... new cayetanosoriano\HashidsBundle\cayetanosorianoHashidsBundle(), ); }
Configuration
Add the following to your config.yml
cayetanosoriano_hashids: salt: "randomsalt" #optional min_hash_length: 10 #optional alphabet: "abcd..." #optional
Then use the service
$kcy = $this->get('hashids');
Optional features
Doctrine param converter
The included Doctrine param converter extends the one included in (SensioFrameworkExtraBundle)[http://symfony.com/doc/current/bundles/SensioFrameworkExtraBundle/annotations/converters.html] to automate decoding of Hashids in routes before fetching the object.
Overload the default service to your services.yml
sensio_framework_extra.converter.doctrine.orm: class: cayetanosoriano\HashidsBundle\Request\ParamConverter\HashidsDoctrineParamConverter arguments: ["@hashids", "@doctrine"] tags: [{ name: request.param_converter, converter: doctrine.orm }]
Specify the Hashid in your route
The following two examples are equivalent, using either the raw database id
or
the Hashid encoded version.
Raw id
(standard SensioFrameworkExtraBundle behaviour)
/** * @Route("/user/{id}", requirements={"id"="\d+"}, name="user_view") */ public function viewAction(User $user) { … }
Hashid
The hashid
request parameter will be automatically recognised as an encoded
version of id
.
/** * @Route("/user/{hashid}", requirements={"hashid"="[A-Za-z0-9_-]+"}, name="user_view") */ public function viewAction(User $user) { … }
license
=======
Twig extension
Declare the service to your services.yml
twig.hashids_extension: class: cayetanosoriano\HashidsBundle\Twig\HashidsExtension arguments: ["@hashids"] public: false tags: [{ name: twig.extension }]
Use the extension in your Twig templates
<a href="{{ path('user_profile', {'hashid': user.id|hashid_encode}) }}">View Profile</a>
License
Copyright (c) 2015 neoshadybeat[at]gmail.com
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.