AutomationSendEmailSubjectResolver.php — MailPoet – Newsletters, Email Marketing, and Automation 5.34.2

mailpoet / lib / Automation / Integrations / MailPoet / Actions / AutomationSendEmailSubjectResolver.php

mailpoet / lib / Automation / Integrations / MailPoet / Actions Last commit date

AutomationSendEmailSubjectResolver.php 1 month ago SendEmailAction.php 1 month ago SendLatestNewsletterAction.php 2 months ago index.php 3 years ago

AutomationSendEmailSubjectResolver.php

161 lines

1	<?php declare(strict_types = 1);
2
3	namespace MailPoet\Automation\Integrations\MailPoet\Actions;
4
5	if (!defined('ABSPATH')) exit;
6
7
8	use MailPoet\Automation\Engine\Control\SubjectTransformerHandler;
9	use MailPoet\Automation\Engine\Data\Automation;
10	use MailPoet\Automation\Engine\Data\Step;
11	use MailPoet\Automation\Engine\Registry;
12	use MailPoet\Entities\NewsletterEntity;
13	use MailPoet\Entities\NewsletterOptionFieldEntity;
14
15	class AutomationSendEmailSubjectResolver {
16	private Registry $registry;
17	private SubjectTransformerHandler $subjectTransformerHandler;
18
19	public function __construct(
20	Registry $registry,
21	SubjectTransformerHandler $subjectTransformerHandler
22	) {
23	$this->registry = $registry;
24	$this->subjectTransformerHandler = $subjectTransformerHandler;
25	}
26
27	/** @return string[] */
28	public function getGuaranteedSubjectKeysForStep(Automation $automation, Step $sendEmailStep): array {
29	if ($sendEmailStep->getKey() !== SendEmailAction::KEY) {
30	return [];
31	}
32
33	$triggerSteps = $this->getTriggerStepsReachingStep($automation, $sendEmailStep);
34	if ($triggerSteps === []) {
35	return [];
36	}
37
38	return $this->intersectTriggerSubjectKeys($triggerSteps);
39	}
40
41	/** @return string[] */
42	public function getGuaranteedSubjectKeysForEmail(Automation $automation, NewsletterEntity $newsletter): array {
43	$exactStep = $this->getExactSendEmailStep($automation, $newsletter);
44	if ($exactStep) {
45	return $this->getGuaranteedSubjectKeysForStep($automation, $exactStep);
46	}
47
48	$steps = $this->getSendEmailStepsReferencingNewsletter($automation, $newsletter);
49	if ($steps === []) {
50	return [];
51	}
52
53	$subjectKeySets = array_map(function (Step $step) use ($automation): array {
54	return $this->getGuaranteedSubjectKeysForStep($automation, $step);
55	}, $steps);
56
57	return $this->intersectSubjectKeySets($subjectKeySets);
58	}
59
60	public function hasGuaranteedSubjectForEmail(Automation $automation, NewsletterEntity $newsletter, string $subjectKey): bool {
61	return in_array($subjectKey, $this->getGuaranteedSubjectKeysForEmail($automation, $newsletter), true);
62	}
63
64	/** @return Step[] */
65	private function getTriggerStepsReachingStep(Automation $automation, Step $targetStep): array {
66	$triggerSteps = [];
67	foreach ($automation->getTriggers() as $triggerStep) {
68	if ($this->stepCanReachStep($automation, $triggerStep, $targetStep)) {
69	$triggerSteps[] = $triggerStep;
70	}
71	}
72	return $triggerSteps;
73	}
74
75	private function stepCanReachStep(Automation $automation, Step $fromStep, Step $toStep): bool {
76	$steps = $automation->getSteps();
77	$stack = [$fromStep->getId()];
78	$visited = [];
79
80	while ($stack !== []) {
81	$stepId = array_pop($stack);
82	if (!is_string($stepId) \|\| isset($visited[$stepId])) {
83	continue;
84	}
85	$visited[$stepId] = true;
86
87	if ($stepId === $toStep->getId()) {
88	return true;
89	}
90
91	$step = $steps[$stepId] ?? null;
92	if (!$step instanceof Step) {
93	continue;
94	}
95
96	foreach ($step->getNextStepIds() as $nextStepId) {
97	$stack[] = $nextStepId;
98	}
99	}
100
101	return false;
102	}
103
104	/** @param Step[] $triggerSteps */
105	private function intersectTriggerSubjectKeys(array $triggerSteps): array {
106	$subjectKeySets = [];
107	foreach ($triggerSteps as $triggerStep) {
108	$trigger = $this->registry->getTrigger($triggerStep->getKey());
109	if (!$trigger) {
110	return [];
111	}
112	$subjectKeySets[] = $this->subjectTransformerHandler->getSubjectKeysForTrigger($trigger);
113	}
114
115	return $this->intersectSubjectKeySets($subjectKeySets);
116	}
117
118	/** @param array<int, string[]> $subjectKeySets */
119	private function intersectSubjectKeySets(array $subjectKeySets): array {
120	if ($subjectKeySets === []) {
121	return [];
122	}
123
124	$subjectKeys = array_shift($subjectKeySets);
125	foreach ($subjectKeySets as $nextSubjectKeys) {
126	$subjectKeys = array_values(array_intersect($subjectKeys, $nextSubjectKeys));
127	}
128	$subjectKeys = array_values(array_unique($subjectKeys));
129	sort($subjectKeys);
130	return $subjectKeys;
131	}
132
133	private function getExactSendEmailStep(Automation $automation, NewsletterEntity $newsletter): ?Step {
134	$stepId = $newsletter->getOptionValue(NewsletterOptionFieldEntity::NAME_AUTOMATION_STEP_ID);
135	if (!is_string($stepId) \|\| $stepId === '') {
136	return null;
137	}
138
139	$step = $automation->getStep($stepId);
140	return $step instanceof Step && $step->getKey() === SendEmailAction::KEY ? $step : null;
141	}
142
143	/** @return Step[] */
144	private function getSendEmailStepsReferencingNewsletter(Automation $automation, NewsletterEntity $newsletter): array {
145	$newsletterId = $newsletter->getId();
146	$wpPostId = $newsletter->getWpPostId();
147
148	return array_values(array_filter($automation->getSteps(), function (Step $step) use ($newsletterId, $wpPostId): bool {
149	if ($step->getKey() !== SendEmailAction::KEY) {
150	return false;
151	}
152
153	$args = $step->getArgs();
154	$emailId = $args['email_id'] ?? null;
155	$emailWpPostId = $args['email_wp_post_id'] ?? null;
156	return ($newsletterId !== null && (int)$emailId === (int)$newsletterId)
157	\|\| ($wpPostId !== null && (int)$emailWpPostId === (int)$wpPostId);
158	}));
159	}
160	}
161