A Global "Export" Action

Hey GonzaloAlonsoD,

Thank you for sharing this code snippet! Could you also add a bit more context to it? :)

Cheers!

Hola Victor, si claro.
Con el código que adjunte, reutilizo los servicios en lugar de agregar el constructor como en el ejemplo:

-- en:

Hi Victor, yes of course.
With the code I attached, I reuse the services instead of adding the constructor like in the example:

    private AdminUrlGenerator $adminUrlGenerator;
    private RequestStack $requestStack;

    public function __construct(AdminUrlGenerator $adminUrlGenerator, RequestStack $requestStack)
    {
        $this->adminUrlGenerator = $adminUrlGenerator;
        $this->requestStack = $requestStack;
    }

Hey GonzaloAlonsoD,

I see! Yeah, another possible solution, thanks for sharing :)

Cheers!

Hey Lechu,

The get() method belongs to the container property, not the controller itself. Try doing this $this->container->get(...);

Cheers!

Hey @Txurdi!

Sorry for the VERY slow reply. This was a tricky question, but fun to figure out. Out goal is, basically, to make a CSV export that looks exactly like what the user sees on the screen: same fields and same values. Here's the solution. The only caveat is that, because we're fully-hydrating entity objects, this won't work with large data sets (even the previous solution would need extra work to function with large data):

First, CsvExporter:

namespace App\Service;

use Doctrine\ORM\QueryBuilder;
use EasyCorp\Bundle\EasyAdminBundle\Collection\FieldCollection;
use EasyCorp\Bundle\EasyAdminBundle\Config\Crud;
use EasyCorp\Bundle\EasyAdminBundle\Dto\EntityDto;
use EasyCorp\Bundle\EasyAdminBundle\Dto\FieldDto;
use EasyCorp\Bundle\EasyAdminBundle\Factory\EntityFactory;
use Goodby\CSV\Export\Standard\Exporter;
use Goodby\CSV\Export\Standard\ExporterConfig;
use Symfony\Component\HttpFoundation\HeaderUtils;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpFoundation\StreamedResponse;
use Symfony\Component\PropertyAccess\PropertyAccessorInterface;

class CsvExporter
{
    public function __construct(private EntityFactory $entityFactory)
    {
    }

    public function createResponseFromQueryBuilder(QueryBuilder $queryBuilder, FieldCollection $fields, EntityDto $entityDto, string $filename): Response
    {
        $results = $queryBuilder->getQuery()->getResult();
        $entityDtos = $this->entityFactory->createCollection($entityDto, $results);
        $this->entityFactory->processFieldsForAll($entityDtos, $fields);

        /** @var FieldDto[] $fields */
        $firstEntity = $entityDtos[$results[0]->getId()];
        $headers = array_map(fn($fieldDto) => $fieldDto->getLabel(), iterator_to_array($firstEntity->getFields()));

        $data = [$headers];

        foreach ($entityDtos as $index => $entityDto) {
            foreach ($entityDto->getFields() as $fieldDto) {
                // templates might include things like   - so decode those
                $data[$index][] = html_entity_decode($fieldDto->getFormattedValue());
            }
        }

        // everything below is the same as before
        $response = new StreamedResponse(function () use ($data) {
            $config = new ExporterConfig();
            $exporter = new Exporter($config);
            $exporter->export('php://output', $data);
        });
        $dispositionHeader = $response->headers->makeDisposition(
            HeaderUtils::DISPOSITION_ATTACHMENT,
            $filename
        );
        $response->headers->set('Content-Disposition', $dispositionHeader);
        $response->headers->set('Content-Type', 'text/csv; charset=utf-8');

        return $response;
    }
}

We now query for entity objects. THEN we process those through the EntityFactory in the same way that EasyAdmin does when rendering the index page. This allows us to reuse all of its normal logic for getting the value of a field.

The export() controller action only changes slightly:

