Project

General

Profile

Revision b0dc3a2e

Added by Julien Enselme over 7 years ago

Update to Drupal 7.52

View differences:

drupal7/includes/entity.inc
446 446
 *
447 447
 * This class allows finding entities based on entity properties (for example,
448 448
 * node->changed), field values, and generic entity meta data (bundle,
449
 * entity type, entity id, and revision ID). It is not possible to query across
449
 * entity type, entity ID, and revision ID). It is not possible to query across
450 450
 * multiple entity types. For example, there is no facility to find published
451 451
 * nodes written by users created in the last hour, as this would require
452 452
 * querying both node->status and user->created.
......
688 688
   * @param $field
689 689
   *   Either a field name or a field array.
690 690
   * @param $column
691
   *   The column that should hold the value to be matched.
691
   *   The column that should hold the value to be matched, defined in the
692
   *   hook_field_schema() of this field. If this is omitted then all of the
693
   *   other parameters are ignored, except $field, and this call will just be
694
   *   adding a condition that says that the field has a value, rather than
695
   *   testing the value itself.
692 696
   * @param $value
693
   *   The value to test the column value against.
697
   *   The value to test the column value against. In most cases, this is a
698
   *   scalar. For more complex options, it is an array. The meaning of each
699
   *   element in the array is dependent on $operator.
694 700
   * @param $operator
695
   *   The operator to be used to test the given value.
701
   *   The operator to be used to test the given value. The possible values are:
702
   *   - '=', '<>', '>', '>=', '<', '<=', 'STARTS_WITH', 'CONTAINS': These
703
   *     operators expect $value to be a literal of the same type as the
704
   *     column.
705
   *   - 'IN', 'NOT IN': These operators expect $value to be an array of
706
   *     literals of the same type as the column.
707
   *   - 'BETWEEN': This operator expects $value to be an array of two literals
708
   *     of the same type as the column.
709
   *   The operator can be omitted, and will default to 'IN' if the value is an
710
   *   array, or to '=' otherwise.
696 711
   * @param $delta_group
697 712
   *   An arbitrary identifier: conditions in the same group must have the same
698
   *   $delta_group.
713
   *   $delta_group. For example, let's presume a multivalue field which has
714
   *   two columns, 'color' and 'shape', and for entity ID 1, there are two
715
   *   values: red/square and blue/circle. Entity ID 1 does not have values
716
   *   corresponding to 'red circle'; however if you pass 'red' and 'circle' as
717
   *   conditions, it will appear in the results -- by default queries will run
718
   *   against any combination of deltas. By passing the conditions with the
719
   *   same $delta_group it will ensure that only values attached to the same
720
   *   delta are matched, and entity 1 would then be excluded from the results.
699 721
   * @param $language_group
700 722
   *   An arbitrary identifier: conditions in the same group must have the same
701 723
   *   $language_group.
......
770 792
   * @param $field
771 793
   *   Either a field name or a field array.
772 794
   * @param $column
773
   *   A column defined in the hook_field_schema() of this field. If this is
774
   *   omitted then the query will find only entities that have data in this
775
   *   field, using the entity and property conditions if there are any.
795
   *   The column that should hold the value to be matched, defined in the
796
   *   hook_field_schema() of this field. If this is omitted then all of the
797
   *   other parameters are ignored, except $field, and this call will just be
798
   *   adding a condition that says that the field has a value, rather than
799
   *   testing the value itself.
776 800
   * @param $value
777 801
   *   The value to test the column value against. In most cases, this is a
778 802
   *   scalar. For more complex options, it is an array. The meaning of each
......
791 815
   * @param $delta_group
792 816
   *   An arbitrary identifier: conditions in the same group must have the same
793 817
   *   $delta_group. For example, let's presume a multivalue field which has
794
   *   two columns, 'color' and 'shape', and for entity id 1, there are two
818
   *   two columns, 'color' and 'shape', and for entity ID 1, there are two
795 819
   *   values: red/square and blue/circle. Entity ID 1 does not have values
796 820
   *   corresponding to 'red circle', however if you pass 'red' and 'circle' as
797
   *   conditions, it will appear in the  results - by default queries will run
821
   *   conditions, it will appear in the results -- by default queries will run
798 822
   *   against any combination of deltas. By passing the conditions with the
799 823
   *   same $delta_group it will ensure that only values attached to the same
800 824
   *   delta are matched, and entity 1 would then be excluded from the results.

Also available in: Unified diff