You are here

class GroupAddBookBlock in Open Social 8.9

Same name and namespace in other branches
  1. 8.3 modules/social_features/social_book/src/Plugin/Block/GroupAddBookBlock.php \Drupal\social_book\Plugin\Block\GroupAddBookBlock
  2. 8.4 modules/social_features/social_book/src/Plugin/Block/GroupAddBookBlock.php \Drupal\social_book\Plugin\Block\GroupAddBookBlock
  3. 8.5 modules/social_features/social_book/src/Plugin/Block/GroupAddBookBlock.php \Drupal\social_book\Plugin\Block\GroupAddBookBlock
  4. 8.6 modules/social_features/social_book/src/Plugin/Block/GroupAddBookBlock.php \Drupal\social_book\Plugin\Block\GroupAddBookBlock
  5. 8.7 modules/social_features/social_book/src/Plugin/Block/GroupAddBookBlock.php \Drupal\social_book\Plugin\Block\GroupAddBookBlock
  6. 8.8 modules/social_features/social_book/src/Plugin/Block/GroupAddBookBlock.php \Drupal\social_book\Plugin\Block\GroupAddBookBlock
  7. 10.3.x modules/social_features/social_book/src/Plugin/Block/GroupAddBookBlock.php \Drupal\social_book\Plugin\Block\GroupAddBookBlock
  8. 10.0.x modules/social_features/social_book/src/Plugin/Block/GroupAddBookBlock.php \Drupal\social_book\Plugin\Block\GroupAddBookBlock
  9. 10.1.x modules/social_features/social_book/src/Plugin/Block/GroupAddBookBlock.php \Drupal\social_book\Plugin\Block\GroupAddBookBlock
  10. 10.2.x modules/social_features/social_book/src/Plugin/Block/GroupAddBookBlock.php \Drupal\social_book\Plugin\Block\GroupAddBookBlock

Provides a 'GroupAddBookBlock' block.

Plugin annotation


@Block(
 id = "group_add_book_block",
 admin_label = @Translation("Group add book block"),
)

Hierarchy

Expanded class hierarchy of GroupAddBookBlock

File

modules/social_features/social_book/src/Plugin/Block/GroupAddBookBlock.php, line 19

Namespace

