You are here

Home » API reference » Image Widget Crop 8.2 » CropWidgetForm.php

class CropWidgetForm in Image Widget Crop 8.2

Same name and namespace in other branches
  1. 8 src/Form/CropWidgetForm.php \Drupal\image_widget_crop\Form\CropWidgetForm

Configure ImageWidgetCrop general settings for this site.

Hierarchy

Expanded class hierarchy of CropWidgetForm

1 string reference to 'CropWidgetForm'
image_widget_crop.routing.yml in ./image_widget_crop.routing.yml
image_widget_crop.routing.yml

File

src/Form/CropWidgetForm.php, line 18

Namespace

Drupal\image_widget_crop\Form
View source 
class CropWidgetForm extends ConfigFormBase {

  /**
   * The settings of image_widget_crop configuration.
   *
   * @var array
   *
   * @see \Drupal\Core\Config\Config
   */
  protected $settings;

  /**
   * Instance of ImageWidgetCropManager object.
   *
   * @var \Drupal\image_widget_crop\ImageWidgetCropInterface
   */
  protected $imageWidgetCropManager;

  /**
   * The module handler to use to load modules.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * The HTTP client to fetch the feed data with.
   *
   * @var \GuzzleHttp\ClientInterface
   */
  protected $httpClient;

  /**
   * Constructs a CropWidgetForm object.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   * @param \Drupal\image_widget_crop\ImageWidgetCropInterface $iwc_manager
   *   The ImageWidgetCrop manager service.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler to use to load modules.
   * @param \GuzzleHttp\ClientInterface $http_client
   *   The Guzzle HTTP client.
   */
  public function __construct(ConfigFactoryInterface $config_factory, ImageWidgetCropInterface $iwc_manager, ModuleHandlerInterface $module_handler, ClientInterface $http_client) {
    parent::__construct($config_factory);
    $this->settings = $this
      ->config('image_widget_crop.settings');
    $this->imageWidgetCropManager = $iwc_manager;
    $this->moduleHandler = $module_handler;
    $this->httpClient = $http_client;
  }

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

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $url = 'https://cdnjs.com/libraries/cropper';
    $cdn_js = IMAGE_WIDGET_CROP_JS_CDN;
    $cdn_css = IMAGE_WIDGET_CROP_CSS_CDN;
    $form['library'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Cropper library settings'),
      '#description' => $this
        ->t('Changes here require a cache rebuild to take full effect.'),
    ];
    $form['library']['library_url'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Custom Cropper library'),
      '#description' => $this
        ->t('Set the URL or local path for the file, or leave empty to use the installed library (if present) or a <a href="@file">CDN</a> fallback. You can retrieve the library file from <a href="@url">Cropper CDN</a>.', [
        '@url' => $url,
        '@file' => $cdn_js,
      ]),
      '#default_value' => $this->settings
        ->get('settings.library_url'),
    ];
    $form['library']['css_url'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Custom Cropper CSS file'),
      '#description' => $this
        ->t('Set the URL or local path for the file, or leave empty to use installed library (if installed) or a <a href="@file">CDN</a> fallback. You can retrieve the CSS file from <a href="@url">Cropper CDN</a>.', [
        '@url' => $url,
        '@file' => $cdn_css,
      ]),
      '#default_value' => $this->settings
        ->get('settings.css_url'),
    ];

