class PathWidget

Same name in other branches
  1. 9 core/modules/path/src/Plugin/Field/FieldWidget/PathWidget.php \Drupal\path\Plugin\Field\FieldWidget\PathWidget
  2. 10 core/modules/path/src/Plugin/Field/FieldWidget/PathWidget.php \Drupal\path\Plugin\Field\FieldWidget\PathWidget
  3. 11.x core/modules/path/src/Plugin/Field/FieldWidget/PathWidget.php \Drupal\path\Plugin\Field\FieldWidget\PathWidget

Plugin implementation of the 'path' widget.

Plugin annotation


@FieldWidget(
  id = "path",
  label = @Translation("URL alias"),
  field_types = {
    "path"
  }
)

Hierarchy

Expanded class hierarchy of PathWidget

File

core/modules/path/src/Plugin/Field/FieldWidget/PathWidget.php, line 21

Namespace

Drupal\path\Plugin\Field\FieldWidget
View source
class PathWidget extends WidgetBase {
    
    /**
     * {@inheritdoc}
     */
    public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
        $entity = $items->getEntity();
        $element += [
            '#element_validate' => [
                [
                    get_class($this),
                    'validateFormElement',
                ],
            ],
        ];
        $element['alias'] = [
            '#type' => 'textfield',
            '#title' => $element['#title'],
            '#default_value' => $items[$delta]->alias,
            '#required' => $element['#required'],
            '#maxlength' => 255,
            '#description' => $this->t('Specify an alternative path by which this data can be accessed. For example, type "/about" when writing an about page.'),
        ];
        $element['pid'] = [
            '#type' => 'value',
            '#value' => $items[$delta]->pid,
        ];
        $element['source'] = [
            '#type' => 'value',
            '#value' => !$entity->isNew() ? '/' . $entity->toUrl()
                ->getInternalPath() : NULL,
        ];
        $element['langcode'] = [
            '#type' => 'value',
            '#value' => $items[$delta]->langcode,
        ];
        // If the advanced settings tabs-set is available (normally rendered in the
        // second column on wide-resolutions), place the field as a details element
        // in this tab-set.
        if (isset($form['advanced'])) {
            $element += [
                '#type' => 'details',
                '#title' => t('URL path settings'),
                '#open' => !empty($items[$delta]->alias),
                '#group' => 'advanced',
                '#access' => $entity->get('path')
                    ->access('edit'),
                '#attributes' => [
                    'class' => [
                        'path-form',
                    ],
                ],
                '#attached' => [
                    'library' => [
                        'path/drupal.path',
                    ],
                ],
            ];
            $element['#weight'] = 30;
        }
        return $element;
    }
    
    /**
     * Form element validation handler for URL alias form element.
     *
     * @param array $element
     *   The form element.
     * @param \Drupal\Core\Form\FormStateInterface $form_state
     *   The form state.
     */
    public static function validateFormElement(array &$element, FormStateInterface $form_state) {
        // Trim the submitted value of whitespace and slashes.
        $alias = rtrim(trim($element['alias']['#value']), " \\/");
        if ($alias !== '') {
            $form_state->setValueForElement($element['alias'], $alias);
            
            /** @var \Drupal\path_alias\PathAliasInterface $path_alias */
            $path_alias = \Drupal::entityTypeManager()->getStorage('path_alias')
                ->create([
                'path' => $element['source']['#value'],
                'alias' => $alias,
                'langcode' => $element['langcode']['#value'],
            ]);
            $violations = $path_alias->validate();
            foreach ($violations as $violation) {
                // Newly created entities do not have a system path yet, so we need to
                // disregard some violations.
                if (!$path_alias->getPath() && $violation->getPropertyPath() === 'path') {
                    continue;
                }
                $form_state->setError($element['alias'], $violation->getMessage());
            }
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function errorElement(array $element, ConstraintViolationInterface $violation, array $form, FormStateInterface $form_state) {
        return $element['alias'];
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title 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.
PathWidget::errorElement public function Assigns a field-level validation error to the right widget sub-element. Overrides WidgetBase::errorElement
PathWidget::formElement public function Returns the form for a single field widget. Overrides WidgetInterface::formElement
PathWidget::validateFormElement public static function Form element validation handler for URL alias form element.
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
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::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsInterface::defaultSettings 42
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
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::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 5
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::settingsForm public function Returns a form to configure settings for the widget. Overrides WidgetInterface::settingsForm 16
WidgetBase::settingsSummary public function Returns a short summary for the current widget settings. Overrides WidgetInterface::settingsSummary 15
WidgetBase::setWidgetState public static function Stores processing information about the widget in $form_state. Overrides WidgetBaseInterface::setWidgetState
WidgetBase::__construct public function Constructs a WidgetBase object. 5

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.