Cavemanon/piratepoet
8
Fork 0
Code Pull Requests Actions Releases 16 Activity

Remove using Idiorm and replace it by Doctrine

Browse Source 
[MAILPOET-4137]
This commit is contained in:
Jan Lysý
2022-04-21 09:27:30 +02:00
committed by Veljko V
parent 69ca1ec45c
commit d019ad9bdb
2 changed files with 72 additions and 83 deletions
Download Patch File Download Diff File Expand all files Collapse all files

153
mailpoet/lib/Subscription/ManageSubscriptionFormRenderer.php
View File

@@ -1,21 +1,21 @@
<?php <?php declare(strict_types = 1);
namespace MailPoet\Subscription; namespace MailPoet\Subscription;
use MailPoet\Config\Renderer as TemplateRenderer; use MailPoet\Config\Renderer as TemplateRenderer;
use MailPoet\CustomFields\CustomFieldsRepository;
use MailPoet\Entities\CustomFieldEntity;
use MailPoet\Entities\SegmentEntity;
use MailPoet\Entities\SubscriberEntity; use MailPoet\Entities\SubscriberEntity;
use MailPoet\Form\Block\Date as FormBlockDate; use MailPoet\Form\Block\Date as FormBlockDate;
use MailPoet\Form\Renderer as FormRenderer; use MailPoet\Form\Renderer as FormRenderer;
use MailPoet\InvalidStateException; use MailPoet\Segments\SegmentsRepository;
use MailPoet\Models\CustomField;
use MailPoet\Models\Segment;
use MailPoet\Models\Subscriber;
use MailPoet\Settings\SettingsController; use MailPoet\Settings\SettingsController;
use MailPoet\Subscribers\LinkTokens; use MailPoet\Subscribers\LinkTokens;
use MailPoet\Subscribers\SubscribersRepository;
use MailPoet\Util\Helpers; use MailPoet\Util\Helpers;
use MailPoet\Util\Url as UrlHelper; use MailPoet\Util\Url as UrlHelper;
use MailPoet\WP\Functions as WPFunctions; use MailPoet\WP\Functions as WPFunctions;
use MailPoetVendor\Doctrine\Common\Collections\Criteria;
class ManageSubscriptionFormRenderer { class ManageSubscriptionFormRenderer {
const FORM_STATE_SUCCESS = 'success'; const FORM_STATE_SUCCESS = 'success';
@@ -42,8 +42,11 @@ class ManageSubscriptionFormRenderer {
/** @var TemplateRenderer */ /** @var TemplateRenderer */
private $templateRenderer; private $templateRenderer;
/** @var SubscribersRepository */ /** @var CustomFieldsRepository */
private $subscribersRepository; private $customFieldsRepository;
/** @var SegmentsRepository */
private $segmentsRepository;
public function __construct( public function __construct(
WPFunctions $wp, WPFunctions $wp,
@@ -53,7 +56,8 @@ class ManageSubscriptionFormRenderer {
FormRenderer $formRenderer, FormRenderer $formRenderer,
FormBlockDate $dateBlock, FormBlockDate $dateBlock,
TemplateRenderer $templateRenderer, TemplateRenderer $templateRenderer,
SubscribersRepository $subscribersRepository CustomFieldsRepository $customFieldsRepository,
SegmentsRepository $segmentsRepository
) { ) {
$this->wp = $wp; $this->wp = $wp;
$this->settings = $settings; $this->settings = $settings;
@@ -62,29 +66,14 @@ class ManageSubscriptionFormRenderer {
$this->formRenderer = $formRenderer; $this->formRenderer = $formRenderer;
$this->dateBlock = $dateBlock; $this->dateBlock = $dateBlock;
$this->templateRenderer = $templateRenderer; $this->templateRenderer = $templateRenderer;
$this->subscribersRepository = $subscribersRepository; $this->customFieldsRepository = $customFieldsRepository;
$this->segmentsRepository = $segmentsRepository;
} }
public function renderForm(SubscriberEntity $subscriberEntity, string $formState = self::FORM_STATE_NOT_SUBMITTED): string { public function renderForm(SubscriberEntity $subscriberEntity, string $formState = self::FORM_STATE_NOT_SUBMITTED): string {
// Once the old Subscriber model is removed from this class, the if below can be removed as well and $subscriberEntity $basicFields = $this->getBasicFields($subscriberEntity);
// can be used directly (probably worth renaming it to $subscriber). For now this if is needed, as when previewing the $customFields = $this->getCustomFields($subscriberEntity);
// manage subscription page, a demo object is created in Pages::getManageContent() that is not persisted to the database $segmentField = $this->getSegmentField($subscriberEntity);
// so $subscriberEntity->getId() is null and thus it is not possible to use Subscriber::findOne() to get the old model.
if ($subscriberEntity->getId()) {
$subscriber = Subscriber::findOne($subscriberEntity->getId())->withSubscriptions()->withCustomFields();
} else {
$subscriber = Subscriber::create();
$subscriber->hydrate([
'email' => $subscriberEntity->getEmail(),
'first_name' => $subscriberEntity->getFirstName(),
'last_name' => $subscriberEntity->getLastName(),
'link_token' => $subscriberEntity->getLinkToken(),
]);
}
$basicFields = $this->getBasicFields($subscriber);
$customFields = $this->getCustomFields($subscriber);
$segmentField = $this->getSegmentField($subscriber);
$form = array_merge( $form = array_merge(
$basicFields, $basicFields,
@@ -103,32 +92,19 @@ class ManageSubscriptionFormRenderer {
$form = $this->wp->applyFilters('mailpoet_manage_subscription_page_form_fields', $form); $form = $this->wp->applyFilters('mailpoet_manage_subscription_page_form_fields', $form);
// Because subscriber isn't stored in DB Doctrine can't found entity in DB, we need temporary workaround
if ($subscriber->email !== Pages::DEMO_EMAIL) {
$subscriberEntity = $this->subscribersRepository->findOneById($subscriber->id);
} else {
$subscriberEntity = new SubscriberEntity();
$subscriberEntity->setEmail($subscriber->email);
$subscriberEntity->setFirstName($subscriber->firstName);
$subscriberEntity->setLastName($subscriber->lastName);
$subscriberEntity->setLinkToken($subscriber->linkToken);
}
if (!$subscriberEntity) {
throw new InvalidStateException();
}
$templateData = [ $templateData = [
'actionUrl' => admin_url('admin-post.php'), 'actionUrl' => admin_url('admin-post.php'),
'redirectUrl' => $this->urlHelper->getCurrentUrl(), 'redirectUrl' => $this->urlHelper->getCurrentUrl(),
'email' => $subscriber->email, 'email' => $subscriberEntity->getEmail(),
'token' => $this->linkTokens->getToken($subscriberEntity), 'token' => $this->linkTokens->getToken($subscriberEntity),
'editEmailInfo' => __('Need to change your email address? Unsubscribe using the form below, then simply sign up again.', 'mailpoet'), 'editEmailInfo' => __('Need to change your email address? Unsubscribe using the form below, then simply sign up again.', 'mailpoet'),
'formHtml' => $this->formRenderer->renderBlocks($form, [], null, $honeypot = false, $captcha = false), 'formHtml' => $this->formRenderer->renderBlocks($form, [], null, $honeypot = false, $captcha = false),
'formState' => $formState, 'formState' => $formState,
]; ];
if ($subscriber->isWPUser() || $subscriber->isWooCommerceUser()) { if ($subscriberEntity->isWPUser() || $subscriberEntity->getIsWoocommerceUser()) {
$wpCurrentUser = $this->wp->wpGetCurrentUser(); $wpCurrentUser = $this->wp->wpGetCurrentUser();
if ($wpCurrentUser->user_email === $subscriber->email) { // phpcs:ignore Squiz.NamingConventions.ValidVariableName.MemberNotCamelCaps if ($wpCurrentUser->user_email === $subscriberEntity->getEmail()) { // phpcs:ignore Squiz.NamingConventions.ValidVariableName.MemberNotCamelCaps
$templateData['editEmailInfo'] = Helpers::replaceLinkTags( $templateData['editEmailInfo'] = Helpers::replaceLinkTags(
__('[link]Edit your profile[/link] to update your email.', 'mailpoet'), __('[link]Edit your profile[/link] to update your email.', 'mailpoet'),
$this->wp->getEditProfileUrl(), $this->wp->getEditProfileUrl(),
@@ -146,11 +122,23 @@ class ManageSubscriptionFormRenderer {
return $this->templateRenderer->render('subscription/manage_subscription.html', $templateData); return $this->templateRenderer->render('subscription/manage_subscription.html', $templateData);
} }
private function getCustomFields(Subscriber $subscriber): array { private function getCustomFields(SubscriberEntity $subscriber): array {
return array_map(function($customField) use($subscriber) { $customFieldValues = [];
$customField->id = 'cf_' . $customField->id; foreach ($subscriber->getSubscriberCustomFields() as $subscriberCustomField) {
$customField = $customField->asArray(); $customField = $subscriberCustomField->getCustomField();
$customField['params']['value'] = $subscriber->{$customField['id']}; if (!$customField) continue;
$customFieldValues[$customField->getId()] = $subscriberCustomField->getValue();
}
return array_map(function(CustomFieldEntity $customFieldEntity) use($customFieldValues) {
$customField = [
'id' => 'cf_' . $customFieldEntity->getId(),
'name' => $customFieldEntity->getName(),
'type' => $customFieldEntity->getType(),
'params' => $customFieldEntity->getParams(),
];
$customField['params']['value'] = $customFieldValues[$customFieldEntity->getId()] ?? null;
if ($customField['type'] === 'date') { if ($customField['type'] === 'date') {
$dateFormats = $this->dateBlock->getDateFormats(); $dateFormats = $this->dateBlock->getDateFormats();
@@ -163,18 +151,18 @@ class ManageSubscriptionFormRenderer {
} }
return $customField; return $customField;
}, CustomField::findMany()); }, $this->customFieldsRepository->findAll());
} }
private function getBasicFields(Subscriber $subscriber): array { private function getBasicFields(SubscriberEntity $subscriber): array {
return [ return [
[ [
'id' => 'first_name', 'id' => 'first_name',
'type' => 'text', 'type' => 'text',
'params' => [ 'params' => [
'label' => __('First name', 'mailpoet'), 'label' => __('First name', 'mailpoet'),
'value' => $subscriber->firstName, 'value' => $subscriber->getFirstName(),
'disabled' => ($subscriber->isWPUser() || $subscriber->isWooCommerceUser()), 'disabled' => ($subscriber->isWPUser() || $subscriber->getIsWoocommerceUser()),
], ],
], ],
[ [
@@ -182,8 +170,8 @@ class ManageSubscriptionFormRenderer {
'type' => 'text', 'type' => 'text',
'params' => [ 'params' => [
'label' => __('Last name', 'mailpoet'), 'label' => __('Last name', 'mailpoet'),
'value' => $subscriber->lastName, 'value' => $subscriber->getLastName(),
'disabled' => ($subscriber->isWPUser() || $subscriber->isWooCommerceUser()), 'disabled' => ($subscriber->isWPUser() || $subscriber->getIsWoocommerceUser()),
], ],
], ],
[ [
@@ -195,41 +183,41 @@ class ManageSubscriptionFormRenderer {
'values' => [ 'values' => [
[ [
'value' => [ 'value' => [
Subscriber::STATUS_SUBSCRIBED => __('Subscribed', 'mailpoet'), SubscriberEntity::STATUS_SUBSCRIBED => __('Subscribed', 'mailpoet'),
], ],
'is_checked' => ( 'is_checked' => (
$subscriber->status === Subscriber::STATUS_SUBSCRIBED $subscriber->getStatus() === SubscriberEntity::STATUS_SUBSCRIBED
), ),
], ],
[ [
'value' => [ 'value' => [
Subscriber::STATUS_UNSUBSCRIBED => __('Unsubscribed', 'mailpoet'), SubscriberEntity::STATUS_UNSUBSCRIBED => __('Unsubscribed', 'mailpoet'),
], ],
'is_checked' => ( 'is_checked' => (
$subscriber->status === Subscriber::STATUS_UNSUBSCRIBED $subscriber->getStatus() === SubscriberEntity::STATUS_UNSUBSCRIBED
), ),
], ],
[ [
'value' => [ 'value' => [
Subscriber::STATUS_BOUNCED => __('Bounced', 'mailpoet'), SubscriberEntity::STATUS_BOUNCED => __('Bounced', 'mailpoet'),
], ],
'is_checked' => ( 'is_checked' => (
$subscriber->status === Subscriber::STATUS_BOUNCED $subscriber->getStatus() === SubscriberEntity::STATUS_BOUNCED
), ),
'is_disabled' => true, 'is_disabled' => true,
'is_hidden' => ( 'is_hidden' => (
$subscriber->status !== Subscriber::STATUS_BOUNCED $subscriber->getStatus() !== SubscriberEntity::STATUS_BOUNCED
), ),
], ],
[ [
'value' => [ 'value' => [
Subscriber::STATUS_INACTIVE => __('Inactive', 'mailpoet'), SubscriberEntity::STATUS_INACTIVE => __('Inactive', 'mailpoet'),
], ],
'is_checked' => ( 'is_checked' => (
$subscriber->status === Subscriber::STATUS_INACTIVE $subscriber->getStatus() === SubscriberEntity::STATUS_INACTIVE
), ),
'is_hidden' => ( 'is_hidden' => (
$subscriber->status !== Subscriber::STATUS_INACTIVE $subscriber->getStatus() !== SubscriberEntity::STATUS_INACTIVE
), ),
], ],
], ],
@@ -238,30 +226,31 @@ class ManageSubscriptionFormRenderer {
]; ];
} }
private function getSegmentField(Subscriber $subscriber): array { private function getSegmentField(SubscriberEntity $subscriber): array {
$segmentIds = $this->settings->get('subscription.segments', []); $segmentIds = $this->settings->get('subscription.segments', []);
// Get default segments
$criteria = ['type' => SegmentEntity::TYPE_DEFAULT, 'deletedAt' => null];
if (!empty($segmentIds)) { if (!empty($segmentIds)) {
$segments = Segment::getPublic() $criteria['id'] = $segmentIds;
->whereIn('id', $segmentIds)
->findMany();
} else {
$segments = Segment::getPublic()
->findMany();
} }
$segments = $this->segmentsRepository->findBy($criteria, ['name' => Criteria::ASC]);
$subscribedSegmentIds = []; $subscribedSegmentIds = [];
if (!empty($subscriber->subscriptions)) { foreach ($subscriber->getSubscriberSegments() as $subscriberSegment) {
foreach ($subscriber->subscriptions as $subscription) { $segment = $subscriberSegment->getSegment();
if ($subscription['status'] === Subscriber::STATUS_SUBSCRIBED) { if (!$segment) continue;
$subscribedSegmentIds[] = $subscription['segment_id'];
} if ($subscriberSegment->getStatus() === SubscriberEntity::STATUS_SUBSCRIBED) {
$subscribedSegmentIds[] = $segment->getId();
} }
} }
$segments = array_map(function($segment) use($subscribedSegmentIds) { $segments = array_map(function(SegmentEntity $segment) use($subscribedSegmentIds) {
return [ return [
'id' => $segment->id, 'id' => $segment->getId(),
'name' => $segment->name, 'name' => $segment->getName(),
'is_checked' => in_array($segment->id, $subscribedSegmentIds), 'is_checked' => in_array($segment->getId(), $subscribedSegmentIds),
]; ];
}, $segments); }, $segments);

2
mailpoet/tests/integration/Subscription/ManageSubscriptionFormRendererTest.php
View File

@@ -69,7 +69,7 @@ class ManageSubscriptionFormRendererTest extends \MailPoetTest {
if ($segment) { if ($segment) {
$subscriberSegment = new SubscriberSegmentEntity($segment, $subscriber, SubscriberEntity::STATUS_SUBSCRIBED); $subscriberSegment = new SubscriberSegmentEntity($segment, $subscriber, SubscriberEntity::STATUS_SUBSCRIBED);
$this->entityManager->persist($subscriberSegment); $this->entityManager->persist($subscriberSegment);
$subscriber->getSegments()->add($subscriberSegment); $subscriber->getSubscriberSegments()->add($subscriberSegment);
} }
$this->entityManager->persist($subscriber); $this->entityManager->persist($subscriber);