interface PathValidatorInterface

Same name in other branches
  1. 9 core/lib/Drupal/Core/Path/PathValidatorInterface.php \Drupal\Core\Path\PathValidatorInterface
  2. 10 core/lib/Drupal/Core/Path/PathValidatorInterface.php \Drupal\Core\Path\PathValidatorInterface
  3. 11.x core/lib/Drupal/Core/Path/PathValidatorInterface.php \Drupal\Core\Path\PathValidatorInterface

Provides an interface for url path validators.

Hierarchy

Expanded class hierarchy of PathValidatorInterface

All classes that implement PathValidatorInterface

7 files declare their use of PathValidatorInterface
ContactFormEditForm.php in core/modules/contact/src/ContactFormEditForm.php
LinkFormatter.php in core/modules/link/src/Plugin/Field/FieldFormatter/LinkFormatter.php
MenuLinkContentForm.php in core/modules/menu_link_content/src/Form/MenuLinkContentForm.php
Route.php in core/modules/migrate/src/Plugin/migrate/process/Route.php
ShortcutSetController.php in core/modules/shortcut/src/Controller/ShortcutSetController.php

... See full list

File

core/lib/Drupal/Core/Path/PathValidatorInterface.php, line 8

Namespace

Drupal\Core\Path
View source 
interface PathValidatorInterface {
    
    /**
     * Returns a URL object, if the path is valid and accessible.
     *
     * @param string $path
     *   The path to check.
     *
     * @return \Drupal\Core\Url|false
     *   The url object, or FALSE if the path is not valid.
     */
    public function getUrlIfValid($path);
    
    /**
     * Returns a URL object, if the path is valid.
     *
     * Unlike getUrlIfValid(), access check is not performed. Do not use this
     * method if the $path is about to be presented to a user.
     *
     * @param string $path
     *   The path to check.
     *
     * @return \Drupal\Core\Url|false
     *   The url object, or FALSE if the path is not valid.
     */
    public function getUrlIfValidWithoutAccessCheck($path);
    
    /**
     * Checks if the URL path is valid and accessible by the current user.
     *
     * @param string $path
     *   The path to check.
     *
     * @return bool
     *   TRUE if the path is valid.
     */
    public function isValid($path);

}

Members

Title Modifiers Object type Summary Overrides
PathValidatorInterface::getUrlIfValid public function Returns a URL object, if the path is valid and accessible. 1
PathValidatorInterface::getUrlIfValidWithoutAccessCheck public function Returns a URL object, if the path is valid. 1
PathValidatorInterface::isValid public function Checks if the URL path is valid and accessible by the current user. 1

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