abstract class ActivityActionBase in Open Social 10.2.x

Base class for Activity action plugins.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\activity_creator\Plugin\ActivityActionBase implements ActivityActionInterface

3 files declare their use of ActivityActionBase

CreateActivityAction.php in modules/custom/activity_basics/src/Plugin/ActivityAction/CreateActivityAction.php

MoveActivityAction.php in modules/custom/activity_basics/src/Plugin/ActivityAction/MoveActivityAction.php

UpdateActivityAction.php in modules/custom/activity_basics/src/Plugin/ActivityAction/UpdateActivityAction.php

File

modules/custom/activity_creator/src/Plugin/ActivityActionBase.php, line 11

Namespace

Drupal\activity_creator\Plugin

abstract class ActivityActionBase extends PluginBase implements ActivityActionInterface {

  /**
   * {@inheritdoc}
   */
  public function create($entity) {
    if ($this
      ->isValidEntity($entity)) {
      $this
        ->createMessage($entity);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function createMessage($entity) {

    // Use the queue logger.
    $activity_logger_factory = \Drupal::service('activity_logger.activity_factory');

    // Create messages for all other types of content.
    $activity_logger_factory
      ->createMessages($entity, $this->pluginId);
  }

  /**
   * {@inheritdoc}
   */
  public function isValidEntity($entity) {

    // Turn off this feature for all non-content entities.
    if (!$entity instanceof ContentEntityInterface) {
      return FALSE;
    }
    return TRUE;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ActivityActionBase::create	public	function	Creates a new message on the action with some logic behind it. Overrides ActivityActionInterface::create	1
ActivityActionBase::createMessage	public	function	Dumb function that can be called to create the message. Overrides ActivityActionInterface::createMessage
ActivityActionBase::isValidEntity	public	function	Checks if this is a valid entity for the action. Overrides ActivityActionInterface::isValidEntity
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	2
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.	98