playtini / easy-admin-helper-bundle
EasyAdmin Helper Bundle
Package info
github.com/playtini/easy-admin-helper-bundle
pkg:composer/playtini/easy-admin-helper-bundle
Requires
- php: ^8.5
- easycorp/easyadmin-bundle: ^5.1
- erusev/parsedown: ^1.8
- gupalo/browser-notifier: ^1.4
- gupalo/dateutils: ^1.20
- gupalo/monolog-dbal-logger: ^1.11
- gupalo/symfony-form-transformers: ^1.4
- gupalo/uidgenerator: ^1.2
- luchaninov/csv-file-loader: ^1.10
- peekabooauth/peekaboo-bundle: ^1.8
- spatie/yaml-front-matter: ^2.1
- symfony/framework-bundle: ^7.4|^8.1
Requires (Dev)
- phpstan/phpstan: ^2.1
- phpunit/phpunit: ^13.2
- roave/security-advisories: dev-master
README
Extends EasyAdmin with reusable traits, fields, and controllers for building admin panels. Requires PHP 8.5+ and Symfony 7.4+/8.1+.
Install
composer require playtini/easy-admin-helper-bundle
Create App\EasyAdmin\EasyAdminMenu implementing EasyAdminMenuInterface.
Create DashboardController extending CustomDashboardController.
Add to config/services.yaml:
Playtini\EasyAdminHelperBundle\Dashboard\EasyAdminMenuInterface: class: 'App\EasyAdmin\EasyAdminMenu' Playtini\EasyAdminHelperBundle\Dashboard\EasyAdminContext: bind: $dashboardController: '@App\Controller\Admin\DashboardController' Playtini\EasyAdminHelperBundle\Event\DashboardExceptionSubscriber: tags: [ { name: kernel.event_subscriber } ]
Load routes. Add to config/routes/easyadmin.yaml:
easy_admin_helper: resource: '@EasyAdminHelperBundle/config/routes.yaml'
EasyAdmin 5 requires pretty URLs, so the EasyAdmin route loader must be enabled for the custom CRUD actions (archive, duplicate) to be registered. Add to the same config/routes/easyadmin.yaml:
easyadmin: resource: . type: easyadmin.routes
Install bundle assets (symlinks JS/CSS to public/bundles/easyadminhelper/):
php bin/console assets:install
Features
Controller Traits
| Trait | Purpose |
|---|---|
CrudControllerTrait |
Base CRUD config (date formats, pagination, actions, detailβedit redirect) |
ArchiveCrudControllerTrait |
Soft-delete via archiving (auto-filters archived, archive/unarchive actions) |
DuplicateCrudControllerTrait |
Entity duplication via DuplicateInterface |
ReadOnlyCrudControllerTrait |
Disables all edit/delete actions, makes fields disabled |
InlineEditCrudControllerTrait |
Inline editing support |
SaveCrudControllerTrait |
Custom save logic via repository |
UserCrudControllerTrait |
Current user helpers |
QuickDateFilterCrudTrait |
Dropdown with preset date periods (1h, today, 24h, 7d, 30d) |
DateRangePickerCrudTrait |
Calendar-based date range picker with from/to params |
Entity Traits
| Trait | Fields |
|---|---|
IdEntityTrait |
Auto-increment id |
NameEntityTrait / NameUniqueEntityTrait |
name (varchar 255) |
LongNameEntityTrait |
name (varchar 1000) |
CreatableEntityTrait |
createdAt (auto-set on persist) |
UpdatableEntityTrait |
updatedAt (auto-set on persist/update) |
ArchivableEntityTrait |
archivedAt (soft-delete timestamp) |
IsEnabledTrait |
isEnabled (boolean) |
UidEntityTrait |
uid (unique string) |
CommentEntityTrait / ShortCommentEntityTrait |
comment (text / varchar 1024) |
DataEntityTrait |
data (JSON column with YAML display helper) |
VirtualFieldsEntityTrait |
Stub methods for computed fields |
Entity Base Classes
BaseAuditLog is a #[ORM\MappedSuperclass] carrying the eight columns of a per-request audit log (username, routeName, routeParams, url, httpMethod, statusCode, ip, responseTimeMs) plus id/createdAt via CreatableEntityTrait. Subclass it with your own #[ORM\Entity], indexes and repository:
#[ORM\Entity(repositoryClass: AuditLogRepository::class)] #[ORM\HasLifecycleCallbacks] #[ORM\Index(columns: ['created_at'])] class AuditLog extends BaseAuditLog {}
#[ORM\HasLifecycleCallbacks] must be declared on the concrete class or createdAt never gets set. Do not also use IdEntityTrait β CreatableEntityTrait already composes it.
Requires doctrine.orm.auto_mapping: true in the consuming application, or an explicit Doctrine mapping for the Playtini\EasyAdminHelperBundle\Entity namespace. Without one, Doctrine treats BaseAuditLog as transient and the subclass maps to zero columns β doctrine:schema:update will then propose dropping every column from the existing table rather than failing loudly.
CrudField Helper
Static factory for pre-configured EasyAdmin fields:
yield CrudField::id(); yield CrudField::panel('Details', 6); yield CrudField::name(); yield CrudField::email(); yield CrudField::domain(); yield CrudField::ip(); yield CrudField::country(); yield CrudField::url('websiteUrl'); yield CrudField::status(); yield CrudField::bool('isVerified', 'Verified'); yield CrudField::createdAt(); yield CrudField::updatedAt(); yield CrudField::yaml('config', isIndex: true); yield CrudField::virtual('Score', fn($v, $entity) => $entity->getScore());
AdminFormatter
AdminFormatter::badge('active', '#198754') // colored badge AdminFormatter::badgeMap('error', $colorMap) // badge with color lookup AdminFormatter::formatExpireDate($date) // color-coded by days remaining AdminFormatter::formatHttpStatus(200) // Bootstrap status badge AdminFormatter::formatBoolNullEmoji(true) // π’ / π΄ AdminFormatter::muteZero(0) // grayed-out zero AdminFormatter::percents(25, 100) // "25%"
Quick Date Filter
Dropdown with preset date periods. Query param: ?period=24h
class ClickCrudController extends AbstractCrudController { use CrudControllerTrait; use QuickDateFilterCrudTrait; public function configureCrud(Crud $crud): Crud { return $this->_configureCrud($crud) ->overrideTemplate('crud/index', '@EasyAdminHelper/crud/quick_date_filter_index.html.twig'); } public function createIndexQueryBuilder(...): QueryBuilder { $qb = parent::createIndexQueryBuilder(...); return $this->applyQuickDateFilter($qb); } }
Override getQuickDateField(), getQuickDateDefault(), getQuickDateOptions() to customize.
Date Range Picker
Calendar-based date range picker. Query params: ?from=2025-01-01&to=2025-01-31
class EventCrudController extends AbstractCrudController { use CrudControllerTrait; use DateRangePickerCrudTrait; public function configureCrud(Crud $crud): Crud { return $this->_configureCrud($crud) ->overrideTemplate('crud/index', '@EasyAdminHelper/crud/date_range_picker_index.html.twig'); } }
The trait handles createIndexQueryBuilder() and configureResponseParameters() automatically. Override getDateRangeField() and getDateRangeDefaultDays() to customize.
Release Session Early
#[ReleaseSessionEarly] marks a controller class or method as session-read-only. ReleaseSessionEarlyListener then flushes the session ($session->save()) before the action runs, so the session row isn't held for the duration β useful for concurrent XHRs from the same user.
#[ReleaseSessionEarly] public function export(): Response { // session already flushed by the time this runs }
Sessions are never started by the listener: if the controller hasn't started one, nothing happens. It's inert in a project that doesn't use the attribute. Attribute lookup is not inheritance-aware β declare it on the concrete controller class or method, not on an abstract base controller. For invokable controllers, the attribute is honoured whether it's placed on the class or on __invoke().
Bulk Import
BulkImportType is a paste-a-TSV import form backed by Form\Dto\BulkImport. It knows nothing about the target entity: the controller reads BulkImport::getRows() and decides what each row means. BulkImport::getMode() returns one of five modes (MODE_CREATE_OR_UPDATE, MODE_CREATE_ONLY, MODE_UPDATE_ONLY, MODE_CREATE_SKIP_EXISTING, MODE_UPDATE_SKIP_MISSING) so every project offers the same choices with the same stored values.
Doc Controllers
Built-in documentation viewer for markdown files in {project}/doc/. Supports YAML front matter. Routes:
/admin/docβ doc index/admin/doc/{name}β single doc page/admin/doc/dbβ database diagrams
Bundled Assets
The bundle ships common vendor JS/CSS in public/. After assets:install they're available at /bundles/easyadminhelper/:
js/jquery.jsβ jQueryjs/chart.jsβ Chart.jsjs/moment.min.jsβ Moment.jsjs/vanilla-datetimerange-picker.jsβ Date range pickercss/vanilla-datetimerange-picker.cssβ Date range picker styles
The bundle layout (templates/layout.html.twig) includes common CSS utilities (.positive, .negative, .uid, .short-1β.short-6, .btn-xs, etc.) and auto-initializes Bootstrap tooltips.