You are here

Home » API reference » Ubercart 8.4 » CartLinksSettingsForm.php

class CartLinksSettingsForm in Ubercart 8.4

Configure general shopping cart settings for this site.

Hierarchy

Expanded class hierarchy of CartLinksSettingsForm

1 string reference to 'CartLinksSettingsForm'
uc_cart_links.routing.yml in uc_cart_links/uc_cart_links.routing.yml
uc_cart_links/uc_cart_links.routing.yml

File

uc_cart_links/src/Form/CartLinksSettingsForm.php, line 14

Namespace

Drupal\uc_cart_links\Form
View source 
class CartLinksSettingsForm extends ConfigFormBase {

  /**
   * The uc_cart_links.validator service.
   *
   * @var \Drupal\uc_cart_links\CartLinksValidatorInterface
   */
  protected $cartLinksValidator;

  /**
   * Form constructor.
   *
   * @param \Drupal\uc_cart_links\CartLinksValidatorInterface $cart_links_validator
   *   The uc_cart_links.validator service.
   */
  public function __construct(CartLinksValidatorInterface $cart_links_validator) {
    $this->cartLinksValidator = $cart_links_validator;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('uc_cart_links.validator'));
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $cart_links_config = $this
      ->config('uc_cart_links.settings');
    $form['uc_cart_links_add_show'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Display the Cart Link product action when you add a product to your cart.'),
      '#default_value' => $cart_links_config
        ->get('add_show'),
    ];
    $form['uc_cart_links_track'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Track clicks through Cart Links that specify tracking IDs.'),
      '#default_value' => $cart_links_config
        ->get('track'),
    ];
    $form['uc_cart_links_empty'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Allow Cart Links to empty customer carts.'),
      '#default_value' => $cart_links_config
        ->get('empty'),
    ];
    $form['uc_cart_links_messages'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Cart Links messages'),
      '#description' => $this
        ->t('Enter messages available to the Cart Links API for display through a link. Separate messages with a line break. Each message should have a numeric key and text value, separated by "|". For example: 1337|Message text.'),
      '#default_value' => $cart_links_config
        ->get('messages'),
    ];
    $form['uc_cart_links_restrictions'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Cart Links restrictions'),
      '#description' => $this
        ->t('To restrict what Cart Links may be used on your site, enter all valid Cart Links in this textbox.  Separate links with a line break. Leave blank to permit any Cart Link.'),
      '#default_value' => $cart_links_config
        ->get('restrictions'),
    ];
    $form['uc_cart_links_invalid_page'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Invalid link redirect page'),
      '#description' => $this
        ->t('Enter the URL to redirect to when an invalid Cart Link is used.'),
      '#default_value' => $cart_links_config
        ->get('invalid_page'),
      '#size' => 32,
      '#field_prefix' => Url::fromRoute('<front>', [], [
        'absolute' => TRUE,
      ])
        ->toString(),
    ];
    return parent::buildForm($form, $form_state);
  }

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

    // Check for properly formatted Cart Links in the restrictions textarea.
    $restrictions = trim($form_state
      ->getValue('uc_cart_links_restrictions'));
    if (!empty($restrictions)) {
      $data = array_map('trim', explode("\n", $restrictions));
      foreach ($data as $restriction) {

        // Ignore blank lines.
        if (preg_match('/^\\s*$/', $restriction)) {
          continue;
        }
        elseif (!$this->cartLinksValidator
          ->isValidSyntax('/cart/add/' . $restriction)) {
          $form_state
            ->setErrorByName('uc_cart_links_restrictions', $this
            ->t('Invalid syntax in Cart Links restriction "%restriction".', [
            '%restriction' => $restriction,
          ]));
        }
      }
    }

    // Check for properly formatted messages.
    $messages = trim($form_state
      ->getValue('uc_cart_links_messages'));
    if (!empty($messages)) {
      $data = array_map('trim', explode("\n", $messages));
      foreach ($data as $message) {

        // Ignore blank lines.
        if (preg_match('/^\\s*$/', $message)) {
          continue;
        }
        elseif (!preg_match('/^\\s*[1-9][0-9]*\\s*\\|\\s*\\S+.*$/', $message)) {
          $form_state
            ->setErrorByName('uc_cart_links_messages', $this
            ->t('Invalid Cart Links message "%message". Messages must be a numeric key followed by "|" followed by a value.', [
            '%message' => $message,
          ]));
          break;
        }
      }
    }
    return parent::validateForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $cart_links_config = $this
      ->config('uc_cart_links.settings');
    $cart_links_config
      ->setData([
      'add_show' => (bool) $form_state
        ->getValue('uc_cart_links_add_show'),
      'track' => (bool) $form_state
        ->getValue('uc_cart_links_track'),
      'empty' => (bool) $form_state
        ->getValue('uc_cart_links_empty'),
      'messages' => (string) $form_state
        ->getValue('uc_cart_links_messages'),
      'restrictions' => (string) $form_state
        ->getValue('uc_cart_links_restrictions'),
      'invalid_page' => (string) $form_state
        ->getValue('uc_cart_links_invalid_page'),
    ])
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
CartLinksSettingsForm::$cartLinksValidator protected property The uc_cart_links.validator service.
CartLinksSettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
CartLinksSettingsForm::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create
CartLinksSettingsForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
CartLinksSettingsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
CartLinksSettingsForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
CartLinksSettingsForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
CartLinksSettingsForm::__construct public function Form 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.