search

sonata-project / SonataAdminBundle

The missing Symfony Admin Generator
https://docs.sonata-project.org/projects/SonataAdminBundle
MIT License
2.11k stars 1.26k forks source link

Sonata 4.0.0-alpha-1 / How to set datetime format for exports? #7105

Closed virtualize closed 3 years ago

virtualize commented 3 years ago

Environment

Sonata packages

show

``` $ composer show --latest 'sonata-project/*' sonata-project/admin-bundle 4.0.0-alpha-1 3.97.0 The missing Symfony Admin Generator sonata-project/block-bundle 4.5.3 4.5.3 Symfony SonataBlockBundle sonata-project/cache 2.1.1 2.1.1 Cache library sonata-project/doctrine-extensions 1.12.0 1.12.0 Doctrine2 behavioral extensions sonata-project/doctrine-orm-admin-bundle 4.0.0-alpha-1 3.33.0 Integrate Doctrine ORM into the SonataAdminBundle sonata-project/exporter 2.6.2 2.6.2 Lightweight Exporter library sonata-project/form-extensions 1.9.0 1.9.0 Symfony form extensions sonata-project/twig-extensions 1.5.1 1.5.1 Sonata twig extensions ```

Symfony packages

show

``` $ composer show --latest 'symfony/*' symfony/apache-pack v1.0.1 v1.0.1 A pack for Apache support in Symfony symfony/asset v4.4.20 v5.2.4 Manages URL generation and versioning of web assets such as CSS stylesheets, JavaScript files and image files symfony/browser-kit v4.4.20 v5.2.4 Simulates the behavior of a web browser, allowing you to make requests, click on links and submit forms programmatically symfony/cache v4.4.21 v5.2.6 Provides an extended PSR-6, PSR-16 (and tags) implementation symfony/cache-contracts v2.4.0 v2.4.0 Generic abstractions related to caching symfony/config v4.4.20 v5.2.4 Helps you find, load, combine, autofill and validate configuration values of any kind symfony/console v4.4.21 v5.2.6 Eases the creation of beautiful and testable command line interfaces symfony/css-selector v4.4.20 v5.2.4 Converts CSS selectors to XPath expressions symfony/debug v4.4.20 v4.4.20 Provides tools to ease debugging PHP code symfony/debug-bundle v4.4.20 v5.2.4 Provides a tight integration of the Symfony Debug component into the Symfony full-stack framework symfony/debug-pack v1.0.9 v1.0.9 A debug pack for Symfony projects symfony/dependency-injection v4.4.21 v5.2.6 Allows you to standardize and centralize the way objects are constructed in your application symfony/deprecation-contracts v2.4.0 v2.4.0 A generic function and convention to trigger deprecation notices symfony/doctrine-bridge v4.4.21 v5.2.6 Provides integration for Doctrine with various Symfony components symfony/dom-crawler v4.4.20 v5.2.4 Eases DOM navigation for HTML and XML documents symfony/dotenv v4.4.20 v5.2.4 Registers environment variables from a .env file symfony/error-handler v4.4.21 v5.2.6 Provides tools to manage errors and ease debugging PHP code symfony/event-dispatcher v4.4.20 v5.2.4 Provides tools that allow your application components to communicate with each other by dispatching events and listening to them symfony/event-dispatcher-contracts v1.1.9 v2.4.0 Generic abstractions related to dispatching event symfony/expression-language v4.4.20 v5.2.4 Provides an engine that can compile and evaluate expressions symfony/filesystem v4.4.21 v5.2.6 Provides basic utilities for the filesystem symfony/finder v4.4.20 v5.2.4 Finds files and directories via an intuitive fluent interface symfony/flex v1.12.2 v1.12.2 Composer plugin for Symfony symfony/form v4.4.21 v5.2.6 Allows to easily create, process and reuse HTML forms symfony/framework-bundle v4.4.21 v5.2.6 Provides a tight integration between Symfony components and the Symfony full-stack framework symfony/google-mailer v4.4.20 v5.2.4 Symfony Google Mailer Bridge symfony/http-client v4.4.21 v5.2.6 Provides powerful methods to fetch HTTP resources synchronously or asynchronously symfony/http-client-contracts v2.4.0 v2.4.0 Generic abstractions related to HTTP clients symfony/http-foundation v4.4.20 v5.2.4 Defines an object-oriented layer for the HTTP specification symfony/http-kernel v4.4.21 v5.2.6 Provides a structured process for converting a Request into a Response symfony/inflector v4.4.21 v5.2.6 Converts words between their singular and plural forms (English only) symfony/intl v4.4.20 v5.2.4 Provides a PHP replacement layer for the C intl extension that includes additional data from the ICU library symfony/mailer v4.4.21 v5.2.6 Helps sending emails symfony/maker-bundle v1.30.2 v1.30.2 Symfony Maker helps you create empty commands, controllers, form classes, tests and more so you can forget about writing boilerplate ... symfony/messenger v4.4.21 v5.2.5 Helps applications send and receive messages to/from other applications or via message queues symfony/mime v4.4.21 v5.2.6 Allows manipulating MIME messages symfony/monolog-bridge v4.4.21 v5.2.5 Provides integration for Monolog with various Symfony components symfony/monolog-bundle v3.7.0 v3.7.0 Symfony MonologBundle symfony/options-resolver v4.4.20 v5.2.4 Provides an improved replacement for the array_replace PHP function symfony/phpunit-bridge v5.2.6 v5.2.6 Provides utilities for PHPUnit, especially user deprecation notices management symfony/polyfill-intl-grapheme v1.22.1 v1.22.1 Symfony polyfill for intl's grapheme_* functions symfony/polyfill-intl-icu v1.22.1 v1.22.1 Symfony polyfill for intl's ICU-related data and classes symfony/polyfill-intl-idn v1.22.1 v1.22.1 Symfony polyfill for intl's idn_to_ascii and idn_to_utf8 functions symfony/polyfill-intl-normalizer v1.22.1 v1.22.1 Symfony polyfill for intl's Normalizer class and related functions symfony/polyfill-php70 v1.20.0 v1.20.0 Symfony polyfill backporting some PHP 7.0+ features to lower PHP versions symfony/polyfill-php73 v1.22.1 v1.22.1 Symfony polyfill backporting some PHP 7.3+ features to lower PHP versions symfony/polyfill-php80 v1.22.1 v1.22.1 Symfony polyfill backporting some PHP 8.0+ features to lower PHP versions symfony/process v4.4.20 v5.2.4 Executes commands in sub-processes symfony/profiler-pack v1.0.5 v1.0.5 A pack for the Symfony web profiler symfony/property-access v4.4.20 v5.2.4 Provides functions to read and write from/to an object or array using a simple string notation symfony/property-info v4.4.20 v5.2.4 Extracts information about PHP class' properties using metadata of popular sources symfony/routing v4.4.20 v5.2.6 Maps an HTTP request to a set of configuration variables symfony/security-acl v3.1.1 v3.1.1 Symfony Security Component - ACL (Access Control List) symfony/security-bundle v4.4.21 v5.2.6 Provides a tight integration of the Security component into the Symfony full-stack framework symfony/security-core v4.4.21 v5.2.6 Symfony Security Component - Core Library symfony/security-csrf v4.4.20 v5.2.4 Symfony Security Component - CSRF Library symfony/security-guard v4.4.20 v5.2.4 Symfony Security Component - Guard symfony/security-http v4.4.21 v5.2.6 Symfony Security Component - HTTP Integration symfony/serializer v4.4.20 v5.2.4 Handles serializing and deserializing data structures, including object graphs, into array structures or other formats like XML and J... symfony/service-contracts v2.4.0 v2.4.0 Generic abstractions related to writing services symfony/stopwatch v4.4.20 v5.2.4 Provides a way to profile code symfony/string v5.2.6 v5.2.6 Provides an object-oriented API to strings and deals with bytes, UTF-8 code points and grapheme clusters in a unified way symfony/swiftmailer-bundle v3.5.2 v3.5.2 Symfony SwiftmailerBundle symfony/templating v4.4.20 v5.2.4 Provides all the tools needed to build any kind of template system symfony/translation v4.4.21 v5.2.6 Provides tools to internationalize your application symfony/translation-contracts v2.4.0 v2.4.0 Generic abstractions related to translation symfony/twig-bridge v4.4.21 v5.2.6 Provides integration for Twig with various Symfony components symfony/twig-bundle v4.4.20 v5.2.4 Provides a tight integration of Twig into the Symfony full-stack framework symfony/validator v4.4.21 v5.2.6 Provides tools to validate values symfony/var-dumper v4.4.21 v5.2.6 Provides mechanisms for walking through any arbitrary PHP variable symfony/var-exporter v4.4.20 v5.2.4 Allows exporting any serializable PHP data structure to plain PHP code symfony/web-profiler-bundle v4.4.21 v5.2.6 Provides a development tool that gives detailed information about the execution of any request symfony/yaml v4.4.21 v5.2.5 Loads and dumps YAML files ```

