add documentation for global batch actions
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful

This commit is contained in:
Simon Vieille 2023-10-12 16:05:19 +02:00
commit 5142ac39ab
Signed by: deblan
GPG key ID: 579388D585F70417

View file

@ -307,3 +307,33 @@ $configuration->setBatchAction(
}
);
```
## setGlobalBatchAction
`setGlobalBatchAction(string $context, string $action, string $label, callable $callack)`
Add a global batch action. The callback has 3 arguments:
* An instance of `App\Core\Repository\RepositoryQuery`
* An instance of `App\Core\Manager\EntityManager`
* An array of selected entities or a `null` value
Do not use the same action in global and classic batch action.
The callback can return a response. If not, the user will be redirect automatically. See the example below:
```php-inline
use App\Core\Entity\EntityInterface;
use App\Core\Manager\EntityManager;
$configuration->setGlobalBatchAction(
'index',
'export_json',
'Export to JSON',
function(RepositoryQuery $query, EntityManager $manager, ?array $selection): ?Response {
$items = $selection ?? $query->find();
return $this->json($items);
}
);
```