class GroupInviteLocalTask in Open Social 10.3.x

Provides a local task that shows the amount of group invites.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Menu\LocalTaskDefault implements CacheableDependencyInterface, LocalTaskInterface uses DependencySerializationTrait
    • class \Drupal\social_group_invite\Plugin\Menu\LocalTask\GroupInviteLocalTask implements ContainerFactoryPluginInterface uses StringTranslationTrait

1 string reference to 'GroupInviteLocalTask'

social_group_invite.links.task.yml in modules/social_features/social_group/modules/social_group_invite/social_group_invite.links.task.yml

modules/social_features/social_group/modules/social_group_invite/social_group_invite.links.task.yml

File

modules/social_features/social_group/modules/social_group_invite/src/Plugin/Menu/LocalTask/GroupInviteLocalTask.php, line 18

Namespace

Drupal\social_group_invite\Plugin\Menu\LocalTask

class GroupInviteLocalTask extends LocalTaskDefault implements ContainerFactoryPluginInterface {
  use StringTranslationTrait;

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

  /**
   * Group invitations loader.
   *
   * @var \Drupal\ginvite\GroupInvitationLoaderInterface
   */
  protected $invitationLoader;

  /**
   * Construct the UnapprovedComments 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 array $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Routing\RouteMatchInterface $routeMatch
   *   The route match.
   * @param \Drupal\ginvite\GroupInvitationLoaderInterface $invitationLoader
   *   The invite loader.
   */
  public function __construct(array $configuration, $plugin_id, array $plugin_definition, RouteMatchInterface $routeMatch, GroupInvitationLoaderInterface $invitationLoader) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->routeMatch = $routeMatch;
    $this->invitationLoader = $invitationLoader;
  }

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

  /**
   * {@inheritdoc}
   */
  public function getTitle(Request $request = NULL) {
    if ($this->invitationLoader
      ->loadByUser()) {

      // We don't need plural because users will be redirected
      // if there is no invite.
      return $this
        ->t('Group invites (@count)', [
        '@count' => count($this->invitationLoader
          ->loadByUser()),
      ]);
    }
    return $this
      ->t('Group invites');
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheTags() {
    $tags = [];
    $user = $this->routeMatch
      ->getParameter('user');

    // Add cache tags for group invite.
    // These are cleared based on entity:user->id
    // for the group content plugin group_invitation.
    if ($user instanceof UserInterface) {
      $tags[] = 'group_content_list:entity:' . $user
        ->id();
      $tags[] = 'group_content_list:plugin:group_invitation:entity:' . $user
        ->id();
    }
    if (is_string($user)) {
      $tags[] = 'group_content_list:entity:' . $user;
      $tags[] = 'group_content_list:plugin:group_invitation:entity:' . $user;
    }
    return Cache::mergeTags(parent::getCacheTags(), $tags);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
GroupInviteLocalTask::$invitationLoader	protected	property	Group invitations loader.
GroupInviteLocalTask::$routeMatch	protected	property	The route match.
GroupInviteLocalTask::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
GroupInviteLocalTask::getCacheTags	public	function	The cache tags associated with this object. Overrides LocalTaskDefault::getCacheTags
GroupInviteLocalTask::getTitle	public	function	Returns the localized title to be shown for this tab. Overrides LocalTaskDefault::getTitle
GroupInviteLocalTask::__construct	public	function	Construct the UnapprovedComments object. Overrides PluginBase::__construct
LocalTaskDefault::$active	protected	property	TRUE if this plugin is forced active for options attributes.
LocalTaskDefault::$routeProvider	protected	property	The route provider to load routes by name.
LocalTaskDefault::getActive	public	function	Gets the active status. Overrides LocalTaskInterface::getActive
LocalTaskDefault::getCacheContexts	public	function	The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts
LocalTaskDefault::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge
LocalTaskDefault::getOptions	public	function	Returns options for rendering a link to the local task. Overrides LocalTaskInterface::getOptions
LocalTaskDefault::getRouteName	public	function	Get the route name from the settings. Overrides LocalTaskInterface::getRouteName
LocalTaskDefault::getRouteParameters	public	function	Returns the route parameters needed to render a link for the local task. Overrides LocalTaskInterface::getRouteParameters	1
LocalTaskDefault::getWeight	public	function	Returns the weight of the local task. Overrides LocalTaskInterface::getWeight
LocalTaskDefault::routeProvider	protected	function	Returns the route provider.
LocalTaskDefault::setActive	public	function	Sets the active status. Overrides LocalTaskInterface::setActive
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	2
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.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
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.