You are here

class CountLink in Flag 8.4

Provides the Count link type.

This class is an extension of the Ajax link type, but modified to provide flag count.

Plugin annotation


@ActionLinkType(
  id = "count_link",
  label = @Translation("Count link"),
  description = "An example AJAX action link which displays the count with the flag."
)

Hierarchy

Expanded class hierarchy of CountLink

File

modules/flag_count/src/Plugin/ActionLink/CountLink.php, line 21

Namespace

Drupal\flag_count\Plugin\ActionLink
View source
class CountLink extends AJAXactionLink {

  /**
   * {@inheritdoc}
   */
  public function getAsFlagLink(FlagInterface $flag, EntityInterface $entity) {

    // Get the render array.
    $build = parent::getAsFlagLink($flag, $entity);

    // Normally, you'd just override flag.html.twig in your site's theme. For
    // this example module, we do something more advanced: Provide a new
    // @ActionLinkType that changes the default theme function.
    $build['#theme'] = 'flag_count';

    // Return the modified render array.
    return $build;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ActionLinkTypeBase::$currentUser protected property The current user.
ActionLinkTypeBase::buildConfigurationForm public function Provides a form array for the action link plugin's settings form. Overrides PluginFormInterface::buildConfigurationForm 1
ActionLinkTypeBase::calculateDependencies public function
ActionLinkTypeBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration 1
ActionLinkTypeBase::getAction protected function Helper method to get the next flag action the user can take.
ActionLinkTypeBase::getAsLink public function Get the action link as a Link object. Overrides ActionLinkTypePluginInterface::getAsLink
ActionLinkTypeBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ActionLinkTypeBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
ActionLinkTypeBase::submitConfigurationForm public function Processes the action link setting form submit. Overrides PluginFormInterface::submitConfigurationForm 1
ActionLinkTypeBase::validateConfigurationForm public function Validates the action link setting form. Overrides PluginFormInterface::validateConfigurationForm 1
AJAXactionLink::$request protected property The request stack.
AJAXactionLink::create public static function Creates an instance of the plugin. Overrides ActionLinkTypeBase::create
AJAXactionLink::getDestination protected function Helper method to generate a destination URL parameter. Overrides ActionLinkTypeBase::getDestination
AJAXactionLink::__construct public function Build a new link type instance and sets the configuration. Overrides ActionLinkTypeBase::__construct
CountLink::getAsFlagLink public function Get the action link formatted for use in entity links. Overrides AJAXactionLink::getAsFlagLink
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.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
Reload::getUrl public function Return a Url object for the given flag action. Overrides ActionLinkTypeBase::getUrl
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.