class CsrfToken in RESTful 7.2
Class CsrfToken @package Drupal\restful\Plugin\resource
Plugin annotation
@Resource(
name = "csrf_token:1.0",
resource = "csrf_token",
label = "CSRF Token",
description = "Resource that provides CSRF Tokens when using cookie authentication.",
authenticationTypes = TRUE,
authenticationOptional = FALSE,
formatter = "single_json",
renderCache = {
"render": FALSE
},
menuItem = "session/token",
majorVersion = 1,
minorVersion = 0
)
Hierarchy
- class \Drupal\restful\Plugin\resource\Resource extends \Drupal\Component\Plugin\PluginBase implements ResourceInterface uses ConfigurablePluginTrait
- class \Drupal\restful\Plugin\resource\CsrfToken implements ResourceInterface
Expanded class hierarchy of CsrfToken
File
- src/
Plugin/ resource/ CsrfToken.php, line 32 - Contains \Drupal\restful\Plugin\resource\CsrfToken.
Namespace
Drupal\restful\Plugin\resourceView source
class CsrfToken extends Resource implements ResourceInterface {
/**
* {@inheritdoc}
*/
protected function publicFields() {
return array(
'X-CSRF-Token' => array(
'callback' => '\\Drupal\\restful\\Plugin\\resource\\CsrfToken::getCsrfToken',
),
);
}
/**
* Value callback; Return the CSRF token.
*
* @return string
* The token.
*/
public static function getCsrfToken() {
return drupal_get_token(\Drupal\restful\Plugin\authentication\Authentication::TOKEN_VALUE);
}
/**
* {@inheritdoc}
*/
public function index($path) {
$values = array();
foreach ($this
->publicFields() as $public_property => $info) {
$value = NULL;
if ($info['callback']) {
$value = ResourceManager::executeCallback($info['callback']);
}
if ($value && !empty($info['process_callbacks'])) {
foreach ($info['process_callbacks'] as $process_callback) {
$value = ResourceManager::executeCallback($process_callback, array(
$value,
));
}
}
$values[$public_property] = $value;
}
return $values;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ConfigurablePluginTrait:: |
protected | property | Plugin instance configuration. | |
ConfigurablePluginTrait:: |
public | function | ||
ConfigurablePluginTrait:: |
public | function | ||
ConfigurablePluginTrait:: |
public | function | ||
CsrfToken:: |
public static | function | Value callback; Return the CSRF token. | |
CsrfToken:: |
public | function |
Basic implementation for listing. Overrides Resource:: |
|
CsrfToken:: |
protected | function |
Public fields. Overrides Resource:: |
|
Resource:: |
protected | property | The authentication manager. | |
Resource:: |
protected | property | The data provider. | |
Resource:: |
protected | property | Indicates if the resource is enabled. | |
Resource:: |
protected | property | The field definition object. | |
Resource:: |
protected | property | The requested path. | |
Resource:: |
protected | property | The current request. | |
Resource:: |
public | function |
Determine if user can access the handler. Overrides ResourceInterface:: |
1 |
Resource:: |
protected | function | Checks access based on the referer header and the allowOrigin setting. | |
Resource:: |
public | function |
Gets the controllers. Overrides ResourceInterface:: |
6 |
Resource:: |
public | function |
Basic implementation for create. Overrides ResourceInterface:: |
|
Resource:: |
protected | function | Data provider class. | 4 |
Resource:: |
public | function |
Data provider factory. Overrides ResourceInterface:: |
1 |
Resource:: |
public | function |
Overrides ConfigurablePluginTrait:: |
|
Resource:: |
public | function |
Disable the resource. Overrides ResourceInterface:: |
|
Resource:: |
public | function |
Discovery controller callback. Overrides ResourceInterface:: |
|
Resource:: |
public | function |
Shorthand method to perform a quick DELETE request. Overrides ResourceInterface:: |
|
Resource:: |
public | function |
Shorthand method to perform a quick GET request. Overrides ResourceInterface:: |
|
Resource:: |
public | function |
Shorthand method to perform a quick PATCH request. Overrides ResourceInterface:: |
|
Resource:: |
public | function |
Shorthand method to perform a quick POST request. Overrides ResourceInterface:: |
|
Resource:: |
public | function |
Shorthand method to perform a quick PUT request. Overrides ResourceInterface:: |
|
Resource:: |
private | function | ||
Resource:: |
public | function |
Enable the resource. Overrides ResourceInterface:: |
|
Resource:: |
public | function |
Get the user from for request. Overrides ResourceInterface:: |
|
Resource:: |
public | function |
Return the controller for a given path. Overrides ResourceInterface:: |
|
Resource:: |
public | function |
Gets the controllers for this resource. Overrides ResourceInterface:: |
|
Resource:: |
public | function |
Gets the data provider. Overrides ResourceInterface:: |
|
Resource:: |
public | function |
Gets the field definitions. Overrides ResourceInterface:: |
|
Resource:: |
public | function |
Gets the path of the resource. Overrides ResourceInterface:: |
|
Resource:: |
public | function |
Get the request object. Overrides ResourceInterface:: |
|
Resource:: |
public | function |
Gets the resource machine name. Overrides ResourceInterface:: |
|
Resource:: |
public | function |
Gets the resource name. Overrides ResourceInterface:: |
|
Resource:: |
public | function |
Helper method; Get the URL of the resource and query strings. Overrides ResourceInterface:: |
|
Resource:: |
public | function |
Return array keyed with the major and minor version of the resource. Overrides ResourceInterface:: |
|
Resource:: |
protected | function | Initializes the authentication manager and adds the appropriate providers. | |
Resource:: |
public | function |
Checks if the resource is enabled. Overrides ResourceInterface:: |
|
Resource:: |
protected | function | Adds the Allowed-Origin headers. | |
Resource:: |
public | function |
Controller function that passes the data along and executes right action. Overrides ResourceInterface:: |
|
Resource:: |
protected | function | Get the public fields with the default values applied to them. | 2 |
Resource:: |
public | function |
Basic implementation for update. Overrides ResourceInterface:: |
|
Resource:: |
public | function |
Basic implementation for update. Overrides ResourceInterface:: |
|
Resource:: |
public | function |
Overrides ResourceInterface:: |
|
Resource:: |
public | function |
Sets the data provider. Overrides ResourceInterface:: |
|
Resource:: |
public | function |
Sets the field definitions. Overrides ResourceInterface:: |
|
Resource:: |
public | function |
Sets the path of the resource. Overrides ResourceInterface:: |
|
Resource:: |
public | function |
Sets the plugin definition to the provided array. Overrides ResourceInterface:: |
|
Resource:: |
public | function |
Sets the request object. Overrides ResourceInterface:: |
|
Resource:: |
public | function |
Switches the user back from the original user for the session. Overrides ResourceInterface:: |
1 |
Resource:: |
public | function |
Basic implementation for update. Overrides ResourceInterface:: |
|
Resource:: |
public | function |
Gets a resource URL based on the current version. Overrides ResourceInterface:: |
|
Resource:: |
public | function |
Basic implementation for view. Overrides ResourceInterface:: |
|
Resource:: |
public | function | Constructs a Drupal\Component\Plugin\PluginBase object. | 1 |
ResourceInterface:: |
constant | The string that separates multiple ids. |