class CountryStateCityWidget in Country, State and City Fields 8

Plugin implementation of the 'country_state_city_widget' widget.

Plugin annotation


@FieldWidget(
  id = "country_state_city_widget",
  label = @Translation("Country state city widget"),
  field_types = {
    "country_state_city_type"
  }
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
    class \Drupal\Core\Field\WidgetBase implements WidgetInterface, ContainerFactoryPluginInterface uses AllowedTagsXssTrait
    class \Drupal\country_state_city\Plugin\Field\FieldWidget\CountryStateCityWidget implements ContainerFactoryPluginInterface

Expanded class hierarchy of CountryStateCityWidget

File

src/Plugin/Field/FieldWidget/CountryStateCityWidget.php, line 24

Namespace

Drupal\country_state_city\Plugin\Field\FieldWidget

View source

class CountryStateCityWidget extends WidgetBase implements ContainerFactoryPluginInterface {

  /**
   * File storage for files.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Construct a MyFormatter object.
   *
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
   *   Defines an interface for entity field definitions.
   * @param array $settings
   *   The formatter settings.
   * @param array $third_party_settings
   *   Any third party settings.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entityTypeManager
   *   Entity type manager service.
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, array $third_party_settings, EntityTypeManagerInterface $entityTypeManager) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $third_party_settings);
    $this->entityTypeManager = $entityTypeManager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($plugin_id, $plugin_definition, $configuration['field_definition'], $configuration['settings'], $configuration['third_party_settings'], $container
      ->get('entity_type.manager'));
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [] + parent::defaultSettings();
  }

  /**
   * Gets the initial values for the widget.
   *
   * This is a replacement for the disabled default values functionality.
   *
   * @return array
   *   The initial values, keyed by property.
   */
  protected function getInitialValues() {
    $initial_values = [
      'country' => '',
      'state' => '',
      'city' => '',
    ];
    return $initial_values;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $elements = [];
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function getStates($country_id) {
    if ($country_id) {
      $query = $this->entityTypeManager
        ->getStorage('statelist')
        ->getQuery()
        ->condition('country_id', $country_id)
        ->sort('name', 'asc');
      $ids = $query
        ->execute();
      $states = [];
      if (count($ids) == 1) {
        $result = $this->entityTypeManager
          ->getStorage('statelist')
          ->load(key($ids));
        $states[$result
          ->id()] = $result
          ->getName();
      }
      elseif (count($ids) > 1) {
        $results = $this->entityTypeManager
          ->getStorage('statelist')
          ->loadMultiple($ids);
        foreach ($results as $result) {
          $states[$result
            ->id()] = $result
            ->getName();
        }
      }
      return $states;
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getCities($state_id) {
    if ($state_id) {
      $query = $this->entityTypeManager
        ->getStorage('citylist')
        ->getQuery()
        ->condition('state_id', $state_id, '=')
        ->sort('name', 'asc');
      $ids = $query
        ->execute();
      $cities = [];
      if (count($ids) == 1) {
        $result = $this->entityTypeManager
          ->getStorage('citylist')
          ->load(key($ids));
        $cities[$result
          ->id()] = $result
          ->getName();
      }
      elseif (count($ids) > 1) {
        $results = $this->entityTypeManager
          ->getStorage('citylist')
          ->loadMultiple($ids);
        foreach ($results as $result) {
          $cities[$result
            ->id()] = $result
            ->getName();
        }
      }
      return $cities;
    }
  }

  /**
   * {@inheritdoc}
   */
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
    $item = $items[$delta];
    $value = $item
      ->getEntity()
      ->isNew() ? $this
      ->getInitialValues() : $item
      ->toArray();
    $field_name = $this->fieldDefinition
      ->getName();
    if (isset($form_state
      ->getUserInput()[$field_name][$delta])) {
      $country_id = $form_state
        ->getUserInput()[$field_name][$delta]['country'];
      $state_id = $form_state
        ->getUserInput()[$field_name][$delta]['state'];
      $city_id = $form_state
        ->getUserInput()[$field_name][$delta]['city'];
    }
    $country_id = $country_id ?? $value['country'] ?? NULL;
    $state_id = $state_id ?? $value['state'] ?? NULL;
    $city_id = $city_id ?? $value['city'] ?? NULL;
    $query = $this->entityTypeManager
      ->getStorage('countrylist')
      ->getQuery()
      ->sort('name', 'asc');
    $ids = $query
      ->execute();
    $countries = [];
    if (count($ids) == 1) {
      $result = $this->entityTypeManager
        ->getStorage('countrylist')
        ->load(key($ids));
      $countries[$result
        ->id()] = $result
        ->getName();
    }
    elseif (count($ids) > 1) {
      $results = $this->entityTypeManager
        ->getStorage('countrylist')
        ->loadMultiple($ids);
      foreach ($results as $result) {
        $countries[$result
          ->id()] = $result
          ->getName();
      }
    }
    $div_id = 'state-wrapper-' . $field_name . '-' . $delta;
    if ($this->fieldDefinition
      ->getFieldStorageDefinition()
      ->getCardinality() == 1) {
      $element += [
        '#type' => 'fieldset',
        '#attributes' => [
          'id' => $div_id,
        ],
      ];
    }
    $element['#attached']['library'][] = 'country_state_city/country_state_city.search_option';
    $element['country'] = [
      '#type' => 'select',
      '#options' => $countries,
      '#default_value' => $country_id,
      '#empty_option' => $this
        ->t('-- Select an option --'),
      '#required' => $this->fieldDefinition
        ->isRequired(),
      '#title' => !empty($this
        ->getFieldSetting('country_lable')) ? $this
        ->getFieldSetting('country_lable') : $this
        ->t('Country'),
      '#delta' => $delta,
      '#validated' => TRUE,
      '#attributes' => [
        'class' => [
          'csc-country-details',
        ],
      ],
      '#ajax' => [
        'callback' => [
          $this,
          'ajaxFillState',
        ],
        'event' => 'change',
        'wrapper' => $div_id,
        'progress' => [
          'type' => 'throbber',
          'message' => $this
            ->t('Searching states...'),
        ],
      ],
    ];
    if ($country_id) {
      $element['state'] = [
        '#type' => 'select',
        '#default_value' => $state_id,
        '#options' => $this
          ->getStates($country_id),
        '#empty_option' => $this
          ->t('-- Select an option --'),
        '#required' => $this->fieldDefinition
          ->isRequired(),
        '#title' => !empty($this
          ->getFieldSetting('state_lable')) ? $this
          ->getFieldSetting('state_lable') : $this
          ->t('State'),
        '#active' => FALSE,
        '#delta' => $delta,
        '#validated' => TRUE,
        '#attributes' => [
          'class' => [
            'csc-state-details',
          ],
        ],
        '#ajax' => [
          'callback' => [
            $this,
            'ajaxFillState',
          ],
          'event' => 'change',
          'wrapper' => $div_id,
          'progress' => [
            'type' => 'throbber',
            'message' => $this
              ->t('Searching cities...'),
          ],
        ],
      ];
    }
    if ($state_id) {
      $element['city'] = [
        '#type' => 'select',
        '#default_value' => $city_id,
        '#options' => $this
          ->getCities($state_id),
        '#empty_option' => $this
          ->t('-- Select an option --'),
        '#required' => $this->fieldDefinition
          ->isRequired(),
        '#title' => !empty($this
          ->getFieldSetting('city_lable')) ? $this
          ->getFieldSetting('city_lable') : $this
          ->t('City'),
        '#validated' => TRUE,
        '#attributes' => [
          'class' => [
            'csc-city-details',
          ],
        ],
      ];
    }
    return $element;
  }

  /**
   * Call the function that consume the webservice.
   *
   * @param array $form
   *   A form that be modified.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The values of the form.
   *
   * @return array
   *   The form modified
   */
  public function ajaxFillState(array $form, FormStateInterface $form_state) {
    $element = $form_state
      ->getTriggeringElement();
    $delta = $element['#delta'];
    $field_name = $this->fieldDefinition
      ->getName();
    $form = $form[$field_name];
    unset($form['widget'][$delta]['_weight']);
    return $form['widget'][$delta];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AllowedTagsXssTrait::allowedTags	public	function	Returns a list of tags allowed by AllowedTagsXssTrait::fieldFilterXss().
AllowedTagsXssTrait::displayAllowedTags	public	function	Returns a human-readable list of allowed tags for display in help texts.
AllowedTagsXssTrait::fieldFilterXss	public	function	Filters an HTML string to prevent XSS vulnerabilities.
CountryStateCityWidget::$entityTypeManager	protected	property	File storage for files.
CountryStateCityWidget::ajaxFillState	public	function	Call the function that consume the webservice.
CountryStateCityWidget::create	public static	function	Creates an instance of the plugin. Overrides WidgetBase::create
CountryStateCityWidget::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
CountryStateCityWidget::formElement	public	function	Returns the form for a single field widget. Overrides WidgetInterface::formElement
CountryStateCityWidget::getCities	public	function
CountryStateCityWidget::getInitialValues	protected	function	Gets the initial values for the widget.
CountryStateCityWidget::getStates	public	function
CountryStateCityWidget::settingsForm	public	function	Returns a form to configure settings for the widget. Overrides WidgetBase::settingsForm
CountryStateCityWidget::settingsSummary	public	function	Returns a short summary for the current widget settings. Overrides WidgetBase::settingsSummary
CountryStateCityWidget::__construct	public	function	Construct a MyFormatter object. Overrides WidgetBase::__construct
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
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginSettingsBase::$defaultSettingsMerged	protected	property	Whether default settings have been merged into the current $settings.
PluginSettingsBase::$thirdPartySettings	protected	property	The plugin settings injected by third party modules.
PluginSettingsBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies	6
PluginSettingsBase::getSetting	public	function	Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings	public	function	Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders	public	function	Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting	public	function	Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings	public	function	Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults	protected	function	Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval	public	function	Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval	3
PluginSettingsBase::setSetting	public	function	Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings	public	function	Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting	public	function	Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting	public	function	Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
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.
WidgetBase::$fieldDefinition	protected	property	The field definition.
WidgetBase::$settings	protected	property	The widget settings. Overrides PluginSettingsBase::$settings
WidgetBase::addMoreAjax	public static	function	Ajax callback for the "Add another item" button.
WidgetBase::addMoreSubmit	public static	function	Submission handler for the "Add another item" button.
WidgetBase::afterBuild	public static	function	After-build handler for field elements in a form.
WidgetBase::errorElement	public	function	Assigns a field-level validation error to the right widget sub-element. Overrides WidgetInterface::errorElement	8
WidgetBase::extractFormValues	public	function	Extracts field values from submitted form values. Overrides WidgetBaseInterface::extractFormValues	2
WidgetBase::flagErrors	public	function	Reports field-level validation errors against actual form elements. Overrides WidgetBaseInterface::flagErrors	2
WidgetBase::form	public	function	Creates a form element for a field. Overrides WidgetBaseInterface::form	3
WidgetBase::formMultipleElements	protected	function	Special handling to create form elements for multiple values.	1
WidgetBase::formSingleElement	protected	function	Generates the form element for a single copy of the widget.
WidgetBase::getFieldSetting	protected	function	Returns the value of a field setting.
WidgetBase::getFieldSettings	protected	function	Returns the array of field settings.
WidgetBase::getFilteredDescription	protected	function	Returns the filtered field description.
WidgetBase::getWidgetState	public static	function	Retrieves processing information about the widget from $form_state. Overrides WidgetBaseInterface::getWidgetState
WidgetBase::getWidgetStateParents	protected static	function	Returns the location of processing information within $form_state.
WidgetBase::handlesMultipleValues	protected	function	Returns whether the widget handles multiple values.
WidgetBase::isApplicable	public static	function	Returns if the widget can be used for the provided field. Overrides WidgetInterface::isApplicable	4
WidgetBase::isDefaultValueWidget	protected	function	Returns whether the widget used for default value form.
WidgetBase::massageFormValues	public	function	Massages the form values into the format expected for field values. Overrides WidgetInterface::massageFormValues	7
WidgetBase::setWidgetState	public static	function	Stores processing information about the widget in $form_state. Overrides WidgetBaseInterface::setWidgetState

You are here

class CountryStateCityWidget in Country, State and City Fields 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation