diff --git a/core/lib/Drupal/Core/Entity/Query/QueryInterface.php b/core/lib/Drupal/Core/Entity/Query/QueryInterface.php index 8a18e46..4c12997 100644 --- a/core/lib/Drupal/Core/Entity/Query/QueryInterface.php +++ b/core/lib/Drupal/Core/Entity/Query/QueryInterface.php @@ -74,7 +74,7 @@ public function getEntityTypeId(); * The value for $field. In most cases, this is a scalar and it's treated as * case-insensitive. For more complex operators, it is an array. The meaning * of each element in the array is dependent on $operator. - * @param string|null $operator + * @param $operator * Possible values: * - '=', '<>', '>', '>=', '<', '<=', 'STARTS_WITH', 'CONTAINS', * 'ENDS_WITH': These operators expect $value to be a literal of the @@ -83,7 +83,7 @@ public function getEntityTypeId(); * literals of the same type as the column. * - 'BETWEEN': This operator expects $value to be an array of two literals * of the same type as the column. - * @param string|null $langcode + * @param $langcode * Language code (optional). If omitted, any translation satisfies the * condition. However, if two or more conditions omit the langcode within * one condition group then they are presumed to apply to the same @@ -91,8 +91,7 @@ public function getEntityTypeId(); * and another does not they are not presumed to apply to the same * translation. * - * @return $this - * + * @return \Drupal\Core\Entity\Query\QueryInterface * @see \Drupal\Core\Entity\Query\andConditionGroup * @see \Drupal\Core\Entity\Query\orConditionGroup */ @@ -101,24 +100,22 @@ public function condition($field, $value = NULL, $operator = NULL, $langcode = N /** * Queries for a non-empty value on a field. * - * @param string $field + * @param $field * Name of a field. - * @param string|null $langcode + * @param $langcode * Language code (optional). - * - * @return $this + * @return \Drupal\Core\Entity\Query\QueryInterface */ public function exists($field, $langcode = NULL); /** * Queries for an empty field. * - * @param string $field. + * @param $field. * Name of a field. - * @param string|null $langcode + * @param $langcode * Language code (optional). - * - * @return $this + * @return \Drupal\Core\Entity\Query\QueryInterface */ public function notExists($field, $langcode = NULL); @@ -132,7 +129,8 @@ public function notExists($field, $langcode = NULL); * An optional integer to distinguish between multiple pagers on one page. * If not provided, one is automatically calculated. * - * @return $this + * @return \Drupal\Core\Entity\Query\QueryInterface + * The called object. */ public function pager($limit = 10, $element = NULL); @@ -140,29 +138,31 @@ public function pager($limit = 10, $element = NULL); * Defines the range of the query. * * @param int|null $start - * The first record from the result set to return. If NULL, removes any - * range directives that are set. + * (optional) The first record from the result set to return. If NULL, + * removes any range directives that are set. * @param int|null $length - * The maximum number of rows to return. If $start and $length are NULL, - * then a complete result set will be generated. If $start is not NULL and - * $length is NULL, then an empty result set will be generated. + * (optional) The maximum number of rows to return. If $start and $length + * are NULL, then a complete result set will be generated. If $start is + * not NULL and $length is NULL, then an empty result set will be + * generated. * - * @return $this + * @return \Drupal\Core\Entity\Query\QueryInterface + * The called object. */ public function range($start = NULL, $length = NULL); /** * Sorts the result set by a given field. * - * @param string $field - * Name of a field on which to sort. + * @param $field + * Name of a field. * @param string $direction * The direction to sort. Legal values are "ASC" and "DESC". * Any other value will be converted to "ASC". - * @param string|null $langcode + * @param $langcode * Language code (optional). - * - * @return $this + * @return \Drupal\Core\Entity\Query\QueryInterface + * The called object. */ public function sort($field, $direction = 'ASC', $langcode = NULL); @@ -171,7 +171,8 @@ public function sort($field, $direction = 'ASC', $langcode = NULL); * * For count queries, execute() returns the number entities found. * - * @return $this + * @return \Drupal\Core\Entity\Query\QueryInterface + * The called object. */ public function count(); @@ -184,7 +185,8 @@ public function count(); * specify what to sort on. This can be an entity or a field as described * in condition(). * - * @return $this + * @return \Drupal\Core\Entity\Query\QueryInterface + * The called object. */ public function tableSort(&$headers); @@ -192,9 +194,10 @@ public function tableSort(&$headers); * Enables or disables access checking for this query. * * @param bool $access_check - * Whether access check is requested or not. Defaults to TRUE. + * (optional) Whether access check is requested or not. Defaults to TRUE. * - * @return $this + * @return \Drupal\Core\Entity\Query\QueryInterface + * The called object. */ public function accessCheck($access_check = TRUE); @@ -230,7 +233,7 @@ public function execute(); * @return \Drupal\Core\Entity\Query\ConditionInterface * A condition object whose conditions will be combined with AND. */ - public function andConditionGroup(); + public function andConditionGroup(); /** * Creates a new group of conditions ORed together.