class PathElement
Same name in other branches
- 8.9.x core/lib/Drupal/Core/Render/Element/PathElement.php \Drupal\Core\Render\Element\PathElement
- 10 core/lib/Drupal/Core/Render/Element/PathElement.php \Drupal\Core\Render\Element\PathElement
- 11.x core/lib/Drupal/Core/Render/Element/PathElement.php \Drupal\Core\Render\Element\PathElement
Provides a matched path render element.
Provides a form element to enter a path which can be optionally validated and stored as either a \Drupal\Core\Url value object or an array containing a route name and route parameters pair.
Plugin annotation
@FormElement("path");
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
- class \Drupal\Core\Render\Element\RenderElement extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Render\Element\ElementInterface
- class \Drupal\Core\Render\Element\FormElement extends \Drupal\Core\Render\Element\RenderElement implements \Drupal\Core\Render\Element\FormElementInterface
- class \Drupal\Core\Render\Element\Textfield extends \Drupal\Core\Render\Element\FormElement
- class \Drupal\Core\Render\Element\PathElement extends \Drupal\Core\Render\Element\Textfield
- class \Drupal\Core\Render\Element\Textfield extends \Drupal\Core\Render\Element\FormElement
- class \Drupal\Core\Render\Element\FormElement extends \Drupal\Core\Render\Element\RenderElement implements \Drupal\Core\Render\Element\FormElementInterface
- class \Drupal\Core\Render\Element\RenderElement extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Render\Element\ElementInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
Expanded class hierarchy of PathElement
2 files declare their use of PathElement
- ContactFormEditForm.php in core/
modules/ contact/ src/ ContactFormEditForm.php - PathElementFormTest.php in core/
tests/ Drupal/ KernelTests/ Core/ Element/ PathElementFormTest.php
2 #type uses of PathElement
- ContactFormEditForm::form in core/
modules/ contact/ src/ ContactFormEditForm.php - Gets the actual form array to be built.
- PathElementFormTest::buildForm in core/
tests/ Drupal/ KernelTests/ Core/ Element/ PathElementFormTest.php - Form constructor.
File
-
core/
lib/ Drupal/ Core/ Render/ Element/ PathElement.php, line 16
Namespace
Drupal\Core\Render\ElementView source
class PathElement extends Textfield {
/**
* Do not convert the submitted value from the user-supplied path.
*/
const CONVERT_NONE = 0;
/**
* Convert the submitted value into a route name and parameter pair.
*/
const CONVERT_ROUTE = 1;
/**
* Convert the submitted value into a \Drupal\Core\Url value object.
*/
const CONVERT_URL = 2;
/**
* {@inheritdoc}
*/
public function getInfo() {
$info = parent::getInfo();
$class = static::class;
$info['#validate_path'] = TRUE;
$info['#convert_path'] = self::CONVERT_ROUTE;
$info['#element_validate'] = [
[
$class,
'validateMatchedPath',
],
];
return $info;
}
/**
* {@inheritdoc}
*/
public static function valueCallback(&$element, $input, FormStateInterface $form_state) {
return NULL;
}
/**
* Form element validation handler for matched_path elements.
*
* Note that #maxlength is validated by _form_validate() already.
*
* This checks that the submitted value matches an active route.
*/
public static function validateMatchedPath(&$element, FormStateInterface $form_state, &$complete_form) {
if (!empty($element['#value']) && ($element['#validate_path'] || $element['#convert_path'] != self::CONVERT_NONE)) {
/** @var \Drupal\Core\Url $url */
if ($url = \Drupal::service('path.validator')->getUrlIfValid($element['#value'])) {
if ($url->isExternal()) {
$form_state->setError($element, t('You cannot use an external URL, please enter a relative path.'));
return;
}
if ($element['#convert_path'] == self::CONVERT_NONE) {
// URL is valid, no conversion required.
return;
}
// We do the value conversion here whilst the Url object is in scope
// after validation has occurred.
if ($element['#convert_path'] == self::CONVERT_ROUTE) {
$form_state->setValueForElement($element, [
'route_name' => $url->getRouteName(),
'route_parameters' => $url->getRouteParameters(),
]);
return;
}
elseif ($element['#convert_path'] == self::CONVERT_URL) {
$form_state->setValueForElement($element, $url);
return;
}
}
$form_state->setError($element, t('This path does not exist or you do not have permission to link to %path.', [
'%path' => $element['#value'],
]));
}
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
FormElement::processAutocomplete | public static | function | Adds autocomplete functionality to elements. | ||
FormElement::processPattern | public static | function | #process callback for #pattern form element property. | ||
FormElement::validatePattern | public static | function | #element_validate callback for #pattern form element property. | ||
PathElement::CONVERT_NONE | constant | Do not convert the submitted value from the user-supplied path. | |||
PathElement::CONVERT_ROUTE | constant | Convert the submitted value into a route name and parameter pair. | |||
PathElement::CONVERT_URL | constant | Convert the submitted value into a \Drupal\Core\Url value object. | |||
PathElement::getInfo | public | function | Returns the element properties for this element. | Overrides Textfield::getInfo | |
PathElement::validateMatchedPath | public static | function | Form element validation handler for matched_path elements. | ||
PathElement::valueCallback | public static | function | Determines how user input is mapped to an element's #value property. | Overrides Textfield::valueCallback | |
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 | |
RenderElement::preRenderAjaxForm | public static | function | Adds Ajax information about an element to communicate with JavaScript. | ||
RenderElement::preRenderGroup | public static | function | Adds members of this group as actual elements for rendering. | ||
RenderElement::processAjaxForm | public static | function | Form element processing handler for the #ajax form property. | 1 | |
RenderElement::processGroup | public static | function | Arranges elements into groups. | ||
RenderElement::setAttributes | public static | function | Sets a form element's class attribute. | Overrides ElementInterface::setAttributes | |
Textfield::preRenderTextfield | public static | function | Prepares a #type 'textfield' render element for input.html.twig. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.