Skip to content

Adaptation to Mautic v5 - Transform controllers #316

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

Closed
wants to merge 11 commits into from
Closed

Adaptation to Mautic v5 - Transform controllers #316

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
7936d3f
initialize requestStack in controllers
volha-pivavarchyk May 17, 2023
72df7de
modify controllers configuration
volha-pivavarchyk May 17, 2023
7f9c36d
initialize requestStack in controllers
volha-pivavarchyk May 17, 2023
1ec9047
inject services into controllers
volha-pivavarchyk May 17, 2023
55af128
fix unit controller tests
volha-pivavarchyk May 17, 2023
f6a11fd
fix controller names in the routes
volha-pivavarchyk May 17, 2023
11f9012
add Manageregistry dependency to controllers
volha-pivavarchyk May 17, 2023
15d246b
replace Controller to AbstractController, fix tests
volha-pivavarchyk May 17, 2023
4eb2c12
use more appropriate name for the render method
volha-pivavarchyk May 17, 2023
ed9629b
Remove deprecated code
volha-pivavarchyk Jul 13, 2023
ab479e8
Start to fix tests
volha-pivavarchyk Jul 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
382 changes: 31 additions & 351 deletions Config/config.php
View file
Open in desktop

Large diffs are not rendered by default.

75 changes: 15 additions & 60 deletions Controller/CustomField/FormController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,106 +15,61 @@
use MauticPlugin\CustomObjectsBundle\Provider\CustomFieldPermissionProvider;
use MauticPlugin\CustomObjectsBundle\Provider\CustomFieldRouteProvider;
use MauticPlugin\CustomObjectsBundle\Provider\CustomObjectRouteProvider;
use Symfony\Component\Form\FormFactory;
use Symfony\Component\Form\FormFactoryInterface;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;

