class UserRestrictionType in User restrictions 8

Defines the annotation object for UserRestrictionType plugins.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\user_restrictions\Annotation\UserRestrictionType

See also

\Drupal\user_restrictions\Plugin\UserRestrictionTypeManager

Plugin API

3 classes are annotated with UserRestrictionType

ClientIp in src/Plugin/UserRestrictionType/ClientIp.php

Defines a restriction type by client IP.

Email in src/Plugin/UserRestrictionType/Email.php

Defines a restriction type by email.

Name in src/Plugin/UserRestrictionType/Name.php

Defines a restriction type by username.

File

src/Annotation/UserRestrictionType.php, line 15

Namespace

Drupal\user_restrictions\Annotation

class UserRestrictionType extends Plugin {

  /**
   * The plugin ID.
   * @var string
   */
  public $id;

  /**
   * The label of the plugin.
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $label;

  /**
   * Plugin weight.
   *
   * @var int
   */
  public $weight;

}

Members

Name	Modifiers	Type	Description	Overrides
Plugin::$definition	protected	property	The plugin definition read from the class annotation.	1
Plugin::get	public	function	Gets the value of an annotation. Overrides AnnotationInterface::get	5
Plugin::getClass	public	function	Gets the class of the annotated class. Overrides AnnotationInterface::getClass
Plugin::getId	public	function	Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider	public	function	Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider
Plugin::parse	protected	function	Parses an annotation into its definition.
Plugin::setClass	public	function	Sets the class of the annotated class. Overrides AnnotationInterface::setClass
Plugin::setProvider	public	function	Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
Plugin::__construct	public	function	Constructs a Plugin object.	2
UserRestrictionType::$id	public	property	The plugin ID.
UserRestrictionType::$label	public	property	The label of the plugin.
UserRestrictionType::$weight	public	property	Plugin weight.