You are here

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

class RestfulExampleArticlesResource__1_5 in RESTful 7

@file Contains RestfulExampleArticlesResource__1_5.

Hierarchy

Expanded class hierarchy of RestfulExampleArticlesResource__1_5

1 string reference to 'RestfulExampleArticlesResource__1_5'
articles__1_5.inc in modules/restful_example/plugins/restful/node/articles/1.5/articles__1_5.inc

File

modules/restful_example/plugins/restful/node/articles/1.5/RestfulExampleArticlesResource__1_5.class.php, line 8
Contains RestfulExampleArticlesResource__1_5.

View source 
class RestfulExampleArticlesResource__1_5 extends RestfulEntityBaseNode {

  /**
   * Overrides RestfulExampleArticlesResource::publicFieldsInfo().
   */
  public function publicFieldsInfo() {
    $public_fields = parent::publicFieldsInfo();
    $public_fields['body'] = array(
      'property' => 'body',
      'sub_property' => 'value',
    );
    $public_fields['tags'] = array(
      'property' => 'field_tags',
      'resource' => array(
        'tags' => 'tags',
      ),
    );
    $public_fields['image'] = array(
      'property' => 'field_image',
      'process_callbacks' => array(
        array(
          $this,
          'imageProcess',
        ),
      ),
      'image_styles' => array(
        'thumbnail',
        'medium',
        'large',
      ),
    );

    // By checking that the field exists, we allow re-using this class on
    // different tests, where different fields exist.
    if (field_info_field('field_images')) {
      $public_fields['images'] = array(
        'property' => 'field_images',
        'process_callbacks' => array(
          array(
            $this,
            'imageProcess',
          ),
        ),
        'image_styles' => array(
          'thumbnail',
          'medium',
          'large',
        ),
      );
    }
    $public_fields['user'] = array(
      'property' => 'author',
      'resource' => array(
        // The bundle of the entity.
        'user' => array(
          // The name of the resource to map to.
          'name' => 'users',
          // Determines if the entire resource should appear, or only the ID.
          'full_view' => TRUE,
        ),
      ),
    );
    $public_fields['static'] = array(
      'callback' => 'static::randomNumber',
    );
    return $public_fields;
  }

  /**
   * Process callback, Remove Drupal specific items from the image array.
   *
   * @param array $value
   *   The image array.
   *
   * @return array
   *   A cleaned image array.
   */
  protected function imageProcess($value) {
    if (static::isArrayNumeric($value)) {
      $output = array();
      foreach ($value as $item) {
        $output[] = $this
          ->imageProcess($item);
      }
      return $output;
    }
    return array(
      'id' => $value['fid'],
      'self' => file_create_url($value['uri']),
      'filemime' => $value['filemime'],
      'filesize' => $value['filesize'],
      'width' => $value['width'],
      'height' => $value['height'],
      'styles' => $value['image_styles'],
    );
  }

