RulesActionBase.php

<?php

namespace Drupal\rules\Core;

use Drupal\Component\Plugin\Exception\ContextException;
use Drupal\Core\Access\AccessResult;
use Drupal\Core\Plugin\ContextAwarePluginTrait;
use Drupal\Core\Plugin\PluginBase;
use Drupal\Core\Session\AccountInterface;
use Drupal\rules\Context\ContextProviderTrait;

/**
 * Base class for rules actions.
 */
abstract class RulesActionBase extends PluginBase implements RulesActionInterface {
    use ContextAwarePluginTrait {
        getContextValue as protected traitGetContextValue;
    }
    use ContextProviderTrait;
    use ExecutablePluginTrait;
    use ConfigurationAccessControlTrait;
    
    /**
     * The plugin configuration.
     *
     * @var array
     */
    protected $configuration;
    
    /**
     * {@inheritdoc}
     */
    public function getContextValue($name) {
        try {
            return $this->traitGetContextValue($name);
        } catch (ContextException $e) {
            // Catch the undocumented exception thrown when no context value is set
            // for a required context.
            // @todo Remove once https://www.drupal.org/node/2677162 is fixed.
            if (strpos($e->getMessage(), 'context is required') === FALSE) {
                throw $e;
            }
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function refineContextDefinitions(array $selected_data) {
        // Do not refine anything by default.
    }
    
    /**
     * {@inheritdoc}
     */
    public function assertMetadata(array $selected_data) {
        // Nothing to assert by default.
        return [];
    }
    
    /**
     * {@inheritdoc}
     *
     * @todo this documentation is not actually inherited from any interface.
     */
    public function getConfiguration() {
        return [
            'id' => $this->getPluginId(),
        ] + $this->configuration;
    }
    
    /**
     * {@inheritdoc}
     *
     * @todo this documentation is not actually inherited from any interface.
     */
    public function setConfiguration(array $configuration) {
        $this->configuration = $configuration + $this->defaultConfiguration();
        return $this;
    }
    
    /**
     * {@inheritdoc}
     *
     * @todo this documentation is not actually inherited from any interface.
     * Do we need this empty implementation?
     */
    public function defaultConfiguration() {
        return [];
    }
    
    /**
     * {@inheritdoc}
     *
     * @todo this documentation is not actually inherited from any interface.
     * Do we need this empty implementation?
     */
    public function calculateDependencies() {
        return [];
    }
    
    /**
     * {@inheritdoc}
     *
     * @todo this documentation is not actually inherited from any interface.
     * Do we need this empty implementation?
     */
    public function executeMultiple(array $objects) {
        // @todo Remove this once it is removed from the interface.
    }
    
    /**
     * {@inheritdoc}
     */
    public function autoSaveContext() {
        // Per default no context parameters will be auto saved.
        return [];
    }
    
    /**
     * {@inheritdoc}
     */
    public function access($object, AccountInterface $account = NULL, $return_as_object = FALSE) {
        // Just deny access per default for now.
        if ($return_as_object) {
            return AccessResult::forbidden();
        }
        return FALSE;
    }
    
    /**
     * {@inheritdoc}
     */
    public function execute() {
        // Provide a reasonable default implementation that calls doExecute() while
        // passing the defined context as arguments.
        $args = [];
        foreach ($this->getContextDefinitions() as $name => $definition) {
            $value = $this->getContextValue($name);
            $type = $definition->toArray()['type'];
            if (substr($type, 0, 6) == 'entity') {
                if (is_array($value) && is_string($value[0])) {
                    $value = array_map([
                        $this,
                        'upcastEntityId',
                    ], $value, array_fill(0, count($value), $type));
                }
                elseif (is_string($value)) {
                    $value = $this->upcastEntityId($value, $type);
                }
            }
            $args[$name] = $value;
        }
        call_user_func_array([
            $this,
            'doExecute',
        ], $args);
    }

}