class TestDebugLogAction

Provides an action writing an error to the Rules debug logger channel.

Plugin annotation


@RulesAction(
  id = "rules_test_debug_log",
  label = @Translation("Test action debug logging"),
  category = @Translation("Tests"),
  context_definitions = {
    "message" = @ContextDefinition("string",
      label = @Translation("Message to log"),
      required = FALSE
    ),
  }
)

Hierarchy

Expanded class hierarchy of TestDebugLogAction

File

tests/modules/rules_test/src/Plugin/RulesAction/TestDebugLogAction.php, line 25

Namespace

Drupal\rules_test\Plugin\RulesAction
View source 
class TestDebugLogAction extends RulesActionBase implements ContainerFactoryPluginInterface {
    
    /**
     * Rules debug logger instance.
     *
     * @var \Drupal\rules\Logger\RulesDebugLoggerChannel
     */
    protected $logger;
    
    /**
     * Constructs a TestDebugLogAction object.
     *
     * @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\rules\Logger\RulesDebugLoggerChannel $logger
     *   Rules debug logger object.
     */
    public function __construct(array $configuration, $plugin_id, $plugin_definition, RulesDebugLoggerChannel $logger) {
        parent::__construct($configuration, $plugin_id, $plugin_definition);
        $this->logger = $logger;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
        return new static($configuration, $plugin_id, $plugin_definition, $container->get('logger.channel.rules_debug'));
    }
    
    /**
     * Writes an error message to the debug log.
     *
     * @param string $message
     *   Message string that should be logged. Defaults to "action called".
     */
    protected function doExecute($message = NULL) {
        if (empty($message)) {
            $message = 'action called';
        }
        $this->logger
            ->error($message);
    }

}

Members

Title Modifiers Object type Summary Member alias Overriden Title Overrides
ConfigurationAccessControlTrait::checkConfigurationAccess public function Checks configuration permission.
ContextAwarePluginTrait::$context protected property The data objects representing the context of this plugin.
ContextAwarePluginTrait::$initializedContextConfig protected property Tracks whether the context has been initialized from configuration.
ContextAwarePluginTrait::getCacheContexts public function 9
ContextAwarePluginTrait::getCacheMaxAge public function 7
ContextAwarePluginTrait::getCacheTags public function 4
ContextAwarePluginTrait::getContext public function
ContextAwarePluginTrait::getContextDefinition public function
ContextAwarePluginTrait::getContextDefinitions public function
ContextAwarePluginTrait::getContextMapping public function
ContextAwarePluginTrait::getContexts public function
ContextAwarePluginTrait::getContextValue public function Aliased as: traitGetContextValue
ContextAwarePluginTrait::getContextValues public function
ContextAwarePluginTrait::getPluginDefinition abstract public function 1
ContextAwarePluginTrait::setContext public function 1
ContextAwarePluginTrait::setContextMapping public function
ContextAwarePluginTrait::setContextValue public function
ContextAwarePluginTrait::validateContexts public function
ContextProviderTrait::$providedContext protected property The data objects that are provided by this plugin.
ContextProviderTrait::getProvidedContext public function
ContextProviderTrait::getProvidedContextDefinition public function
ContextProviderTrait::getProvidedContextDefinitions public function
ContextProviderTrait::setProvidedValue public function
ContextProviderTrait::upcastEntityId public function Upcasts an entity id to a full entity object.
ExecutablePluginTrait::getLabelValue protected function Get the translated label from the plugin definition.
ExecutablePluginTrait::summary public function Get the translated summary from the label annotation. 4
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
RulesActionBase::$configuration protected property The plugin configuration.
RulesActionBase::access public function Checks object access. Overrides RulesActionInterface::access
RulesActionBase::assertMetadata public function Asserts additional metadata for the selected data. Overrides ContextAwarePluginInterface::assertMetadata
RulesActionBase::autoSaveContext public function Returns a list of context names that should be auto-saved after execution. Overrides RulesActionInterface::autoSaveContext 14
RulesActionBase::calculateDependencies public function @todo this documentation is not actually inherited from any interface.
Do we need this empty implementation?
RulesActionBase::defaultConfiguration public function @todo this documentation is not actually inherited from any interface.
Do we need this empty implementation?
RulesActionBase::execute public function Executes the plugin. Overrides ExecutableInterface::execute 2
RulesActionBase::executeMultiple public function @todo this documentation is not actually inherited from any interface.
Do we need this empty implementation?
RulesActionBase::getConfiguration public function @todo this documentation is not actually inherited from any interface.
RulesActionBase::getContextValue public function Gets the value for a defined context. Overrides ContextAwarePluginInterface::getContextValue
RulesActionBase::refineContextDefinitions public function Refines used and provided context definitions based upon context values. Overrides ContextAwarePluginInterface::refineContextDefinitions 5
RulesActionBase::setConfiguration public function @todo this documentation is not actually inherited from any interface.
TestDebugLogAction::$logger protected property Rules debug logger instance.
TestDebugLogAction::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
TestDebugLogAction::doExecute protected function Writes an error message to the debug log.
TestDebugLogAction::__construct public function Constructs a TestDebugLogAction object.