interface DataProviderResourceInterface in RESTful 7.2

Hierarchy

• interface \Drupal\restful\Plugin\resource\CrudInterface
  • interface \Drupal\restful\Plugin\resource\DataProvider\DataProviderInterface
    • interface \Drupal\restful\Plugin\resource\DataProvider\DataProviderResourceInterface

File

src/Plugin/resource/DataProvider/DataProviderResourceInterface.php, line 12

Contains \Drupal\restful\Plugin\resource\DataProvider\DataProviderResourceInterface.

Namespace

Drupal\restful\Plugin\resource\DataProvider

interface DataProviderResourceInterface extends DataProviderInterface {

  /**
   * Creates a new DataProviderResource object from the resource info.
   *
   * @param RequestInterface $request
   *   The request.
   * @param string $resource_name
   *   The resource name.
   * @param array $version
   *   The first position is the major version, the second is the minor version.
   *
   * @return DataProviderResourceInterface
   *   The data provider.
   */
  public static function init(RequestInterface $request, $resource_name, array $version);

  /**
   * Create or update an item based on the payload.
   *
   * @param mixed $identifier
   *   The resource item identifier.
   * @param mixed $object
   *   The payload.
   *
   * @return mixed
   *   The identifier of the created or updated resource item.
   */
  public function merge($identifier, $object);

}

Members

Name	Modifiers	Type	Description	Overrides
CrudInterface::count	public	function	Counts the total results for the index call.	8
CrudInterface::create	public	function	Create operation.	8
CrudInterface::index	public	function	List operation.	3
CrudInterface::remove	public	function	Delete operation.	8
CrudInterface::update	public	function	Update operation.	8
CrudInterface::view	public	function	Read operation.	8
CrudInterface::viewMultiple	public	function	Read operation.	8
DataProviderInterface::addOptions	public	function	Adds the options in the provided array to the data provider options.	3
DataProviderInterface::canonicalPath	public	function	Generates the canonical path for a given path.	3
DataProviderInterface::discover	public	function	Return the discovery information for the given entity.	3
DataProviderInterface::getAccount	public	function	Gets the authenticated account.	3
DataProviderInterface::getCacheFragments	public	function	Gets the entity context.	3
DataProviderInterface::getIndexIds	public	function	Returns the ID to render for the current index GET request.	8
DataProviderInterface::getLangCode	public	function	Get the language code.	3
DataProviderInterface::getMetadata	public	function	Returns the metadata collection.	3
DataProviderInterface::getOptions	public	function	Gets the data provider options.	3
DataProviderInterface::getRange	public	function	Gets the range.	3
DataProviderInterface::getRequest	public	function	Gets the request.	3
DataProviderInterface::getResourcePath	public	function	Get the resource path.	3
DataProviderInterface::isNestedField	public static	function	Checks if the passed in string is a dot-nested field.	3
DataProviderInterface::methodAccess	public	function	Checks if the provided field can be used with the current method.	3
DataProviderInterface::processFilterInput	public static	function	Processes the input for a filter and adds the appropriate defaults.	3
DataProviderInterface::setAccount	public	function	Sets the authenticated account.	3
DataProviderInterface::setLangCode	public	function	Sets the language code.	3
DataProviderInterface::setOptions	public	function	Sets the options.	3
DataProviderInterface::setRange	public	function	Sets the range.	3
DataProviderInterface::setRequest	public	function	Sets the request.	3
DataProviderInterface::setResourcePath	public	function	Set the resource path.	3
DataProviderResourceInterface::init	public static	function	Creates a new DataProviderResource object from the resource info.	1
DataProviderResourceInterface::merge	public	function	Create or update an item based on the payload.	1