You are here

Home » API reference » Add To Head 8 » AddToHeadProfileForm.php

class AddToHeadProfileForm in Add To Head 8

Hierarchy

Expanded class hierarchy of AddToHeadProfileForm

1 string reference to 'AddToHeadProfileForm'
add_to_head.routing.yml in ./add_to_head.routing.yml
add_to_head.routing.yml

File

src/Form/AddToHeadProfileForm.php, line 8

Namespace

Drupal\add_to_head\Form
View source 
class AddToHeadProfileForm extends FormBase {
  public function getFormId() {
    return 'add_to_head_profile_form';
  }
  public function buildForm(array $form, FormStateInterface $form_state, array $profile = array()) {

    // Fill in profile defaults to ensure all keys exist.
    $profile += [
      'name' => '',
      'code' => '',
      'paths' => [
        'visibility' => 0,
        'paths' => '',
      ],
      'scope' => '',
      'roles' => [
        'visibility' => 0,
        'list' => [],
      ],
    ];
    $profile['roles']['visibility'] = empty($profile['roles']['visibility']) ? 0 : $profile['roles']['visibility'];
    $profile['roles']['list'] = is_array($profile['roles']['list']) ? $profile['roles']['list'] : array();
    $form['name_orig'] = array(
      '#type' => 'value',
      '#value' => $profile['name'],
    );
    $form['name'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Name'),
      '#description' => $this
        ->t('This is the unique name for this profile'),
      '#required' => TRUE,
      '#default_value' => $profile['name'],
    );
    $form['code'] = array(
      '#type' => 'textarea',
      '#title' => $this
        ->t('Code'),
      '#description' => $this
        ->t('Enter the code you would like to insert into the head of the page'),
      '#required' => TRUE,
      '#default_value' => $profile['code'],
      '#wysiwyg' => FALSE,
    );
    $form['paths'] = array(
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Paths'),
      '#tree' => TRUE,
    );
    $form['paths']['visibility'] = array(
      '#type' => 'radios',
      '#title' => $this
        ->t('Embed code on specific pages'),
      '#options' => array(
        'exclude' => $this
          ->t('Show on every page except the listed pages.'),
        'include' => $this
          ->t('Show on only the listed pages.'),
      ),
      '#default_value' => $profile['paths']['visibility'],
    );
    $form['paths']['paths'] = array(
      '#type' => 'textarea',
      '#title' => $this
        ->t('Paths'),
      '#description' => $this
        ->t("Enter one page per line as Drupal paths. The '*' character is a wildcard. Example paths are %blog for the blog page and %blog-wildcard for every personal blog. %front is the front page.", array(
        '%blog' => 'blog',
        '%blog-wildcard' => 'blog/*',
        '%front' => '<front>',
      )),
      '#default_value' => $profile['paths']['paths'],
      '#wysiwyg' => FALSE,
    );

    // Render the Roles overview.
    $form['roles'] = array(
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Roles'),
      '#tree' => TRUE,
    );
    $form['roles']['visibility'] = array(
      '#type' => 'radios',
      '#title' => $this
        ->t('Embed code for specific roles'),
      '#options' => array(
        'include' => $this
          ->t('Add for the selected roles only'),
        'exclude' => $this
          ->t('Add for every role except the selected ones'),
      ),
      '#default_value' => $profile['roles']['visibility'],
    );
    $form['roles']['list'] = array(
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Selected roles'),
      '#default_value' => $profile['roles']['list'],
      '#options' => user_role_names(),
      '#description' => $this
        ->t('If none of the roles are selected, all roles will have the code displayed. If a user has any of the roles checked, that user will be have the code displayed (or not, depending on the setting above).'),
    );
    $form['scope'] = array(
      '#type' => 'radios',
      '#title' => $this
        ->t('Scope of addition'),
      '#description' => $this
        ->t('Which section of the head would you like this snippet appended to?'),
      '#options' => array(
        'head' => $this
          ->t('Head - This appears early on in the head (before any CSS and JS are included)'),
        'styles' => $this
          ->t('Styles - It will be appended to the CSS files section. This is usually before any other JS is included.'),
        'scripts' => $this
          ->t('Scripts - It will be appended to the Javascripts section. This can, sometimes, be in the footer of the document depending on the theme.'),
      ),
      '#default_value' => $profile['scope'],
    );
    $form['submit'] = array(
      '#type' => 'submit',
      '#value' => $this
        ->t('Save'),
    );
    return $form;
  }
  public function validateForm(array &$form, FormStateInterface $form_state) {
    parent::validateForm($form, $form_state);
    $name = $form_state
      ->getValue('name');
    $settings = \Drupal::config('add_to_head.settings')
      ->get('add_to_head_profiles');
    if (preg_match('/[^a-z0-9\\-]/', $name)) {
      $form_state
        ->setErrorByName('name', $this
        ->t('The name should only contain lower case letters, numbers and hyphens.'));
      return;
    }
    if ($name != $form_state
      ->getValue('name_orig') && isset($settings[$name])) {
      $form_state
        ->setErrorByName('name', $this
        ->t('This name has already been used. Please try another.'));
    }
  }
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $settings = \Drupal::config('add_to_head.settings')
      ->get('add_to_head_profiles');
    if ($form_state
      ->getValue('name') != $form_state
      ->getValue('name_orig')) {
      unset($settings[$form_state
        ->getValue('name_orig')]);
    }
    $settings[$form_state
      ->getValue('name')] = array(
      'name' => $form_state
        ->getValue('name'),
      'code' => trim($form_state
        ->getValue('code')),
      'scope' => $form_state
        ->getValue('scope'),
      'paths' => [
        'visibility' => $form_state
          ->getValue('paths')['visibility'],
        'paths' => trim($form_state
          ->getValue('paths')['paths']),
      ],
      'roles' => [
        'visibility' => $form_state
          ->getValue('roles')['visibility'],
        'list' => array_filter($form_state
          ->getValue('roles')['list']),
      ],
    );
    add_to_head_set_settings($settings);
    $form_state
      ->setRedirect('add_to_head.admin');
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AddToHeadProfileForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
AddToHeadProfileForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
AddToHeadProfileForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
AddToHeadProfileForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
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::config protected function Retrieves a configuration object.
FormBase::configFactory protected function Gets the config factory for this form. 1
FormBase::container private function Returns the service container.
FormBase::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 87
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.