diff --git a/lib/DI/ContainerConfigurator.php b/lib/DI/ContainerConfigurator.php index d29ce6b118..56431b648d 100644 --- a/lib/DI/ContainerConfigurator.php +++ b/lib/DI/ContainerConfigurator.php @@ -264,6 +264,7 @@ class ContainerConfigurator implements IContainerConfigurator { $container->autowire(\MailPoet\Subscription\Comment::class)->setPublic(true); $container->autowire(\MailPoet\Subscription\Form::class)->setPublic(true); $container->autowire(\MailPoet\Subscription\Manage::class)->setPublic(true); + $container->autowire(\MailPoet\Subscription\ManageSubscriptionFormRenderer::class)->setPublic(true); $container->autowire(\MailPoet\Subscription\Pages::class)->setPublic(true) ->setShared(false); // Get a new instance each time $container->get() is called, needed for tests $container->autowire(\MailPoet\Subscription\Registration::class)->setPublic(true); diff --git a/lib/Subscription/ManageSubscriptionFormRenderer.php b/lib/Subscription/ManageSubscriptionFormRenderer.php new file mode 100644 index 0000000000..11107875ff --- /dev/null +++ b/lib/Subscription/ManageSubscriptionFormRenderer.php @@ -0,0 +1,226 @@ +wp = $wp; + $this->settings = $settings; + $this->urlHelper = $urlHelper; + $this->linkTokens = $linkTokens; + $this->formRenderer = $formRenderer; + $this->dateBlock = $dateBlock; + $this->templateRenderer = $templateRenderer; + } + + public function renderForm(Subscriber $subscriber): string { + $customFields = array_map(function($customField) use($subscriber) { + $customField->id = 'cf_' . $customField->id; + $customField = $customField->asArray(); + $customField['params']['value'] = $subscriber->{$customField['id']}; + + if ($customField['type'] === 'date') { + $dateFormats = $this->dateBlock->getDateFormats(); + $customField['params']['date_format'] = array_shift( + $dateFormats[$customField['params']['date_type']] + ); + } + if (!isset($customField['params']['label'])) { + $customField['params']['label'] = $customField['name']; + } + + return $customField; + }, CustomField::findMany()); + + $segmentIds = $this->settings->get('subscription.segments', []); + if (!empty($segmentIds)) { + $segments = Segment::getPublic() + ->whereIn('id', $segmentIds) + ->findMany(); + } else { + $segments = Segment::getPublic() + ->findMany(); + } + $subscribedSegmentIds = []; + if (!empty($subscriber->subscriptions)) { + foreach ($subscriber->subscriptions as $subscription) { + if ($subscription['status'] === Subscriber::STATUS_SUBSCRIBED) { + $subscribedSegmentIds[] = $subscription['segment_id']; + } + } + } + + $segments = array_map(function($segment) use($subscribedSegmentIds) { + return [ + 'id' => $segment->id, + 'name' => $segment->name, + 'is_checked' => in_array($segment->id, $subscribedSegmentIds), + ]; + }, $segments); + + + $fields = [ + [ + 'id' => 'first_name', + 'type' => 'text', + 'params' => [ + 'label' => __('First name', 'mailpoet'), + 'value' => $subscriber->firstName, + 'disabled' => ($subscriber->isWPUser() || $subscriber->isWooCommerceUser()), + ], + ], + [ + 'id' => 'last_name', + 'type' => 'text', + 'params' => [ + 'label' => __('Last name', 'mailpoet'), + 'value' => $subscriber->lastName, + 'disabled' => ($subscriber->isWPUser() || $subscriber->isWooCommerceUser()), + ], + ], + [ + 'id' => 'status', + 'type' => 'select', + 'params' => [ + 'required' => true, + 'label' => __('Status', 'mailpoet'), + 'values' => [ + [ + 'value' => [ + Subscriber::STATUS_SUBSCRIBED => __('Subscribed', 'mailpoet'), + ], + 'is_checked' => ( + $subscriber->status === Subscriber::STATUS_SUBSCRIBED + ), + ], + [ + 'value' => [ + Subscriber::STATUS_UNSUBSCRIBED => __('Unsubscribed', 'mailpoet'), + ], + 'is_checked' => ( + $subscriber->status === Subscriber::STATUS_UNSUBSCRIBED + ), + ], + [ + 'value' => [ + Subscriber::STATUS_BOUNCED => __('Bounced', 'mailpoet'), + ], + 'is_checked' => ( + $subscriber->status === Subscriber::STATUS_BOUNCED + ), + 'is_disabled' => true, + 'is_hidden' => ( + $subscriber->status !== Subscriber::STATUS_BOUNCED + ), + ], + [ + 'value' => [ + Subscriber::STATUS_INACTIVE => __('Inactive', 'mailpoet'), + ], + 'is_checked' => ( + $subscriber->status === Subscriber::STATUS_INACTIVE + ), + 'is_hidden' => ( + $subscriber->status !== Subscriber::STATUS_INACTIVE + ), + ], + ], + ], + ], + ]; + + $form = array_merge( + $fields, + $customFields, + [ + [ + 'id' => 'segments', + 'type' => 'segment', + 'params' => [ + 'label' => __('Your lists', 'mailpoet'), + 'values' => $segments, + ], + ], + [ + 'id' => 'submit', + 'type' => 'submit', + 'params' => [ + 'label' => __('Save', 'mailpoet'), + ], + ], + ] + ); + + $templateData = [ + 'actionUrl' => admin_url('admin-post.php'), + 'redirectUrl' => $this->urlHelper->getCurrentUrl(), + 'email' => $subscriber->email, + 'token' => $this->linkTokens->getToken($subscriber), + 'editEmailInfo' => __('Need to change your email address? Unsubscribe here, then simply sign up again.', 'mailpoet'), + 'formHtml' => $this->formRenderer->renderBlocks($form, [], $honeypot = false), + ]; + + if ($subscriber->isWPUser() || $subscriber->isWooCommerceUser()) { + $wpCurrentUser = $this->wp->wpGetCurrentUser(); + if ($wpCurrentUser->user_email === $subscriber->email) { // phpcs:ignore Squiz.NamingConventions.ValidVariableName.NotCamelCaps + $templateData['editEmailInfo'] = Helpers::replaceLinkTags( + __('[link]Edit your profile[/link] to update your email.', 'mailpoet'), + $this->wp->getEditProfileUrl(), + ['target' => '_blank'] + ); + } else { + $templateData['editEmailInfo'] = Helpers::replaceLinkTags( + __('[link]Log in to your account[/link] to update your email.', 'mailpoet'), + $this->wp->wpLoginUrl(), + ['target' => '_blank'] + ); + } + } + + return $this->wp->applyFilters( + 'mailpoet_manage_subscription_page', + $this->templateRenderer->render('subscription/manage_subscription.html', $templateData) + ); + } +} diff --git a/lib/Subscription/Pages.php b/lib/Subscription/Pages.php index e9cf89d9a4..d9a3819d95 100644 --- a/lib/Subscription/Pages.php +++ b/lib/Subscription/Pages.php @@ -5,10 +5,6 @@ namespace MailPoet\Subscription; use MailPoet\Config\Renderer as TemplateRenderer; use MailPoet\Entities\StatisticsUnsubscribeEntity; use MailPoet\Form\AssetsController; -use MailPoet\Form\Block\Date as FormBlockDate; -use MailPoet\Form\Renderer as FormRenderer; -use MailPoet\Models\CustomField; -use MailPoet\Models\Segment; use MailPoet\Models\Subscriber; use MailPoet\Models\SubscriberSegment; use MailPoet\Newsletter\Scheduler\WelcomeScheduler; @@ -17,7 +13,6 @@ use MailPoet\Statistics\Track\Unsubscribes; use MailPoet\Subscribers\LinkTokens; use MailPoet\Subscribers\NewSubscriberNotificationMailer; use MailPoet\Util\Helpers; -use MailPoet\Util\Url as UrlHelper; use MailPoet\WP\Functions as WPFunctions; class Pages { @@ -38,9 +33,6 @@ class Pages { /** @var SettingsController */ private $settings; - /** @var UrlHelper */ - private $urlHelper; - /** @var WPFunctions */ private $wp; @@ -59,46 +51,39 @@ class Pages { /** @var AssetsController */ private $assetsController; - /** @var FormRenderer */ - private $formRenderer; - - /** @var FormBlockDate */ - private $dateBlock; - /** @var TemplateRenderer */ private $templateRenderer; /** @var Unsubscribes */ private $unsubscribesTracker; + /** @var ManageSubscriptionFormRenderer */ + private $manageSubscriptionFormRenderer; + public function __construct( NewSubscriberNotificationMailer $newSubscriberNotificationSender, WPFunctions $wp, SettingsController $settings, - UrlHelper $urlHelper, CaptchaRenderer $captchaRenderer, WelcomeScheduler $welcomeScheduler, LinkTokens $linkTokens, SubscriptionUrlFactory $subscriptionUrlFactory, AssetsController $assetsController, - FormRenderer $formRenderer, - FormBlockDate $dateBlock, TemplateRenderer $templateRenderer, - Unsubscribes $unsubscribesTracker + Unsubscribes $unsubscribesTracker, + ManageSubscriptionFormRenderer $manageSubscriptionFormRenderer ) { $this->wp = $wp; $this->newSubscriberNotificationSender = $newSubscriberNotificationSender; $this->settings = $settings; - $this->urlHelper = $urlHelper; $this->captchaRenderer = $captchaRenderer; $this->welcomeScheduler = $welcomeScheduler; $this->linkTokens = $linkTokens; $this->subscriptionUrlFactory = $subscriptionUrlFactory; $this->assetsController = $assetsController; - $this->formRenderer = $formRenderer; - $this->dateBlock = $dateBlock; $this->templateRenderer = $templateRenderer; $this->unsubscribesTracker = $unsubscribesTracker; + $this->manageSubscriptionFormRenderer = $manageSubscriptionFormRenderer; } public function init($action = false, $data = [], $initShortcodes = false, $initPageFilters = false) { @@ -372,174 +357,7 @@ class Pages { } else { return $this->wp->__('Subscription management form is only available to mailing lists subscribers.', 'mailpoet'); } - - $customFields = array_map(function($customField) use($subscriber) { - $customField->id = 'cf_' . $customField->id; - $customField = $customField->asArray(); - $customField['params']['value'] = $subscriber->{$customField['id']}; - - if ($customField['type'] === 'date') { - $dateFormats = $this->dateBlock->getDateFormats(); - $customField['params']['date_format'] = array_shift( - $dateFormats[$customField['params']['date_type']] - ); - } - if (!isset($customField['params']['label'])) { - $customField['params']['label'] = $customField['name']; - } - - return $customField; - }, CustomField::findMany()); - - $segmentIds = $this->settings->get('subscription.segments', []); - if (!empty($segmentIds)) { - $segments = Segment::getPublic() - ->whereIn('id', $segmentIds) - ->findMany(); - } else { - $segments = Segment::getPublic() - ->findMany(); - } - $subscribedSegmentIds = []; - if (!empty($this->subscriber->subscriptions)) { - foreach ($this->subscriber->subscriptions as $subscription) { - if ($subscription['status'] === Subscriber::STATUS_SUBSCRIBED) { - $subscribedSegmentIds[] = $subscription['segment_id']; - } - } - } - - $segments = array_map(function($segment) use($subscribedSegmentIds) { - return [ - 'id' => $segment->id, - 'name' => $segment->name, - 'is_checked' => in_array($segment->id, $subscribedSegmentIds), - ]; - }, $segments); - - - $fields = [ - [ - 'id' => 'first_name', - 'type' => 'text', - 'params' => [ - 'label' => $this->wp->__('First name', 'mailpoet'), - 'value' => $subscriber->firstName, - 'disabled' => ($subscriber->isWPUser() || $subscriber->isWooCommerceUser()), - ], - ], - [ - 'id' => 'last_name', - 'type' => 'text', - 'params' => [ - 'label' => $this->wp->__('Last name', 'mailpoet'), - 'value' => $subscriber->lastName, - 'disabled' => ($subscriber->isWPUser() || $subscriber->isWooCommerceUser()), - ], - ], - [ - 'id' => 'status', - 'type' => 'select', - 'params' => [ - 'required' => true, - 'label' => $this->wp->__('Status', 'mailpoet'), - 'values' => [ - [ - 'value' => [ - Subscriber::STATUS_SUBSCRIBED => $this->wp->__('Subscribed', 'mailpoet'), - ], - 'is_checked' => ( - $subscriber->status === Subscriber::STATUS_SUBSCRIBED - ), - ], - [ - 'value' => [ - Subscriber::STATUS_UNSUBSCRIBED => $this->wp->__('Unsubscribed', 'mailpoet'), - ], - 'is_checked' => ( - $subscriber->status === Subscriber::STATUS_UNSUBSCRIBED - ), - ], - [ - 'value' => [ - Subscriber::STATUS_BOUNCED => $this->wp->__('Bounced', 'mailpoet'), - ], - 'is_checked' => ( - $subscriber->status === Subscriber::STATUS_BOUNCED - ), - 'is_disabled' => true, - 'is_hidden' => ( - $subscriber->status !== Subscriber::STATUS_BOUNCED - ), - ], - [ - 'value' => [ - Subscriber::STATUS_INACTIVE => $this->wp->__('Inactive', 'mailpoet'), - ], - 'is_checked' => ( - $subscriber->status === Subscriber::STATUS_INACTIVE - ), - 'is_hidden' => ( - $subscriber->status !== Subscriber::STATUS_INACTIVE - ), - ], - ], - ], - ], - ]; - - $form = array_merge( - $fields, - $customFields, - [ - [ - 'id' => 'segments', - 'type' => 'segment', - 'params' => [ - 'label' => $this->wp->__('Your lists', 'mailpoet'), - 'values' => $segments, - ], - ], - [ - 'id' => 'submit', - 'type' => 'submit', - 'params' => [ - 'label' => $this->wp->__('Save', 'mailpoet'), - ], - ], - ] - ); - - $templateData = [ - 'actionUrl' => admin_url('admin-post.php'), - 'redirectUrl' => $this->urlHelper->getCurrentUrl(), - 'email' => $subscriber->email, - 'token' => $this->linkTokens->getToken($subscriber), - 'editEmailInfo' => __('Need to change your email address? Unsubscribe here, then simply sign up again.', 'mailpoet'), - 'formHtml' => $this->formRenderer->renderBlocks($form, [], $honeypot = false), - ]; - - if ($subscriber->isWPUser() || $subscriber->isWooCommerceUser()) { - $wpCurrentUser = $this->wp->wpGetCurrentUser(); - if ($wpCurrentUser->user_email === $subscriber->email) { // phpcs:ignore Squiz.NamingConventions.ValidVariableName.NotCamelCaps - $templateData['editEmailInfo'] = Helpers::replaceLinkTags( - __('[link]Edit your profile[/link] to update your email.', 'mailpoet'), - $this->wp->getEditProfileUrl(), - ['target' => '_blank'] - ); - } else { - $templateData['editEmailInfo'] = Helpers::replaceLinkTags( - __('[link]Log in to your account[/link] to update your email.', 'mailpoet'), - $this->wp->wpLoginUrl(), - ['target' => '_blank'] - ); - } - } - - return $this->wp->applyFilters( - 'mailpoet_manage_subscription_page', - $this->templateRenderer->render('subscription/manage_subscription.html', $templateData) - ); + return $this->manageSubscriptionFormRenderer->renderForm($subscriber); } private function getUnsubscribeContent() { diff --git a/tests/integration/Subscription/PagesTest.php b/tests/integration/Subscription/PagesTest.php index e0a21b8733..1ab0539cb9 100644 --- a/tests/integration/Subscription/PagesTest.php +++ b/tests/integration/Subscription/PagesTest.php @@ -7,8 +7,6 @@ use Codeception\Util\Fixtures; use MailPoet\Config\Renderer; use MailPoet\DI\ContainerWrapper; use MailPoet\Form\AssetsController; -use MailPoet\Form\Block\Date as FormBlockDate; -use MailPoet\Form\Renderer as FormRenderer; use MailPoet\Models\Newsletter; use MailPoet\Models\NewsletterOption; use MailPoet\Models\NewsletterOptionField; @@ -24,9 +22,9 @@ use MailPoet\Statistics\Track\Unsubscribes; use MailPoet\Subscribers\LinkTokens; use MailPoet\Subscribers\NewSubscriberNotificationMailer; use MailPoet\Subscription\CaptchaRenderer; +use MailPoet\Subscription\ManageSubscriptionFormRenderer; use MailPoet\Subscription\Pages; use MailPoet\Subscription\SubscriptionUrlFactory; -use MailPoet\Util\Url as UrlHelper; use MailPoet\WP\Functions as WPFunctions; use MailPoetVendor\Carbon\Carbon; use MailPoetVendor\Idiorm\ORM; @@ -194,16 +192,14 @@ class PagesTest extends \MailPoetTest { $newSubscriberNotificationsMock ?? $container->get(NewSubscriberNotificationMailer::class), $container->get(WPFunctions::class), $container->get(SettingsController::class), - $container->get(UrlHelper::class), $container->get(CaptchaRenderer::class), $container->get(WelcomeScheduler::class), $container->get(LinkTokens::class), $container->get(SubscriptionUrlFactory::class), $container->get(AssetsController::class), - $container->get(FormRenderer::class), - $container->get(FormBlockDate::class), $container->get(Renderer::class), - $unsubscribesMock ?? $container->get(Unsubscribes::class) + $unsubscribesMock ?? $container->get(Unsubscribes::class), + $container->get(ManageSubscriptionFormRenderer::class) ); } }