  /**
   * Callback, Generate a random number.
   *
   * @param \EntityMetadataWrapper $wrapper
   *   The EMW.
   *
   * @return int
   *   A random integer.
   */
  public static function randomNumber($wrapper) {
    return mt_rand();
  }

}

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::$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::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::isValidMethod public static function Determines if the HTTP method is one of the known methods.
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.
RestfulDataProviderEFQ::$bundle protected property The bundle.
RestfulDataProviderEFQ::$EFQClass protected property The bundle.
RestfulDataProviderEFQ::$entityType protected property The entity type.
RestfulDataProviderEFQ::addExtraInfoToQuery protected function Adds query tags and metadata to the EntityFieldQuery. Overrides RestfulBase::addExtraInfoToQuery
RestfulDataProviderEFQ::create public function Create an item from the request object. Overrides RestfulBase::create
RestfulDataProviderEFQ::defaultSortInfo public function Defines default sort fields if none are provided via the request URL. 1
RestfulDataProviderEFQ::EFQObject protected function Gets a EFQ object.
RestfulDataProviderEFQ::getBundle public function Getter for $bundle.
RestfulDataProviderEFQ::getColumnFromProperty protected function Get the DB column name from a property.
RestfulDataProviderEFQ::getEntityFieldQuery protected function Initialize an EntityFieldQuery (or extending class).
RestfulDataProviderEFQ::getEntityInfo public function Get the entity info for the current entity the endpoint handling. 1
RestfulDataProviderEFQ::getEntityType public function Getter for $entityType.
RestfulDataProviderEFQ::getTotalCount public function Get the total count of entities that match certain request. Overrides RestfulDataProviderEFQInterface::getTotalCount
RestfulDataProviderEFQ::index public function Get a list of entities. Overrides RestfulBase::index
RestfulDataProviderEFQ::isValidConjunctionForFilter protected static function Overrides \RestfulBase::isValidConjuctionForFilter(). Overrides RestfulBase::isValidConjunctionForFilter
RestfulDataProviderEFQ::isValidOperatorsForFilter protected static function Overrides \RestfulBase::isValidOperatorsForFilter(). Overrides RestfulBase::isValidOperatorsForFilter
RestfulDataProviderEFQ::queryForListFilter protected function Filter the query for list.
RestfulDataProviderEFQ::queryForListPagination protected function Set correct page (i.e. range) for the query for list.
RestfulDataProviderEFQ::queryForListSort protected function Sort the query for list.
RestfulDataProviderEFQ::remove public function Remove the item from the data source. Overrides RestfulBase::remove
RestfulDataProviderEFQ::update public function Update an item based on the request object. Overrides RestfulBase::update
RestfulDataProviderEFQ::view public function View an item from the data source. Overrides RestfulBase::view
RestfulDataProviderEFQ::viewMultiple public function View a collection of items. Overrides RestfulBase::viewMultiple
RestfulDataProviderEFQ::__construct public function Constructs a RestfulDataProviderEFQ object. Overrides RestfulBase::__construct 2
RestfulEntityBase::$publicFields protected property The public fields that are exposed to the API. Overrides RestfulBase::$publicFields
RestfulEntityBase::addDefaultValuesToPublicFields protected function Add default values to the public fields array. Overrides RestfulBase::addDefaultValuesToPublicFields
RestfulEntityBase::checkEntityAccess protected function Check access to CRUD an entity. 2
RestfulEntityBase::checkPropertyAccess protected function Check access on a property. 1
RestfulEntityBase::checkPropertyAccessByAccessCallbacks protected function Check access on property by the defined access callbacks.
RestfulEntityBase::clearResourceRenderedCacheEntity public function Clear all caches corresponding to the current resource for a given entity.
RestfulEntityBase::controllersInfo public static function Overrides \RestfulDataProviderEFQ::controllersInfo(). Overrides RestfulBase::controllersInfo 8
RestfulEntityBase::createEntity public function Create a new entity. Overrides RestfulDataProviderEFQ::createEntity 1
RestfulEntityBase::createEntityFromReference protected function Helper function; Create an entity from a a sub-resource.
RestfulEntityBase::createOrUpdateSubResourceItem protected function Create, update or return an already saved entity.
RestfulEntityBase::createOrUpdateSubResourceItems protected function Create, update or return a set of already saved entities.
RestfulEntityBase::deleteEntity public function Delete an entity using DELETE. Overrides RestfulDataProviderEFQ::deleteEntity
RestfulEntityBase::entityValidate public function Validate an entity before it is saved.
RestfulEntityBase::formSchemaHasAllowedValues protected function Determines if a field has allowed values.
RestfulEntityBase::getBundlesForAutocomplete protected function Return the bundles that should be used for the autocomplete search.
RestfulEntityBase::getEntityCacheTags public function The array of parameters by which entities should be cached.
RestfulEntityBase::getEntityIdByFieldId protected function Get the entity ID based on the ID provided in the request.
RestfulEntityBase::getEntitySelf protected function Get the "self" url.
RestfulEntityBase::getFieldInfoAndFormSchema protected function Get the field info, data and form element
RestfulEntityBase::getFormSchemaAllowedValues protected function Get allowed values for the form schema.
RestfulEntityBase::getImageUris public function Get the image URLs based on the configured image styles.
RestfulEntityBase::getList public function Get a list of entities. Overrides RestfulDataProviderEFQ::getList 2
RestfulEntityBase::getListForAutocomplete protected function Return the values of the types tags, with the ID.
RestfulEntityBase::getQueryForAutocomplete protected function Request the query object to get a list for autocomplete.
RestfulEntityBase::getQueryResultForAutocomplete protected function Returns the result of a query for the auto complete.
RestfulEntityBase::getTargetTypeFromEntityReference protected function Get the "target_type" property from an field or property reference.
RestfulEntityBase::getValueFromFieldFormatter protected function Get value from a field rendered by Drupal field API's formatter.
RestfulEntityBase::getValueFromProperty protected function Get value from a property.
RestfulEntityBase::getValueFromResource protected function Get value from an entity reference field with "resource" property.
RestfulEntityBase::isValidEntity protected function Determine if an entity is valid, and accessible.
RestfulEntityBase::patchEntity public function Update an entity using PATCH.
RestfulEntityBase::propertyIsField public static function Checks if a given string represents a Field API field.
RestfulEntityBase::propertyValuesPreprocess public function Massage the value to set according to the format expected by the wrapper.
RestfulEntityBase::propertyValuesPreprocessFile protected function Preprocess value for "File" related field types.
RestfulEntityBase::propertyValuesPreprocessReference protected function Pre-process value for "Entity reference" field types.
RestfulEntityBase::propertyValuesPreprocessText protected function Preprocess value for "Text" related field types.
RestfulEntityBase::putEntity public function Update an entity using PUT.
RestfulEntityBase::setPropertyValues protected function Set properties of the entity based on the request, and save the entity. 1
RestfulEntityBase::updateEntity protected function Update an entity. Overrides RestfulDataProviderEFQ::updateEntity
RestfulEntityBase::validateFields protected function Validates an entity's fields before they are saved.
RestfulEntityBase::viewEntities public function Get a list of entities based on a list of IDs. Overrides RestfulDataProviderEFQ::viewEntities
RestfulEntityBase::viewEntity public function View an entity. Overrides RestfulDataProviderEFQ::viewEntity
RestfulEntityBaseNode::entityPreSave public function Overrides RestfulEntityBase::entityPreSave(). Overrides RestfulEntityBase::entityPreSave
RestfulEntityBaseNode::getQueryCount public function Overrides RestfulEntityBase::getQueryCount(). Overrides RestfulDataProviderEFQ::getQueryCount
RestfulEntityBaseNode::getQueryForList public function Overrides RestfulEntityBase::getQueryForList(). Overrides RestfulDataProviderEFQ::getQueryForList
RestfulExampleArticlesResource__1_5::imageProcess protected function Process callback, Remove Drupal specific items from the image array.
RestfulExampleArticlesResource__1_5::publicFieldsInfo public function Overrides RestfulExampleArticlesResource::publicFieldsInfo(). Overrides RestfulEntityBase::publicFieldsInfo
RestfulExampleArticlesResource__1_5::randomNumber public static function Callback, Generate a random number.
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