You are here

Home » API reference » Field Encryption 3.0.x » FieldOverviewController.php

class FieldOverviewController in Field Encryption 3.0.x

Same name and namespace in other branches
  1. 8.2 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 15

Namespace

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

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

  /**
   * The entity field manager.
   *
   * @var \Drupal\Core\Entity\EntityFieldManagerInterface
   */
  protected $entityFieldManager;

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

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

  /**
   * Renders overview page of encrypted fields.
   */
  public function overview() {
    $encrypted_fields = $this
      ->getEncryptedFields();
    $build['table'] = [
      '#type' => 'table',
      '#header' => [
        'field_name' => $this
          ->t('Field'),
        'entity_type' => $this
          ->t('Entity type'),
        'properties' => $this
          ->t('Properties'),
        'operations' => $this
          ->t('Operations'),
      ],
      '#title' => 'Overview of encrypted fields',
      '#rows' => [],
      '#empty' => $this
        ->t('There are no encrypted fields.'),
    ];
    foreach ($encrypted_fields as $encrypted_field) {
      if ($encrypted_field
        ->isBaseField()) {
        $properties = $encrypted_field
          ->getSetting('field_encrypt.properties') ?? [];
      }
      else {
        $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),
          ],
        ],
        '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,
                  'base_field' => $encrypted_field
                    ->isBaseField(),
                ]),
              ],
            ],
          ],
        ],
      ];
      $build['table']['#rows'][$encrypted_field
        ->getName()] = $row;
    }
    return $build;
  }

  /**
   * Get a list of encrypted fields' storage entities.
   *
   * @return \Drupal\Core\Field\FieldStorageDefinitionInterface[]
   *   An array of FieldStorageConfig entities and base fields 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;
      }
    }
    foreach ($this->entityTypeManager
      ->getDefinitions() as $entity_type) {

      // Only content entity types support encryption.
      if ($entity_type instanceof ContentEntityTypeInterface) {

        /** @var \Drupal\Core\Field\BaseFieldDefinition $base_field */
        foreach ($this->entityFieldManager
          ->getBaseFieldDefinitions($entity_type
          ->id()) as $base_field) {
          if ($base_field
            ->getSetting('field_encrypt.encrypt')) {
            $encrypted_fields[] = $base_field;
          }
        }
      }
    }
    return $encrypted_fields;
  }

}

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::$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::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.
FieldOverviewController::$entityFieldManager protected property The entity field manager.
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::overview public function Renders overview page of encrypted fields.
FieldOverviewController::__construct public function Creates a new FieldOverviewController object.
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.