class Agent in DRD Agent 4.0.x
Same name and namespace in other branches
- 8.3 src/Controller/Agent.php \Drupal\drd_agent\Controller\Agent
Class Default.
@package Drupal\drd_agent\Controller
Hierarchy
- class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
- class \Drupal\drd_agent\Controller\Agent
Expanded class hierarchy of Agent
1 file declares its use of Agent
- Download.php in src/
Agent/ Action/ Download.php
File
- src/
Controller/ Agent.php, line 18
Namespace
Drupal\drd_agent\ControllerView source
class Agent extends ControllerBase {
/**
* @var \Symfony\Component\DependencyInjection\ContainerInterface
*/
protected $container;
/**
* @var \Drupal\Core\State\StateInterface
*/
protected $state;
/**
* Get an array of http response headers.
*
* @return array
* The array with headers.
*/
public static function responseHeader() : array {
return [
'Content-Type' => 'text/plain; charset=utf-8',
'X-DRD-Agent' => $_SERVER['HTTP_X_DRD_VERSION'],
];
}
/**
* Agent constructor.
*
* @param \Symfony\Component\DependencyInjection\ContainerInterface $container
* @param \Drupal\Core\State\StateInterface $state
*/
public function __construct(ContainerInterface $container, StateInterface $state) {
$this->container = $container;
$this->state = $state;
}
public static function create(ContainerInterface $container) {
return new static($container, $container
->get('state'));
}
/**
* Route callback to execute an action and return their result.
*
* @return \Symfony\Component\HttpFoundation\Response
* The response to DRD.
* @throws \Exception
*/
public function get() : Response {
return $this
->deliver(ActionBase::create($this->container)
->run((bool) $this->state
->get('drd_agent.debug_mode', FALSE)));
}
/**
* Route callback to retrieve a list of available crypt methods.
*
* @return \Symfony\Component\HttpFoundation\Response
* The response to DRD.
* @throws \Exception
*/
public function getCryptMethods() : Response {
return $this
->deliver(base64_encode(json_encode(CryptBase::getMethods($this->container))));
}
/**
* Route callback to authorize a DRD instance by a secret.
*
* @return \Symfony\Component\HttpFoundation\Response
* The response to DRD.
* @throws \Exception
*/
public function authorizeBySecret() : Response {
return $this
->deliver(ActionBase::create($this->container)
->authorizeBySecret((bool) $this->state
->get('drd_agent.debug_mode', FALSE)));
}
/**
* Callback to deliver the result of the action in json format.
*
* @param string|Response $data
* The result which should be delivered back to DRD.
*
* @return \Symfony\Component\HttpFoundation\Response
* The response to DRD.
*/
private function deliver($data) : Response {
return $data instanceof Response ? $data : new JsonResponse($data, 200, self::responseHeader());
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
Agent:: |
protected | property | ||
Agent:: |
protected | property | ||
Agent:: |
public | function | Route callback to authorize a DRD instance by a secret. | |
Agent:: |
public static | function |
Instantiates a new instance of this class. Overrides ControllerBase:: |
|
Agent:: |
private | function | Callback to deliver the result of the action in json format. | |
Agent:: |
public | function | Route callback to execute an action and return their result. | |
Agent:: |
public | function | Route callback to retrieve a list of available crypt methods. | |
Agent:: |
public static | function | Get an array of http response headers. | |
Agent:: |
public | function | Agent constructor. | |
ControllerBase:: |
protected | property | The configuration factory. | |
ControllerBase:: |
protected | property | The current user service. | 1 |
ControllerBase:: |
protected | property | The entity form builder. | |
ControllerBase:: |
protected | property | The entity type manager. | |
ControllerBase:: |
protected | property | The form builder. | 2 |
ControllerBase:: |
protected | property | The key-value storage. | 1 |
ControllerBase:: |
protected | property | The language manager. | 1 |
ControllerBase:: |
protected | property | The module handler. | 2 |
ControllerBase:: |
protected | property | The state service. | |
ControllerBase:: |
protected | function | Returns the requested cache bin. | |
ControllerBase:: |
protected | function | Retrieves a configuration object. | |
ControllerBase:: |
private | function | Returns the service container. | |
ControllerBase:: |
protected | function | Returns the current user. | 1 |
ControllerBase:: |
protected | function | Retrieves the entity form builder. | |
ControllerBase:: |
protected | function | Retrieves the entity type manager. | |
ControllerBase:: |
protected | function | Returns the form builder service. | 2 |
ControllerBase:: |
protected | function | Returns a key/value storage collection. | 1 |
ControllerBase:: |
protected | function | Returns the language manager service. | 1 |
ControllerBase:: |
protected | function | Returns the module handler. | 2 |
ControllerBase:: |
protected | function | Returns a redirect response object for the specified route. | |
ControllerBase:: |
protected | function | Returns the state storage service. | |
LoggerChannelTrait:: |
protected | property | The logger channel factory service. | |
LoggerChannelTrait:: |
protected | function | Gets the logger for a specific channel. | |
LoggerChannelTrait:: |
public | function | Injects the logger channel factory. | |
MessengerTrait:: |
protected | property | The messenger. | 27 |
MessengerTrait:: |
public | function | Gets the messenger. | 27 |
MessengerTrait:: |
public | function | Sets the messenger. | |
RedirectDestinationTrait:: |
protected | property | The redirect destination service. | 1 |
RedirectDestinationTrait:: |
protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. | |
RedirectDestinationTrait:: |
protected | function | Returns the redirect destination service. | |
RedirectDestinationTrait:: |
public | function | Sets the redirect destination service. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 4 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |