class MachineNameController in Drupal 9
Same name and namespace in other branches
- 8 core/modules/system/src/MachineNameController.php \Drupal\system\MachineNameController
Controller routines for machine name transliteration routes.
Hierarchy
- class \Drupal\system\MachineNameController implements ContainerInjectionInterface
Expanded class hierarchy of MachineNameController
1 file declares its use of MachineNameController
- MachineNameControllerTest.php in core/
modules/ system/ tests/ src/ Unit/ Transliteration/ MachineNameControllerTest.php
File
- core/
modules/ system/ src/ MachineNameController.php, line 16
Namespace
Drupal\systemView source
class MachineNameController implements ContainerInjectionInterface {
/**
* The transliteration helper.
*
* @var \Drupal\Component\Transliteration\TransliterationInterface
*/
protected $transliteration;
/**
* The token generator.
*
* @var \Drupal\Core\Access\CsrfTokenGenerator
*/
protected $tokenGenerator;
/**
* Constructs a MachineNameController object.
*
* @param \Drupal\Component\Transliteration\TransliterationInterface $transliteration
* The transliteration helper.
* @param \Drupal\Core\Access\CsrfTokenGenerator $token_generator
* The token generator.
*/
public function __construct(TransliterationInterface $transliteration, CsrfTokenGenerator $token_generator) {
$this->transliteration = $transliteration;
$this->tokenGenerator = $token_generator;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container
->get('transliteration'), $container
->get('csrf_token'));
}
/**
* Transliterates a string in given language. Various postprocessing possible.
*
* @param \Symfony\Component\HttpFoundation\Request $request
* The input string and language for the transliteration.
* Optionally may contain the replace_pattern, replace, lowercase parameters.
*
* @return \Symfony\Component\HttpFoundation\JsonResponse
* The transliterated string.
*/
public function transliterate(Request $request) {
$text = $request->query
->get('text');
$langcode = $request->query
->get('langcode');
$replace_pattern = $request->query
->get('replace_pattern');
$replace_token = $request->query
->get('replace_token');
$replace = $request->query
->get('replace');
$lowercase = $request->query
->get('lowercase');
$transliterated = $this->transliteration
->transliterate($text, $langcode, '_');
if ($lowercase) {
$transliterated = mb_strtolower($transliterated);
}
if (isset($replace_pattern) && isset($replace)) {
if (!isset($replace_token)) {
throw new AccessDeniedHttpException("Missing 'replace_token' query parameter.");
}
elseif (!$this->tokenGenerator
->validate($replace_token, $replace_pattern)) {
throw new AccessDeniedHttpException("Invalid 'replace_token' query parameter.");
}
// Quote the pattern delimiter and remove null characters to avoid the e
// or other modifiers being injected.
$transliterated = preg_replace('@' . strtr($replace_pattern, [
'@' => '\\@',
chr(0) => '',
]) . '@', $replace, $transliterated);
}
return new JsonResponse($transliterated);
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
MachineNameController:: |
protected | property | The token generator. | |
MachineNameController:: |
protected | property | The transliteration helper. | |
MachineNameController:: |
public static | function |
Instantiates a new instance of this class. Overrides ContainerInjectionInterface:: |
|
MachineNameController:: |
public | function | Transliterates a string in given language. Various postprocessing possible. | |
MachineNameController:: |
public | function | Constructs a MachineNameController object. |