class SocialUserNavigationSettingsForm in Open Social 8.6

Class SocialUserNavigationSettingsForm.

@package Drupal\social_user\Form

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\social_user\Form\SocialUserNavigationSettingsForm implements ContainerInjectionInterface

1 string reference to 'SocialUserNavigationSettingsForm'

social_user.routing.yml in modules/social_features/social_user/social_user.routing.yml

modules/social_features/social_user/social_user.routing.yml

File

modules/social_features/social_user/src/Form/SocialUserNavigationSettingsForm.php, line 17

Namespace

Drupal\social_user\Form

class SocialUserNavigationSettingsForm extends ConfigFormBase implements ContainerInjectionInterface {

  /**
   * The Module Handler.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * {@inheritdoc}
   */
  public function __construct(ConfigFactoryInterface $config_factory, ModuleHandlerInterface $moduleHandler) {
    parent::__construct($config_factory);
    $this->moduleHandler = $moduleHandler;
  }

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

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {

    // Get the configuration file.
    $config = $this
      ->config('social_user.navigation.settings');
    $form['navigation_settings'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Display icon configuration'),
      '#description' => $this
        ->t('Select which icons you want to show or hide in the main (top) navigation bar.'),
    ];

    // Check if the module is enabled before we show the setting.
    if ($this->moduleHandler
      ->moduleExists('social_private_message')) {
      $form['navigation_settings']['display_social_private_message_icon'] = [
        '#type' => 'checkbox',
        '#title' => $this
          ->t('Display the <b>Social Private Message</b> (envelope) icon.'),
        '#default_value' => $config
          ->get('display_social_private_message_icon'),
        '#required' => FALSE,
        '#description' => $this
          ->t("<i>Disabling this won't disable the Social Private Message feature, but only hide the icon from the navigation.</i>"),
      ];
    }

    // Check if the module is enabled before we show the setting.
    if ($this->moduleHandler
      ->moduleExists('social_group')) {
      $form['navigation_settings']['display_my_groups_icon'] = [
        '#type' => 'checkbox',
        '#title' => $this
          ->t('Display the <b>My Groups</b> icon in the main navigation'),
        '#default_value' => $config
          ->get('display_my_groups_icon'),
        '#required' => FALSE,
        '#description' => $this
          ->t("<i>Disabling this will simply hide the 'My Groups' button from the main navigation.</i>"),
      ];
    }
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {

    // Get the configuration file.
    $config = $this
      ->config('social_user.navigation.settings');
    $config
      ->set('display_social_private_message_icon', $form_state
      ->getValue('display_social_private_message_icon'))
      ->set('display_my_groups_icon', $form_state
      ->getValue('display_my_groups_icon'))
      ->save();
    parent::submitForm($form, $form_state);
  }

}

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.
SocialUserNavigationSettingsForm::$moduleHandler	protected	property	The Module Handler.
SocialUserNavigationSettingsForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
SocialUserNavigationSettingsForm::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
SocialUserNavigationSettingsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
SocialUserNavigationSettingsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
SocialUserNavigationSettingsForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
SocialUserNavigationSettingsForm::__construct	public	function	Constructs a \Drupal\system\ConfigFormBase object. Overrides ConfigFormBase::__construct
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.