Bookmark management bundle
A redis driven bookmark engine.
Install through composer:
php -d memory_limit=-1 composer.phar require xlabs/bookmarkbundle
This bundle depends on "xlabs/rabbitmqbundle". Make sure to set it up too.
In your AppKernel
public function registerbundles()
{
return [
...
...
new XLabs\BookmarkBundle\XLabsBookmarkBundle(),
];
}
php bin/console doctrine:schema:update --force
Append to main routing file:
# app/config/routing.yml
x_labs_bookmark:
resource: "@XLabsBookmarkBundle/Resources/config/routing.yml"
#prefix: /
Default values are shown below:
# app/config/config.yml
x_labs_bookmark:
redis_settings:
host: 192.168.5.23
port: 6379
database_id: 7
_key_namespace: 'xlabs:bookmark'
Append this anywhere in you template
{% include 'XLabsBookmarkBundle:Bookmark:loader.html.twig' %}
To see a sample template, check:
XLabsBookmarkBundle:Bookmark:example.html.twig
Make sure you run the following command. This is the consumer that will save all operations in the project DB.
php bin/console xlabs:bookmark:mysql_backup
If ever Redis lost all the data, you will be able to recover it by issueing the following command:
php bin/console xlabs:bookmark:restore
If you already have data in redis and want to create a mysql backup of it, there´s a sample one-time command you should copy to your project and adapt conveniently:
php bin/console xlabs:bookmark:initial_backup
If you want some action to take place whenever a BOOKMARK takes place in the frontends, you can create an event listener as follows:
# YourBundle/Resources/config/services.yml
...
xlabs_bookmark.event_listener:
class: YourBundle\EventListeners\YourListener.php
tags:
- { name: kernel.event_listener, event: xlabs_bookmark.event, method: yourListenerMethod }
use Symfony\Component\EventDispatcher\Event;
class YourListener extends Event
{
public function yourListenerMethod(Event $event)
{
dump($event->getBookmark()); die;
}
}
The $event variable contains all info about the BOOKMARK action that has taken place.
By default, the service uses the user in session. If you ever wanted to use the service on your own by using any specific user performing the BOOKMARK action:
$user = $em->getRepository('YourBundle:YourUserEntity')->find(<ID>);
$bookmark_engine = $container->get('xlabs_bookmark_engine');
$bookmark_engine->setUser($user);
$bookmark_engine->...