class WebformOptions in Webform 8.5
Same name in this branch
- 8.5 src/Element/WebformOptions.php \Drupal\webform\Element\WebformOptions
- 8.5 src/Entity/WebformOptions.php \Drupal\webform\Entity\WebformOptions
Same name and namespace in other branches
- 6.x src/Entity/WebformOptions.php \Drupal\webform\Entity\WebformOptions
Defines the webform options entity.
Plugin annotation
@ConfigEntityType(
id = "webform_options",
label = @Translation("Webform options"),
label_collection = @Translation("Webform options"),
label_singular = @Translation("webform options"),
label_plural = @Translation("webform options"),
label_count = @PluralTranslation(
singular = "@count webform options",
plural = "@count webform options",
),
handlers = {
"storage" = "\Drupal\webform\WebformOptionsStorage",
"access" = "Drupal\webform\WebformOptionsAccessControlHandler",
"list_builder" = "Drupal\webform\WebformOptionsListBuilder",
"form" = {
"add" = "Drupal\webform\WebformOptionsForm",
"edit" = "Drupal\webform\WebformOptionsForm",
"duplicate" = "Drupal\webform\WebformOptionsForm",
"delete" = "Drupal\webform\WebformOptionsDeleteForm",
}
},
admin_permission = "administer webform",
entity_keys = {
"id" = "id",
"label" = "label",
},
links = {
"add-form" = "/admin/structure/webform/config/options/manage/add",
"edit-form" = "/admin/structure/webform/config/options/manage/{webform_options}/edit",
"duplicate-form" = "/admin/structure/webform/config/options/manage/{webform_options}/duplicate",
"delete-form" = "/admin/structure/webform/config/options/manage/{webform_options}/delete",
"collection" = "/admin/structure/webform/config/options/manage",
},
config_export = {
"id",
"uuid",
"label",
"category",
"likert",
"options",
}
)
Hierarchy
- class \Drupal\Core\Entity\EntityBase implements EntityInterface uses RefinableCacheableDependencyTrait, DependencySerializationTrait
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses SynchronizableEntityTrait, PluginDependencyTrait
- class \Drupal\webform\Entity\WebformOptions implements WebformOptionsInterface uses StringTranslationTrait
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses SynchronizableEntityTrait, PluginDependencyTrait
Expanded class hierarchy of WebformOptions
14 files declare their use of WebformOptions
- webform.install.update.inc in includes/
webform.install.update.inc - Archived Webform update hooks.
- WebformCompositeBase.php in src/
Plugin/ WebformElement/ WebformCompositeBase.php - WebformElementBase.php in src/
Plugin/ WebformElementBase.php - WebformElementController.php in src/
Controller/ WebformElementController.php - WebformElementOptions.php in src/
Element/ WebformElementOptions.php
File
- src/
Entity/ WebformOptions.php, line 59
Namespace
Drupal\webform\EntityView source
class WebformOptions extends ConfigEntityBase implements WebformOptionsInterface {
use StringTranslationTrait;
/**
* The webform options ID.
*
* @var string
*/
protected $id;
/**
* The webform options UUID.
*
* @var string
*/
protected $uuid;
/**
* The webform options label.
*
* @var string
*/
protected $label;
/**
* The webform options category.
*
* @var string
*/
protected $category;
/**
* Flag to used options as likert answers.
*
* @var bool
*/
protected $likert = FALSE;
/**
* The webform options options.
*
* @var string
*/
protected $options;
/**
* The webform options decoded.
*
* @var string
*/
protected $optionsDecoded;
/**
* {@inheritdoc}
*/
public function isLikert() {
return $this->likert;
}
/**
* {@inheritdoc}
*/
public function set($property_name, $value) {
// Make sure to reset decoded options when options are updated.
if ($property_name === 'options') {
$this->optionsDecoded = NULL;
}
return parent::set($property_name, $value);
}
/**
* {@inheritdoc}
*/
public function getOptions() {
if (!isset($this->optionsDecoded)) {
try {
$options = WebformYaml::decode($this->options);
// Since YAML supports simple values.
$options = is_array($options) ? $options : [];
} catch (\Exception $exception) {
$link = $this
->toLink($this
->t('Edit'), 'edit-form')
->toString();
\Drupal::logger('webform')
->notice('%title options are not valid. @message', [
'%title' => $this
->label(),
'@message' => $exception
->getMessage(),
'link' => $link,
]);
$options = FALSE;
}
$this->optionsDecoded = $options;
}
return $this->optionsDecoded;
}
/**
* {@inheritdoc}
*/
public function setOptions(array $options) {
$this->options = WebformYaml::encode($options);
$this->optionsDecoded = NULL;
return $this;
}
/**
* {@inheritdoc}
*/
public function hasAlterHooks() {
$hook_name = 'webform_options_' . $this
->id() . '_alter';
$alter_hooks = \Drupal::moduleHandler()
->getImplementations($hook_name);
return count($alter_hooks) ? TRUE : FALSE;
}
/**
* {@inheritdoc}
*/
public function preSave(EntityStorageInterface $storage) {
parent::preSave($storage);
// If the submitted options match the altered options clear the submission
// options.
$altered_options = [];
$temp_element = [];
\Drupal::moduleHandler()
->alter('webform_options_' . $this
->id(), $altered_options, $temp_element);
$altered_options = WebformOptionsHelper::convertOptionsToString($altered_options);
if ($altered_options === $this
->getOptions()) {
$this->options = '';
}
}
/**
* {@inheritdoc}
*/
public function postSave(EntityStorageInterface $storage, $update = TRUE) {
parent::postSave($storage, $update);
// Clear cached properties.
$this->optionsDecoded = NULL;
}
/**
* {@inheritdoc}
*/
public static function sort(ConfigEntityInterface $a, ConfigEntityInterface $b) {
$a_label = $a
->get('category') . $a
->label();
$b_label = $b
->get('category') . $b
->label();
return strnatcasecmp($a_label, $b_label);
}
/**
* {@inheritdoc}
*/
public static function getElementOptions(array &$element, $property_name = '#options') {
// If element already has #options array just call alter hook with
// a NULL id.
if (is_array($element[$property_name])) {
$options = $element[$property_name];
\Drupal::moduleHandler()
->alter('webform_options', $options, $element);
return $options;
}
// Return empty options if element does not define an options id.
if (empty($element[$property_name]) || !is_string($element[$property_name])) {
return [];
}
// If options have been set return them.
// This allows dynamic options to be overridden.
$id = $element[$property_name];
if ($webform_options = WebformOptions::load($id)) {
$options = $webform_options
->getOptions() ?: [];
}
else {
$options = [];
}
// Alter options using hook_webform_options_alter()
// and/or hook_webform_options_WEBFORM_OPTIONS_ID_alter() hook.
// @see webform.api.php
\Drupal::moduleHandler()
->alter('webform_options_' . $id, $options, $element);
\Drupal::moduleHandler()
->alter('webform_options', $options, $element, $id);
// Log empty options.
if (empty($options)) {
\Drupal::logger('webform')
->notice('Options %id do not exist.', [
'%id' => $id,
]);
}
return $options;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
CacheableDependencyTrait:: |
protected | property | Cache contexts. | |
CacheableDependencyTrait:: |
protected | property | Cache max-age. | |
CacheableDependencyTrait:: |
protected | property | Cache tags. | |
CacheableDependencyTrait:: |
protected | function | Sets cacheability; useful for value object constructors. | |
ConfigEntityBase:: |
private | property | Whether the config is being deleted by the uninstall process. | |
ConfigEntityBase:: |
protected | property | The language code of the entity's default language. | |
ConfigEntityBase:: |
protected | property | The original ID of the configuration entity. | |
ConfigEntityBase:: |
protected | property | The enabled/disabled status of the configuration entity. | 4 |
ConfigEntityBase:: |
protected | property | Third party entity settings. | |
ConfigEntityBase:: |
protected | property | Trust supplied data and not use configuration schema on save. | |
ConfigEntityBase:: |
protected | property | Information maintained by Drupal core about configuration. | |
ConfigEntityBase:: |
protected | function | Overrides \Drupal\Core\Entity\DependencyTrait:addDependency(). | |
ConfigEntityBase:: |
public | function |
Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityInterface:: |
13 |
ConfigEntityBase:: |
public | function |
Creates a duplicate of the entity. Overrides EntityBase:: |
1 |
ConfigEntityBase:: |
public | function |
Disables the configuration entity. Overrides ConfigEntityInterface:: |
1 |
ConfigEntityBase:: |
public | function |
Enables the configuration entity. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Returns the value of a property. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Returns the cache tags that should be used to invalidate caches. Overrides EntityBase:: |
1 |
ConfigEntityBase:: |
public | function |
Gets the configuration dependency name. Overrides EntityBase:: |
|
ConfigEntityBase:: |
protected static | function | Gets the configuration manager. | |
ConfigEntityBase:: |
public | function |
Gets the configuration target identifier for the entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Gets the configuration dependencies. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets the original ID. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
protected | function | Gets the typed config manager. | |
ConfigEntityBase:: |
public | function |
Gets whether on not the data is trusted. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
protected static | function |
Override to never invalidate the individual entities' cache tags; the
config system already invalidates them. Overrides EntityBase:: |
|
ConfigEntityBase:: |
protected | function |
Override to never invalidate the entity's cache tag; the config system
already invalidates it. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Checks whether this entity is installable. Overrides ConfigEntityInterface:: |
2 |
ConfigEntityBase:: |
public | function |
Overrides Entity::isNew(). Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Deprecated way of generating a link to the entity. See toLink(). Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface:: |
7 |
ConfigEntityBase:: |
public static | function |
Acts on entities before they are deleted and before hooks are invoked. Overrides EntityBase:: |
8 |
ConfigEntityBase:: |
public | function |
Saves an entity permanently. Overrides EntityBase:: |
1 |
ConfigEntityBase:: |
public | function |
Sets the original ID. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Sets the status of the configuration entity. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function | ||
ConfigEntityBase:: |
public | function |
Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface:: |
4 |
ConfigEntityBase:: |
public | function |
Gets an array of all property values. Overrides EntityBase:: |
2 |
ConfigEntityBase:: |
public | function |
Gets the URL object for the entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Sets that the data should be trusted. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Unsets a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets the public URL for this entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Gets the URL object for the entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Constructs an Entity object. Overrides EntityBase:: |
10 |
ConfigEntityBase:: |
public | function |
Overrides EntityBase:: |
4 |
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 | Aliased as: traitSleep | 1 |
DependencySerializationTrait:: |
public | function | 2 | |
DependencyTrait:: |
protected | property | The object's dependencies. | |
DependencyTrait:: |
protected | function | Adds multiple dependencies. | |
DependencyTrait:: |
protected | function | Adds a dependency. Aliased as: addDependencyTrait | |
EntityBase:: |
protected | property | Boolean indicating whether the entity should be forced to be new. | |
EntityBase:: |
protected | property | The entity type. | |
EntityBase:: |
protected | property | A typed data object wrapping this entity. | |
EntityBase:: |
public | function |
Checks data value access. Overrides AccessibleInterface:: |
1 |
EntityBase:: |
public | function |
Gets the bundle of the entity. Overrides EntityInterface:: |
1 |
EntityBase:: |
public static | function |
Constructs a new entity object, without permanently saving it. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Deletes an entity permanently. Overrides EntityInterface:: |
2 |
EntityBase:: |
public | function |
Enforces an entity to be new. Overrides EntityInterface:: |
|
EntityBase:: |
protected | function | Gets the entity manager. | |
EntityBase:: |
protected | function | Gets the entity type bundle info service. | |
EntityBase:: |
protected | function | Gets the entity type manager. | |
EntityBase:: |
public | function |
The cache contexts associated with this object. Overrides CacheableDependencyTrait:: |
|
EntityBase:: |
public | function |
The maximum age for which this object may be cached. Overrides CacheableDependencyTrait:: |
|
EntityBase:: |
public | function |
The cache tags associated with this object. Overrides CacheableDependencyTrait:: |
|
EntityBase:: |
public | function |
Gets the key that is used to store configuration dependencies. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the entity type definition. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the ID of the type of the entity. Overrides EntityInterface:: |
|
EntityBase:: |
protected | function | The list cache tags to invalidate for this entity. | |
EntityBase:: |
public | function |
Gets a typed data object for this entity object. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Indicates if a link template exists for a given key. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the identifier. Overrides EntityInterface:: |
11 |
EntityBase:: |
public | function |
Gets the label of the entity. Overrides EntityInterface:: |
6 |
EntityBase:: |
public | function |
Gets the language of the entity. Overrides EntityInterface:: |
1 |
EntityBase:: |
protected | function | Gets the language manager. | |
EntityBase:: |
protected | function | Gets an array link templates. | 1 |
EntityBase:: |
public static | function |
Loads an entity. Overrides EntityInterface:: |
|
EntityBase:: |
public static | function |
Loads one or more entities. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Acts on a created entity before hooks are invoked. Overrides EntityInterface:: |
4 |
EntityBase:: |
public static | function |
Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface:: |
16 |
EntityBase:: |
public static | function |
Acts on loaded entities. Overrides EntityInterface:: |
2 |
EntityBase:: |
public static | function |
Changes the values of an entity before it is created. Overrides EntityInterface:: |
5 |
EntityBase:: |
public | function |
Gets a list of entities referenced by this entity. Overrides EntityInterface:: |
1 |
EntityBase:: |
public | function |
Generates the HTML for a link to this entity. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets a list of URI relationships supported by this entity. Overrides EntityInterface:: |
|
EntityBase:: |
protected | function | Gets an array of placeholders for this entity. | 2 |
EntityBase:: |
public | function |
Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface:: |
1 |
EntityBase:: |
protected | function | Gets the UUID generator. | |
PluginDependencyTrait:: |
protected | function | Calculates and adds dependencies of a specific plugin instance. | 1 |
PluginDependencyTrait:: |
protected | function | Calculates and returns dependencies of a specific plugin instance. | |
PluginDependencyTrait:: |
protected | function | Wraps the module handler. | 1 |
PluginDependencyTrait:: |
protected | function | Wraps the theme handler. | 1 |
RefinableCacheableDependencyTrait:: |
public | function | 1 | |
RefinableCacheableDependencyTrait:: |
public | function | ||
RefinableCacheableDependencyTrait:: |
public | function | ||
RefinableCacheableDependencyTrait:: |
public | function | ||
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. | |
SynchronizableEntityTrait:: |
protected | property | Whether this entity is being created, updated or deleted through a synchronization process. | |
SynchronizableEntityTrait:: |
public | function | ||
SynchronizableEntityTrait:: |
public | function | ||
WebformOptions:: |
protected | property | The webform options category. | |
WebformOptions:: |
protected | property | The webform options ID. | |
WebformOptions:: |
protected | property | The webform options label. | |
WebformOptions:: |
protected | property | Flag to used options as likert answers. | |
WebformOptions:: |
protected | property | The webform options options. | |
WebformOptions:: |
protected | property | The webform options decoded. | |
WebformOptions:: |
protected | property |
The webform options UUID. Overrides ConfigEntityBase:: |
|
WebformOptions:: |
public static | function |
Get webform element options. Overrides WebformOptionsInterface:: |
|
WebformOptions:: |
public | function |
Get options (YAML) as an associative array. Overrides WebformOptionsInterface:: |
|
WebformOptions:: |
public | function |
Determine if the webform options has alter hooks. Overrides WebformOptionsInterface:: |
|
WebformOptions:: |
public | function |
Determine if options should be used as Likert scale. Overrides WebformOptionsInterface:: |
|
WebformOptions:: |
public | function |
Acts on a saved entity before the insert or update hook is invoked. Overrides EntityBase:: |
|
WebformOptions:: |
public | function |
Acts on an entity before the presave hook is invoked. Overrides ConfigEntityBase:: |
|
WebformOptions:: |
public | function |
Sets the value of a property. Overrides ConfigEntityBase:: |
|
WebformOptions:: |
public | function |
Set options (YAML) value. Overrides WebformOptionsInterface:: |
|
WebformOptions:: |
public static | function |
Helper callback for uasort() to sort configuration entities by weight and label. Overrides ConfigEntityBase:: |