class ShortcutSetController

Same name in other branches
  1. 9 core/modules/shortcut/src/Controller/ShortcutSetController.php \Drupal\shortcut\Controller\ShortcutSetController
  2. 10 core/modules/shortcut/src/Controller/ShortcutSetController.php \Drupal\shortcut\Controller\ShortcutSetController
  3. 11.x core/modules/shortcut/src/Controller/ShortcutSetController.php \Drupal\shortcut\Controller\ShortcutSetController

Builds the page for administering shortcut sets.

Hierarchy

Expanded class hierarchy of ShortcutSetController

File

core/modules/shortcut/src/Controller/ShortcutSetController.php, line 15

Namespace

Drupal\shortcut\Controller
View source
class ShortcutSetController extends ControllerBase {
    
    /**
     * The path validator.
     *
     * @var \Drupal\Core\Path\PathValidatorInterface
     */
    protected $pathValidator;
    
    /**
     * Creates a new ShortcutSetController instance.
     *
     * @param \Drupal\Core\Path\PathValidatorInterface $path_validator
     *   The path validator.
     */
    public function __construct(PathValidatorInterface $path_validator) {
        $this->pathValidator = $path_validator;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container) {
        return new static($container->get('path.validator'));
    }
    
    /**
     * Creates a new link in the provided shortcut set.
     *
     * @param \Drupal\shortcut\ShortcutSetInterface $shortcut_set
     *   The shortcut set to add a link to.
     * @param \Symfony\Component\HttpFoundation\Request $request
     *   The request object.
     *
     * @return \Symfony\Component\HttpFoundation\RedirectResponse
     *   A redirect response to the front page, or the previous location.
     *
     * @throws \Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException
     */
    public function addShortcutLinkInline(ShortcutSetInterface $shortcut_set, Request $request) {
        $link = $request->query
            ->get('link');
        $name = $request->query
            ->get('name');
        if (parse_url($link, PHP_URL_SCHEME) === NULL && $this->pathValidator
            ->isValid($link)) {
            $shortcut = $this->entityTypeManager()
                ->getStorage('shortcut')
                ->create([
                'title' => $name,
                'shortcut_set' => $shortcut_set->id(),
                'link' => [
                    'uri' => 'internal:/' . $link,
                ],
            ]);
            try {
                $shortcut->save();
                $this->messenger()
                    ->addStatus($this->t('Added a shortcut for %title.', [
                    '%title' => $shortcut->label(),
                ]));
            } catch (\Exception $e) {
                $this->messenger()
                    ->addError($this->t('Unable to add a shortcut for %title.', [
                    '%title' => $shortcut->label(),
                ]));
            }
            return $this->redirect('<front>');
        }
        throw new AccessDeniedHttpException();
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 1
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityManager protected property The entity manager.
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 2
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$moduleHandler protected property The module handler. 2
ControllerBase::$stateService protected property The state service.
ControllerBase::cache protected function Returns the requested cache bin.
ControllerBase::config protected function Retrieves a configuration object.
ControllerBase::container private function Returns the service container.
ControllerBase::currentUser protected function Returns the current user. 1
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityManager Deprecated protected function Retrieves the entity manager service.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 2
ControllerBase::keyValue protected function Returns a key/value storage collection. 1
ControllerBase::languageManager protected function Returns the language manager service. 1
ControllerBase::moduleHandler protected function Returns the module handler. 2
ControllerBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::state protected function Returns the state storage service.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 17
MessengerTrait::messenger public function Gets the messenger. 17
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a &#039;destination&#039; URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
ShortcutSetController::$pathValidator protected property The path validator.
ShortcutSetController::addShortcutLinkInline public function Creates a new link in the provided shortcut set.
ShortcutSetController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
ShortcutSetController::__construct public function Creates a new ShortcutSetController instance.
StringTranslationTrait::$stringTranslation protected property The string translation service.
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.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.

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