class EditorController

Same name in other branches
  1. 8.9.x core/modules/editor/src/EditorController.php \Drupal\editor\EditorController
  2. 10 core/modules/editor/src/EditorController.php \Drupal\editor\EditorController
  3. 11.x core/modules/editor/src/EditorController.php \Drupal\editor\EditorController

Returns responses for Editor module routes.

Hierarchy

Expanded class hierarchy of EditorController

File

core/modules/editor/src/EditorController.php, line 14

Namespace

Drupal\editor
View source
class EditorController extends ControllerBase {
    
    /**
     * Apply the necessary XSS filtering for using a certain text format's editor.
     *
     * @param \Symfony\Component\HttpFoundation\Request $request
     *   The current request object.
     * @param \Drupal\filter\FilterFormatInterface $filter_format
     *   The text format whose text editor (if any) will be used.
     *
     * @return \Symfony\Component\HttpFoundation\JsonResponse
     *   A JSON response containing the XSS-filtered value.
     *
     * @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
     *   Thrown if no value to filter is specified.
     *
     * @see editor_filter_xss()
     */
    public function filterXss(Request $request, FilterFormatInterface $filter_format) {
        $value = $request->request
            ->get('value');
        if (!isset($value)) {
            throw new NotFoundHttpException();
        }
        // The original_format parameter will only exist when switching text format.
        $original_format_id = $request->request
            ->get('original_format_id');
        $original_format = NULL;
        if (isset($original_format_id)) {
            $original_format = $this->entityTypeManager()
                ->getStorage('filter_format')
                ->load($original_format_id);
        }
        return new JsonResponse(editor_filter_xss($value, $filter_format, $original_format));
    }

}

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::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 49
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.
EditorController::filterXss public function Apply the necessary XSS filtering for using a certain text format's editor.
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 '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.