class CertificateMapper in Certificate 4.x

Defines a Certificate mapper item annotation object.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\certificate\Annotation\CertificateMapper

See also

CertificateMapperManager

Plugin API

4 classes are annotated with CertificateMapper

CourseCreditCertificateMapper in src/Plugin/certificate/CertificateMapper/CourseCreditCertificateMapper.php

Plugin annotation @CertificateMapper( id = "course_credit_awarded", label = @Translation("Awarded course credit"), description = @Translation("Using this mapping will award a certificate based on the credit type the user claimed after completing a…

ManualCertificateMapper in src/Plugin/certificate/CertificateMapper/ManualCertificateMapper.php

Plugin annotation @CertificateMapper( id = "manual", label = @Translation("Manual"), description = @Translation("Select a single certificate to award to the user"), )

RulesCertificateMapper in src/Plugin/certificate/CertificateMapper/RulesCertificateMapper.php

Plugin annotation @CertificateMapper( id = "rules", label = @Translation("Rules component"), description = @Translation("Uses rules components"), required = {"rules"} )

TestCertificateMapper in modules/certificate_test/src/Plugin/certificate/CertificateMapper/TestCertificateMapper.php

Plugin annotation @CertificateMapper( id = "firstletter", label = @Translation("Test mapper"), description = @Translation("Map based on first letter of username"), )

File

src/Annotation/CertificateMapper.php, line 17

Namespace

Drupal\certificate\Annotation

class CertificateMapper extends Plugin {

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

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

  /**
   * The plugin description.
   *
   * @var string
   */
  public $description;

  /**
   * A list of required modules
   *
   * @var array
   */
  public $required;

}

Members

Name	Modifiers	Type	Description	Overrides
CertificateMapper::$description	public	property	The plugin description.
CertificateMapper::$id	public	property	The plugin ID.
CertificateMapper::$label	public	property	The label of the plugin.
CertificateMapper::$required	public	property	A list of required modules
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