Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Upgrade report bundle to work with Symfony 3 forms #8056

Merged
merged 7 commits into from Dec 13, 2019
Merged

Upgrade report bundle to work with Symfony 3 forms #8056

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
c3d7cb8
Upgrade report bundle to work with Symfony 3 forms
dongilbert Nov 1, 2019
15f51d1
Remove MauticFactory
dongilbert Nov 1, 2019
820864d
Typehint the TranslatorInterface instead
dongilbert Nov 1, 2019
ee3b811
Flip labels with values for choice types
escopecz Dec 13, 2019
6d591b7
Use class names instead of form aliases
escopecz Dec 13, 2019
ed17e4f
This is how a config form should be registered now
escopecz Dec 13, 2019
f048c1d
Merge branch 'm2-to-m3' into GIT-7989.report-bundle-upgrade
escopecz Dec 13, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
18 changes: 6 additions & 12 deletions app/bundles/ReportBundle/Config/config.php
View file
Open in desktop
Expand Up @@ -118,7 +118,6 @@
'forms' => [
'mautic.form.type.reportconfig' => [
'class' => \Mautic\ReportBundle\Form\Type\ConfigType::class,
'alias' => 'reportconfig',
],
'mautic.form.type.report' => [
'class' => \Mautic\ReportBundle\Form\Type\ReportType::class,
Expand All @@ -128,36 +127,31 @@
],
],
'mautic.form.type.filter_selector' => [
'class' => 'Mautic\ReportBundle\Form\Type\FilterSelectorType',
'alias' => 'filter_selector',
'class' => \Mautic\ReportBundle\Form\Type\FilterSelectorType::class,
],
'mautic.form.type.table_order' => [
'class' => 'Mautic\ReportBundle\Form\Type\TableOrderType',
'arguments' => 'mautic.factory',
'alias' => 'table_order',
'class' => \Mautic\ReportBundle\Form\Type\TableOrderType::class,
'arguments' => [
'translator',
],
],
'mautic.form.type.report_filters' => [
'class' => 'Mautic\ReportBundle\Form\Type\ReportFiltersType',
'arguments' => 'mautic.factory',
'alias' => 'report_filters',
],
'mautic.form.type.report_dynamic_filters' => [
'class' => 'Mautic\ReportBundle\Form\Type\DynamicFiltersType',
'alias' => 'report_dynamicfilters',
],
'mautic.form.type.report_widget' => [
'class' => 'Mautic\ReportBundle\Form\Type\ReportWidgetType',
'alias' => 'report_widget',
'arguments' => 'mautic.report.model.report',
],
'mautic.form.type.aggregator' => [
'class' => 'Mautic\ReportBundle\Form\Type\AggregatorType',
'alias' => 'aggregator',
'class' => \Mautic\ReportBundle\Form\Type\AggregatorType::class,
'arguments' => 'translator',
],
'mautic.form.type.report.settings' => [
'class' => \Mautic\ReportBundle\Form\Type\ReportSettingsType::class,
'alias' => 'report_settings',
],
],
'helpers' => [
Expand Down
3 changes: 2 additions & 1 deletion app/bundles/ReportBundle/Controller/ReportController.php
View file
Open in desktop
Expand Up @@ -16,6 +16,7 @@
use Mautic\CoreBundle\Helper\DateTimeHelper;
use Mautic\CoreBundle\Helper\InputHelper;
use Mautic\ReportBundle\Entity\Report;
use Mautic\ReportBundle\Form\Type\DynamicFiltersType;
use Mautic\ReportBundle\Model\ExportResponse;
use Symfony\Component\HttpFoundation;

Expand Down Expand Up @@ -646,7 +647,7 @@ public function viewAction($objectId, $reportPage = 1)
}

