Spaces:
No application file
No application file
File size: 8,857 Bytes
d2897cd |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 |
<?php
namespace Mautic\CampaignBundle\Event;
use Mautic\CampaignBundle\Event\Exception\KeyAlreadyRegisteredException;
use Mautic\CoreBundle\Event\ComponentValidationTrait;
use Symfony\Contracts\EventDispatcher\Event;
use Symfony\Contracts\Translation\TranslatorInterface;
class CampaignBuilderEvent extends Event
{
use ComponentValidationTrait;
private array $decisions = [];
private array $conditions = [];
private array $actions = [];
/**
* Holds info if some property has been already sorted or not.
*/
private array $sortCache = [];
public function __construct(
private TranslatorInterface $translator
) {
}
/**
* Add an lead decision to the list of available .
*
* @param string $key a unique identifier; it is recommended that it be namespaced i.e. lead.mytrigger
* @param array $decision can contain the following keys:
* $decision = [
* 'label' => (required) what to display in the list
* 'eventName' => (required) The event name to fire when this event is triggered.
* 'description' => (optional) short description of event
* 'formType' => (optional) name of the form type SERVICE for the action
* 'formTypeOptions' => (optional) array of options to pass to the formType service
* 'formTheme' => (optional) form theme
* 'connectionRestrictions' => (optional) Array of events to restrict this event to. Implicit events
* [
* 'anchor' => [], // array of anchors this event should _not_ be allowed to connect to in the format of eventType.anchorName, e.g. decision.no
* 'source' => ['action' => [], 'decision' => [], 'condition' => []], // array of event keys allowed to connect into this event
* 'target' => ['action' => [], 'decision' => [], 'condition' => []], // array of event keys allowed to flow from this event
* ]
* ]
*/
public function addDecision($key, array $decision): void
{
if (array_key_exists($key, $this->decisions)) {
throw new KeyAlreadyRegisteredException("The key, '$key' is already used by another contact action. Please use a different key.");
}
// check for required keys and that given functions are callable
$this->verifyComponent(
['label', ['eventName', 'callback']],
$decision,
['callback']
);
$decision['label'] = $this->translator->trans($decision['label']);
$decision['description'] = (isset($decision['description'])) ? $this->translator->trans($decision['description']) : '';
$this->decisions[$key] = $decision;
}
/**
* @return mixed
*/
public function getDecisions()
{
return $this->sort('decisions');
}
/**
* Add an lead condition to the list of available conditions.
*
* @param string $key a unique identifier; it is recommended that it be namespaced i.e. lead.mytrigger
* @param array $event can contain the following keys:
* $condition = [
* 'label' => (required) what to display in the list
* 'eventName' => (required) The event name to fire when this event is triggered.
* 'description' => (optional) short description of event
* 'formType' => (optional) name of the form type SERVICE for the action
* 'formTypeOptions' => (optional) array of options to pass to the formType service
* 'formTheme' => (optional) form theme
* 'connectionRestrictions' => (optional) Array of events to restrict this event to. Implicit events
* [
* 'anchor' => [], // array of anchors this event should _not_ be allowed to connect to in the format of eventType.anchorName, e.g. decision.no
* 'source' => ['action' => [], 'decision' => [], 'condition' => []], // array of event keys allowed to connect into this event
* 'target' => ['action' => [], 'decision' => [], 'condition' => []], // array of event keys allowed to flow from this event
* ]
* ]
*/
public function addCondition($key, array $event): void
{
if (array_key_exists($key, $this->conditions)) {
throw new KeyAlreadyRegisteredException("The key, '$key' is already used by another contact action. Please use a different key.");
}
// check for required keys and that given functions are callable
$this->verifyComponent(
['label', ['eventName', 'callback']],
$event,
['callback']
);
$event['label'] = $this->translator->trans($event['label']);
$event['description'] = (isset($event['description'])) ? $this->translator->trans($event['description']) : '';
$this->conditions[$key] = $event;
}
/**
* Get lead conditions.
*
* @return array
*/
public function getConditions()
{
return $this->sort('conditions');
}
/**
* Add an action to the list of available .
*
* @param string $key a unique identifier; it is recommended that it be namespaced i.e. lead.action
* @param array $action can contain the following keys:
* $action = [
* 'label' => (required) what to display in the list
* 'eventName' => (required) The event to fire when this event is triggered.
* 'description' => (optional) short description of event
* 'formType' => (optional) name of the form type SERVICE for the action
* 'formTypeOptions' => (optional) array of options to pass to the formType service
* 'formTheme' => (optional) form theme
* 'timelineTemplate' => (optional) custom template for the lead timeline
* 'connectionRestrictions' => (optional) Array of events to restrict this event to. Implicit events
* [
* 'anchor' => [], // array of anchors this event should _not_ be allowed to connect to in the format of eventType.anchorName, e.g. decision.no
* 'source' => ['action' => [], 'decision' => [], 'condition' => []], // array of event keys allowed to connect into this event
* 'target' => ['action' => [], 'decision' => [], 'condition' => []], // array of event keys allowed to flow from this event
* ]
* ]
*/
public function addAction($key, array $action): void
{
if (array_key_exists($key, $this->actions)) {
throw new KeyAlreadyRegisteredException("The key, '$key' is already used by another action. Please use a different key.");
}
// check for required keys and that given functions are callable
$this->verifyComponent(
['label', ['batchEventName', 'eventName', 'callback']],
$action,
['callback']
);
// translate the group
$action['label'] = $this->translator->trans($action['label']);
$action['description'] = (isset($action['description'])) ? $this->translator->trans($action['description']) : '';
$this->actions[$key] = $action;
}
/**
* Get actions.
*
* @return array
*/
public function getActions()
{
return $this->sort('actions');
}
/**
* Sort internal actions, decisions and conditions arrays.
*
* @param string $property name
*
* @return array
*/
protected function sort($property)
{
if (empty($this->sortCache[$property])) {
uasort(
$this->{$property},
fn ($a, $b): int => strnatcasecmp(
$a['label'],
$b['label']
)
);
$this->sortCache[$property] = true;
}
return $this->{$property};
}
}
|