class PathElement in Zircon Profile 8
Same name and namespace in other branches
- 8.0 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 a array containing a route name and route parameters pair.
Plugin annotation
@FormElement("path");
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, StringTranslationTrait
- class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
- class \Drupal\Core\Render\Element\FormElement implements FormElementInterface
- class \Drupal\Core\Render\Element\Textfield
- class \Drupal\Core\Render\Element\PathElement
- class \Drupal\Core\Render\Element\Textfield
- class \Drupal\Core\Render\Element\FormElement implements FormElementInterface
- class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, StringTranslationTrait
Expanded class hierarchy of PathElement
1 file declares its use of PathElement
- PathElementFormTest.php in core/
modules/ system/ src/ Tests/ Element/ PathElementFormTest.php - Contains \Drupal\system\Tests\Element\PathElementFormTest.
1 #type use of PathElement
- PathElementFormTest::buildForm in core/
modules/ system/ src/ Tests/ Element/ PathElementFormTest.php - Form constructor.
File
- core/
lib/ Drupal/ Core/ Render/ Element/ PathElement.php, line 21 - Contains \Drupal\Core\Render\Element\PathElement.
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 = get_class($this);
$info['#validate_path'] = TRUE;
$info['#convert_path'] = self::CONVERT_ROUTE;
$info['#element_validate'] = array(
array(
$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, array(
'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.', array(
'%path' => $element['#value'],
)));
}
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
FormElement:: |
public static | function | Adds autocomplete functionality to elements. | |
FormElement:: |
public static | function | #process callback for #pattern form element property. | |
FormElement:: |
public static | function | #element_validate callback for #pattern form element property. | |
PathElement:: |
constant | Do not convert the submitted value from the user-supplied path. | ||
PathElement:: |
constant | Convert the submitted value into a route name and parameter pair. | ||
PathElement:: |
constant | Convert the submitted value into a \Drupal\Core\Url value object. | ||
PathElement:: |
public | function |
Returns the element properties for this element. Overrides Textfield:: |
|
PathElement:: |
public static | function | Form element validation handler for matched_path elements. | |
PathElement:: |
public static | function |
Determines how user input is mapped to an element's #value property. Overrides Textfield:: |
|
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 2 |
PluginBase:: |
protected | property | The plugin implementation definition. | |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Constructs a Drupal\Component\Plugin\PluginBase object. | 69 |
RenderElement:: |
public static | function | Adds Ajax information about an element to communicate with JavaScript. | |
RenderElement:: |
public static | function | Adds members of this group as actual elements for rendering. | |
RenderElement:: |
public static | function | Form element processing handler for the #ajax form property. | |
RenderElement:: |
public static | function | Arranges elements into groups. | |
RenderElement:: |
public static | function |
Sets a form element's class attribute. Overrides ElementInterface:: |
|
StringTranslationTrait:: |
protected | property | The string translation service. | |
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. | |
Textfield:: |
public static | function | Prepares a #type 'textfield' render element for input.html.twig. |