Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions config/services.php
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
use EasyCorp\Bundle\EasyAdminBundle\Command\MakeCrudControllerCommand;
use EasyCorp\Bundle\EasyAdminBundle\Contracts\Field\FieldConfiguratorInterface;
use EasyCorp\Bundle\EasyAdminBundle\Contracts\Filter\FilterConfiguratorInterface;
use EasyCorp\Bundle\EasyAdminBundle\Contracts\Icon\EntityIconGeneratorInterface;
use EasyCorp\Bundle\EasyAdminBundle\Contracts\Menu\MenuItemMatcherInterface;
use EasyCorp\Bundle\EasyAdminBundle\Contracts\Orm\EntityPaginatorInterface;
use EasyCorp\Bundle\EasyAdminBundle\Contracts\Translation\EntityTranslationIdGeneratorInterface;
Expand Down Expand Up @@ -73,6 +74,7 @@
use EasyCorp\Bundle\EasyAdminBundle\Form\Type\CrudFormType;
use EasyCorp\Bundle\EasyAdminBundle\Form\Type\FileUploadType;
use EasyCorp\Bundle\EasyAdminBundle\Form\Type\FiltersFormType;
use EasyCorp\Bundle\EasyAdminBundle\Icon\EntityIconGenerator;
use EasyCorp\Bundle\EasyAdminBundle\Intl\IntlFormatter;
use EasyCorp\Bundle\EasyAdminBundle\Maker\ClassMaker;
use EasyCorp\Bundle\EasyAdminBundle\Menu\MenuItemMatcher;
Expand Down Expand Up @@ -252,6 +254,7 @@
->arg(3, service(AdminUrlGenerator::class))
->arg(4, service(MenuItemMatcherInterface::class))
->arg(5, service(EntityTranslationIdGeneratorInterface::class))
->arg(6, service(EntityIconGeneratorInterface::class))

->set(MenuItemMatcher::class)
->arg(0, service(AdminUrlGenerator::class))
Expand Down Expand Up @@ -446,6 +449,10 @@

->alias(EntityTranslationIdGeneratorInterface::class, EntityTranslationIdGenerator::class)

->set(EntityIconGenerator::class)

->alias(EntityIconGeneratorInterface::class, EntityIconGenerator::class)

->set(AssetPackage::class)
->arg(0, service('request_stack'))
->tag('assets.package', ['package' => AssetPackage::PACKAGE_NAME])
Expand Down
26 changes: 26 additions & 0 deletions doc/dashboards.rst
Original file line number Diff line number Diff line change
Expand Up @@ -843,6 +843,32 @@ generator to return the menu items::
// ...
}

Icons
~~~~~

If you prefer to configure all icons for links to entities in one place you can implement
``EntityIconGeneratorInterface``:

namespace App\EasyAdmin\Icon;

use App\Entity\Developer;
use App\Entity\Invoice;
use EasyCorp\Bundle\EasyAdminBundle\Contracts\Icon\EntityIconGeneratorInterface;
use Symfony\Component\DependencyInjection\Attribute\AsAlias;

#[AsAlias(EntityIconGeneratorInterface::class)]
class EntityIconGenerator implements EntityIconGeneratorInterface
{
public function generate(string $entity): ?string
{
return match ($entity) {
Developer::class => 'fa-solid fa-user',
Invoice::class => 'fa fa-file-invoice',
default => null,
};
}
}

.. _dashboards-user-menu:

User Menu
Expand Down
14 changes: 14 additions & 0 deletions src/Contracts/Icon/EntityIconGeneratorInterface.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<?php

namespace EasyCorp\Bundle\EasyAdminBundle\Contracts\Icon;

interface EntityIconGeneratorInterface
{
/**
* For a given entity FQCN (for example "App\Entity\Invoice") generates a string representing
* an icon (for example "fa fa-file-invoice").
*
* @param class-string $entity
*/
public function generate(string $entity): ?string;
}
14 changes: 14 additions & 0 deletions src/Factory/MenuFactory.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
use EasyCorp\Bundle\EasyAdminBundle\Config\UserMenu;
use EasyCorp\Bundle\EasyAdminBundle\Context\AdminContext;
use EasyCorp\Bundle\EasyAdminBundle\Contracts\Factory\MenuFactoryInterface;
use EasyCorp\Bundle\EasyAdminBundle\Contracts\Icon\EntityIconGeneratorInterface;
use EasyCorp\Bundle\EasyAdminBundle\Contracts\Menu\MenuItemInterface;
use EasyCorp\Bundle\EasyAdminBundle\Contracts\Menu\MenuItemMatcherInterface;
use EasyCorp\Bundle\EasyAdminBundle\Contracts\Provider\AdminContextProviderInterface;
Expand Down Expand Up @@ -34,6 +35,7 @@ public function __construct(
private readonly AdminUrlGeneratorInterface $adminUrlGenerator,
private readonly MenuItemMatcherInterface $menuItemMatcher,
private readonly ?EntityTranslationIdGeneratorInterface $entityTranslationIdGenerator = null,
private readonly ?EntityIconGeneratorInterface $entityIconGenerator = null,
) {
if (null === $this->entityTranslationIdGenerator) {
trigger_deprecation(
Expand All @@ -43,6 +45,14 @@ public function __construct(
'$entityTranslationIdGenerator',
);
}
if (null === $this->entityIconGenerator) {
trigger_deprecation(
'easycorp/easyadmin-bundle',
'4.28',
'Not passing argument "$entityIconGenerator" will cause an error in 5.0.0.',
'$entityIconGenerator',
);
}
}

/**
Expand Down Expand Up @@ -119,6 +129,10 @@ private function buildMenuItem(MenuItemDto $menuItemDto, array $subItems, string
$menuItemDto->setLabel($label);
}

if (MenuItemDto::TYPE_CRUD === $menuItemDto->getType() && null === $menuItemDto->getIcon() && null !== $this->entityIconGenerator) {
$menuItemDto->setIcon($this->entityIconGenerator->generate($menuItemDto->getRouteParameters()[EA::ENTITY_FQCN]));
}

$url = $this->generateMenuItemUrl($menuItemDto);
$menuItemDto->setLinkUrl($url);

Expand Down
13 changes: 13 additions & 0 deletions src/Icon/EntityIconGenerator.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<?php

namespace EasyCorp\Bundle\EasyAdminBundle\Icon;

use EasyCorp\Bundle\EasyAdminBundle\Contracts\Icon\EntityIconGeneratorInterface;

final class EntityIconGenerator implements EntityIconGeneratorInterface
{
public function generate(string $entity): ?string
{
return null;
}
}