public function export(AdminContext $context, CsvExporter $csvExporter)
{
    $fields = FieldCollection::new($this->configureFields(Crud::PAGE_INDEX));
    $filters = $this->container->get(FilterFactory::class)->create($context->getCrud()->getFiltersConfig(), $fields, $context->getEntity());
    $queryBuilder = $this->createIndexQueryBuilder($context->getSearch(), $context->getEntity(), $fields, $filters);

    // NEW THING 1
    // set this to "trick" the fields in the exporter to only use fields for the index page
    $context->getCrud()->setPageName(Crud::PAGE_INDEX);

    return $csvExporter->createResponseFromQueryBuilder(
        $queryBuilder,
        $fields,
        // NEW THING 2
        $context->getEntity(),
        'questions.csv'
    );
}

There are only 2 new things here, both marked. The first helps "trick" the EntityFactory so that when it's processing the fields, it correctly only shows the fields that appear on PAGE_INDEX. The second thing is where we pass a, sort of, empty EntityDto instance that represents the current entity into the CsvExporter. This is, inside of CsvExporter, needed so that EntityFactory can work its magic.

Try it out and let me know what you think - I really like this solution!

Cheers!

Yes, thank you so much for this! I ran into a new issue with collection fields being truncated to 32 characters in the CSV file, which I didn't want. I got around that by adding

$context->getCrud()->setCurrentAction(Action::DETAIL);

to the export() controller action to trick the formatCollection() method into truncating at 512 characters instead of 32. There's probably a better way to accomplish that...

I've had to deal with a few tricky fields where the formatted value was not correct in the csv. If you know the property name of the tricky field, you can just add a conditional like this within the fieldDto loop.
Then instead of getFormattedValue(), you use getValue() and customize the formatting.

if ($fieldDto->getProperty() == 'notes'){
    $csvValue = $fieldDto->getValue()
    // do something with csv value
    $data[$index][] = $csvValue
}

Ah good catch and nice solution! I'm not sure if there's a better solution or not - in this newer version of the code, we're purposely rendering all of the fields exactly like EasyAdmin would render them, including truncating. So, changing to DETAIL mode is an interesting work around. Otherwise, all I can think to do would be to add custom code into CsvExporter that would avoid using ->getFormattedValue() for just some fields... but that sounds a little yucky.

Cheers!

Thank you very much!
It's working like a charm!

Hey Colin,

That's a good question. You could create your own CSV exporter service by leveraging the Serializer component, but you would end up reinventing the wheel. The Goodby-csv library seems to be pretty good managing memory and has a few other convenient features. You can give it a check here https://github.com/handcraftedinthealps/goodby-csv

Cheers!

Hi Sergey-P!

As far as I can tell, no. The attributes that trigger that modal are built into the batch system - https://github.com/EasyCorp/EasyAdminBundle/blob/c0bde19c9ec3ee97e379b1c9f7d6d99e253eb7cf/src/Factory/ActionFactory.php#L147-L156 and the actual code that submits the batch actions form is built into the "submit" button on that modal - https://github.com/EasyCorp/EasyAdminBundle/blob/c0bde19c9ec3ee97e379b1c9f7d6d99e253eb7cf/assets/js/app.js#L291-L318

So, pretty sure the confirmation is required.. unless you did some serious craziness with JavaScript where you try to "undo" the modal and reimplement the form submit manually.

Cheers!

thank <3

Thanks for posting that Tien dat L.! I'm not surprised that our custom logic was a bit limited: it worked for our use-case, but obviously wasn't tested for JSON fields!

Cheers!