class FormController extends CommonController
{
/**
* @var FormFactory
*/
private $formFactory;

/**
* @var CustomFieldModel
*/
private $customFieldModel;

/**
* @var CustomFieldPermissionProvider
*/
private $permissionProvider;

/**
* @var CustomFieldRouteProvider
*/
private $fieldRouteProvider;

/**
* @var CustomFieldFactory
*/
private $customFieldFactory;

/**
* @var CustomObjectModel
*/
private $customObjectModel;

/**
* @var CustomObjectRouteProvider
*/
private $objectRouteProvider;

public function __construct(
FormFactory $formFactory,
public function renderFormAction(
Request $request,
FormFactoryInterface $formFactory,
CustomFieldModel $customFieldModel,
CustomFieldFactory $customFieldFactory,
CustomFieldPermissionProvider $permissionProvider,
CustomFieldRouteProvider $fieldRouteProvider,
CustomObjectModel $customObjectModel,
CustomObjectRouteProvider $objectRouteProvider
) {
$this->formFactory = $formFactory;
$this->customFieldModel = $customFieldModel;
$this->customFieldFactory = $customFieldFactory;
$this->permissionProvider = $permissionProvider;
$this->fieldRouteProvider = $fieldRouteProvider;
$this->customObjectModel = $customObjectModel;
$this->objectRouteProvider = $objectRouteProvider;
}

public function renderFormAction(Request $request): Response
{
): Response {
$objectId = (int) $request->get('objectId');
$fieldId = (int) $request->get('fieldId');
$fieldType = $request->get('fieldType');
$panelId = is_numeric($request->get('panelId')) ? (int) $request->get('panelId') : null; // Is edit of existing panel in view
$panelCount = is_numeric($request->get('panelCount')) ? (int) $request->get('panelCount') : null;

if ($objectId) {
$customObject = $this->customObjectModel->fetchEntity($objectId);
$customObject = $customObjectModel->fetchEntity($objectId);
} else {
$customObject = new CustomObject();
}

try {
if ($fieldId) {
$customField = $this->customFieldModel->fetchEntity($fieldId);
$this->permissionProvider->canEdit($customField);
$customField = $customFieldModel->fetchEntity($fieldId);
$permissionProvider->canEdit($customField);
} else {
$this->permissionProvider->canCreate();
$customField = $this->customFieldFactory->create($fieldType, $customObject);
$permissionProvider->canCreate();
$customField = $customFieldFactory->create($fieldType, $customObject);
}
} catch (NotFoundException $e) {
return $this->notFound($e->getMessage());
} catch (ForbiddenException $e) {
return $this->accessDenied(false, $e->getMessage());
}

$route = $this->fieldRouteProvider->buildFormRoute($customField->getId());
$action = $this->fieldRouteProvider->buildSaveRoute($fieldType, $fieldId, $customObject->getId(), $panelCount, $panelId);
$form = $this->formFactory->create(CustomFieldType::class, $customField, ['action' => $action]);
$route = $fieldRouteProvider->buildFormRoute($customField->getId());
$action = $fieldRouteProvider->buildSaveRoute($fieldType, $fieldId, $customObject->getId(), $panelCount, $panelId);
$form = $formFactory->create(CustomFieldType::class, $customField, ['action' => $action]);

return $this->delegateView(
[
'returnUrl' => $this->objectRouteProvider->buildEditRoute($customObject->getId()),
'returnUrl' => $objectRouteProvider->buildEditRoute($customObject->getId()),
'viewParameters' => [
'customObject' => $customObject,
'customField' => $customField,
'form' => $form->createView(),
],
'contentTemplate' => 'CustomObjectsBundle:CustomField:form.html.php',
'contentTemplate' => '@CustomObjects/CustomField/form.html.twig',
'passthroughVars' => [
'mauticContent' => 'customField',
'route' => $route,
Expand Down
91 changes: 27 additions & 64 deletions Controller/CustomField/SaveController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,10 @@
use MauticPlugin\CustomObjectsBundle\Model\CustomObjectModel;
use MauticPlugin\CustomObjectsBundle\Provider\CustomFieldPermissionProvider;
use MauticPlugin\CustomObjectsBundle\Provider\CustomFieldRouteProvider;
use Symfony\Component\Form\FormFactory;
use Symfony\Component\Form\FormFactoryInterface;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Translation\TranslatorInterface;

/**
* This controller is not used for saving to database, it is used only to generate forms and data validation.
Expand All @@ -32,79 +31,38 @@
class SaveController extends CommonController
{
/**
* @var FormFactory
*/
private $formFactory;

/**
* @var CustomFieldModel
*/
private $customFieldModel;

/**
* @var CustomFieldFactory
*/
private $customFieldFactory;

/**
* @var CustomFieldPermissionProvider
*/
private $permissionProvider;

/**
* @var CustomFieldRouteProvider
*/
private $fieldRouteProvider;

/**
* @var CustomObjectModel
* Not save but validate Custom Field data and return proper response. Check class description.
*
* @return Response|JsonResponse
*/
private $customObjectModel;

public function __construct(
FormFactory $formFactory,
TranslatorInterface $translator,
public function saveAction(
Request $request,
FormFactoryInterface $formFactory,
CustomFieldModel $customFieldModel,
CustomFieldFactory $customFieldFactory,
CustomFieldPermissionProvider $permissionProvider,
CustomFieldRouteProvider $fieldRouteProvider,
CustomObjectModel $customObjectModel
) {
$this->formFactory = $formFactory;
$this->translator = $translator;
$this->customFieldModel = $customFieldModel;
$this->customFieldFactory = $customFieldFactory;
$this->permissionProvider = $permissionProvider;
$this->fieldRouteProvider = $fieldRouteProvider;
$this->customObjectModel = $customObjectModel;
}

/**
* Not save but validate Custom Field data and return proper response. Check class description.
*
* @return Response|JsonResponse
*/
public function saveAction(Request $request)
{
$objectId = (int) $request->get('objectId');
$fieldId = (int) $request->query->get('fieldId');
$fieldType = $request->get('fieldType');
$panelId = is_numeric($request->get('panelId')) ? (int) $request->get('panelId') : null; // Is edit of existing panel in view
$panelCount = is_numeric($request->get('panelCount')) ? (int) $request->get('panelCount') : null;

if ($objectId) {
$customObject = $this->customObjectModel->fetchEntity($objectId);
$customObject = $customObjectModel->fetchEntity($objectId);
} else {
$customObject = new CustomObject();
}

try {
if ($fieldId) {
$customField = $this->customFieldModel->fetchEntity($fieldId);
$this->permissionProvider->canEdit($customField);
$customField = $customFieldModel->fetchEntity($fieldId);
$permissionProvider->canEdit($customField);
} else {
$this->permissionProvider->canCreate();
$customField = $this->customFieldFactory->create($fieldType, $customObject);
$permissionProvider->canCreate();
$customField = $customFieldFactory->create($fieldType, $customObject);
}
} catch (NotFoundException $e) {
return $this->notFound($e->getMessage());
Expand All @@ -114,17 +72,17 @@ public function saveAction(Request $request)

$this->recreateOptionsFromPost($request->get('custom_field'), $customField);

$action = $this->fieldRouteProvider->buildSaveRoute($fieldType, $fieldId, $customObject->getId(), $panelCount, $panelId);
$form = $this->formFactory->create(CustomFieldType::class, $customField, ['action' => $action]);
$action = $fieldRouteProvider->buildSaveRoute($fieldType, $fieldId, $customObject->getId(), $panelCount, $panelId);
$form = $formFactory->create(CustomFieldType::class, $customField, ['action' => $action]);

$form->handleRequest($request);

if ($form->isValid()) {
// Render Custom Field form RAT for Custom Object form.
return $this->buildSuccessForm($customObject, $form->getData(), $request);
return $this->buildSuccessForm($customObject, $form->getData(), $request, $customFieldModel, $formFactory);
}

$route = $fieldId ? $this->fieldRouteProvider->buildFormRoute($fieldId) : '';
$route = $fieldId ? $fieldRouteProvider->buildFormRoute($fieldId) : '';

// Render Custom Field form for modal.
return $this->delegateView(
Expand All @@ -134,7 +92,7 @@ public function saveAction(Request $request)
'customField' => $customField,
'form' => $form->createView(),
],
'contentTemplate' => 'CustomObjectsBundle:CustomField:form.html.php',
'contentTemplate' => '@CustomObjects/CustomField/form.html.twig',
'passthroughVars' => [
'mauticContent' => 'customField',
'route' => $route,
Expand All @@ -147,8 +105,13 @@ public function saveAction(Request $request)
/**
* Here is CO form panel part build and injected in the frontend as part of existing CO form.
*/
private function buildSuccessForm(CustomObject $customObject, CustomField $customField, Request $request): JsonResponse
{
private function buildSuccessForm(
CustomObject $customObject,
CustomField $customField,
Request $request,
CustomFieldModel $customFieldModel,
FormFactoryInterface $formFactory
): JsonResponse {
$panelId = is_numeric($request->get('panelId')) ? (int) $request->get('panelId') : null; // Is edit of existing panel in view

if (null === $panelId) {
Expand All @@ -167,18 +130,18 @@ private function buildSuccessForm(CustomObject $customObject, CustomField $custo
$option->setCustomField($customField);
}

$this->customFieldModel->setAlias($customField);
$customFieldModel->setAlias($customField);

$customFields = new ArrayCollection([$customField]);
$customObject->setCustomFields($customFields);

$form = $this->formFactory->create(
$form = $formFactory->create(
CustomObjectType::class,
$customObject
);

$template = $this->render(
'CustomObjectsBundle:CustomObject:_form-fields.html.php',
'@CustomObjects/CustomObject/_form-fields.html.twig',
[
'form' => $form->createView(),
'panelId' => $panelId, // Panel id to me replaced if edit
Expand Down
Loading