class EntityCreate

Provides a generic 'Create a new entity' action.

@todo Add access callback information from Drupal 7.

Plugin annotation


@RulesAction(
  id = "rules_entity_create",
  deriver = "Drupal\rules\Plugin\RulesAction\EntityCreateDeriver"
)

Hierarchy

Expanded class hierarchy of EntityCreate

File

src/Plugin/RulesAction/EntityCreate.php, line 20

Namespace

Drupal\rules\Plugin\RulesAction
View source 
class EntityCreate extends RulesActionBase implements ContainerFactoryPluginInterface {
    
    /**
     * The entity storage service.
     *
     * @var \Drupal\Core\Entity\EntityStorageInterface
     */
    protected $storage;
    
    /**
     * The entity type id.
     *
     * @var string
     */
    protected $entityTypeId;
    
    /**
     * The entity bundle key used for the entity type.
     *
     * @var string
     */
    protected $bundleKey;
    
    /**
     * Constructs an EntityCreate 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\Core\Entity\EntityStorageInterface $storage
     *   The entity storage service.
     */
    public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityStorageInterface $storage) {
        parent::__construct($configuration, $plugin_id, $plugin_definition);
        $this->storage = $storage;
        $this->entityTypeId = $plugin_definition['entity_type_id'];
        $this->bundleKey = $plugin_definition['bundle_key'];
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
        return new static($configuration, $plugin_id, $plugin_definition, $container->get('entity_type.manager')
            ->getStorage($plugin_definition['entity_type_id']));
    }
    
    /**
     * {@inheritdoc}
     */
    public function refineContextDefinitions(array $selected_data) {
        if ($type = $this->entityTypeId) {
            $data_type = "entity:{$type}";
            if ($this->bundleKey && ($bundle = $this->getContextValue($this->bundleKey))) {
                $data_type .= ":{$bundle}";
            }
            $this->pluginDefinition['provides'][$type . '_created']
                ->setDataType($data_type);
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function execute() {
        $values = $this->getContextValues();
        $entity = $this->storage
            ->create($values);
        $this->setProvidedValue($this->entityTypeId . '_created', $entity);
    }

}

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.
EntityCreate::$bundleKey protected property The entity bundle key used for the entity type.
EntityCreate::$entityTypeId protected property The entity type id.
EntityCreate::$storage protected property The entity storage service.
EntityCreate::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
EntityCreate::execute public function Executes the plugin. Overrides RulesActionBase::execute
EntityCreate::refineContextDefinitions public function Refines used and provided context definitions based upon context values. Overrides RulesActionBase::refineContextDefinitions
EntityCreate::__construct public function Constructs an EntityCreate 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::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::setConfiguration public function @todo this documentation is not actually inherited from any interface.