    // Indicate which files are used when custom urls are not set.
    if ($this->moduleHandler
      ->moduleExists('libraries') && ($info = libraries_detect('cropper')) && $info['installed']) {
      $form['library']['library_url']['#attributes']['placeholder'] = $info['library path'] . '/dist/' . key($info['files']['js']);
      $form['library']['css_url']['#attributes']['placeholder'] = $info['library path'] . '/dist/' . key($info['files']['css']);
    }
    else {
      $form['library']['library_url']['#attributes']['placeholder'] = $cdn_js;
      $form['library']['css_url']['#attributes']['placeholder'] = $cdn_css;
    }
    $form['image_crop'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('General configuration'),
    ];
    $form['image_crop']['crop_preview_image_style'] = [
      '#title' => $this
        ->t('Crop preview image style'),
      '#type' => 'select',
      '#options' => image_style_options(FALSE),
      '#default_value' => $this->settings
        ->get('settings.crop_preview_image_style'),
      '#description' => $this
        ->t('The preview image will be shown while editing the content.'),
      '#weight' => 15,
    ];
    $form['image_crop']['crop_list'] = [
      '#title' => $this
        ->t('Crop Type'),
      '#type' => 'select',
      '#options' => $this->imageWidgetCropManager
        ->getAvailableCropType(CropType::getCropTypeNames()),
      '#empty_option' => $this
        ->t('<@no-preview>', [
        '@no-preview' => $this
          ->t('no preview'),
      ]),
      '#default_value' => $this->settings
        ->get('settings.crop_list'),
      '#multiple' => TRUE,
      '#description' => $this
        ->t('The type of crop to apply to your image. If your Crop Type not appear here, set an image style use your Crop Type'),
      '#weight' => 16,
    ];
    $form['image_crop']['show_crop_area'] = [
      '#title' => $this
        ->t('Always expand crop area'),
      '#type' => 'checkbox',
      '#default_value' => $this->settings
        ->get('settings.show_crop_area'),
    ];
    $form['image_crop']['warn_multiple_usages'] = [
      '#title' => $this
        ->t('Warn user when a file have multiple usages'),
      '#type' => 'checkbox',
      '#default_value' => $this->settings
        ->get('settings.warn_multiple_usages'),
    ];
    $form['image_crop']['show_default_crop'] = [
      '#title' => $this
        ->t('Show default crop area'),
      '#type' => 'checkbox',
      '#default_value' => $this->settings
        ->get('settings.show_default_crop'),
    ];
    $form['image_crop']['crop_types_required'] = [
      '#title' => $this
        ->t('Set Crop Type as required'),
      '#type' => 'select',
      '#options' => $this->imageWidgetCropManager
        ->getAvailableCropType(CropType::getCropTypeNames()),
      '#empty_option' => $this
        ->t("- Any crop selected -"),
      '#default_value' => $this->settings
        ->get('settings.crop_types_required'),
      '#multiple' => TRUE,
      '#description' => $this
        ->t('Set active crop as required.'),
      '#weight' => 16,
    ];
    $form['image_crop']['notify'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Cropping Notifications'),
    ];
    $form['image_crop']['notify']['notify_apply'] = [
      '#title' => $this
        ->t('Crop apply'),
      '#type' => 'checkbox',
      '#default_value' => $this->settings
        ->get('settings.notify_apply'),
    ];
    $form['image_crop']['notify']['notify_update'] = [
      '#title' => $this
        ->t('Crop update'),
      '#type' => 'checkbox',
      '#default_value' => $this->settings
        ->get('settings.notify_update'),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * Validation for cropper library.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   *
   * @throws \GuzzleHttp\Exception\GuzzleException
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    parent::validateForm($form, $form_state);
    if (!empty($form_state
      ->getValue('library_url')) || !empty($form_state
      ->getValue('css_url'))) {
      $files = [
        'library' => $form_state
          ->getValue('library_url'),
        'css' => $form_state
          ->getValue('css_url'),
      ];
      if (empty($files['library']) || empty($files['css'])) {
        $form_state
          ->setErrorByName('plugin', $this
          ->t('Please provide both a library and a CSS file when using custom URLs.'));
      }
      else {
        foreach ($files as $type => $file) {

          // Verify that both files exist.
          $is_local = parse_url($file, PHP_URL_SCHEME) === NULL && strpos($file, '//') !== 0;
          if ($is_local && !file_exists($file)) {
            $form_state
              ->setErrorByName($type . '_url', $this
              ->t('The provided local file does not exist.'));
          }
          elseif (!$is_local) {
            try {
              $result = $this->httpClient
                ->request('GET', $file);
              if ($result
                ->getStatusCode() != 200) {
                throw new \Exception($result
                  ->getReasonPhrase(), 1);
              }
            } catch (\Exception $e) {
              $form_state
                ->setErrorByName($type . '_url', $this
                ->t('The remote URL for the library does not appear to be valid: @message.', [
                '@message' => $e
                  ->getMessage(),
              ]));
            }
          }
        }
      }
    }
  }

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

    // We need to rebuild the library cache if we switch from remote to local
    // library or vice-versa.
    Cache::invalidateTags([
      'library_info',
    ]);

    // Set Default (CDN) libraries urls if empty.
    $this
      ->setDefaultLibrariesUrls($form_state);
    $this->settings
      ->set("settings.library_url", $form_state
      ->getValue('library_url'))
      ->set("settings.css_url", $form_state
      ->getValue('css_url'))
      ->set("settings.crop_preview_image_style", $form_state
      ->getValue('crop_preview_image_style'))
      ->set("settings.show_default_crop", $form_state
      ->getValue('show_default_crop'))
      ->set("settings.show_crop_area", $form_state
      ->getValue('show_crop_area'))
      ->set("settings.warn_multiple_usages", $form_state
      ->getValue('warn_multiple_usages'))
      ->set("settings.crop_list", $form_state
      ->getValue('crop_list'))
      ->set("settings.crop_types_required", $form_state
      ->getValue('crop_types_required'))
      ->set("settings.notify_apply", $form_state
      ->getValue('notify_apply'))
      ->set("settings.notify_update", $form_state
      ->getValue('notify_update'));
    $this->settings
      ->save();
  }

  /**
   * Set the default state of cropper libraries files url.
   *
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   */
  public function setDefaultLibrariesUrls(FormStateInterface $form_state) {
    if (empty($form_state
      ->getValue('library_url')) || empty($form_state
      ->getValue('css_url'))) {
      $form_state
        ->setValue('library_url', $form_state
        ->getCompleteForm()['library']['library_url']['#attributes']['placeholder']);
      $form_state
        ->setValue('css_url', $form_state
        ->getCompleteForm()['library']['css_url']['#attributes']['placeholder']);
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigFormBaseTrait::config protected function Retrieves a configuration object.
CropWidgetForm::$httpClient protected property The HTTP client to fetch the feed data with.
CropWidgetForm::$imageWidgetCropManager protected property Instance of ImageWidgetCropManager object.
CropWidgetForm::$moduleHandler protected property The module handler to use to load modules.
CropWidgetForm::$settings protected property The settings of image_widget_crop configuration.
CropWidgetForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
CropWidgetForm::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create
CropWidgetForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
CropWidgetForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
CropWidgetForm::setDefaultLibrariesUrls public function Set the default state of cropper libraries files url.
CropWidgetForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
CropWidgetForm::validateForm public function Validation for cropper library. Overrides FormBase::validateForm
CropWidgetForm::__construct public function Constructs a CropWidgetForm object. Overrides ConfigFormBase::__construct
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.