fixed in configureActions() in
update(Crud::PAGE_INDEX, ACTION::DELETE, static function (Action $action) {
$action->displayIF() {};

add return $action;
}

pls update in Source code Finish

Hey Tien dat L.!

Sorry about that! You are 100% correct! I do this correctly in the video - https://symfonycasts.com/sc... - but the code got out of sync! I'm fixing that right now. I appreciate you mentioning it!

Cheers!

I had the same error for an entity and it was because it had a json array type property (User::roles).

I feel like the service can't handle this kind of property

I know you're already seen it Fabrice, but for others, @kiuega posted a nice solution for this problem! https://symfonycasts.com/sc...

Hi weaverryan thank, i have other question,
now dql like " SELECT entity FROM App\Entity\Question entity " how can i custom export fields like
" SELECT id, name, slug FROM App\Entity\Question entity "

Hey Tien dat L.!

It sounds like you want to export different fields that what is exporting currently, correct? Right now, the export exports every field on Question. That's what the "SELECT entity" means: it says "grab ALL the data from the Question" entity. Then, we loop over that in CsvExporter and export everything.

If you want to only export a sub-set of fields, you could modify the query builder to only select those:

$queryBuilder->select('entity.id, entity.name');

You could put that in your code right BEFORE you pass the $queryBuilder to CsvExporter. This will change the query to only return some fields... and then the exporter will only export those fields.

Cheers!

weaverryan thanks

Hi @Ryan and @Victor

Thanks for sharing this useful feature.
I am using easy-admin and leagueCsv bundle in one of project so i have tried to make it works with league instead of Goodby here's a gist :
https://gist.github.com/lwillems/bdb662b58a0a48bc4b0d91a28434c6ad
I was wondering when you are calling :
$result = $queryBuilder->getQuery()->getArrayResult();
Full dataset is loaded into memory ? whould it works with huge collection of entities ? to improve memory usage i have tried to use toIterable() instead, the negative side is the usage of 1 more query to get headers WDYT ?

Regards

Hey Laurent!

I am using easy-admin and leagueCsv bundle in one of project so i have tried to make it works with league instead of Goodby here's a gist :

Awesome! Thank you for posting that!

I was wondering when you are calling :
$result = $queryBuilder->getQuery()->getArrayResult();
Full dataset is loaded into memory ? whould it works with huge collection of entities ? to improve memory usage i have tried > to use toIterable() instead, the negative side is the usage of 1 more query to get headers WDYT ?

You're absolutely correct - the way we wrote the code doesn't work with a huge data set. Huge datasets are definitely more complex :). Does simply changing to toIterable() help? I would have thought that this still would load everything into memory - it would still have one huge query to get all the data (which it would then need to store in memory). But perhaps I'm wrong and toIterable() helps?

Cheers!

Use $this->container->get(FilterFactory::class)

Good catch on that! I was blindly copying and pasting - I should have noticed that!

The full story: in Symfony 6, the $this->get() was removed. It's not normally something you should use at all anymore. But for (good) technical reasons, EasyAdmin still grabs things directly out of a container (technically a "service locator"). Anyways, $this->get() was a shortcut for $this->container->get(), which is why the fix shared by Fabrice works. On the latest EasyAdmin (both v3 and v4), the code has already been refactored to use $this->container->get(). We used just an old enough EasyAdmin in this tutorial to still have the old code :). Oh, and your solution of autowiring FilterFactory is also AWESOME - very clever solution!

Side note: this IS correct in the video (I was using a new enough version of EasyAdmin), but wrong in the code (which was using a slightly older version). I'm fixing that right now thanks to these comments!

And thanks for posting your improvement to CsvExporter!

Cheers!

Hey Kiuega,

Thank you for your feedback about this feature. IIRC the bundle has/had an opened issue about it, but it requires a complex implementation and may have some edge cases with the other existent features... so it was a low-priority feature because of this. Feel free to find a related issue about it to get more info, and if the issue is still releveant and wasn't closed for some reasons I'm not aware of - please, feel free to submit a PR! It might be so that maintainers just do not have enough time to work on this feature.

Cheers!

Hey Lubna

I see it's really necessary for you, I can't just share it here, but if you have access to downloaded code, you can look into the finish/ directory from course code archive

Cheers!

Thanks, I downloaded it!

Hi again! Sorry if I am bothering you. I would be thankful and grateful if you could please save my career by launching this tutorial. My manger asked me again to add this feature and it still does not work with me. :'( :'(

Hey Lubna

I'm afraid this video will be released within a few days. There isn't much I can do, but you can download the source code as Vladimir said, and since there is the script content released already, you can follow it along. I hope it helps

Cheers!

Thanks! no worries if I lost my current job I will apply for a new one at SensioLabs.