$dynamicFilterForm = $this->get('form.factory')->create(
'report_dynamicfilters',
DynamicFiltersType::class,
$filterSettings,
[
'action' => $action,
Expand Down
3 changes: 0 additions & 3 deletions app/bundles/ReportBundle/Entity/Report.php
View file
Open in desktop
Expand Up @@ -24,9 +24,6 @@
use Symfony\Component\Validator\Constraints\NotBlank;
use Symfony\Component\Validator\Mapping\ClassMetadata;

/**
* Class Report.
*/
class Report extends FormEntity implements SchedulerInterface
{
/**
Expand Down
3 changes: 2 additions & 1 deletion app/bundles/ReportBundle/EventListener/DashboardSubscriber.php
View file
Open in desktop
Expand Up @@ -14,6 +14,7 @@
use Mautic\CoreBundle\Security\Permissions\CorePermissions;
use Mautic\DashboardBundle\Event\WidgetDetailEvent;
use Mautic\DashboardBundle\EventListener\DashboardSubscriber as MainDashboardSubscriber;
use Mautic\ReportBundle\Form\Type\ReportWidgetType;
use Mautic\ReportBundle\Model\ReportModel;

class DashboardSubscriber extends MainDashboardSubscriber
Expand Down Expand Up @@ -42,7 +43,7 @@ class DashboardSubscriber extends MainDashboardSubscriber
*/
protected $types = [
'report' => [
'formAlias' => 'report_widget',
'formAlias' => ReportWidgetType::class,
],
];

Expand Down
5 changes: 4 additions & 1 deletion app/bundles/ReportBundle/Form/DataTransformer/ReportFilterDataTransformer.php
View file
Open in desktop
Expand Up @@ -13,6 +13,9 @@

use Mautic\CoreBundle\Helper\DateTimeHelper;
use Symfony\Component\Form\DataTransformerInterface;
use Symfony\Component\Form\Extension\Core\Type\DateTimeType;
use Symfony\Component\Form\Extension\Core\Type\DateType;
use Symfony\Component\Form\Extension\Core\Type\TimeType;

class ReportFilterDataTransformer implements DataTransformerInterface
{
Expand Down Expand Up @@ -46,7 +49,7 @@ public function transform($filters)
return $filters;
}
$type = $this->columns[$f['column']]['type'];
if (in_array($type, ['datetime', 'date', 'time'])) {
if (in_array($type, ['datetime', 'date', 'time', DateTimeType::class, DateType::class, TimeType::class])) {
$dt = new DateTimeHelper($f['value'], '', 'utc');
$f['value'] = $dt->toLocalString();
}
Expand Down
87 changes: 49 additions & 38 deletions app/bundles/ReportBundle/Form/Type/AggregatorType.php
View file
Open in desktop
Expand Up @@ -12,19 +12,21 @@
namespace Mautic\ReportBundle\Form\Type;

use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\Form\FormInterface;
use Symfony\Component\Form\FormView;
use Symfony\Component\OptionsResolver\OptionsResolverInterface;
use Symfony\Component\OptionsResolver\OptionsResolver;
use Symfony\Component\Translation\TranslatorInterface;

/**
* Class AggregatorType.
*/
class AggregatorType extends AbstractType
{
/**
* @var TranslatorInterface
*/
private $translator;

public function __construct($translator)
public function __construct(TranslatorInterface $translator)
{
$this->translator = $translator;
}
Expand All @@ -34,39 +36,48 @@ public function __construct($translator)
*/
public function buildForm(FormBuilderInterface $builder, array $options)
{
// function
$builder->add('function', 'choice', [
'choices' => [
'COUNT' => $this->translator->trans('mautic.report.report.label.aggregators.count'),
'AVG' => $this->translator->trans('mautic.report.report.label.aggregators.avg'),
'SUM' => $this->translator->trans('mautic.report.report.label.aggregators.sum'),
'MIN' => $this->translator->trans('mautic.report.report.label.aggregators.min'),
'MAX' => $this->translator->trans('mautic.report.report.label.aggregators.max'),
],
'expanded' => false,
'multiple' => false,
'label' => 'mautic.report.function',
'label_attr' => ['class' => 'control-label'],
'empty_value' => false,
'required' => false,
'attr' => [
'class' => 'form-control not-chosen',
],
]);
$builder->add(
'function',
ChoiceType::class,
[
'choices_as_values' => true,
'choices' => [
$this->translator->trans('mautic.report.report.label.aggregators.count') => 'COUNT',
$this->translator->trans('mautic.report.report.label.aggregators.avg') => 'AVG',
$this->translator->trans('mautic.report.report.label.aggregators.sum') => 'SUM',
$this->translator->trans('mautic.report.report.label.aggregators.min') => 'MIN',
$this->translator->trans('mautic.report.report.label.aggregators.max') => 'MAX',
],
'expanded' => false,
'multiple' => false,
'label' => 'mautic.report.function',
'label_attr' => ['class' => 'control-label'],
'empty_value' => false,
'required' => false,
'attr' => [
'class' => 'form-control not-chosen',
],
]
);

// Build a list of columns
$builder->add('column', 'choice', [
'choices' => $options['columnList'],
'expanded' => false,
'multiple' => false,
'label' => 'mautic.report.report.label.filtercolumn',
'label_attr' => ['class' => 'control-label'],
'empty_value' => false,
'required' => false,
'attr' => [
'class' => 'form-control filter-columns',
],
]);
$builder->add(
'column',
ChoiceType::class,
[
'choices_as_values' => true,
'choices' => array_flip($options['columnList']),
'expanded' => false,
'multiple' => false,
'label' => 'mautic.report.report.label.filtercolumn',
'label_attr' => ['class' => 'control-label'],
'empty_value' => false,
'required' => false,
'attr' => [
'class' => 'form-control filter-columns',
],
]
);
}

/**
Expand All @@ -82,15 +93,15 @@ public function buildView(FormView $view, FormInterface $form, array $options)
/**
* {@inheritdoc}
*/
public function getName()
public function getBlockPrefix()
{
return 'aggregator';
}

/**
* {@inheritdoc}
*/
public function setDefaultOptions(OptionsResolverInterface $resolver)
public function configureOptions(OptionsResolver $resolver)
{
$resolver->setDefaults([
'columnList' => [],
Expand Down
2 changes: 1 addition & 1 deletion app/bundles/ReportBundle/Form/Type/ConfigType.php
View file
Open in desktop
Expand Up @@ -43,7 +43,7 @@ public function buildForm(FormBuilderInterface $builder, array $options)
/**
* {@inheritdoc}
*/
public function getName()
public function getBlockPrefix()
{
return 'reportconfig';
}
Expand Down
24 changes: 13 additions & 11 deletions app/bundles/ReportBundle/Form/Type/DynamicFiltersType.php
View file
Open in desktop
Expand Up @@ -14,12 +14,13 @@
use Mautic\CoreBundle\Form\Type\ButtonGroupType;
use Mautic\ReportBundle\Entity\Report;
use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
use Symfony\Component\Form\Extension\Core\Type\DateTimeType;
use Symfony\Component\Form\Extension\Core\Type\DateType;
use Symfony\Component\Form\Extension\Core\Type\TextType;
use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\OptionsResolver\OptionsResolverInterface;
use Symfony\Component\OptionsResolver\OptionsResolver;

/**
* Class DynamicFiltersType.
*/
class DynamicFiltersType extends AbstractType
{
/**
Expand Down Expand Up @@ -61,26 +62,27 @@ public function buildForm(FormBuilderInterface $builder, array $options)
}
break;
case 'date':
$type = 'date';
$type = DateType::class;
$args['input'] = 'string';
$args['widget'] = 'single_text';
$args['format'] = 'y-MM-dd';
$args['attr']['class'] .= ' datepicker';
break;
case 'datetime':
$type = 'datetime';
$type = DateTimeType::class;
$args['input'] = 'string';
$args['widget'] = 'single_text';
$args['format'] = 'y-MM-dd HH:mm:ss';
$args['attr']['class'] .= ' datetimepicker';
break;
case 'multiselect':
case 'select':
$type = 'choice';
$args['choices'] = $definition['list'];
$type = ChoiceType::class;
$args['choices_as_values'] = true;
$args['choices'] = array_flip($definition['list']);
break;
default:
$type = 'text';
$type = TextType::class;
break;
}

Expand All @@ -92,15 +94,15 @@ public function buildForm(FormBuilderInterface $builder, array $options)
/**
* {@inheritdoc}
*/
public function getName()
public function getBlockPrefix()
{
return 'report_dynamicfilters';
}

/**
* {@inheritdoc}
*/
public function setDefaultOptions(OptionsResolverInterface $resolver)
public function configureOptions(OptionsResolver $resolver)
{
$resolver->setDefaults(
[
Expand Down