abstract class SmsGatewayPluginBase in SMS Framework 2.x
Same name and namespace in other branches
- 8 src/Plugin/SmsGatewayPluginBase.php \Drupal\sms\Plugin\SmsGatewayPluginBase
- 2.1.x src/Plugin/SmsGatewayPluginBase.php \Drupal\sms\Plugin\SmsGatewayPluginBase
Base class for sms gateway plugins.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\sms\Plugin\SmsGatewayPluginBase implements SmsGatewayPluginInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of SmsGatewayPluginBase
4 files declare their use of SmsGatewayPluginBase
- DefaultCapabilities.php in tests/
modules/ sms_test_gateway/ src/ Plugin/ SmsGateway/ DefaultCapabilities.php - Incoming.php in tests/
modules/ sms_test_gateway/ src/ Plugin/ SmsGateway/ Incoming.php - Memory.php in tests/
modules/ sms_test_gateway/ src/ Plugin/ SmsGateway/ Memory.php - NoIncoming.php in tests/
modules/ sms_test_gateway/ src/ Plugin/ SmsGateway/ NoIncoming.php
File
- src/
Plugin/ SmsGatewayPluginBase.php, line 16
Namespace
Drupal\sms\PluginView source
abstract class SmsGatewayPluginBase extends PluginBase implements SmsGatewayPluginInterface {
/**
* Constructs a new SmsGateway plugin.
*
* @param array $configuration
* The configuration to use and build the sms gateway.
* @param string $plugin_id
* The gateway id.
* @param mixed $plugin_definition
* The gateway plugin definition.
*/
public function __construct(array $configuration, $plugin_id, $plugin_definition) {
parent::__construct($configuration, $plugin_id, $plugin_definition);
$this
->setConfiguration($configuration);
}
/**
* {@inheritdoc}
*/
public function getConfiguration() {
return $this->configuration;
}
/**
* {@inheritdoc}
*/
public function setConfiguration(array $configuration) {
$this->configuration = NestedArray::mergeDeep($this
->defaultConfiguration(), $configuration);
}
/**
* {@inheritdoc}
*/
public function defaultConfiguration() {
return [];
}
/**
* {@inheritdoc}
*/
public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
return $form;
}
/**
* {@inheritdoc}
*/
public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
}
/**
* {@inheritdoc}
*/
public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
}
/**
* {@inheritdoc}
*/
public function calculateDependencies() {
return [];
}
/**
* {@inheritdoc}
*/
public function getCreditsBalance() {
return NULL;
}
/**
* {@inheritdoc}
*/
public function parseDeliveryReports(Request $request, Response $response) {
return [];
}
/**
* {@inheritdoc}
*/
public function getDeliveryReports(array $message_ids = NULL) {
return [];
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
MessengerTrait:: |
protected | property | The messenger. | 27 |
MessengerTrait:: |
public | function | Gets the messenger. | 27 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
2 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
SmsGatewayPluginBase:: |
public | function |
Form constructor. Overrides PluginFormInterface:: |
1 |
SmsGatewayPluginBase:: |
public | function |
Calculates dependencies for the configured plugin. Overrides DependentPluginInterface:: |
|
SmsGatewayPluginBase:: |
public | function |
Gets default configuration for this plugin. Overrides ConfigurableInterface:: |
1 |
SmsGatewayPluginBase:: |
public | function |
Gets this plugin's configuration. Overrides ConfigurableInterface:: |
|
SmsGatewayPluginBase:: |
public | function |
Returns the credit balance available on this gateway. Overrides SmsGatewayPluginInterface:: |
1 |
SmsGatewayPluginBase:: |
public | function |
Gets delivery reports from the gateway. Overrides SmsGatewayPluginInterface:: |
1 |
SmsGatewayPluginBase:: |
public | function |
Parses incoming delivery reports and returns the created delivery reports. Overrides SmsGatewayPluginInterface:: |
1 |
SmsGatewayPluginBase:: |
public | function |
Sets the configuration for this plugin instance. Overrides ConfigurableInterface:: |
|
SmsGatewayPluginBase:: |
public | function |
Form submission handler. Overrides PluginFormInterface:: |
1 |
SmsGatewayPluginBase:: |
public | function |
Form validation handler. Overrides PluginFormInterface:: |
|
SmsGatewayPluginBase:: |
public | function |
Constructs a new SmsGateway plugin. Overrides PluginBase:: |
|
SmsGatewayPluginInterface:: |
public | function | Sends an SMS. | 4 |
StringTranslationTrait:: |
protected | property | The string translation service. | 4 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |