abstract class ObjectAttributesFormBase in Ubercart 8.4

Defines the class/product attributes overview form.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\uc_attribute\Form\ObjectAttributesFormBase

Expanded class hierarchy of ObjectAttributesFormBase

File

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

Namespace

Drupal\uc_attribute\Form

View source

abstract class ObjectAttributesFormBase 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_form';
  }

  /**
   * Constructs Attributes 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) {
    $form['attributes'] = [
      '#type' => 'table',
      '#header' => [
        $this
          ->t('Remove'),
        $this
          ->t('Name'),
        $this
          ->t('Label'),
        $this
          ->t('Default'),
        $this
          ->t('Required'),
        $this
          ->t('List position'),
        $this
          ->t('Display'),
      ],
      '#empty' => $this
        ->t('No attributes available.'),
      '#tabledrag' => [
        [
          'action' => 'order',
          'relationship' => 'sibling',
          'group' => 'uc-attribute-table-ordering',
        ],
      ],
    ];
    foreach ($this->attributes as $aid => $attribute) {
      $option = isset($attribute->options[$attribute->default_option]) ? $attribute->options[$attribute->default_option] : NULL;
      $form['attributes'][$aid]['#attributes']['class'][] = 'draggable';
      $form['attributes'][$aid]['remove'] = [
        '#type' => 'checkbox',
        '#title' => $this
          ->t('Remove'),
        '#title_display' => 'invisible',
      ];
      $form['attributes'][$aid]['name'] = [
        '#markup' => $attribute->name,
      ];
      $form['attributes'][$aid]['label'] = [
        '#type' => 'textfield',
        '#title' => $this
          ->t('Label'),
        '#title_display' => 'invisible',
        '#default_value' => empty($attribute->label) ? $attribute->name : $attribute->label,
        '#size' => 20,
        '#maxlength' => 255,
      ];
      $form['attributes'][$aid]['option'] = [
        '#markup' => $option ? $option->name . ' (' . uc_currency_format($option->price) . ')' : $this
          ->t('n/a'),
      ];
      $form['attributes'][$aid]['required'] = [
        '#type' => 'checkbox',
        '#title' => $this
          ->t('Required'),
        '#title_display' => 'invisible',
        '#default_value' => $attribute->required,
      ];
      $form['attributes'][$aid]['ordering'] = [
        '#type' => 'weight',
        '#title' => $this
          ->t('List position'),
        '#title_display' => 'invisible',
        '#default_value' => $attribute->ordering,
        '#attributes' => [
          'class' => [
            'uc-attribute-table-ordering',
          ],
        ],
      ];
      $form['attributes'][$aid]['display'] = [
        '#type' => 'select',
        '#title' => $this
          ->t('Display'),
        '#title_display' => 'invisible',
        '#default_value' => $attribute->display,
        '#options' => _uc_attribute_display_types(),
      ];
    }
    $form['actions'] = [
      '#type' => 'actions',
    ];
    $form['actions']['save'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Save changes'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $changed = FALSE;
    foreach ($form_state
      ->getValue('attributes') as $aid => $attribute) {
      if ($attribute['remove']) {
        $remove_aids[] = $aid;
      }
      else {
        unset($attribute['remove']);
        \Drupal::database()
          ->merge($this->attributeTable)
          ->key('aid', $aid)
          ->fields($attribute)
          ->execute();
        $changed = TRUE;
      }
    }
    if (isset($remove_aids)) {
      $select = \Drupal::database()
        ->select('uc_attribute_options', 'ao')
        ->fields('ao', [
        'oid',
      ])
        ->condition('ao.aid', $remove_aids, 'IN');
      \Drupal::database()
        ->delete($this->optionTable)
        ->condition('oid', $select, 'IN')
        ->condition($this->idField, $this->idValue)
        ->execute();
      \Drupal::database()
        ->delete($this->attributeTable)
        ->condition($this->idField, $this->idValue)
        ->condition('aid', $remove_aids, 'IN')
        ->execute();
      $this
        ->attributesRemoved();
      $this
        ->messenger()
        ->addMessage($this
        ->formatPlural(count($remove_aids), '1 attribute has been removed.', '@count attributes have been removed.'));
    }
    if ($changed) {
      $this
        ->messenger()
        ->addMessage($this
        ->t('The changes have been saved.'));
    }
  }

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

}

Members

Name	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.
ObjectAttributesFormBase::$attributes	protected	property	The attributes.
ObjectAttributesFormBase::$attributeTable	protected	property	The attribute table that this form will write to.
ObjectAttributesFormBase::$idField	protected	property	The identifier field that this form will use.
ObjectAttributesFormBase::$idValue	protected	property	The identifier value that this form will use.
ObjectAttributesFormBase::$optionTable	protected	property	The option table that this form will write to.
ObjectAttributesFormBase::attributesRemoved	protected	function	Called when submission of this form caused attributes to be removed.	1
ObjectAttributesFormBase::buildBaseForm	protected	function	Constructs Attributes Form array on behalf of subclasses.
ObjectAttributesFormBase::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
ObjectAttributesFormBase::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
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

abstract class ObjectAttributesFormBase in Ubercart 8.4

Hierarchy

File

Namespace

Members

API Navigation