Created
February 19, 2013 19:28
-
-
Save Berdir/4989027 to your computer and use it in GitHub Desktop.
getObjects docblock
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
/** | |
* Query across multiple Salsa objects by performing a left join. | |
* | |
* @param array $objects | |
* Array of the salsa objects/tables, to query | |
* @param array $conditions | |
* Array of conditions. The key is the column name, the value can be one of | |
* - A value: used as is, with the = operator. | |
* - An array of values: Imploded with , and the IN operator is used. | |
* - A value with a %: The LIKE operator is used. | |
* - An array with the keys #operator and #value. Supporter operators are | |
* =, >=, <=, <|>, LIKE, IN, NOT IN, IS NOT EMPTY, IS EMPTY. EMPTY is | |
* equal to an NULL OR empty value. | |
* @param array $limit | |
* Limit the number of returned objects, Either an integer or "offset,limit" | |
* No more than 100 objects can be returned at once· | |
* @param array $include | |
* An array of columns that should be included in the response. Everything | |
* is returned if empty. | |
* @param array $orderBy | |
* An array of columns to order by. Use -column to sort descending. | |
* @param array $groupBy | |
* An array of columns to group by. | |
* | |
* @return array | |
* Array of objects. | |
* | |
* @throws SalsaQueryException | |
* @throws SalsaConnectionException | |
*/ |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment