class CertificateController in Certificate 4.x

Hierarchy

class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
- class \Drupal\certificate\Controller\CertificateController

Expanded class hierarchy of CertificateController

File

src/Controller/CertificateController.php, line 19

Namespace

View source

class CertificateController extends ControllerBase {

  /**
   * Get the certificate enabled entity from the route.
   *
   * @return \Drupal\Core\Entity\ContentEntityInterface
   */
  public function getEntityFromRoute() {
    $param = current(\Drupal::routeMatch()
      ->getParameters());
    if (current($param) instanceof EntityInterface) {
      $entity = current($param);
    }
    if (!isset($entity)) {
      $route_match = Drupal::routeMatch();
      $route = $route_match
        ->getRouteObject();
      if ($certificate_param = $route
        ->getOption('certificate_param')) {
        $params = $route_match
          ->getParameters();
        $entity_id = $params
          ->get($certificate_param);
        $entity = Drupal::entityTypeManager()
          ->getStorage($certificate_param)
          ->load($entity_id);
      }
    }
    return $entity ?? NULL;
  }

  /**
   * @param EntityInterface $entity
   *   The entity this belongs to
   * @param AccountInterface $account
   * The user account to check
   * @return \Drupal\Core\Access\AccessResultInterface
   *   An access result
   */
  public function accessTab(EntityInterface $entity = NULL, AccountInterface $user = NULL) {
    $access = AccessResult::forbidden('No certificate access by default');
    if (!($entity = $this
      ->getEntityFromRoute())) {
      return AccessResult::neutral()
        ->setCacheMaxAge(0);
    }
    $currentUser = \Drupal::currentUser();
    $requestedUser = $user ?? $currentUser;
    $admin = $currentUser
      ->hasPermission('administer certificate');
    $view_all = $currentUser
      ->hasPermission('view all user certificates');
    if (!$requestedUser
      ->id()) {
      return AccessResult::forbidden('Not a valid user.')
        ->setCacheMaxAge(0);
    }
    if ($currentUser
      ->id() !== $requestedUser
      ->id() && !($admin || $view_all)) {
      return AccessResult::forbidden('Not an admin user.')
        ->setCacheMaxAge(0);
    }

    // Check that the user can access the certificate on this entity.
    return $entity
      ->access('certificate', $requestedUser, TRUE)
      ->setCacheMaxAge(0);
  }

  /**
   * Full tab
   * @param $entity
   * @param AccountInterface $account
   * @return type
   */
  function certificatePage(AccountInterface $account = NULL) {
    if (!($entity = $this
      ->getEntityFromRoute())) {
      return AccessResult::neutral();
    }
    $account = \Drupal::currentUser();

    // Get all templates for this entity combo
    $render = [];
    $valid_certs = [];
    $global_certs = CertificateMapping::getGlobalCertificateMappings();
    $certificate_mappers = Drupal::service('plugin.manager.certificate_mapper');
    $map_defs = $certificate_mappers
      ->getDefinitions();

    /* @todo add find field name function */
    foreach ($entity
      ->getFields() as $field) {
      if ($field
        ->getFieldDefinition()
        ->getType() == 'entity_reference' && $field
        ->getSetting('target_type') == 'certificate_mapping') {
        $certs = $field
          ->referencedEntities();
      }
    }

    //Default to load a page
    $render['info']['#markup'] = '';
    foreach ($map_defs as $map_key => $maps) {
      $plugin = $certificate_mappers
        ->createInstance($map_key, [
        'of' => 'configuration values',
      ]);
      $matches = $plugin
        ->processMapping($entity, $account) ?? [];
      foreach ($matches as $match) {
        foreach ($certs as $local) {
          if ($local
            ->isMatch($map_key, $match)) {
            $valid_certs["{$map_key}.{$match}"][] = $local
              ->get('cid')->value;
          }
        }

        // If local is not set, check the global mappings
        if (!isset($valid_certs["{$map_key}.{$match}"])) {
          foreach ($global_certs as $global) {
            if ($global
              ->isMatch($map_key, $match) && $global
              ->get('cid')->value !== '-1') {
              $valid_certs["{$map_key}.{$match}"][] = $global
                ->get('cid')->value;
            }
          }
        }
        elseif ($valid_certs["{$map_key}.{$match}"] == '-1') {
          unset($valid_certs["{$map_key}.{$match}"]);
        }
      }
    }
    if (empty($valid_certs)) {
      $render['info']['#markup'] = t('Sorry, there is no certificate available.');
      return $render;
    }

    // Return single certs right away
    if (count($valid_certs) === 1 && count(reset($valid_certs)) === 1) {
      $template = CertificateTemplate::load(current(reset($valid_certs)));
      return $this
        ->certificateDownload($entity, $account, $template);
    }

    // Return markup if we need to present messages
    $render['info']['#markup'] = t('You are eligible for multiple certificates.');
    $render['table'] = [
      '#type' => 'table',
      '#header' => [
        $this
          ->t('Type'),
        $this
          ->t('Download'),
      ],
    ];
    foreach ($valid_certs as $cert_name => $vals) {
      foreach ($vals as $val) {
        $params = [
          $entity
            ->getEntityTypeId() => $entity
            ->id(),
          'user' => $account
            ->id(),
          'certificate_template' => $val,
        ];
        $render['table'][$val] = [
          'type' => [
            '#markup' => $cert_name,
          ],
          'download' => Link::createFromRoute(t('Download certificate'), "certificate.{$entity->getEntityTypeId()}.pdf", $params)
            ->toRenderable(),
        ];
      }
    }
    return $render;
  }

