class AlternativeFrontpageSettings in Open Social 8

Class AlternativeFrontpageSettings.

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\alternative_frontpage\Form\AlternativeFrontpageSettings

1 string reference to 'AlternativeFrontpageSettings'

alternative_frontpage.routing.yml in modules/custom/alternative_frontpage/alternative_frontpage.routing.yml

modules/custom/alternative_frontpage/alternative_frontpage.routing.yml

File

modules/custom/alternative_frontpage/src/Form/AlternativeFrontpageSettings.php, line 14

Namespace

Drupal\alternative_frontpage\Form

class AlternativeFrontpageSettings extends ConfigFormBase {

  /**
   * Path validator.
   *
   * @var \Drupal\Core\Path\PathValidatorInterface
   */
  protected $pathValidator;

  /**
   * Class constructor.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   * @param \Drupal\Core\Path\PathValidatorInterface $path_validator
   *   The factory for configuration objects.
   */
  public function __construct(ConfigFactoryInterface $config_factory, PathValidatorInterface $path_validator) {
    parent::__construct($config_factory);
    $this->pathValidator = $path_validator;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {

    // Instantiates this form class.
    return new static($container
      ->get('config.factory'), $container
      ->get('path.validator'));
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('alternative_frontpage.settings');
    $site_config = $this
      ->config('system.site');
    $form['frontpage_for_anonymous_users'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Frontpage for anonymous users'),
      '#description' => $this
        ->t('Enter the frontpage for anonymous users. This setting will override the homepage which is set in the Site Configuration form. Enter the path starting with a forward slash. Default: /stream.'),
      '#maxlength' => 64,
      '#size' => 64,
      '#default_value' => $site_config
        ->get('page.front'),
    ];
    $form['frontpage_for_authenticated_user'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Frontpage for authenticated users'),
      '#description' => $this
        ->t('Enter the frontpage for authenticated users. When the value is left empty it will use the anonymous homepage for authenticated users as well. Enter the path starting with a forward slash. Default: /stream.'),
      '#maxlength' => 64,
      '#size' => 64,
      '#default_value' => $config
        ->get('frontpage_for_authenticated_user'),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $frontpage_for_anonymous_user = $form_state
      ->getValue('frontpage_for_anonymous_users');
    $frontpage_for_authenticated_user = $form_state
      ->getValue('frontpage_for_authenticated_user');
    if ($frontpage_for_anonymous_user) {
      if (!$this->pathValidator
        ->getUrlIfValidWithoutAccessCheck($frontpage_for_anonymous_user)) {
        $form_state
          ->setErrorByName('frontpage_for_anonymous_users', $this
          ->t('The path for the anonymous frontpage is not valid.'));
      }
      elseif (substr($frontpage_for_anonymous_user, 0, 1) !== '/') {
        $form_state
          ->setErrorByName('frontpage_for_anonymous_users', $this
          ->t('The path for the anonymous frontpage should start with a forward slash.'));
      }
      elseif (!$this
        ->isAllowedPath($frontpage_for_anonymous_user)) {
        $form_state
          ->setErrorByName('frontpage_for_anonymous_users', $this
          ->t('The path for the anonymous frontpage is not allowed.'));
      }
    }
    else {
      $form_state
        ->setErrorByName('frontpage_for_anonymous_users', $this
        ->t('The path for the anonymous frontpage cannot be empty.'));
    }
    if ($frontpage_for_authenticated_user) {
      if (!$this->pathValidator
        ->getUrlIfValidWithoutAccessCheck($frontpage_for_authenticated_user)) {
        $form_state
          ->setErrorByName('frontpage_for_authenticated_user', $this
          ->t('The path for the authenticated frontpage is not valid.'));
      }
      elseif (substr($frontpage_for_authenticated_user, 0, 1) !== '/') {
        $form_state
          ->setErrorByName('frontpage_for_authenticated_user', $this
          ->t('The path for the authenticated frontpage should start with a forward slash.'));
      }
      elseif (!$this
        ->isAllowedPath($frontpage_for_authenticated_user)) {
        $form_state
          ->setErrorByName('frontpage_for_authenticated_user', $this
          ->t('The path for the authenticated frontpage is not allowed.'));
      }
    }
  }

  /**
   * Checks if a path is allowed.
   *
   * Some paths are not allowed, e.g. /user/logout or /ajax.
   *
   * @param string $path
   *   Path to check.
   *
   * @return bool
   *   Returns true when path is allowed.
   */
  private function isAllowedPath($path) {
    $unallowed_paths = [
      '/user/logout',
      '/ajax',
    ];
    foreach ($unallowed_paths as $unallowed_path) {
      if ($unallowed_path === substr($path, 0, strlen($unallowed_path))) {
        return FALSE;
      }
    }
    return TRUE;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);
    $this
      ->config('alternative_frontpage.settings')
      ->set('frontpage_for_authenticated_user', $form_state
      ->getValue('frontpage_for_authenticated_user'))
      ->save();
    $this->configFactory
      ->getEditable('system.site')
      ->set('page.front', $form_state
      ->getValue('frontpage_for_anonymous_users'))
      ->save();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AlternativeFrontpageSettings::$pathValidator	protected	property	Path validator.
AlternativeFrontpageSettings::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
AlternativeFrontpageSettings::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
AlternativeFrontpageSettings::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
AlternativeFrontpageSettings::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
AlternativeFrontpageSettings::isAllowedPath	private	function	Checks if a path is allowed.
AlternativeFrontpageSettings::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
AlternativeFrontpageSettings::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
AlternativeFrontpageSettings::__construct	public	function	Class constructor. 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.
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.