You are here

abstract class BaseJobAction in TMGMT Extension Suite 8

Same name and namespace in other branches
  1. 8.3 src/Plugin/Action/BaseJobAction.php \Drupal\tmgmt_extension_suit\Plugin\Action\BaseJobAction
  2. 8.2 src/Plugin/Action/BaseJobAction.php \Drupal\tmgmt_extension_suit\Plugin\Action\BaseJobAction

Hierarchy

Expanded class hierarchy of BaseJobAction

File

src/Plugin/Action/BaseJobAction.php, line 14

Namespace

Drupal\tmgmt_extension_suit\Plugin\Action
View source
abstract class BaseJobAction extends ActionBase implements ContainerFactoryPluginInterface {

  /**
   * The tempstore factory.
   *
   * @var \Drupal\user\PrivateTempStoreFactory
   */
  protected $tempStoreFactory;

  /**
   * The current user.
   *
   * @var \Drupal\Core\Session\AccountInterface
   */
  protected $currentUser;

  /**
   * Creates TranslateNode action.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin ID for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\user\PrivateTempStoreFactory $temp_store_factory
   *   The tempstore factory.
   * @param \Drupal\Core\Session\AccountInterface $current_user
   *   Current user.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, PrivateTempStoreFactory $temp_store_factory, AccountInterface $current_user) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->currentUser = $current_user;
    $this->tempStoreFactory = $temp_store_factory;
  }

  /**
   * {@inheritdoc}
   */
  public function access($object, AccountInterface $account = NULL, $return_as_object = FALSE) {

    //** @var \Drupal\node\NodeInterface $object */

    // @todo Move the check to own service.
    $result = content_translation_translate_access($object);

    //return $return_as_object ? $result : $result->isAllowed();
    return TRUE;
  }
  protected abstract function getTempStoreName($entity_type = '');

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('user.private_tempstore'), $container
      ->get('current_user'));
  }

  /**
   * {@inheritdoc}
   */
  public function executeMultiple(array $entities) {
    $ids = [];

    /** @var \Drupal\Core\Entity\ContentEntityInterface $entity */
    foreach ($entities as $entity) {
      $ids[$entity
        ->id()] = $entity
        ->getEntityTypeId();
    }
    $entity = reset($entities);
    if ($entity instanceof EntityInterface) {
      $entity_type = $entity
        ->getEntityTypeId();
    }
    $this->tempStoreFactory
      ->get($this
      ->getTempStoreName($entity_type))
      ->set($this->currentUser
      ->id(), $ids);
  }

  /**
   * {@inheritdoc}
   */
  public function execute(ContentEntityInterface $entity = NULL) {
    $this
      ->executeMultiple([
      $entity,
    ]);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BaseJobAction::$currentUser protected property The current user.
BaseJobAction::$tempStoreFactory protected property The tempstore factory.
BaseJobAction::access public function Checks object access. Overrides ActionInterface::access
BaseJobAction::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
BaseJobAction::execute public function Executes the plugin. Overrides ExecutableInterface::execute
BaseJobAction::executeMultiple public function Executes the plugin for an array of objects. Overrides ActionBase::executeMultiple
BaseJobAction::getTempStoreName abstract protected function 5
BaseJobAction::__construct public function Creates TranslateNode action. Overrides PluginBase::__construct
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
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.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.