  /**
   * Downloads
   *
   * @param $entity
   * @param AccountInterface $account
   * @param CertificateTemplate $template
   * @return type
   */
  function accessPdf(EntityInterface $entity = NULL, AccountInterface $user, CertificateTemplate $certificate_template) {
    if (!($entity = $this
      ->getEntityFromRoute())) {
      return AccessResult::neutral();
    }
    return $this
      ->accessTab($entity, $user);
  }

  /**
   * Stream a PDF to the browser.
   *
   * @param $entity
   * @param AccountInterface $user
   * @param CertificateTemplate $certificate_template
   * @param boolean $preview Send to browser instead
   *
   * @return binary
   */
  function certificateDownload(EntityInterface $entity = NULL, AccountInterface $user, CertificateTemplate $certificate_template, $preview = FALSE) {
    if (!($entity = $this
      ->getEntityFromRoute())) {
      return AccessResult::neutral();
    }
    $snapshots_enabled = (bool) Drupal::config('certificate.settings')
      ->get('snapshots');
    $snapshot_params = [
      'entity_id' => $entity
        ->id(),
      'entity_type' => $entity
        ->bundle(),
      'uid' => $user
        ->id(),
    ];
    if ($snapshots_enabled) {
      $snapshot_search = Drupal::entityTypeManager()
        ->getStorage('certificate_snapshot')
        ->loadByProperties($snapshot_params);
      $html = !empty($snapshot_search) ? current($snapshot_search)
        ->get('snapshot')->value : NULL;
    }

    // If no snapshot HTML found, load the entity
    if (empty($html)) {
      $renderView = $certificate_template
        ->renderView($user, $entity);
      $html = render($renderView);
    }

    // Add base HREF so images work.
    $base = \Drupal::request()
      ->getSchemeAndHttpHost();
    $html = "<base href=\"{$base}\">" . $html;

    // Save a new snapshot if none exists
    if ($snapshots_enabled && empty($snapshot_search)) {
      $snapshot_params['snapshot'] = $html;
      CertificateSnapshot::create($snapshot_params)
        ->save();
    }
    if (\Drupal::currentUser()
      ->hasPermission('administer certificate') && isset($_GET['preview'])) {
      print $html;
      exit;
    }

    // Get the PDF engine.
    $pdf_gen = $certificate_template
      ->loadPrintableEngine([
      'orientation' => $certificate_template
        ->get('orientation')
        ->getString(),
    ]);

    // Check for a PDF engine
    if ($pdf_gen === FALSE) {
      $current_user = Drupal::currentUser();
      $msg = t('Current site configuration does not allow PDF file creation. Please contact an administrator.');
      if ($current_user
        ->hasPermission('administer entity print')) {
        $link = Link::createFromRoute('configure a PDF library', 'entity_print.settings');
        $msg = t('Please @link to print certificates. Error: @error', [
          '@link' => $link
            ->toString(),
          '@error' => $pdf_gen ? $pdf_gen
            ->getStderr() : '',
        ]);
      }
      return [
        '#markup' => $msg,
      ];
    }

    // Engine is configured, proceed!
    // Add the page
    $pdf_gen
      ->addPage($html);

    // Create that pdf and send it!
    $pdf_gen
      ->send($entity
      ->label(), TRUE);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CertificateController::accessPdf		function	Downloads
CertificateController::accessTab	public	function
CertificateController::certificateDownload		function	Stream a PDF to the browser.
CertificateController::certificatePage		function	Full tab
CertificateController::getEntityFromRoute	public	function	Get the certificate enabled entity from the route.
ControllerBase::$configFactory	protected	property	The configuration factory.
ControllerBase::$currentUser	protected	property	The current user service.	1
ControllerBase::$entityFormBuilder	protected	property	The entity form builder.
ControllerBase::$entityTypeManager	protected	property	The entity type manager.
ControllerBase::$formBuilder	protected	property	The form builder.	2
ControllerBase::$keyValue	protected	property	The key-value storage.	1
ControllerBase::$languageManager	protected	property	The language manager.	1
ControllerBase::$moduleHandler	protected	property	The module handler.	2
ControllerBase::$stateService	protected	property	The state service.
ControllerBase::cache	protected	function	Returns the requested cache bin.
ControllerBase::config	protected	function	Retrieves a configuration object.
ControllerBase::container	private	function	Returns the service container.
ControllerBase::create	public static	function	Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create	46
ControllerBase::currentUser	protected	function	Returns the current user.	1
ControllerBase::entityFormBuilder	protected	function	Retrieves the entity form builder.
ControllerBase::entityTypeManager	protected	function	Retrieves the entity type manager.
ControllerBase::formBuilder	protected	function	Returns the form builder service.	2
ControllerBase::keyValue	protected	function	Returns a key/value storage collection.	1
ControllerBase::languageManager	protected	function	Returns the language manager service.	1
ControllerBase::moduleHandler	protected	function	Returns the module handler.	2
ControllerBase::redirect	protected	function	Returns a redirect response object for the specified route.
ControllerBase::state	protected	function	Returns the state storage service.
LoggerChannelTrait::$loggerFactory	protected	property	The logger channel factory service.
LoggerChannelTrait::getLogger	protected	function	Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory	public	function	Injects the logger channel factory.
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
MessengerTrait::setMessenger	public	function	Sets the messenger.
RedirectDestinationTrait::$redirectDestination	protected	property	The redirect destination service.	1
RedirectDestinationTrait::getDestinationArray	protected	function	Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination	protected	function	Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination	public	function	Sets the redirect destination service.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.

You are here

class CertificateController in Certificate 4.x

Hierarchy

File

Namespace

Members

API Navigation