Exporter Bundle

You can easily export your data to pdf or excel format.

Documentation

• Getting started
  • Prerequisites
  • Installation
  • Configuration
  • Usage
• Advanced Configuration
  • Custom filename
  • Custom twig template
  • Custom Exporter Class
    • Advanced filename
    • Add headers
    • Access Query Builder
    • Manage Filters (Extensions)
  • Custom Driver
  • Normalizer

Getting started

Prerequisites

This bundle requires Symfony 5.0+ and api platform.

Installation

$ composer require 90pixel/exporter-bundle

Register bundle

You can skip this step if you're using flex.

return [
    //...
    DPX\ExporterBundle\ExporterBundle::class => ['all' => true],
];

Configuration

Add custom collection operation in your entity.

/**
 * @ApiResource(
 *     collectionOperations={
 *          "get",
 *          "export"={
 *              "method"="GET",
 *              "path"="/products/export"
 *          }
 *     }
 * )
 * ...
 */

then register your custom operation.

Xlsx

/**
 * ...
 * @ExporterConfig(
 *     operationName="export",
 *     headers={"ID", "Product", "Barcode", "Price"},
 * )
 * ...
 */

Pdf

/**
 * ...
 * @ExporterConfig(
 *     operationName="export",
 *     driver="dpx.exporter.driver.pdf",
 *     headers={"ID", "Product", "Barcode", "Price"},
 * )
 * ...
 */

Usage

Go to http://localhost/api/products/export

If it works, a file named export.xlsx will download.

Also you can customize filename. For advanced usage, please see advanced configuration section.

Advanced Configuration

Custom Filename

/**
 * ...
 * @ExporterConfig(
 *     operationName="export",
 *     filename="products.xlsx"
 * )
 * ...
 */

For more advanced filename, please see advanced filename section.

Custom Twig Template

You can customize pdf style easily with your own twig template.

/**
 * ...
 * @ExporterConfig(
 *     operationName="export",
 *     templateName="pdf/products.html.twig"
 * )
 * ...
 */

Custom Exporter Class

You can customize few things easily with custom exporter class.

Generate exporter class.

<?php
// src/Exporter/ProductExporter.php

namespace App\Exporter;

class ProductExporter extends ExporterHelper
{
}

Advanced filename

<?php
// src/Exporter/ProductExporter.php

namespace App\Exporter;

class ProductExporter extends ExporterHelper
{
    /**
     * @return string
     */
    public function getFileName(): string
    {
        return sprintf('products-%s.xlsx', date('Y')); // products-2021.xlsx
    }
}

Add headers

<?php
// src/Exporter/ProductExporter.php

namespace App\Exporter;

class ProductExporter extends ExporterHelper
{
    public $headers = [
        'ID',
        'Product Name',
        'Barcode',
        'Price',
    ];
}

or

<?php
// src/Exporter/ProductExporter.php

namespace App\Exporter;

use DPX\ExporterBundle\Manager\ExporterManager;

class ProductExporter extends ExporterHelper
{
    /**
     * @var ExporterManager
     */
    private $exporterManager;
    
    public function __construct(ExporterManager $exporterManager)
    {
        $this->exporterManager = $exporterManager;
    }
     
    /**
     * @return array
     */
    public function getHeaders(): array
    {
        $isDiscount = $this->exporterManager->getRequest()->get('discount') === 'true';
        return [
            'ID',
            'Product',
            'Barcode',
            $isDiscount ? 'Discount' : 'Price'
        ];
    }
}

Access Query Builder

<?php
// src/Exporter/ProductExporter.php

namespace App\Exporter;

class ProductExporter extends ExporterHelper
{
    // ...
    
    /**
     * @param QueryBuilder $queryBuilder
     * @param string $alias
     */
    public function builder(QueryBuilder $queryBuilder, string $alias)
    {
        // Customize query
    }
}

Manage Filters (Extensions)

Sometimes you want to enable some extensions for your export. You can easily define which extensions will be enabled.

Note: API platform query filters are enabled by default.

<?php
// src/Exporter/ProductExporter.php

namespace App\Exporter;

class ProductExporter extends ExporterHelper
{
    // ...
    
    /**
     * @return string[]
     */
    public function filters(): array
    {
        return [
            FilterExtension::class,
            MyCustomExtension::class
        ];
    }
}

Custom Driver

You can expand output support with custom drivers. For example, if you want to output .jpg, this section is for you.

The custom driver should look like this.

<?php

namespace App\Driver;

use DPX\ExporterBundle\Helper\DriverHelper;
use Symfony\Component\HttpFoundation\Response;

class JpgDriver extends DriverHelper
{
    public function handle($data): Response
    {
        // The magic must happen here.
    }
}

Normalizer

<?php
// src/Serializer/Normalizer/ProductNormalizer.php

namespace App\Serializer\Normalizer;

use App\Entity\Product;
use NumberFormatter;
use Symfony\Component\Serializer\Normalizer\CacheableSupportsMethodInterface;
use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
use Symfony\Component\Serializer\Normalizer\ObjectNormalizer;

class ProductNormalizer implements NormalizerInterface, CacheableSupportsMethodInterface
{
    private $normalizer;

    public function __construct(ObjectNormalizer $normalizer)
    {
        $this->normalizer = $normalizer;
    }

    public function normalize($object, $format = null, array $context = []): array
    {
        $data = $this->normalizer->normalize($object, $format, $context);
        
        $formatter = new NumberFormatter('en_GB',  NumberFormatter::CURRENCY);
        $price = $formatter->formatCurrency($object->getPrice(), 'EUR');

        $data['price'] = $price;

        return $data;
    }

    public function supportsNormalization($data, $format = null): bool
    {
        return $data instanceof Product;
    }

    public function hasCacheableSupportsMethod(): bool
    {
        return true;
    }
}

Author

Muhep Atasoy

License

This project is licensed under the MIT License - see the LICENSE file for details