class UrlSettingType in UI Patterns Settings 8.2

Url setting type.

Plugin annotation

@UiPatternsSettingType(
  id = "url",
  label = @Translation("Url")
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\ui_patterns_settings\Plugin\PatternSettingTypeBase implements ConfigurableInterface, ContainerFactoryPluginInterface, PatternSettingTypeInterface
      • class \Drupal\ui_patterns_settings\Plugin\TokenSettingTypeBase implements ContainerFactoryPluginInterface
        • class \Drupal\ui_patterns_settings\Plugin\UIPatterns\SettingType\UrlSettingType

File

src/Plugin/UiPatterns/SettingType/UrlSettingType.php, line 18

Namespace

Drupal\ui_patterns_settings\Plugin\UIPatterns\SettingType

class UrlSettingType extends TokenSettingTypeBase {

  /**
   * {@inheritdoc}
   */
  public function fieldStorageExposableTypes() {
    return [
      'link',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function preprocessExposedField(FieldItemList $items) {
    foreach ($items as $item) {
      return $item
        ->getUrl();
    }
  }

  /**
   * {@inheritdoc}
   */
  public function settingsPreprocess($value, array $context, PatternDefinitionSetting $def) {
    $value = parent::settingsPreprocess($value, $context, $def);
    if (empty($value)) {
      return "";
    }
    try {
      $url = Url::fromUri($value)
        ->toString();
    } catch (\Exception $e) {

      // Not a valid uri. Try user input:
      try {
        $url = Url::fromUserInput($value)
          ->toString();
      } catch (\Exception $e) {

        // Not a valid url.
        return '#';
      }
    }
    return $url;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PatternSettingTypeBase::$entityTypeManager	protected	property	Return pattern definitions for setting .
PatternSettingTypeBase::$moduleHandler	private	property	The module handler.
PatternSettingTypeBase::$patternDefinition	private	property	Return pattern definitions for setting .
PatternSettingTypeBase::$patternSettingDefinition	private	property	Return pattern definitions for setting .
PatternSettingTypeBase::alterFieldStorage	public	function	Alter the storage of a connected field storage. Overrides PatternSettingTypeInterface::alterFieldStorage	1
PatternSettingTypeBase::buildConfigurationForm	public	function	Creates a generic configuration form for all settings types. Individual settings plugins can add elements to this form by overriding PatternSettingTypeBaseInterface::settingsForm(). Most plugins should not override this method unless they need to… Overrides PatternSettingTypeInterface::buildConfigurationForm
PatternSettingTypeBase::calculateDependencies	public	function
PatternSettingTypeBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration
PatternSettingTypeBase::formGroupProcess	public static	function	Set the right group before drupal #group attribute is processed.
PatternSettingTypeBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
PatternSettingTypeBase::getDescription	public	function
PatternSettingTypeBase::getPatternSettingDefinition	protected	function	Return pattern setting definition.
PatternSettingTypeBase::getSettingTypeDependencies	protected	function	Returns a list of plugin dependencies.	2
PatternSettingTypeBase::getValue	protected	function	Return value if set otherwise take the default value.	1
PatternSettingTypeBase::handleInput	protected	function	Add validation and basics classes to the raw input field.	1
PatternSettingTypeBase::label	public	function
PatternSettingTypeBase::preprocess	public	function	Returns the processed setting variable. Overrides PatternSettingTypeInterface::preprocess	1
PatternSettingTypeBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
PatternSettingTypeBase::tokenForm	protected	function	Returns the bind form field.
PatternSettingTypeBase::validateLayout	public static	function	Check required input fields in layout forms.
PatternSettingTypeBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
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.
TokenSettingTypeBase::$tokenService	protected	property	The token service.
TokenSettingTypeBase::create	public static	function	Creates an instance of the plugin. Overrides PatternSettingTypeBase::create
TokenSettingTypeBase::getTokenService	public	function	Gets the token service.
TokenSettingTypeBase::settingsForm	public	function	Returns the configuration form elements specific to this settings plugin.. Overrides PatternSettingTypeInterface::settingsForm
TokenSettingTypeBase::setTokenService	public	function	Sets the token service.
UrlSettingType::fieldStorageExposableTypes	public	function	Returns the list to matching field types. Overrides PatternSettingTypeBase::fieldStorageExposableTypes
UrlSettingType::preprocessExposedField	public	function	Returns the processed setting variable for an exposed field. Overrides PatternSettingTypeBase::preprocessExposedField
UrlSettingType::settingsPreprocess	public	function	Preprocess setting variable. Overrides TokenSettingTypeBase::settingsPreprocess