class VarnishImagePurgeConfiguration in Varnish purger 8

Same name and namespace in other branches

8.2 modules/varnish_image_purge/src/Form/VarnishImagePurgeConfiguration.php \Drupal\varnish_image_purge\Form\VarnishImagePurgeConfiguration

Configure site information settings for this site.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
  - class \Drupal\varnish_image_purge\Form\VarnishImagePurgeConfiguration

Expanded class hierarchy of VarnishImagePurgeConfiguration

1 string reference to 'VarnishImagePurgeConfiguration'

varnish_image_purge.routing.yml in modules/varnish_image_purge/varnish_image_purge.routing.yml: modules/varnish_image_purge/varnish_image_purge.routing.yml

File

modules/varnish_image_purge/src/Form/VarnishImagePurgeConfiguration.php, line 16

Namespace

Drupal\varnish_image_purge\Form

View source

class VarnishImagePurgeConfiguration extends ConfigFormBase {

  /**
   * Drupal\Core\Entity\EntityTypeManagerInterface definition.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  private $entityTypeManager;

  /**
   * Drupal\Core\Entity\EntityTypeBundleInfo definition.
   *
   * @var \Drupal\Core\Entity\EntityTypeBundleInfo
   */
  private $entityTypeBundleInfo;

  /**
   * VarnishImagePurgeConfiguration constructor.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The config factory.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entityTypeManager
   *   The entity type manager.
   * @param \Drupal\Core\Entity\EntityTypeBundleInfo $entityTypeBundleInfo
   *   The entity type bundle info.
   */
  public function __construct(ConfigFactoryInterface $config_factory, EntityTypeManagerInterface $entityTypeManager, EntityTypeBundleInfo $entityTypeBundleInfo) {
    parent::__construct($config_factory);
    $this->entityTypeManager = $entityTypeManager;
    $this->entityTypeBundleInfo = $entityTypeBundleInfo;
  }

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

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'varnish_image_purge_configuration_form';
  }

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      'varnish_image_purge.configuration',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('varnish_image_purge.configuration');
    $entity_types = $config
      ->get('entity_types');
    $content_entity_types = [];
    $entity_type_definitions = $this->entityTypeManager
      ->getDefinitions();

    /* @var $definition \Drupal\Core\Entity\EntityTypeInterface */
    foreach ($entity_type_definitions as $definition) {
      if ($definition instanceof ContentEntityType) {
        $content_entity_types[] = $definition;
      }
    }
    if (empty($content_entity_types)) {
      $this
        ->messenger()
        ->addStatus($this
        ->t('No content entities were found'));
      return NULL;
    }
    foreach ($content_entity_types as $content_entity_type) {
      $form['intro'] = [
        '#markup' => t('Configure bundles of entity types that Varnish image purge should be used for, if none selected, all bundles form all entity types will be used. Just the fields of type image will be purge.'),
      ];
      $default_value = [];
      if (!is_null($entity_types) && isset($entity_types[$content_entity_type
        ->id()])) {
        $default_value = $entity_types[$content_entity_type
          ->id()];
      }
      $form['entity_types'][$content_entity_type
        ->id()] = [
        '#type' => 'checkboxes',
        '#title' => $content_entity_type
          ->getLabel(),
        '#multiple' => TRUE,
        '#options' => $this
          ->getOptionsFromEntity($content_entity_type),
        '#default_value' => $default_value,
      ];
    }
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {

    // @todo
    // Validations.
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->config('varnish_image_purge.configuration');
    $values = [];
    foreach ($form_state
      ->getValues() as $entity_type => $bundles) {
      if (is_array($bundles)) {
        foreach ($bundles as $bundle_id => $bundle) {
          if ($bundle !== 0) {
            $values[$entity_type][] = $bundle_id;
          }
        }
      }
    }
    $config
      ->set('entity_types', $values);
    $config
      ->save();
    parent::submitForm($form, $form_state);
  }

  /**
   * Get the bundles form an entity and format as options.
   *
   * @param \Drupal\Core\Entity\ContentEntityType $content_entity_type
   *   The entity to get the bundles from.
   *
   * @return array
   *   Fortmatted options.
   */
  private function getOptionsFromEntity(ContentEntityType $content_entity_type) {
    $bundles = $this->entityTypeBundleInfo
      ->getBundleInfo($content_entity_type
      ->id());
    $options = [];
    foreach ($bundles as $key => $bundle) {
      $options[$key] = $bundle['label'];
    }
    return $options;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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.
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.
VarnishImagePurgeConfiguration::$entityTypeBundleInfo	private	property	Drupal\Core\Entity\EntityTypeBundleInfo definition.
VarnishImagePurgeConfiguration::$entityTypeManager	private	property	Drupal\Core\Entity\EntityTypeManagerInterface definition.
VarnishImagePurgeConfiguration::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
VarnishImagePurgeConfiguration::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
VarnishImagePurgeConfiguration::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
VarnishImagePurgeConfiguration::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
VarnishImagePurgeConfiguration::getOptionsFromEntity	private	function	Get the bundles form an entity and format as options.
VarnishImagePurgeConfiguration::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
VarnishImagePurgeConfiguration::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
VarnishImagePurgeConfiguration::__construct	public	function	VarnishImagePurgeConfiguration constructor. Overrides ConfigFormBase::__construct

You are here

class VarnishImagePurgeConfiguration in Varnish purger 8

Hierarchy

File

Namespace

Members

API Navigation