interface CacheDecoratedResourceInterface in RESTful 7.2

Hierarchy

• interface \Drupal\restful\Plugin\resource\ResourceInterface extends \Drupal\Component\Plugin\PluginInspectionInterface \Drupal\Component\Plugin\ConfigurablePluginInterface
  • interface \Drupal\restful\Plugin\resource\Decorators\ResourceDecoratorInterface
    • interface \Drupal\restful\Plugin\resource\Decorators\CacheDecoratedResourceInterface

2 files declare their use of CacheDecoratedResourceInterface

Formatter.php in src/Plugin/formatter/Formatter.php

Contains \Drupal\restful\Plugin\formatter\Formatter

restful.entity.inc in ./restful.entity.inc

Contains entity related code.

File

src/Plugin/resource/Decorators/CacheDecoratedResourceInterface.php, line 11

Contains \Drupal\restful\Plugin\resource\Decorators\CacheDecoratedResourceInterface.

Namespace

Drupal\restful\Plugin\resource\Decorators

interface CacheDecoratedResourceInterface extends ResourceDecoratorInterface {

  /**
   * Generates a serialized key value pair.
   *
   * @param string $key
   *   The key
   * @param string $value
   *   The value.
   *
   * @return string
   *   The serialized value.
   */
  public static function serializeKeyValue($key, $value);

  /**
   * Getter for $cacheController.
   *
   * @return \DrupalCacheInterface
   *   The cache object.
   */
  public function getCacheController();

  /**
   * Checks if simple invalidation is enabled for this resource.
   *
   * @return bool
   *   TRUE if simple invalidation is needed.
   */
  public function hasSimpleInvalidation();

}

Members

Name	Modifiers	Type	Description	Overrides
CacheDecoratedResourceInterface::getCacheController	public	function	Getter for $cacheController.	1
CacheDecoratedResourceInterface::hasSimpleInvalidation	public	function	Checks if simple invalidation is enabled for this resource.	1
CacheDecoratedResourceInterface::serializeKeyValue	public static	function	Generates a serialized key value pair.	1
ResourceDecoratorInterface::getDecoratedResource	public	function	Gets the decorated resource.	1
ResourceDecoratorInterface::getPrimaryResource	public	function	Gets the primary resource, the one that is not a decorator.	1
ResourceInterface::access	public	function	Determine if user can access the handler.	2
ResourceInterface::controllersInfo	public	function	Gets the controllers.	2
ResourceInterface::create	public	function	Basic implementation for create.	2
ResourceInterface::dataProviderFactory	public	function	Data provider factory.	2
ResourceInterface::disable	public	function	Disable the resource.	2
ResourceInterface::discover	public	function	Discovery controller callback.	2
ResourceInterface::doDelete	public	function	Shorthand method to perform a quick DELETE request.	2
ResourceInterface::doGet	public	function	Shorthand method to perform a quick GET request.	2
ResourceInterface::doPatch	public	function	Shorthand method to perform a quick PATCH request.	2
ResourceInterface::doPost	public	function	Shorthand method to perform a quick POST request.	2
ResourceInterface::doPut	public	function	Shorthand method to perform a quick PUT request.	2
ResourceInterface::enable	public	function	Enable the resource.	2
ResourceInterface::getAccount	public	function	Get the user from for request.	2
ResourceInterface::getControllerFromPath	public	function	Return the controller for a given path.	2
ResourceInterface::getControllers	public	function	Gets the controllers for this resource.	2
ResourceInterface::getDataProvider	public	function	Gets the data provider.	2
ResourceInterface::getFieldDefinitions	public	function	Gets the field definitions.	2
ResourceInterface::getPath	public	function	Gets the path of the resource.	2
ResourceInterface::getRequest	public	function	Get the request object.	2
ResourceInterface::getResourceMachineName	public	function	Gets the resource machine name.	2
ResourceInterface::getResourceName	public	function	Gets the resource name.	2
ResourceInterface::getUrl	public	function	Helper method; Get the URL of the resource and query strings.	2
ResourceInterface::getVersion	public	function	Return array keyed with the major and minor version of the resource.	2
ResourceInterface::IDS_SEPARATOR		constant	The string that separates multiple ids.
ResourceInterface::index	public	function	Basic implementation for listing.	2
ResourceInterface::isEnabled	public	function	Checks if the resource is enabled.	2
ResourceInterface::process	public	function	Controller function that passes the data along and executes right action.	2
ResourceInterface::remove	public	function	Basic implementation for update.	2
ResourceInterface::replace	public	function	Basic implementation for update.	2
ResourceInterface::setAccount	public	function		2
ResourceInterface::setDataProvider	public	function	Sets the data provider.	2
ResourceInterface::setFieldDefinitions	public	function	Sets the field definitions.	2
ResourceInterface::setPath	public	function	Sets the path of the resource.	2
ResourceInterface::setPluginDefinition	public	function	Sets the plugin definition to the provided array.	2
ResourceInterface::setRequest	public	function	Sets the request object.	2
ResourceInterface::switchUserBack	public	function	Switches the user back from the original user for the session.	2
ResourceInterface::update	public	function	Basic implementation for update.	2
ResourceInterface::versionedUrl	public	function	Gets a resource URL based on the current version.	2
ResourceInterface::view	public	function	Basic implementation for view.	2