Spaces:
No application file
No application file
File size: 3,011 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 |
<?php
namespace Mautic\ChannelBundle\Event;
use Mautic\ChannelBundle\Model\MessageModel;
use Mautic\CoreBundle\Event\CommonEvent;
class ChannelEvent extends CommonEvent
{
/**
* @var array
*/
protected $channels = [];
/**
* @var array
*/
protected $featureChannels = [];
/**
* Adds a submit action to the list of available actions.
*
* @param string $channel a unique identifier; it is recommended that it be namespaced if there are multiple entities in a channel i.e. something.something
* @param array $config Should be keyed by the feature it supports that contains an array of feature configuration options. i.e.
* $config = [
* MessageModel::CHANNEL_FEATURE => [
* 'lookupFormType' => (optional) Form type class/alias for the channel lookup list,
* 'propertiesFormType' => (optional) Form type class/alias for the channel properties if a lookup list is not used,
*
* 'channelTemplate' => (optional) template to inject UI/DOM into the bottom of the channel's tab
* 'formTheme' => (optional) theme directory for custom form types
*
* ]
* ]
*
* @return $this
*/
public function addChannel($channel, array $config = [])
{
$this->channels[$channel] = $config;
foreach ($config as $feature => $featureConfig) {
$this->featureChannels[$feature][$channel] = $featureConfig;
}
return $this;
}
/**
* Returns registered channels with their configs.
*
* @return array
*/
public function getChannelConfigs()
{
return $this->channels;
}
/**
* Returns repository name for the provided channel. Defaults to classic naming convention.
*
* @param string $channel
*
* @return string
*/
public function getRepositoryName($channel)
{
if (isset($this->channels[$channel][MessageModel::CHANNEL_FEATURE]['repository'])) {
return $this->channels[$channel][MessageModel::CHANNEL_FEATURE]['repository'];
}
// if not defined, try the classic naming convention
$channel = ucfirst($channel);
$class = "\Mautic\\{$channel}Bundle\Entity\\{$channel}";
\assert(class_exists($class));
return $class;
}
/**
* Returns the name of the column holding the channel name for the provided channel. Defaults to 'name'.
*
* @param string $channel
*
* @return string
*/
public function getNameColumn($channel)
{
return $this->channels[$channel][MessageModel::CHANNEL_FEATURE]['nameColumn'] ?? 'name';
}
/**
* @return array
*/
public function getFeatureChannels()
{
return $this->featureChannels;
}
}
|