Fields

1
2
3
4
5
6
7
8
9
10
11
12

use Doctrine\ORM\Mapping as ORM;

#[ORM\Entity]
class Customer
{
    // ...

    public function getFullName()
    {
        return $this->getFirstName().' '.$this->getLastName();
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

namespace App\Controller\Admin;

use EasyCorp\Bundle\EasyAdminBundle\Config\Crud;
use EasyCorp\Bundle\EasyAdminBundle\Controller\AbstractCrudController;

class UserCrudController extends AbstractCrudController
{
    // ...

    public function configureFields(string $pageName): iterable
    {
        return [
            TextField::new('fullName'),
            // ...
        ];
    }

    public function createIndexQueryBuilder(SearchDto $searchDto, EntityDto $entityDto, FieldCollection $fields, FilterCollection $filters): QueryBuilder
    {
        $queryBuilder = parent::createIndexQueryBuilder($searchDto, $entityDto, $fields, $filters);

        // if user defined sort is not set
        if (0 === count($searchDto->getSort())) {
            $queryBuilder
                ->addSelect('CONCAT(entity.first_name, \' \', entity.last_name) AS HIDDEN full_name')
                ->addOrderBy('full_name', 'DESC');
        }

        return $queryBuilder;
    }
}

1
2
3
4
5
6
7
8
9
10
11

public function configureFields(string $pageName): iterable
{
    return [
        IdField::new('id')->hideOnForm(),
        TextField::new('firstName'),
        TextField::new('lastName'),
        TextField::new('phone'),
        EmailField::new('email')->hideOnIndex(),
        DateTimeField::new('createdAt')->onlyOnDetail(),
    ];
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

use EasyCorp\Bundle\EasyAdminBundle\Config\Crud;

public function configureFields(string $pageName): iterable
{
    $id = IdField::new('id');
    $firstName = TextField::new('firstName');
    $lastName = TextField::new('lastName');
    $phone = TextField::new('phone');
    $email = EmailField::new('email');
    $createdAt = DateTimeField::new('createdAt');

    if (Crud::PAGE_INDEX === $pageName) {
        return [$id, $firstName, $lastName, $phone];
    } elseif(Crud::PAGE_DETAIL === $pageName) {
        return ['...'];
    } else {
        return ['...'];
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13

public function configureFields(string $pageName): iterable
{
    yield IdField::new('id')->hideOnForm();

    if ('... some expression ...') {
        yield TextField::new('firstName');
        yield TextField::new('lastName');
    }

    yield TextField::new('phone');
    yield EmailField::new('email')->hideOnIndex();
    yield DateTimeField::new('createdAt')->onlyOnDetail();
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

use EasyCorp\Bundle\EasyAdminBundle\Field\FormField;

public function configureFields(string $pageName): iterable
{
    return [
        // Creates a tab: all fields following it will belong to that tab
        // (until the end of the form or until you create another tab)
        FormField::addTab('First Tab'),
        TextField::new('firstName'),
        TextField::new('lastName'),

        // Creates a second tab and customizes some of its properties, such
        // as its icon, CSS class and help message
        FormField::addTab('Contact information Tab')
            ->setIcon('phone')->addCssClass('optional')
            ->setHelp('Phone number is preferred'),

        TextField::new('phone'),
        // ...
    ];
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14

use EasyCorp\Bundle\EasyAdminBundle\Field\FormField;

public function configureFields(string $pageName): iterable
{
    return [
        FormField::addColumn(8),
        TextField::new('firstName'),
        TextField::new('lastName'),

        FormField::addColumn(4),
        TextField::new('phone'),
        TextField::new('email')->hideOnIndex(),
    ];
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14

use EasyCorp\Bundle\EasyAdminBundle\Field\FormField;

public function configureFields(string $pageName): iterable
{
    return [
        FormField::addColumn('col-lg-8 col-xl-6'),
        TextField::new('firstName'),
        TextField::new('lastName'),

        FormField::addColumn('col-lg-3 col-xl-2'),
        TextField::new('phone'),
        TextField::new('email')->hideOnIndex(),
    ];
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

use EasyCorp\Bundle\EasyAdminBundle\Field\FormField;

public function configureFields(string $pageName): iterable
{
    return [
        FormField::addTab('User Data'),

        FormField::addColumn('col-lg-8 col-xl-6'),
        TextField::new('firstName'),
        TextField::new('lastName'),

        FormField::addColumn('col-lg-3 col-xl-2'),
        TextField::new('phone'),
        TextField::new('email')->hideOnIndex(),

        FormField::addTab('Financial Information'),

        // ...
    ];
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

use EasyCorp\Bundle\EasyAdminBundle\Field\FormField;

public function configureFields(string $pageName): iterable
{
    return [
        // fieldsets usually display only a title
        FormField::addFieldset('User Details'),
        TextField::new('firstName'),
        TextField::new('lastName'),

        // fieldsets without titles only display a separation between fields
        FormField::addFieldset(),
        DateTimeField::new('createdAt')->onlyOnDetail(),

        // fieldsets can also define their icon, CSS class and help message
        FormField::addFieldset('Contact information')
            ->setIcon('phone')->addCssClass('optional')
            ->setHelp('Phone number is preferred'),
        TextField::new('phone'),
        TextField::new('email')->hideOnIndex(),

        // fieldsets can be collapsible too (useful if your forms are long)
        // this makes the fieldset collapsible but renders it expanded by default
        FormField::addFieldset('Contact information')->collapsible(),
        // this makes the fieldset collapsible and renders it collapsed by default
        FormField::addFieldset('Contact information')->renderCollapsed(),
    ];
}

1
2
3
4
5
6
7
8
9
10
11

use EasyCorp\Bundle\EasyAdminBundle\Field\DateTimeField;

public function configureFields(string $pageName): iterable
{
    return [
        // ...,

        DateTimeField::new('startsAt')->setColumns(6),
        DateTimeField::new('endsAt')->setColumns(6),
    ];
}

1
2
3
4
5
6
7
8
9
10
11

use EasyCorp\Bundle\EasyAdminBundle\Field\DateTimeField;

public function configureFields(string $pageName): iterable
{
    return [
        // ...,

        DateTimeField::new('startsAt')->setColumns('col-sm-6 col-lg-5 col-xxl-3'),
        DateTimeField::new('endsAt')->setColumns('col-sm-6 col-lg-5 col-xxl-3'),
    ];
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

use EasyCorp\Bundle\EasyAdminBundle\Field\BooleanField;
use EasyCorp\Bundle\EasyAdminBundle\Field\DateTimeField;
use EasyCorp\Bundle\EasyAdminBundle\Field\FormField;

public function configureFields(string $pageName): iterable
{
    return [
        // ...,

        DateTimeField::new('startsAt')->setColumns('col-sm-6 col-lg-5 col-xxl-3'),
        DateTimeField::new('endsAt')->setColumns('col-sm-6 col-lg-5 col-xxl-3'),
        FormField::addRow(),

        // you can pass the name of the breakpoint to add a row only on certain widths
        // FormField::addRow('xl'),

        // this field will always render on its own row, even if there's
        // enough space for it in the previous row in `lg`, `xl` and `xxl` breakpoints
        BooleanField::new('published')->setColumns(2),
    ];
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

TextField::new('firstName', 'Name')
    // use this method if your field needs a specific form theme to render properly
    ->addFormTheme('@FOSCKEditor/Form/ckeditor_widget.html.twig')
    // you can add more than one form theme using the same method
    ->addFormTheme('theme1.html.twig', 'theme2.html.twig', 'theme3.html.twig')

    // CSS class/classes are applied to the field contents (in the 'index' page)
    // or to the row that wraps the contents (in the 'detail', 'edit' and 'new' pages)

    // use this method to add new classes to the ones applied by EasyAdmin
    ->addCssClass('text-large text-bold')
    // use this other method if you want to remove any CSS class added by EasyAdmin
    ->setCssClass('text-large text-bold')

    // this defines the Twig template used to render this field in 'index' and 'detail' pages
    // (this is not used in the 'edit'/'new' pages because they use Symfony Forms themes)
    ->setTemplatePath('admin/fields/my_template.html.twig')

    // useful for example to right-align numbers/money values (this setting is ignored in 'detail' page)
    ->setTextAlign('right')
;

1
2
3
4
5
6
7
8
9
10

use EasyCorp\Bundle\EasyAdminBundle\Config\Asset;
// ...

TextField::new('firstName', 'Name')
    ->addCssFiles(Asset::new('bundle/some-bundle/foo.css')->ignoreOnForm()->htmlAttr('media', 'print'))
    ->addJsFiles(Asset::new('admin/some-custom-code.js')->onlyOnIndex()->defer())
    ->addWebpackEncoreEntries(Asset::new('admin-maps')->onlyWhenCreating()->preload())
    // you can even define the Symfony Asset package which the asset belongs to
    ->addCssFiles(Asset::new('some-path/bar.css')->package('legacy_assets'))
;

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

IntegerField::new('stock', 'Stock')
    // callbacks usually take only the current value as argument
    ->formatValue(function ($value) {
        return $value < 10 ? sprintf('%d **LOW STOCK**', $value) : $value;
    });

TextEditorField::new('description')
    // callables also receives the entire entity instance as the second argument
    ->formatValue(function ($value, $entity) {
        return $entity->isPublished() ? $value : 'Coming soon...';
    });

// in PHP 7.4 and newer you can use arrow functions
// ->formatValue(fn ($value) => $value < 10 ? sprintf('%d **LOW STOCK**', $value) : $value);
// ->formatValue(fn ($value, $entity) => $entity->isPublished() ? $value : 'Coming soon...');

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

TextField::new('firstName', 'Name')
    // if TRUE, listing can be sorted by this field (default: TRUE)
    // unmapped fields cannot be sorted
    ->setSortable(false)

    // help message displayed for this field in the 'detail', 'edit' and 'new' pages
    ->setHelp('...')

    // sets the value of the `empty_data` option in the Symfony form
    // see https://symfony.com/doc/current/reference/forms/types/form.html#empty-data
    ->setEmptyData('Jane Doe')

    // the Symfony Form type used to render this field in 'edit'/'new' pages
    // (fields have good default values for this option, so you don't usually configure this)
    ->setFormType(TextType::class)

    // an array of parameters passed to the Symfony form type
    // (this only overrides the values of the passed form type options;
    // it leaves all the other existing type options unchanged)
    ->setFormTypeOptions(['option_name' => 'option_value'])

    // a custom HTML attribute added when rendering the field
    // e.g. setHtmlAttribute('data-foo', 'bar') renders a 'data-foo="bar"' attribute in HTML
    // On 'index' and 'detail' pages, the attribute is added to the field container:
    // <td> and div.field-group respectively
    // On 'new' and 'edit' pages, the attribute is added to the form field;
    // it's a shortcut for the equivalent setFormTypeOption('attr.data-foo', 'bar)
    ->setHtmlAttribute('attribute_name', 'attribute_value')

    // a key-value array of attributes to add to the HTML element
    ->setHtmlAttributes(['data-foo' => 'bar', 'autofocus' => 'autofocus'])

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

namespace App\Admin\Field;

use EasyCorp\Bundle\EasyAdminBundle\Contracts\Field\FieldInterface;
use Symfony\Component\Form\Extension\Core\Type\TextareaType;

final class MapField implements FieldInterface
{
    use FieldTrait;

    public const OPTION_MAP_PROVIDER = 'mapProvider';

    public static function new(string $propertyName, ?string $label = null): self
    {
        return (new self())
            // ...
            ->setCustomOption(self::OPTION_MAP_PROVIDER, 'openstreetmap')
        ;
    }

    public function useGoogleMaps(): self
    {
        $this->setCustomOption(self::OPTION_MAP_PROVIDER, 'google');

        return $this;
    }

    public function useOpenStreetMap(): self
    {
        $this->setCustomOption(self::OPTION_MAP_PROVIDER, 'openstreetmap');

        return $this;
    }
}