abstract class CertificateMapperBase in Certificate 4.x

Base class for Certificate mapper plugins.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\certificate\Plugin\CertificateMapperBase

4 files declare their use of CertificateMapperBase

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

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

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

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

File

src/Plugin/CertificateMapperBase.php, line 14

Namespace

Drupal\certificate\Plugin

abstract class CertificateMapperBase extends PluginBase {

  /**
   * Get the map keys that the user is eligible for.
   *
   * @return array
   */
  abstract function processMapping(ContentEntityInterface $entity, AccountInterface $account);

  /**
   * Get a list of map keys.
   *
   * @return array
   */
  abstract function getMapKeys();
  public function hasDependencies() {
    $enabled = TRUE;
    $definition = $this
      ->getPluginDefinition();
    foreach ($definition['required'] ?? [] as $module) {
      if (!Drupal::moduleHandler()
        ->moduleExists($module)) {
        $enabled = FALSE;
        break;
      }
    }
    return $enabled;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CertificateMapperBase::getMapKeys	abstract	function	Get a list of map keys.	4
CertificateMapperBase::hasDependencies	public	function
CertificateMapperBase::processMapping	abstract	function	Get the map keys that the user is eligible for.	4
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.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	98