class ImageToolkitForm

Same name in other branches
  1. 8.9.x core/modules/system/src/Form/ImageToolkitForm.php \Drupal\system\Form\ImageToolkitForm
  2. 10 core/modules/system/src/Form/ImageToolkitForm.php \Drupal\system\Form\ImageToolkitForm
  3. 11.x core/modules/system/src/Form/ImageToolkitForm.php \Drupal\system\Form\ImageToolkitForm

Configures image toolkit settings for this site.

@internal

Hierarchy

Expanded class hierarchy of ImageToolkitForm

1 string reference to 'ImageToolkitForm'
system.routing.yml in core/modules/system/system.routing.yml
core/modules/system/system.routing.yml

File

core/modules/system/src/Form/ImageToolkitForm.php, line 16

Namespace

Drupal\system\Form
View source
class ImageToolkitForm extends ConfigFormBase {
    
    /**
     * An array containing currently available toolkits.
     *
     * @var \Drupal\Core\ImageToolkit\ImageToolkitInterface[]
     */
    protected $availableToolkits = [];
    
    /**
     * Constructs an ImageToolkitForm object.
     *
     * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
     *   The factory for configuration objects.
     * @param \Drupal\Core\ImageToolkit\ImageToolkitManager $manager
     *   The image toolkit plugin manager.
     */
    public function __construct(ConfigFactoryInterface $config_factory, ImageToolkitManager $manager) {
        parent::__construct($config_factory);
        foreach ($manager->getAvailableToolkits() as $id => $definition) {
            $this->availableToolkits[$id] = $manager->createInstance($id);
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container) {
        return new static($container->get('config.factory'), $container->get('image.toolkit.manager'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() {
        return 'system_image_toolkit_settings';
    }
    
    /**
     * {@inheritdoc}
     */
    protected function getEditableConfigNames() {
        return [
            'system.image',
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildForm(array $form, FormStateInterface $form_state) {
        $current_toolkit = $this->config('system.image')
            ->get('toolkit');
        $form['image_toolkit'] = [
            '#type' => 'radios',
            '#title' => $this->t('Select an image processing toolkit'),
            '#default_value' => $current_toolkit,
            '#options' => [],
        ];
        // If we have more than one image toolkit, allow the user to select the one
        // to use, and load each of the toolkits' settings form.
        foreach ($this->availableToolkits as $id => $toolkit) {
            $definition = $toolkit->getPluginDefinition();
            $form['image_toolkit']['#options'][$id] = $definition['title'];
            $form['image_toolkit_settings'][$id] = [
                '#type' => 'details',
                '#title' => $this->t('@toolkit settings', [
                    '@toolkit' => $definition['title'],
                ]),
                '#open' => TRUE,
                '#tree' => TRUE,
                '#states' => [
                    'visible' => [
                        ':radio[name="image_toolkit"]' => [
                            'value' => $id,
                        ],
                    ],
                ],
            ];
            $form['image_toolkit_settings'][$id] += $toolkit->buildConfigurationForm([], $form_state);
        }
        return parent::buildForm($form, $form_state);
    }
    
    /**
     * {@inheritdoc}
     */
    public function validateForm(array &$form, FormStateInterface $form_state) {
        parent::validateForm($form, $form_state);
        // Call the form validation handler for each of the toolkits.
        foreach ($this->availableToolkits as $toolkit) {
            $toolkit->validateConfigurationForm($form, $form_state);
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitForm(array &$form, FormStateInterface $form_state) {
        $this->config('system.image')
            ->set('toolkit', $form_state->getValue('image_toolkit'))
            ->save();
        // Call the form submit handler for each of the toolkits.
        foreach ($this->availableToolkits as $toolkit) {
            $toolkit->submitConfigurationForm($form, $form_state);
        }
        parent::submitForm($form, $form_state);
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ConfigFormBaseTrait::config protected function Retrieves a configuration object.
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 3
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. 3
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.
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.
ImageToolkitForm::$availableToolkits protected property An array containing currently available toolkits.
ImageToolkitForm::buildForm public function Overrides ConfigFormBase::buildForm
ImageToolkitForm::create public static function Overrides ConfigFormBase::create
ImageToolkitForm::getEditableConfigNames protected function Overrides ConfigFormBaseTrait::getEditableConfigNames
ImageToolkitForm::getFormId public function Overrides FormInterface::getFormId
ImageToolkitForm::submitForm public function Overrides ConfigFormBase::submitForm
ImageToolkitForm::validateForm public function Overrides FormBase::validateForm
ImageToolkitForm::__construct public function Constructs an ImageToolkitForm object. Overrides ConfigFormBase::__construct
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. 17
MessengerTrait::messenger public function Gets the messenger. 17
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. 3
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.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.