class EditorFileDialog in CkEditor Background Image 8

Same name and namespace in other branches

2.0.x src/Form/EditorFileDialog.php \Drupal\ckeditor_bgimage\Form\EditorFileDialog

Provides a link dialog for text editors.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\ckeditor_bgimage\Form\EditorFileDialog implements BaseFormIdInterface

Expanded class hierarchy of EditorFileDialog

1 string reference to 'EditorFileDialog'

ckeditor_bgimage.routing.yml in ./ckeditor_bgimage.routing.yml: ckeditor_bgimage.routing.yml

File

src/Form/EditorFileDialog.php, line 21

Namespace

Drupal\ckeditor_bgimage\Form

View source

class EditorFileDialog extends FormBase implements BaseFormIdInterface {

  /**
   * The file storage service.
   *
   * @var \Drupal\Core\Entity\EntityStorageInterface
   */
  protected $fileStorage;

  /**
   * Constructs a form object for image dialog.
   *
   * @param \Drupal\Core\Entity\EntityStorageInterface $file_storage
   *   The file storage service.
   */
  public function __construct(EntityStorageInterface $file_storage) {
    $this->fileStorage = $file_storage;
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function getBaseFormId() {

    // Use the EditorLinkDialog form id to ease alteration.
    return 'editor_bgimage_link_dialog';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, FilterFormat $filter_format = NULL) {
    $file_element = $form_state
      ->get('file_element') ?: [];
    if (isset($form_state
      ->getUserInput()['editor_object'])) {
      $file_element = $form_state
        ->getUserInput()['editor_object'];
      $form_state
        ->set('file_element', $file_element);
      $form_state
        ->setCached(TRUE);
    }
    $form['#tree'] = TRUE;
    $form['#attached']['library'][] = 'editor/drupal.editor.dialog';
    $form['#prefix'] = '<div id="editor-bgimage-dialog-form">';
    $form['#suffix'] = '</div>';
    $editor = editor_load($filter_format
      ->id());
    $file_upload = $editor
      ->getThirdPartySettings('ckeditor_bgimage');
    $max_filesize = min(Bytes::toInt($file_upload['max_size']), Environment::getUploadMaxSize());
    $existing_file = isset($file_element['data-entity-uuid']) ? $this
      ->loadEntityByUuid('file', $file_element['data-entity-uuid']) : NULL;
    $fid = $existing_file ? $existing_file
      ->id() : NULL;
    $ext = !empty($file_upload['extensions']) ? [
      $file_upload['extensions'],
    ] : [
      'jpg',
      'jpeg',
      'png',
    ];
    $form['fid'] = [
      '#title' => $this
        ->t('Background Image'),
      '#type' => 'managed_file',
      '#upload_location' => $file_upload['scheme'] . '://' . $file_upload['directory'],
      '#default_value' => $fid ? [
        $fid,
      ] : NULL,
      '#upload_validators' => [
        'file_validate_extensions' => $ext,
        'file_validate_size' => [
          $max_filesize,
        ],
      ],
      '#required' => TRUE,
      '#access' => TRUE,
    ];
    $form['attributes']['href'] = [
      '#title' => $this
        ->t('URL'),
      '#type' => 'textfield',
      '#default_value' => isset($file_element['href']) ? $file_element['href'] : '',
      '#maxlength' => 2048,
      '#required' => TRUE,
      '#access' => TRUE,
    ];
    $form['background_color'] = [
      '#title' => $this
        ->t('Background Color'),
      '#type' => 'color',
      '#default_value' => '#ffffff',
      '#description' => $this
        ->t('Select a Color'),
      '#maxlength' => 10,
    ];
    $form['width'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Width'),
      '#description' => $this
        ->t('Set a value width in (px)'),
      '#maxlength' => 4,
      '#required' => FALSE,
    ];
    $form['height'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Heigth'),
      '#description' => $this
        ->t('Set a value height in (px)'),
      '#maxlength' => 4,
      '#required' => FALSE,
    ];
    $form['background_aling'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Background Position'),
      '#options' => [
        'left top' => $this
          ->t('Left Top'),
        'left center' => $this
          ->t('Left Center'),
        'left bottom' => $this
          ->t('Left Bottom'),
        'right top' => $this
          ->t('Right Top'),
        'right center' => $this
          ->t('Right Center'),
        'right bottom' => $this
          ->t('Right Bottom'),
        'center top' => $this
          ->t('Center Top'),
        'center center' => $this
          ->t('Center Center'),
        'center bottom' => $this
          ->t('Center Bottom'),
      ],
    ];
    if ($file_upload['status']) {
      $form['attributes']['href']['#access'] = FALSE;
      $form['attributes']['href']['#required'] = FALSE;
    }
    else {
      $form['fid']['#access'] = FALSE;
      $form['fid']['#required'] = FALSE;
    }
    $form['actions'] = [
      '#type' => 'actions',
    ];
    $form['actions']['save_modal'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Save'),
      '#submit' => [],
      '#ajax' => [
        'callback' => '::submitForm',
        'event' => 'click',
      ],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $response = new AjaxResponse();
    $form_state
      ->setValue([
      'attributes',
      'idModal',
    ], rand(1000000, 99999999));
    $fid = $form_state
      ->getValue([
      'fid',
      0,
    ]);
    if (!empty($fid)) {

      /** @var \Drupal\file\FileInterface */
      $file = $this->fileStorage
        ->load($fid);
      $file_url = file_create_url($file
        ->getFileUri());
      $file_url = file_url_transform_relative($file_url);
      $form_state
        ->setValue([
        'attributes',
        'image',
      ], $file_url);
    }
    if ($form_state
      ->getErrors()) {
      unset($form['#prefix'], $form['#suffix']);
      $form['status_messages'] = [
        '#type' => 'status_messages',
        '#weight' => -10,
      ];
      $response
        ->addCommand(new HtmlCommand('#editor-bgimage-dialog-form', $form));
      return $response;
    }
    $response
      ->addCommand(new EditorDialogSave($form_state
      ->getValues()));
    $response
      ->addCommand(new CloseModalDialogCommand());
    return $response;
  }

}

Members

Name	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
EditorFileDialog::$fileStorage	protected	property	The file storage service.
EditorFileDialog::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
EditorFileDialog::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
EditorFileDialog::getBaseFormId	public	function	Returns a string identifying the base form. Overrides BaseFormIdInterface::getBaseFormId
EditorFileDialog::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
EditorFileDialog::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
EditorFileDialog::__construct	public	function	Constructs a form object for image dialog.
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.
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.

You are here

class EditorFileDialog in CkEditor Background Image 8

Hierarchy

File

Namespace

Members

API Navigation