Spaces:
No application file
No application file
File size: 4,302 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 |
<?php
namespace Mautic\PointBundle\Event;
use Symfony\Component\Process\Exception\InvalidArgumentException;
use Symfony\Contracts\EventDispatcher\Event;
use Symfony\Contracts\Translation\TranslatorInterface;
class PointBuilderEvent extends Event
{
private array $actions = [];
public function __construct(
private TranslatorInterface $translator
) {
}
/**
* Adds 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:
* 'label' => (required) what to display in the list
* 'description' => (optional) short description of event
* 'template' => (optional) template to use for the action's HTML in the point builder
* i.e AcmeMyBundle:PointAction:theaction.html.twig
* 'formType' => (optional) name of the form type SERVICE for the action; will use a default form with point change only
* 'formTypeOptions' => (optional) array of options to pass to formType
* 'callback' => (optional) callback function that will be passed when the action is triggered; return true to
* change the configured points or false to ignore the action
* The callback function can receive the following arguments by name (via ReflectionMethod::invokeArgs())
* Mautic\CoreBundle\Factory\MauticFactory $factory
* Mautic\LeadBundle\Entity\Lead $lead
* $eventDetails - variable sent from firing function to call back function
* array $action = array(
* 'id' => int
* 'type' => string
* 'name' => string
* 'properties' => array()
* )
*
* @throws InvalidArgumentException
*/
public function addAction($key, array $action): void
{
if (array_key_exists($key, $this->actions)) {
throw new InvalidArgumentException("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(
['group', 'label'],
['callback'],
$action
);
// translate the label and group
$action['label'] = $this->translator->trans($action['label']);
$action['group'] = $this->translator->trans($action['group']);
$this->actions[$key] = $action;
}
/**
* @return array
*/
public function getActions()
{
uasort($this->actions, fn ($a, $b): int => strnatcasecmp(
$a['label'], $b['label']));
return $this->actions;
}
/**
* Gets a list of actions supported by the choice form field.
*/
public function getActionList(): array
{
$list = [];
$actions = $this->getActions();
foreach ($actions as $k => $a) {
$list[$k] = $a['label'];
}
return $list;
}
/**
* @return mixed[]
*/
public function getActionChoices(): array
{
$choices = [];
foreach ($this->actions as $k => $c) {
$choices[$c['group']][$c['label']] = $k;
}
return $choices;
}
/**
* @throws InvalidArgumentException
*/
private function verifyComponent(array $keys, array $methods, array $component): void
{
foreach ($keys as $k) {
if (!array_key_exists($k, $component)) {
throw new InvalidArgumentException("The key, '$k' is missing.");
}
}
foreach ($methods as $m) {
if (isset($component[$m]) && !is_callable($component[$m], true)) {
throw new InvalidArgumentException($component[$m].' is not callable. Please ensure that it exists and that it is a fully qualified namespace.');
}
}
}
}
|