class EventRequestEnrollmentNotification in Open Social 8.9

Same name and namespace in other branches

10.3.x modules/social_features/social_event/src/Plugin/Block/EventRequestEnrollmentNotification.php \Drupal\social_event\Plugin\Block\EventRequestEnrollmentNotification
10.0.x modules/social_features/social_event/src/Plugin/Block/EventRequestEnrollmentNotification.php \Drupal\social_event\Plugin\Block\EventRequestEnrollmentNotification
10.1.x modules/social_features/social_event/src/Plugin/Block/EventRequestEnrollmentNotification.php \Drupal\social_event\Plugin\Block\EventRequestEnrollmentNotification
10.2.x modules/social_features/social_event/src/Plugin/Block/EventRequestEnrollmentNotification.php \Drupal\social_event\Plugin\Block\EventRequestEnrollmentNotification

Provides a 'Event requests notification' block.

Plugin annotation


@Block(
  id = "event_requests_notification",
  admin_label = @Translation("Event requests notification"),
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Component\Plugin\ContextAwarePluginBase implements ContextAwarePluginInterface
  - class \Drupal\Core\Plugin\ContextAwarePluginBase implements CacheableDependencyInterface, ContextAwarePluginInterface uses DependencySerializationTrait, StringTranslationTrait, TypedDataTrait
    class \Drupal\Core\Block\BlockBase implements BlockPluginInterface, PluginWithFormsInterface, PreviewFallbackInterface uses BlockPluginTrait, ContextAwarePluginAssignmentTrait
    class \Drupal\social_event\Plugin\Block\EventRequestEnrollmentNotification implements ContainerFactoryPluginInterface

Expanded class hierarchy of EventRequestEnrollmentNotification

File

modules/social_features/social_event/src/Plugin/Block/EventRequestEnrollmentNotification.php, line 30

Namespace

Drupal\social_event\Plugin\Block

View source

class EventRequestEnrollmentNotification extends BlockBase implements ContainerFactoryPluginInterface {

  /**
   * Event entity.
   *
   * @var \Drupal\Core\Entity\EntityInterface|null
   */
  protected $event;

  /**
   * Entity type manger.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Translation manager.
   *
   * @var \Drupal\Core\StringTranslation\TranslationManager
   */
  protected $translation;

  /**
   * Current route match.
   *
   * @var \Drupal\Core\Routing\RouteMatchInterface
   */
  protected $routeMatch;

  /**
   * The logger factory.
   *
   * @var \Drupal\Core\Logger\LoggerChannelFactoryInterface
   */
  protected $loggerFactory;

  /**
   * Constructs SocialGroupRequestMembershipNotification.
   *
   * @param array $configuration
   *   Configuration array.
   * @param string $plugin_id
   *   Plugin ID.
   * @param mixed $plugin_definition
   *   Plugin definition.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\Core\StringTranslation\TranslationManager $translation
   *   The translation manager.
   * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
   *   Current route match.
   * @param \Drupal\Core\Logger\LoggerChannelFactoryInterface $logger_factory
   *   The logger factory service.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager, TranslationManager $translation, RouteMatchInterface $route_match, LoggerChannelFactoryInterface $logger_factory) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->event = social_event_get_current_event();
    $this->entityTypeManager = $entity_type_manager;
    $this->translation = $translation;
    $this->routeMatch = $route_match;
    $this->loggerFactory = $logger_factory;
  }

  /**
   * {@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'), $container
      ->get('string_translation'), $container
      ->get('current_route_match'), $container
      ->get('logger.factory'));
  }

  /**
   * {@inheritdoc}
   */
  public function build() : array {

    // No event? Don't bother anymore.
    if (!$this->event instanceof NodeInterface) {
      return [];
    }

    // Don't continue if we don't have the correct enroll method for this event.
    if ((int) $this->event
      ->getFieldValue('field_enroll_method', 'value') !== EventEnrollmentInterface::ENROLL_METHOD_REQUEST) {
      return [];
    }

    // At this point we try to get the amount of pending requests.
    try {
      $requests = $this->entityTypeManager
        ->getStorage('event_enrollment')
        ->getQuery()
        ->condition('field_event.target_id', $this->event
        ->id())
        ->condition('field_request_or_invite_status.value', EventEnrollmentInterface::REQUEST_PENDING)
        ->condition('field_enrollment_status.value', '0')
        ->count()
        ->execute();
      if (!$requests) {
        return [];
      }
      return [
        '#type' => 'html_tag',
        '#tag' => 'div',
        '#value' => $this
          ->t('There @link to enroll in this event.', [
          '@link' => Link::fromTextAndUrl($this->translation
            ->formatPlural($requests, 'is (1) new request', 'are (@count) new requests'), Url::fromRoute('view.event_manage_enrollment_requests.page_manage_enrollment_requests', [
            'node' => $this->event
              ->id(),
          ]))
            ->toString(),
        ]),
        '#attributes' => [
          'class' => [
            'alert',
            'alert-warning',
          ],
        ],
      ];
    } catch (InvalidPluginDefinitionException $e) {
      $this->loggerFactory
        ->get('social_event')
        ->error($e
        ->getMessage());
    } catch (PluginNotFoundException $e) {
      $this->loggerFactory
        ->get('social_event')
        ->error($e
        ->getMessage());
    }

    // Catch all.
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function access(AccountInterface $account, $return_as_object = FALSE) {
    $is_event_page = isset($this->event);

    // Show this block only on these specific routes.
    // We can't use the Block UI as you can't specify just the node canonical
    // route.
    $routes = [
      'entity.node.canonical',
      'view.event_enrollments.view_enrollments',
      'view.event_manage_enrollments.page_manage_enrollments',
      'view.event_manage_enrollment_invites.page_manage_enrollment_invites',
      'view.manage_enrollments.page',
      'view.managers.view_managers',
      'social_event_managers.add_enrollees',
      'social_event_managers.vbo.execute_configurable',
      'social_event_managers.vbo.confirm',
    ];

    // We have an event and it's part of the above list of routes.
    if ($this->event instanceof NodeInterface && in_array($this->routeMatch
      ->getRouteName(), $routes, TRUE)) {
      return AccessResult::allowedIf($is_event_page && social_event_manager_or_organizer($this->event));
    }
    return AccessResult::forbidden();
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheContexts() {
    $contexts = parent::getCacheContexts();

    // Ensure the context keeps track of the URL so we don't see the message on
    // every event.
    $contexts = Cache::mergeContexts($contexts, [
      'url',
      'user.permissions',
    ]);
    return $contexts;
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheTags() {
    return Cache::mergeTags(parent::getCacheTags(), [
      'event_enrollment_list:' . $this->event
        ->id(),
    ]);
  }

}

Members

Name	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::baseConfigurationDefaults	protected	function	Returns generic default configuration for block plugins.
BlockPluginTrait::blockAccess	protected	function	Indicates whether the block should be shown.	16
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::defaultConfiguration	public	function		19
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
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::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge	7
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
EventRequestEnrollmentNotification::$entityTypeManager	protected	property	Entity type manger.
EventRequestEnrollmentNotification::$event	protected	property	Event entity.
EventRequestEnrollmentNotification::$loggerFactory	protected	property	The logger factory.
EventRequestEnrollmentNotification::$routeMatch	protected	property	Current route match.
EventRequestEnrollmentNotification::$translation	protected	property	Translation manager.
EventRequestEnrollmentNotification::access	public	function	Overrides BlockPluginTrait::access
EventRequestEnrollmentNotification::build	public	function	Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
EventRequestEnrollmentNotification::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
EventRequestEnrollmentNotification::getCacheContexts	public	function	The cache contexts associated with this object. Overrides ContextAwarePluginBase::getCacheContexts
EventRequestEnrollmentNotification::getCacheTags	public	function	The cache tags associated with this object. Overrides ContextAwarePluginBase::getCacheTags
EventRequestEnrollmentNotification::__construct	public	function	Constructs SocialGroupRequestMembershipNotification. Overrides BlockPluginTrait::__construct
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

You are here

class EventRequestEnrollmentNotification in Open Social 8.9

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation