class ProfileSelect in Commerce Core 8.2
Provides a form element for selecting a customer profile.
$form['billing_profile'] = [
'#type' => 'commerce_profile_select',
'#default_value' => $profile,
'#available_countries' => [
'US',
'FR',
],
];
To access the profile in validation or submission callbacks, use $form['billing_profile']['#profile']. Due to Drupal core limitations the profile can't be accessed via $form_state->getValue('billing_profile').
Plugin annotation
@RenderElement("commerce_profile_select");
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
- class \Drupal\commerce_order\Element\ProfileSelect uses CommerceElementTrait
- class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of ProfileSelect
Deprecated
Use the customer_profile or content_entity inline forms instead.
Usage example:
See also
https://www.drupal.org/node/3015309
File
- modules/
order/ src/ Element/ ProfileSelect.php, line 30
Namespace
Drupal\commerce_order\ElementView source
class ProfileSelect extends RenderElement {
use CommerceElementTrait;
/**
* {@inheritdoc}
*/
public function getInfo() {
$class = get_class($this);
return [
// A list of country codes. If empty, all countries will be available.
'#available_countries' => [],
// The profile entity operated on. Required.
'#default_value' => NULL,
'#process' => [
[
$class,
'attachElementSubmit',
],
[
$class,
'processForm',
],
],
'#element_validate' => [
[
$class,
'validateElementSubmit',
],
],
'#theme_wrappers' => [
'container',
],
];
}
/**
* Builds the element form.
*
* @param array $element
* The form element being processed.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The current state of the form.
* @param array $complete_form
* The complete form structure.
*
* @throws \InvalidArgumentException
* Thrown when #default_value is empty or not an entity, or when
* #available_countries is not an array of country codes.
*
* @return array
* The processed form element.
*/
public static function processForm(array $element, FormStateInterface $form_state, array &$complete_form) {
if (empty($element['#default_value'])) {
throw new \InvalidArgumentException('The commerce_profile_select element requires the #default_value property.');
}
elseif (isset($element['#default_value']) && !$element['#default_value'] instanceof ProfileInterface) {
throw new \InvalidArgumentException('The commerce_profile_select #default_value property must be a profile entity.');
}
if (!is_array($element['#available_countries'])) {
throw new \InvalidArgumentException('The commerce_profile_select #available_countries property must be an array.');
}
/** @var \Drupal\commerce\InlineFormManager $inline_form_manager */
$inline_form_manager = \Drupal::service('plugin.manager.commerce_inline_form');
// The customer_profile inline form provides an address book widget
// which can be buggy when used inside a form element.
// That's why the content_entity inline form is used instead.
$inline_form = $inline_form_manager
->createInstance('content_entity', [], $element['#default_value']);
$element['#inline_form'] = $inline_form;
$element = $inline_form
->buildInlineForm($element, $form_state);
// Customize the address widget.
if (!empty($element['address']['widget'][0])) {
$address_widget['#type'] = 'container';
if (!empty($element['#available_countries'])) {
$address_widget['address']['#available_countries'] = $element['#available_countries'];
}
}
// The updateProfile() callback needs to run after the inline form ones.
$element['#element_validate'][] = [
get_called_class(),
'updateProfile',
];
$element['#commerce_element_submit'][] = [
get_called_class(),
'updateProfile',
];
return $element;
}
/**
* Updates $element['#profile'] with the inline form's entity.
*
* @param array $element
* The form element.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The current state of the form.
*/
public static function updateProfile(array &$element, FormStateInterface $form_state) {
/** @var \Drupal\commerce\Plugin\Commerce\InlineForm\EntityInlineFormInterface $inline_form */
$inline_form = $element['#inline_form'];
$element['#profile'] = $inline_form
->getEntity();
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
CommerceElementTrait:: |
public static | function | Attaches the #commerce_element_submit functionality. | |
CommerceElementTrait:: |
protected static | function | Calls the #commerce_element_submit callbacks recursively. | |
CommerceElementTrait:: |
public static | function | Submits elements by calling their #commerce_element_submit callbacks. | |
CommerceElementTrait:: |
protected static | function | Checks whether #commerce_element_submit callbacks should be executed. | |
CommerceElementTrait:: |
public static | function | Confirms that #commerce_element_submit handlers can be run. | |
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginBase:: |
public | function | Constructs a \Drupal\Component\Plugin\PluginBase object. | 92 |
ProfileSelect:: |
public | function |
Returns the element properties for this element. Overrides ElementInterface:: |
|
ProfileSelect:: |
public static | function | Builds the element form. | |
ProfileSelect:: |
public static | function | Updates $element['#profile'] with the inline form's entity. | |
RenderElement:: |
public static | function | Adds Ajax information about an element to communicate with JavaScript. | |
RenderElement:: |
public static | function | Adds members of this group as actual elements for rendering. | |
RenderElement:: |
public static | function | Form element processing handler for the #ajax form property. | 1 |
RenderElement:: |
public static | function | Arranges elements into groups. | |
RenderElement:: |
public static | function |
Sets a form element's class attribute. Overrides ElementInterface:: |
|
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |