class ContextualController
Same name and namespace in other branches
- 11.x core/modules/contextual/src/ContextualController.php \Drupal\contextual\ContextualController
- 10 core/modules/contextual/src/ContextualController.php \Drupal\contextual\ContextualController
- 9 core/modules/contextual/src/ContextualController.php \Drupal\contextual\ContextualController
- 8.9.x core/modules/contextual/src/ContextualController.php \Drupal\contextual\ContextualController
Returns responses for Contextual module routes.
Hierarchy
- class \Drupal\contextual\ContextualController implements \Drupal\Core\DependencyInjection\ContainerInjectionInterface uses \Drupal\Core\DependencyInjection\AutowireTrait
Expanded class hierarchy of ContextualController
File
-
core/
modules/ contextual/ src/ ContextualController.php, line 17
Namespace
Drupal\contextualView source
class ContextualController implements ContainerInjectionInterface {
use AutowireTrait;
public function __construct(protected RendererInterface $renderer, protected ?ContextualLinksSerializer $serializer = NULL) {
if (!$serializer) {
@trigger_error('Calling ' . __METHOD__ . '() without the $serializer argument is deprecated in drupal:11.4.0 and it will be required in drupal:12.0.0. See https://www.drupal.org/node/3568088', E_USER_DEPRECATED);
$this->serializer = \Drupal::service(ContextualLinksSerializer::class);
}
}
/**
* Returns the requested rendered contextual links.
*
* Given a list of contextual links IDs, render them. Hence this must be
* robust to handle arbitrary input.
*
* @param \Symfony\Component\HttpFoundation\Request $request
* The Symfony request object.
*
* @return \Symfony\Component\HttpFoundation\JsonResponse
* The JSON response.
*
* @throws \Symfony\Component\HttpKernel\Exception\BadRequestHttpException
* Thrown when the request contains no ids.
*
* @internal
*
* @see contextual_preprocess()
*/
public function render(Request $request) {
if (!$request->request
->has('ids')) {
throw new BadRequestHttpException('No contextual ids specified.');
}
$ids = $request->request
->all('ids');
if (!$request->request
->has('tokens')) {
throw new BadRequestHttpException('No contextual ID tokens specified.');
}
$tokens = $request->request
->all('tokens');
$rendered = [];
foreach ($ids as $key => $id) {
if (!isset($tokens[$key]) || !hash_equals($tokens[$key], Crypt::hmacBase64($id, Settings::getHashSalt() . \Drupal::service('private_key')->get()))) {
throw new BadRequestHttpException('Invalid contextual ID specified.');
}
$element = [
'#type' => 'contextual_links',
'#contextual_links' => $this->serializer
->idToLinks($id),
];
$rendered[$id] = $this->renderer
->renderRoot($element);
}
return new JsonResponse($rendered);
}
}
Members
| Title Sort descending | Modifiers | Object type | Summary |
|---|---|---|---|
| AutowiredInstanceTrait::createInstanceAutowired | public static | function | Instantiates a new instance of the implementing class using autowiring. |
| AutowireTrait::create | public static | function | Instantiates a new instance of the implementing class using autowiring. |
| ContextualController::render | public | function | Returns the requested rendered contextual links. |
| ContextualController::__construct | public | function |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.