class MenuController

Same name in this branch
  1. 9 core/modules/menu_link_content/src/Controller/MenuController.php \Drupal\menu_link_content\Controller\MenuController
Same name in other branches
  1. 8.9.x core/modules/menu_link_content/src/Controller/MenuController.php \Drupal\menu_link_content\Controller\MenuController
  2. 8.9.x core/modules/menu_ui/src/Controller/MenuController.php \Drupal\menu_ui\Controller\MenuController
  3. 10 core/modules/menu_link_content/src/Controller/MenuController.php \Drupal\menu_link_content\Controller\MenuController
  4. 10 core/modules/menu_ui/src/Controller/MenuController.php \Drupal\menu_ui\Controller\MenuController
  5. 11.x core/modules/menu_link_content/src/Controller/MenuController.php \Drupal\menu_link_content\Controller\MenuController
  6. 11.x core/modules/menu_ui/src/Controller/MenuController.php \Drupal\menu_ui\Controller\MenuController

Returns responses for Menu routes.

Hierarchy

Expanded class hierarchy of MenuController

File

core/modules/menu_ui/src/Controller/MenuController.php, line 16

Namespace

Drupal\menu_ui\Controller
View source
class MenuController extends ControllerBase {
    
    /**
     * The menu parent form service.
     *
     * @var \Drupal\Core\Menu\MenuParentFormSelectorInterface
     */
    protected $menuParentSelector;
    
    /**
     * Creates a new MenuController object.
     *
     * @param \Drupal\Core\Menu\MenuParentFormSelectorInterface $menu_parent_form
     *   The menu parent form service.
     */
    public function __construct(MenuParentFormSelectorInterface $menu_parent_form) {
        $this->menuParentSelector = $menu_parent_form;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container) {
        return new static($container->get('menu.parent_form_selector'));
    }
    
    /**
     * Gets all the available menus and menu items as a JavaScript array.
     *
     * @param \Symfony\Component\HttpFoundation\Request $request
     *   The request of the page.
     *
     * @return \Symfony\Component\HttpFoundation\JsonResponse
     *   The available menu and menu items.
     */
    public function getParentOptions(Request $request) {
        $available_menus = [];
        if ($menus = $request->request
            ->get('menus')) {
            foreach ($menus as $menu) {
                $available_menus[$menu] = $menu;
            }
        }
        // @todo Update this to use the optional $cacheability parameter, so that
        //   a cacheable JSON response can be sent.
        $options = $this->menuParentSelector
            ->getParentSelectOptions('', $available_menus);
        return new JsonResponse($options);
    }
    
    /**
     * Route title callback.
     *
     * @param \Drupal\system\MenuInterface $menu
     *   The menu entity.
     *
     * @return array
     *   The menu label as a render array.
     */
    public function menuTitle(MenuInterface $menu) {
        return [
            '#markup' => $menu->label(),
            '#allowed_tags' => Xss::getHtmlTagList(),
        ];
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 3
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 1
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$moduleHandler protected property The module handler. 1
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. 3
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 1
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. 1
ControllerBase::redirect protected function Returns a redirect response object for the specified route.
ControllerBase::state protected function Returns the state storage 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.
MenuController::$menuParentSelector protected property The menu parent form service.
MenuController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
MenuController::getParentOptions public function Gets all the available menus and menu items as a JavaScript array.
MenuController::menuTitle public function Route title callback.
MenuController::__construct public function Creates a new MenuController object.
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 'destination' 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.
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
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.

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