presta/sonata-bookmarks-bundle

A Symfony bundle to allow user to save and share bookmarks Sonata Admin

v1.0.0 2024-07-30 13:25 UTC

Requires

• php: ^8.1
• doctrine/orm: ^2.7|^3.2
• sonata-project/admin-bundle: ^4.22
• sonata-project/doctrine-orm-admin-bundle: ^4.9
• symfony/framework-bundle: ^6.3|^7.1
• symfony/validator: ^6.3|^7.1
• symfony/yaml: ^6.3|^7.1
• twig/twig: ^3.5

Requires (Dev)

• phpstan/phpstan: ^1.10
• phpunit/phpunit: ^9.5
• symfony/browser-kit: ^6.3
• symfony/css-selector: ^6.3
• symplify/easy-coding-standard: ^11.3

MIT

• PrestaConcept

README

PrestaSonataBookmarksBundle will allow your Sonata users to save bookmarks in admin.

Preview

On each admin, you can save a page as bookmark to a dedicated database entry, after naming it.

An admin exists where you can remove bookmarks created in the application.

Installation

Install the bundle with the command:

composer require presta/sonata-bookmarks-bundle

Enable the bundle:

# config/bundles.php
return [
+    Presta\SonataBookmarksBundle\PrestaSonataBookmarksBundle::class => ['all' => true],
];

Configuration

Import our Javascripts in your project:

import '../../public/bundles/prestasonatabookmarks/scripts/app';

This step is highly dependent on how your public assets are built, imported. It's up to you knowing the best way to include it in your project.

Include our action template into the Twig template you configured to be your admin layout:

{% extends '@SonataAdmin/standard_layout.html.twig' %}

{% block sonata_top_nav_menu %}
    <ul class="nav navbar-nav">
        <li>{{ include('@PrestaSonataBookmarks/admin/bookmark_action.html.twig') }}</li>
    </ul>
    {{ parent() }}
{% endblock %}

See related SonataAdmin documentation

Configure to doctrine that what entity will be attached to bookmarks config/packages/doctrine.yaml:

<?php

use Doctrine\ORM\Mapping as ORM;
use Presta\SonataBookmarksBundle\Entity\BookmarkOwnerInterface;
use Symfony\Component\Security\Core\User\UserInterface;

#[ORM\Entity]
class User implements UserInterface, BookmarkOwnerInterface
{
}

# config/packages/doctrine.yaml
doctrine:
  orm:
    resolve_target_entities:
      Presta\SonataBookmarksBundle\Entity\BookmarkOwnerInterface: 'App\Entity\User'

See related DoctrineBundle documentation

Finally, update your schema to create the tables required for our entities:

bin/console doctrine:schema:update 

Or create a migration if you have DoctrineMigrationsBundle installed:

bin/console doctrine:migrations:diff
bin/console doctrine:migrations:migrate

This project is supported by PrestaConcept

Released under the MIT License