SocialGroupSettings.php in Open Social 10.1.x

Namespace

Drupal\social_group\Form

File

modules/social_features/social_group/src/Form/SocialGroupSettings.php

<?php

namespace Drupal\social_group\Form;

use Drupal\Core\Cache\Cache;
use Drupal\Core\Form\ConfigFormBase;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Link;
use Drupal\Core\Url;
use Drupal\crop\Entity\CropType;

/**
 * Settings form which enables site managers to configure different options.
 *
 * @package Drupal\social_event_managers\Form
 */
class SocialGroupSettings extends ConfigFormBase {

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('social_group.settings');
    $form['permissions'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Group permissions'),
      '#options' => [
        'allow_group_create' => $this
          ->t('Allow regular users to create new groups'),
        'allow_group_selection_in_node' => $this
          ->t('Allow regular users to change the group their content belong to'),
        'address_visibility_settings' => $this
          ->t('Only show the group address to the group members'),
      ],
      '#weight' => 10,
    ];
    foreach (array_keys($form['permissions']['#options']) as $permission) {
      if ($this
        ->hasPermission($permission)) {
        $form['permissions']['#default_value'][] = $permission;
      }
    }
    $form['default_hero'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Default group hero size'),
      '#description' => $this
        ->t('The default hero size used on this platform. Only applicable when logged-in users cannot choose a different hero size on each group.'),
      '#default_value' => $config
        ->get('default_hero'),
      '#options' => $this
        ->getCropTypes(),
      '#weight' => 20,
    ];

    // Add an option for site manager to enable/disable option to choose group
    // type on page to add flexible groups.
    if (\Drupal::moduleHandler()
      ->moduleExists('social_group_flexible_group')) {
      $form['social_group_type_required'] = [
        '#type' => 'checkbox',
        '#title' => $this
          ->t('Require group types'),
        '#description' => $this
          ->t('When checked, a new option will appear on
          the flexible group form which requires group creators to select a
          group type, this allows for a better categorisation of groups in your
          community. You can add or edit the available group types @link', [
          '@link' => Link::fromTextAndUrl('here.', Url::fromUserInput('/admin/structure/taxonomy/manage/group_type/overview'))
            ->toString(),
        ]),
        '#default_value' => $config
          ->get('social_group_type_required'),
      ];
    }
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);
    $config = $this
      ->config('social_group.settings');
    foreach ($form_state
      ->getValue('permissions') as $key => $value) {
      $config
        ->set($key, !empty($value));
    }
    $config
      ->set('default_hero', $form_state
      ->getValue('default_hero'))
      ->save();
    $config
      ->set('social_group_type_required', $form_state
      ->getValue('social_group_type_required'))
      ->save();
    Cache::invalidateTags([
      'group_view',
    ]);
  }

  /**
   * Function that gets the available crop types.
   *
   * @return array
   *   The croptypes.
   */
  protected function getCropTypes() {
    $croptypes = [
      'hero',
      'hero_small',
    ];
    $options = [];
    foreach ($croptypes as $croptype) {
      $type = CropType::load($croptype);
      if ($type instanceof CropType) {
        $options[$type
          ->id()] = $type
          ->label();
      }
    }
    return $options;
  }

  /**
   * Check if permission is granted.
   *
   * @param string $name
   *   The permission name.
   *
   * @return bool
   *   TRUE if permission is granted.
   */
  protected function hasPermission($name) {
    return !empty($this
      ->config('social_group.settings')
      ->get($name));
  }

}

Classes

Name	Description
SocialGroupSettings	Settings form which enables site managers to configure different options.