Merge branch 'master' of github.com:Elgg/Elgg

10 files changed, 31 insertions, 32 deletions

diff --git a/engine/lib/access.php b/engine/lib/access.php
index 6da747463..20f57ec41 100644
--- a/engine/lib/access.php
+++ b/engine/lib/access.php
@@ -776,7 +776,7 @@ function elgg_view_access_collections($owner_guid) {
  * 	access_id => int The access ID of the entity.
  *
  * @see elgg_get_entities()
- * @return array
+ * @return mixed int if count is true, an array of entity objects, or false on failure
  * @since 1.7.0
  */
 function elgg_get_entities_from_access_id(array $options = array()) {
diff --git a/engine/lib/annotations.php b/engine/lib/annotations.php
index 80ffbe74e..9ab5a1b39 100644
--- a/engine/lib/annotations.php
+++ b/engine/lib/annotations.php
@@ -285,14 +285,12 @@ function elgg_list_annotations($options) {
  */
 
 /**
- * Returns entities based upon annotations.  Accepts the same values as
- * elgg_get_entities_from_metadata() but uses the annotations table.
+ * Returns entities based upon annotations.  Also accepts all options available
+ * to elgg_get_entities() and elgg_get_entities_from_metadata().
  *
- * NB: Entity creation time is selected as max_time. To sort based upon
+ * Entity creation time is selected as max_time. To sort based upon
  * this, pass 'order_by' => 'maxtime asc' || 'maxtime desc'
  *
- * time_created in this case will be the time the annotation was created.
- *
  * @see elgg_get_entities
  * @see elgg_get_entities_from_metadata
  *
@@ -321,7 +319,7 @@ function elgg_list_annotations($options) {
  *
  *  annotation_ids => NULL|ARR Annotation IDs
  *
- * @return array
+ * @return mixed int if count is true, an array of entity objects, or false on failure
  * @since 1.7.0
  */
 function elgg_get_entities_from_annotations(array $options = array()) {
diff --git a/engine/lib/configuration.php b/engine/lib/configuration.php
index b756d2e70..3a2364057 100644
--- a/engine/lib/configuration.php
+++ b/engine/lib/configuration.php
@@ -464,11 +464,6 @@ function get_config($name, $site_guid = 0) {
 			$dep_version = 1.8;
 			break;
 
-		case 'wwwroot':
-			$new_name = 'www_root';
-			$dep_version = 1.8;
-			break;
-
 		case 'sitename':
 			$new_name = 'site_name';
 			$dep_version = 1.8;
@@ -553,7 +548,7 @@ function set_default_config() {
 		'path'			=>	"$install_root/",
 		'view_path'		=>	"$install_root/views/",
 		'plugins_path'	=>	"$install_root/mod/",
-		'www_root'		=> 	$www_root,
+		'wwwroot'		=> 	$www_root,
 		'url'			=>	$www_root,
 		'site_name'		=>	'New Elgg site',
 		'language'		=>	'en',
@@ -561,8 +556,6 @@ function set_default_config() {
 		// compatibility with old names for ppl not using get_config()
 		'viewpath'		=>	"$install_root/views/",
 		'pluginspath'	=>	"$install_root/mod/",
-		'wwwroot'		=> 	$www_root,
-		'url'			=>	$www_root,
 		'sitename'		=>	'New Elgg site',
 	);
 
diff --git a/engine/lib/elgglib.php b/engine/lib/elgglib.php
index 7bdc5972a..c62175629 100644
--- a/engine/lib/elgglib.php
+++ b/engine/lib/elgglib.php
@@ -2031,7 +2031,10 @@ function elgg_init() {
 	elgg_register_js('elgg.userpicker', 'js/lib/userpicker.js');
 	elgg_register_js('elgg.friendspicker', 'js/lib/friends_picker.js');
 	elgg_register_js('jquery.easing', 'vendors/jquery/jquery.easing.1.3.packed.js');
+	elgg_register_js('jquery.imgareaselect', 'vendors/jquery/jquery.imgareaselect-0.9.8/scripts/jquery.imgareaselect.min.js');
 
+	elgg_register_css('jquery.imgareaselect', 'vendors/jquery/jquery.imgareaselect-0.9.8/css/imgareaselect-deprecated.css');
+	
 	// Trigger the shutdown:system event upon PHP shutdown.
 	register_shutdown_function('_elgg_shutdown_hook');
 
diff --git a/engine/lib/metadata.php b/engine/lib/metadata.php
index a6b1bb43a..2becc5f3c 100644
--- a/engine/lib/metadata.php
+++ b/engine/lib/metadata.php
@@ -366,7 +366,6 @@ function elgg_enable_metadata(array $options) {
  * When in doubt, use name_value_pairs.
  *
  * @see elgg_get_entities
- * @see elgg_get_entities_from_annotations
  *
  * @param array $options Array in format:
  *
@@ -398,7 +397,7 @@ function elgg_enable_metadata(array $options) {
  *
  *  metadata_owner_guids => NULL|ARR guids for metadata owners
  *
- * @return array
+ * @return mixed int if count is true, an array of entity objects, or false on failure
  * @since 1.7.0
  */
 function elgg_get_entities_from_metadata(array $options = array()) {
diff --git a/engine/lib/navigation.php b/engine/lib/navigation.php
index 27af26be2..3f3a8ecd5 100644
--- a/engine/lib/navigation.php
+++ b/engine/lib/navigation.php
@@ -20,20 +20,20 @@
  * Menus
  * Elgg uses a single interface to manage its menus. Menu items are added with
  * {@link elgg_register_menu_item()}. This is generally used for menus that
- * appear only once per page. For context-sensitive menus (such as the hover
+ * appear only once per page. For dynamic menus (such as the hover
  * menu for user's avatar), a plugin hook is emitted when the menu is being
  * created. The hook is 'register', 'menu:<menu_name>'. For more details on this,
  * @see elgg_view_menu().
  *
  * Menus supported by the Elgg core
  * Standard menus:
- *     site   Site navihgation shown on every page.
+ *     site   Site navigation shown on every page.
  *     page   Page menu usually shown in a sidebar. Uses Elgg's context.
  *     topbar Topbar menu shown on every page. The default has two sections.
  *     footer Like the topbar but in the footer.
  *     extras Links about content on the page. The RSS link is added to this.
  *
- * Context-sensitive (also called just-in-time menus):
+ * Dynamic menus (also called just-in-time menus):
  *     user_hover  Avatar hover menu. The user entity is passed as a parameter.
  *     entity      The set of links shown in the summary of an entity.
  *     river       Links shown on river items.
@@ -51,7 +51,7 @@
  *
  * @warning Generally you should not use this in response to the plugin hook:
  * 'register', 'menu:<menu_name>'. If you do, you may end up with many incorrect
- * links on a context-sensitive menu.
+ * links on a dynamic menu.
  *
  * @warning A menu item's name must be unique per menu. If more than one menu
  * item with the same name are registered, the last menu item takes priority.
@@ -393,7 +393,7 @@ function elgg_annotation_menu_setup($hook, $type, $return, $params) {
 			'href' => $url,
 			'text' => "<span class=\"elgg-icon elgg-icon-delete\"></span>",
 			'confirm' => elgg_echo('deleteconfirm'),
-			'text_encode' => false
+			'encode_text' => false
 		);
 		$return[] = ElggMenuItem::factory($options);
 	}
diff --git a/engine/lib/plugins.php b/engine/lib/plugins.php
index fd85ed9f0..365ef6fdf 100644
--- a/engine/lib/plugins.php
+++ b/engine/lib/plugins.php
@@ -978,7 +978,7 @@ function elgg_unset_all_plugin_settings($plugin_id = null) {
  * 	plugin_user_setting_name_value_pairs_operator => NULL|STR The operator to use for combining
  *                                        (name = value) OPERATOR (name = value); default AND
  *
- * @return mixed
+ * @return mixed int if count is true, an array of entity objects, or false on failure
  */
 function elgg_get_entities_from_plugin_user_settings(array $options = array()) {
 	// if they're passing it don't bother
diff --git a/engine/lib/private_settings.php b/engine/lib/private_settings.php
index e5e7b2213..d7d819e1c 100644
--- a/engine/lib/private_settings.php
+++ b/engine/lib/private_settings.php
@@ -38,7 +38,7 @@
  *                                     their own settings.
  *
  *
- * @return array
+ * @return mixed int if count is true, an array of entity objects, or false on failure
  * @since 1.8.0
  */
 function elgg_get_entities_from_private_settings(array $options = array()) {
diff --git a/engine/lib/relationships.php b/engine/lib/relationships.php
index 9d5fd39b6..f1da65a34 100644
--- a/engine/lib/relationships.php
+++ b/engine/lib/relationships.php
@@ -235,6 +235,11 @@ function get_entity_relationships($guid, $inverse_relationship = FALSE) {
 
 /**
  * Return entities matching a given query joining against a relationship.
+ * Also accepts all options available to elgg_get_entities() and
+ * elgg_get_entities_from_metadata().
+ *
+ * @see elgg_get_entities
+ * @see elgg_get_entities_from_metadata
  *
  * @param array $options Array in format:
  *
@@ -244,7 +249,7 @@ function get_entity_relationships($guid, $inverse_relationship = FALSE) {
  *
  * 	inverse_relationship => BOOL Inverse the relationship
  *
- * @return array
+ * @return mixed int if count is true, an array of entity objects, or false on failure
  * @since 1.7.0
  */
 function elgg_get_entities_from_relationship($options) {
@@ -365,7 +370,7 @@ function elgg_list_entities_from_relationship(array $options = array()) {
  *
  * @param array $options An options array compatible with
  *                       elgg_get_entities_from_relationship()
- * @return array
+ * @return mixed int if count is true, an array of entity objects, or false on failure
  * @since 1.8.0
  */
 function elgg_get_entities_from_relationship_count(array $options = array()) {
diff --git a/engine/lib/views.php b/engine/lib/views.php
index c31f61e84..a18118f32 100644
--- a/engine/lib/views.php
+++ b/engine/lib/views.php
@@ -709,9 +709,9 @@ function elgg_view_layout($layout_name, $vars = array()) {
  *
  * This function triggers a 'register', 'menu:<menu name>' plugin hook that enables
  * plugins to add menu items just before a menu is rendered. This is used by
- * context-sensitive menus (menus that are specific to a particular entity such
- * as the user hover menu). Using elgg_register_menu_item() in response to the hook
- * can cause incorrect links to show up. See the blog plugin's blog_owner_block_menu()
+ * dynamic menus (menus that change based on some input such as the user hover
+ * menu). Using elgg_register_menu_item() in response to the hook can cause
+ * incorrect links to show up. See the blog plugin's blog_owner_block_menu()
  * for an example of using this plugin hook.
  *
  * An additional hook is the 'prepare', 'menu:<menu name>' which enables plugins
@@ -724,8 +724,9 @@ function elgg_view_layout($layout_name, $vars = array()) {
  * @param array  $vars      An associative array of display options for the menu.
  *                          Options include:
  *                              sort_by => string or php callback
- *                                  string options: 'name', 'priority', 'title' (default), 'register' (registration order)
- *                                  php callback: a compare function for usort
+ *                                  string options: 'name', 'priority', 'title' (default),
+ *                                  'register' (registration order) or a
+ *                                  php callback (a compare function for usort)
  *                              handler: string the page handler to build action URLs
  *                              entity: ElggEntity to use to build action URLs
  *                              class: string the class for the entire menu.
@@ -744,7 +745,7 @@ function elgg_view_menu($menu_name, array $vars = array()) {
 	$menu = $CONFIG->menus[$menu_name];
 
 	// Give plugins a chance to add menu items just before creation.
-	// This supports context sensitive menus (ex. user_hover).
+	// This supports dynamic menus (example: user_hover).
 	$menu = elgg_trigger_plugin_hook('register', "menu:$menu_name", $vars, $menu);
 
 	$builder = new ElggMenuBuilder($menu);