-
Notifications
You must be signed in to change notification settings - Fork 58
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adds list form filters
- Loading branch information
Showing
21 changed files
with
723 additions
and
24 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,196 @@ | ||
| <?php | ||
|
|
||
| namespace AlterPHP\EasyAdminExtensionBundle\Configuration; | ||
|
|
||
| use Doctrine\Common\Persistence\ManagerRegistry; | ||
| use Doctrine\ORM\Mapping\ClassMetadataInfo; | ||
| use EasyCorp\Bundle\EasyAdminBundle\Configuration\ConfigPassInterface; | ||
| use EasyCorp\Bundle\EasyAdminBundle\Form\Type\EasyAdminAutocompleteType; | ||
| use Symfony\Bridge\Doctrine\Form\Type\EntityType; | ||
| use Symfony\Component\Form\Extension\Core\Type\ChoiceType; | ||
|
|
||
| /** | ||
| * Guess form types for list form filters. | ||
| */ | ||
| class ListFormFiltersConfigPass implements ConfigPassInterface | ||
| { | ||
| /** @var ManagerRegistry */ | ||
| private $doctrine; | ||
|
|
||
| public function __construct(ManagerRegistry $doctrine) | ||
| { | ||
| $this->doctrine = $doctrine; | ||
| } | ||
|
|
||
| /** | ||
| * @param array $backendConfig | ||
| * | ||
| * @return array | ||
| */ | ||
| public function process(array $backendConfig): array | ||
| { | ||
| if (!isset($backendConfig['entities'])) { | ||
| return $backendConfig; | ||
| } | ||
|
|
||
| foreach ($backendConfig['entities'] as $entityName => $entityConfig) { | ||
| if (!isset($entityConfig['list']['form_filters'])) { | ||
| continue; | ||
| } | ||
|
|
||
| $formFilters = array(); | ||
|
|
||
| foreach ($entityConfig['list']['form_filters'] as $i => $formFilter) { | ||
| // Detects invalid config node | ||
| if (!is_string($formFilter) && !is_array($formFilter)) { | ||
| throw new \RuntimeException( | ||
| sprintf( | ||
| 'The values of the "form_filters" option for the list view of the "%s" entity can only be strings or arrays.', | ||
| $entityConfig['class'] | ||
| ) | ||
| ); | ||
| } | ||
|
|
||
| // Key mapping | ||
| if (is_string($formFilter)) { | ||
| $filterConfig = array('property' => $formFilter); | ||
| } else { | ||
| if (!array_key_exists('property', $formFilter)) { | ||
| throw new \RuntimeException( | ||
| sprintf( | ||
| 'One of the values of the "form_filters" option for the "list" view of the "%s" entity does not define the mandatory option "property".', | ||
| $entityConfig['class'] | ||
| ) | ||
| ); | ||
| } | ||
|
|
||
| $filterConfig = $formFilter; | ||
| } | ||
|
|
||
| $this->configureFilter($entityConfig['class'], $filterConfig); | ||
|
|
||
| // If type is not configured at this steps => not guessable | ||
| if (!isset($filterConfig['type'])) { | ||
| continue; | ||
| } | ||
|
|
||
| $formFilters[$filterConfig['property']] = $filterConfig; | ||
| } | ||
|
|
||
| // set form filters config and form ! | ||
| $backendConfig['entities'][$entityName]['list']['form_filters'] = $formFilters; | ||
| } | ||
|
|
||
| return $backendConfig; | ||
| } | ||
|
|
||
| private function configureFilter(string $entityClass, array &$filterConfig) | ||
| { | ||
| // No need to guess type | ||
| if (isset($filterConfig['type'])) { | ||
| return; | ||
| } | ||
|
|
||
| $em = $this->doctrine->getManagerForClass($entityClass); | ||
| $entityMetadata = $em->getMetadataFactory()->getMetadataFor($entityClass); | ||
|
|
||
| // Not able to guess type | ||
| if ( | ||
| !$entityMetadata->hasField($filterConfig['property']) | ||
| && !$entityMetadata->hasAssociation($filterConfig['property']) | ||
| ) { | ||
| return; | ||
| } | ||
|
|
||
| if ($entityMetadata->hasField($filterConfig['property'])) { | ||
| $this->configureFieldFilter( | ||
| $entityClass, $entityMetadata->getFieldMapping($filterConfig['property']), $filterConfig | ||
| ); | ||
| } elseif ($entityMetadata->hasAssociation($filterConfig['property'])) { | ||
| $this->configureAssociationFilter( | ||
| $entityClass, $entityMetadata->getAssociationMapping($filterConfig['property']), $filterConfig | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| private function configureFieldFilter(string $entityClass, array $fieldMapping, array &$filterConfig) | ||
| { | ||
| switch ($fieldMapping['type']) { | ||
| case 'boolean': | ||
| $filterConfig['type'] = ChoiceType::class; | ||
| $defaultFilterConfigTypeOptions = array( | ||
| 'choices' => array( | ||
| 'list_form_filters.default.boolean.true' => true, | ||
| 'list_form_filters.default.boolean.false' => false, | ||
| ), | ||
| 'choice_translation_domain' => 'EasyAdminBundle', | ||
| ); | ||
| break; | ||
| case 'string': | ||
| $filterConfig['type'] = ChoiceType::class; | ||
| $defaultFilterConfigTypeOptions = array( | ||
| 'multiple' => true, | ||
| 'choices' => $this->getChoiceList($entityClass, $filterConfig['property'], $filterConfig), | ||
| 'attr' => array('data-widget' => 'select2'), | ||
| ); | ||
| break; | ||
| default: | ||
| return; | ||
| } | ||
|
|
||
| // Merge default type options when defined | ||
| if (isset($defaultFilterConfigTypeOptions)) { | ||
| $filterConfig['type_options'] = array_merge( | ||
| $defaultFilterConfigTypeOptions, | ||
| isset($filterConfig['type_options']) ? $filterConfig['type_options'] : array() | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| private function configureAssociationFilter(string $entityClass, array $associationMapping, array &$filterConfig) | ||
| { | ||
| // To-One (EasyAdminAutocompleteType) | ||
| if ($associationMapping['type'] & ClassMetadataInfo::TO_ONE) { | ||
| $filterConfig['type'] = EasyAdminAutocompleteType::class; | ||
| $filterConfig['type_options'] = array_merge( | ||
| array( | ||
| 'class' => $associationMapping['targetEntity'], | ||
| 'multiple' => true, | ||
| 'attr' => array('data-widget' => 'select2'), | ||
| ), | ||
| isset($filterConfig['type_options']) ? $filterConfig['type_options'] : array() | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| private function getChoiceList(string $entityClass, string $property, array &$filterConfig) | ||
| { | ||
| if (isset($filterConfig['type_options']['choices'])) { | ||
| $choices = $filterConfig['type_options']['choices']; | ||
| unset($filterConfig['type_options']['choices']); | ||
|
|
||
| return $choices; | ||
| } | ||
|
|
||
| if (!isset($filterConfig['type_options']['choices_static_callback'])) { | ||
| throw new \RuntimeException( | ||
| sprintf( | ||
| 'Choice filter field "%s" for entity "%s" must provide either a static callback method returning choice list or choices option.', | ||
| $property, | ||
| $entityClass | ||
| ) | ||
| ); | ||
| } | ||
|
|
||
| $callableParams = array(); | ||
| if (is_string($filterConfig['type_options']['choices_static_callback'])) { | ||
| $callable = array($entityClass, $filterConfig['type_options']['choices_static_callback']); | ||
| } else { | ||
| $callable = array($entityClass, $filterConfig['type_options']['choices_static_callback'][0]); | ||
| $callableParams = $filterConfig['type_options']['choices_static_callback'][1]; | ||
| } | ||
| unset($filterConfig['type_options']['choices_static_callback']); | ||
|
|
||
| return forward_static_call_array($callable, $callableParams); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.