You are here

Home » API reference » Organic groups 8 » AdminSettingsForm.php

class AdminSettingsForm in Organic groups 8

Provides the main administration settings form for Organic groups.

Hierarchy

Expanded class hierarchy of AdminSettingsForm

1 string reference to 'AdminSettingsForm'
og_ui.routing.yml in og_ui/og_ui.routing.yml
og_ui/og_ui.routing.yml

File

og_ui/src/Form/AdminSettingsForm.php, line 16

Namespace

Drupal\og_ui\Form
View source 
class AdminSettingsForm extends ConfigFormBase {

  /**
   * The manager for OgDeleteOrphans plugins.
   *
   * @var \Drupal\Component\Plugin\PluginManagerInterface
   */
  protected $ogDeleteOrphansPluginManager;

  /**
   * Constructs an AdminSettingsForm object.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   * @param \Drupal\Component\Plugin\PluginManagerInterface $delete_orphans_plugin_manager
   *   The manager for OgDeleteOrphans plugins.
   */
  public function __construct(ConfigFactoryInterface $config_factory, PluginManagerInterface $delete_orphans_plugin_manager) {
    parent::__construct($config_factory);
    $this->ogDeleteOrphansPluginManager = $delete_orphans_plugin_manager;
  }

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

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildForm($form, $form_state);
    $config_og = $this
      ->config('og.settings');
    $form['og_group_manager_full_access'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Group manager has full permissions'),
      '#description' => $this
        ->t('When enabled the group manager will have all the permissions in the group.'),
      '#default_value' => $config_og
        ->get('group_manager_full_access'),
    ];
    $form['og_node_access_strict'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Strict node access permissions'),
      '#description' => $this
        ->t('When enabled Organic groups will restrict permissions for creating, updating and deleting according to the Organic groups access settings. Example: A content editor with the <em>Edit any page content</em> permission who is not a member of a group would be denied access to modifying page content in that group. (For restricting view access use the Organic groups access control module.)'),
      '#default_value' => $config_og
        ->get('node_access_strict'),
    ];

    // @todo Port og_ui_admin_people_view.
    $form['og_delete_orphans'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Delete orphans'),
      '#description' => $this
        ->t('Delete orphaned group content (excluding users) when a group is deleted.'),
      '#default_value' => $config_og
        ->get('delete_orphans'),
    ];
    $definitions = $this->ogDeleteOrphansPluginManager
      ->getDefinitions();
    ksort($definitions);
    $options = array_map(function ($definition) {
      return $definition['label'];
    }, $definitions);
    $form['og_delete_orphans_plugin_id'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Deletion method'),
      '#default_value' => $config_og
        ->get('delete_orphans_plugin_id'),
      '#options' => $options,
      '#states' => [
        'visible' => [
          ':input[name="og_delete_orphans"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
      '#attributes' => [
        'class' => [
          'child-item',
        ],
      ],
    ];
    foreach ($definitions as $id => $definition) {

      /** @var \Drupal\og\OgDeleteOrphansInterface $plugin */
      $plugin = $this->ogDeleteOrphansPluginManager
        ->createInstance($id, []);

      // Add the description for each delete method.
      $form['og_delete_orphans_plugin_id'][$id] = [
        '#description' => $definition['description'],
      ];

      // Show the configuration options for the chosen plugin.
      $configuration = $plugin
        ->configurationForm($form, $form_state);
      if ($configuration) {
        $form['og_delete_orphans_options_' . $id] = $configuration + [
          '#states' => [
            'visible' => [
              ':input[name="og_delete_orphans"]' => [
                'checked' => TRUE,
              ],
              ':input[name="og_delete_orphans_plugin_id"]' => [
                'value' => $id,
              ],
            ],
          ],
        ];
      }
    }
    $form['#attached']['library'][] = 'og_ui/form';
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);
    $this
      ->config('og.settings')
      ->set('group_manager_full_access', $form_state
      ->getValue('og_group_manager_full_access'))
      ->set('node_access_strict', $form_state
      ->getValue('og_node_access_strict'))
      ->set('delete_orphans', $form_state
      ->getValue('og_delete_orphans'))
      ->set('delete_orphans_plugin_id', $form_state
      ->getValue('og_delete_orphans_plugin_id'))
      ->save();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AdminSettingsForm::$ogDeleteOrphansPluginManager protected property The manager for OgDeleteOrphans plugins.
AdminSettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
AdminSettingsForm::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create
AdminSettingsForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
AdminSettingsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
AdminSettingsForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
AdminSettingsForm::__construct public function Constructs an AdminSettingsForm object. Overrides ConfigFormBase::__construct
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.