class WorkspaceConfigForm in Workspace 8

Class WorkspaceConfigForm.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
  - class \Drupal\workspace\Form\WorkspaceConfigForm

Expanded class hierarchy of WorkspaceConfigForm

1 string reference to 'WorkspaceConfigForm'

workspace.routing.yml in ./workspace.routing.yml: workspace.routing.yml

File

src/Form/WorkspaceConfigForm.php, line 16

Namespace

Drupal\workspace\Form

View source

class WorkspaceConfigForm extends ConfigFormBase {

  /**
   * Drupal\multiversion\Workspace\WorkspaceManagerInterface definition.
   *
   * @var \Drupal\multiversion\Workspace\WorkspaceManagerInterface
   */
  protected $workspaceManager;
  protected $entityTypeManager;

  /**
   * Constructs a new WorkspaceConfigForm object.
   */
  public function __construct(ConfigFactoryInterface $config_factory, WorkspaceManagerInterface $workspace_manager, EntityTypeManagerInterface $entity_type_manager) {
    parent::__construct($config_factory);
    $this->workspaceManager = $workspace_manager;
    $this->entityTypeManager = $entity_type_manager;
  }

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

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config_settings = $this
      ->config('workspace.settings');
    $form['default'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Default settings'),
    ];
    $form['default']['description'] = [
      '#type' => 'markup',
      '#markup' => $this
        ->t('Settings that will be used as default when creating new workspaces.'),
    ];
    $this
      ->addDefaultTargetWorkspaceSettingField($form, $config_settings);
    $this
      ->addFilterSettingsFields($form, $config_settings);
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);
    $config_settings = $this
      ->config('workspace.settings');
    foreach ([
      'push_replication_settings' => $this
        ->t('Push replication settings'),
      'pull_replication_settings' => $this
        ->t('Pull replication settings'),
      'upstream' => $this
        ->t('Default target workspace'),
    ] as $key => $item) {
      $value_settings = $form_state
        ->getValue($key);
      $config_settings
        ->set($key, $value_settings)
        ->save();
    }
  }

  /**
   * {@inheritdoc}
   */
  private function addFilterSettingsFields(&$form, $config_settings) {
    $options = [];
    $replication_settings = $this->entityTypeManager
      ->getStorage('replication_settings')
      ->loadByProperties([]);
    foreach ($replication_settings as $replication_setting) {
      $options[$replication_setting
        ->id()] = $replication_setting
        ->label();
    }
    $form['default']['pull_replication_settings'] = [
      '#type' => 'select',
      '#required' => FALSE,
      '#empty_option' => $this
        ->t('- None -'),
      '#empty_value' => '_none',
      '#title' => $this
        ->t('Default replication settings on update'),
      '#description' => $this
        ->t('The default settings to use when content is pulled from upstream.'),
      '#options' => $options,
      '#default_value' => $config_settings
        ->get('pull_replication_settings'),
    ];
    $form['default']['push_replication_settings'] = [
      '#type' => 'select',
      '#required' => FALSE,
      '#empty_option' => $this
        ->t('- None -'),
      '#empty_value' => '_none',
      '#title' => $this
        ->t('Default replication settings on deploy'),
      '#description' => $this
        ->t('The default settings to use when content is pushed to upstream.'),
      '#options' => $options,
      '#default_value' => $config_settings
        ->get('push_replication_settings'),
    ];
  }

  /**
   * {@inheritdoc}
   */
  private function addDefaultTargetWorkspaceSettingField(&$form, $config_settings) {
    $options = [];
    $workspace_pointers = WorkspacePointer::loadMultiple();
    foreach ($workspace_pointers as $workspace_pointer) {
      if ($workspace_pointer
        ->getWorkspaceAvailable() === FALSE) {
        continue;
      }

      /** @var \Drupal\multiversion\Entity\WorkspaceInterface $workspace */
      $workspace = $workspace_pointer
        ->getWorkspace();
      if ($workspace && !$workspace
        ->isPublished()) {
        continue;
      }
      $options[$workspace_pointer
        ->id()] = $workspace_pointer
        ->label();
    }
    $form['default']['upstream'] = [
      '#type' => 'select',
      '#required' => FALSE,
      '#empty_option' => $this
        ->t('- None -'),
      '#empty_value' => 0,
      '#title' => $this
        ->t('Assign default target workspace'),
      '#description' => $this
        ->t('The default workspace to push to and pull from.'),
      '#options' => $options,
      '#default_value' => $config_settings
        ->get('upstream'),
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigFormBaseTrait::config	protected	function	Retrieves a configuration object.
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.
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.
WorkspaceConfigForm::$entityTypeManager	protected	property
WorkspaceConfigForm::$workspaceManager	protected	property	Drupal\multiversion\Workspace\WorkspaceManagerInterface definition.
WorkspaceConfigForm::addDefaultTargetWorkspaceSettingField	private	function
WorkspaceConfigForm::addFilterSettingsFields	private	function
WorkspaceConfigForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
WorkspaceConfigForm::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
WorkspaceConfigForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
WorkspaceConfigForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
WorkspaceConfigForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
WorkspaceConfigForm::__construct	public	function	Constructs a new WorkspaceConfigForm object. Overrides ConfigFormBase::__construct

You are here

class WorkspaceConfigForm in Workspace 8

Hierarchy

File

Namespace

Members

API Navigation