updated to 7.x-1.11

includes/datasource_entity.inc

@@ -6,18 +6,12 @@
  */
 
 /**
- * Data source for all entities known to the Entity API.
+ * Represents a datasource for all entities known to the Entity API.
  */
 class SearchApiEntityDataSourceController extends SearchApiAbstractDataSourceController {
 
   /**
-   * Return information on the ID field for this controller's type.
-   *
-   * @return array
-   *   An associative array containing the following keys:
-   *   - key: The property key for the ID field, as used in the item wrapper.
-   *   - type: The type of the ID field. Has to be one of the types from
-   *     search_api_field_types(). List types ("list<*>") are not allowed.
+   * {@inheritdoc}
    */
   public function getIdFieldInfo() {
     $info = entity_get_info($this->entityType);
@@ -43,13 +37,7 @@ class SearchApiEntityDataSourceController extends SearchApiAbstractDataSourceCon
   }
 
   /**
-   * Load items of the type of this data source controller.
-   *
-   * @param array $ids
-   *   The IDs of the items to laod.
-   *
-   * @return array
-   *   The loaded items, keyed by ID.
+   * {@inheritdoc}
    */
   public function loadItems(array $ids) {
     $items = entity_load($this->entityType, $ids);
@@ -65,32 +53,14 @@ class SearchApiEntityDataSourceController extends SearchApiAbstractDataSourceCon
   }
 
   /**
-   * Get a metadata wrapper for the item type of this data source controller.
-   *
-   * @param $item
-   *   Unless NULL, an item of the item type for this controller to be wrapped.
-   * @param array $info
-   *   Optionally, additional information that should be used for creating the
-   *   wrapper. Uses the same format as entity_metadata_wrapper().
-   *
-   * @return EntityMetadataWrapper
-   *   A wrapper for the item type of this data source controller, according to
-   *   the info array, and optionally loaded with the given data.
-   *
-   * @see entity_metadata_wrapper()
+   * {@inheritdoc}
    */
   public function getMetadataWrapper($item = NULL, array $info = array()) {
     return entity_metadata_wrapper($this->entityType, $item, $info);
   }
 
   /**
-   * Get the unique ID of an item.
-   *
-   * @param $item
-   *   An item of this controller's type.
-   *
-   * @return
-   *   Either the unique ID of the item, or NULL if none is available.
+   * {@inheritdoc}
    */
   public function getItemId($item) {
     $id = entity_id($this->entityType, $item);
@@ -98,13 +68,7 @@ class SearchApiEntityDataSourceController extends SearchApiAbstractDataSourceCon
   }
 
   /**
-   * Get a human-readable label for an item.
-   *
-   * @param $item
-   *   An item of this controller's type.
-   *
-   * @return
-   *   Either a human-readable label for the item, or NULL if none is available.
+   * {@inheritdoc}
    */
   public function getItemLabel($item) {
     $label = entity_label($this->entityType, $item);
@@ -112,15 +76,7 @@ class SearchApiEntityDataSourceController extends SearchApiAbstractDataSourceCon
   }
 
   /**
-   * Get a URL at which the item can be viewed on the web.
-   *
-   * @param $item
-   *   An item of this controller's type.
-   *
-   * @return
-   *   Either an array containing the 'path' and 'options' keys used to build
-   *   the URL of the item, and matching the signature of url(), or NULL if the
-   *   item has no URL of its own.
+   * {@inheritdoc}
    */
   public function getItemUrl($item) {
     if ($this->entityType == 'file') {
@@ -137,18 +93,7 @@ class SearchApiEntityDataSourceController extends SearchApiAbstractDataSourceCon
   }
 
   /**
-   * Initialize tracking of the index status of items for the given indexes.
-   *
-   * All currently known items of this data source's type should be inserted
-   * into the tracking table for the given indexes, with status "changed". If
-   * items were already present, these should also be set to "changed" and not
-   * be inserted again.
-   *
-   * @param array $indexes
-   *   The SearchApiIndex objects for which item tracking should be initialized.
-   *
-   * @throws SearchApiDataSourceException
-   *   If any of the indexes doesn't use the same item type as this controller.
+   * {@inheritdoc}
    */
   public function startTracking(array $indexes) {
     if (!$this->table) {
@@ -190,14 +135,7 @@ class SearchApiEntityDataSourceController extends SearchApiAbstractDataSourceCon
   }
 
   /**
-   * Helper method that can be used by subclasses instead of implementing startTracking().
-   *
-   * Returns the IDs of all items that are known for this controller's type.
-   *
-   * Will be used when the entity type doesn't specify a "base table".
-   *
-   * @return array
-   *   An array containing all item IDs for this type.
+   * {@inheritdoc}
    */
   protected function getAllItemIds() {
     return array_keys(entity_load($this->entityType));