You are here

Home » API reference » Avatar Kit 8.2 » AvatarKitServicesForm.php

class AvatarKitServicesForm in Avatar Kit 8.2

Configure Avatar Kit services.

Hierarchy

Expanded class hierarchy of AvatarKitServicesForm

1 string reference to 'AvatarKitServicesForm'
avatars.routing.yml in ./avatars.routing.yml
avatars.routing.yml

File

src/Form/AvatarKitServicesForm.php, line 16

Namespace

Drupal\avatars\Form
View source 
class AvatarKitServicesForm extends ConfigFormBase {

  /**
   * The avatar service preference cache backend.
   *
   * @var \Drupal\Core\Cache\CacheBackendInterface
   */
  protected $preferenceCacheBackend;

  /**
   * Construct a new AvatarKitServicesForm object.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   * @param \Drupal\Core\Cache\CacheBackendInterface $preferenceCacheBackend
   *   The avatar service preference cache backend.
   */
  public function __construct(ConfigFactoryInterface $config_factory, CacheBackendInterface $preferenceCacheBackend) {
    parent::__construct($config_factory);
    $this->preferenceCacheBackend = $preferenceCacheBackend;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'), $container
      ->get('cache.avatars.entity_preference'));
  }

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() : array {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() : string {
    return 'avatars_settings';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) : array {
    $headers = [
      'label' => $this
        ->t('Service'),
      'plugin' => $this
        ->t('Plugin'),
      'weight' => $this
        ->t('Weight'),
      'operations' => $this
        ->t('Operations'),
    ];
    $table_drag_group = 'avatar-service-weight';
    $form['services'] = [
      '#type' => 'table',
      '#header' => $headers,
      '#empty' => $this
        ->t('No avatar service instances found.'),
      '#tabledrag' => [
        [
          'action' => 'order',
          'relationship' => 'sibling',
          'group' => $table_drag_group,
        ],
      ],
      '#default_value' => [],
    ];

    /** @var \Drupal\avatars\Entity\AvatarKitServiceInterface[] $instances */
    $instances = AvatarKitService::loadMultiple();
    uasort($instances, [
      AvatarKitService::class,
      'sort',
    ]);
    foreach ($instances as $instance) {
      $row = [];
      $row['#attributes']['class'][] = 'draggable';
      $row['label']['#plain_text'] = $instance
        ->label();
      $definition = $instance
        ->getPlugin()
        ->getPluginDefinition();
      $row['plugin']['#plain_text'] = $definition['label'] ?? '';
      $row['weight'] = [
        '#type' => 'weight',
        '#title' => $this
          ->t('Weight'),
        '#title_display' => 'invisible',
        '#default_value' => $instance
          ->getWeight(),
        '#attributes' => [
          'class' => [
            $table_drag_group,
          ],
        ],
      ];
      $row['operations'] = [
        '#type' => 'operations',
        '#links' => $this
          ->getOperations($instance),
      ];
      $id = $instance
        ->id();
      $form['services'][$id] = $row;
    }
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) : void {
    parent::submitForm($form, $form_state);

    // Invalidate cached preferences for entities.
    $this->preferenceCacheBackend
      ->invalidateAll();

    // Generators are already sorted correctly.
    foreach ($form_state
      ->getValue('services') as $id => $row) {

      /** @var \Drupal\avatars\Entity\AvatarKitService $instance */
      $instance = AvatarKitService::load($id);
      $instance
        ->setWeight($row['weight'])
        ->save();
    }
  }

  /**
   * Get operations for an avatar service suitable for a operations element.
   *
   * @param \Drupal\avatars\Entity\AvatarKitServiceInterface $instance
   *   An avatar kit service instance.
   *
   * @return array
   *   Get operations for an avatar service instance suitable
   */
  protected function getOperations(AvatarKitServiceInterface $instance) : array {
    $operations = [];
    if ($instance
      ->access('update')) {
      $operations['edit'] = [
        'title' => $this
          ->t('Edit'),
        'weight' => 10,
        'url' => $instance
          ->toUrl('edit-form'),
      ];
    }
    if ($instance
      ->access('delete')) {
      $operations['delete'] = [
        'title' => $this
          ->t('Delete'),
        'weight' => 100,
        'url' => $instance
          ->toUrl('delete-form'),
      ];
    }
    return $operations;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AvatarKitServicesForm::$preferenceCacheBackend protected property The avatar service preference cache backend.
AvatarKitServicesForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
AvatarKitServicesForm::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create
AvatarKitServicesForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
AvatarKitServicesForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
AvatarKitServicesForm::getOperations protected function Get operations for an avatar service suitable for a operations element.
AvatarKitServicesForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
AvatarKitServicesForm::__construct public function Construct a new AvatarKitServicesForm object. Overrides ConfigFormBase::__construct
ConfigFormBaseTrait::config protected function Retrieves a configuration object.
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 1
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::configFactory protected function Gets the config factory for this form. 1
FormBase::container private function Returns the service container.
FormBase::currentUser protected function Gets the current user.
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::logger protected function Gets the logger for a specific channel.
FormBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::setRequestStack public function Sets the request stack object to use.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 62
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.