class YamlFormHandler in YAML Form 8

Defines a form handler annotation object.

Plugin Namespace: Plugin\YamlFormHandler.

For a working example, see \Drupal\yamlform\Plugin\YamlFormHandler\EmailYamlFormHandler

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\yamlform\Annotation\YamlFormHandler

See also

hook_yamlform_handler_info_alter()

\Drupal\yamlform\YamlFormHandlerInterface

\Drupal\yamlform\YamlFormHandlerBase

\Drupal\yamlform\YamlFormHandlerManager

Plugin API

6 classes are annotated with YamlFormHandler

BrokenYamlFormHandler in src/Plugin/YamlFormHandler/BrokenYamlFormHandler.php

Defines a fallback plugin for missing form handler plugins.

DebugYamlFormHandler in modules/yamlform_devel/src/Plugin/YamlFormHandler/DebugYamlFormHandler.php

Form submission debug handler.

DebugYamlFormHandler in tests/modules/yamlform_test/src/Plugin/YamlFormHandler/DebugYamlFormHandler.php

Form submission debug handler.

EmailYamlFormHandler in src/Plugin/YamlFormHandler/EmailYamlFormHandler.php

Emails a form submission.

RemotePostYamlFormHandler in src/Plugin/YamlFormHandler/RemotePostYamlFormHandler.php

Form submission remote post handler.

... See full list

File

src/Annotation/YamlFormHandler.php, line 24

Namespace

Drupal\yamlform\Annotation

class YamlFormHandler extends Plugin {

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

  /**
   * The human-readable name of the form handler.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $label;

  /**
   * The category in the admin UI where the block will be listed.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $category = '';

  /**
   * A brief description of the form handler.
   *
   * This will be shown when adding or configuring this form handler.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $description = '';

  /**
   * The maximum number of instances allowed for this form handler.
   *
   * Possible values are positive integers or
   * \Drupal\yamlform\YamlFormHandlerInterface::CARDINALITY_UNLIMITED or
   * \Drupal\yamlform\YamlFormHandlerInterface::CARDINALITY_SINGLE.
   *
   * @var int
   */
  public $cardinality = YamlFormHandlerInterface::CARDINALITY_UNLIMITED;

  /**
   * Notifies the form that this handler processes results.
   *
   * When set to TRUE, 'Disable saving of submissions.' can be set.
   *
   * @var bool
   */
  public $results = YamlFormHandlerInterface::RESULTS_IGNORED;

}

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
YamlFormHandler::$cardinality	public	property	The maximum number of instances allowed for this form handler.
YamlFormHandler::$category	public	property	The category in the admin UI where the block will be listed.
YamlFormHandler::$description	public	property	A brief description of the form handler.
YamlFormHandler::$id	public	property	The plugin ID.
YamlFormHandler::$label	public	property	The human-readable name of the form handler.
YamlFormHandler::$results	public	property	Notifies the form that this handler processes results.