summaryrefslogtreecommitdiff
path: root/includes/entity.inc
diff options
context:
space:
mode:
Diffstat (limited to 'includes/entity.inc')
-rw-r--r--includes/entity.inc19
1 files changed, 10 insertions, 9 deletions
diff --git a/includes/entity.inc b/includes/entity.inc
index 832abe2fd..2fefd5904 100644
--- a/includes/entity.inc
+++ b/includes/entity.inc
@@ -296,6 +296,7 @@ class DrupalDefaultEntityController implements DrupalEntityControllerInterface {
/**
* Attaches data to entities upon loading.
+ *
* This will attach fields, if the entity is fieldable. It calls
* hook_entity_load() for modules which need to add data to all entities.
* It also calls hook_TYPE_load() on the loaded entities. For example
@@ -415,13 +416,14 @@ class EntityFieldQueryException extends Exception {}
* an EntityFieldQueryException will be raised if an unsupported condition is
* specified or if the query has field conditions or sorts that are stored in
* different field storage engines. However, this logic can be overridden in
- * hook_entity_query().
+ * hook_entity_query_alter().
*
* Also note that this query does not automatically respect entity access
* restrictions. Node access control is performed by the SQL storage engine but
* other storage engines might not do this.
*/
class EntityFieldQuery {
+
/**
* Indicates that both deleted and non-deleted fields should be returned.
*
@@ -594,9 +596,7 @@ class EntityFieldQuery {
*
* 'bundle', 'revision_id' and 'entity_id' have no such restrictions.
*
- * Note: The "comment" and "taxonomy_term" entity types don't support bundle
- * conditions. For "taxonomy_term", propertyCondition('vid') can be used
- * instead.
+ * Note: The "comment" entity type does not support bundle conditions.
*
* @param $name
* 'entity_type', 'bundle', 'revision_id' or 'entity_id'.
@@ -958,7 +958,7 @@ class EntityFieldQuery {
}
/**
- * Enable a pager for the query.
+ * Enables a pager for the query.
*
* @param $limit
* An integer specifying the number of elements per page. If passed a false
@@ -986,10 +986,11 @@ class EntityFieldQuery {
}
/**
- * Enable sortable tables for this query.
+ * Enables sortable tables for this query.
*
* @param $headers
- * An EFQ Header array based on which the order clause is added to the query.
+ * An EFQ Header array based on which the order clause is added to the
+ * query.
*
* @return EntityFieldQuery
* The called object.
@@ -1272,7 +1273,7 @@ class EntityFieldQuery {
}
/**
- * Get the total number of results and initialize a pager for the query.
+ * Gets the total number of results and initializes a pager for the query.
*
* The pager can be disabled by either setting the pager limit to 0, or by
* setting this query to be a count query.
@@ -1359,6 +1360,6 @@ class EntityFieldQuery {
}
/**
- * Exception thrown when a malformed entity is passed.
+ * Defines an exception thrown when a malformed entity is passed.
*/
class EntityMalformedException extends Exception { }