You are here

Home » API reference » RESTful 7 » RestfulExampleNodeUserResource.class.php

class RestfulExampleNodeUserResource in RESTful 7

@file Contains RestfulExampleNodeUserResource.

Hierarchy

Expanded class hierarchy of RestfulExampleNodeUserResource

1 string reference to 'RestfulExampleNodeUserResource'
node_user__1_0.inc in modules/restful_example/plugins/restful/db_query/node_user/1.0/node_user__1_0.inc

File

modules/restful_example/plugins/restful/db_query/node_user/1.0/RestfulExampleNodeUserResource.class.php, line 8
Contains RestfulExampleNodeUserResource.

View source 
class RestfulExampleNodeUserResource extends \RestfulDataProviderDbQuery implements \RestfulDataProviderDbQueryInterface {

  /**
   * {@inheritdoc}
   */
  public function publicFieldsInfo() {
    $public_fields['id'] = array(
      'property' => 'nid',
    );
    $public_fields['label'] = array(
      'property' => 'title',
    );

    // The terms are taken from a join query, as they exist on another table.
    $public_fields['author'] = array(
      'property' => 'name',
      // Set the actual column name, so WHERE and ORDER BY may work, as MySql
      // doesn't allow using a column alias for those operations.
      'column_for_query' => 'user.name',
    );
    return $public_fields;
  }

