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

Refactor shortcode categories to doctrine

Browse Source 
[MAILPOET-2993]
This commit is contained in:
Pavel Dohnal
2020-11-04 13:44:16 +01:00
committed by Veljko V
parent 6139e300c3
commit fcbfd6fb68
17 changed files with 444 additions and 185 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
lib/Newsletter/Shortcodes/Categories/CategoryInterface.php Normal file
View File

@@ -0,0 +1,18 @@
<?php
namespace MailPoet\Newsletter\Shortcodes\Categories;
use MailPoet\Entities\NewsletterEntity;
use MailPoet\Entities\SendingQueueEntity;
use MailPoet\Entities\SubscriberEntity;
interface CategoryInterface {
public function process(
array $shortcodeDetails,
NewsletterEntity $newsletter = null,
SubscriberEntity $subscriber = null,
SendingQueueEntity $queue = null,
string $content = '',
bool $wpUserPreview = false
): ?string;
}

18
lib/Newsletter/Shortcodes/Categories/Date.php
View File

@@ -2,12 +2,20 @@
namespace MailPoet\Newsletter\Shortcodes\Categories;
use MailPoet\Entities\NewsletterEntity;
use MailPoet\Entities\SendingQueueEntity;
use MailPoet\Entities\SubscriberEntity;
use MailPoet\WP\Functions as WPFunctions;
class Date {
public static function process(
$shortcodeDetails
) {
class Date implements CategoryInterface {
public function process(
array $shortcodeDetails,
NewsletterEntity $newsletter = null,
SubscriberEntity $subscriber = null,
SendingQueueEntity $queue = null,
string $content = '',
bool $wpUserPreview = false
): ?string {
$actionMapping = [
'd' => 'd',
'dordinal' => 'jS',
@@ -22,6 +30,6 @@ class Date {
}
return ($shortcodeDetails['action'] === 'custom' && $shortcodeDetails['action_argument'] === 'format') ?
WPFunctions::get()->dateI18n($shortcodeDetails['action_argument_value'], $wp->currentTime('timestamp')) :
false;
null;
}
}

134
lib/Newsletter/Shortcodes/Categories/Link.php
View File

@@ -2,31 +2,52 @@
namespace MailPoet\Newsletter\Shortcodes\Categories;
use MailPoet\Entities\NewsletterEntity;
use MailPoet\Entities\SendingQueueEntity;
use MailPoet\Entities\SubscriberEntity;
use MailPoet\Models\Newsletter as NewsletterModel;
use MailPoet\Models\SendingQueue;
use MailPoet\Models\Subscriber as SubscriberModel;
use MailPoet\Newsletter\Url as NewsletterUrl;
use MailPoet\Settings\SettingsController;
use MailPoet\Subscription\SubscriptionUrlFactory;
use MailPoet\Tasks\Sending;
use MailPoet\WP\Functions as WPFunctions;
class Link {
class Link implements CategoryInterface {
const CATEGORY_NAME = 'link';
public static function process(
$shortcodeDetails,
$newsletter,
$subscriber,
$queue,
$content,
$wpUserPreview
/** @var SettingsController */
private $settings;
/** @var WPFunctions */
private $wp;
public function __construct(
SettingsController $settings,
WPFunctions $wp
) {
$this->settings = $settings;
$this->wp = $wp;
}
public function process(
array $shortcodeDetails,
NewsletterEntity $newsletter = null,
SubscriberEntity $subscriber = null,
SendingQueueEntity $queue = null,
string $content = '',
bool $wpUserPreview = false
): ?string {
$subscriptionUrlFactory = SubscriptionUrlFactory::getInstance();
$subscriberModel = $this->getSubscriberModel($subscriber);
$newsletterModel = $this->getNewsletterModel($newsletter);
$queueModel = $this->getQueueModel($queue);
switch ($shortcodeDetails['action']) {
case 'subscription_unsubscribe_url':
return self::processUrl(
$shortcodeDetails['action'],
$subscriptionUrlFactory->getConfirmUnsubscribeUrl($wpUserPreview ? null : $subscriber, self::getSendingQueueId($queue)),
$subscriptionUrlFactory->getConfirmUnsubscribeUrl($wpUserPreview ? null : $subscriberModel, self::getSendingQueueId($queue)),
$queue,
$wpUserPreview
);
@@ -34,7 +55,7 @@ class Link {
case 'subscription_instant_unsubscribe_url':
return self::processUrl(
$shortcodeDetails['action'],
$subscriptionUrlFactory->getUnsubscribeUrl($wpUserPreview ? null : $subscriber, self::getSendingQueueId($queue)),
$subscriptionUrlFactory->getUnsubscribeUrl($wpUserPreview ? null : $subscriberModel, self::getSendingQueueId($queue)),
$queue,
$wpUserPreview
);
@@ -42,96 +63,121 @@ class Link {
case 'subscription_manage_url':
return self::processUrl(
$shortcodeDetails['action'],
$subscriptionUrlFactory->getManageUrl($wpUserPreview ? null : $subscriber),
$subscriptionUrlFactory->getManageUrl($wpUserPreview ? null : $subscriberModel),
$queue,
$wpUserPreview
);
case 'newsletter_view_in_browser_url':
$url = NewsletterUrl::getViewInBrowserUrl(
$newsletter,
$newsletterModel,
$wpUserPreview ? null : $subscriber,
$queue,
$queueModel,
$wpUserPreview
);
return self::processUrl($shortcodeDetails['action'], $url, $queue, $wpUserPreview);
default:
$shortcode = self::getFullShortcode($shortcodeDetails['action']);
$url = WPFunctions::get()->applyFilters(
$url = $this->wp->applyFilters(
'mailpoet_newsletter_shortcode_link',
$shortcode,
$newsletter,
$subscriber,
$queue,
$newsletterModel,
$subscriberModel,
$queueModel,
$wpUserPreview
);
return ($url !== $shortcode) ?
self::processUrl($shortcodeDetails['action'], $url, $queue, $wpUserPreview) :
false;
null;
}
}
public static function processUrl($action, $url, $queue, $wpUserPreview = false) {
public function processUrl($action, $url, $queue, $wpUserPreview = false): string {
if ($wpUserPreview) return $url;
$settings = SettingsController::getInstance();
return ($queue !== false && (boolean)$settings->get('tracking.enabled')) ?
return ($queue !== false && (boolean)$this->settings->get('tracking.enabled')) ?
self::getFullShortcode($action) :
$url;
}
public static function processShortcodeAction(
$shortcodeAction, $newsletter, $subscriber, $queue, $wpUserPreview
) {
public function processShortcodeAction(
$shortcodeAction,
NewsletterEntity $newsletter = null,
SubscriberEntity $subscriber = null,
SendingQueueEntity $queue = null,
$wpUserPreview = false
): ?string {
$subscriberModel = $this->getSubscriberModel($subscriber);
$newsletterModel = $this->getNewsletterModel($newsletter);
$queueModel = $this->getQueueModel($queue);
$subscriptionUrlFactory = SubscriptionUrlFactory::getInstance();
switch ($shortcodeAction) {
case 'subscription_unsubscribe_url':
$url = $subscriptionUrlFactory->getConfirmUnsubscribeUrl($subscriber, self::getSendingQueueId($queue));
$url = $subscriptionUrlFactory->getConfirmUnsubscribeUrl($subscriberModel, self::getSendingQueueId($queue));
break;
case 'subscription_instant_unsubscribe_url':
$url = $subscriptionUrlFactory->getUnsubscribeUrl($subscriber, self::getSendingQueueId($queue));
$url = $subscriptionUrlFactory->getUnsubscribeUrl($subscriberModel, self::getSendingQueueId($queue));
break;
case 'subscription_manage_url':
$url = $subscriptionUrlFactory->getManageUrl($subscriber);
$url = $subscriptionUrlFactory->getManageUrl($subscriberModel);
break;
case 'newsletter_view_in_browser_url':
$url = NewsletterUrl::getViewInBrowserUrl(
$newsletter,
$subscriber,
$queue,
$newsletterModel,
$subscriberModel,
$queueModel,
false
);
break;
default:
$shortcode = self::getFullShortcode($shortcodeAction);
$url = WPFunctions::get()->applyFilters(
$url = $this->wp->applyFilters(
'mailpoet_newsletter_shortcode_link',
$shortcode,
$newsletter,
$subscriber,
$queue,
$newsletterModel,
$subscriberModel,
$queueModel,
$wpUserPreview
);
$url = ($url !== $shortcodeAction) ? $url : false;
$url = ($url !== $shortcodeAction) ? $url : null;
break;
}
return $url;
}
private static function getFullShortcode($action) {
private function getFullShortcode($action): string {
return sprintf('[link:%s]', $action);
}
/**
* @return int|null
*/
private static function getSendingQueueId($queue) {
if ($queue instanceof Sending) {
return (int)$queue->id;
}
private function getSendingQueueId($queue): ?int {
if ($queue instanceof SendingQueueEntity) {
return $queue->getId();
}
return null;
}
// temporary function until Links are refactored to Doctrine
private function getSubscriberModel(SubscriberEntity $subscriber = null): ?SubscriberModel {
if (!$subscriber) return null;
$subscriberModel = SubscriberModel::where('id', $subscriber->getId())->findOne();
if ($subscriberModel) return $subscriberModel;
return null;
}
// temporary function until Links are refactored to Doctrine
private function getNewsletterModel(NewsletterEntity $newsletter = null): ?NewsletterModel {
if (!$newsletter) return null;
$newsletterModel = NewsletterModel::where('id', $newsletter->getId())->findOne();
if ($newsletterModel) return $newsletterModel;
return null;
}
// temporary function until Links are refactored to Doctrine
private function getQueueModel(SendingQueueEntity $queue = null): ?SendingQueue {
if (!$queue) return null;
$queueModel = SendingQueue::where('id', $queue->getId())->findOne();
if ($queueModel) return $queueModel;
return null;
}
}

62
lib/Newsletter/Shortcodes/Categories/Newsletter.php
View File

@@ -2,45 +2,59 @@
namespace MailPoet\Newsletter\Shortcodes\Categories;
use MailPoet\Models\Newsletter as NewsletterModel;
use MailPoet\Entities\NewsletterEntity;
use MailPoet\Entities\SendingQueueEntity;
use MailPoet\Entities\SubscriberEntity;
use MailPoet\Newsletter\NewslettersRepository;
use MailPoet\WP\Functions as WPFunctions;
use MailPoet\WP\Posts as WPPosts;
class Newsletter {
public static function process(
$shortcodeDetails,
$newsletter,
$subscriber,
$queue,
$content
) {
class Newsletter implements CategoryInterface {
/** @var NewslettersRepository */
private $newslettersRepository;
public function __construct(NewslettersRepository $newslettersRepository) {
$this->newslettersRepository = $newslettersRepository;
}
public function process(
array $shortcodeDetails,
NewsletterEntity $newsletter = null,
SubscriberEntity $subscriber = null,
SendingQueueEntity $queue = null,
string $content = '',
bool $wpUserPreview = false
): ?string {
switch ($shortcodeDetails['action']) {
case 'subject':
return ($newsletter) ? $newsletter->subject : false;
return ($newsletter instanceof NewsletterEntity) ? $newsletter->getSubject() : null;
case 'total':
return substr_count($content, 'data-post-id');
return (string)substr_count($content, 'data-post-id');
case 'post_title':
preg_match_all('/data-post-id="(\d+)"/ism', $content, $posts);
$postIds = array_unique($posts[1]);
$latestPost = (!empty($postIds)) ? self::getLatestWPPost($postIds) : false;
return ($latestPost) ? $latestPost['post_title'] : false;
$latestPost = (!empty($postIds)) ? $this->getLatestWPPost($postIds) : null;
return ($latestPost) ? $latestPost['post_title'] : null;
case 'number':
if ($newsletter->type !== NewsletterModel::TYPE_NOTIFICATION_HISTORY) return false;
$sentNewsletters =
NewsletterModel::where('parent_id', $newsletter->parentId)
->where('status', NewsletterModel::STATUS_SENT)
->count();
return ++$sentNewsletters;
if (!($newsletter instanceof NewsletterEntity)) return null;
if ($newsletter->getType() !== NewsletterEntity::TYPE_NOTIFICATION_HISTORY) {
return null;
}
$sentNewsletters = $this->newslettersRepository->countBy([
'parent' => $newsletter->getParent(),
'status' => NewsletterEntity::STATUS_SENT,
]);
return (string)++$sentNewsletters;
default:
return false;
return null;
}
}
public static function ensureConsistentQueryType(\WP_Query $query) {
public function ensureConsistentQueryType(\WP_Query $query) {
// Queries with taxonomies are autodetected as 'is_archive=true' and 'is_home=false'
// while queries without them end up being 'is_archive=false' and 'is_home=true'.
// This is to fix that by always enforcing constistent behavior.
@@ -48,10 +62,10 @@ class Newsletter {
$query->is_home = false; // phpcs:ignore Squiz.NamingConventions.ValidVariableName.NotCamelCaps
}
private static function getLatestWPPost($postIds) {
private function getLatestWPPost($postIds) {
// set low priority to execute 'ensureConstistentQueryType' before any other filter
$filterPriority = defined('PHP_INT_MIN') ? constant('PHP_INT_MIN') : ~PHP_INT_MAX;
WPFunctions::get()->addAction('pre_get_posts', [get_called_class(), 'ensureConsistentQueryType'], $filterPriority);
WPFunctions::get()->addAction('pre_get_posts', [$this, 'ensureConsistentQueryType'], $filterPriority);
$posts = new \WP_Query(
[
'post_type' => WPPosts::getTypes(),
@@ -62,7 +76,7 @@ class Newsletter {
'order' => 'DESC',
]
);
WPFunctions::get()->removeAction('pre_get_posts', [get_called_class(), 'ensureConsistentQueryType'], $filterPriority);
WPFunctions::get()->removeAction('pre_get_posts', [$this, 'ensureConsistentQueryType'], $filterPriority);
return (!empty($posts->posts[0])) ?
$posts->posts[0]->to_array() :
false;

69
lib/Newsletter/Shortcodes/Categories/Subscriber.php
View File

@@ -2,52 +2,67 @@
namespace MailPoet\Newsletter\Shortcodes\Categories;
use MailPoet\Models\Subscriber as SubscriberModel;
use MailPoet\Models\SubscriberCustomField;
use MailPoet\Entities\NewsletterEntity;
use MailPoet\Entities\SendingQueueEntity;
use MailPoet\Entities\SubscriberCustomFieldEntity;
use MailPoet\Entities\SubscriberEntity;
use MailPoet\Subscribers\SubscriberCustomFieldRepository;
use MailPoet\Subscribers\SubscribersRepository;
use MailPoet\WP\Functions as WPFunctions;
class Subscriber {
/**
* @param \MailPoet\Models\Subscriber|false|mixed $subscriber
*/
public static function process(
$shortcodeDetails,
$newsletter,
$subscriber
class Subscriber implements CategoryInterface {
/** @var SubscribersRepository */
private $subscribersRepository;
/** @var SubscriberCustomFieldRepository */
private $subscriberCustomFieldRepository;
public function __construct(
SubscribersRepository $subscribersRepository,
SubscriberCustomFieldRepository $subscriberCustomFieldRepository
) {
if ($subscriber !== false && !($subscriber instanceof SubscriberModel)) {
return $shortcodeDetails['shortcode'];
}
$this->subscribersRepository = $subscribersRepository;
$this->subscriberCustomFieldRepository = $subscriberCustomFieldRepository;
}
public function process(
array $shortcodeDetails,
NewsletterEntity $newsletter = null,
SubscriberEntity $subscriber = null,
SendingQueueEntity $queue = null,
string $content = '',
bool $wpUserPreview = false
): ?string {
$defaultValue = ($shortcodeDetails['action_argument'] === 'default') ?
$shortcodeDetails['action_argument_value'] :
'';
switch ($shortcodeDetails['action']) {
case 'firstname':
return (!empty($subscriber->firstName)) ? $subscriber->firstName : $defaultValue;
return (($subscriber instanceof SubscriberEntity) && !empty($subscriber->getFirstName())) ? $subscriber->getFirstName() : $defaultValue;
case 'lastname':
return (!empty($subscriber->lastName)) ? $subscriber->lastName : $defaultValue;
return (($subscriber instanceof SubscriberEntity) && !empty($subscriber->getLastName())) ? $subscriber->getLastName() : $defaultValue;
case 'email':
return ($subscriber) ? $subscriber->email : false;
return ($subscriber instanceof SubscriberEntity) ? $subscriber->getEmail() : $defaultValue;
case 'displayname':
if ($subscriber && $subscriber->wpUserId) {
$wpUser = WPFunctions::get()->getUserdata($subscriber->wpUserId);
if (($subscriber instanceof SubscriberEntity) && $subscriber->getWpUserId()) {
$wpUser = WPFunctions::get()->getUserdata($subscriber->getWpUserId());
return $wpUser->user_login; // phpcs:ignore Squiz.NamingConventions.ValidVariableName.NotCamelCaps
}
return $defaultValue;
case 'count':
return SubscriberModel::filter('subscribed')
->count();
return (string)$this->subscribersRepository->getTotalSubscribers();
default:
if (preg_match('/cf_(\d+)/', $shortcodeDetails['action'], $customField) &&
!empty($subscriber->id)
!empty($subscriber->getId())
) {
$customField = SubscriberCustomField
::where('subscriber_id', $subscriber->id)
->where('custom_field_id', $customField[1])
->findOne();
return ($customField instanceof SubscriberCustomField) ? $customField->value : false;
$customField = $this->subscriberCustomFieldRepository->findOneBy([
'subscriber' => $subscriber,
'customField' => $customField[1],
]);
return ($customField instanceof SubscriberCustomFieldEntity) ? $customField->getValue() : null;
}
return false;
return null;
}
}
}