class Builtin in Freelinking 4.0.x

Freelinking builtin plugin.

Plugin annotation

@Freelinking(
  id = "builtin",
  title = @Translation("Built-in"),
  weight = -1,
  hidden = true,
  settings = { }
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\freelinking\Plugin\FreelinkingPluginBase implements FreelinkingPluginInterface
      • class \Drupal\freelinking\Plugin\freelinking\Builtin implements ContainerFactoryPluginInterface

1 file declares its use of Builtin

BuiltinTest.php in tests/src/Unit/Plugin/freelinking/BuiltinTest.php

File

src/Plugin/freelinking/Builtin.php, line 21

Namespace

Drupal\freelinking\Plugin\freelinking

class Builtin extends FreelinkingPluginBase implements ContainerFactoryPluginInterface {

  /**
   * Current user account.
   *
   * @var \Drupal\Core\Session\AccountProxyInterface
   */
  protected $account;

  /**
   * Initialize method.
   *
   * @param array $configuration
   *   The configuration array.
   * @param string $plugin_id
   *   The plugin ID.
   * @param array $plugin_definition
   *   The plugin definition array.
   * @param \Drupal\Core\Session\AccountProxyInterface $account
   *   The current user account.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, AccountProxyInterface $account) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->account = $account;
  }

  /**
   * {@inheritdoc}
   */
  public function getTip() {
    return $this
      ->t('Redact, show text only, or display the indicator');
  }

  /**
   * {@inheritdoc}
   */
  public function getIndicator() {
    return '/^(showtext|nowiki|redact)$/';
  }

  /**
   * {@inheritdoc}
   */
  public function buildLink(array $target) {
    $text = '';
    if ('showtext' === $target['indicator']) {
      $text = $target['text'] ? $target['text'] : $target['dest'];
    }
    elseif ('nowiki' === $target['indicator']) {
      $text .= '[[';
      $text .= $target['text'] ? $target['text'] : $target['dest'];
      $text .= ']]';
    }
    elseif ('redact' === $target['indicator']) {
      if ($this->account
        ->isAuthenticated()) {
        $text = $target['dest'];
      }
      else {
        $text = $target['text'] ? $target['text'] : '******';
      }
    }
    return [
      '#markup' => $text,
    ];
  }

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

}

Members

Name	Modifiers	Type	Description	Overrides
Builtin::$account	protected	property	Current user account.
Builtin::buildLink	public	function	Build a link with the plugin. Overrides FreelinkingPluginInterface::buildLink
Builtin::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
Builtin::getIndicator	public	function	A regular expression string to indicate what to replace for this plugin. Overrides FreelinkingPluginInterface::getIndicator
Builtin::getTip	public	function	Provides tips for this freelinking plugin. Overrides FreelinkingPluginInterface::getTip
Builtin::__construct	public	function	Initialize method. Overrides PluginBase::__construct
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
FreelinkingPluginBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
FreelinkingPluginBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration	6
FreelinkingPluginBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration	1
FreelinkingPluginBase::getFailoverPluginId	public	function	Get the failover plugin ID (if applicable). Overrides FreelinkingPluginInterface::getFailoverPluginId	1
FreelinkingPluginBase::isHidden	public	function	Determine if the plugin is built-in (always on). Overrides FreelinkingPluginInterface::isHidden
FreelinkingPluginBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
FreelinkingPluginBase::settingsForm	public	function	Plugin configuration form. Overrides FreelinkingPluginInterface::settingsForm	6
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
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	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.