class EmailFrequencyBase in Open Social 8.7

Class EmailFrequencyBase.

Implements common functions for all EmailFrequency classes.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\activity_send_email\EmailFrequencyBase implements EmailFrequencyInterface

4 files declare their use of EmailFrequencyBase

Daily.php in modules/custom/activity_send/modules/activity_send_email/src/Plugin/EmailFrequency/Daily.php

Immediately.php in modules/custom/activity_send/modules/activity_send_email/src/Plugin/EmailFrequency/Immediately.php

None.php in modules/custom/activity_send/modules/activity_send_email/src/Plugin/EmailFrequency/None.php

Weekly.php in modules/custom/activity_send/modules/activity_send_email/src/Plugin/EmailFrequency/Weekly.php

File

modules/custom/activity_send/modules/activity_send_email/src/EmailFrequencyBase.php, line 16

Namespace

Drupal\activity_send_email

class EmailFrequencyBase extends PluginBase implements EmailFrequencyInterface {

  /**
   * {@inheritdoc}
   */
  public function getName() {
    return $this->pluginDefinition['name'];
  }

  /**
   * {@inheritdoc}
   */
  public function getWeight() {
    return $this->pluginDefinition['weight'];
  }

  /**
   * {@inheritdoc}
   */
  public function getInterval() {
    return $this->pluginDefinition['interval'];
  }

  /**
   * {@inheritdoc}
   */
  public function processItem(Activity $activity, Message $message, User $target) {
    $db = Database::getConnection();

    // Insert incoming activities in our digest table.
    $db
      ->insert('user_activity_digest')
      ->fields([
      'uid',
      'activity',
      'frequency',
      'timestamp',
    ])
      ->values([
      $target
        ->id(),
      $activity
        ->id(),
      $this->pluginId,
      time(),
    ])
      ->execute();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
EmailFrequencyBase::getInterval	public	function	Return the interval of the email frequency in seconds. Overrides EmailFrequencyInterface::getInterval
EmailFrequencyBase::getName	public	function	Return the name of the email frequency. Overrides EmailFrequencyInterface::getName
EmailFrequencyBase::getWeight	public	function	Return the weight of the frequency option. Overrides EmailFrequencyInterface::getWeight
EmailFrequencyBase::processItem	public	function	Processes an activity item. Overrides EmailFrequencyInterface::processItem	2
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92