class EntitySave

Provides a 'Save entity' action.

@todo Add access callback information from Drupal 7.

Plugin annotation

@RulesAction(
  id = "rules_entity_save",
  label = @Translation("Save entity"),
  category = @Translation("Entity"),
  context_definitions = {
    "entity" = @ContextDefinition("entity",
      label = @Translation("Entity"),
      description = @Translation("Specifies the entity, which should be saved permanently."),
      assignment_restriction = "selector"
    ),
    "immediate" = @ContextDefinition("boolean",
      label = @Translation("Force saving immediately"),
      description = @Translation("Usually saving is postponed till the end of the evaluation, so that multiple saves can be fold into one. If this set, saving is forced to happen immediately."),
      assignment_restriction = "input",
      options_provider = "\Drupal\rules\TypedData\Options\YesNoOptions",
      default_value = FALSE,
      required = FALSE
    ),
  }
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
    • class \Drupal\rules\Core\RulesActionBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\rules\Core\RulesActionInterface uses \Drupal\Core\Plugin\ContextAwarePluginTrait, \Drupal\rules\Context\ContextProviderTrait, \Drupal\rules\Core\ExecutablePluginTrait, \Drupal\rules\Core\ConfigurationAccessControlTrait
      • class \Drupal\rules\Plugin\RulesAction\EntitySave extends \Drupal\rules\Core\RulesActionBase

Expanded class hierarchy of EntitySave

File

src/Plugin/RulesAction/EntitySave.php, line 34

Namespace

class EntitySave extends RulesActionBase {
    
    /**
     * Flag that indicates if the entity should be auto-saved later.
     *
     * @var bool
     */
    protected $saveLater = TRUE;
    
    /**
     * Saves the Entity.
     *
     * @param \Drupal\Core\Entity\EntityInterface $entity
     *   The entity to be saved.
     * @param bool $immediate
     *   (optional) Save the entity immediately.
     */
    protected function doExecute(EntityInterface $entity, $immediate) {
        // We only need to do something here if the immediate flag is set, otherwise
        // the entity will be auto-saved after the execution.
        if ((bool) $immediate) {
            $entity->save();
            $this->saveLater = FALSE;
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function autoSaveContext() {
        if ($this->saveLater) {
            return [
                'entity',
            ];
        }
        return [];
    }

}

Members