Class ParseQuery - Handles querying data from Parse.
| author |
Fosco Marotto [email protected] |
|---|---|
| package |
Parse |
__construct(mixed $className)
mixedClass Name of data on Parse.
_and(array $queries) : \Parse\ParseQuery
arrayThe list of queries to OR.
\Parse\ParseQueryReturns the query, so you can chain this call.
_getOptions() : array
array
_matchClassname(array $queryObjects) : string
| Throws |
|
|---|
arrayArray of ParseQuery objects.
stringclass name.
_mergeQueries(string $key, array $queries) : \Parse\ParseQuery
stringThe condition $and, $or, $nor.
arrayThe list of queries to combine.
\Parse\ParseQueryReturns the query, so you can chain this call.
_nor(array $queries) : \Parse\ParseQuery
arrayThe list of queries to NOR.
\Parse\ParseQueryReturns the query, so you can chain this call.
_or(array $queries) : \Parse\ParseQuery
arrayThe list of queries to OR.
\Parse\ParseQueryReturns the query, so you can chain this call.
_setConditions(array $conditions)
| Throws |
|
|---|
arrayArray of Conditions to set
addAscending(mixed $key) : \Parse\ParseQuery
mixedKey(s) to sort by, which is a string or an array of strings.
\Parse\ParseQueryReturns this query, so you can chain this call.
addCondition(string $key, string $condition, mixed $value)
| Throws |
|
|---|
stringThe key to where constraints
stringThe condition name
mixedThe condition value, can be a string or an array of strings
addDescending(mixed $key) : \Parse\ParseQuery
mixedKey(s) to sort by, which is a string or an array of strings.
\Parse\ParseQueryReturns this query, so you can chain this call.
aggregate(array $pipeline) : array
arraystages to process query
array
andQueries(array $queryObjects) : \Parse\ParseQuery
All queries must have same class name.
| Throws |
|
|---|
arrayArray of ParseQuery objects to AND.
\Parse\ParseQueryThe query that is the AND of the passed in queries.
ascending(mixed $key) : \Parse\ParseQuery
mixedKey(s) to sort by, which is a string or an array of strings.
\Parse\ParseQueryReturns this query, so you can chain this call.
buildQueryString(array $queryOptions) : string
arrayAssociative array of the query constraints.
stringQuery string.
containedBy(string $key, mixed $value) : \Parse\ParseQuery
stringThe key to check.
mixedThe values that will match.
\Parse\ParseQueryReturns this query, so you can chain this call.
containedIn(string $key, array $values) : \Parse\ParseQuery
stringThe key to check.
arrayThe values that will match.
\Parse\ParseQueryReturns the query, so you can chain this call.
contains(string $key, mixed $value) : \Parse\ParseQuery
stringThe key to check.
mixedThe substring that the value must contain.
\Parse\ParseQueryReturns this query, so you can chain this call.
containsAll(string $key, array $values) : \Parse\ParseQuery
stringThe key to check. This key's value must be an array.
arrayThe values that will match.
\Parse\ParseQueryReturns the query, so you can chain this call.
containsAllStartingWith(string $key, array $values) : \Parse\ParseQuery
stringThe key to check. This key's value must be an array.
arrayThe values that will match as starting string.
\Parse\ParseQueryReturns the query, so you can chain this call.
count(boolean $useMasterKey = false) : integer
booleanIf the query should use the master key
integer
descending(mixed $key) : \Parse\ParseQuery
mixedKey(s) to sort by, which is a string or an array of strings.
\Parse\ParseQueryReturns this query, so you can chain this call.
distinct(string $key) : array
stringfield to find distinct values
array
doesNotExist(string $key) : \Parse\ParseQuery
stringThe key that should not exist.
\Parse\ParseQueryReturns the query, so you can chain this call.
doesNotMatchKeyInQuery(string $key, string $queryKey, \Parse\ParseQuery $query) : \Parse\ParseQuery
stringThe key that contains teh value that is being excluded.
stringThe key in objects returned by the query to match against.
\Parse\ParseQueryReturns the query, so you can chain this call.
doesNotMatchQuery(string $key, \Parse\ParseQuery $query) : \Parse\ParseQuery
stringThe key that the contains the object not to match the query.
\Parse\ParseQueryReturns the query, so you can chain this call.
each(callable $callback, boolean $useMasterKey = false, integer $batchSize = 100)
| Throws |
|
|---|
callableCallback that will be called with each result of the query.
boolean
integer
endsWith(string $key, mixed $value) : \Parse\ParseQuery
stringThe key to check.
mixedThe substring that the value must end with.
\Parse\ParseQueryReturns this query, so you can chain this call.
equalTo(string $key, mixed $value) : \Parse\ParseQuery
stringKey to set up an equals constraint.
mixedValue the key must equal.
\Parse\ParseQueryReturns this query, so you can chain this call.
excludeKey(mixed $key) : \Parse\ParseQuery
(Requires Parse Server 3.6.0+)
mixedThe name(s) of the key(s) to exclude. It could be string, or an Array of string.
\Parse\ParseQueryReturns the query, so you can chain this call.
exists(string $key) : \Parse\ParseQuery
stringThe key that should exist.
\Parse\ParseQueryReturns the query, so you can chain this call.
find(boolean $useMasterKey = false, boolean $decodeObjects = true) : array<mixed,\Parse\ParseObject>
boolean
booleanIf set to false, will return raw data instead of ParseObject instances
array<mixed,\Parse\ParseObject>
first(boolean $useMasterKey = false, boolean $decodeObjects = true) : array|\Parse\ParseObject
booleanIf the query should use the master key
booleanIf set to false, will return raw data instead of ParseObject instances
array|\Parse\ParseObjectReturns the first object or an empty array
fullText(string $key, mixed $value) : \Parse\ParseQuery
stringThe key to check.
mixedThe substring that the value must contain.
\Parse\ParseQueryReturns this query, so you can chain this call.
get(string $objectId, boolean $useMasterKey = false) : array|\Parse\ParseObject
| Throws |
|
|---|
stringUnique object id to retrieve.
booleanIf the query should use the master key
array|\Parse\ParseObjectReturns the selected object or an empty array
greaterThan(string $key, mixed $value) : \Parse\ParseQuery
stringThe key to check.
mixedThe value that provides an Lower bound.
\Parse\ParseQueryReturns this query, so you can chain this call.
greaterThanOrEqualTo(string $key, mixed $value) : \Parse\ParseQuery
stringThe key to check.
mixedThe value that provides a lower bound.
\Parse\ParseQueryReturns this query, so you can chain this call.
greaterThanOrEqualToRelativeTime(string $key, string $relativeTime) : \Parse\ParseQuery
stringThe key to check.
stringThe relative time that provides a lower bound
\Parse\ParseQueryReturns this query, so you can chain this call.
greaterThanRelativeTime(string $key, string $relativeTime) : \Parse\ParseQuery
stringThe key to check
stringThe relative time that provides a lower bound
\Parse\ParseQueryReturns this query, so you can chain this call.
handleQueryResult(array $result, boolean $decodeObjects) : Array
arrayArray of ParseObject raw data.
booleanIf set to false, will return raw data instead of ParseObject instances
ArrayArray of ParseObjects or raw data.
includeAllKeys() : \Parse\ParseQuery
Requires Parse Server 3.0.0+
\Parse\ParseQueryReturns the query, so you can chain this call.
includeKey(mixed $key) : \Parse\ParseQuery
You can include all nested Parse Objects by passing in '*'. (Requires Parse Server 3.0.0+)
mixedThe name(s) of the key(s) to include. It could be string, or an Array of string.
\Parse\ParseQueryReturns the query, so you can chain this call.
lessThan(string $key, mixed $value) : \Parse\ParseQuery
stringThe key to check.
mixedThe value that provides an Upper bound.
\Parse\ParseQueryReturns this query, so you can chain this call.
lessThanOrEqualTo(string $key, mixed $value) : \Parse\ParseQuery
stringThe key to check.
mixedThe value that provides an upper bound.
\Parse\ParseQueryReturns this query, so you can chain this call.
lessThanOrEqualToRelativeTime(string $key, string $relativeTime) : \Parse\ParseQuery
stringThe key to check.
stringThe relative time that provides an upper bound
\Parse\ParseQueryReturns this query, so you can chain this call.
lessThanRelativeTime(string $key, string $relativeTime) : \Parse\ParseQuery
stringThe key to check
stringThe relative time that provides an upper bound
\Parse\ParseQueryReturns this query, so you can chain this call.
limit(integer $n) : \Parse\ParseQuery
integerNumber of objects to return from the query.
\Parse\ParseQueryReturns this query, so you can chain this call.
matches(string $key, string $regex, string $modifiers = '') : \Parse\ParseQuery
This may be slow for large datasets.
stringThe key that the string to match is stored in.
stringThe regular expression pattern to match.
stringModifies the search, supports i, m
\Parse\ParseQueryReturns the query, so you can chain this call.
matchesKeyInQuery(string $key, string $queryKey, \Parse\ParseQuery $query) : \Parse\ParseQuery
stringThe key that contains the value that is being matched.
stringThe key in objects returned by the query to match against.
\Parse\ParseQueryReturns the query, so you can chain this call.
matchesQuery(string $key, \Parse\ParseQuery $query) : \Parse\ParseQuery
stringThe key that the contains the object to match the query.
\Parse\ParseQueryReturns the query, so you can chain this call.
near(string $key, \Parse\ParseGeoPoint $point) : \Parse\ParseQuery
stringThe key that the ParseGeoPoint is stored in.
\Parse\ParseQueryReturns this query, so you can chain this call.
norQueries(array $queryObjects) : \Parse\ParseQuery
All queries must have same class name.
| Throws |
|
|---|
arrayArray of ParseQuery objects to NOR.
\Parse\ParseQueryThe query that is the NOR of the passed in queries.
notContainedIn(string $key, array $values) : \Parse\ParseQuery
stringThe key to check.
arrayThe values that will not match.
\Parse\ParseQueryReturns the query, so you can chain this call.
notEqualTo(string $key, mixed $value) : \Parse\ParseQuery
stringThe key to check.
mixedThe value that must not be equalled.
\Parse\ParseQueryReturns this query, so you can chain this call.
orQueries(array $queryObjects) : \Parse\ParseQuery
All queries must have same class name.
| Throws |
|
|---|
arrayArray of ParseQuery objects to OR.
\Parse\ParseQueryThe query that is the OR of the passed in queries.
polygonContains(string $key, \Parse\ParseGeoPoint $point) : \Parse\ParseQuery
stringThe key of the ParsePolygon
\Parse\ParseQueryReturns this query, so you can chain this call.
quote(mixed $s) : string
Surrounding with \Q .. \E does this, we just need to escape \E's in the text separately.
mixedThe string or array being replaced.
stringReturns the string converted.
readPreference(string $readPreference, string $includeReadPreference = null, string $subqueryReadPreference = null) : \Parse\ParseQuery
stringThe read preference for the main query.
stringThe read preference for the queries to include pointers.
stringThe read preference for the sub queries.
\Parse\ParseQueryReturns the query, so you can chain this call.
regexStartWith(mixed $s) : string
mixedThe string or array being replaced.
stringReturns the string converted.
select(mixed $key) : \Parse\ParseQuery
mixedThe name(s) of the key(s) to include. It could be string, or an Array of string.
\Parse\ParseQueryReturns the query, so you can chain this call.
skip(integer $n) : \Parse\ParseQuery
integerNumber of objects to skip from start of results.
\Parse\ParseQueryReturns this query, so you can chain this call.
startsWith(string $key, mixed $value) : \Parse\ParseQuery
stringThe key to check.
mixedThe substring that the value must start with.
\Parse\ParseQueryReturns this query, so you can chain this call.
withCount(boolean $includeCount = true) : \Parse\ParseQuery
Note: the results will be an object
results: holding {ParseObject} array and count: integer holding total number
booleanIf response should include count, true by default.
\Parse\ParseQueryReturns this query, so you can chain this call.
withinGeoBox(string $key, \Parse\ParseGeoPoint $southwest, \Parse\ParseGeoPoint $northeast) : \Parse\ParseQuery
stringThe key of the ParseGeoPoint
\Parse\ParseQueryReturns this query, so you can chain this call.
withinKilometers(string $key, \Parse\ParseGeoPoint $point, integer $maxDistance, boolean $sort = true) : \Parse\ParseQuery
Radius of earth used is 6371.0 kilometers.
stringThe key of the ParseGeoPoint
integerMaximum distance (in kilometers)
booleanReturn objects sorted by distance
\Parse\ParseQueryReturns this query, so you can chain this call.
withinMiles(string $key, \Parse\ParseGeoPoint $point, integer $maxDistance, boolean $sort = true) : \Parse\ParseQuery
Radius of earth used is 3958.8 miles.
stringThe key of the ParseGeoPoint
integerMaximum distance (in miles)
booleanReturn objects sorted by distance
\Parse\ParseQueryReturns this query, so you can chain this call.
withinPolygon(string $key, array $points) : \Parse\ParseQuery
Polygon must have at least 3 points
stringThe key of the ParseGeoPoint
arrayArray of ParseGeoPoint
\Parse\ParseQueryReturns this query, so you can chain this call.
withinRadians(string $key, \Parse\ParseGeoPoint $point, integer $maxDistance, boolean $sort = true) : \Parse\ParseQuery
stringThe key of the ParseGeoPoint
integerMaximum distance (in radians)
booleanReturn objects sorted by distance
\Parse\ParseQueryReturns this query, so you can chain this call.
className : string
| var |
|---|
string
where : array
| var |
|---|
array
orderBy : array
| var |
|---|
array
includes : array
| var |
|---|
array
excludes : array
| var |
|---|
array
selectedKeys : array
| var |
|---|
array
skip : integer
| var |
|---|
integer
count : integer
| var |
|---|
integer
limit : integer
| var |
|---|
integer
readPreference : string
| var |
|---|
string
includeReadPreference : string
| var |
|---|
string
subqueryReadPreference : string
| var |
|---|
string