class EntityLegal in Entity Legal 3.0.x

Class EntityLegal.

Plugin Namespace: Plugin\EntityLegal.

@package Drupal\entity_legal\Annotation

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\entity_legal\Annotation\EntityLegal

5 classes are annotated with EntityLegal

Message in src/Plugin/EntityLegal/Message.php

Method class for alerting existing users via Drupal set message.

Popup in src/Plugin/EntityLegal/Popup.php

Method class for alerting existing users via a jQuery UI popup window.

ProfileForm in src/Plugin/EntityLegal/ProfileForm.php

Method class for displaying a checkbox on the user register form.

ProfileFormEmbedded in src/Plugin/EntityLegal/ProfileFormEmbedded.php

Method class for displaying a checkbox on the user register form.

Redirect in src/Plugin/EntityLegal/Redirect.php

Method class for redirecting existing users to accept a legal document.

File

src/Annotation/EntityLegal.php, line 16

Namespace

Drupal\entity_legal\Annotation

class EntityLegal extends Plugin {

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

  /**
   * The human-readable name of the Entity Legal method plugin.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $label;

  /**
   * The method type; "new_users" or "existing_users".
   *
   * @var string
   */
  public $type;

}

Members

Name	Modifiers	Type	Description	Overrides
EntityLegal::$id	public	property	The plugin ID.
EntityLegal::$label	public	property	The human-readable name of the Entity Legal method plugin.
EntityLegal::$type	public	property	The method type; "new_users" or "existing_users".
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	1
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