You are here

Home » API reference » Flush Single Image Styles 8 » FlushSingleImageForm.php

class FlushSingleImageForm in Flush Single Image Styles 8

Class FlushSingleImageForm.

Hierarchy

Expanded class hierarchy of FlushSingleImageForm

2 string references to 'FlushSingleImageForm'
flush_single_image.routing.yml in ./flush_single_image.routing.yml
flush_single_image.routing.yml
flush_single_image.routing.yml in ./flush_single_image.routing.yml
flush_single_image.routing.yml

File

src/Form/FlushSingleImageForm.php, line 16

Namespace

Drupal\flush_single_image\Form
View source 
class FlushSingleImageForm extends FormBase {

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

  /**
   * The filesystem helper.
   *
   * @var \Drupal\Core\File\FileSystem
   */
  protected $fileSystem;

  /**
   * The drupal messenger service.
   *
   * @var \Drupal\Core\Messenger\MessengerInterface
   */
  protected $messenger;

  /**
   * The single image flusher service.
   *
   * @var \Drupal\flush_single_image\FlushSingleImage
   */
  protected $flushSingleImage;

  /**
   * Constructs a new FlushSingleImageForm object.
   */
  public function __construct(EntityTypeManagerInterface $entity_type_manager, FileSystemInterface $file_system, MessengerInterface $messenger, FlushSingleImageInterface $flush_single_image) {
    $this->entityTypeManager = $entity_type_manager;
    $this->fileSystem = $file_system;
    $this->messenger = $messenger;
    $this->flushSingleImage = $flush_single_image;
  }
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('entity_type.manager'), $container
      ->get('file_system'), $container
      ->get('messenger'), $container
      ->get('flush_single_image'));
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form['path'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('File URI'),
      '#description' => $this
        ->t('The image URI to flush image styles for. This can also be a relative path in which case the ' . file_default_scheme() . ':// scheme will be used.'),
    ];
    $form['check'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Check Styles'),
    ];
    $form['check']['description'] = [
      '#markup' => '<p class="description">Click "Check Styles" to check which styles have images cached for the provided image path.</p>',
      '#prefix' => '<div id="flush-single-image-description">',
      '#suffix' => '</div>',
      '#title' => $this
        ->t('Check Styles'),
    ];
    $form['check']['submit'] = [
      '#type' => 'button',
      '#value' => $this
        ->t('Check Styles'),
      '#ajax' => [
        'callback' => '::checkStyles',
        'wrapper' => 'flush-single-image-description',
        'progress' => [
          'type' => 'throbber',
          'message' => t('Checking styles...'),
        ],
      ],
      '#attributes' => [
        'class' => [
          'form-item',
        ],
      ],
    ];
    $form['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Flush'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    parent::validateForm($form, $form_state);
    if (!$form_state
      ->getValue('path')) {
      $form_state
        ->setError($form['path'], $this
        ->t('@name field is required.', [
        '@name' => $form['path']['#title'],
      ]));
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $paths = $this->flushSingleImage
      ->flush($form_state
      ->getValue('path'));
    foreach ($paths as $path) {
      $this->messenger
        ->addMessage(t('Flushed @path', [
        '@path' => $path,
      ]));
    }
    $this->messenger
      ->addMessage(t('Flushed all images for @path', [
      '@path' => $form_state
        ->getValue('path'),
    ]));
    $form_state
      ->setRebuild(TRUE);
  }

  /**
   * Ajax callback to check which styles an image has cached.
   */
  public static function checkStyles(array &$form, FormStateInterface $form_state) {
    $paths = \Drupal::service('flush_single_image')
      ->flush($form_state
      ->getValue('path'));
    if ($paths) {
      $element = [
        '#theme' => 'item_list',
        '#title' => t('Styled Images for @path', [
          '@path' => $form_state
            ->getValue('path'),
        ]),
        '#prefix' => '<div id="flush-single-image-description">',
        '#suffix' => '</div>',
        '#items' => [],
      ];
      foreach ($paths as $path) {
        $element['#items'][] = [
          '#markup' => $path,
        ];
      }
    }
    else {
      $element = [
        '#markup' => '<p class="description">There are no image styles cached for this image.</p>',
        '#prefix' => '<div id="flush-single-image-description">',
        '#suffix' => '</div>',
        '#title' => t('Check Styles'),
      ];
    }
    return $element;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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
FlushSingleImageForm::$entityTypeManager protected property The entity type manager service.
FlushSingleImageForm::$fileSystem protected property The filesystem helper.
FlushSingleImageForm::$flushSingleImage protected property The single image flusher service.
FlushSingleImageForm::$messenger protected property The drupal messenger service. Overrides MessengerTrait::$messenger
FlushSingleImageForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
FlushSingleImageForm::checkStyles public static function Ajax callback to check which styles an image has cached.
FlushSingleImageForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
FlushSingleImageForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
FlushSingleImageForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
FlushSingleImageForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
FlushSingleImageForm::__construct public function Constructs a new FlushSingleImageForm object.
FormBase::$configFactory protected property The config factory. 1
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::config protected function Retrieves a configuration object.
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 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.