abstract class TokenAuthenticationBase in RESTful 7.2

Hierarchy

class \Drupal\restful\Plugin\resource\Resource extends \Drupal\Component\Plugin\PluginBase implements ResourceInterface uses ConfigurablePluginTrait
- class \Drupal\restful\Plugin\resource\ResourceEntity
  - class \Drupal\restful_token_auth\Plugin\resource\TokenAuthenticationBase implements ResourceInterface

Expanded class hierarchy of TokenAuthenticationBase

File

modules/restful_token_auth/src/Plugin/resource/TokenAuthenticationBase.php, line 13: Contains Drupal\restful_token_auth\Plugin\resource\TokenAuthenticationBase.

Namespace

Drupal\restful_token_auth\Plugin\resource

View source

abstract class TokenAuthenticationBase extends ResourceEntity implements ResourceInterface {

  /**
   * Overrides ResourceEntity::publicFields().
   *
   * @see http://tools.ietf.org/html/rfc6750#section-4
   */
  public function publicFields() {
    $public_fields = parent::publicFields();
    unset($public_fields['label']);
    unset($public_fields['self']);
    $public_fields['id']['methods'] = array();
    $public_fields['access_token'] = array(
      'property' => 'token',
    );
    $public_fields['type'] = array(
      'callback' => array(
        '\\Drupal\\restful\\RestfulManager::echoMessage',
        array(
          'Bearer',
        ),
      ),
    );
    $public_fields['expires_in'] = array(
      'property' => 'expire',
      'process_callbacks' => array(
        '\\Drupal\\restful_token_auth\\Plugin\\resource\\TokenAuthenticationBase::intervalInSeconds',
      ),
    );
    $public_fields['refresh_token'] = array(
      'property' => 'refresh_token_reference',
      'process_callbacks' => array(
        '\\Drupal\\restful_token_auth\\Plugin\\resource\\TokenAuthenticationBase::getTokenFromEntity',
      ),
    );
    return $public_fields;
  }

  /**
   * Process callback helper to get the time difference in seconds.
   *
   * @param int $value
   *   The expiration timestamp in the access token.
   *
   * @return int
   *   Number of seconds before expiration.
   */
  public static function intervalInSeconds($value) {
    $interval = $value - time();
    return $interval < 0 ? 0 : $interval;
  }

