diff options
| author | brettp <brettp@36083f99-b078-4883-b0ff-0f9b5a30f544> | 2010-03-24 19:49:29 +0000 |
|---|---|---|
| committer | brettp <brettp@36083f99-b078-4883-b0ff-0f9b5a30f544> | 2010-03-24 19:49:29 +0000 |
| commit | d47809ecb0dee997682fb53d220ef5377406a975 (patch) | |
| tree | fa3dea3db7193adb58caa5bf7b2bd8e93c0c2cea | |
| parent | 7b44da8e24271eeb4b57905e9c89789d2b315402 (diff) | |
| download | elgg-d47809ecb0dee997682fb53d220ef5377406a975.tar.gz elgg-d47809ecb0dee997682fb53d220ef5377406a975.tar.bz2 | |
Added documentation for order_by_metadata.
git-svn-id: http://code.elgg.org/elgg/trunk@5496 36083f99-b078-4883-b0ff-0f9b5a30f544
| -rw-r--r-- | engine/lib/metadata.php | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/engine/lib/metadata.php b/engine/lib/metadata.php index a5e8e22e8..5c248e0f6 100644 --- a/engine/lib/metadata.php +++ b/engine/lib/metadata.php @@ -553,13 +553,16 @@ function find_metadata($meta_name = "", $meta_value = "", $entity_type = "", $en * * metadata_values => NULL|ARR metadata values * - * metadata_name_value_pairs => NULL|ARR (name = 'name', value => 'value', 'operand' => '=', 'case_sensitive' => TRUE) entries. + * metadata_name_value_pairs => NULL|ARR (name => 'name', value => 'value', 'operand' => '=', 'case_sensitive' => TRUE) entries. * Currently if multiple values are sent via an array (value => array('value1', 'value2') the pair's operand will be forced to "IN". * * metadata_name_value_pairs_operator => NULL|STR The operator to use for combining (name = value) OPERATOR (name = value); default AND * * metadata_case_sensitive => BOOL Overall Case sensitive * + * order_by_metadata => NULL|ARR (array('name' => 'metadata_text1', 'direction' => ASC|DESC, 'as' => text|integer), + * Also supports array('name' => 'metadata_text1') + * * @return array */ function elgg_get_entities_from_metadata(array $options = array()) { |