interface DataProviderDbQueryInterface in RESTful 7.2
Hierarchy
- interface \Drupal\restful\Plugin\resource\CrudInterface
- interface \Drupal\restful\Plugin\resource\DataProvider\DataProviderInterface
- interface \Drupal\restful\Plugin\resource\DataProvider\DataProviderDbQueryInterface
- interface \Drupal\restful\Plugin\resource\DataProvider\DataProviderInterface
Expanded class hierarchy of DataProviderDbQueryInterface
All classes that implement DataProviderDbQueryInterface
File
- src/
Plugin/ resource/ DataProvider/ DataProviderDbQueryInterface.php, line 10 - Contains \Drupal\restful\Plugin\resource\DataProvider\DataProviderDbQueryInterface.
Namespace
Drupal\restful\Plugin\resource\DataProviderView source
interface DataProviderDbQueryInterface extends DataProviderInterface {
/**
* Get the name of the table to query.
*
* @return string
* The name of the table to query.
*/
public function getTableName();
/**
* Set the name of the table to query.
*
* @param string $table_name
* The name of the table to query.
*/
public function setTableName($table_name);
/**
* Gets the primary field.
*
* @return string
* The field name.
*/
public function getPrimary();
/**
* Sets the primary field.
*
* @param string $primary
* The field name.
*/
public function setPrimary($primary);
/**
* Checks if the current field is the primary field.
*
* @param string $field_name
* The column name to check.
*
* @return bool
* TRUE if it is the primary field, FALSE otherwise.
*/
public function isPrimaryField($field_name);
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
CrudInterface:: |
public | function | Counts the total results for the index call. | 8 |
CrudInterface:: |
public | function | Create operation. | 8 |
CrudInterface:: |
public | function | List operation. | 3 |
CrudInterface:: |
public | function | Delete operation. | 8 |
CrudInterface:: |
public | function | Update operation. | 8 |
CrudInterface:: |
public | function | Read operation. | 8 |
CrudInterface:: |
public | function | Read operation. | 8 |
DataProviderDbQueryInterface:: |
public | function | Gets the primary field. | 1 |
DataProviderDbQueryInterface:: |
public | function | Get the name of the table to query. | 1 |
DataProviderDbQueryInterface:: |
public | function | Checks if the current field is the primary field. | 1 |
DataProviderDbQueryInterface:: |
public | function | Sets the primary field. | 1 |
DataProviderDbQueryInterface:: |
public | function | Set the name of the table to query. | 1 |
DataProviderInterface:: |
public | function | Adds the options in the provided array to the data provider options. | 3 |
DataProviderInterface:: |
public | function | Generates the canonical path for a given path. | 3 |
DataProviderInterface:: |
public | function | Return the discovery information for the given entity. | 3 |
DataProviderInterface:: |
public | function | Gets the authenticated account. | 3 |
DataProviderInterface:: |
public | function | Gets the entity context. | 3 |
DataProviderInterface:: |
public | function | Returns the ID to render for the current index GET request. | 8 |
DataProviderInterface:: |
public | function | Get the language code. | 3 |
DataProviderInterface:: |
public | function | Returns the metadata collection. | 3 |
DataProviderInterface:: |
public | function | Gets the data provider options. | 3 |
DataProviderInterface:: |
public | function | Gets the range. | 3 |
DataProviderInterface:: |
public | function | Gets the request. | 3 |
DataProviderInterface:: |
public | function | Get the resource path. | 3 |
DataProviderInterface:: |
public static | function | Checks if the passed in string is a dot-nested field. | 3 |
DataProviderInterface:: |
public | function | Checks if the provided field can be used with the current method. | 3 |
DataProviderInterface:: |
public static | function | Processes the input for a filter and adds the appropriate defaults. | 3 |
DataProviderInterface:: |
public | function | Sets the authenticated account. | 3 |
DataProviderInterface:: |
public | function | Sets the language code. | 3 |
DataProviderInterface:: |
public | function | Sets the options. | 3 |
DataProviderInterface:: |
public | function | Sets the range. | 3 |
DataProviderInterface:: |
public | function | Sets the request. | 3 |
DataProviderInterface:: |
public | function | Set the resource path. | 3 |