vendor/easycorp/easyadmin-bundle/src/Config/Crud.php line 359

  1. <?php
  3. namespace EasyCorp\Bundle\EasyAdminBundle\Config;
  5. use EasyCorp\Bundle\EasyAdminBundle\Config\Option\SortOrder;
  6. use EasyCorp\Bundle\EasyAdminBundle\Dto\CrudDto;
  7. use EasyCorp\Bundle\EasyAdminBundle\Dto\FilterConfigDto;
  8. use EasyCorp\Bundle\EasyAdminBundle\Dto\PaginatorDto;
  9. use EasyCorp\Bundle\EasyAdminBundle\Field\DateTimeField;
  10. use Symfony\Contracts\Translation\TranslatableInterface;
  12. /**
  13.  * @author Javier Eguiluz <javier.eguiluz@gmail.com>
  14.  */
  15. class Crud
  16. {
  17.     public const PAGE_DETAIL = 'detail';
  18.     public const PAGE_EDIT = 'edit';
  19.     public const PAGE_INDEX = 'index';
  20.     public const PAGE_NEW = 'new';
  21.     public const LAYOUT_CONTENT_DEFAULT = 'normal';
  22.     public const LAYOUT_CONTENT_FULL = 'full';
  23.     public const LAYOUT_SIDEBAR_DEFAULT = 'normal';
  24.     public const LAYOUT_SIDEBAR_COMPACT = 'compact';
  26.     private CrudDto $dto;
  28.     private int $paginatorPageSize = 20;
  29.     private int $paginatorRangeSize = 3;
  30.     private bool $paginatorFetchJoinCollection = true;
  31.     private ?bool $paginatorUseOutputWalkers = null;
  33.     private function __construct(CrudDto $crudDto)
  34.     {
  35.         $this->dto = $crudDto;
  36.     }
  38.     public static function new(): self
  39.     {
  40.         $dto = new CrudDto();
  42.         return new self($dto);
  43.     }
  45.     /**
  46.      * @param TranslatableInterface|string|callable $label The callable signature is: fn ($entityInstance, $pageName): string
  47.      *
  48.      * @psalm-param mixed $label
  49.      */
  50.     public function setEntityLabelInSingular(/* @var TranslatableInterface|string|callable */ $label): self
  51.     {
  52.         if (!\is_string($label) && !$label instanceof TranslatableInterface && !\is_callable($label)) {
  53.             trigger_deprecation(
  54.                 'easycorp/easyadmin-bundle',
  55.                 '4.0.5',
  56.                 'Argument "%s" for "%s" must be one of these types: %s. Passing type "%s" will cause an error in 5.0.0.',
  57.                 '$label',
  58.                 __METHOD__,
  59.                 '"string" or "TranslatableInterface" or "callable"',
  60.                 \gettype($label)
  61.             );
  62.         }
  64.         $this->dto->setEntityLabelInSingular($label);
  66.         return $this;
  67.     }
  69.     /**
  70.      * @param TranslatableInterface|string|callable $label The callable signature is: fn ($entityInstance, $pageName): string
  71.      *
  72.      * @psalm-param mixed $label
  73.      */
  74.     public function setEntityLabelInPlural(/* @var TranslatableInterface|string|callable */ $label): self
  75.     {
  76.         if (!\is_string($label) && !$label instanceof TranslatableInterface && !\is_callable($label)) {
  77.             trigger_deprecation(
  78.                 'easycorp/easyadmin-bundle',
  79.                 '4.0.5',
  80.                 'Argument "%s" for "%s" must be one of these types: %s. Passing type "%s" will cause an error in 5.0.0.',
  81.                 '$label',
  82.                 __METHOD__,
  83.                 '"string" or "callable"',
  84.                 \gettype($label)
  85.             );
  86.         }
  88.         $this->dto->setEntityLabelInPlural($label);
  90.         return $this;
  91.     }
  93.     /**
  94.      * @param TranslatableInterface|string|callable $title The callable signature is: fn ($entityInstance): string
  95.      *
  96.      * @psalm-param mixed $title
  97.      */
  98.     public function setPageTitle(string $pageName, /* @var TranslatableInterface|string|callable */ $title): self
  99.     {
  100.         if (!\is_string($title) && !$title instanceof TranslatableInterface && !\is_callable($title)) {
  101.             trigger_deprecation(
  102.                 'easycorp/easyadmin-bundle',
  103.                 '4.0.5',
  104.                 'Argument "%s" for "%s" must be one of these types: %s. Passing type "%s" will cause an error in 5.0.0.',
  105.                 '$title',
  106.                 __METHOD__,
  107.                 '"string" or "TranslatableInterface" or "callable"',
  108.                 \gettype($title)
  109.             );
  110.         }
  112.         if (!\in_array($pageName, $this->getValidPageNames(), true)) {
  113.             throw new \InvalidArgumentException(sprintf('The first argument of the "%s()" method must be one of these valid page names: %s ("%s" given).', __METHOD__, implode(', ', $this->getValidPageNames()), $pageName));
  114.         }
  116.         $this->dto->setCustomPageTitle($pageName, $title);
  118.         return $this;
  119.     }
  121.     public function setHelp(string $pageName, TranslatableInterface|string $helpMessage): self
  122.     {
  123.         if (!\in_array($pageName, $this->getValidPageNames(), true)) {
  124.             throw new \InvalidArgumentException(sprintf('The first argument of the "%s()" method must be one of these valid page names: %s ("%s" given).', __METHOD__, implode(', ', $this->getValidPageNames()), $pageName));
  125.         }
  127.         $this->dto->setHelpMessage($pageName, $helpMessage);
  129.         return $this;
  130.     }
  132.     /**
  133.      * @param string $formatOrPattern A format name ('short', 'medium', 'long', 'full') or a valid ICU Datetime Pattern (see https://unicode-org.github.io/icu/userguide/format_parse/datetime/)
  134.      */
  135.     public function setDateFormat(string $formatOrPattern): self
  136.     {
  137.         if (DateTimeField::FORMAT_NONE === $formatOrPattern || '' === trim($formatOrPattern)) {
  138.             $validDateFormatsWithoutNone = array_filter(
  139.                 DateTimeField::VALID_DATE_FORMATS,
  140.                 static fn (string $format): bool => DateTimeField::FORMAT_NONE !== $format
  141.             );
  143.             throw new \InvalidArgumentException(sprintf('The first argument of the "%s()" method cannot be "%s" or an empty string. Use either the special date formats (%s) or a datetime Intl pattern.', __METHOD__, DateTimeField::FORMAT_NONE, implode(', ', $validDateFormatsWithoutNone)));
  144.         }
  146.         $datePattern = DateTimeField::INTL_DATE_PATTERNS[$formatOrPattern] ?? $formatOrPattern;
  147.         $this->dto->setDatePattern($datePattern);
  149.         return $this;
  150.     }
  152.     /**
  153.      * @param string $formatOrPattern A format name ('short', 'medium', 'long', 'full') or a valid ICU Datetime Pattern (see https://unicode-org.github.io/icu/userguide/format_parse/datetime/)
  154.      */
  155.     public function setTimeFormat(string $formatOrPattern): self
  156.     {
  157.         if (DateTimeField::FORMAT_NONE === $formatOrPattern || '' === trim($formatOrPattern)) {
  158.             $validTimeFormatsWithoutNone = array_filter(
  159.                 DateTimeField::VALID_DATE_FORMATS,
  160.                 static fn (string $format): bool => DateTimeField::FORMAT_NONE !== $format
  161.             );
  163.             throw new \InvalidArgumentException(sprintf('The first argument of the "%s()" method cannot be "%s" or an empty string. Use either the special time formats (%s) or a datetime Intl pattern.', __METHOD__, DateTimeField::FORMAT_NONE, implode(', ', $validTimeFormatsWithoutNone)));
  164.         }
  166.         $timePattern = DateTimeField::INTL_TIME_PATTERNS[$formatOrPattern] ?? $formatOrPattern;
  167.         $this->dto->setTimePattern($timePattern);
  169.         return $this;
  170.     }
  172.     /**
  173.      * @param string $dateFormatOrPattern A format name ('none', 'short', 'medium', 'long', 'full') or a valid ICU Datetime Pattern (see https://unicode-org.github.io/icu/userguide/format_parse/datetime/)
  174.      * @param string $timeFormat          A format name ('none', 'short', 'medium', 'long', 'full')
  175.      */
  176.     public function setDateTimeFormat(string $dateFormatOrPattern, string $timeFormat = DateTimeField::FORMAT_NONE): self
  177.     {
  178.         if ('' === trim($dateFormatOrPattern)) {
  179.             throw new \InvalidArgumentException(sprintf('The first argument of the "%s()" method cannot be an empty string. Use either a date format (%s) or a datetime Intl pattern.', __METHOD__, implode(', ', DateTimeField::VALID_DATE_FORMATS)));
  180.         }
  182.         $datePatternIsEmpty = DateTimeField::FORMAT_NONE === $dateFormatOrPattern;
  183.         $timePatternIsEmpty = DateTimeField::FORMAT_NONE === $timeFormat || '' === trim($timeFormat);
  184.         if ($datePatternIsEmpty && $timePatternIsEmpty) {
  185.             throw new \InvalidArgumentException(sprintf('The values of the arguments of "%s()" cannot be "%s" or an empty string at the same time. Change any of them (or both).', __METHOD__, DateTimeField::FORMAT_NONE));
  186.         }
  188.         // when date format/pattern is none and time format is a pattern,
  189.         // silently turn them into a datetime pattern
  190.         if (DateTimeField::FORMAT_NONE === $dateFormatOrPattern && !\in_array($timeFormat, DateTimeField::VALID_DATE_FORMATS, true)) {
  191.             $dateFormatOrPattern = $timeFormat;
  192.             $timeFormat = DateTimeField::FORMAT_NONE;
  193.         }
  195.         $isDatePattern = !\in_array($dateFormatOrPattern, DateTimeField::VALID_DATE_FORMATS, true);
  197.         if ($isDatePattern && DateTimeField::FORMAT_NONE !== $timeFormat) {
  198.             throw new \InvalidArgumentException(sprintf('When the first argument of "%s()" is a datetime pattern, you cannot set the time format in the second argument (define the time format inside the datetime pattern).', __METHOD__));
  199.         }
  201.         if (!$isDatePattern && !\in_array($timeFormat, DateTimeField::VALID_DATE_FORMATS, true)) {
  202.             throw new \InvalidArgumentException(sprintf('The value of the time format can only be one of the following: %s (but "%s" was given).', implode(', ', DateTimeField::VALID_DATE_FORMATS), $timeFormat));
  203.         }
  205.         $this->dto->setDateTimePattern($dateFormatOrPattern, $timeFormat);
  207.         return $this;
  208.     }
  210.     public function setDateIntervalFormat(string $format): self
  211.     {
  212.         $this->dto->setDateIntervalFormat($format);
  214.         return $this;
  215.     }
  217.     public function setTimezone(string $timezoneId): self
  218.     {
  219.         if (!\in_array($timezoneId, timezone_identifiers_list(), true)) {
  220.             throw new \InvalidArgumentException(sprintf('The "%s" timezone is not a valid PHP timezone ID. Use any of the values listed at https://www.php.net/manual/en/timezones.php', $timezoneId));
  221.         }
  223.         $this->dto->setTimezone($timezoneId);
  225.         return $this;
  226.     }
  228.     public function setNumberFormat(string $format): self
  229.     {
  230.         $this->dto->setNumberFormat($format);
  232.         return $this;
  233.     }
  235.     /**
  236.      * @param $sortFieldsAndOrder ['fieldName' => 'ASC|DESC', ...]
  237.      */
  238.     public function setDefaultSort(array $sortFieldsAndOrder): self
  239.     {
  240.         $sortFieldsAndOrder = array_map('strtoupper', $sortFieldsAndOrder);
  241.         foreach ($sortFieldsAndOrder as $sortField => $sortOrder) {
  242.             if (!\in_array($sortOrder, [SortOrder::ASC, SortOrder::DESC], true)) {
  243.                 throw new \InvalidArgumentException(sprintf('The sort order can be only "%s" or "%s", "%s" given.', SortOrder::ASC, SortOrder::DESC, $sortOrder));
  244.             }
  246.             if (!\is_string($sortField)) {
  247.                 throw new \InvalidArgumentException(sprintf('The keys of the array that defines the default sort must be strings with the field names, but the given "%s" value is a "%s".', $sortField, \gettype($sortField)));
  248.             }
  249.         }
  251.         $this->dto->setDefaultSort($sortFieldsAndOrder);
  253.         return $this;
  254.     }
  256.     public function setSearchFields(?array $fieldNames): self
  257.     {
  258.         $this->dto->setSearchFields($fieldNames);
  260.         return $this;
  261.     }
  263.     public function setAutofocusSearch(bool $autofocusSearch = true): self
  264.     {
  265.         $this->dto->setAutofocusSearch($autofocusSearch);
  267.         return $this;
  268.     }
  270.     public function showEntityActionsInlined(bool $showInlined = true): self
  271.     {
  272.         $this->dto->setShowEntityActionsAsDropdown(!$showInlined);
  274.         return $this;
  275.     }
  277.     public function setFilters(?FilterConfigDto $filters): self
  278.     {
  279.         $this->dto->setFiltersConfig($filters);
  281.         return $this;
  282.     }
  284.     public function setPaginatorPageSize(int $maxResultsPerPage): self
  285.     {
  286.         if ($maxResultsPerPage < 1) {
  287.             throw new \InvalidArgumentException('The minimum value of paginator page size is 1.');
  288.         }
  290.         $this->paginatorPageSize = $maxResultsPerPage;
  292.         return $this;
  293.     }
  295.     public function setPaginatorRangeSize(int $maxPagesOnEachSide): self
  296.     {
  297.         if ($maxPagesOnEachSide < 0) {
  298.             throw new \InvalidArgumentException('The minimum value of paginator range size is 0.');
  299.         }
  301.         $this->paginatorRangeSize = $maxPagesOnEachSide;
  303.         return $this;
  304.     }
  306.     public function setPaginatorFetchJoinCollection(bool $fetchJoinCollection): self
  307.     {
  308.         $this->paginatorFetchJoinCollection = $fetchJoinCollection;
  310.         return $this;
  311.     }
  313.     public function setPaginatorUseOutputWalkers(bool $useOutputWalkers): self
  314.     {
  315.         $this->paginatorUseOutputWalkers = $useOutputWalkers;
  317.         return $this;
  318.     }
  320.     public function overrideTemplate(string $templateName, string $templatePath): self
  321.     {
  322.         $this->dto->overrideTemplate($templateName, $templatePath);
  324.         return $this;
  325.     }
  327.     /**
  328.      * Format: ['templateName' => 'templatePath', ...].
  329.      */
  330.     public function overrideTemplates(array $templateNamesAndPaths): self
  331.     {
  332.         foreach ($templateNamesAndPaths as $templateName => $templatePath) {
  333.             $this->overrideTemplate($templateName, $templatePath);
  334.         }
  336.         return $this;
  337.     }
  339.     public function addFormTheme(string $themePath): self
  340.     {
  341.         $this->dto->addFormTheme($themePath);
  343.         return $this;
  344.     }
  346.     public function setFormThemes(array $themePaths): self
  347.     {
  348.         foreach ($themePaths as $path) {
  349.             if (!\is_string($path)) {
  350.                 throw new \InvalidArgumentException(sprintf('All form theme paths passed to the "%s" method must be strings, but at least one of those values is of type "%s".', __METHOD__, \gettype($path)));
  351.             }
  352.         }
  354.         $this->dto->setFormThemes($themePaths);
  356.         return $this;
  357.     }
  359.     public function setFormOptions(array $newFormOptions, array $editFormOptions = null): self
  360.     {
  361.         $this->dto->setNewFormOptions(KeyValueStore::new($newFormOptions));
  362.         $this->dto->setEditFormOptions(KeyValueStore::new($editFormOptions ?? $newFormOptions));
  364.         return $this;
  365.     }
  367.     public function setEntityPermission(string $permission): self
  368.     {
  369.         $this->dto->setEntityPermission($permission);
  371.         return $this;
  372.     }
  374.     public function renderContentMaximized(bool $maximized = true): self
  375.     {
  376.         $this->dto->setContentWidth($maximized ? self::LAYOUT_CONTENT_FULL : self::LAYOUT_CONTENT_DEFAULT);
  378.         return $this;
  379.     }
  381.     public function renderSidebarMinimized(bool $minimized = true): self
  382.     {
  383.         $this->dto->setSidebarWidth($minimized ? self::LAYOUT_SIDEBAR_COMPACT : self::LAYOUT_SIDEBAR_DEFAULT);
  385.         return $this;
  386.     }
  388.     public function getAsDto(): CrudDto
  389.     {
  390.         $this->dto->setPaginator(new PaginatorDto($this->paginatorPageSize, $this->paginatorRangeSize, 1, $this->paginatorFetchJoinCollection, $this->paginatorUseOutputWalkers));
  392.         return $this->dto;
  393.     }
  395.     private function getValidPageNames(): array
  396.     {
  397.         return [self::PAGE_DETAIL, self::PAGE_EDIT, self::PAGE_INDEX, self::PAGE_NEW];
  398.     }
  399. }