PHP version

$ php -v
PHP 7.4.13 (cli) (built: Dec  6 2020 20:43:27) ( NTS )
Copyright (c) The PHP Group
Zend Engine v3.4.0, Copyright (c) Zend Technologies
    with Zend OPcache v7.4.4, Copyright (c), by Zend Technologies
    with blackfire v1.34.0~mac-x64-non_zts74, https://blackfire.io, by Blackfire

Subject

In Sonata v3 we did this

namespace App\Admin;

use Sonata\AdminBundle\Admin\AbstractAdmin;
use Sonata\Exporter\Source\DoctrineORMQuerySourceIterator;

class ProductAdmin extends AbstractAdmin
{
    public function getDataSourceIterator()
    {
        /** @var DoctrineORMQuerySourceIterator $iterator */
        $iterator = parent::getDataSourceIterator();
        $iterator->setDateTimeFormat('Y-m-d H:i:s');
        return $iterator;
    }

But in Sonata 4 getDataSourceIterator() is declared final in AbstractAdmin which we're extending from.

What is the (new) suggested way to set the export datetime format? Is there one?

VincentLanglet commented 3 years ago

You can write your own DataSource, https://github.com/sonata-project/SonataDoctrineORMAdminBundle/blob/master/src/Exporter/DataSource.php#L22

And using instead of the default own provided. There is some documentation about how to do this. And I'll provide a global option in https://github.com/sonata-project/SonataAdminBundle/pull/7077

virtualize commented 3 years ago

Thanks. What I've done and works so far, is decorating the default DataSource with my own:

namespace App\Service\Admin;

use Sonata\AdminBundle\Datagrid\ProxyQueryInterface;
use Sonata\AdminBundle\Exporter\DataSourceInterface;
use Sonata\DoctrineORMAdminBundle\Exporter\DataSource;
use Sonata\Exporter\Source\DoctrineORMQuerySourceIterator;
use Sonata\Exporter\Source\SourceIteratorInterface;

class DecoratingDataSource implements DataSourceInterface
{
    private DataSource $dataSource;

    public function __construct(DataSource $dataSource)
    {
        $this->dataSource = $dataSource;
    }

    public function createIterator(ProxyQueryInterface $query, array $fields): SourceIteratorInterface
    {
        /** @var DoctrineORMQuerySourceIterator $iterator */
        $iterator = $this->dataSource->createIterator($query, $fields);
        $iterator->setDateTimeFormat('Y-m-d H:i:s');

        return $iterator;
    }
}
# config/services.yaml
services:
    ...
    App\Service\Admin\DecoratingDataSource:
        decorates: 'sonata.admin.data_source.orm'

@VincentLanglet do you think this is worth documenting somewhere or do you want to wait for #7077?

VincentLanglet commented 3 years ago

This is a nice way to do it. I think it should be documented indeed, in the doctrine orm admin documentation.