class ImageToolkitForm

Configures image toolkit settings for this site.

Hierarchy

Expanded class hierarchy of ImageToolkitForm

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

File

drupal/core/modules/system/lib/Drupal/system/Form/ImageToolkitForm.php, line 19
Contains \Drupal\system\Form\ImageToolkitForm.

Namespace

Drupal\system\Form
View source
class ImageToolkitForm extends SystemConfigFormBase {

  /**
   * An array containing currently available toolkits.
   *
   * @var array
   */
  protected $availableToolkits = array();

  /**
   * Constructs a ImageToolkitForm object.
   *
   * @param \Drupal\Core\Config\ConfigFactory $config_factory
   *   The factory for configuration objects.
   * @param \Drupal\Core\Config\Context\ContextInterface $context
   *   The configuration context used for this configuration object.
   * @param \Drupal\system\Plugin\ImageToolkitManager $manager
   *   The image toolkit plugin manager.
   */
  public function __construct(ConfigFactory $config_factory, ContextInterface $context, ImageToolkitManager $manager) {
    parent::__construct($config_factory, $context);
    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('config.context.free'), $container
      ->get('image.toolkit.manager'));
  }

  /**
   * {@inheritdoc}
   */
  public function getFormID() {
    return 'system_image_toolkit_settings';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, array &$form_state) {
    $current_toolkit = $this->configFactory
      ->get('system.image')
      ->get('toolkit');
    $form['image_toolkit'] = array(
      '#type' => 'radios',
      '#title' => t('Select an image processing toolkit'),
      '#default_value' => $current_toolkit,
      '#options' => array(),
    );

    // If we have available toolkits, allow the user to select the image toolkit
    // to use and load the settings forms.
    foreach ($this->availableToolkits as $id => $toolkit) {
      $definition = $toolkit
        ->getPluginDefinition();
      $form['image_toolkit']['#options'][$id] = $definition['title'];
      $form['image_toolkit_settings'][$id] = array(
        '#type' => 'fieldset',
        '#title' => t('@toolkit settings', array(
          '@toolkit' => $definition['title'],
        )),
        '#collapsible' => TRUE,
        '#collapsed' => $id == $current_toolkit ? FALSE : TRUE,
        '#tree' => TRUE,
      );
      $form['image_toolkit_settings'][$id] += $toolkit
        ->settingsForm();
    }
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, array &$form_state) {
    $this->configFactory
      ->get('system.image')
      ->set('toolkit', $form_state['values']['image_toolkit'])
      ->save();

    // Call the form submit handler for each of the toolkits.
    // Get the toolkit settings forms.
    foreach ($this->availableToolkits as $id => $toolkit) {
      $toolkit
        ->settingsFormSubmit($form, $form_state);
    }
    parent::submitForm($form, $form_state);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ImageToolkitForm::$availableToolkits protected property An array containing currently available toolkits.
ImageToolkitForm::buildForm public function Implements \Drupal\Core\Form\FormInterface::buildForm(). Overrides SystemConfigFormBase::buildForm
ImageToolkitForm::create public static function Instantiates a new instance of this controller. Overrides SystemConfigFormBase::create
ImageToolkitForm::getFormID public function Returns a unique string identifying the form. Overrides FormInterface::getFormID
ImageToolkitForm::submitForm public function Implements \Drupal\Core\Form\FormInterface::submitForm(). Overrides SystemConfigFormBase::submitForm
ImageToolkitForm::__construct public function Constructs a ImageToolkitForm object. Overrides SystemConfigFormBase::__construct
SystemConfigFormBase::$configFactory protected property Stores the configuration factory.
SystemConfigFormBase::validateForm public function Implements \Drupal\Core\Form\FormInterface::validateForm(). Overrides FormInterface::validateForm 7