class CountryItem in Country 8

Same name in this branch

8 src/Plugin/views/filter/CountryItem.php \Drupal\country\Plugin\views\filter\CountryItem
8 src/Plugin/views/sort/CountryItem.php \Drupal\country\Plugin\views\sort\CountryItem
8 src/Plugin/Field/FieldType/CountryItem.php \Drupal\country\Plugin\Field\FieldType\CountryItem

Plugin implementation of the 'country' field type.

Plugin annotation


@FieldType(
  id = "country",
  label = @Translation("Country"),
  description = @Translation("Stores the ISO-2 name of a country."),
  default_widget = "country_default",
  default_formatter = "country_default"
)

Hierarchy

class \Drupal\Core\TypedData\TypedData implements PluginInspectionInterface, TypedDataInterface uses DependencySerializationTrait, StringTranslationTrait, TypedDataTrait
- class \Drupal\Core\TypedData\Plugin\DataType\Map implements \Drupal\Core\TypedData\Plugin\DataType\IteratorAggregate, ComplexDataInterface
  - class \Drupal\Core\Field\FieldItemBase implements FieldItemInterface
    class \Drupal\country\Plugin\Field\FieldType\CountryItem implements OptionsProviderInterface

Expanded class hierarchy of CountryItem

File

src/Plugin/Field/FieldType/CountryItem.php, line 24

Namespace

Drupal\country\Plugin\Field\FieldType

View source

class CountryItem extends FieldItemBase implements OptionsProviderInterface {
  const COUNTRY_ISO_MAXLENGTH = 2;

  /**
   * {@inheritdoc}
   */
  public static function propertyDefinitions(FieldStorageDefinitionInterface $field_definition) {
    $properties['value'] = DataDefinition::create('string')
      ->setLabel(t('Country'));
    return $properties;
  }