Drupal\social_book\Plugin\Block
View source
class GroupAddBookBlock extends BlockBase {

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'label_display' => FALSE,
    ];
  }

  /**
   * {@inheritdoc}
   *
   * Custom access logic to display the block.
   */
  public function blockAccess(AccountInterface $account) {
    if (\Drupal::moduleHandler()
      ->moduleExists('social_group')) {
      $group = _social_group_get_current_group();
    }
    else {
      $group = NULL;
    }
    if (is_object($group)) {
      if ($group
        ->hasPermission('create group_node:book entity', $account) && $account
        ->hasPermission("create book content")) {
        if ($group
          ->getGroupType()
          ->id() === 'public_group') {
          $config = \Drupal::config('entity_access_by_field.settings');
          if ($config
            ->get('disable_public_visibility') === 1 && !$account
            ->hasPermission('override disabled public visibility')) {
            return AccessResult::forbidden();
          }
        }
        return AccessResult::allowed();
      }
    }

    // By default, the block is not visible.
    return AccessResult::forbidden();
  }

  /**
   * {@inheritdoc}
   */
  public function build() {
    $build = [];
    if (\Drupal::moduleHandler()
      ->moduleExists('social_group')) {
      $group = _social_group_get_current_group();
    }
    else {
      $group = NULL;
    }
    if (is_object($group)) {
      $url = Url::fromUserInput("/group/{$group->id()}/content/create/group_node:book");
      $link_options = [
        'attributes' => [
          'class' => [
            'btn',
            'btn-primary',
            'btn-raised',
            'waves-effect',
            'brand-bg-primary',
          ],
        ],
      ];
      $url
        ->setOptions($link_options);
      $build['content'] = Link::fromTextAndUrl(t('Create book page'), $url)
        ->toRenderable();

      // Cache.
      $build['#cache']['contexts'][] = 'url.path';
      $build['#cache']['tags'][] = 'group:' . $group
        ->id();
    }
    return $build;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BlockPluginInterface::BLOCK_LABEL_VISIBLE constant Indicates the block label (title) should be displayed to end users.
BlockPluginTrait::$transliteration protected property The transliteration service.
BlockPluginTrait::access public function
BlockPluginTrait::baseConfigurationDefaults protected function Returns generic default configuration for block plugins.
BlockPluginTrait::blockForm public function 16
BlockPluginTrait::blockSubmit public function 13
BlockPluginTrait::blockValidate public function 3
BlockPluginTrait::buildConfigurationForm public function Creates a generic configuration form for all block types. Individual block plugins can add elements to this form by overriding BlockBase::blockForm(). Most block plugins should not override this method unless they need to alter the generic form elements. 2
BlockPluginTrait::calculateDependencies public function
BlockPluginTrait::getConfiguration public function 1
BlockPluginTrait::getMachineNameSuggestion public function 1
BlockPluginTrait::getPreviewFallbackString public function 3
BlockPluginTrait::label public function
BlockPluginTrait::setConfiguration public function
BlockPluginTrait::setConfigurationValue public function
BlockPluginTrait::setTransliteration public function Sets the transliteration service.
BlockPluginTrait::submitConfigurationForm public function Most block plugins should not override this method. To add submission handling for a specific block type, override BlockBase::blockSubmit().
BlockPluginTrait::transliteration protected function Wraps the transliteration service.
BlockPluginTrait::validateConfigurationForm public function Most block plugins should not override this method. To add validation for a specific block type, override BlockBase::blockValidate(). 1
BlockPluginTrait::__construct public function 22
ContextAwarePluginAssignmentTrait::addContextAssignmentElement protected function Builds a form element for assigning a context to a given slot.
ContextAwarePluginAssignmentTrait::contextHandler protected function Wraps the context handler.
ContextAwarePluginBase::$context protected property The data objects representing the context of this plugin.
ContextAwarePluginBase::$contexts Deprecated private property Data objects representing the contexts passed in the plugin configuration.
ContextAwarePluginBase::createContextFromConfiguration protected function Overrides ContextAwarePluginBase::createContextFromConfiguration
ContextAwarePluginBase::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts 9
ContextAwarePluginBase::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge 7
ContextAwarePluginBase::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags 4
ContextAwarePluginBase::getContext public function This code is identical to the Component in order to pick up a different Context class. Overrides ContextAwarePluginBase::getContext
ContextAwarePluginBase::getContextDefinition public function Overrides ContextAwarePluginBase::getContextDefinition
ContextAwarePluginBase::getContextDefinitions public function Overrides ContextAwarePluginBase::getContextDefinitions
ContextAwarePluginBase::getContextMapping public function Gets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::getContextMapping
ContextAwarePluginBase::getContexts public function Gets the defined contexts. Overrides ContextAwarePluginInterface::getContexts
ContextAwarePluginBase::getContextValue public function Gets the value for a defined context. Overrides ContextAwarePluginInterface::getContextValue
ContextAwarePluginBase::getContextValues public function Gets the values for all defined contexts. Overrides ContextAwarePluginInterface::getContextValues
ContextAwarePluginBase::setContext public function Set a context on this plugin. Overrides ContextAwarePluginBase::setContext
ContextAwarePluginBase::setContextMapping public function Sets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::setContextMapping
ContextAwarePluginBase::setContextValue public function Sets the value for a defined context. Overrides ContextAwarePluginBase::setContextValue
ContextAwarePluginBase::validateContexts public function Validates the set values for the defined contexts. Overrides ContextAwarePluginInterface::validateContexts
ContextAwarePluginBase::__get public function Implements magic __get() method.
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
GroupAddBookBlock::blockAccess public function Custom access logic to display the block. Overrides BlockPluginTrait::blockAccess
GroupAddBookBlock::build public function Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
GroupAddBookBlock::defaultConfiguration public function Overrides BlockPluginTrait::defaultConfiguration
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginWithFormsTrait::getFormClass public function
PluginWithFormsTrait::hasFormClass public function
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
TypedDataTrait::$typedDataManager protected property The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager public function Gets the typed data manager. 2
TypedDataTrait::setTypedDataManager public function Sets the typed data manager. 2