class ParagraphsLockablePlugin

Provides a Paragraphs Lockable plugin.

Plugin annotation


@ParagraphsBehavior(
  id = "lockable",
  label = @Translation("Lock editing"),
  description = @Translation("Prevent from editing without special permission."),
  weight = 3
)

Hierarchy

Expanded class hierarchy of ParagraphsLockablePlugin

1 file declares its use of ParagraphsLockablePlugin
paragraphs_collection.module in paragraphs_collection/paragraphs_collection.module
Contains paragraphs_collection.module

File

paragraphs_collection/src/Plugin/paragraphs/Behavior/ParagraphsLockablePlugin.php, line 28

Namespace

Drupal\paragraphs_collection\Plugin\paragraphs\Behavior
View source
class ParagraphsLockablePlugin extends ParagraphsBehaviorBase {

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

  /**
   * Constructs a new ParagraphsLockablePlugin 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\EntityFieldManager $entity_field_manager
   *   Entity Field Manager for base.
   * @param \Drupal\Core\Session\AccountProxyInterface $currentUser
   *   Current user for permissions scope.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityFieldManager $entity_field_manager, AccountProxyInterface $currentUser) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $entity_field_manager);
    $this->currentUser = $currentUser;
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildBehaviorForm(ParagraphInterface $paragraph, array &$form, FormStateInterface $form_state) {

    // Only display if this plugin is enabled and the user has the permissions.
    $form['locked'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Lock content'),
      '#description' => $this
        ->t('If selected this paragraph content will be locked for anyone without the appropriate permission.'),
      '#default_value' => $paragraph
        ->getBehaviorSetting($this
        ->getPluginId(), 'locked'),
      '#access' => $this->currentUser
        ->hasPermission('administer lockable paragraph'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function view(array &$build, Paragraph $paragraphs_entity, EntityViewDisplayInterface $display, $view_mode) {

    // This implementation of view does nothing.
    // As this behavior affects the back end and not the display to the user.
  }

  /**
   * Check the access for the paragraph based on the lockable setting.
   *
   * Only add content access controls if:
   *  Not a view operation
   *  Lockable Behavior is enabled
   *  Lockable has the locked value set as true.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The paragraph entity.
   * @param string $operation
   *   The current operation.
   * @param \Drupal\Core\Session\AccountInterface $account
   *   The current logged in user.
   *
   * @return \Drupal\Core\Access\AccessResult
   *    The access result, will be false if the paragraph is locked
   *    and the user does not have the appropriate permission.
   */
  public static function determineParagraphAccess(EntityInterface $entity, $operation, AccountInterface $account) {

    /** @var ParagraphsType $paragraphs_type */
    $paragraphs_type = $entity
      ->getParagraphType();
    if ($operation !== 'view' && $entity
      ->getBehaviorSetting('lockable', 'locked') && $paragraphs_type
      ->hasEnabledBehaviorPlugin('lockable')) {
      $accessResult = AccessResult::forbiddenIf(!$account
        ->hasPermission('administer lockable paragraph'));
    }
    else {
      $accessResult = AccessResult::neutral();
    }
    $accessResult
      ->addCacheableDependency($entity);
    $accessResult
      ->addCacheableDependency($paragraphs_type);
    return $accessResult;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary(Paragraph $paragraph) {
    $locked = $paragraph
      ->getBehaviorSetting($this
      ->getPluginId(), 'locked');
    $summary = [
      [
        'value' => $this
          ->t('Locked'),
      ],
    ];
    return $locked ? $summary : [];
  }

}

Members

Name Modifierssort descending Type Description Overrides
ParagraphsBehaviorBase::filterBehaviorFormSubmitValues protected function Removes default behavior form values before storing the user-set ones.
ParagraphsLockablePlugin::$currentUser protected property The current user.
ParagraphsBehaviorBase::$entityFieldManager protected property The entity field manager.
ParagraphsLockablePlugin::__construct public function Constructs a new ParagraphsLockablePlugin object. Overrides ParagraphsBehaviorBase::__construct
ParagraphsLockablePlugin::buildBehaviorForm public function Builds a behavior perspective for each paragraph based on its type. Overrides ParagraphsBehaviorBase::buildBehaviorForm
ParagraphsLockablePlugin::view public function Extends the paragraph render array with behavior. Overrides ParagraphsBehaviorInterface::view
ParagraphsLockablePlugin::settingsSummary public function Returns a short summary for the current behavior settings. Overrides ParagraphsBehaviorBase::settingsSummary
ParagraphsBehaviorBase::buildConfigurationForm public function 7
ParagraphsBehaviorBase::validateConfigurationForm public function 6
ParagraphsBehaviorBase::submitConfigurationForm public function 6
ParagraphsBehaviorBase::defaultConfiguration public function 7
ParagraphsBehaviorBase::getConfiguration public function
ParagraphsBehaviorBase::setConfiguration public function
ParagraphsBehaviorBase::calculateDependencies public function
ParagraphsBehaviorBase::preprocess public function Adds a default set of helper variables for preprocessors and templates. Overrides ParagraphsBehaviorInterface::preprocess 1
ParagraphsBehaviorBase::validateBehaviorForm public function Validates the behavior fields form. Overrides ParagraphsBehaviorInterface::validateBehaviorForm 1
ParagraphsBehaviorBase::submitBehaviorForm public function Submit the values taken from the form to store the values. Overrides ParagraphsBehaviorInterface::submitBehaviorForm 3
ParagraphsBehaviorBase::getFieldNameOptions public function Returns list of field names for the given paragraph type and field type. Overrides ParagraphsBehaviorInterface::getFieldNameOptions
ParagraphsBehaviorBase::settingsIcon public function Returns a short info icon for the current behavior settings. Overrides ParagraphsBehaviorInterface::settingsIcon 1
ParagraphsLockablePlugin::create public static function Overrides ParagraphsBehaviorBase::create
ParagraphsLockablePlugin::determineParagraphAccess public static function Check the access for the paragraph based on the lockable setting.
ParagraphsBehaviorBase::isApplicable public static function Returns if the plugin can be used for the provided Paragraphs type. Overrides ParagraphsBehaviorInterface::isApplicable 1