Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
n/a
0 / 0
n/a
0 / 0
CRAP
n/a
0 / 0
1<?php
2
3/**
4 * This file is part of the MADIS - RGPD Management application.
5 *
6 * @copyright Copyright (c) 2018-2019 Soluris - Solutions Numériques Territoriales Innovantes
7 *
8 * This program is free software: you can redistribute it and/or modify
9 * it under the terms of the GNU Affero General Public License as published by
10 * the Free Software Foundation, either version 3 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU Affero General Public License for more details.
17 *
18 * You should have received a copy of the GNU Affero General Public License
19 * along with this program. If not, see <https://www.gnu.org/licenses/>.
20 */
21
22declare(strict_types=1);
23
24namespace App\Domain\Reporting\Generator\Word;
25
26use PhpOffice\PhpWord\PhpWord;
27use Symfony\Component\HttpFoundation\BinaryFileResponse;
28
29interface GeneratorInterface
30{
31    public const DATE_FORMAT      = 'd/m/Y';
32    public const DATE_TIME_FORMAT = 'd/m/Y à H:i';
33    public const DATE_TIME_ZONE   = 'Europe/Paris';
34
35    public const TABLE_ORIENTATION_HORIZONTAL = 'horizontal';
36    public const TABLE_ORIENTATION_VERTICAL   = 'vertical';
37
38    /**
39     * Initialize the Document
40     * - Configuration
41     * - Default tyle.
42     */
43    public function initializeDocument(PhpWord $document): void;
44
45    /**
46     * Generate the response
47     * - This response parse PhpWord to a Word document
48     * - Prepare it in a BinaryFileResponse.
49     *
50     * @param PhpWord $document     The PhpWord document to use
51     * @param string  $documentName The document name to use
52     *
53     * @return BinaryFileResponse The response
54     */
55    public function generateResponse(PhpWord $document, string $documentName): BinaryFileResponse;
56}