abstract class DataProviderDecorator in RESTful 7.2

Hierarchy

• class \Drupal\restful\Plugin\resource\DataProvider\DataProviderDecorator implements DataProviderInterface

File

src/Plugin/resource/DataProvider/DataProviderDecorator.php, line 13

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

Namespace

Drupal\restful\Plugin\resource\DataProvider

abstract class DataProviderDecorator implements DataProviderInterface {

  /**
   * Decorated provider.
   *
   * @var DataProviderInterface
   */
  protected $decorated;

  /**
   * Contstructs a DataProviderDecorator class.
   *
   * @param DataProviderInterface $decorated
   *   The decorated data provider.
   */
  public function __construct(DataProviderInterface $decorated) {
    $this->decorated = $decorated;
  }

  /**
   * {@inheritdoc}
   */
  public function getRange() {
    return $this->decorated
      ->getRange();
  }

  /**
   * {@inheritdoc}
   */
  public function setRange($range) {
    $this->decorated
      ->setRange($range);
  }

  /**
   * {@inheritdoc}
   */
  public function getAccount() {
    return $this->decorated
      ->getAccount();
  }

  /**
   * {@inheritdoc}
   */
  public function setAccount($account) {
    $this->decorated
      ->setAccount($account);
  }

  /**
   * {@inheritdoc}
   */
  public function getRequest() {
    return $this->decorated
      ->getRequest();
  }

  /**
   * {@inheritdoc}
   */
  public function setRequest(RequestInterface $request) {
    $this->decorated
      ->setRequest($request);
  }

  /**
   * {@inheritdoc}
   */
  public function getLangCode() {
    return $this->decorated
      ->getLangCode();
  }

  /**
   * {@inheritdoc}
   */
  public function setLangCode($langcode) {
    $this->decorated
      ->setLangCode($langcode);
  }

  /**
   * {@inheritdoc}
   */
  public function getOptions() {
    return $this->decorated
      ->getOptions();
  }

  /**
   * {@inheritdoc}
   */
  public function addOptions(array $options) {
    $this->decorated
      ->addOptions($options);
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheFragments($identifier) {
    $this->decorated
      ->getCacheFragments($identifier);
  }

  /**
   * {@inheritdoc}
   */
  public function canonicalPath($path) {
    return $this->decorated
      ->canonicalPath($path);
  }

  /**
   * {@inheritdoc}
   */
  public function methodAccess(ResourceFieldInterface $resource_field) {
    return $this->decorated
      ->methodAccess($resource_field);
  }

  /**
   * {@inheritdoc}
   */
  public function setOptions(array $options) {
    $this->decorated
      ->setOptions($options);
  }

  /**
   * {@inheritdoc}
   */
  public function getIndexIds() {
    return $this->decorated
      ->getIndexIds();
  }

  /**
   * {@inheritdoc}
   */
  public function index() {
    return $this->decorated
      ->index();
  }

  /**
   * {@inheritdoc}
   */
  public function count() {
    return $this->decorated
      ->count();
  }

  /**
   * {@inheritdoc}
   */
  public function create($object) {
    return $this->decorated
      ->create($object);
  }

  /**
   * {@inheritdoc}
   */
  public function view($identifier) {
    return $this->decorated
      ->view($identifier);
  }

  /**
   * {@inheritdoc}
   */
  public function viewMultiple(array $identifiers) {
    return $this->decorated
      ->viewMultiple($identifiers);
  }

  /**
   * {@inheritdoc}
   */
  public function update($identifier, $object, $replace = FALSE) {
    return $this->decorated
      ->update($identifier, $object, $replace);
  }

  /**
   * {@inheritdoc}
   */
  public function remove($identifier) {
    $this->decorated
      ->remove($identifier);
  }

  /**
   * {@inheritdoc}
   */
  public function discover($path = NULL) {
    return $this->decorated
      ->discover($path);
  }

  /**
   * {@inheritdoc}
   */
  public static function isNestedField($field_name) {
    return DataProvider::isNestedField($field_name);
  }

  /**
   * {@inheritdoc}
   */
  public static function processFilterInput($filter, $public_field) {
    return DataProvider::processFilterInput($filter, $public_field);
  }

  /**
   * {@inheritdoc}
   */
  public function setResourcePath($resource_path) {
    $this->decorated
      ->setResourcePath($resource_path);
  }

  /**
   * {@inheritdoc}
   */
  public function getResourcePath() {
    return $this->decorated
      ->getResourcePath();
  }

  /**
   * {@inheritdoc}
   */
  public function getMetadata() {
    return $this->decorated
      ->getMetadata();
  }

}

Members

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