1: 2: 3: 4: 5: 6: 7: 8: 9: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: 20: 21: 22: 23: 24: 25: 26: 27: 28: 29: 30: 31: 32: 33: 34: 35: 36: 37: 38: 39: 40: 41: 42: 43: 44: 45: 46: 47: 48: 49: 50: 51: 52: 53: 54: 55: 56: 57: 58: 59: 60: 61: 62: 63: 64: 65: 66: 67: 68: 69: 70: 71: 72: 73: 74: 75: 76: 77: 78: 79: 80: 81: 82: 83: 84: 85: 86: 87: 88: 89: 90: 91: 92: 93: 94: 95: 96: 97: 98: 99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: 292: 293: 294: 295: 296: 297: 298: 299: 300: 301: 302: 303: 304: 305: 306: 307: 308: 309: 310: 311: 312: 313: 314: 315: 316: 317: 318: 319: 320: 321: 322: 323: 324: 325: 326: 327: 328: 329: 330: 331: 332: 333: 334: 335: 336: 337: 338: 339: 340: 341: 342: 343: 344: 345: 346: 347: 348: 349: 350: 351: 352: 353: 354: 355: 356: 357: 358: 359: 360: 361: 362: 363: 364: 365: 366: 367: 368: 369: 370: 371: 372: 373: 374: 375: 376: 377: 378: 379: 380: 381: 382: 383: 384: 385: 386: 387: 388: 389: 390: 391: 392: 393: 394: 395: 396: 397: 398: 399: 400: 401: 402: 403: 404: 405: 406: 407: 408: 409: 410: 411: 412: 413: 414: 415: 416: 417: 418: 419: 420: 421: 422: 423: 424: 425: 426: 427: 428: 429: 430: 431: 432: 433: 434: 435: 436: 437: 438: 439: 440: 441: 442: 443: 444: 445: 446: 447: 448: 449: 450: 451: 452: 453: 454: 455: 456: 457: 458: 459: 460: 461: 462: 463: 464: 465: 466: 467: 468: 469: 470: 471: 472: 473: 474: 475: 476: 477: 478: 479: 480: 481: 482: 483: 484: 485: 486: 487: 488: 489: 490: 491: 492: 493: 494: 495: 496: 497: 498: 499: 500: 501: 502: 503: 504: 505: 506: 507: 508: 509: 510: 511: 512: 513: 514: 515: 516: 517: 518: 519: 520: 521: 522: 523: 524: 525: 526: 527: 528: 529: 530: 531: 532: 533: 534: 535: 536: 537: 538: 539: 540: 541: 542: 543: 544: 545: 546: 547: 548: 549: 550: 551: 552: 553: 554: 555: 556: 557: 558: 559: 560: 561: 562: 563: 564: 565: 566: 567: 568: 569: 570: 571: 572: 573: 574: 575: 576: 577: 578: 579: 580: 581: 582: 583: 584: 585: 586: 587: 588: 589: 590: 591: 592: 593: 594: 595: 596: 597: 598: 599: 600: 601: 602: 603: 604: 605: 606: 607: 608: 609: 610: 611: 612: 613: 614: 615: 616: 617: 618: 619: 620: 621: 622: 623: 624: 625: 626: 627: 628: 629: 630: 631: 632: 633: 634: 635: 636: 637: 638: 639: 640: 641: 642: 643: 644: 645: 646: 647: 648: 649: 650: 651: 652: 653: 654: 655: 656: 657: 658: 659: 660: 661: 662: 663: 664: 665: 666: 667: 668: 669: 670: 671: 672: 673: 674: 675: 676: 677: 678: 679: 680: 681: 682: 683: 684: 685: 686: 687: 688: 689: 690: 691: 692: 693: 694: 695: 696: 697: 698: 699: 700: 701: 702: 703: 704: 705: 706: 707: 708: 709: 710: 711: 712: 713: 714: 715: 716: 717: 718: 719: 720: 721: 722: 723: 724: 725: 726: 727: 728: 729: 730: 731: 732: 733: 734: 735: 736: 737: 738: 739: 740: 741: 742: 743: 744: 745: 746: 747: 748: 749: 750: 751: 752: 753: 754: 755: 756: 757: 758: 759: 760: 761: 762: 763: 764: 765: 766: 767: 768: 769: 770: 771: 772: 773: 774: 775: 776: 777: 778: 779: 780: 781: 782: 783: 784: 785: 786: 787: 788: 789: 790: 791: 792: 793: <?php
namespace LeanCloud;
use LeanCloud\Client;
use LeanCloud\LeanObject;
/**
* Query representation for finding objects on LeanCloud
*/
class Query {
/**
* ClassName the query will operate on
*
* @var string
*/
private $className;
/**
* Keys of fields to include in query result
*
* @var array
*/
private $select;
/**
* Keys of (nested) object fields to include in query result
*
* @var array
*/
private $include;
/**
* Limit number of rows to return in query result
*
* @var int
*/
private $limit;
/**
* Skip number of rows to return in query result
*
* @var int
*/
private $skip;
/**
* Ordering for the query
*
* @var array
*/
private $order;
/**
* Extra option as query request params
*
* @var array
*/
private $extraOption;
/**
* Initilize query
*
* @param string $queryClass The class to operate on
*/
public function __construct($queryClass) {
if (is_string($queryClass)) {
$this->className = $queryClass;
} else if (is_subclass_of($queryClass, "LeanObject")) {
$this->className = $queryClass::$className;
} else {
throw new \InvalidArgumentException("Query class invalid.");
}
$this->where = array();
$this->select = array();
$this->include = array();
$this->order = array();
$this->limit = -1;
$this->skip = 0;
$this->extraOption = array();
}
/**
* Get className of the query
*
* @return string
*/
public function getClassName() {
return $this->className;
}
/**
* Add condition on field
*
* @param string $key Field key
* @param string $op Condition operator: $ne, $in, $all, $nin etc
* @param mixed $val Condition value(s)
*/
private function _addCondition($key, $op, $val) {
$this->where[$key][$op] = Client::encode($val);
}
/**
* Field equals to a value
*
* Equal-to condition is the strongest constraint overall, it has
* higher precedence than all other conditions. All prior
* conditions set on the field will be discarded and of no effect
* when adding an equal-to condition.
*
* @param string $key
* @param mixed $val
* @return self
*/
public function equalTo($key, $val) {
$this->where[$key] = Client::encode($val);
return $this;
}
/**
* Field does not equal to a value
*
* @param string $key
* @param mixed $val
* @return self
*/
public function notEqualTo($key, $val) {
$this->_addCondition($key, '$ne', $val);
return $this;
}
/**
* Field less than a value
*
* @param string $key
* @param mixed $val
* @return self
*/
public function lessThan($key, $val) {
$this->_addCondition($key, '$lt', $val);
return $this;
}
/**
* Field less than or equal to a value
*
* @param string $key
* @param mixed $val
* @return self
*/
public function lessThanOrEqualTo($key, $val) {
$this->_addCondition($key, '$lte', $val);
return $this;
}
/**
* Field greater than a value
*
* @param string $key
* @param mixed $val
* @return self
*/
public function greaterThan($key, $val) {
$this->_addCondition($key, '$gt', $val);
return $this;
}
/**
* Field greater than or equal to a vaule
*
* @param string $key
* @param mixed $val
* @return self
*/
public function greaterThanOrEqualTo($key, $val) {
$this->_addCondition($key, '$gte', $val);
return $this;
}
/**
* Field value is contained in an array
*
* @param string $key
* @param array $vals
* @return self
*/
public function containedIn($key, $vals) {
$this->_addCondition($key, '$in', $vals);
return $this;
}
/**
* Field value is not contained in an array
*
* @param string $key
* @param array $vals
* @return self
*/
public function notContainedIn($key, $vals) {
$this->_addCondition($key, '$nin', $vals);
return $this;
}
/**
* Field contains all values from an array
*
* @param string $key
* @param array $vals
* @return self
*/
public function containsAll($key, $vals) {
$this->_addCondition($key, '$all', $vals);
return $this;
}
/**
* Array field size equal to val
*
* @param string $key
* @param int $val
* @return self
*/
public function sizeEqualTo($key, $val) {
$this->_addCondition($key, '$size', $val);
return $this;
}
/**
* Field exists
*
* @param string $key
* @return self
*/
public function exists($key) {
$this->_addCondition($key, '$exists', true);
return $this;
}
/**
* Field not exists
*
* @param string $key
* @return self
*/
public function notExists($key) {
$this->_addCondition($key, '$exists', false);
return $this;
}
// String match
/**
* String field contains a (string) value
*
* It performs regex search on string fields, thus might be slow
* for large datasets.
*
* @param string $key
* @param string $val The substring to find
* @return self
*/
public function contains($key, $val) {
$this->_addCondition($key, '$regex', $val);
return $this;
}
/**
* String field starts with a (string) value
*
* It performs regex search on string fields, thus might be slow
* for large datasets.
*
* @param string $key
* @param string $val The start string
* @return self
*/
public function startsWith($key, $val) {
$this->_addCondition($key, '$regex', '^' . $val);
return $this;
}
/**
* String field ends with a (string) value
*
* It performs regex search on string fields, thus might be slow
* for large datasets.
*
* @param string $key
* @param string $val The end string
* @return self
*/
public function endsWith($key, $val) {
$this->_addCondition($key, '$regex', $val . '$' );
return $this;
}
/**
* String field matches a regular expression
*
* The regex string should not be enclosed with `/`, and modifiers
* must be provided via `$modifiers` argument.
*
* It performs regex search on string fields, thus might be slow
* for large datasets.
*
* @param string $key
* @param string $regex The pattern string
* @param string $modifiers (optional) Regexp modifiers: "i", "m" etc.
* @return self
*/
public function matches($key, $regex, $modifiers="") {
$this->_addCondition($key, '$regex', $regex);
if (!empty($modifiers)) {
$this->_addCondition($key, '$options', $modifiers);
}
return $this;
}
// end String match
// Sub query
/**
* Matches result objects returned from a sub-query
*
* @param string $key
* @param Query $query The sub-query
* @return self
*/
public function matchesInQuery($key, $query) {
$this->_addCondition($key, '$inQuery', array(
"where" => $query->where,
"className" => $query->getClassName()
));
return $this;
}
/**
* Not-match result objects returned from a sub-query
*
* @param string $key
* @param Query $query The sub-query
* @return self
*/
public function notMatchInQuery($key, $query) {
$this->_addCondition($key, '$notInQuery', array(
"where" => $query->where,
"className" => $query->getClassName()
));
return $this;
}
/**
* Matches values of specified field from a sub-query
*
* @param string $key
* @param string $queryKey Target field key in sub-query
* @param Query $query The sub-query
* @return self
*/
public function matchesFieldInQuery($key, $queryKey, $query) {
$this->_addCondition($key, '$select', array(
"key" => $queryKey,
"query" => array(
"where" => $query->where,
"className" => $query->getClassName()
)
));
return $this;
}
/**
* Not-match values of specified field from a sub-query
*
* @param string $key
* @param string $queryKey Target field key in sub-query
* @param Query $query The sub-query
* @return self
*/
public function notMatchFieldInQuery($key, $queryKey, $query) {
$this->_addCondition($key, '$dontSelect', array(
"key" => $queryKey,
"query" => array(
"where" => $query->where,
"className" => $query->getClassName()
)
));
return $this;
}
/**
* Relation field related to an object
*
* @param string $key A relation field key
* @param LeanObject $obj Target object to relate
* @return self
*/
public function relatedTo($key, $obj) {
$this->where['$relatedTo'] = array(
"key" => $key,
"object" => $obj->getPointer()
);
return $this;
}
// end Sub query
// GeoPoint query
/**
* Find objects near a geo point
*
* @param string $key Field key
* @param GeoPoint $point Center geo point
* @return self
*/
public function near($key, GeoPoint $point) {
$this->_addCondition($key, '$nearSphere', $point);
return $this;
}
/**
* Find objects within a sphere of point, in radians
*
* @param string $key Field key
* @param GeoPoint $point Center geo point
* @param number $distance Distance in radians
* @return self
*/
public function withinRadians($key, GeoPoint $point, $distance) {
$this->near($key, $point);
$this->_addCondition($key, '$maxDistanceInRadians', $distance);
return $this;
}
/**
* Find objects within a sphere of point, in kilometers
*
* @param string $key Field key
* @param GeoPoint $point Center geo point
* @param number $distance Distance in kilometers
* @return self
*/
public function withinKilometers($key, GeoPoint $point, $distance) {
$this->near($key, $point);
$this->_addCondition($key, '$maxDistanceInKilometers', $distance);
return $this;
}
/**
* Find objects within a sphere of point, in miles
*
* @param string $key Field key
* @param GeoPoint $point Center geo point
* @param number $distance Distance in miles
* @return self
*/
public function withinMiles($key, GeoPoint $point, $distance) {
$this->near($key, $point);
$this->_addCondition($key, '$maxDistanceInMiles', $distance);
return $this;
}
/**
* Find objects within a rectangle
*
* @param string $key Field key
* @param GeoPoint $southwest Geo point of southwest corner
* @param GeoPoint $northeast Geo point of northeast corner
* @return self
*/
public function withinBox($key, GeoPoint $southwest, GeoPoint $northeast) {
$this->_addCondition($key, '$within', array(
'$box' => array($southwest, $northeast)
));
return $this;
}
// End GeoPoint query
/**
* Specify fields to include in query result
*
* It accepts either one array of keys, or variable number of keys.
*
* @param string|array of string Field keys
* @return self
*/
public function select($keys) {
if (!is_array($keys)) {
$keys = func_get_args();
}
$this->select = array_merge($this->select, $keys);
return $this;
}
/**
* Include nested objects in query result
*
* Include nested object to return full object instead of
* pointer. It accepts an array of keys, or variable number of
* keys.
*
* Deep nested fields can be specified as dot separated field,
* e.g. `$commentQuery->include('post.author')` which will include
* author object in comment query result.
*
* @param string|array of string Field keys
* @return self
*/
public function _include($keys) {
if (!is_array($keys)) {
$keys = func_get_args();
}
$this->include = array_merge($this->include, $keys);
return $this;
}
/**
* Limit number of rows to return
*
* The default limit is 100, with a max of 1000 results being returned
* at a time.
*
* @param int $n Number of rows
* @return self
*/
public function limit($n) {
$this->limit = $n;
return $this;
}
/**
* Skip number of rows to return in the query
*
* The default is to skip at zero.
*
* @param int $n Number of rows to skip
* @return self
*/
public function skip($n) {
$this->skip = $n;
return $this;
}
/**
* Set ascending order on field
*
* Previous order constraints will be discarded.
*
* @param string $key
* @return self
*/
public function ascend($key) {
$this->order = array($key);
return $this;
}
/**
* Set descending order on field
*
* Previous order constraints will be discarded.
*
* @param string $key
* @return self
*/
public function descend($key) {
$this->order = array("-$key");
return $this;
}
/**
* Add ascending order on a field
*
* The previous ordering will have higher precedence over this one.
*
* @param string $key
* @return self
*/
public function addAscend($key) {
$this->order[] = $key;
return $this;
}
/**
* Add descending order on a field
*
* The previous ordering will have higher precedence over this one.
*
* @param string $key
* @return self
*/
public function addDescend($key) {
$this->order[] = "-$key";
return $this;
}
/**
* Compose AND/OR query from queries
*
* @param string $op Operator string, either `$and` or `$or`
* @param array $queries Array of Query
* @return Query
*/
private static function composeQuery($op, $queries) {
$className = $queries[0]->getClassName();
$conds = array(); // where conditions
forEach($queries as $q) {
if ($q->getClassName() != $className) {
throw new \RuntimeException("Query class incompatible.");
}
$conds[] = $q->where;
}
$query = new Query($className);
$query->where[$op] = $conds;
return $query;
}
/**
* Compose OR query from variable number of queries
*
* It accepts one array of LeanQueries, or variable number of
* LeanQueries.
*
* @param ...
* @return Query
*/
public static function orQuery($queries) {
if (!is_array($queries)) {
$queries = func_get_args();
}
return self::composeQuery('$or', $queries);
}
/**
* Compose AND query from variable number of queries
*
* It accepts one array of LeanQueries, or variable number of
* LeanQueries.
*
* @param ...
* @return Query
*/
public static function andQuery($queries) {
if (!is_array($queries)) {
$queries = func_get_args();
}
return self::composeQuery('$and', $queries);
}
/**
* Add extra option in query request
*
* Extra options will be appended as request params when
* sending query to cloud.
*
* @param string $key
* @param mixed $val
* @return self
*/
public function addOption($key, $val) {
$this->extraOption[$key] = $val;
return $this;
}
/**
* Encode query to JSON representation
*
* @return array
*/
public function encode() {
$out = array();
if (!empty($this->extraOption)) {
// extraOption has lower precedence than preserved query params
$out = $this->extraOption;
}
if (!empty($this->where)) {
$out["where"] = json_encode($this->where);
}
if (!empty($this->select)) {
$out["keys"] = implode(",", $this->select);
}
if (!empty($this->include)) {
$out["include"] = implode(",", $this->include);
}
if ($this->skip > 0) {
$out["skip"] = $this->skip;
}
if ($this->limit > -1) {
$out["limit"] = $this->limit;
}
if (!empty($this->order)) {
$out["order"] = implode(",", $this->order);
}
return $out;
}
/**
* Query object by id
*
* @param string $objectId
* @return LeanObject
*/
public function get($objectId) {
$this->equalTo('objectId', $objectId);
return $this->first();
}
/**
* Find the first object by the query
*
* @return LeanObject
*/
public function first() {
$objects = $this->find($this->skip, 1);
return empty($objects) ? null : $objects[0];
}
/**
* Find and return objects by the query
*
* The skip or limit provided here will have higher precedence
* than the ones specified by query's `skip` and `limit` methods.
* It does not mutate query.
*
* @param int $skip (optional) Number of rows to skip
* @param int $limit (optional) Max number of rows to fetch
* @return array
*/
public function find($skip=-1, $limit=-1) {
$params = $this->encode();
if ($skip >= 0) {
$params["skip"] = $skip;
}
if ($limit >= 0) {
$params["limit"] = $limit;
}
$resp = Client::get("/classes/{$this->getClassName()}", $params);
$objects = array();
forEach($resp["results"] as $props) {
$obj = LeanObject::create($this->getClassName());
$obj->mergeAfterFetch($props);
$objects[] = $obj;
}
return $objects;
}
/**
* Count number of objects by the query
*
* @return int
*/
public function count() {
$params = $this->encode();
$params["limit"] = 0;
$params["count"] = 1;
$resp = Client::get("/classes/{$this->getClassName()}", $params);
return $resp["count"];
}
/**
* Doing a CQL query to retrive objects
*
* It returns an array that contains:
*
* * className - Class name of the query
* * results - List of objects
* * count - Number of objects when it's a count query
*
* @param string $cql CQL statement
* @param array $pvalues Positional values to replace in CQL
* @return array
* @link https://leancloud.cn/docs/cql_guide.html
*/
public static function doCloudQuery($cql, $pvalues=array()) {
$data = array("cql" => $cql);
if (!empty($pvalues)) {
$data["pvalues"] = json_encode(Client::encode($pvalues));
}
$resp = Client::get('/cloudQuery', $data);
$objects = array();
forEach($resp["results"] as $val) {
$obj = LeanObject::create($resp["className"], $val["objectId"]);
$obj->mergeAfterFetch($val);
$objects[] = $obj;
}
$resp["results"] = $objects;
return $resp;
}
}