  /**
   * Get the token string from the token entity.
   *
   * @param int $token_id
   *   The restful_token_auth entity.
   *
   * @return string
   *   The token string.
   */
  public static function getTokenFromEntity($token_id) {
    if ($token = entity_load_single('restful_token_auth', $token_id)) {
      return $token->token;
    }
    return NULL;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigurablePluginTrait::$instanceConfiguration	protected	property	Plugin instance configuration.
ConfigurablePluginTrait::calculateDependencies	public	function
ConfigurablePluginTrait::getConfiguration	public	function
ConfigurablePluginTrait::setConfiguration	public	function
Resource::$authenticationManager	protected	property	The authentication manager.
Resource::$dataProvider	protected	property	The data provider.
Resource::$enabled	protected	property	Indicates if the resource is enabled.
Resource::$fieldDefinitions	protected	property	The field definition object.
Resource::$path	protected	property	The requested path.
Resource::$request	protected	property	The current request.
Resource::access	public	function	Determine if user can access the handler. Overrides ResourceInterface::access	1
Resource::accessByAllowOrigin	protected	function	Checks access based on the referer header and the allowOrigin setting.
Resource::controllersInfo	public	function	Gets the controllers. Overrides ResourceInterface::controllersInfo	6
Resource::create	public	function	Basic implementation for create. Overrides ResourceInterface::create
Resource::defaultConfiguration	public	function	Overrides ConfigurablePluginTrait::defaultConfiguration
Resource::disable	public	function	Disable the resource. Overrides ResourceInterface::disable
Resource::discover	public	function	Discovery controller callback. Overrides ResourceInterface::discover
Resource::doDelete	public	function	Shorthand method to perform a quick DELETE request. Overrides ResourceInterface::doDelete
Resource::doGet	public	function	Shorthand method to perform a quick GET request. Overrides ResourceInterface::doGet
Resource::doPatch	public	function	Shorthand method to perform a quick PATCH request. Overrides ResourceInterface::doPatch
Resource::doPost	public	function	Shorthand method to perform a quick POST request. Overrides ResourceInterface::doPost
Resource::doPut	public	function	Shorthand method to perform a quick PUT request. Overrides ResourceInterface::doPut
Resource::doWrite	private	function
Resource::enable	public	function	Enable the resource. Overrides ResourceInterface::enable
Resource::getAccount	public	function	Get the user from for request. Overrides ResourceInterface::getAccount
Resource::getControllerFromPath	public	function	Return the controller for a given path. Overrides ResourceInterface::getControllerFromPath
Resource::getControllers	public	function	Gets the controllers for this resource. Overrides ResourceInterface::getControllers
Resource::getDataProvider	public	function	Gets the data provider. Overrides ResourceInterface::getDataProvider
Resource::getFieldDefinitions	public	function	Gets the field definitions. Overrides ResourceInterface::getFieldDefinitions
Resource::getPath	public	function	Gets the path of the resource. Overrides ResourceInterface::getPath
Resource::getRequest	public	function	Get the request object. Overrides ResourceInterface::getRequest
Resource::getResourceMachineName	public	function	Gets the resource machine name. Overrides ResourceInterface::getResourceMachineName
Resource::getResourceName	public	function	Gets the resource name. Overrides ResourceInterface::getResourceName
Resource::getUrl	public	function	Helper method; Get the URL of the resource and query strings. Overrides ResourceInterface::getUrl
Resource::getVersion	public	function	Return array keyed with the major and minor version of the resource. Overrides ResourceInterface::getVersion
Resource::index	public	function	Basic implementation for listing. Overrides ResourceInterface::index	1
Resource::initAuthenticationManager	protected	function	Initializes the authentication manager and adds the appropriate providers.
Resource::isEnabled	public	function	Checks if the resource is enabled. Overrides ResourceInterface::isEnabled
Resource::preflight	protected	function	Adds the Allowed-Origin headers.
Resource::process	public	function	Controller function that passes the data along and executes right action. Overrides ResourceInterface::process
Resource::remove	public	function	Basic implementation for update. Overrides ResourceInterface::remove
Resource::replace	public	function	Basic implementation for update. Overrides ResourceInterface::replace
Resource::setAccount	public	function	Overrides ResourceInterface::setAccount
Resource::setDataProvider	public	function	Sets the data provider. Overrides ResourceInterface::setDataProvider
Resource::setFieldDefinitions	public	function	Sets the field definitions. Overrides ResourceInterface::setFieldDefinitions
Resource::setPath	public	function	Sets the path of the resource. Overrides ResourceInterface::setPath
Resource::setPluginDefinition	public	function	Sets the plugin definition to the provided array. Overrides ResourceInterface::setPluginDefinition
Resource::setRequest	public	function	Sets the request object. Overrides ResourceInterface::setRequest
Resource::switchUserBack	public	function	Switches the user back from the original user for the session. Overrides ResourceInterface::switchUserBack	1
Resource::update	public	function	Basic implementation for update. Overrides ResourceInterface::update
Resource::versionedUrl	public	function	Gets a resource URL based on the current version. Overrides ResourceInterface::versionedUrl
Resource::view	public	function	Basic implementation for view. Overrides ResourceInterface::view
ResourceEntity::$bundles	protected	property	The entity bundles.
ResourceEntity::$entityType	protected	property	The entity type.
ResourceEntity::dataProviderClassName	protected	function	Data provider class. Overrides Resource::dataProviderClassName	3
ResourceEntity::dataProviderFactory	public	function	Data provider factory. Overrides Resource::dataProviderFactory
ResourceEntity::getBundles	public	function	Gets the entity bundle.
ResourceEntity::getEntitySelf	public	function	Get the "self" url.
ResourceEntity::getEntityType	public	function	Gets the entity type.
ResourceEntity::processPublicFields	protected	function	Get the public fields with the default values applied to them. Overrides Resource::processPublicFields	2
ResourceEntity::viewModeFields	protected	function	Get the public fields with default values based on view mode information.
ResourceEntity::__construct	public	function	Constructs a Drupal\Component\Plugin\PluginBase object. Overrides Resource::__construct	2
ResourceInterface::IDS_SEPARATOR		constant	The string that separates multiple ids.
TokenAuthenticationBase::getTokenFromEntity	public static	function	Get the token string from the token entity.
TokenAuthenticationBase::intervalInSeconds	public static	function	Process callback helper to get the time difference in seconds.
TokenAuthenticationBase::publicFields	public	function	Overrides ResourceEntity::publicFields(). Overrides ResourceEntity::publicFields

You are here

abstract class TokenAuthenticationBase in RESTful 7.2

Hierarchy

File

Namespace

Members

API Navigation