You are here

Home » API reference » Ubercart 8.4 » ObjectAttributesAddFormBase.php

abstract class ObjectAttributesAddFormBase in Ubercart 8.4

Defines the class/product attributes add form.

Hierarchy

Expanded class hierarchy of ObjectAttributesAddFormBase

File

uc_attribute/src/Form/ObjectAttributesAddFormBase.php, line 11

Namespace

Drupal\uc_attribute\Form
View source 
abstract class ObjectAttributesAddFormBase extends FormBase {

  /**
   * The attributes.
   *
   * @var array
   */
  protected $attributes = [];

  /**
   * The attribute table that this form will write to.
   *
   * @var string
   */
  protected $attributeTable;

  /**
   * The option table that this form will write to.
   *
   * @var string
   */
  protected $optionTable;

  /**
   * The identifier field that this form will use.
   *
   * @var string
   */
  protected $idField;

  /**
   * The identifier value that this form will use.
   *
   * @var string
   */
  protected $idValue;

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

  /**
   * Constructs Attributes Add Form array on behalf of subclasses.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   *
   * @return array
   *   The form structure.
   */
  protected function buildBaseForm(array $form, FormStateInterface $form_state) {
    $used_aids = [];
    foreach ($this->attributes as $attribute) {
      $used_aids[] = $attribute->aid;
    }
    $unused_attributes = [];
    $result = \Drupal::database()
      ->query("SELECT a.aid, a.name, a.label FROM {uc_attributes} a LEFT JOIN {uc_attribute_options} ao ON a.aid = ao.aid GROUP BY a.aid, a.name, a.label ORDER BY a.name");
    foreach ($result as $attribute) {
      if (!in_array($attribute->aid, $used_aids)) {
        $unused_attributes[$attribute->aid] = $attribute->name;
      }
    }
    $form['add_attributes'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Attributes'),
      '#options' => $unused_attributes ?: [
        $this
          ->t('No attributes left to add.'),
      ],
      '#disabled' => empty($unused_attributes),
    ];
    $form['actions'] = [
      '#type' => 'actions',
    ];
    $form['actions']['add'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Add attributes'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    foreach (array_filter($form_state
      ->getValue('add_attributes')) as $aid) {

      // Enable all options for added attributes.
      $attribute = uc_attribute_load($aid);
      $oid = 0;
      if (isset($attribute->options)) {
        foreach ($attribute->options as $option) {
          $option->{$this->idField} = $this->idValue;
          unset($option->name);
          unset($option->aid);
          \Drupal::database()
            ->insert($this->optionTable)
            ->fields((array) $option)
            ->execute();
        }

        // Make the first option (if any) the default.
        if ($option = reset($attribute->options)) {
          $oid = $option->oid;
        }
      }
      $select = \Drupal::database()
        ->select('uc_attributes', 'a')
        ->condition('aid', $aid);
      $select
        ->addExpression(':id', $this->idField, [
        ':id' => $this->idValue,
      ]);
      $select
        ->addField('a', 'aid');
      $select
        ->addField('a', 'label');
      $select
        ->addField('a', 'ordering');
      $select
        ->addExpression(':oid', 'default_option', [
        ':oid' => $oid,
      ]);
      $select
        ->addField('a', 'required');
      $select
        ->addField('a', 'display');
      \Drupal::database()
        ->insert($this->attributeTable)
        ->from($select)
        ->execute();
    }
    $num = count(array_filter($form_state
      ->getValue('add_attributes')));
    if ($num > 0) {
      $this
        ->attributesAdded();
      $this
        ->messenger()
        ->addMessage($this
        ->formatPlural($num, '1 attribute has been added.', '@count attributes have been added.'));
    }
  }

  /**
   * Called when submission of this form caused attributes to be added.
   */
  protected function attributesAdded() {
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 62
FormInterface::buildForm public function Form constructor. 179
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.
ObjectAttributesAddFormBase::$attributes protected property The attributes.
ObjectAttributesAddFormBase::$attributeTable protected property The attribute table that this form will write to.
ObjectAttributesAddFormBase::$idField protected property The identifier field that this form will use.
ObjectAttributesAddFormBase::$idValue protected property The identifier value that this form will use.
ObjectAttributesAddFormBase::$optionTable protected property The option table that this form will write to.
ObjectAttributesAddFormBase::attributesAdded protected function Called when submission of this form caused attributes to be added. 1
ObjectAttributesAddFormBase::buildBaseForm protected function Constructs Attributes Add Form array on behalf of subclasses.
ObjectAttributesAddFormBase::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
ObjectAttributesAddFormBase::submitForm public function Form submission handler. Overrides FormInterface::submitForm 2
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.