You are here

Home » API reference » Field Encryption 8.2 » FieldOverviewController.php

class FieldOverviewController in Field Encryption 8.2

Same name and namespace in other branches
  1. 3.0.x src/Controller/FieldOverviewController.php \Drupal\field_encrypt\Controller\FieldOverviewController

Renders encrypted fields overview.

Hierarchy

Expanded class hierarchy of FieldOverviewController

File

src/Controller/FieldOverviewController.php, line 13

Namespace

Drupal\field_encrypt\Controller
View source 
class FieldOverviewController extends ControllerBase {

  /**
   * The entity type manager service.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Creates a new FieldOverviewController object.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager service.
   */
  public function __construct(EntityTypeManagerInterface $entity_type_manager) {
    $this->entityTypeManager = $entity_type_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('entity_type.manager'));
  }

  /**
   * Renders overview page of encrypted fields.
   */
  public function overview() {
    $encrypted_fields = $this
      ->getEncryptedFields();
    $build['table'] = array(
      '#type' => 'table',
      '#header' => [
        'field_name' => $this
          ->t('Field'),
        'entity_type' => $this
          ->t('Entity type'),
        'properties' => $this
          ->t('Properties'),
        'encryption_profile' => $this
          ->t('Encryption profile'),
        'count' => $this
          ->t('# encrypted field values'),
        'operations' => $this
          ->t('Operations'),
      ],
      '#title' => 'Overview of encrypted fields',
      '#rows' => array(),
      '#empty' => $this
        ->t('There are no encrypted fields.'),
    );
    foreach ($encrypted_fields as $encrypted_field) {
      $properties = $encrypted_field
        ->getThirdPartySetting('field_encrypt', 'properties', []);
      $entity_type = $encrypted_field
        ->getTargetEntityTypeId();
      $field_name = $encrypted_field
        ->getName();
      $row = [
        'field_name' => $field_name,
        'entity_type' => $entity_type,
        'properties' => [
          'data' => [
            '#theme' => 'item_list',
            '#items' => array_filter($properties),
          ],
        ],
        'encryption_profile' => $encrypted_field
          ->getThirdPartySetting('field_encrypt', 'encryption_profile', ''),
        'count' => $this
          ->getEncryptedFieldValueCount($entity_type, $field_name),
        'operations' => [
          'data' => [
            '#type' => 'operations',
            '#links' => [
              'decrypt' => [
                'title' => $this
                  ->t('Decrypt'),
                'url' => Url::fromRoute('field_encrypt.field_decrypt_confirm', [
                  'entity_type' => $entity_type,
                  'field_name' => $field_name,
                ]),
              ],
            ],
          ],
        ],
      ];
      $build['table']['#rows'][$encrypted_field
        ->id()] = $row;
    }
    return $build;
  }

  /**
   * Get a list of encrypted fields' storage entities.
   *
   * @return \Drupal\field\FieldStorageConfigInterface[]
   *   An array of FieldStorageConfig entities for encrypted fields.
   */
  protected function getEncryptedFields() {
    $encrypted_fields = [];
    $storage = $this->entityTypeManager
      ->getStorage('field_storage_config');
    $fields = $storage
      ->loadMultiple();
    foreach ($fields as $field) {
      if ($field
        ->getThirdPartySetting('field_encrypt', 'encrypt', FALSE) == TRUE) {
        $encrypted_fields[] = $field;
      }
    }
    return $encrypted_fields;
  }

  /**
   * Get the number of encrypted field values for a given field on entity type.
   *
   * @param string $entity_type
   *   The entity type to check.
   * @param string $field_name
   *   The field name to check.
   *
   * @return int
   *   The number of encrypted field values.
   */
  protected function getEncryptedFieldValueCount($entity_type, $field_name) {
    $query = $this->entityTypeManager
      ->getStorage('encrypted_field_value')
      ->getQuery()
      ->condition('entity_type', $entity_type)
      ->condition('field_name', $field_name);
    $values = $query
      ->execute();
    return count($values);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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::$entityManager protected property The entity 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::currentUser protected function Returns the current user. 1
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityManager Deprecated protected function Retrieves the entity manager service.
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. Overrides UrlGeneratorTrait::redirect
ControllerBase::state protected function Returns the state storage service.
FieldOverviewController::$entityTypeManager protected property The entity type manager service. Overrides ControllerBase::$entityTypeManager
FieldOverviewController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
FieldOverviewController::getEncryptedFields protected function Get a list of encrypted fields' storage entities.
FieldOverviewController::getEncryptedFieldValueCount protected function Get the number of encrypted field values for a given field on entity type.
FieldOverviewController::overview public function Renders overview page of encrypted fields.
FieldOverviewController::__construct public function Creates a new FieldOverviewController object.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator 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. 29
MessengerTrait::messenger public function Gets the messenger. 29
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. 1
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.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.