  /**
   * Overrides \RestfulDataProviderDbQuery::getQuery().
   *
   * Join with the terms table.
   */
  protected function getQuery() {
    $query = parent::getQuery();

    // Add a node access tag.
    $query
      ->addTag('node_access');
    $query
      ->innerJoin('users', 'user', 'node.uid = user.uid');

    // Explicitly set the alias of the column, so it will match the public field
    // name.
    $query
      ->addField('user', 'name', 'name');
    return $query;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
RestfulBase::$authenticationManager protected property Authentication manager.
RestfulBase::$cacheController protected property Cache controller object.
RestfulBase::$controllers protected property Nested array that provides information about what method to call for each route pattern.
RestfulBase::$httpHeaders protected property Array keyed by the header property, and the value.
RestfulBase::$langcode protected property Determines the language of the items that should be returned.
RestfulBase::$method protected property The HTTP method used for the request.
RestfulBase::$path protected property The path of the request.
RestfulBase::$publicFields protected property The public fields that are exposed to the API. 1
RestfulBase::$range protected property Determines the number of items that should be returned when viewing lists.
RestfulBase::$rateLimitManager protected property Rate limit manager.
RestfulBase::$request protected property The request array.
RestfulBase::$staticCache public property Static cache controller.
RestfulBase::$valueMetadata protected property Holds additional information about the generated values. This information is available to the formatters.
RestfulBase::access public function Determine if user can access the handler. Overrides RestfulInterface::access 4
RestfulBase::accessByAllowOrigin protected function Checks access based on the referer header and the allow_origin setting.
RestfulBase::addCidParams protected static function Get the cache id parameters based on the keys.
RestfulBase::addHttpHeaders public function Add the a value to a multi-value HTTP header. Overrides RestfulInterface::addHttpHeaders
RestfulBase::cacheInvalidate public function Invalidates cache for a certain entity.
RestfulBase::cleanRequest public static function Helper function to remove the application generated request data.
RestfulBase::clearRenderedCache protected function Clear an entry from the rendered cache.
RestfulBase::clearResourceRenderedCache public function Clear all caches corresponding to the current resource.
RestfulBase::controllersInfo public static function Returns the default controllers for the entity. 1
RestfulBase::delete public function Call resource using the DELETE http method.
RestfulBase::executeCallback public static function Execute a user callback.
RestfulBase::format public function Call the output format on the given data.
RestfulBase::formatter protected function Get the formatter handler for the current restful formatter.
RestfulBase::formatterNames public function Returns the names of the available formatter plugins.
RestfulBase::generateCacheId protected function Generate a cache identifier for the request and the current context.
RestfulBase::get public function Call resource using the GET http method.
RestfulBase::getAccount public function Proxy method to get the account from the authenticationManager.
RestfulBase::getAuthenticationManager public function Getter for $authenticationManager.
RestfulBase::getCacheController public function Getter for $cacheController.
RestfulBase::getControllerFromPath public function Return the controller from a given path.
RestfulBase::getControllers public function Get the defined controllers
RestfulBase::getHttpHeaders public function Return array keyed by the header property, and the value. Overrides RestfulInterface::getHttpHeaders
RestfulBase::getLangCode public function Get the language code.
RestfulBase::getMenuItem public static function Get the non translated menu item.
RestfulBase::getMethod public function Get the HTTP method used for the request.
RestfulBase::getPageArguments public static function Get the resource name and version from the page arguments in the router.
RestfulBase::getPath public function Return the path of the request.
RestfulBase::getPublicFields public function Return the properties that should be public after processing. Overrides RestfulInterface::getPublicFields
RestfulBase::getRange public function Get the pager range.
RestfulBase::getRateLimitManager public function Getter for rateLimitManager.
RestfulBase::getRenderedCache protected function Get an entry from the rendered cache.
RestfulBase::getRequest public function Get the request array.
RestfulBase::getRequestForSubRequest protected function Gets a request array with the data that should be piped to sub requests.
RestfulBase::getResourceLastVersion public static function Return the last version for a given resource.
RestfulBase::getResourceName public function Return the resource name.
RestfulBase::getUrl public function Helper method; Get the URL of the resource and query strings.
RestfulBase::getValueMetadata public function Get value metadata.
RestfulBase::getVersion public function Return array keyed with the major and minor version of the resource.
RestfulBase::getVersionFromRequest public static function Gets the major and minor version for the current request.
RestfulBase::head public function Call resource using the GET http method.
RestfulBase::isArrayNumeric final public static function Helper method to determine if an array is numeric.
RestfulBase::isListRequest public function Helper method to know if the current request is for a list.
RestfulBase::isReadMethod public static function Determines if the HTTP method represents a read operation.
RestfulBase::isValidConjunctionForFilter protected static function Check if a conjunction is valid for filtering. 2
RestfulBase::isValidMethod public static function Determines if the HTTP method is one of the known methods.
RestfulBase::isValidOperatorsForFilter protected static function Check if an operator is valid for filtering. 1
RestfulBase::isWriteMethod public static function Determines if the HTTP method represents a write operation.
RestfulBase::newCacheObject protected function Get the default cache object based on the plugin configuration.
RestfulBase::notImplementedCrudOperation protected static function Helper method with the code to run for non implemented CRUD operations.
RestfulBase::options public function Call resource using the OPTIONS http method.
RestfulBase::overrideRange protected function Overrides the range parameter with the URL value if any.
RestfulBase::parseRequestForListFilter protected function Filter the query for list.
RestfulBase::parseRequestForListPagination protected function Parses the request object to get the pagination options.
RestfulBase::parseRequestForListSort protected function Parses the request to get the sorting options.
RestfulBase::parseVersionString public static function Parses the version string.
RestfulBase::patch public function Call resource using the PATCH http method.
RestfulBase::post public function Call resource using the POST http method.
RestfulBase::process public function Entry point to process a request. Overrides RestfulInterface::process
RestfulBase::processDataProviderOptions protected function Process plugin options by validation keys exists, and set default values.
RestfulBase::put public function Call resource using the PUT http method.
RestfulBase::setAccount public function Proxy method to set the account from the authenticationManager.
RestfulBase::setAuthenticationManager public function Setter for $authenticationManager.
RestfulBase::setHttpHeaders public function Set the HTTP headers. Overrides RestfulInterface::setHttpHeaders
RestfulBase::setLangCode public function Sets the language code.
RestfulBase::setMethod public function Set the HTTP method used for the request.
RestfulBase::setPath public function Set the path of the request.
RestfulBase::setPublicFields public function Set the public fields.
RestfulBase::setRange public function Set the pager range.
RestfulBase::setRateLimitManager public function Setter for rateLimitManager.
RestfulBase::setRenderedCache protected function Store an entry in the rendered cache.
RestfulBase::setRequest public function Set the request array.
RestfulBase::versionedUrl public function Gets a resource URL based on the current version.
RestfulDataProviderDbQuery::$idColumn protected property The name of the column(s) in the table to be used as the unique key.
RestfulDataProviderDbQuery::$primary protected property Holds the primary field.
RestfulDataProviderDbQuery::$tableName protected property The name of the table to query.
RestfulDataProviderDbQuery::addDefaultValuesToPublicFields protected function Add default values to the public fields array. Overrides RestfulBase::addDefaultValuesToPublicFields
RestfulDataProviderDbQuery::addExtraInfoToQuery protected function Adds query tags and metadata to the EntityFieldQuery. Overrides RestfulBase::addExtraInfoToQuery
RestfulDataProviderDbQuery::COLUMN_IDS_SEPARATOR constant The separator used to divide a key into its table columns when there is more than one column.
RestfulDataProviderDbQuery::create public function Create an item from the request object. Overrides RestfulBase::create
RestfulDataProviderDbQuery::defaultSortInfo public function Defines default sort columns if none are provided via the request URL.
RestfulDataProviderDbQuery::getColumnFromIds protected function Given an array of string ID's return a single column. for example:
RestfulDataProviderDbQuery::getIdColumn public function Get ID column
RestfulDataProviderDbQuery::getPrimary public function
RestfulDataProviderDbQuery::getPropertyColumnForQuery protected function Return the column name that should be used for query.
RestfulDataProviderDbQuery::getQueryCount public function Prepare a query for RestfulEntityBase::getTotalCount(). Overrides RestfulDataProviderDbQueryInterface::getQueryCount
RestfulDataProviderDbQuery::getQueryForList public function Prepare a query for RestfulEntityBase::getList(). Overrides RestfulDataProviderDbQueryInterface::getQueryForList
RestfulDataProviderDbQuery::getTableName public function Get the name of the table to query.
RestfulDataProviderDbQuery::getTotalCount public function Helper method to get the total count of entities that match certain request. Overrides RestfulDataProviderDbQueryInterface::getTotalCount
RestfulDataProviderDbQuery::getUniqueId public function Returns a unique id for a table record.
RestfulDataProviderDbQuery::index public function Get a list of entities. Overrides RestfulBase::index
RestfulDataProviderDbQuery::isPrimaryField function Checks if the current field is the primary field.
RestfulDataProviderDbQuery::mapDbRowToPublicFields public function Prepares the output array from the database row object. Overrides RestfulDataProviderDbQueryInterface::mapDbRowToPublicFields
RestfulDataProviderDbQuery::queryForListFilter protected function Filter the query for list.
RestfulDataProviderDbQuery::queryForListPagination protected function Set correct page (i.e. range) for the query for list.
RestfulDataProviderDbQuery::queryForListSort protected function Sort the query for list.
RestfulDataProviderDbQuery::remove public function Remove the item from the data source. Overrides RestfulBase::remove
RestfulDataProviderDbQuery::replace protected function Replace a record by another.
RestfulDataProviderDbQuery::setIdColumn public function Set the name of the column in the table to be used as the unique key.
RestfulDataProviderDbQuery::setPrimary public function
RestfulDataProviderDbQuery::setTableName public function Set the name of the table to query.
RestfulDataProviderDbQuery::update public function Update an item based on the request object. Overrides RestfulBase::update
RestfulDataProviderDbQuery::view public function View an item from the data source. Overrides RestfulBase::view
RestfulDataProviderDbQuery::viewMultiple public function View a collection of items. Overrides RestfulBase::viewMultiple
RestfulDataProviderDbQuery::__construct public function Constructs a RestfulDataProviderDbQuery object. Overrides RestfulBase::__construct
RestfulExampleNodeUserResource::getQuery protected function Overrides \RestfulDataProviderDbQuery::getQuery(). Overrides RestfulDataProviderDbQuery::getQuery
RestfulExampleNodeUserResource::publicFieldsInfo public function Return the properties that should be public. Overrides RestfulInterface::publicFieldsInfo
RestfulInterface::ACCESS_ALLOW constant Return this value from public field access callbacks to allow access.
RestfulInterface::ACCESS_DENY constant Return this value from public field access callbacks to deny access.
RestfulInterface::ACCESS_IGNORE constant Return this value from public field access callbacks to not affect access.
RestfulInterface::CONNECT constant
RestfulInterface::DELETE constant
RestfulInterface::GET constant HTTP methods.
RestfulInterface::HEAD constant
RestfulInterface::OPTIONS constant
RestfulInterface::PATCH constant
RestfulInterface::POST constant
RestfulInterface::PUT constant
RestfulInterface::TOKEN_VALUE constant Token value for token generation functions.
RestfulInterface::TRACE constant
RestfulPluginBase::$plugin protected property The plugin definition array.
RestfulPluginBase::getPlugin public function Gets information about the restful plugin. Overrides RestfulPluginInterface::getPlugin
RestfulPluginBase::getPluginKey public function Gets information about the restful plugin key. Overrides RestfulPluginInterface::getPluginKey
RestfulPluginBase::setPlugin public function Sets information about the restful plugin. Overrides RestfulPluginInterface::setPlugin
RestfulPluginBase::setPluginKey public function Gets information about the restful plugin key. Overrides RestfulPluginInterface::setPluginKey