mirror of
https://gitlab.com/Chill-Projet/chill-bundles.git
synced 2025-06-12 13:24:25 +00:00
60 lines
2.3 KiB
PHP
60 lines
2.3 KiB
PHP
<?php
|
|
|
|
/*
|
|
* Copyright (C) 2015 Champs-Libres <info@champs-libres.coop>
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Affero General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Affero General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Affero General Public License
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
namespace Chill\MainBundle\Export;
|
|
|
|
use Symfony\Component\Form\FormBuilderInterface;
|
|
|
|
/**
|
|
*
|
|
* @author Julien Fastré <julien.fastre@champs-libres.coop>
|
|
*/
|
|
interface FormatterInterface
|
|
{
|
|
const TYPE_TABULAR = 'tabular';
|
|
|
|
public function getType();
|
|
|
|
public function getName();
|
|
|
|
/**
|
|
* build a form, which will be used to collect data required for the execution
|
|
* of this formatter.
|
|
*
|
|
* @uses appendAggregatorForm
|
|
* @param FormBuilderInterface $builder
|
|
* @param type $exportAlias
|
|
* @param array $aggregatorAliases
|
|
*/
|
|
public function buildForm(FormBuilderInterface $builder, $exportAlias, array $aggregatorAliases);
|
|
|
|
/**
|
|
* Generate a response from the data collected on differents ExportElementInterface
|
|
*
|
|
* @param mixed[] $result The result, as given by the ExportInterface
|
|
* @param mixed[] $data collected from the current form
|
|
* @param \Chill\MainBundle\Export\ExportInterface $export the export which is executing
|
|
* @param \Chill\MainBundle\Export\FilterInterface[] $filters the filters applying on the export. The key will be filters aliases, and the values will be filter's data (from their own form)
|
|
* @param \Chill\MainBundle\Export\AggregatorInterface[] $aggregators the aggregators applying on the export. The key will be aggregators aliases, and the values will be aggregator's data (from their own form)
|
|
*/
|
|
public function getResponse($result, $formatterData, $exportAlias, array $exportData, array $filtersData,
|
|
array $aggregatorsData);
|
|
|
|
}
|