bachir/materio-base-d7
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

updated to 7.x-1.11

Browse Source
This commit is contained in:
Bachir Soussi Chiadmi
2014-02-07 10:01:18 +01:00
parent a30917d1d2
commit cf03e9ca52
69 changed files with 4629 additions and 1557 deletions
Download Patch File Download Diff File Expand all files Collapse all files
includes/datasource.inc
+110 -199
View File
@@ -18,46 +18,49 @@
* aware that indexes' numerical IDs can change due to feature reverts. It is
* therefore recommended to use search_api_index_update_datasource(), or similar
* code, in a hook_search_api_index_update() implementation.
*
* All methods of the data source may throw exceptions of type
* SearchApiDataSourceException if any exception or error state is encountered.
*/
interface SearchApiDataSourceControllerInterface {
/**
* Constructor for a data source controller.
* Constructs a new data source controller.
*
* @param $type
* @param string $type
* The item type for which this controller is created.
*/
public function __construct($type);
/**
* Return information on the ID field for this controller's type.
* Returns 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.
*
* @throws SearchApiDataSourceException
* If any error state was encountered.
*/
public function getIdFieldInfo();
/**
* Load items of the type of this data source controller.
* Loads 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.
*
* @throws SearchApiDataSourceException
* If any error state was encountered.
*/
public function loadItems(array $ids);
/**
* Get a metadata wrapper for the item type of this data source controller.
* Creates a metadata wrapper for this datasource controller's type.
*
* @param $item
* @param mixed $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
@@ -67,151 +70,170 @@ interface SearchApiDataSourceControllerInterface {
* A wrapper for the item type of this data source controller, according to
* the info array, and optionally loaded with the given data.
*
* @throws SearchApiDataSourceException
* If any error state was encountered.
*
* @see entity_metadata_wrapper()
*/
public function getMetadataWrapper($item = NULL, array $info = array());
/**
* Get the unique ID of an item.
* Retrieves the unique ID of an item.
*
* @param $item
* @param mixed $item
* An item of this controller's type.
*
* @return
* @return mixed
* Either the unique ID of the item, or NULL if none is available.
*
* @throws SearchApiDataSourceException
* If any error state was encountered.
*/
public function getItemId($item);
/**
* Get a human-readable label for an item.
* Retrieves a human-readable label for an item.
*
* @param $item
* @param mixed $item
* An item of this controller's type.
*
* @return
* @return string|null
* Either a human-readable label for the item, or NULL if none is available.
*
* @throws SearchApiDataSourceException
* If any error state was encountered.
*/
public function getItemLabel($item);
/**
* Get a URL at which the item can be viewed on the web.
* Retrieves a URL at which the item can be viewed on the web.
*
* @param $item
* @param mixed $item
* An item of this controller's type.
*
* @return
* @return array|null
* 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.
*
* @throws SearchApiDataSourceException
* If any error state was encountered.
*/
public function getItemUrl($item);
/**
* Initialize tracking of the index status of items for the given indexes.
* Initializes 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
* @param SearchApiIndex[] $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.
* If any error state was encountered.
*/
public function startTracking(array $indexes);
/**
* Stop tracking of the index status of items for the given indexes.
* Stops tracking of the index status of items for the given indexes.
*
* The tracking tables of the given indexes should be completely cleared.
*
* @param array $indexes
* @param SearchApiIndex[] $indexes
* The SearchApiIndex objects for which item tracking should be stopped.
*
* @throws SearchApiDataSourceException
* If any of the indexes doesn't use the same item type as this controller.
* If any error state was encountered.
*/
public function stopTracking(array $indexes);
/**
* Start tracking the index status for the given items on the given indexes.
* Starts tracking the index status for the given items on the given indexes.
*
* @param array $item_ids
* The IDs of new items to track.
* @param array $indexes
* @param SearchApiIndex[] $indexes
* The indexes for which items should be tracked.
*
* @throws SearchApiDataSourceException
* If any of the indexes doesn't use the same item type as this controller.
* If any error state was encountered.
*/
public function trackItemInsert(array $item_ids, array $indexes);
/**
* Set the tracking status of the given items to "changed"/"dirty".
* Sets the tracking status of the given items to "changed"/"dirty".
*
* Unless $dequeue is set to TRUE, this operation is ignored for items whose
* status is not "indexed".
*
* @param $item_ids
* @param array|false $item_ids
* Either an array with the IDs of the changed items. Or FALSE to mark all
* items as changed for the given indexes.
* @param array $indexes
* @param SearchApiIndex[] $indexes
* The indexes for which the change should be tracked.
* @param $dequeue
* If set to TRUE, also change the status of queued items.
* @param bool $dequeue
* (deprecated) If set to TRUE, also change the status of queued items.
* The concept of queued items will be removed in the Drupal 8 version of
* this module.
*
* @throws SearchApiDataSourceException
* If any of the indexes doesn't use the same item type as this controller.
* If any error state was encountered.
*/
public function trackItemChange($item_ids, array $indexes, $dequeue = FALSE);
/**
* Set the tracking status of the given items to "queued".
* Sets the tracking status of the given items to "queued".
*
* Queued items are not marked as "dirty" even when they are changed, and they
* are not returned by the getChangedItems() method.
*
* @param $item_ids
* @param array|false $item_ids
* Either an array with the IDs of the queued items. Or FALSE to mark all
* items as queued for the given indexes.
* @param SearchApiIndex $index
* The index for which the items were queued.
*
* @throws SearchApiDataSourceException
* If any of the indexes doesn't use the same item type as this controller.
* If any error state was encountered.
*
* @deprecated
* As of Search API 1.10, the cron queue is not used for indexing anymore,
* therefore this method has become useless. It will be removed in the
* Drupal 8 version of this module.
*/
public function trackItemQueued($item_ids, SearchApiIndex $index);
/**
* Set the tracking status of the given items to "indexed".
* Sets the tracking status of the given items to "indexed".
*
* @param array $item_ids
* The IDs of the indexed items.
* @param SearchApiIndex $indexes
* @param SearchApiIndex $index
* The index on which the items were indexed.
*
* @throws SearchApiDataSourceException
* If the index doesn't use the same item type as this controller.
* If any error state was encountered.
*/
public function trackItemIndexed(array $item_ids, SearchApiIndex $index);
/**
* Stop tracking the index status for the given items on the given indexes.
* Stops tracking the index status for the given items on the given indexes.
*
* @param array $item_ids
* The IDs of the removed items.
* @param array $indexes
* @param SearchApiIndex[] $indexes
* The indexes for which the deletions should be tracked.
*
* @throws SearchApiDataSourceException
* If any of the indexes doesn't use the same item type as this controller.
* If any error state was encountered.
*/
public function trackItemDelete(array $item_ids, array $indexes);
/**
* Get a list of items that need to be indexed.
* Retrieves a list of items that need to be indexed.
*
* If possible, completely unindexed items should be returned before items
* that were indexed but later changed. Also, items that were changed longer
@@ -219,16 +241,19 @@ interface SearchApiDataSourceControllerInterface {
*
* @param SearchApiIndex $index
* The index for which changed items should be returned.
* @param $limit
* @param int $limit
* The maximum number of items to return. Negative values mean "unlimited".
*
* @return array
* The IDs of items that need to be indexed for the given index.
*
* @throws SearchApiDataSourceException
* If any error state was encountered.
*/
public function getChangedItems(SearchApiIndex $index, $limit = -1);
/**
* Get information on how many items have been indexed for a certain index.
* Retrieves information on how many items have been indexed for a certain index.
*
* @param SearchApiIndex $index
* The index whose index status should be returned.
@@ -240,22 +265,26 @@ interface SearchApiDataSourceControllerInterface {
* index.
*
* @throws SearchApiDataSourceException
* If the index doesn't use the same item type as this controller.
* If any error state was encountered.
*/
public function getIndexStatus(SearchApiIndex $index);
/**
* Get the entity type of items from this datasource.
* Retrieves the entity type of items from this datasource.
*
* @return string|null
* An entity type string if the items provided by this datasource are
* entities; NULL otherwise.
*
* @throws SearchApiDataSourceException
* If any error state was encountered.
*/
public function getEntityType();
}
/**
* Default base class for the SearchApiDataSourceControllerInterface.
* Provides a default base class for datasource controllers.
*
* Contains default implementations for a number of methods which will be
* similar for most data sources. Concrete data sources can decide to extend
@@ -330,10 +359,7 @@ abstract class SearchApiAbstractDataSourceController implements SearchApiDataSou
protected $changedColumn = 'changed';
/**
* Constructor for a data source controller.
*
* @param $type
* The item type for which this controller is created.
* {@inheritdoc}
*/
public function __construct($type) {
$this->type = $type;
@@ -345,30 +371,14 @@ abstract class SearchApiAbstractDataSourceController implements SearchApiDataSou
}
/**
* Get the entity type of items from this datasource.
*
* @return string|null
* An entity type string if the items provided by this datasource are
* entities; NULL otherwise.
* {@inheritdoc}
*/
public function getEntityType() {
return $this->entityType;
}
/**
* 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()) {
$info += $this->getPropertyInfo();
@@ -376,7 +386,7 @@ abstract class SearchApiAbstractDataSourceController implements SearchApiDataSou
}
/**
* Get the property info for this item type.
* Retrieves the property info for this item type.
*
* This is a helper method for getMetadataWrapper() that can be used by
* subclasses to specify the property information to use when creating a
@@ -384,7 +394,7 @@ abstract class SearchApiAbstractDataSourceController implements SearchApiDataSou
*
* The data structure uses largely the format specified in
* hook_entity_property_info(). However, the first level of keys (containing
* the entity types) is omitted, and the "property" key is called
* the entity types) is omitted, and the "properties" key is called
* "property info" instead. So, an example return value would look like this:
*
* @code
@@ -413,6 +423,9 @@ abstract class SearchApiAbstractDataSourceController implements SearchApiDataSou
* @return array
* Property information as specified by entity_metadata_wrapper().
*
* @throws SearchApiDataSourceException
* If any error state was encountered.
*
* @see getMetadataWrapper()
* @see hook_entity_property_info()
*/
@@ -425,13 +438,7 @@ abstract class SearchApiAbstractDataSourceController implements SearchApiDataSou
}
/**
* 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_info = $this->getIdFieldInfo();
@@ -445,13 +452,7 @@ abstract class SearchApiAbstractDataSourceController implements SearchApiDataSou
}
/**
* 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 = $this->getMetadataWrapper($item)->label();
@@ -459,33 +460,14 @@ abstract class SearchApiAbstractDataSourceController implements SearchApiDataSou
}
/**
* 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) {
return NULL;
}
/**
* 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) {
@@ -499,27 +481,23 @@ abstract class SearchApiAbstractDataSourceController implements SearchApiDataSou
}
/**
* 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.
*
* Helper method that can be used by subclasses instead of implementing
* startTracking().
*
* @return array
* An array containing all item IDs for this type.
*
* @throws SearchApiDataSourceException
* If any error state was encountered.
*/
protected function getAllItemIds() {
throw new SearchApiDataSourceException(t('Items not known for type @type.', array('@type' => $this->type)));
}
/**
* Stop tracking of the index status of items for the given indexes.
*
* The tracking tables of the given indexes should be completely cleared.
*
* @param array $indexes
* The SearchApiIndex objects for which item tracking should be stopped.
*
* @throws SearchApiDataSourceException
* If any of the indexes doesn't use the same item type as this controller.
* {@inheritdoc}
*/
public function stopTracking(array $indexes) {
if (!$this->table) {
@@ -529,22 +507,14 @@ abstract class SearchApiAbstractDataSourceController implements SearchApiDataSou
// will mostly be called with only one index.
foreach ($indexes as $index) {
$this->checkIndex($index);
$query = db_delete($this->table)
db_delete($this->table)
->condition($this->indexIdColumn, $index->id)
->execute();
}
}
/**
* Start tracking the index status for the given items on the given indexes.
*
* @param array $item_ids
* The IDs of new items to track.
* @param array $indexes
* The indexes for which items should be tracked.
*
* @throws SearchApiDataSourceException
* If any of the indexes doesn't use the same item type as this controller.
* {@inheritdoc}
*/
public function trackItemInsert(array $item_ids, array $indexes) {
if (!$this->table) {
@@ -571,21 +541,7 @@ abstract class SearchApiAbstractDataSourceController implements SearchApiDataSou
}
/**
* Set the tracking status of the given items to "changed"/"dirty".
*
* Unless $dequeue is set to TRUE, this operation is ignored for items whose
* status is not "indexed".
*
* @param $item_ids
* Either an array with the IDs of the changed items. Or FALSE to mark all
* items as changed for the given indexes.
* @param array $indexes
* The indexes for which the change should be tracked.
* @param $dequeue
* If set to TRUE, also change the status of queued items.
*
* @throws SearchApiDataSourceException
* If any of the indexes doesn't use the same item type as this controller.
* {@inheritdoc}
*/
public function trackItemChange($item_ids, array $indexes, $dequeue = FALSE) {
if (!$this->table) {
@@ -609,21 +565,10 @@ abstract class SearchApiAbstractDataSourceController implements SearchApiDataSou
}
/**
* Set the tracking status of the given items to "queued".
*
* Queued items are not marked as "dirty" even when they are changed, and they
* are not returned by the getChangedItems() method.
*
* @param $item_ids
* Either an array with the IDs of the queued items. Or FALSE to mark all
* items as queued for the given indexes.
* @param SearchApiIndex $index
* The index for which the items were queued.
*
* @throws SearchApiDataSourceException
* If any of the indexes doesn't use the same item type as this controller.
* {@inheritdoc}
*/
public function trackItemQueued($item_ids, SearchApiIndex $index) {
$this->checkIndex($index);
if (!$this->table) {
return;
}
@@ -639,15 +584,7 @@ abstract class SearchApiAbstractDataSourceController implements SearchApiDataSou
}
/**
* Set the tracking status of the given items to "indexed".
*
* @param array $item_ids
* The IDs of the indexed items.
* @param SearchApiIndex $indexes
* The index on which the items were indexed.
*
* @throws SearchApiDataSourceException
* If the index doesn't use the same item type as this controller.
* {@inheritdoc}
*/
public function trackItemIndexed(array $item_ids, SearchApiIndex $index) {
if (!$this->table) {
@@ -664,15 +601,7 @@ abstract class SearchApiAbstractDataSourceController implements SearchApiDataSou
}
/**
* Stop tracking the index status for the given items on the given indexes.
*
* @param array $item_ids
* The IDs of the removed items.
* @param array $indexes
* The indexes for which the deletions should be tracked.
*
* @throws SearchApiDataSourceException
* If any of the indexes doesn't use the same item type as this controller.
* {@inheritdoc}
*/
public function trackItemDelete(array $item_ids, array $indexes) {
if (!$this->table) {
@@ -690,19 +619,7 @@ abstract class SearchApiAbstractDataSourceController implements SearchApiDataSou
}
/**
* Get a list of items that need to be indexed.
*
* If possible, completely unindexed items should be returned before items
* that were indexed but later changed. Also, items that were changed longer
* ago should be favored.
*
* @param SearchApiIndex $index
* The index for which changed items should be returned.
* @param $limit
* The maximum number of items to return. Negative values mean "unlimited".
*
* @return array
* The IDs of items that need to be indexed for the given index.
* {@inheritdoc}
*/
public function getChangedItems(SearchApiIndex $index, $limit = -1) {
if ($limit == 0) {
@@ -721,16 +638,7 @@ abstract class SearchApiAbstractDataSourceController implements SearchApiDataSou
}
/**
* Get information on how many items have been indexed for a certain index.
*
* @param SearchApiIndex $index
* The index whose index status should be returned.
*
* @return array
* An associative array containing two keys (in this order):
* - indexed: The number of items already indexed in their latest version.
* - total: The total number of items that have to be indexed for this
* index.
* {@inheritdoc}
*/
public function getIndexStatus(SearchApiIndex $index) {
if (!$this->table) {
@@ -752,13 +660,16 @@ abstract class SearchApiAbstractDataSourceController implements SearchApiDataSou
}
/**
* Helper method for ensuring that an index uses the same item type as this controller.
* Checks whether the given index is valid for this datasource controller.
*
* Helper method used by various methods in this class. By default only checks
* whether the types match.
*
* @param SearchApiIndex $index
* The index to check.
*
* @throws SearchApiDataSourceException
* If the index doesn't use the same type as this controller.
* If the index doesn't fit to this datasource controller.
*/
protected function checkIndex(SearchApiIndex $index) {
if ($index->item_type != $this->type) {