  /**
   * {@inheritdoc}
   */
  public static function schema(FieldStorageDefinitionInterface $field_definition) {
    return [
      'columns' => [
        'value' => [
          'type' => 'char',
          'length' => static::COUNTRY_ISO_MAXLENGTH,
          'not null' => FALSE,
        ],
      ],
      'indexes' => [
        'value' => [
          'value',
        ],
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function isEmpty() {
    $value = $this
      ->get('value')
      ->getValue();
    return $value === NULL || $value === '';
  }

  /**
   * {@inheritdoc}
   */
  public function getConstraints() {
    $constraint_manager = \Drupal::typedDataManager()
      ->getValidationConstraintManager();
    $constraints = parent::getConstraints();
    $constraints[] = $constraint_manager
      ->create('ComplexData', [
      'value' => [
        'Length' => [
          'max' => static::COUNTRY_ISO_MAXLENGTH,
          'maxMessage' => t('%name: the country iso-2 code may not be longer than @max characters.', [
            '%name' => $this
              ->getFieldDefinition()
              ->getLabel(),
            '@max' => static::COUNTRY_ISO_MAXLENGTH,
          ]),
        ],
      ],
    ]);
    return $constraints;
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultStorageSettings() {
    return [
      'selectable_countries' => [],
    ] + parent::defaultStorageSettings();
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultFieldSettings() {
    return [
      'selectable_countries' => [],
    ] + parent::defaultFieldSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function storageSettingsForm(array &$form, FormStateInterface $form_state, $has_data) {
    $element = [];

    // We need the field-level 'selectable_countries' setting, and
    // $this->getSettings() will only provide the instance-level one, so we
    // need to explicitly fetch the field.
    $settings = $this
      ->getFieldDefinition()
      ->getFieldStorageDefinition()
      ->getSettings();
    static::defaultCountriesForm($element, $settings);
    $element['selectable_countries']['#description'] = t('If no countries are selected, all of them will be available for this field.');
    return $element;
  }

  /**
   * Builds the selectable_countries element.
   *
   * @param array $element
   *   The form associative array passed by reference.
   * @param array $settings
   *   The field settings array.
   */
  protected function defaultCountriesForm(array &$element, array $settings) {
    $element['selectable_countries'] = [
      '#type' => 'select',
      '#title' => t('Selectable countries'),
      '#default_value' => $settings['selectable_countries'],
      '#options' => $this
        ->getPossibleOptions(),
      '#description' => t('Select all countries you want to make available for this field.'),
      '#multiple' => TRUE,
      '#size' => 10,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public static function generateSampleValue(FieldDefinitionInterface $field_definition) {
    $countries = array_keys(\Drupal::service('country.field.manager')
      ->getSelectableCountries($field_definition));
    return [
      'value' => $countries[array_rand($countries)],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getPossibleOptions(AccountInterface $account = NULL) {
    $select_options = \Drupal::service('country_manager')
      ->getList();
    asort($select_options);
    return $select_options;
  }

  /**
   * {@inheritdoc}
   */
  public function getPossibleValues(AccountInterface $account = NULL) {
    $options = $this
      ->getPossibleOptions($account);
    return array_keys($options);
  }

  /**
   * {@inheritdoc}
   */
  public function getSettableOptions(AccountInterface $account = NULL) {
    $settings = $this
      ->getFieldDefinition()
      ->getFieldStorageDefinition()
      ->getSettings();
    $selectable = array_keys($settings['selectable_countries']);
    $countries = \Drupal::service('country_manager')
      ->getList();
    if (!empty($selectable)) {
      $countries = array_filter($countries, function ($key) use ($selectable) {
        return in_array($key, $selectable);
      }, ARRAY_FILTER_USE_KEY);
    }
    return $countries;
  }

  /**
   * {@inheritdoc}
   */
  public function getSettableValues(AccountInterface $account = NULL) {
    $options = $this
      ->getSettableOptions($account);
    return array_keys($options);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CountryItem::COUNTRY_ISO_MAXLENGTH		constant
CountryItem::defaultCountriesForm	protected	function	Builds the selectable_countries element.
CountryItem::defaultFieldSettings	public static	function	Defines the field-level settings for this plugin. Overrides FieldItemBase::defaultFieldSettings
CountryItem::defaultStorageSettings	public static	function	Defines the storage-level settings for this plugin. Overrides FieldItemBase::defaultStorageSettings
CountryItem::generateSampleValue	public static	function	Generates placeholder field values. Overrides FieldItemBase::generateSampleValue
CountryItem::getConstraints	public	function	Gets a list of validation constraints. Overrides TypedData::getConstraints
CountryItem::getPossibleOptions	public	function	Returns an array of possible values with labels for display. Overrides OptionsProviderInterface::getPossibleOptions
CountryItem::getPossibleValues	public	function	Returns an array of possible values. Overrides OptionsProviderInterface::getPossibleValues
CountryItem::getSettableOptions	public	function	Returns an array of settable values with labels for display. Overrides OptionsProviderInterface::getSettableOptions
CountryItem::getSettableValues	public	function	Returns an array of settable values. Overrides OptionsProviderInterface::getSettableValues
CountryItem::isEmpty	public	function	Determines whether the data structure is empty. Overrides Map::isEmpty
CountryItem::propertyDefinitions	public static	function	Defines field item properties. Overrides FieldItemInterface::propertyDefinitions
CountryItem::schema	public static	function	Returns the schema for the field. Overrides FieldItemInterface::schema
CountryItem::storageSettingsForm	public	function	Returns a form for the storage-level settings. Overrides FieldItemBase::storageSettingsForm
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
FieldItemBase::calculateDependencies	public static	function	Calculates dependencies for field items. Overrides FieldItemInterface::calculateDependencies	2
FieldItemBase::calculateStorageDependencies	public static	function	Calculates dependencies for field items on the storage level. Overrides FieldItemInterface::calculateStorageDependencies	1
FieldItemBase::delete	public	function	Defines custom delete behavior for field values. Overrides FieldItemInterface::delete	2
FieldItemBase::deleteRevision	public	function	Defines custom revision delete behavior for field values. Overrides FieldItemInterface::deleteRevision
FieldItemBase::fieldSettingsForm	public	function	Returns a form for the field-level settings. Overrides FieldItemInterface::fieldSettingsForm	7
FieldItemBase::fieldSettingsFromConfigData	public static	function	Returns a settings array in the field type's canonical representation. Overrides FieldItemInterface::fieldSettingsFromConfigData	1
FieldItemBase::fieldSettingsToConfigData	public static	function	Returns a settings array that can be stored as a configuration value. Overrides FieldItemInterface::fieldSettingsToConfigData	1
FieldItemBase::getEntity	public	function	Gets the entity that field belongs to. Overrides FieldItemInterface::getEntity
FieldItemBase::getFieldDefinition	public	function	Gets the field definition. Overrides FieldItemInterface::getFieldDefinition
FieldItemBase::getLangcode	public	function	Gets the langcode of the field values held in the object. Overrides FieldItemInterface::getLangcode
FieldItemBase::getSetting	protected	function	Returns the value of a field setting.
FieldItemBase::getSettings	protected	function	Returns the array of field settings.
FieldItemBase::mainPropertyName	public static	function	Returns the name of the main property, if any. Overrides FieldItemInterface::mainPropertyName	8
FieldItemBase::onDependencyRemoval	public static	function	Informs the plugin that a dependency of the field will be deleted. Overrides FieldItemInterface::onDependencyRemoval	1
FieldItemBase::postSave	public	function	Defines custom post-save behavior for field values. Overrides FieldItemInterface::postSave	2
FieldItemBase::preSave	public	function	Defines custom presave behavior for field values. Overrides FieldItemInterface::preSave	7
FieldItemBase::setValue	public	function	Sets the data value. Overrides Map::setValue	4
FieldItemBase::storageSettingsFromConfigData	public static	function	Returns a settings array in the field type's canonical representation. Overrides FieldItemInterface::storageSettingsFromConfigData	2
FieldItemBase::storageSettingsToConfigData	public static	function	Returns a settings array that can be stored as a configuration value. Overrides FieldItemInterface::storageSettingsToConfigData	2
FieldItemBase::view	public	function	Returns a renderable array for a single field item. Overrides FieldItemInterface::view
FieldItemBase::writePropertyValue	protected	function	Different to the parent Map class, we avoid creating property objects as far as possible in order to optimize performance. Thus we just update $this->values if no property object has been created yet. Overrides Map::writePropertyValue
FieldItemBase::__construct	public	function	Constructs a TypedData object given its definition and context. Overrides TypedData::__construct	1
FieldItemBase::__get	public	function	Magic method: Gets a property value. Overrides FieldItemInterface::__get	2
FieldItemBase::__isset	public	function	Magic method: Determines whether a property is set. Overrides FieldItemInterface::__isset
FieldItemBase::__set	public	function	Magic method: Sets a property value. Overrides FieldItemInterface::__set	1
FieldItemBase::__unset	public	function	Magic method: Unsets a property. Overrides FieldItemInterface::__unset
Map::$definition	protected	property	The data definition. Overrides TypedData::$definition
Map::$properties	protected	property	The array of properties.
Map::$values	protected	property	An array of values for the contained properties.
Map::applyDefaultValue	public	function	Applies the default value. Overrides TypedData::applyDefaultValue	4
Map::get	public	function	Gets a property object. Overrides ComplexDataInterface::get
Map::getIterator	public	function
Map::getProperties	public	function	Gets an array of property objects. Overrides ComplexDataInterface::getProperties
Map::getString	public	function	Returns a string representation of the data. Overrides TypedData::getString
Map::getValue	public	function	Gets the data value. Overrides TypedData::getValue	1
Map::onChange	public	function	Overrides TraversableTypedDataInterface::onChange	4
Map::set	public	function	Sets a property value. Overrides ComplexDataInterface::set
Map::toArray	public	function	Returns an array of all property values. Overrides ComplexDataInterface::toArray	1
Map::__clone	public	function	Magic method: Implements a deep clone.
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.
TypedData::$name	protected	property	The property name.
TypedData::$parent	protected	property	The parent typed data object.
TypedData::createInstance	public static	function	Constructs a TypedData object given its definition and context. Overrides TypedDataInterface::createInstance
TypedData::getDataDefinition	public	function	Gets the data definition. Overrides TypedDataInterface::getDataDefinition
TypedData::getName	public	function	Returns the name of a property or item. Overrides TypedDataInterface::getName
TypedData::getParent	public	function	Returns the parent data structure; i.e. either complex data or a list. Overrides TypedDataInterface::getParent
TypedData::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
TypedData::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
TypedData::getPropertyPath	public	function	Returns the property path of the data. Overrides TypedDataInterface::getPropertyPath
TypedData::getRoot	public	function	Returns the root of the typed data tree. Overrides TypedDataInterface::getRoot
TypedData::setContext	public	function	Sets the context of a property or item via a context aware parent. Overrides TypedDataInterface::setContext
TypedData::validate	public	function	Validates the currently set data value. Overrides TypedDataInterface::validate
TypedDataTrait::$typedDataManager	protected	property	The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager	public	function	Gets the typed data manager.	2
TypedDataTrait::setTypedDataManager	public	function	Sets the typed data manager.	2

You are here

class CountryItem in Country 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation