class BeautytipsConfigForm in BeautyTips 8

Beautytips admin settings 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\beautytips\Form\BeautytipsConfigForm

Expanded class hierarchy of BeautytipsConfigForm

1 string reference to 'BeautytipsConfigForm'

beautytips.routing.yml in ./beautytips.routing.yml: beautytips.routing.yml

File

src/Form/BeautytipsConfigForm.php, line 15

Namespace

Drupal\beautytips\Form

View source

class BeautytipsConfigForm extends ConfigFormBase {
  protected $moduleHandler;
  protected $fieldNames = [
    'beautytips_position',
    'beautytips_text_input',
    'beautytips_form_id',
    'beautytips_show_form',
    'beautytips_drupal_help',
    'beautytips_advanced_help',
  ];

  /**
   * Constructs a \Drupal\system\ConfigFormBase object.
   *
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   */
  public function __construct(ModuleHandlerInterface $module_handler, ConfigFactoryInterface $config_factory) {
    parent::__construct($config_factory);
    $this
      ->setConfigFactory($config_factory);
    $this->moduleHandler = $module_handler;
  }

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

  /**
   * {@inheritdoc}
   */
  public function getFormID() {
    return 'beautytips_admin';
  }

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('beautytips.basic');
    $form['beautytips_always_add'] = [
      '#title' => $this
        ->t('Add beautytips js to every page'),
      '#description' => $this
        ->t('This allows you to give the class \'beautytips\' to any element on a page and the title attribute will popup as a beautytip.<br /> i.e. <i> &lt;p class="beautytips" title="type the text you want beautytips to display here"&gt .....&lt/p&gt</i>'),
      '#type' => 'checkbox',
      '#default_value' => $config
        ->get('beautytips_always_add'),
      '#weight' => -1,
    ];
    $selectors = $config
      ->get('beautytips_added_selectors_array');
    $form['beautytips_added_selectors_array'] = [
      '#title' => $this
        ->t('Add beautytips to the following selectors'),
      '#description' => $this
        ->t("Separate selectors with a comma.  Beautytips will be added to each of these on every page.  The element's title attribute will be the text used. (OPTIONAL)"),
      '#type' => 'textfield',
      '#default_value' => is_array($selectors) ? implode(", ", $selectors) : '',
      '#weight' => -1,
    ];
    $form['beautytips_ltr'] = [
      '#title' => $this
        ->t('Support Left to Right display'),
      '#description' => $this
        ->t('Only check this if this is an ltr site.  This adds css to support it.'),
      '#type' => 'checkbox',
      '#default_value' => $config
        ->get('beautytips_ltr'),
    ];
    $form['beautytips_default_styles'] = [
      '#type' => 'details',
      '#title' => 'Styling Options',
      '#collapsible' => TRUE,
      '#collapsed' => FALSE,
    ];
    $styles = beautytips_get_styles(TRUE);
    $style_options = [];
    if (count($styles)) {
      unset($styles['default']);
      foreach ($styles as $name => $style) {
        $bt_style_options[$name]['cssSelect'] = '#edit-beautytips-default-style-' . str_replace('_', '-', $name);
        $bt_style_options[$name]['text'] = 'Aenean risus purus, pharetra in, blandit quis, gravida a, turpis.  Aenean risus purus, pharetra in, blandit quis, gravida a, turpis.  Aenean risus purus, pharetra in, blandit quis, gravida a, turpis.';
        $bt_style_options[$name]['width'] = isset($style['width']) ? $style['width'] : '300px';
        $bt_style_options[$name]['style'] = $name;
        $style_options[$name] = $name;
      }
    }
    $bt_style_options['default_hover'] = [
      'cssSelect' => '#beautytips-site-wide-popup',
      'text' => 'Sed justo nibh, ultrices ut gravida et, laoreet et elit. Nullam consequat lacus et dui dignissim venenatis. Curabitur quis urna eget mi interdum viverra quis eu enim. Ut sit amet nunc augue. Morbi fermentum ultricies velit sed aliquam. Etiam dui tortor, auctor sed tempus ac, auctor sed sapien.',
      'positions' => [
        'right',
      ],
    ];

