entity_legal.module in Entity Legal 3.0.x

Entity Legal module.

@longdesc Provides versioned legal forms to serve to users. By default only a message method is supplied for user prompting.

File

entity_legal.module

<?php

/**
 * @file
 * Entity Legal module.
 *
 * @longdesc
 * Provides versioned legal forms to serve to users. By default only a message
 * method is supplied for user prompting.
 */
define('ENTITY_LEGAL_DOCUMENT_ENTITY_NAME', 'entity_legal_document');
define('ENTITY_LEGAL_DOCUMENT_VERSION_ENTITY_NAME', 'entity_legal_document_version');
define('ENTITY_LEGAL_DOCUMENT_ACCEPTANCE_ENTITY_NAME', 'entity_legal_document_acceptance');
use Drupal\Core\Link;
use Drupal\user\UserInterface;

/**
 * Implements hook_page_attachments_alter().
 */
function entity_legal_page_attachments_alter(array &$attachments) {
  $context = [
    'attachments' => &$attachments,
  ];

  // Execute Popup method plugin.
  \Drupal::service('plugin.manager.entity_legal')
    ->createInstance('popup')
    ->execute($context);
}

/**
 * Implements template_preprocess_page().
 */
function entity_legal_preprocess_page(&$variable) {

  // Execute Message method plugin.
  \Drupal::service('plugin.manager.entity_legal')
    ->createInstance('message')
    ->execute();
}

/**
 * Implements hook_form_FORM_ID_alter().
 */
function entity_legal_form_user_register_form_alter(&$form, &$form_state) {
  $context = [
    'form' => &$form,
  ];

  // Execute Profile Form method plugin.
  \Drupal::service('plugin.manager.entity_legal')
    ->createInstance('form_link')
    ->execute($context);

  // Execute Profile Form Embedded method plugin.
  \Drupal::service('plugin.manager.entity_legal')
    ->createInstance('form_inline')
    ->execute($context);
}

/**
 * Implements hook_entity_extra_field_info().
 */
function entity_legal_entity_extra_field_info() {
  $extra = [];
  $documents = \Drupal::entityTypeManager()
    ->getStorage(ENTITY_LEGAL_DOCUMENT_ENTITY_NAME)
    ->loadByProperties([
    'require_signup' => 1,
  ]);

  /** @var \Drupal\entity_legal\EntityLegalDocumentInterface $document */
  foreach ($documents as $document) {
    if ($document
      ->getPublishedVersion()) {
      $extra['user']['user']['form']['legal_' . $document
        ->id()] = [
        'label' => $document
          ->getPublishedVersion()
          ->label(),
        'description' => t('Checkbox for accepting :link', [
          ':link' => Link::createFromRoute($document
            ->label(), 'entity.entity_legal_document.edit_form'),
        ]),
        'weight' => -4,
      ];
    }
  }
  return $extra;
}

/**
 * Implements hook_entity_type_alter().
 */
function entity_legal_entity_type_alter(array &$entity_types) {

  /** @var $entity_types \Drupal\Core\Entity\EntityTypeInterface[] */

  // Add a translation handler for fields if the language module is enabled.
  if (\Drupal::moduleHandler()
    ->moduleExists('language')) {
    $translation = $entity_types['entity_legal_document_version']
      ->get('translation');
    $translation['entity_legal_document_version'] = TRUE;
    $entity_types['entity_legal_document_version']
      ->set('translation', $translation);
  }
}

/**
 * Implements hook_entity_ENTITY_TYPE_delete().
 */
function entity_legal_user_delete(UserInterface $account) {
  $acceptance_storage = \Drupal::entityTypeManager()
    ->getStorage(ENTITY_LEGAL_DOCUMENT_ACCEPTANCE_ENTITY_NAME);
  $aids = $acceptance_storage
    ->getQuery()
    ->condition('uid', $account
    ->id())
    ->execute();
  if ($aids) {
    $acceptance_storage
      ->delete($acceptance_storage
      ->loadMultiple($aids));
  }
}

Functions

Name	Description
entity_legal_entity_extra_field_info	Implements hook_entity_extra_field_info().
entity_legal_entity_type_alter	Implements hook_entity_type_alter().
entity_legal_form_user_register_form_alter	Implements hook_form_FORM_ID_alter().
entity_legal_page_attachments_alter	Implements hook_page_attachments_alter().
entity_legal_preprocess_page	Implements template_preprocess_page().
entity_legal_user_delete	Implements hook_entity_ENTITY_TYPE_delete().

Constants

Name	Description
ENTITY_LEGAL_DOCUMENT_ACCEPTANCE_ENTITY_NAME
ENTITY_LEGAL_DOCUMENT_ENTITY_NAME	@file Entity Legal module.
ENTITY_LEGAL_DOCUMENT_VERSION_ENTITY_NAME