    // TODO: Determine what to do if default style has been removed.
    $form['beautytips_default_styles']['beautytips_default_style'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Choose a default style'),
      '#description' => $this
        ->t('Mouse over the radio buttons to see a preview.'),
      '#prefix' => '<div id="beauty-default-styles">',
      '#suffix' => '</div>',
      '#options' => $style_options,
      '#default_value' => $config
        ->get('beautytips_default_style'),
    ];
    $style_options = [
      'fill' => $this
        ->t('background color (string - html color)'),
      'strokeWidth' => $this
        ->t('width of border (integer)'),
      'strokeStyle' => $this
        ->t('color of border (string - html color)'),
      'width' => $this
        ->t('width of popup (number in px)'),
      'padding' => $this
        ->t('space between content and border (number in px)'),
      'cornerRadius' => $this
        ->t('Controls roundness of corners (integer)'),
      'spikeGirth' => $this
        ->t('thickness of spike (integer)'),
      'spikeLength' => $this
        ->t('length of spike (integer)'),
      'shadowBlur' => $this
        ->t('Size of popup shadow (integer)'),
      'shadowColor' => $this
        ->t('Color of popup shadow (string - html color)'),
    ];
    $form['beautytips_default_styles']['custom_styles'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Custom Style Options'),
      '#description' => $this
        ->t('<b>Set a custom style.</b><br /> Note: These will use the default style that is selected as a base <br /> but will overide elements such as background color, border color etc.   <br /><i>Leave these empty unless you know what you are doing.</i><div id="beautytips-popup-changes"><div id="beauty-click-text"><p>Double Click here to view popup with custom changes</p></div></div>'),
      '#collapsible' => TRUE,
      '#collapsed' => TRUE,
      '#attributes' => [
        'class' => [
          'bt-custom-styles',
        ],
      ],
      '#prefix' => '<div id="beautytips-site-wide-popup"><div id="beauty-text"><p>Hover here to see the current site-wide beautytips</p></div></div>',
    ];
    $custom_style = $config
      ->get('beautytips_custom_style');
    foreach ($style_options as $option => $description) {
      $form['beautytips_default_styles']['custom_styles']['bt-options-box-' . $option] = [
        '#title' => $option,
        '#description' => $description,
        '#type' => 'textfield',
        '#default_value' => isset($custom_style[$option]) ? $custom_style[$option] : '',
      ];
    }
    $form['beautytips_default_styles']['custom_styles']['bt-options-box-shadow'] = [
      '#title' => 'shadow',
      '#description' => $this
        ->t('Whether or not the popup has a shadow'),
      '#type' => 'radios',
      '#options' => [
        'default' => $this
          ->t('Default'),
        'shadow' => $this
          ->t('Shadow On'),
        'no_shadow' => $this
          ->t('Shadow Off'),
      ],
      '#attributes' => [
        'class' => [
          'beautytips-options-shadow',
        ],
      ],
      '#default_value' => isset($custom_style['shadow']) ? $custom_style['shadow'] : 'default',
    ];
    $form['beautytips_default_styles']['custom_styles']['bt-options-cssClass'] = [
      '#title' => 'cssClass',
      '#description' => $this
        ->t('The class that will be applied to the box wrapper div (of the TIP)'),
      '#type' => 'textfield',
      '#default_value' => isset($custom_style['cssClass']) ? $custom_style['cssClass'] : '',
    ];
    $css_style_options = [
      'color',
      'fontFamily',
      'fontWeight',
      'fontSize',
    ];
    $form['beautytips_default_styles']['custom_styles']['css-styles'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Font Styling'),
      '#description' => $this
        ->t('Enter css options for changing the font style'),
      '#attributes' => [
        'class' => [
          'beautytips-css-styling',
        ],
      ],
      '#collapsible' => FALSE,
    ];
    foreach ($css_style_options as $option) {
      $form['beautytips_default_styles']['custom_styles']['css-styles']['bt-options-css-' . $option] = [
        '#title' => $option,
        '#type' => 'textfield',
        '#default_value' => isset($custom_style['cssStyles'][$option]) ? $custom_style['cssStyles'][$option] : '',
      ];
    }
    $form['#attached'] = [
      'library' => [
        'beautytips/beautytips.beautytips',
      ],
    ];
    beautytips_add_beautytips($form, $bt_style_options);
    if ($this->moduleHandler
      ->moduleExists('beautytips_ui')) {
      beautytips_ui_admin_settings($form);
    }
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $values = $form_state
      ->getValues();
    $integer_fields = [
      'bt-options-box-strokeWidth',
      'bt-options-box-cornerRadius',
      'bt-options-box-spikeGirth',
      'bt-options-box-spikeLength',
      'bt-options-box-shadowBlur',
    ];
    $pixel_fields = [
      'bt-options-box-width',
      'bt-options-box-padding',
      'bt-options-css-fontSize',
    ];
    foreach ($integer_fields as $name) {
      if ($values[$name]) {
        if (!is_numeric($values[$name])) {
          $form_state
            ->setErrorByName($name, $this
            ->t('You need to enter a numeric value for <em>@name</em>', [
            '@name' => str_replace([
              'bt-options-box-',
              'bt-options-css-',
            ], '', $name),
          ]));
        }
        else {
          $form_state
            ->setValue($name, round($values[$name]));
        }
      }
    }
    foreach ($pixel_fields as $name) {
      if ($values[$name]) {
        $unit = substr($values[$name], -2, 2);
        $value = str_replace([
          'px',
          ' ',
          'em',
        ], '', $values[$name]);
        if (!is_numeric($value) || !$value && $value != 0 || !in_array($unit, [
          'px',
          'em',
        ])) {
          $form_state
            ->setErrorByName($name, $this
            ->t('You need to enter a numeric value for <em>@name</em>, followed by <em>px</em>', [
            '@name' => str_replace([
              'bt-options-box-',
              'bt-options-css-',
            ], '', $name),
          ]));
        }
      }
    }
    parent::validateForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->configFactory()
      ->getEditable('beautytips.basic');
    $values = $form_state
      ->getValues();
    if (count($values)) {
      $custom_style = [];
      $css_style = [];
      foreach ($values as $option => $value) {
        if (strpos($option, 'bt-options-box-') === 0) {
          $option = str_replace('bt-options-box-', '', $option);
          $custom_style[$option] = $value;
        }
        elseif ($option == 'bt-options-cssClass') {
          $option = str_replace('bt-options-', '', $option);
          $custom_style[$option] = $value;
        }
        elseif (strpos($option, 'bt-options-css-') === 0) {
          $option = str_replace('bt-options-css-', '', $option);
          if ($value) {
            $css_style[$option] = $value;
          }
        }
      }

      // Store the defaults - they will be passed to javascript.
      $style = beautytips_get_style($values['beautytips_default_style']);
      if (count($custom_style)) {
        foreach ($custom_style as $option => $value) {
          if ($option == 'shadow') {
            if ($value != 'default') {
              $style['shadow'] = $value == 'shadow' ? TRUE : FALSE;
            }
          }
          elseif (!empty($value) || $value == '0') {
            $style[$option] = is_numeric($value) ? (int) $value : (string) $value;
          }
        }
      }
      if (count($css_style)) {
        foreach ($css_style as $option => $value) {
          if (!empty($value)) {
            $style['cssStyles'][$option] = (string) $value;
          }
        }
        if (!empty($css_style)) {
          $custom_style['cssStyles'] = $css_style;
        }
      }
      $config
        ->set('beautytips_defaults', $style);
      $config
        ->set('beautytips_custom_style', $custom_style);
      $config
        ->set('beautytips_default_style', $values['beautytips_default_style']);
      $config
        ->set('beautytips_always_add', $values['beautytips_always_add']);
      $config
        ->set('beautytips_ltr', $values['beautytips_ltr']);
      Cache::invalidateTags([
        'beautytips',
      ]);

      // Store array of selectors that bt will be added to on every page.
      $selectors = explode(",", $values['beautytips_added_selectors_array']);
      if (count($selectors)) {
        foreach ($selectors as $key => $selector) {
          $selectors[$key] = trim($selector);
        }
      }
      $config
        ->set('beautytips_added_selectors_array', $selectors);
      if (!empty($values)) {
        foreach ($values as $key => $value) {
          if (in_array($key, $this->fieldNames)) {
            \Drupal::state()
              ->set($key, $value);
          }
        }
      }
    }
    if ($this->moduleHandler
      ->moduleExists('beautytips_ui')) {
      beautytips_ui_admin_submit($form, $form_state);
    }
    $config
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BeautytipsConfigForm::$fieldNames	protected	property
BeautytipsConfigForm::$moduleHandler	protected	property
BeautytipsConfigForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
BeautytipsConfigForm::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
BeautytipsConfigForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
BeautytipsConfigForm::getFormID	public	function
BeautytipsConfigForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
BeautytipsConfigForm::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
BeautytipsConfigForm::__construct	public	function	Constructs a \Drupal\system\ConfigFormBase 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.
FormInterface::getFormId	public	function	Returns a unique string identifying the form.	236
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.

You are here

class BeautytipsConfigForm in BeautyTips 8

Hierarchy

File

Namespace

Members

API Navigation