Elgg / Elgg

engine/lib/group.php

Doc Comments +1 added lines, -1 removed lines

@@ -106,7 +106,7 @@
  * @param string $type  Hook type
  * @param array  $value Array of unit test locations
  *
- * @return array
+ * @return string[]
  * @access private
  */
 function _elgg_groups_test($hook, $type, $value) {

Indentation +37 added lines, -37 removed lines

@@ -19,10 +19,10 @@ 
  * @access private
  */
 function get_group_entity_as_row($guid) {
-	$guid = (int) $guid;
+    $guid = (int) $guid;
 
-	$prefix = _elgg_config()->dbprefix;
-	return get_data_row("SELECT * from {$prefix}groups_entity where guid=$guid");
+    $prefix = _elgg_config()->dbprefix;
+    return get_data_row("SELECT * from {$prefix}groups_entity where guid=$guid");
 }
 
 /**
@@ -38,16 +38,16 @@ 
  * @since 1.5.0
  */
 function add_group_tool_option($name, $label, $default_on = true) {
-	$options = _elgg_config()->group_tool_options;
-	if (!$options) {
-		$options = [];
-	}
-	$options[] = (object) [
-		'name' => $name,
-		'label' => $label,
-		'default_on' => $default_on,
-	];
-	_elgg_config()->group_tool_options = $options;
+    $options = _elgg_config()->group_tool_options;
+    if (!$options) {
+        $options = [];
+    }
+    $options[] = (object) [
+        'name' => $name,
+        'label' => $label,
+        'default_on' => $default_on,
+    ];
+    _elgg_config()->group_tool_options = $options;
 }
 
 /**
@@ -61,18 +61,18 @@ 
  * @since 1.7.5
  */
 function remove_group_tool_option($name) {
-	$options = _elgg_config()->group_tool_options;
-	if (!is_array($options)) {
-		return;
-	}
+    $options = _elgg_config()->group_tool_options;
+    if (!is_array($options)) {
+        return;
+    }
 
-	foreach ($options as $i => $option) {
-		if ($option->name == $name) {
-			unset($options[$i]);
-		}
-	}
+    foreach ($options as $i => $option) {
+        if ($option->name == $name) {
+            unset($options[$i]);
+        }
+    }
 
-	_elgg_config()->group_tool_options = $options;
+    _elgg_config()->group_tool_options = $options;
 }
 
 /**
@@ -86,16 +86,16 @@ 
  * @access private
  */
 function _elgg_groups_container_override($hook, $type, $result, $params) {
-	$container = $params['container'];
-	$user = $params['user'];
-	if (elgg_instanceof($container, 'group') && $user) {
-		/* @var \ElggGroup $container */
-		if ($container->isMember($user)) {
-			return true;
-		}
-	}
+    $container = $params['container'];
+    $user = $params['user'];
+    if (elgg_instanceof($container, 'group') && $user) {
+        /* @var \ElggGroup $container */
+        if ($container->isMember($user)) {
+            return true;
+        }
+    }
 
-	return $result;
+    return $result;
 }
 
 /**
@@ -109,8 +109,8 @@ 
  * @access private
  */
 function _elgg_groups_test($hook, $type, $value) {
-	$value[] = Paths::elgg() . 'engine/tests/ElggGroupTest.php';
-	return $value;
+    $value[] = Paths::elgg() . 'engine/tests/ElggGroupTest.php';
+    return $value;
 }
 
 /**
@@ -118,13 +118,13 @@ 
  * @access private
  */
 function _elgg_groups_init() {
-	elgg_register_plugin_hook_handler('container_permissions_check', 'all', '_elgg_groups_container_override');
-	elgg_register_plugin_hook_handler('unit_test', 'system', '_elgg_groups_test');
+    elgg_register_plugin_hook_handler('container_permissions_check', 'all', '_elgg_groups_container_override');
+    elgg_register_plugin_hook_handler('unit_test', 'system', '_elgg_groups_test');
 }
 
 /**
  * @see \Elgg\Application::loadCore Do not do work here. Just register for events.
  */
 return function(\Elgg\EventsService $events, \Elgg\HooksRegistrationService $hooks) {
-	$events->registerHandler('init', 'system', '_elgg_groups_init');
+    $events->registerHandler('init', 'system', '_elgg_groups_init');
 };

Spacing +1 added lines, -1 removed lines

@@ -109,7 +109,7 @@
  * @access private
  */
 function _elgg_groups_test($hook, $type, $value) {
-	$value[] = Paths::elgg() . 'engine/tests/ElggGroupTest.php';
+	$value[] = Paths::elgg().'engine/tests/ElggGroupTest.php';
 	return $value;
 }
 

engine/lib/metastrings.php

Doc Comments +1 added lines, -1 removed lines

@@ -741,7 +741,7 @@
  * @param string $type  system
  * @param array  $value Array of other tests
  *
- * @return array
+ * @return string[]
  * @access private
  */
 function _elgg_metastrings_test($hook, $type, $value) {

Indentation +530 added lines, -530 removed lines

@@ -45,262 +45,262 @@ 
  * @access private
  */
 function _elgg_get_metastring_based_objects($options) {
-	$options = _elgg_normalize_metastrings_options($options);
-
-	switch ($options['metastring_type']) {
-		case 'metadata':
-			$type = 'metadata';
-			$callback = 'row_to_elggmetadata';
-			break;
-
-		case 'annotations':
-		case 'annotation':
-			$type = 'annotations';
-			$callback = 'row_to_elggannotation';
-			break;
-
-		default:
-			return false;
-	}
-
-	$defaults = [
-		// entities
-		'types' => ELGG_ENTITIES_ANY_VALUE,
-		'subtypes' => ELGG_ENTITIES_ANY_VALUE,
-		'type_subtype_pairs' => ELGG_ENTITIES_ANY_VALUE,
-
-		'guids' => ELGG_ENTITIES_ANY_VALUE,
-		'owner_guids' => ELGG_ENTITIES_ANY_VALUE,
-		'container_guids' => ELGG_ENTITIES_ANY_VALUE,
-
-		'modified_time_lower' => ELGG_ENTITIES_ANY_VALUE,
-		'modified_time_upper' => ELGG_ENTITIES_ANY_VALUE,
-		'created_time_lower' => ELGG_ENTITIES_ANY_VALUE,
-		'created_time_upper' => ELGG_ENTITIES_ANY_VALUE,
-
-		// options are normalized to the plural in case we ever add support for them.
-		'metastring_names' => ELGG_ENTITIES_ANY_VALUE,
-		'metastring_values' => ELGG_ENTITIES_ANY_VALUE,
-
-		'metastring_case_sensitive' => true,
-		'metastring_calculation' => ELGG_ENTITIES_NO_VALUE,
-
-		'metastring_created_time_lower' => ELGG_ENTITIES_ANY_VALUE,
-		'metastring_created_time_upper' => ELGG_ENTITIES_ANY_VALUE,
-
-		'metastring_owner_guids' => ELGG_ENTITIES_ANY_VALUE,
+    $options = _elgg_normalize_metastrings_options($options);
+
+    switch ($options['metastring_type']) {
+        case 'metadata':
+            $type = 'metadata';
+            $callback = 'row_to_elggmetadata';
+            break;
+
+        case 'annotations':
+        case 'annotation':
+            $type = 'annotations';
+            $callback = 'row_to_elggannotation';
+            break;
+
+        default:
+            return false;
+    }
+
+    $defaults = [
+        // entities
+        'types' => ELGG_ENTITIES_ANY_VALUE,
+        'subtypes' => ELGG_ENTITIES_ANY_VALUE,
+        'type_subtype_pairs' => ELGG_ENTITIES_ANY_VALUE,
+
+        'guids' => ELGG_ENTITIES_ANY_VALUE,
+        'owner_guids' => ELGG_ENTITIES_ANY_VALUE,
+        'container_guids' => ELGG_ENTITIES_ANY_VALUE,
+
+        'modified_time_lower' => ELGG_ENTITIES_ANY_VALUE,
+        'modified_time_upper' => ELGG_ENTITIES_ANY_VALUE,
+        'created_time_lower' => ELGG_ENTITIES_ANY_VALUE,
+        'created_time_upper' => ELGG_ENTITIES_ANY_VALUE,
+
+        // options are normalized to the plural in case we ever add support for them.
+        'metastring_names' => ELGG_ENTITIES_ANY_VALUE,
+        'metastring_values' => ELGG_ENTITIES_ANY_VALUE,
+
+        'metastring_case_sensitive' => true,
+        'metastring_calculation' => ELGG_ENTITIES_NO_VALUE,
+
+        'metastring_created_time_lower' => ELGG_ENTITIES_ANY_VALUE,
+        'metastring_created_time_upper' => ELGG_ENTITIES_ANY_VALUE,
+
+        'metastring_owner_guids' => ELGG_ENTITIES_ANY_VALUE,
 		
-		'metastring_ids' => ELGG_ENTITIES_ANY_VALUE,
-
-		// sql
-		'order_by' => 'n_table.time_created ASC, n_table.id ASC',
-		'limit' => _elgg_config()->default_limit,
-		'offset' => 0,
-		'count' => false,
-		'selects' => [],
-		'wheres' => [],
-		'joins' => [],
-
-		'distinct' => true,
-		'preload_owners' => false,
-		'callback' => $callback,
+        'metastring_ids' => ELGG_ENTITIES_ANY_VALUE,
+
+        // sql
+        'order_by' => 'n_table.time_created ASC, n_table.id ASC',
+        'limit' => _elgg_config()->default_limit,
+        'offset' => 0,
+        'count' => false,
+        'selects' => [],
+        'wheres' => [],
+        'joins' => [],
+
+        'distinct' => true,
+        'preload_owners' => false,
+        'callback' => $callback,
 
-		'batch' => false,
-		'batch_inc_offset' => true,
-		'batch_size' => 25,
-	];
-
-	$options = array_merge($defaults, $options);
-
-	if ($options['batch'] && !$options['count']) {
-		$batch_size = $options['batch_size'];
-		$batch_inc_offset = $options['batch_inc_offset'];
-
-		// clean batch keys from $options.
-		unset($options['batch'], $options['batch_size'], $options['batch_inc_offset']);
-
-		return new \ElggBatch('_elgg_get_metastring_based_objects', $options, null, $batch_size, $batch_inc_offset);
-	}
-
-	// can't use helper function with type_subtype_pair because
-	// it's already an array...just need to merge it
-	if (isset($options['type_subtype_pair'])) {
-		if (isset($options['type_subtype_pairs'])) {
-			$options['type_subtype_pairs'] = array_merge($options['type_subtype_pairs'],
-				$options['type_subtype_pair']);
-		} else {
-			$options['type_subtype_pairs'] = $options['type_subtype_pair'];
-		}
-	}
-
-	$singulars = [
-		'type', 'subtype', 'type_subtype_pair',
-		'guid', 'owner_guid', 'container_guid',
-		'metastring_name', 'metastring_value',
-		'metastring_owner_guid', 'metastring_id',
-		'select', 'where', 'join'
-	];
-
-	$options = _elgg_normalize_plural_options_array($options, $singulars);
-
-	if (!$options) {
-		return false;
-	}
-
-	$db_prefix = _elgg_config()->dbprefix;
-
-	// evaluate where clauses
-	if (!is_array($options['wheres'])) {
-		$options['wheres'] = [$options['wheres']];
-	}
-
-	$wheres = $options['wheres'];
-
-	// entities
-	$wheres[] = _elgg_services()->entityTable->getEntityTypeSubtypeWhereSql('e', $options['types'],
-		$options['subtypes'], $options['type_subtype_pairs']);
-
-	$wheres[] = _elgg_get_guid_based_where_sql('e.guid', $options['guids']);
-	$wheres[] = _elgg_get_guid_based_where_sql('e.owner_guid', $options['owner_guids']);
-	$wheres[] = _elgg_get_guid_based_where_sql('e.container_guid', $options['container_guids']);
-
-	$wheres[] = _elgg_get_entity_time_where_sql('e', $options['created_time_upper'],
-		$options['created_time_lower'], $options['modified_time_upper'], $options['modified_time_lower']);
-
-
-	$wheres[] = _elgg_get_entity_time_where_sql('n_table', $options['metastring_created_time_upper'],
-		$options['metastring_created_time_lower'], null, null);
-
-	$wheres[] = _elgg_get_guid_based_where_sql('n_table.owner_guid',
-		$options['metastring_owner_guids']);
-
-	// see if any functions failed
-	// remove empty strings on successful functions
-	foreach ($wheres as $i => $where) {
-		if ($where === false) {
-			return false;
-		} elseif (empty($where)) {
-			unset($wheres[$i]);
-		}
-	}
-
-	// remove identical where clauses
-	$wheres = array_unique($wheres);
-
-	// evaluate join clauses
-	if (!is_array($options['joins'])) {
-		$options['joins'] = [$options['joins']];
-	}
-
-	$joins = [];
-	$joins[] = "JOIN {$db_prefix}entities e ON n_table.entity_guid = e.guid";
-
-	// evaluate selects
-	if (!is_array($options['selects'])) {
-		$options['selects'] = [$options['selects']];
-	}
-
-	$selects = $options['selects'];
-
-	// add optional joins
-	$joins = array_merge($joins, $options['joins']);
-
-	// metastrings
-	$metastring_clauses = _elgg_get_metastring_sql('n_table', $options['metastring_names'],
-		$options['metastring_values'], null, $options['metastring_ids'],
-		$options['metastring_case_sensitive'], $type);
-
-	if ($metastring_clauses) {
-		$wheres = array_merge($wheres, $metastring_clauses['wheres']);
-		$joins = array_merge($joins, $metastring_clauses['joins']);
-	} else {
-		if ($type === 'annotations') {
-			$wheres[] = _elgg_get_access_where_sql([
-				'table_alias' => 'n_table',
-				'guid_column' => 'entity_guid',
-			]);
-		}
-	}
-
-	$distinct = $options['distinct'] ? "DISTINCT " : "";
-
-	if ($options['metastring_calculation'] === ELGG_ENTITIES_NO_VALUE && !$options['count']) {
-		$selects = array_unique($selects);
-		// evalutate selects
-		$select_str = '';
-		if ($selects) {
-			foreach ($selects as $select) {
-				$select_str .= ", $select";
-			}
-		}
-
-		$query = "SELECT $distinct n_table.*{$select_str} FROM {$db_prefix}$type n_table";
-	} elseif ($options['count']) {
-		// count is over the entities
-		$query = "SELECT count($distinct e.guid) as calculation FROM {$db_prefix}$type n_table";
-	} else {
-		$query = "SELECT {$options['metastring_calculation']}(n_table.value) as calculation FROM {$db_prefix}$type n_table";
-	}
-
-	foreach ($joins as $i => $join) {
-		if ($join === false) {
-			return false;
-		} elseif (empty($join)) {
-			unset($joins[$i]);
-		}
-	}
-
-	// remove identical join clauses
-	$joins = array_unique($joins);
-
-	// add joins
-	foreach ($joins as $j) {
-		$query .= " $j ";
-	}
-
-	// add wheres
-	$query .= ' WHERE ';
-
-	foreach ($wheres as $w) {
-		$query .= " $w AND ";
-	}
-
-	// Add access controls
-	$query .= _elgg_get_access_where_sql(['table_alias' => 'e']);
-
-	// reverse order by
-	if (isset($options['reverse_order_by']) && $options['reverse_order_by']) {
-		$options['order_by'] = _elgg_sql_reverse_order_by_clause($options['order_by']);
-	}
-
-	if ($options['metastring_calculation'] === ELGG_ENTITIES_NO_VALUE && !$options['count']) {
-		if (isset($options['group_by'])) {
-			$options['group_by'] = sanitise_string($options['group_by']);
-			$query .= " GROUP BY {$options['group_by']}";
-		}
-
-		if (isset($options['order_by']) && $options['order_by']) {
-			$options['order_by'] = sanitise_string($options['order_by']);
-			$query .= " ORDER BY {$options['order_by']}, n_table.id";
-		}
-
-		if ($options['limit']) {
-			$limit = sanitise_int($options['limit']);
-			$offset = sanitise_int($options['offset'], false);
-			$query .= " LIMIT $offset, $limit";
-		}
-
-		$dt = get_data($query, $options['callback']);
-
-		if ($options['preload_owners'] && is_array($dt) && count($dt) > 1) {
-			_elgg_services()->entityPreloader->preload($dt, ['owner_guid']);
-		}
-
-		return $dt;
-	} else {
-		$result = get_data_row($query);
-		return $result->calculation;
-	}
+        'batch' => false,
+        'batch_inc_offset' => true,
+        'batch_size' => 25,
+    ];
+
+    $options = array_merge($defaults, $options);
+
+    if ($options['batch'] && !$options['count']) {
+        $batch_size = $options['batch_size'];
+        $batch_inc_offset = $options['batch_inc_offset'];
+
+        // clean batch keys from $options.
+        unset($options['batch'], $options['batch_size'], $options['batch_inc_offset']);
+
+        return new \ElggBatch('_elgg_get_metastring_based_objects', $options, null, $batch_size, $batch_inc_offset);
+    }
+
+    // can't use helper function with type_subtype_pair because
+    // it's already an array...just need to merge it
+    if (isset($options['type_subtype_pair'])) {
+        if (isset($options['type_subtype_pairs'])) {
+            $options['type_subtype_pairs'] = array_merge($options['type_subtype_pairs'],
+                $options['type_subtype_pair']);
+        } else {
+            $options['type_subtype_pairs'] = $options['type_subtype_pair'];
+        }
+    }
+
+    $singulars = [
+        'type', 'subtype', 'type_subtype_pair',
+        'guid', 'owner_guid', 'container_guid',
+        'metastring_name', 'metastring_value',
+        'metastring_owner_guid', 'metastring_id',
+        'select', 'where', 'join'
+    ];
+
+    $options = _elgg_normalize_plural_options_array($options, $singulars);
+
+    if (!$options) {
+        return false;
+    }
+
+    $db_prefix = _elgg_config()->dbprefix;
+
+    // evaluate where clauses
+    if (!is_array($options['wheres'])) {
+        $options['wheres'] = [$options['wheres']];
+    }
+
+    $wheres = $options['wheres'];
+
+    // entities
+    $wheres[] = _elgg_services()->entityTable->getEntityTypeSubtypeWhereSql('e', $options['types'],
+        $options['subtypes'], $options['type_subtype_pairs']);
+
+    $wheres[] = _elgg_get_guid_based_where_sql('e.guid', $options['guids']);
+    $wheres[] = _elgg_get_guid_based_where_sql('e.owner_guid', $options['owner_guids']);
+    $wheres[] = _elgg_get_guid_based_where_sql('e.container_guid', $options['container_guids']);
+
+    $wheres[] = _elgg_get_entity_time_where_sql('e', $options['created_time_upper'],
+        $options['created_time_lower'], $options['modified_time_upper'], $options['modified_time_lower']);
+
+
+    $wheres[] = _elgg_get_entity_time_where_sql('n_table', $options['metastring_created_time_upper'],
+        $options['metastring_created_time_lower'], null, null);
+
+    $wheres[] = _elgg_get_guid_based_where_sql('n_table.owner_guid',
+        $options['metastring_owner_guids']);
+
+    // see if any functions failed
+    // remove empty strings on successful functions
+    foreach ($wheres as $i => $where) {
+        if ($where === false) {
+            return false;
+        } elseif (empty($where)) {
+            unset($wheres[$i]);
+        }
+    }
+
+    // remove identical where clauses
+    $wheres = array_unique($wheres);
+
+    // evaluate join clauses
+    if (!is_array($options['joins'])) {
+        $options['joins'] = [$options['joins']];
+    }
+
+    $joins = [];
+    $joins[] = "JOIN {$db_prefix}entities e ON n_table.entity_guid = e.guid";
+
+    // evaluate selects
+    if (!is_array($options['selects'])) {
+        $options['selects'] = [$options['selects']];
+    }
+
+    $selects = $options['selects'];
+
+    // add optional joins
+    $joins = array_merge($joins, $options['joins']);
+
+    // metastrings
+    $metastring_clauses = _elgg_get_metastring_sql('n_table', $options['metastring_names'],
+        $options['metastring_values'], null, $options['metastring_ids'],
+        $options['metastring_case_sensitive'], $type);
+
+    if ($metastring_clauses) {
+        $wheres = array_merge($wheres, $metastring_clauses['wheres']);
+        $joins = array_merge($joins, $metastring_clauses['joins']);
+    } else {
+        if ($type === 'annotations') {
+            $wheres[] = _elgg_get_access_where_sql([
+                'table_alias' => 'n_table',
+                'guid_column' => 'entity_guid',
+            ]);
+        }
+    }
+
+    $distinct = $options['distinct'] ? "DISTINCT " : "";
+
+    if ($options['metastring_calculation'] === ELGG_ENTITIES_NO_VALUE && !$options['count']) {
+        $selects = array_unique($selects);
+        // evalutate selects
+        $select_str = '';
+        if ($selects) {
+            foreach ($selects as $select) {
+                $select_str .= ", $select";
+            }
+        }
+
+        $query = "SELECT $distinct n_table.*{$select_str} FROM {$db_prefix}$type n_table";
+    } elseif ($options['count']) {
+        // count is over the entities
+        $query = "SELECT count($distinct e.guid) as calculation FROM {$db_prefix}$type n_table";
+    } else {
+        $query = "SELECT {$options['metastring_calculation']}(n_table.value) as calculation FROM {$db_prefix}$type n_table";
+    }
+
+    foreach ($joins as $i => $join) {
+        if ($join === false) {
+            return false;
+        } elseif (empty($join)) {
+            unset($joins[$i]);
+        }
+    }
+
+    // remove identical join clauses
+    $joins = array_unique($joins);
+
+    // add joins
+    foreach ($joins as $j) {
+        $query .= " $j ";
+    }
+
+    // add wheres
+    $query .= ' WHERE ';
+
+    foreach ($wheres as $w) {
+        $query .= " $w AND ";
+    }
+
+    // Add access controls
+    $query .= _elgg_get_access_where_sql(['table_alias' => 'e']);
+
+    // reverse order by
+    if (isset($options['reverse_order_by']) && $options['reverse_order_by']) {
+        $options['order_by'] = _elgg_sql_reverse_order_by_clause($options['order_by']);
+    }
+
+    if ($options['metastring_calculation'] === ELGG_ENTITIES_NO_VALUE && !$options['count']) {
+        if (isset($options['group_by'])) {
+            $options['group_by'] = sanitise_string($options['group_by']);
+            $query .= " GROUP BY {$options['group_by']}";
+        }
+
+        if (isset($options['order_by']) && $options['order_by']) {
+            $options['order_by'] = sanitise_string($options['order_by']);
+            $query .= " ORDER BY {$options['order_by']}, n_table.id";
+        }
+
+        if ($options['limit']) {
+            $limit = sanitise_int($options['limit']);
+            $offset = sanitise_int($options['offset'], false);
+            $query .= " LIMIT $offset, $limit";
+        }
+
+        $dt = get_data($query, $options['callback']);
+
+        if ($options['preload_owners'] && is_array($dt) && count($dt) > 1) {
+            _elgg_services()->entityPreloader->preload($dt, ['owner_guid']);
+        }
+
+        return $dt;
+    } else {
+        $result = get_data_row($query);
+        return $result->calculation;
+    }
 }
 
 /**
@@ -320,105 +320,105 @@ 
  * @access private
  */
 function _elgg_get_metastring_sql($table, $names = null, $values = null,
-	$pairs = null, $ids = null, $case_sensitive = false, $type = null) {
-
-	if ($type !== 'metadata' && $type !== 'annotations') {
-		throw new \InvalidArgumentException('$type must be "metadata" or "annotations"');
-	}
-
-	if ((!$names && $names !== 0)
-		&& (!$values && $values !== 0)
-		&& !$ids
-		&& (!$pairs && $pairs !== 0)) {
-		return [];
-	}
-
-	$db_prefix = _elgg_config()->dbprefix;
-
-	// binary forces byte-to-byte comparision of strings, making
-	// it case- and diacritical-mark- sensitive.
-	// only supported on values.
-	$binary = ($case_sensitive) ? ' BINARY ' : '';
-
-	$return =  [
-		'joins' =>  [],
-		'wheres' => []
-	];
-
-	$wheres = [];
-
-	// get names wheres and joins
-	$names_where = '';
-	if ($names !== null) {
-		if (!is_array($names)) {
-			$names = [$names];
-		}
-
-		$sanitised_names = [];
-		foreach ($names as $name) {
-			// normalise to 0.
-			if (!$name) {
-				$name = '0';
-			}
-			$sanitised_names[] = '\'' . sanitise_string($name) . '\'';
-		}
-
-		if ($names_str = implode(',', $sanitised_names)) {
-			$names_where = "($table.name IN ($names_str))";
-		}
-	}
-
-	// get values wheres and joins
-	$values_where = '';
-	if ($values !== null) {
-		if (!is_array($values)) {
-			$values = [$values];
-		}
-
-		$sanitised_values = [];
-		foreach ($values as $value) {
-			// normalize to 0
-			if (!$value) {
-				$value = 0;
-			}
-			$sanitised_values[] = '\'' . sanitise_string($value) . '\'';
-		}
-
-		if ($values_str = implode(',', $sanitised_values)) {
-			$values_where = "({$binary}$table.value IN ($values_str))";
-		}
-	}
+    $pairs = null, $ids = null, $case_sensitive = false, $type = null) {
+
+    if ($type !== 'metadata' && $type !== 'annotations') {
+        throw new \InvalidArgumentException('$type must be "metadata" or "annotations"');
+    }
+
+    if ((!$names && $names !== 0)
+        && (!$values && $values !== 0)
+        && !$ids
+        && (!$pairs && $pairs !== 0)) {
+        return [];
+    }
+
+    $db_prefix = _elgg_config()->dbprefix;
+
+    // binary forces byte-to-byte comparision of strings, making
+    // it case- and diacritical-mark- sensitive.
+    // only supported on values.
+    $binary = ($case_sensitive) ? ' BINARY ' : '';
+
+    $return =  [
+        'joins' =>  [],
+        'wheres' => []
+    ];
+
+    $wheres = [];
+
+    // get names wheres and joins
+    $names_where = '';
+    if ($names !== null) {
+        if (!is_array($names)) {
+            $names = [$names];
+        }
+
+        $sanitised_names = [];
+        foreach ($names as $name) {
+            // normalise to 0.
+            if (!$name) {
+                $name = '0';
+            }
+            $sanitised_names[] = '\'' . sanitise_string($name) . '\'';
+        }
+
+        if ($names_str = implode(',', $sanitised_names)) {
+            $names_where = "($table.name IN ($names_str))";
+        }
+    }
+
+    // get values wheres and joins
+    $values_where = '';
+    if ($values !== null) {
+        if (!is_array($values)) {
+            $values = [$values];
+        }
+
+        $sanitised_values = [];
+        foreach ($values as $value) {
+            // normalize to 0
+            if (!$value) {
+                $value = 0;
+            }
+            $sanitised_values[] = '\'' . sanitise_string($value) . '\'';
+        }
+
+        if ($values_str = implode(',', $sanitised_values)) {
+            $values_where = "({$binary}$table.value IN ($values_str))";
+        }
+    }
 	
-	if ($ids !== null) {
-		if (!is_array($ids)) {
-			$ids = [$ids];
-		}
-		$ids_str = implode(',', $ids);
-		if ($ids_str) {
-			$wheres[] = "n_table.id IN ($ids_str)";
-		}
-	}
-
-	if ($names_where && $values_where) {
-		$wheres[] = "($names_where AND $values_where)";
-	} elseif ($names_where) {
-		$wheres[] = $names_where;
-	} elseif ($values_where) {
-		$wheres[] = $values_where;
-	}
-
-	if ($type === 'annotations') {
-		$wheres[] = _elgg_get_access_where_sql([
-			'table_alias' => $table,
-			'guid_column' => 'entity_guid',
-		]);
-	}
-
-	if ($where = implode(' AND ', $wheres)) {
-		$return['wheres'][] = "($where)";
-	}
-
-	return $return;
+    if ($ids !== null) {
+        if (!is_array($ids)) {
+            $ids = [$ids];
+        }
+        $ids_str = implode(',', $ids);
+        if ($ids_str) {
+            $wheres[] = "n_table.id IN ($ids_str)";
+        }
+    }
+
+    if ($names_where && $values_where) {
+        $wheres[] = "($names_where AND $values_where)";
+    } elseif ($names_where) {
+        $wheres[] = $names_where;
+    } elseif ($values_where) {
+        $wheres[] = $values_where;
+    }
+
+    if ($type === 'annotations') {
+        $wheres[] = _elgg_get_access_where_sql([
+            'table_alias' => $table,
+            'guid_column' => 'entity_guid',
+        ]);
+    }
+
+    if ($where = implode(' AND ', $wheres)) {
+        $return['wheres'][] = "($where)";
+    }
+
+    return $return;
 }
 
 /**
@@ -430,41 +430,41 @@ 
  */
 function _elgg_normalize_metastrings_options(array $options = []) {
 
-	// support either metastrings_type or metastring_type
-	// because I've made this mistake many times and hunting it down is a pain...
-	$type = elgg_extract('metastring_type', $options, null);
-	$type = elgg_extract('metastrings_type', $options, $type);
-
-	$options['metastring_type'] = $type;
-
-	// support annotation_ and annotations_ because they're way too easy to confuse
-	$prefixes = ['metadata_', 'annotation_', 'annotations_'];
-
-	// map the metadata_* options to metastring_* options
-	$map = [
-		'names'                 => 'metastring_names',
-		'values'                => 'metastring_values',
-		'case_sensitive'        => 'metastring_case_sensitive',
-		'owner_guids'           => 'metastring_owner_guids',
-		'created_time_lower'    => 'metastring_created_time_lower',
-		'created_time_upper'    => 'metastring_created_time_upper',
-		'calculation'           => 'metastring_calculation',
-		'ids'                   => 'metastring_ids',
-	];
-
-	foreach ($prefixes as $prefix) {
-		$singulars = ["{$prefix}name", "{$prefix}value", "{$prefix}owner_guid", "{$prefix}id"];
-		$options = _elgg_normalize_plural_options_array($options, $singulars);
-
-		foreach ($map as $specific => $normalized) {
-			$key = $prefix . $specific;
-			if (isset($options[$key])) {
-				$options[$normalized] = $options[$key];
-			}
-		}
-	}
-
-	return $options;
+    // support either metastrings_type or metastring_type
+    // because I've made this mistake many times and hunting it down is a pain...
+    $type = elgg_extract('metastring_type', $options, null);
+    $type = elgg_extract('metastrings_type', $options, $type);
+
+    $options['metastring_type'] = $type;
+
+    // support annotation_ and annotations_ because they're way too easy to confuse
+    $prefixes = ['metadata_', 'annotation_', 'annotations_'];
+
+    // map the metadata_* options to metastring_* options
+    $map = [
+        'names'                 => 'metastring_names',
+        'values'                => 'metastring_values',
+        'case_sensitive'        => 'metastring_case_sensitive',
+        'owner_guids'           => 'metastring_owner_guids',
+        'created_time_lower'    => 'metastring_created_time_lower',
+        'created_time_upper'    => 'metastring_created_time_upper',
+        'calculation'           => 'metastring_calculation',
+        'ids'                   => 'metastring_ids',
+    ];
+
+    foreach ($prefixes as $prefix) {
+        $singulars = ["{$prefix}name", "{$prefix}value", "{$prefix}owner_guid", "{$prefix}id"];
+        $options = _elgg_normalize_plural_options_array($options, $singulars);
+
+        foreach ($map as $specific => $normalized) {
+            $key = $prefix . $specific;
+            if (isset($options[$key])) {
+                $options[$normalized] = $options[$key];
+            }
+        }
+    }
+
+    return $options;
 }
 
 /**
@@ -482,48 +482,48 @@ 
  * @access private
  */
 function _elgg_set_metastring_based_object_enabled_by_id($id, $enabled, $type) {
-	$id = (int) $id;
-	$db_prefix = _elgg_config()->dbprefix;
-
-	$object = _elgg_get_metastring_based_object_from_id($id, $type);
-
-	switch ($type) {
-		case 'annotation':
-		case 'annotations':
-			$type = 'annotation';
-			$table = "{$db_prefix}annotations";
-			break;
-
-		case 'metadata':
-			$table = "{$db_prefix}metadata";
-			break;
-	}
-
-	if ($enabled === 'yes' || $enabled === 1 || $enabled === true) {
-		$enabled = 'yes';
-		$event = 'enable';
-	} elseif ($enabled === 'no' || $enabled === 0 || $enabled === false) {
-		$enabled = 'no';
-		$event = 'disable';
-	} else {
-		return false;
-	}
-
-	$return = false;
-
-	if ($object) {
-		// don't set it if it's already set.
-		if ($object->enabled == $enabled) {
-			$return = false;
-		} elseif ($object->canEdit() && (elgg_trigger_event($event, $type, $object))) {
-			$return = update_data("UPDATE $table SET enabled = :enabled where id = :id", [
-				':enabled' => $enabled,
-				':id' => $id,
-			]);
-		}
-	}
-
-	return $return;
+    $id = (int) $id;
+    $db_prefix = _elgg_config()->dbprefix;
+
+    $object = _elgg_get_metastring_based_object_from_id($id, $type);
+
+    switch ($type) {
+        case 'annotation':
+        case 'annotations':
+            $type = 'annotation';
+            $table = "{$db_prefix}annotations";
+            break;
+
+        case 'metadata':
+            $table = "{$db_prefix}metadata";
+            break;
+    }
+
+    if ($enabled === 'yes' || $enabled === 1 || $enabled === true) {
+        $enabled = 'yes';
+        $event = 'enable';
+    } elseif ($enabled === 'no' || $enabled === 0 || $enabled === false) {
+        $enabled = 'no';
+        $event = 'disable';
+    } else {
+        return false;
+    }
+
+    $return = false;
+
+    if ($object) {
+        // don't set it if it's already set.
+        if ($object->enabled == $enabled) {
+            $return = false;
+        } elseif ($object->canEdit() && (elgg_trigger_event($event, $type, $object))) {
+            $return = update_data("UPDATE $table SET enabled = :enabled where id = :id", [
+                ':enabled' => $enabled,
+                ':id' => $id,
+            ]);
+        }
+    }
+
+    return $return;
 }
 
 /**
@@ -542,12 +542,12 @@ 
  * @access private
  */
 function _elgg_batch_metastring_based_objects(array $options, $callback, $inc_offset = true) {
-	if (!$options || !is_array($options)) {
-		return false;
-	}
+    if (!$options || !is_array($options)) {
+        return false;
+    }
 
-	$batch = new \ElggBatch('_elgg_get_metastring_based_objects', $options, $callback, 50, $inc_offset);
-	return $batch->callbackResult;
+    $batch = new \ElggBatch('_elgg_get_metastring_based_objects', $options, $callback, 50, $inc_offset);
+    return $batch->callbackResult;
 }
 
 /**
@@ -559,23 +559,23 @@ 
  * @access private
  */
 function _elgg_get_metastring_based_object_from_id($id, $type) {
-	$id = (int) $id;
-	if (!$id) {
-		return false;
-	}
+    $id = (int) $id;
+    if (!$id) {
+        return false;
+    }
 
-	$options = [
-		'metastring_type' => $type,
-		'metastring_id' => $id,
-	];
+    $options = [
+        'metastring_type' => $type,
+        'metastring_id' => $id,
+    ];
 
-	$obj = _elgg_get_metastring_based_objects($options);
+    $obj = _elgg_get_metastring_based_objects($options);
 
-	if ($obj && count($obj) == 1) {
-		return $obj[0];
-	}
+    if ($obj && count($obj) == 1) {
+        return $obj[0];
+    }
 
-	return false;
+    return false;
 }
 
 /**
@@ -587,38 +587,38 @@ 
  * @access private
  */
 function _elgg_delete_metastring_based_object_by_id($id, $type) {
-	$id = (int) $id;
-	$db_prefix = _elgg_config()->dbprefix;
-
-	switch ($type) {
-		case 'annotations':
-		case 'annotation':
-			$table = $db_prefix . 'annotations';
-			$type = 'annotation';
-			break;
-
-		case 'metadata':
-			$table = $db_prefix . 'metadata';
-			$type = 'metadata';
-			break;
-
-		default:
-			return false;
-	}
-
-	$obj = _elgg_get_metastring_based_object_from_id($id, $type);
-
-	if ($obj) {
-		if ($obj->canEdit()) {
-			if (elgg_trigger_event('delete', $type, $obj)) {
-				return (bool) delete_data("DELETE FROM $table WHERE id = :id", [
-					':id' => $id,
-				]);
-			}
-		}
-	}
-
-	return false;
+    $id = (int) $id;
+    $db_prefix = _elgg_config()->dbprefix;
+
+    switch ($type) {
+        case 'annotations':
+        case 'annotation':
+            $table = $db_prefix . 'annotations';
+            $type = 'annotation';
+            break;
+
+        case 'metadata':
+            $table = $db_prefix . 'metadata';
+            $type = 'metadata';
+            break;
+
+        default:
+            return false;
+    }
+
+    $obj = _elgg_get_metastring_based_object_from_id($id, $type);
+
+    if ($obj) {
+        if ($obj->canEdit()) {
+            if (elgg_trigger_event('delete', $type, $obj)) {
+                return (bool) delete_data("DELETE FROM $table WHERE id = :id", [
+                    ':id' => $id,
+                ]);
+            }
+        }
+    }
+
+    return false;
 }
 
 /**
@@ -631,54 +631,54 @@ 
  * @access private
  */
 function _elgg_entities_get_metastrings_options($type, $options) {
-	$valid_types = ['metadata', 'annotation'];
-	if (!in_array($type, $valid_types)) {
-		return false;
-	}
-
-	// the options for annotations are singular (annotation_name) but the table
-	// is plural (elgg_annotations) so rewrite for the table name.
-	$n_table = ($type == 'annotation') ? 'annotations' : $type;
-
-	$singulars = ["{$type}_name", "{$type}_value",
-		"{$type}_name_value_pair", "{$type}_owner_guid"];
-	$options = _elgg_normalize_plural_options_array($options, $singulars);
-
-	$clauses = _elgg_get_entity_metadata_where_sql('e', $n_table, $options["{$type}_names"],
-		$options["{$type}_values"], $options["{$type}_name_value_pairs"],
-		$options["{$type}_name_value_pairs_operator"], $options["{$type}_case_sensitive"],
-		$options["order_by_{$type}"], $options["{$type}_owner_guids"]);
-
-	if ($clauses) {
-		// merge wheres to pass to elgg_get_entities()
-		if (isset($options['wheres']) && !is_array($options['wheres'])) {
-			$options['wheres'] = [$options['wheres']];
-		} elseif (!isset($options['wheres'])) {
-			$options['wheres'] = [];
-		}
-
-		$options['wheres'] = array_merge($options['wheres'], $clauses['wheres']);
-
-		// merge joins to pass to elgg_get_entities()
-		if (isset($options['joins']) && !is_array($options['joins'])) {
-			$options['joins'] = [$options['joins']];
-		} elseif (!isset($options['joins'])) {
-			$options['joins'] = [];
-		}
-
-		$options['joins'] = array_merge($options['joins'], $clauses['joins']);
-
-		if ($clauses['orders']) {
-			$order_by_metadata = implode(", ", $clauses['orders']);
-			if (isset($options['order_by']) && $options['order_by']) {
-				$options['order_by'] = "$order_by_metadata, {$options['order_by']}";
-			} else {
-				$options['order_by'] = "$order_by_metadata, e.time_created DESC";
-			}
-		}
-	}
-
-	return $options;
+    $valid_types = ['metadata', 'annotation'];
+    if (!in_array($type, $valid_types)) {
+        return false;
+    }
+
+    // the options for annotations are singular (annotation_name) but the table
+    // is plural (elgg_annotations) so rewrite for the table name.
+    $n_table = ($type == 'annotation') ? 'annotations' : $type;
+
+    $singulars = ["{$type}_name", "{$type}_value",
+        "{$type}_name_value_pair", "{$type}_owner_guid"];
+    $options = _elgg_normalize_plural_options_array($options, $singulars);
+
+    $clauses = _elgg_get_entity_metadata_where_sql('e', $n_table, $options["{$type}_names"],
+        $options["{$type}_values"], $options["{$type}_name_value_pairs"],
+        $options["{$type}_name_value_pairs_operator"], $options["{$type}_case_sensitive"],
+        $options["order_by_{$type}"], $options["{$type}_owner_guids"]);
+
+    if ($clauses) {
+        // merge wheres to pass to elgg_get_entities()
+        if (isset($options['wheres']) && !is_array($options['wheres'])) {
+            $options['wheres'] = [$options['wheres']];
+        } elseif (!isset($options['wheres'])) {
+            $options['wheres'] = [];
+        }
+
+        $options['wheres'] = array_merge($options['wheres'], $clauses['wheres']);
+
+        // merge joins to pass to elgg_get_entities()
+        if (isset($options['joins']) && !is_array($options['joins'])) {
+            $options['joins'] = [$options['joins']];
+        } elseif (!isset($options['joins'])) {
+            $options['joins'] = [];
+        }
+
+        $options['joins'] = array_merge($options['joins'], $clauses['joins']);
+
+        if ($clauses['orders']) {
+            $order_by_metadata = implode(", ", $clauses['orders']);
+            if (isset($options['order_by']) && $options['order_by']) {
+                $options['order_by'] = "$order_by_metadata, {$options['order_by']}";
+            } else {
+                $options['order_by'] = "$order_by_metadata, e.time_created DESC";
+            }
+        }
+    }
+
+    return $options;
 }
 
 /**
@@ -692,13 +692,13 @@ 
  * @access private
  */
 function _elgg_metastrings_test($hook, $type, $value) {
-	$value[] = Paths::elgg() . 'engine/tests/ElggCoreMetastringsTest.php';
-	return $value;
+    $value[] = Paths::elgg() . 'engine/tests/ElggCoreMetastringsTest.php';
+    return $value;
 }
 
 /**
  * @see \Elgg\Application::loadCore Do not do work here. Just register for events.
  */
 return function(\Elgg\EventsService $events, \Elgg\HooksRegistrationService $hooks) {
-	$hooks->registerHandler('unit_test', 'system', '_elgg_metastrings_test');
+    $hooks->registerHandler('unit_test', 'system', '_elgg_metastrings_test');
 };

Spacing +7 added lines, -7 removed lines

@@ -340,7 +340,7 @@ 
 	// only supported on values.
 	$binary = ($case_sensitive) ? ' BINARY ' : '';
 
-	$return =  [
+	$return = [
 		'joins' =>  [],
 		'wheres' => []
 	];
@@ -360,7 +360,7 @@ 
 			if (!$name) {
 				$name = '0';
 			}
-			$sanitised_names[] = '\'' . sanitise_string($name) . '\'';
+			$sanitised_names[] = '\''.sanitise_string($name).'\'';
 		}
 
 		if ($names_str = implode(',', $sanitised_names)) {
@@ -381,7 +381,7 @@ 
 			if (!$value) {
 				$value = 0;
 			}
-			$sanitised_values[] = '\'' . sanitise_string($value) . '\'';
+			$sanitised_values[] = '\''.sanitise_string($value).'\'';
 		}
 
 		if ($values_str = implode(',', $sanitised_values)) {
@@ -457,7 +457,7 @@ 
 		$options = _elgg_normalize_plural_options_array($options, $singulars);
 
 		foreach ($map as $specific => $normalized) {
-			$key = $prefix . $specific;
+			$key = $prefix.$specific;
 			if (isset($options[$key])) {
 				$options[$normalized] = $options[$key];
 			}
@@ -593,12 +593,12 @@ 
 	switch ($type) {
 		case 'annotations':
 		case 'annotation':
-			$table = $db_prefix . 'annotations';
+			$table = $db_prefix.'annotations';
 			$type = 'annotation';
 			break;
 
 		case 'metadata':
-			$table = $db_prefix . 'metadata';
+			$table = $db_prefix.'metadata';
 			$type = 'metadata';
 			break;
 
@@ -692,7 +692,7 @@ 
  * @access private
  */
 function _elgg_metastrings_test($hook, $type, $value) {
-	$value[] = Paths::elgg() . 'engine/tests/ElggCoreMetastringsTest.php';
+	$value[] = Paths::elgg().'engine/tests/ElggCoreMetastringsTest.php';
 	return $value;
 }
 

engine/lib/sessions.php

Doc Comments +2 added lines, -2 removed lines

@@ -130,7 +130,7 @@ 
  * @param string $username The username
  * @param string $password The password
  *
- * @return true|string True or an error message on failure
+ * @return string|boolean True or an error message on failure
  * @access private
  */
 function elgg_authenticate($username, $password) {
@@ -314,7 +314,7 @@ 
  * @param \ElggUser $user       A valid Elgg user object
  * @param boolean   $persistent Should this be a persistent login?
  *
- * @return true or throws exception
+ * @return boolean or throws exception
  * @throws LoginException
  */
 function login(\ElggUser $user, $persistent = false) {

Indentation +173 added lines, -173 removed lines

@@ -18,7 +18,7 @@ 
  * @since 1.9
  */
 function elgg_get_session() {
-	return _elgg_services()->session;
+    return _elgg_services()->session;
 }
 
 /**
@@ -27,7 +27,7 @@ 
  * @return \ElggUser|null
  */
 function elgg_get_logged_in_user_entity() {
-	return _elgg_services()->session->getLoggedInUser();
+    return _elgg_services()->session->getLoggedInUser();
 }
 
 /**
@@ -37,7 +37,7 @@ 
  * @return int
  */
 function elgg_get_logged_in_user_guid() {
-	return _elgg_services()->session->getLoggedInUserGuid();
+    return _elgg_services()->session->getLoggedInUserGuid();
 }
 
 /**
@@ -46,7 +46,7 @@ 
  * @return bool
  */
 function elgg_is_logged_in() {
-	return _elgg_services()->session->isLoggedIn();
+    return _elgg_services()->session->isLoggedIn();
 }
 
 /**
@@ -55,7 +55,7 @@ 
  * @return bool
  */
 function elgg_is_admin_logged_in() {
-	return _elgg_services()->session->isAdminLoggedIn();
+    return _elgg_services()->session->isAdminLoggedIn();
 }
 
 /**
@@ -70,28 +70,28 @@ 
  */
 function elgg_is_admin_user($user_guid) {
 	
-	$user_guid = (int) $user_guid;
+    $user_guid = (int) $user_guid;
 
-	$current_user = elgg_get_logged_in_user_entity();
-	if ($current_user && $current_user->guid == $user_guid) {
-		return $current_user->isAdmin();
-	}
+    $current_user = elgg_get_logged_in_user_entity();
+    if ($current_user && $current_user->guid == $user_guid) {
+        return $current_user->isAdmin();
+    }
 
-	// cannot use magic metadata here because of recursion
-	$dbprefix = _elgg_config()->dbprefix;
-	$query = "SELECT 1 FROM {$dbprefix}users_entity as e
+    // cannot use magic metadata here because of recursion
+    $dbprefix = _elgg_config()->dbprefix;
+    $query = "SELECT 1 FROM {$dbprefix}users_entity as e
 		WHERE (
 			e.guid = {$user_guid}
 			AND e.admin = 'yes'
 		)";
 
-	// normalizing the results from get_data()
-	// See #1242
-	$info = get_data($query);
-	if (!((is_array($info) && count($info) < 1) || $info === false)) {
-		return true;
-	}
-	return false;
+    // normalizing the results from get_data()
+    // See #1242
+    $info = get_data($query);
+    if (!((is_array($info) && count($info) < 1) || $info === false)) {
+        return true;
+    }
+    return false;
 }
 
 /**
@@ -110,13 +110,13 @@ 
  * @access private
  */
 function elgg_authenticate($username, $password) {
-	$pam = new \ElggPAM('user');
-	$credentials = ['username' => $username, 'password' => $password];
-	$result = $pam->authenticate($credentials);
-	if (!$result) {
-		return $pam->getFailureMessage();
-	}
-	return true;
+    $pam = new \ElggPAM('user');
+    $credentials = ['username' => $username, 'password' => $password];
+    $result = $pam->authenticate($credentials);
+    if (!$result) {
+        return $pam->getFailureMessage();
+    }
+    return true;
 }
 
 /**
@@ -133,33 +133,33 @@ 
  */
 function pam_auth_userpass(array $credentials = []) {
 
-	if (!isset($credentials['username']) || !isset($credentials['password'])) {
-		return false;
-	}
+    if (!isset($credentials['username']) || !isset($credentials['password'])) {
+        return false;
+    }
 
-	$user = get_user_by_username($credentials['username']);
-	if (!$user) {
-		throw new \LoginException(_elgg_services()->translator->translate('LoginException:UsernameFailure'));
-	}
+    $user = get_user_by_username($credentials['username']);
+    if (!$user) {
+        throw new \LoginException(_elgg_services()->translator->translate('LoginException:UsernameFailure'));
+    }
 
-	$password_svc = _elgg_services()->passwords;
-	$password = $credentials['password'];
-	$hash = $user->password_hash;
+    $password_svc = _elgg_services()->passwords;
+    $password = $credentials['password'];
+    $hash = $user->password_hash;
 
-	if (check_rate_limit_exceeded($user->guid)) {
-		throw new \LoginException(_elgg_services()->translator->translate('LoginException:AccountLocked'));
-	}
+    if (check_rate_limit_exceeded($user->guid)) {
+        throw new \LoginException(_elgg_services()->translator->translate('LoginException:AccountLocked'));
+    }
 
-	if (!$password_svc->verify($password, $hash)) {
-		log_login_failure($user->guid);
-		throw new \LoginException(_elgg_services()->translator->translate('LoginException:PasswordFailure'));
-	}
+    if (!$password_svc->verify($password, $hash)) {
+        log_login_failure($user->guid);
+        throw new \LoginException(_elgg_services()->translator->translate('LoginException:PasswordFailure'));
+    }
 
-	if ($password_svc->needsRehash($hash)) {
-		$password_svc->forcePasswordReset($user, $password);
-	}
+    if ($password_svc->needsRehash($hash)) {
+        $password_svc->forcePasswordReset($user, $password);
+    }
 
-	return true;
+    return true;
 }
 
 /**
@@ -170,19 +170,19 @@ 
  * @return bool
  */
 function log_login_failure($user_guid) {
-	$user_guid = (int) $user_guid;
-	$user = get_entity($user_guid);
+    $user_guid = (int) $user_guid;
+    $user = get_entity($user_guid);
 
-	if (($user_guid) && ($user) && ($user instanceof \ElggUser)) {
-		$fails = (int) $user->getPrivateSetting("login_failures");
-		$fails++;
+    if (($user_guid) && ($user) && ($user instanceof \ElggUser)) {
+        $fails = (int) $user->getPrivateSetting("login_failures");
+        $fails++;
 
-		$user->setPrivateSetting("login_failures", $fails);
-		$user->setPrivateSetting("login_failure_$fails", time());
-		return true;
-	}
+        $user->setPrivateSetting("login_failures", $fails);
+        $user->setPrivateSetting("login_failure_$fails", time());
+        return true;
+    }
 
-	return false;
+    return false;
 }
 
 /**
@@ -193,27 +193,27 @@ 
  * @return bool true on success (success = user has no logged failed attempts)
  */
 function reset_login_failure_count($user_guid) {
-	$user_guid = (int) $user_guid;
-	$user = get_entity($user_guid);
+    $user_guid = (int) $user_guid;
+    $user = get_entity($user_guid);
 
-	if (($user_guid) && ($user) && ($user instanceof \ElggUser)) {
-		$fails = (int) $user->getPrivateSetting("login_failures");
+    if (($user_guid) && ($user) && ($user instanceof \ElggUser)) {
+        $fails = (int) $user->getPrivateSetting("login_failures");
 
-		if ($fails) {
-			for ($n = 1; $n <= $fails; $n++) {
-				$user->removePrivateSetting("login_failure_$n");
-			}
+        if ($fails) {
+            for ($n = 1; $n <= $fails; $n++) {
+                $user->removePrivateSetting("login_failure_$n");
+            }
 
-			$user->removePrivateSetting("login_failures");
+            $user->removePrivateSetting("login_failures");
 
-			return true;
-		}
+            return true;
+        }
 
-		// nothing to reset
-		return true;
-	}
+        // nothing to reset
+        return true;
+    }
 
-	return false;
+    return false;
 }
 
 /**
@@ -224,31 +224,31 @@ 
  * @return bool on exceeded limit.
  */
 function check_rate_limit_exceeded($user_guid) {
-	// 5 failures in 5 minutes causes temporary block on logins
-	$limit = 5;
-	$user_guid = (int) $user_guid;
-	$user = get_entity($user_guid);
-
-	if (($user_guid) && ($user) && ($user instanceof \ElggUser)) {
-		$fails = (int) $user->getPrivateSetting("login_failures");
-		if ($fails >= $limit) {
-			$cnt = 0;
-			$time = time();
-			for ($n = $fails; $n > 0; $n--) {
-				$f = $user->getPrivateSetting("login_failure_$n");
-				if ($f > $time - (60 * 5)) {
-					$cnt++;
-				}
-
-				if ($cnt == $limit) {
-					// Limit reached
-					return true;
-				}
-			}
-		}
-	}
-
-	return false;
+    // 5 failures in 5 minutes causes temporary block on logins
+    $limit = 5;
+    $user_guid = (int) $user_guid;
+    $user = get_entity($user_guid);
+
+    if (($user_guid) && ($user) && ($user instanceof \ElggUser)) {
+        $fails = (int) $user->getPrivateSetting("login_failures");
+        if ($fails >= $limit) {
+            $cnt = 0;
+            $time = time();
+            for ($n = $fails; $n > 0; $n--) {
+                $f = $user->getPrivateSetting("login_failure_$n");
+                if ($f > $time - (60 * 5)) {
+                    $cnt++;
+                }
+
+                if ($cnt == $limit) {
+                    // Limit reached
+                    return true;
+                }
+            }
+        }
+    }
+
+    return false;
 }
 
 /**
@@ -261,11 +261,11 @@ 
  * @since 1.9
  */
 function elgg_set_cookie(\ElggCookie $cookie) {
-	if (elgg_trigger_event('init:cookie', $cookie->name, $cookie)) {
-		return setcookie($cookie->name, $cookie->value, $cookie->expire, $cookie->path,
-						$cookie->domain, $cookie->secure, $cookie->httpOnly);
-	}
-	return false;
+    if (elgg_trigger_event('init:cookie', $cookie->name, $cookie)) {
+        return setcookie($cookie->name, $cookie->value, $cookie->expire, $cookie->path,
+                        $cookie->domain, $cookie->secure, $cookie->httpOnly);
+    }
+    return false;
 }
 
 /**
@@ -281,35 +281,35 @@ 
  * @throws LoginException
  */
 function login(\ElggUser $user, $persistent = false) {
-	if ($user->isBanned()) {
-		throw new \LoginException(elgg_echo('LoginException:BannedUser'));
-	}
+    if ($user->isBanned()) {
+        throw new \LoginException(elgg_echo('LoginException:BannedUser'));
+    }
 
-	$session = _elgg_services()->session;
+    $session = _elgg_services()->session;
 
-	// give plugins a chance to reject the login of this user (no user in session!)
-	if (!elgg_trigger_before_event('login', 'user', $user)) {
-		throw new \LoginException(elgg_echo('LoginException:Unknown'));
-	}
+    // give plugins a chance to reject the login of this user (no user in session!)
+    if (!elgg_trigger_before_event('login', 'user', $user)) {
+        throw new \LoginException(elgg_echo('LoginException:Unknown'));
+    }
 
-	// #5933: set logged in user early so code in login event will be able to
-	// use elgg_get_logged_in_user_entity().
-	$session->setLoggedInUser($user);
+    // #5933: set logged in user early so code in login event will be able to
+    // use elgg_get_logged_in_user_entity().
+    $session->setLoggedInUser($user);
 
-	// if remember me checked, set cookie with token and store hash(token) for user
-	if ($persistent) {
-		_elgg_services()->persistentLogin->makeLoginPersistent($user);
-	}
+    // if remember me checked, set cookie with token and store hash(token) for user
+    if ($persistent) {
+        _elgg_services()->persistentLogin->makeLoginPersistent($user);
+    }
 
-	// User's privilege has been elevated, so change the session id (prevents session fixation)
-	$session->migrate();
+    // User's privilege has been elevated, so change the session id (prevents session fixation)
+    $session->migrate();
 
-	set_last_login($user->guid);
-	reset_login_failure_count($user->guid);
+    set_last_login($user->guid);
+    reset_login_failure_count($user->guid);
 
-	elgg_trigger_after_event('login', 'user', $user);
+    elgg_trigger_after_event('login', 'user', $user);
 
-	return true;
+    return true;
 }
 
 /**
@@ -318,26 +318,26 @@ 
  * @return bool
  */
 function logout() {
-	$session = _elgg_services()->session;
-	$user = $session->getLoggedInUser();
-	if (!$user) {
-		return false;
-	}
+    $session = _elgg_services()->session;
+    $user = $session->getLoggedInUser();
+    if (!$user) {
+        return false;
+    }
 
-	if (!elgg_trigger_before_event('logout', 'user', $user)) {
-		return false;
-	}
+    if (!elgg_trigger_before_event('logout', 'user', $user)) {
+        return false;
+    }
 
-	_elgg_services()->persistentLogin->removePersistentLogin();
+    _elgg_services()->persistentLogin->removePersistentLogin();
 
-	// pass along any messages into new session
-	$old_msg = $session->get(SystemMessagesService::SESSION_KEY, []);
-	$session->invalidate();
-	$session->set(SystemMessagesService::SESSION_KEY, $old_msg);
+    // pass along any messages into new session
+    $old_msg = $session->get(SystemMessagesService::SESSION_KEY, []);
+    $session->invalidate();
+    $session->set(SystemMessagesService::SESSION_KEY, $old_msg);
 
-	elgg_trigger_after_event('logout', 'user', $user);
+    elgg_trigger_after_event('logout', 'user', $user);
 
-	return true;
+    return true;
 }
 
 /**
@@ -349,44 +349,44 @@ 
  * @access private
  */
 function _elgg_session_boot(ServiceProvider $services) {
-	$services->timer->begin([__FUNCTION__]);
-
-	$session = $services->session;
-	$session->start();
-
-	// test whether we have a user session
-	if ($session->has('guid')) {
-		/** @var ElggUser $user */
-		$user = $services->entityTable->get($session->get('guid'), 'user');
-		if (!$user) {
-			// OMG user has been deleted.
-			$session->invalidate();
-			forward('');
-		}
-
-		$services->persistentLogin->replaceLegacyToken($user);
-	} else {
-		$user = $services->persistentLogin->bootSession();
-	}
-
-	if ($user) {
-		$session->setLoggedInUser($user);
-		set_last_action($user);
-
-		// logout a user with open session who has been banned
-		if ($user->isBanned()) {
-			logout();
-			return false;
-		}
-	}
-
-	$services->timer->end([__FUNCTION__]);
-	return true;
+    $services->timer->begin([__FUNCTION__]);
+
+    $session = $services->session;
+    $session->start();
+
+    // test whether we have a user session
+    if ($session->has('guid')) {
+        /** @var ElggUser $user */
+        $user = $services->entityTable->get($session->get('guid'), 'user');
+        if (!$user) {
+            // OMG user has been deleted.
+            $session->invalidate();
+            forward('');
+        }
+
+        $services->persistentLogin->replaceLegacyToken($user);
+    } else {
+        $user = $services->persistentLogin->bootSession();
+    }
+
+    if ($user) {
+        $session->setLoggedInUser($user);
+        set_last_action($user);
+
+        // logout a user with open session who has been banned
+        if ($user->isBanned()) {
+            logout();
+            return false;
+        }
+    }
+
+    $services->timer->end([__FUNCTION__]);
+    return true;
 }
 
 /**
  * @see \Elgg\Application::loadCore Do not do work here. Just register for events.
  */
 return function(\Elgg\EventsService $events, \Elgg\HooksRegistrationService $hooks) {
-	register_pam_handler('pam_auth_userpass');
+    register_pam_handler('pam_auth_userpass');
 };

engine/lib/system_log.php

Doc Comments +2 added lines, -2 removed lines

@@ -298,7 +298,7 @@ 
  * @param string   $object_type Object type
  * @param Loggable $object      Object to log
  *
- * @return true
+ * @return boolean
  */
 function system_log_default_logger($event, $object_type, $object) {
 	system_log($object['object'], $object['event']);
@@ -314,7 +314,7 @@ 
  * @param String   $object_type Type of object
  * @param Loggable $object      Object to log
  *
- * @return true
+ * @return boolean
  * @access private
  */
 function system_log_listener($event, $object_type, $object) {

Spacing +4 added lines, -4 removed lines

@@ -59,7 +59,7 @@ 
 		if (is_int($by_user)) {
 			$where[] = "performed_by_guid=$by_user";
 		} else if (is_array($by_user)) {
-			$where [] = "performed_by_guid in (" . implode(",", $by_user) . ")";
+			$where [] = "performed_by_guid in (".implode(",", $by_user).")";
 		}
 	}
 	if ($event != "") {
@@ -76,13 +76,13 @@ 
 	}
 
 	if ($timebefore) {
-		$where[] = "time_created < " . ((int) $timebefore);
+		$where[] = "time_created < ".((int) $timebefore);
 	}
 	if ($timeafter) {
-		$where[] = "time_created > " . ((int) $timeafter);
+		$where[] = "time_created > ".((int) $timeafter);
 	}
 	if ($object_id) {
-		$where[] = "object_id = " . ((int) $object_id);
+		$where[] = "object_id = ".((int) $object_id);
 	}
 	if ($ip_address) {
 		$where[] = "ip_address = '$ip_address'";

Indentation +209 added lines, -209 removed lines

@@ -28,90 +28,90 @@ 
  * @return mixed
  */
 function get_system_log($by_user = "", $event = "", $class = "", $type = "", $subtype = "", $limit = null,
-						$offset = 0, $count = false, $timebefore = 0, $timeafter = 0, $object_id = 0,
-						$ip_address = "") {
-
-	$by_user_orig = $by_user;
-	if (is_array($by_user) && sizeof($by_user) > 0) {
-		foreach ($by_user as $key => $val) {
-			$by_user[$key] = (int) $val;
-		}
-	} else {
-		$by_user = (int) $by_user;
-	}
+                        $offset = 0, $count = false, $timebefore = 0, $timeafter = 0, $object_id = 0,
+                        $ip_address = "") {
+
+    $by_user_orig = $by_user;
+    if (is_array($by_user) && sizeof($by_user) > 0) {
+        foreach ($by_user as $key => $val) {
+            $by_user[$key] = (int) $val;
+        }
+    } else {
+        $by_user = (int) $by_user;
+    }
 	
-	$event = sanitise_string($event);
-	$class = sanitise_string($class);
-	$type = sanitise_string($type);
-	$subtype = sanitise_string($subtype);
-	$ip_address = sanitise_string($ip_address);
-	if ($limit === null) {
-		$limit = _elgg_config()->default_limit;
-	}
-	$limit = (int) $limit;
-	$offset = (int) $offset;
-
-	$where = [];
-
-	if ($by_user_orig !== "" && $by_user_orig !== false && $by_user_orig !== null) {
-		if (is_int($by_user)) {
-			$where[] = "performed_by_guid=$by_user";
-		} else if (is_array($by_user)) {
-			$where [] = "performed_by_guid in (" . implode(",", $by_user) . ")";
-		}
-	}
-	if ($event != "") {
-		$where[] = "event='$event'";
-	}
-	if ($class !== "") {
-		$where[] = "object_class='$class'";
-	}
-	if ($type != "") {
-		$where[] = "object_type='$type'";
-	}
-	if ($subtype !== "") {
-		$where[] = "object_subtype='$subtype'";
-	}
-
-	if ($timebefore) {
-		$where[] = "time_created < " . ((int) $timebefore);
-	}
-	if ($timeafter) {
-		$where[] = "time_created > " . ((int) $timeafter);
-	}
-	if ($object_id) {
-		$where[] = "object_id = " . ((int) $object_id);
-	}
-	if ($ip_address) {
-		$where[] = "ip_address = '$ip_address'";
-	}
-
-	$select = "*";
-	if ($count) {
-		$select = "count(*) as count";
-	}
-
-	$prefix = _elgg_config()->dbprefix;
-	$query = "SELECT $select from {$prefix}system_log where 1 ";
-	foreach ($where as $w) {
-		$query .= " and $w";
-	}
-
-	if (!$count) {
-		$query .= " order by time_created desc";
-		$query .= " limit $offset, $limit"; // Add order and limit
-	}
-
-	if ($count) {
-		$numrows = get_data_row($query);
-		if ($numrows) {
-			return $numrows->count;
-		}
-	} else {
-		return get_data($query);
-	}
-
-	return false;
+    $event = sanitise_string($event);
+    $class = sanitise_string($class);
+    $type = sanitise_string($type);
+    $subtype = sanitise_string($subtype);
+    $ip_address = sanitise_string($ip_address);
+    if ($limit === null) {
+        $limit = _elgg_config()->default_limit;
+    }
+    $limit = (int) $limit;
+    $offset = (int) $offset;
+
+    $where = [];
+
+    if ($by_user_orig !== "" && $by_user_orig !== false && $by_user_orig !== null) {
+        if (is_int($by_user)) {
+            $where[] = "performed_by_guid=$by_user";
+        } else if (is_array($by_user)) {
+            $where [] = "performed_by_guid in (" . implode(",", $by_user) . ")";
+        }
+    }
+    if ($event != "") {
+        $where[] = "event='$event'";
+    }
+    if ($class !== "") {
+        $where[] = "object_class='$class'";
+    }
+    if ($type != "") {
+        $where[] = "object_type='$type'";
+    }
+    if ($subtype !== "") {
+        $where[] = "object_subtype='$subtype'";
+    }
+
+    if ($timebefore) {
+        $where[] = "time_created < " . ((int) $timebefore);
+    }
+    if ($timeafter) {
+        $where[] = "time_created > " . ((int) $timeafter);
+    }
+    if ($object_id) {
+        $where[] = "object_id = " . ((int) $object_id);
+    }
+    if ($ip_address) {
+        $where[] = "ip_address = '$ip_address'";
+    }
+
+    $select = "*";
+    if ($count) {
+        $select = "count(*) as count";
+    }
+
+    $prefix = _elgg_config()->dbprefix;
+    $query = "SELECT $select from {$prefix}system_log where 1 ";
+    foreach ($where as $w) {
+        $query .= " and $w";
+    }
+
+    if (!$count) {
+        $query .= " order by time_created desc";
+        $query .= " limit $offset, $limit"; // Add order and limit
+    }
+
+    if ($count) {
+        $numrows = get_data_row($query);
+        if ($numrows) {
+            return $numrows->count;
+        }
+    } else {
+        return get_data($query);
+    }
+
+    return false;
 }
 
 /**
@@ -122,10 +122,10 @@ 
  * @return mixed
  */
 function get_log_entry($entry_id) {
-	$entry_id = (int) $entry_id;
+    $entry_id = (int) $entry_id;
 
-	$prefix = _elgg_config()->dbprefix;
-	return get_data_row("SELECT * from {$prefix}system_log where id=$entry_id");
+    $prefix = _elgg_config()->dbprefix;
+    return get_data_row("SELECT * from {$prefix}system_log where id=$entry_id");
 }
 
 /**
@@ -136,45 +136,45 @@ 
  * @return mixed
  */
 function get_object_from_log_entry($entry) {
-	if (is_numeric($entry)) {
-		$entry = get_log_entry($entry);
-		if (!$entry) {
-			return false;
-		}
-	}
-
-	$class = $entry->object_class;
-	$id = $entry->object_id;
-
-	if (!class_exists($class)) {
-		// failed autoload
-		return false;
-	}
-
-	$getters = [
-		'ElggAnnotation' => 'elgg_get_annotation_from_id',
-		'ElggMetadata' => 'elgg_get_metadata_from_id',
-		'ElggRelationship' => 'get_relationship',
-	];
-
-	if (isset($getters[$class]) && is_callable($getters[$class])) {
-		$object = call_user_func($getters[$class], $id);
-	} elseif (preg_match('~^Elgg[A-Z]~', $class)) {
-		$object = get_entity($id);
-	} else {
-		// surround with try/catch because object could be disabled
-		try {
-			$object = new $class($entry->object_id);
-			return $object;
-		} catch (Exception $e) {
-		}
-	}
-
-	if (!is_object($object) || get_class($object) !== $class) {
-		return false;
-	}
-
-	return $object;
+    if (is_numeric($entry)) {
+        $entry = get_log_entry($entry);
+        if (!$entry) {
+            return false;
+        }
+    }
+
+    $class = $entry->object_class;
+    $id = $entry->object_id;
+
+    if (!class_exists($class)) {
+        // failed autoload
+        return false;
+    }
+
+    $getters = [
+        'ElggAnnotation' => 'elgg_get_annotation_from_id',
+        'ElggMetadata' => 'elgg_get_metadata_from_id',
+        'ElggRelationship' => 'get_relationship',
+    ];
+
+    if (isset($getters[$class]) && is_callable($getters[$class])) {
+        $object = call_user_func($getters[$class], $id);
+    } elseif (preg_match('~^Elgg[A-Z]~', $class)) {
+        $object = get_entity($id);
+    } else {
+        // surround with try/catch because object could be disabled
+        try {
+            $object = new $class($entry->object_id);
+            return $object;
+        } catch (Exception $e) {
+        }
+    }
+
+    if (!is_object($object) || get_class($object) !== $class) {
+        return false;
+    }
+
+    return $object;
 }
 
 /**
@@ -187,68 +187,68 @@ 
  * @return void
  */
 function system_log($object, $event) {
-	static $log_cache;
-	static $cache_size = 0;
-
-	if ($object instanceof Loggable) {
-		/* @var \ElggEntity|\ElggExtender $object */
-		if (_elgg_config()->version < 2012012000) {
-			// this is a site that doesn't have the ip_address column yet
-			return;
-		}
-
-		// reset cache if it has grown too large
-		if (!is_array($log_cache) || $cache_size > 500) {
-			$log_cache = [];
-			$cache_size = 0;
-		}
-
-		// Has loggable interface, extract the necessary information and store
-		$object_id = (int) $object->getSystemLogID();
-		$object_class = get_class($object);
-		$object_type = $object->getType();
-		$object_subtype = $object->getSubtype();
-		$event = sanitise_string($event);
-		$time = time();
-		$ip_address = sanitize_string(_elgg_services()->request->getClientIp());
-		if (!$ip_address) {
-			$ip_address = '0.0.0.0';
-		}
-		$performed_by = elgg_get_logged_in_user_guid();
-
-		if (isset($object->access_id)) {
-			$access_id = $object->access_id;
-		} else {
-			$access_id = ACCESS_PUBLIC;
-		}
-		if (isset($object->enabled)) {
-			$enabled = $object->enabled;
-		} else {
-			$enabled = 'yes';
-		}
-
-		if (isset($object->owner_guid)) {
-			$owner_guid = $object->owner_guid;
-		} else {
-			$owner_guid = 0;
-		}
-
-		// Create log if we haven't already created it
-		if (!isset($log_cache[$time][$object_id][$event])) {
-			$prefix = _elgg_config()->dbprefix;
-			$query = "INSERT into {$prefix}system_log
+    static $log_cache;
+    static $cache_size = 0;
+
+    if ($object instanceof Loggable) {
+        /* @var \ElggEntity|\ElggExtender $object */
+        if (_elgg_config()->version < 2012012000) {
+            // this is a site that doesn't have the ip_address column yet
+            return;
+        }
+
+        // reset cache if it has grown too large
+        if (!is_array($log_cache) || $cache_size > 500) {
+            $log_cache = [];
+            $cache_size = 0;
+        }
+
+        // Has loggable interface, extract the necessary information and store
+        $object_id = (int) $object->getSystemLogID();
+        $object_class = get_class($object);
+        $object_type = $object->getType();
+        $object_subtype = $object->getSubtype();
+        $event = sanitise_string($event);
+        $time = time();
+        $ip_address = sanitize_string(_elgg_services()->request->getClientIp());
+        if (!$ip_address) {
+            $ip_address = '0.0.0.0';
+        }
+        $performed_by = elgg_get_logged_in_user_guid();
+
+        if (isset($object->access_id)) {
+            $access_id = $object->access_id;
+        } else {
+            $access_id = ACCESS_PUBLIC;
+        }
+        if (isset($object->enabled)) {
+            $enabled = $object->enabled;
+        } else {
+            $enabled = 'yes';
+        }
+
+        if (isset($object->owner_guid)) {
+            $owner_guid = $object->owner_guid;
+        } else {
+            $owner_guid = 0;
+        }
+
+        // Create log if we haven't already created it
+        if (!isset($log_cache[$time][$object_id][$event])) {
+            $prefix = _elgg_config()->dbprefix;
+            $query = "INSERT into {$prefix}system_log
 				(object_id, object_class, object_type, object_subtype, event,
 				performed_by_guid, owner_guid, access_id, enabled, time_created, ip_address)
 			VALUES
 				('$object_id','$object_class','$object_type', '$object_subtype', '$event',
 				$performed_by, $owner_guid, $access_id, '$enabled', '$time', '$ip_address')";
 			
-			execute_delayed_write_query($query);
+            execute_delayed_write_query($query);
 
-			$log_cache[$time][$object_id][$event] = true;
-			$cache_size += 1;
-		}
-	}
+            $log_cache[$time][$object_id][$event] = true;
+            $cache_size += 1;
+        }
+    }
 }
 
 /**
@@ -259,32 +259,32 @@ 
  * @return bool
  */
 function archive_log($offset = 0) {
-	$offset = (int) $offset;
-	$now = time(); // Take a snapshot of now
-	$prefix = _elgg_config()->dbprefix;
+    $offset = (int) $offset;
+    $now = time(); // Take a snapshot of now
+    $prefix = _elgg_config()->dbprefix;
 
-	$ts = $now - $offset;
+    $ts = $now - $offset;
 
-	// create table
-	$query = "CREATE TABLE {$prefix}system_log_$now as
+    // create table
+    $query = "CREATE TABLE {$prefix}system_log_$now as
 		SELECT * from {$prefix}system_log WHERE time_created<$ts";
 
-	if (!update_data($query)) {
-		return false;
-	}
+    if (!update_data($query)) {
+        return false;
+    }
 
-	// delete
-	// Don't delete on time since we are running in a concurrent environment
-	if (delete_data("DELETE from {$prefix}system_log WHERE time_created<$ts") === false) {
-		return false;
-	}
+    // delete
+    // Don't delete on time since we are running in a concurrent environment
+    if (delete_data("DELETE from {$prefix}system_log WHERE time_created<$ts") === false) {
+        return false;
+    }
 
-	// alter table to engine
-	if (!update_data("ALTER TABLE {$prefix}system_log_$now engine=archive")) {
-		return false;
-	}
+    // alter table to engine
+    if (!update_data("ALTER TABLE {$prefix}system_log_$now engine=archive")) {
+        return false;
+    }
 
-	return true;
+    return true;
 }
 
 /**
@@ -297,9 +297,9 @@ 
  * @return true
  */
 function system_log_default_logger($event, $object_type, $object) {
-	system_log($object['object'], $object['event']);
+    system_log($object['object'], $object['event']);
 
-	return true;
+    return true;
 }
 
 /**
@@ -314,20 +314,20 @@ 
  * @access private
  */
 function system_log_listener($event, $object_type, $object) {
-	if (($object_type != 'systemlog') && ($event != 'log')) {
-		elgg_trigger_event('log', 'systemlog', ['object' => $object, 'event' => $event]);
-	}
+    if (($object_type != 'systemlog') && ($event != 'log')) {
+        elgg_trigger_event('log', 'systemlog', ['object' => $object, 'event' => $event]);
+    }
 
-	return true;
+    return true;
 }
 
 /**
  * @see \Elgg\Application::loadCore Do not do work here. Just register for events.
  */
 return function(\Elgg\EventsService $events, \Elgg\HooksRegistrationService $hooks) {
-	/** Register event to listen to all events **/
-	$events->registerHandler('all', 'all', 'system_log_listener', 400);
+    /** Register event to listen to all events **/
+    $events->registerHandler('all', 'all', 'system_log_listener', 400);
 
-	/** Register a default system log handler */
-	$events->registerHandler('log', 'systemlog', 'system_log_default_logger', 999);
+    /** Register a default system log handler */
+    $events->registerHandler('log', 'systemlog', 'system_log_default_logger', 999);
 };

engine/lib/upgrades/create_upgrade.php

Doc Comments +1 added lines, -1 removed lines

@@ -167,7 +167,7 @@
  * @param string $directory  Directory to look in
  * @param array  $exceptions Array of filenames to ignore
  * @param array  $list       Array of files to append to
- * @param mixed  $extensions Array of extensions to allow, NULL for all. Use a dot: array('.php').
+ * @param string[]  $extensions Array of extensions to allow, NULL for all. Use a dot: array('.php').
  *
  * @return array Filenames in $directory, in the form $directory/filename.
  */

Indentation +74 added lines, -74 removed lines

@@ -10,17 +10,17 @@ 
 
 // only allow from the command line.
 if (php_sapi_name() != 'cli') {
-	die('Upgrades can only be created from the command line.');
+    die('Upgrades can only be created from the command line.');
 }
 
 if (count($argv) < 2) {
-	elgg_create_upgrade_show_usage('No upgrade name.');
+    elgg_create_upgrade_show_usage('No upgrade name.');
 }
 
 $name = $argv[1];
 
 if (strlen($name) > 24) {
-	elgg_create_upgrade_show_usage('Upgrade names cannot be longer than 24 characters.');
+    elgg_create_upgrade_show_usage('Upgrade names cannot be longer than 24 characters.');
 }
 
 require_once '../../../version.php';
@@ -39,38 +39,38 @@ 
 sort($files);
 
 foreach ($files as $filename) {
-	$filename = basename($filename);
-	$date = (int)substr($filename, 0, 8);
-	$inc = (int)substr($filename, 8, 2);
-
-	if ($upgrade_date == $date) {
-		if ($inc >= $upgrade_inc) {
-			$upgrade_inc = $inc + 1;
-		}
-	}
+    $filename = basename($filename);
+    $date = (int)substr($filename, 0, 8);
+    $inc = (int)substr($filename, 8, 2);
+
+    if ($upgrade_date == $date) {
+        if ($inc >= $upgrade_inc) {
+            $upgrade_inc = $inc + 1;
+        }
+    }
 }
 
 // zero-pad
 // if there are more than 10 upgrades in a day, someone needs talking to.
 if ($upgrade_inc < 10) {
-	$upgrade_inc = "0$upgrade_inc";
+    $upgrade_inc = "0$upgrade_inc";
 }
 
 $upgrade_version = $upgrade_date . $upgrade_inc;
 
 // make filename
 if (substr($release, 0, 3) == '1.7') {
-	// 1.7 upgrades are YYYYMMDDXX
-	$upgrade_name = $upgrade_version . '.php';
+    // 1.7 upgrades are YYYYMMDDXX
+    $upgrade_name = $upgrade_version . '.php';
 } else {
-	// 1.8+ upgrades are YYYYMMDDXX-release-friendly_name-rnd
-	$upgrade_name = $upgrade_version . "-$upgrade_release-$name-$upgrade_rnd.php";
+    // 1.8+ upgrades are YYYYMMDDXX-release-friendly_name-rnd
+    $upgrade_name = $upgrade_version . "-$upgrade_release-$name-$upgrade_rnd.php";
 }
 
 $upgrade_file = $upgrade_path . '/' . $upgrade_name;
 
 if (is_file($upgrade_file)) {
-	elgg_create_upgrade_show_usage("Upgrade file $upgrade_file already exists. This script has failed you.");
+    elgg_create_upgrade_show_usage("Upgrade file $upgrade_file already exists. This script has failed you.");
 }
 
 $upgrade_code = <<<___UPGRADE
@@ -89,14 +89,14 @@ 
 $h = fopen($upgrade_file, 'wb');
 
 if (!$h) {
-	die("Could not open file $upgrade_file");
+    die("Could not open file $upgrade_file");
 }
 
 if (!fwrite($h, $upgrade_code)) {
-	die("Could not write to $upgrade_file");
+    die("Could not write to $upgrade_file");
 } else {
-	elgg_set_version_dot_php_version($upgrade_version);
-	echo <<<___MSG
+    elgg_set_version_dot_php_version($upgrade_version);
+    echo <<<___MSG
 
 Created upgrade file and updated version.php.
 
@@ -115,26 +115,26 @@ 
  * @return boolean
  */
 function elgg_set_version_dot_php_version($version) {
-	$file = '../../../version.php';
-	$h = fopen($file, 'r+b');
+    $file = '../../../version.php';
+    $h = fopen($file, 'r+b');
 
-	if (!$h) {
-		return false;
-	}
+    if (!$h) {
+        return false;
+    }
 
-	$out = '';
+    $out = '';
 
-	while (($line = fgets($h)) !== false) {
-		$find = "/\\\$version[ ]?=[ ]?[0-9]{10};/";
-		$replace = "\$version = $version;";
-		$out .= preg_replace($find, $replace, $line);
-	}
+    while (($line = fgets($h)) !== false) {
+        $find = "/\\\$version[ ]?=[ ]?[0-9]{10};/";
+        $replace = "\$version = $version;";
+        $out .= preg_replace($find, $replace, $line);
+    }
 
-	rewind($h);
+    rewind($h);
 
-	fwrite($h, $out);
-	fclose($h);
-	return true;
+    fwrite($h, $out);
+    fclose($h);
+    return true;
 }
 
 /**
@@ -144,7 +144,7 @@ 
  * @return void
  */
 function elgg_create_upgrade_show_usage($msg = '') {
-	$text = <<<___MSG
+    $text = <<<___MSG
 $msg
 
 Example:
@@ -152,7 +152,7 @@ 
 
 ___MSG;
 
-	die($text);
+    die($text);
 }
 
 /**
@@ -174,25 +174,25 @@ 
 function elgg_get_file_list($directory, $exceptions = array(), $list = array(),
 $extensions = NULL) {
 
-	$directory = sanitise_filepath($directory);
-	if ($handle = opendir($directory)) {
-		while (($file = readdir($handle)) !== FALSE) {
-			if (!is_file($directory . $file) || in_array($file, $exceptions)) {
-				continue;
-			}
-
-			if (is_array($extensions)) {
-				if (in_array(strrchr($file, '.'), $extensions)) {
-					$list[] = $directory . $file;
-				}
-			} else {
-				$list[] = $directory . $file;
-			}
-		}
-		closedir($handle);
-	}
-
-	return $list;
+    $directory = sanitise_filepath($directory);
+    if ($handle = opendir($directory)) {
+        while (($file = readdir($handle)) !== FALSE) {
+            if (!is_file($directory . $file) || in_array($file, $exceptions)) {
+                continue;
+            }
+
+            if (is_array($extensions)) {
+                if (in_array(strrchr($file, '.'), $extensions)) {
+                    $list[] = $directory . $file;
+                }
+            } else {
+                $list[] = $directory . $file;
+            }
+        }
+        closedir($handle);
+    }
+
+    return $list;
 }
 
 /**
@@ -204,20 +204,20 @@ 
  * @return string
  */
 function sanitise_filepath($path, $append_slash = TRUE) {
-	// Convert to correct UNIX paths
-	$path = str_replace('\\', '/', $path);
-	$path = str_replace('../', '/', $path);
-	// replace // with / except when preceeded by :
-	$path = preg_replace("/([^:])\/\//", "$1/", $path);
-
-	// Sort trailing slash
-	$path = trim($path);
-	// rtrim defaults plus /
-	$path = rtrim($path, " \n\t\0\x0B/");
-
-	if ($append_slash) {
-		$path = $path . '/';
-	}
-
-	return $path;
+    // Convert to correct UNIX paths
+    $path = str_replace('\\', '/', $path);
+    $path = str_replace('../', '/', $path);
+    // replace // with / except when preceeded by :
+    $path = preg_replace("/([^:])\/\//", "$1/", $path);
+
+    // Sort trailing slash
+    $path = trim($path);
+    // rtrim defaults plus /
+    $path = rtrim($path, " \n\t\0\x0B/");
+
+    if ($append_slash) {
+        $path = $path . '/';
+    }
+
+    return $path;
 }
\ No newline at end of file

Spacing +10 added lines, -10 removed lines

@@ -40,8 +40,8 @@ 
 
 foreach ($files as $filename) {
 	$filename = basename($filename);
-	$date = (int)substr($filename, 0, 8);
-	$inc = (int)substr($filename, 8, 2);
+	$date = (int) substr($filename, 0, 8);
+	$inc = (int) substr($filename, 8, 2);
 
 	if ($upgrade_date == $date) {
 		if ($inc >= $upgrade_inc) {
@@ -56,18 +56,18 @@ 
 	$upgrade_inc = "0$upgrade_inc";
 }
 
-$upgrade_version = $upgrade_date . $upgrade_inc;
+$upgrade_version = $upgrade_date.$upgrade_inc;
 
 // make filename
 if (substr($release, 0, 3) == '1.7') {
 	// 1.7 upgrades are YYYYMMDDXX
-	$upgrade_name = $upgrade_version . '.php';
+	$upgrade_name = $upgrade_version.'.php';
 } else {
 	// 1.8+ upgrades are YYYYMMDDXX-release-friendly_name-rnd
-	$upgrade_name = $upgrade_version . "-$upgrade_release-$name-$upgrade_rnd.php";
+	$upgrade_name = $upgrade_version."-$upgrade_release-$name-$upgrade_rnd.php";
 }
 
-$upgrade_file = $upgrade_path . '/' . $upgrade_name;
+$upgrade_file = $upgrade_path.'/'.$upgrade_name;
 
 if (is_file($upgrade_file)) {
 	elgg_create_upgrade_show_usage("Upgrade file $upgrade_file already exists. This script has failed you.");
@@ -177,16 +177,16 @@ 
 	$directory = sanitise_filepath($directory);
 	if ($handle = opendir($directory)) {
 		while (($file = readdir($handle)) !== FALSE) {
-			if (!is_file($directory . $file) || in_array($file, $exceptions)) {
+			if (!is_file($directory.$file) || in_array($file, $exceptions)) {
 				continue;
 			}
 
 			if (is_array($extensions)) {
 				if (in_array(strrchr($file, '.'), $extensions)) {
-					$list[] = $directory . $file;
+					$list[] = $directory.$file;
 				}
 			} else {
-				$list[] = $directory . $file;
+				$list[] = $directory.$file;
 			}
 		}
 		closedir($handle);
@@ -216,7 +216,7 @@ 
 	$path = rtrim($path, " \n\t\0\x0B/");
 
 	if ($append_slash) {
-		$path = $path . '/';
+		$path = $path.'/';
 	}
 
 	return $path;

mod/file/start.php

Doc Comments +3 added lines

@@ -298,6 +298,9 @@
 	return elgg_view('file/typecloud', $params);
 }
 
+/**
+ * @param boolean $friends
+ */
 function file_type_cloud_get_url($type, $friends) {
 	$url = elgg_get_site_url() . 'file/search?subtype=file';
 

Spacing +5 added lines, -5 removed lines

@@ -13,7 +13,7 @@ 
 function file_init() {
 
 	// register a library of helper functions
-	elgg_register_library('elgg:file', __DIR__ . '/lib/file.php');
+	elgg_register_library('elgg:file', __DIR__.'/lib/file.php');
 
 	// Site navigation
 	$item = new ElggMenuItem('file', elgg_echo('file'), 'file/all');
@@ -286,10 +286,10 @@ 
 }
 
 function file_type_cloud_get_url($type, $friends) {
-	$url = elgg_get_site_url() . 'file/search?subtype=file';
+	$url = elgg_get_site_url().'file/search?subtype=file';
 
 	if ($type->tag != "all") {
-		$url .= "&md_type=simpletype&tag=" . urlencode($type->tag);
+		$url .= "&md_type=simpletype&tag=".urlencode($type->tag);
 	}
 
 	if ($friends) {
@@ -301,7 +301,7 @@ 
 	}
 
 	if (elgg_get_page_owner_guid()) {
-		$url .= "&page_owner=" . elgg_get_page_owner_guid();
+		$url .= "&page_owner=".elgg_get_page_owner_guid();
 	}
 
 	return $url;
@@ -320,7 +320,7 @@ 
 	$entity = $params['entity'];
 	if (elgg_instanceof($entity, 'object', 'file')) {
 		$title = elgg_get_friendly_title($entity->title);
-		return "file/view/" . $entity->getGUID() . "/" . $title;
+		return "file/view/".$entity->getGUID()."/".$title;
 	}
 }
 

Indentation +356 added lines, -356 removed lines

@@ -12,75 +12,75 @@ 
  */
 function file_init() {
 
-	// register a library of helper functions
-	elgg_register_library('elgg:file', __DIR__ . '/lib/file.php');
-
-	// Site navigation
-	$item = new ElggMenuItem('file', elgg_echo('file'), 'file/all');
-	elgg_register_menu_item('site', $item);
-
-	// Extend CSS
-	elgg_extend_view('elgg.css', 'file/css');
-
-	// add enclosure to rss item
-	elgg_extend_view('extensions/item', 'file/enclosure');
-
-	// extend group main page
-	elgg_extend_view('groups/tool_latest', 'file/group_module');
-
-	// Register a page handler, so we can have nice URLs
-	elgg_register_page_handler('file', 'file_page_handler');
-
-	// Register URL handlers for files
-	elgg_register_plugin_hook_handler('entity:url', 'object', 'file_set_url');
-	elgg_register_plugin_hook_handler('entity:icon:url', 'object', 'file_set_icon_url');
-
-	// Register for notifications
-	elgg_register_notification_event('object', 'file', ['create']);
-	elgg_register_plugin_hook_handler('prepare', 'notification:create:object:file', 'file_prepare_notification');
-
-	// add the group files tool option
-	add_group_tool_option('file', elgg_echo('groups:enablefiles'), true);
-
-	// add a file link to owner blocks
-	elgg_register_plugin_hook_handler('register', 'menu:owner_block', 'file_owner_block_menu');
-
-	// cleanup thumbnails on delete. high priority because we want to try to make sure the
-	// deletion will actually occur before we go through with this.
-	elgg_register_event_handler('delete', 'object', 'file_handle_object_delete', 999);
-
-	// embed support
-	$item = ElggMenuItem::factory([
-		'name' => 'file',
-		'text' => elgg_echo('file'),
-		'priority' => 10,
-		'data' => [
-			'options' => [
-				'type' => 'object',
-				'subtype' => 'file',
-			],
-		],
-	]);
-	elgg_register_menu_item('embed', $item);
-
-	$item = ElggMenuItem::factory([
-		'name' => 'file_upload',
-		'text' => elgg_echo('file:upload'),
-		'priority' => 100,
-		'data' => [
-			'view' => 'embed/file_upload/content',
-		],
-	]);
-
-	elgg_register_menu_item('embed', $item);
-
-	elgg_extend_view('theme_sandbox/icons', 'file/theme_sandbox/icons/files');
-
-	// allow to be liked
-	elgg_register_plugin_hook_handler('likes:is_likable', 'object:file', 'Elgg\Values::getTrue');
-
-	elgg_register_plugin_hook_handler('entity:icon:sizes', 'object', 'file_set_custom_icon_sizes');
-	elgg_register_plugin_hook_handler('entity:icon:file', 'object', 'file_set_icon_file');
+    // register a library of helper functions
+    elgg_register_library('elgg:file', __DIR__ . '/lib/file.php');
+
+    // Site navigation
+    $item = new ElggMenuItem('file', elgg_echo('file'), 'file/all');
+    elgg_register_menu_item('site', $item);
+
+    // Extend CSS
+    elgg_extend_view('elgg.css', 'file/css');
+
+    // add enclosure to rss item
+    elgg_extend_view('extensions/item', 'file/enclosure');
+
+    // extend group main page
+    elgg_extend_view('groups/tool_latest', 'file/group_module');
+
+    // Register a page handler, so we can have nice URLs
+    elgg_register_page_handler('file', 'file_page_handler');
+
+    // Register URL handlers for files
+    elgg_register_plugin_hook_handler('entity:url', 'object', 'file_set_url');
+    elgg_register_plugin_hook_handler('entity:icon:url', 'object', 'file_set_icon_url');
+
+    // Register for notifications
+    elgg_register_notification_event('object', 'file', ['create']);
+    elgg_register_plugin_hook_handler('prepare', 'notification:create:object:file', 'file_prepare_notification');
+
+    // add the group files tool option
+    add_group_tool_option('file', elgg_echo('groups:enablefiles'), true);
+
+    // add a file link to owner blocks
+    elgg_register_plugin_hook_handler('register', 'menu:owner_block', 'file_owner_block_menu');
+
+    // cleanup thumbnails on delete. high priority because we want to try to make sure the
+    // deletion will actually occur before we go through with this.
+    elgg_register_event_handler('delete', 'object', 'file_handle_object_delete', 999);
+
+    // embed support
+    $item = ElggMenuItem::factory([
+        'name' => 'file',
+        'text' => elgg_echo('file'),
+        'priority' => 10,
+        'data' => [
+            'options' => [
+                'type' => 'object',
+                'subtype' => 'file',
+            ],
+        ],
+    ]);
+    elgg_register_menu_item('embed', $item);
+
+    $item = ElggMenuItem::factory([
+        'name' => 'file_upload',
+        'text' => elgg_echo('file:upload'),
+        'priority' => 100,
+        'data' => [
+            'view' => 'embed/file_upload/content',
+        ],
+    ]);
+
+    elgg_register_menu_item('embed', $item);
+
+    elgg_extend_view('theme_sandbox/icons', 'file/theme_sandbox/icons/files');
+
+    // allow to be liked
+    elgg_register_plugin_hook_handler('likes:is_likable', 'object:file', 'Elgg\Values::getTrue');
+
+    elgg_register_plugin_hook_handler('entity:icon:sizes', 'object', 'file_set_custom_icon_sizes');
+    elgg_register_plugin_hook_handler('entity:icon:file', 'object', 'file_set_icon_file');
 }
 
 /**
@@ -101,49 +101,49 @@ 
  */
 function file_page_handler($page) {
 
-	if (!isset($page[0])) {
-		$page[0] = 'all';
-	}
-
-	$page_type = $page[0];
-	switch ($page_type) {
-		case 'owner':
-			file_register_toggle();
-			echo elgg_view_resource('file/owner');
-			break;
-		case 'friends':
-			file_register_toggle();
-			echo elgg_view_resource('file/friends');
-			break;
-		case 'view':
-			echo elgg_view_resource('file/view', [
-				'guid' => $page[1],
-			]);
-			break;
-		case 'add':
-			echo elgg_view_resource('file/upload');
-			break;
-		case 'edit':
-			echo elgg_view_resource('file/edit', [
-				'guid' => $page[1],
-			]);
-			break;
-		case 'search':
-			file_register_toggle();
-			echo elgg_view_resource('file/search');
-			break;
-		case 'group':
-			file_register_toggle();
-			echo elgg_view_resource('file/owner');
-			break;
-		case 'all':
-			file_register_toggle();
-			echo elgg_view_resource('file/all');
-			break;
-		default:
-			return false;
-	}
-	return true;
+    if (!isset($page[0])) {
+        $page[0] = 'all';
+    }
+
+    $page_type = $page[0];
+    switch ($page_type) {
+        case 'owner':
+            file_register_toggle();
+            echo elgg_view_resource('file/owner');
+            break;
+        case 'friends':
+            file_register_toggle();
+            echo elgg_view_resource('file/friends');
+            break;
+        case 'view':
+            echo elgg_view_resource('file/view', [
+                'guid' => $page[1],
+            ]);
+            break;
+        case 'add':
+            echo elgg_view_resource('file/upload');
+            break;
+        case 'edit':
+            echo elgg_view_resource('file/edit', [
+                'guid' => $page[1],
+            ]);
+            break;
+        case 'search':
+            file_register_toggle();
+            echo elgg_view_resource('file/search');
+            break;
+        case 'group':
+            file_register_toggle();
+            echo elgg_view_resource('file/owner');
+            break;
+        case 'all':
+            file_register_toggle();
+            echo elgg_view_resource('file/all');
+            break;
+        default:
+            return false;
+    }
+    return true;
 }
 
 /**
@@ -151,23 +151,23 @@ 
  */
 function file_register_toggle() {
 
-	if (get_input('list_type', 'list') == 'list') {
-		$list_type = 'gallery';
-		$icon = elgg_view_icon('grid');
-	} else {
-		$list_type = 'list';
-		$icon = elgg_view_icon('list');
-	}
+    if (get_input('list_type', 'list') == 'list') {
+        $list_type = 'gallery';
+        $icon = elgg_view_icon('grid');
+    } else {
+        $list_type = 'list';
+        $icon = elgg_view_icon('list');
+    }
 
-	$url = elgg_http_add_url_query_elements(current_page_url(), ['list_type' => $list_type]);
+    $url = elgg_http_add_url_query_elements(current_page_url(), ['list_type' => $list_type]);
 	
-	elgg_register_menu_item('filter:file', [
-		'name' => 'file_list',
-		'text' => $icon,
-		'href' => $url,
-		'title' => elgg_echo("file:list:$list_type"),
-		'priority' => 1000,
-	]);
+    elgg_register_menu_item('filter:file', [
+        'name' => 'file_list',
+        'text' => $icon,
+        'href' => $url,
+        'title' => elgg_echo("file:list:$list_type"),
+        'priority' => 1000,
+    ]);
 }
 
 /**
@@ -180,44 +180,44 @@ 
  * @return Elgg\Notifications\Notification
  */
 function file_prepare_notification($hook, $type, $notification, $params) {
-	$entity = $params['event']->getObject();
-	$owner = $params['event']->getActor();
-	$recipient = $params['recipient'];
-	$language = $params['language'];
-	$method = $params['method'];
-
-	$descr = $entity->description;
-	$title = $entity->title;
-
-	$notification->subject = elgg_echo('file:notify:subject', [$entity->title], $language);
-	$notification->body = elgg_echo('file:notify:body', [
-		$owner->name,
-		$title,
-		$descr,
-		$entity->getURL()
-	], $language);
-	$notification->summary = elgg_echo('file:notify:summary', [$entity->title], $language);
-	$notification->url = $entity->getURL();
-	return $notification;
+    $entity = $params['event']->getObject();
+    $owner = $params['event']->getActor();
+    $recipient = $params['recipient'];
+    $language = $params['language'];
+    $method = $params['method'];
+
+    $descr = $entity->description;
+    $title = $entity->title;
+
+    $notification->subject = elgg_echo('file:notify:subject', [$entity->title], $language);
+    $notification->body = elgg_echo('file:notify:body', [
+        $owner->name,
+        $title,
+        $descr,
+        $entity->getURL()
+    ], $language);
+    $notification->summary = elgg_echo('file:notify:summary', [$entity->title], $language);
+    $notification->url = $entity->getURL();
+    return $notification;
 }
 
 /**
  * Add a menu item to the user ownerblock
  */
 function file_owner_block_menu($hook, $type, $return, $params) {
-	if (elgg_instanceof($params['entity'], 'user')) {
-		$url = "file/owner/{$params['entity']->username}";
-		$item = new ElggMenuItem('file', elgg_echo('file'), $url);
-		$return[] = $item;
-	} else {
-		if ($params['entity']->file_enable != "no") {
-			$url = "file/group/{$params['entity']->guid}/all";
-			$item = new ElggMenuItem('file', elgg_echo('file:group'), $url);
-			$return[] = $item;
-		}
-	}
-
-	return $return;
+    if (elgg_instanceof($params['entity'], 'user')) {
+        $url = "file/owner/{$params['entity']->username}";
+        $item = new ElggMenuItem('file', elgg_echo('file'), $url);
+        $return[] = $item;
+    } else {
+        if ($params['entity']->file_enable != "no") {
+            $url = "file/group/{$params['entity']->guid}/all";
+            $item = new ElggMenuItem('file', elgg_echo('file:group'), $url);
+            $return[] = $item;
+        }
+    }
+
+    return $return;
 }
 
 /**
@@ -230,80 +230,80 @@ 
  */
 function file_get_type_cloud($container_guid = "", $friends = false) {
 
-	$container_guids = $container_guid;
-	$container = get_entity($container_guid);
-
-	if ($friends && $container) {
-		// tags interface does not support pulling tags on friends' content so
-		// we need to grab all friends
-		$friend_entities = $container->getFriends(['limit' => 0]);
-		if ($friend_entities) {
-			$friend_guids = [];
-			foreach ($friend_entities as $friend) {
-				$friend_guids[] = $friend->getGUID();
-			}
-		}
-		$container_guids = $friend_guids;
-	}
-
-	elgg_register_tag_metadata_name('simpletype');
-	$options = [
-		'type' => 'object',
-		'subtype' => 'file',
-		'container_guids' => $container_guids,
-		'threshold' => 0,
-		'limit' => 10,
-		'tag_names' => ['simpletype']
-	];
-	$types = elgg_get_tags($options);
-
-	if ($types) {
-		$all = new stdClass;
-		$all->tag = 'all';
-		elgg_register_menu_item('page', [
-			'name' => 'file:all',
-			'text' => elgg_echo('all'),
-			'href' =>  file_type_cloud_get_url($all, $friends),
-		]);
+    $container_guids = $container_guid;
+    $container = get_entity($container_guid);
+
+    if ($friends && $container) {
+        // tags interface does not support pulling tags on friends' content so
+        // we need to grab all friends
+        $friend_entities = $container->getFriends(['limit' => 0]);
+        if ($friend_entities) {
+            $friend_guids = [];
+            foreach ($friend_entities as $friend) {
+                $friend_guids[] = $friend->getGUID();
+            }
+        }
+        $container_guids = $friend_guids;
+    }
+
+    elgg_register_tag_metadata_name('simpletype');
+    $options = [
+        'type' => 'object',
+        'subtype' => 'file',
+        'container_guids' => $container_guids,
+        'threshold' => 0,
+        'limit' => 10,
+        'tag_names' => ['simpletype']
+    ];
+    $types = elgg_get_tags($options);
+
+    if ($types) {
+        $all = new stdClass;
+        $all->tag = 'all';
+        elgg_register_menu_item('page', [
+            'name' => 'file:all',
+            'text' => elgg_echo('all'),
+            'href' =>  file_type_cloud_get_url($all, $friends),
+        ]);
 		
-		foreach ($types as $type) {
-			elgg_register_menu_item('page', [
-				'name' => "file:$type->tag",
-				'text' => elgg_echo("file:type:$type->tag"),
-				'href' =>  file_type_cloud_get_url($type, $friends),
-			]);
-		}
-	}
+        foreach ($types as $type) {
+            elgg_register_menu_item('page', [
+                'name' => "file:$type->tag",
+                'text' => elgg_echo("file:type:$type->tag"),
+                'href' =>  file_type_cloud_get_url($type, $friends),
+            ]);
+        }
+    }
 	
-	// returning the view is needed for BC
-	$params = [
-		'friends' => $friends,
-		'types' => $types,
-	];
+    // returning the view is needed for BC
+    $params = [
+        'friends' => $friends,
+        'types' => $types,
+    ];
 
-	return elgg_view('file/typecloud', $params);
+    return elgg_view('file/typecloud', $params);
 }
 
 function file_type_cloud_get_url($type, $friends) {
-	$url = elgg_get_site_url() . 'file/search?subtype=file';
+    $url = elgg_get_site_url() . 'file/search?subtype=file';
 
-	if ($type->tag != "all") {
-		$url .= "&md_type=simpletype&tag=" . urlencode($type->tag);
-	}
+    if ($type->tag != "all") {
+        $url .= "&md_type=simpletype&tag=" . urlencode($type->tag);
+    }
 
-	if ($friends) {
-		$url .= "&friends=$friends";
-	}
+    if ($friends) {
+        $url .= "&friends=$friends";
+    }
 
-	if ($type->tag == "image") {
-		$url .= "&list_type=gallery";
-	}
+    if ($type->tag == "image") {
+        $url .= "&list_type=gallery";
+    }
 
-	if (elgg_get_page_owner_guid()) {
-		$url .= "&page_owner=" . elgg_get_page_owner_guid();
-	}
+    if (elgg_get_page_owner_guid()) {
+        $url .= "&page_owner=" . elgg_get_page_owner_guid();
+    }
 
-	return $url;
+    return $url;
 }
 
 /**
@@ -316,11 +316,11 @@ 
  * @return string File URL
  */
 function file_set_url($hook, $type, $url, $params) {
-	$entity = $params['entity'];
-	if (elgg_instanceof($entity, 'object', 'file')) {
-		$title = elgg_get_friendly_title($entity->title);
-		return "file/view/" . $entity->getGUID() . "/" . $title;
-	}
+    $entity = $params['entity'];
+    if (elgg_instanceof($entity, 'object', 'file')) {
+        $title = elgg_get_friendly_title($entity->title);
+        return "file/view/" . $entity->getGUID() . "/" . $title;
+    }
 }
 
 /**
@@ -335,66 +335,66 @@ 
  * @return string Relative URL
  */
 function file_set_icon_url($hook, $type, $url, $params) {
-	$file = $params['entity'];
-	$size = elgg_extract('size', $params, 'large');
-	if (elgg_instanceof($file, 'object', 'file')) {
-		// thumbnails get first priority
-		$thumbnail = $file->getIcon($size);
-		$thumb_url = $thumbnail->getInlineURL(true);
-		if ($thumb_url) {
-			return $thumb_url;
-		}
-
-		$mapping = [
-			'application/excel' => 'excel',
-			'application/msword' => 'word',
-			'application/ogg' => 'music',
-			'application/pdf' => 'pdf',
-			'application/powerpoint' => 'ppt',
-			'application/vnd.ms-excel' => 'excel',
-			'application/vnd.ms-powerpoint' => 'ppt',
-			'application/vnd.oasis.opendocument.text' => 'openoffice',
-			'application/vnd.openxmlformats-officedocument.wordprocessingml.document' => 'word',
-			'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' => 'excel',
-			'application/vnd.openxmlformats-officedocument.presentationml.presentation' => 'ppt',
-			'application/x-gzip' => 'archive',
-			'application/x-rar-compressed' => 'archive',
-			'application/x-stuffit' => 'archive',
-			'application/zip' => 'archive',
-			'text/directory' => 'vcard',
-			'text/v-card' => 'vcard',
-			'application' => 'application',
-			'audio' => 'music',
-			'text' => 'text',
-			'video' => 'video',
-		];
-
-		$mime = $file->getMimeType();
-		if ($mime) {
-			$base_type = substr($mime, 0, strpos($mime, '/'));
-		} else {
-			$mime = 'none';
-			$base_type = 'none';
-		}
-
-		if (isset($mapping[$mime])) {
-			$type = $mapping[$mime];
-		} elseif (isset($mapping[$base_type])) {
-			$type = $mapping[$base_type];
-		} else {
-			$type = 'general';
-		}
-
-		if ($size == 'large') {
-			$ext = '_lrg';
-		} else {
-			$ext = '';
-		}
-
-		$url = elgg_get_simplecache_url("file/icons/{$type}{$ext}.gif");
-		$url = elgg_trigger_plugin_hook('file:icon:url', 'override', $params, $url);
-		return $url;
-	}
+    $file = $params['entity'];
+    $size = elgg_extract('size', $params, 'large');
+    if (elgg_instanceof($file, 'object', 'file')) {
+        // thumbnails get first priority
+        $thumbnail = $file->getIcon($size);
+        $thumb_url = $thumbnail->getInlineURL(true);
+        if ($thumb_url) {
+            return $thumb_url;
+        }
+
+        $mapping = [
+            'application/excel' => 'excel',
+            'application/msword' => 'word',
+            'application/ogg' => 'music',
+            'application/pdf' => 'pdf',
+            'application/powerpoint' => 'ppt',
+            'application/vnd.ms-excel' => 'excel',
+            'application/vnd.ms-powerpoint' => 'ppt',
+            'application/vnd.oasis.opendocument.text' => 'openoffice',
+            'application/vnd.openxmlformats-officedocument.wordprocessingml.document' => 'word',
+            'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' => 'excel',
+            'application/vnd.openxmlformats-officedocument.presentationml.presentation' => 'ppt',
+            'application/x-gzip' => 'archive',
+            'application/x-rar-compressed' => 'archive',
+            'application/x-stuffit' => 'archive',
+            'application/zip' => 'archive',
+            'text/directory' => 'vcard',
+            'text/v-card' => 'vcard',
+            'application' => 'application',
+            'audio' => 'music',
+            'text' => 'text',
+            'video' => 'video',
+        ];
+
+        $mime = $file->getMimeType();
+        if ($mime) {
+            $base_type = substr($mime, 0, strpos($mime, '/'));
+        } else {
+            $mime = 'none';
+            $base_type = 'none';
+        }
+
+        if (isset($mapping[$mime])) {
+            $type = $mapping[$mime];
+        } elseif (isset($mapping[$base_type])) {
+            $type = $mapping[$base_type];
+        } else {
+            $type = 'general';
+        }
+
+        if ($size == 'large') {
+            $ext = '_lrg';
+        } else {
+            $ext = '';
+        }
+
+        $url = elgg_get_simplecache_url("file/icons/{$type}{$ext}.gif");
+        $url = elgg_trigger_plugin_hook('file:icon:url', 'override', $params, $url);
+        return $url;
+    }
 }
 
 /**
@@ -406,15 +406,15 @@ 
  * @return void
  */
 function file_handle_object_delete($event, $type, ElggObject $file) {
-	if (!$file instanceof ElggFile) {
-		return;
-	}
-	if (!$file->guid) {
-		// this is an ElggFile used as temporary API
-		return;
-	}
-
-	$file->deleteIcon();
+    if (!$file instanceof ElggFile) {
+        return;
+    }
+    if (!$file->guid) {
+        // this is an ElggFile used as temporary API
+        return;
+    }
+
+    $file->deleteIcon();
 }
 
 /**
@@ -428,30 +428,30 @@ 
  */
 function file_set_custom_icon_sizes($hook, $type, $return, $params) {
 
-	$entity_subtype = elgg_extract('entity_subtype', $params);
-	if ($entity_subtype !== 'file') {
-		return;
-	}
-
-	return [
-		'small' => [
-			'w' => 60,
-			'h' => 60,
-			'square' => true,
-			'upscale' => true,
-		],
-		'medium' => [
-			'w' => 153,
-			'h' => 153,
-			'square' => true,
-			'upscale' => true,
-		],
-		'large' => [
-			'w' => 600,
-			'h' => 600,
-			'upscale' => false,
-		],
-	];
+    $entity_subtype = elgg_extract('entity_subtype', $params);
+    if ($entity_subtype !== 'file') {
+        return;
+    }
+
+    return [
+        'small' => [
+            'w' => 60,
+            'h' => 60,
+            'square' => true,
+            'upscale' => true,
+        ],
+        'medium' => [
+            'w' => 153,
+            'h' => 153,
+            'square' => true,
+            'upscale' => true,
+        ],
+        'large' => [
+            'w' => 600,
+            'h' => 600,
+            'upscale' => false,
+        ],
+    ];
 }
 
 /**
@@ -465,42 +465,42 @@ 
  */
 function file_set_icon_file($hook, $type, $icon, $params) {
 
-	$entity = elgg_extract('entity', $params);
-	$size = elgg_extract('size', $params, 'large');
+    $entity = elgg_extract('entity', $params);
+    $size = elgg_extract('size', $params, 'large');
 
-	if (!elgg_instanceof($entity, 'object', 'file')) {
-		return;
-	}
+    if (!elgg_instanceof($entity, 'object', 'file')) {
+        return;
+    }
 	
-	switch ($size) {
-		case 'small' :
-			$filename_prefix = 'thumb';
-			$metadata_name = 'thumbnail';
-			break;
-
-		case 'medium' :
-			$filename_prefix = 'smallthumb';
-			$metadata_name = 'smallthumb';
-			break;
-
-		case 'large' :
-			$filename_prefix = 'largethumb';
-			$metadata_name = 'largethumb';
-			break;
-
-		default :
-			$filename_prefix = "{$size}thumb";
-			$metadata_name = $filename_prefix;
-			break;
-	}
-
-	$icon->owner_guid = $entity->owner_guid;
-	if (isset($entity->$metadata_name)) {
-		$icon->setFilename($entity->$metadata_name);
-	} else {
-		$filename = pathinfo($entity->getFilenameOnFilestore(), PATHINFO_FILENAME);
-		$filename = "file/{$filename_prefix}{$filename}.jpg";
-		$icon->setFilename($filename);
-	}
-	return $icon;
+    switch ($size) {
+        case 'small' :
+            $filename_prefix = 'thumb';
+            $metadata_name = 'thumbnail';
+            break;
+
+        case 'medium' :
+            $filename_prefix = 'smallthumb';
+            $metadata_name = 'smallthumb';
+            break;
+
+        case 'large' :
+            $filename_prefix = 'largethumb';
+            $metadata_name = 'largethumb';
+            break;
+
+        default :
+            $filename_prefix = "{$size}thumb";
+            $metadata_name = $filename_prefix;
+            break;
+    }
+
+    $icon->owner_guid = $entity->owner_guid;
+    if (isset($entity->$metadata_name)) {
+        $icon->setFilename($entity->$metadata_name);
+    } else {
+        $filename = pathinfo($entity->getFilenameOnFilestore(), PATHINFO_FILENAME);
+        $filename = "file/{$filename_prefix}{$filename}.jpg";
+        $icon->setFilename($filename);
+    }
+    return $icon;
 }

mod/messages/start.php

Doc Comments +1 added lines, -1 removed lines

@@ -470,7 +470,7 @@
  * @param string $return_value
  * @param array  $params
  *
- * @return array
+ * @return string
  */
 function messages_ecml_views_hook($hook, $entity_type, $return_value, $params) {
 	$return_value['messages/messages'] = elgg_echo('messages');

Indentation +298 added lines, -298 removed lines

@@ -8,50 +8,50 @@ 
 
 function messages_init() {
 
-	// add page menu items
-	if (elgg_is_logged_in()) {
-		elgg_register_menu_item('page', [
-			'name' => 'messages:inbox',
-			'text' => elgg_echo('messages:inbox'),
-			'href' => "messages/inbox/" . elgg_get_logged_in_user_entity()->username,
-			'context' => 'messages',
-		]);
+    // add page menu items
+    if (elgg_is_logged_in()) {
+        elgg_register_menu_item('page', [
+            'name' => 'messages:inbox',
+            'text' => elgg_echo('messages:inbox'),
+            'href' => "messages/inbox/" . elgg_get_logged_in_user_entity()->username,
+            'context' => 'messages',
+        ]);
 		
-		elgg_register_menu_item('page', [
-			'name' => 'messages:sentmessages',
-			'text' => elgg_echo('messages:sentmessages'),
-			'href' => "messages/sent/" . elgg_get_logged_in_user_entity()->username,
-			'context' => 'messages',
-		]);
-	}
-
-	// Extend system CSS with our own styles, which are defined in the messages/css view
-	elgg_extend_view('elgg.css', 'messages/css');
-	elgg_extend_view('elgg.js', 'messages/js');
+        elgg_register_menu_item('page', [
+            'name' => 'messages:sentmessages',
+            'text' => elgg_echo('messages:sentmessages'),
+            'href' => "messages/sent/" . elgg_get_logged_in_user_entity()->username,
+            'context' => 'messages',
+        ]);
+    }
+
+    // Extend system CSS with our own styles, which are defined in the messages/css view
+    elgg_extend_view('elgg.css', 'messages/css');
+    elgg_extend_view('elgg.js', 'messages/js');
 	
-	// Register a page handler, so we can have nice URLs
-	elgg_register_page_handler('messages', 'messages_page_handler');
+    // Register a page handler, so we can have nice URLs
+    elgg_register_page_handler('messages', 'messages_page_handler');
 
-	// Register a URL handler
-	elgg_register_plugin_hook_handler('entity:url', 'object', 'messages_set_url');
+    // Register a URL handler
+    elgg_register_plugin_hook_handler('entity:url', 'object', 'messages_set_url');
 
-	// Extend avatar hover menu
-	elgg_register_plugin_hook_handler('register', 'menu:user_hover', 'messages_user_hover_menu');
+    // Extend avatar hover menu
+    elgg_register_plugin_hook_handler('register', 'menu:user_hover', 'messages_user_hover_menu');
 
-	// delete messages sent by a user when user is deleted
-	elgg_register_event_handler('delete', 'user', 'messages_purge');
+    // delete messages sent by a user when user is deleted
+    elgg_register_event_handler('delete', 'user', 'messages_purge');
 
-	// ecml
-	elgg_register_plugin_hook_handler('get_views', 'ecml', 'messages_ecml_views_hook');
+    // ecml
+    elgg_register_plugin_hook_handler('get_views', 'ecml', 'messages_ecml_views_hook');
 
-	// permission overrides
-	elgg_register_plugin_hook_handler('permissions_check:metadata', 'object', 'messages_can_edit_metadata');
-	elgg_register_plugin_hook_handler('permissions_check', 'object', 'messages_can_edit');
-	elgg_register_plugin_hook_handler('container_permissions_check', 'object', 'messages_can_edit_container');
+    // permission overrides
+    elgg_register_plugin_hook_handler('permissions_check:metadata', 'object', 'messages_can_edit_metadata');
+    elgg_register_plugin_hook_handler('permissions_check', 'object', 'messages_can_edit');
+    elgg_register_plugin_hook_handler('container_permissions_check', 'object', 'messages_can_edit_container');
 
-	// Topbar menu. We assume this menu will render *after* a message is rendered. If a refactor/plugin
-	// causes it to render first, the unread count notification will not update until the next page.
-	elgg_register_plugin_hook_handler('register', 'menu:topbar', 'messages_register_topbar');
+    // Topbar menu. We assume this menu will render *after* a message is rendered. If a refactor/plugin
+    // causes it to render first, the unread count notification will not update until the next page.
+    elgg_register_plugin_hook_handler('register', 'menu:topbar', 'messages_register_topbar');
 }
 
 /**
@@ -62,49 +62,49 @@ 
  */
 function messages_page_handler($page) {
 
-	elgg_gatekeeper();
-
-	elgg_push_breadcrumb(elgg_echo('messages'), 'messages/inbox/' . $current_user->username);
-
-	if (!isset($page[0])) {
-		$page[0] = 'inbox';
-	}
-
-	// Support the old inbox url /messages/<username>, but only if it matches the logged in user.
-	// Otherwise having a username like "read" on the system could confuse this function.
-	if ($current_user->username === $page[0]) {
-		$page[1] = $page[0];
-		$page[0] = 'inbox';
-	}
-
-	if (!isset($page[1])) {
-		$page[1] = $current_user->username;
-	}
-
-	switch ($page[0]) {
-		case 'inbox':
-			echo elgg_view_resource('messages/inbox', [
-				'username' => $page[1],
-			]);
-			break;
-		case 'sent':
-			echo elgg_view_resource('messages/sent', [
-				'username' => $page[1],
-			]);
-			break;
-		case 'read':
-			echo elgg_view_resource('messages/read', [
-				'guid' => $page[1],
-			]);
-			break;
-		case 'compose':
-		case 'add':
-			echo elgg_view_resource('messages/send');
-			break;
-		default:
-			return false;
-	}
-	return true;
+    elgg_gatekeeper();
+
+    elgg_push_breadcrumb(elgg_echo('messages'), 'messages/inbox/' . $current_user->username);
+
+    if (!isset($page[0])) {
+        $page[0] = 'inbox';
+    }
+
+    // Support the old inbox url /messages/<username>, but only if it matches the logged in user.
+    // Otherwise having a username like "read" on the system could confuse this function.
+    if ($current_user->username === $page[0]) {
+        $page[1] = $page[0];
+        $page[0] = 'inbox';
+    }
+
+    if (!isset($page[1])) {
+        $page[1] = $current_user->username;
+    }
+
+    switch ($page[0]) {
+        case 'inbox':
+            echo elgg_view_resource('messages/inbox', [
+                'username' => $page[1],
+            ]);
+            break;
+        case 'sent':
+            echo elgg_view_resource('messages/sent', [
+                'username' => $page[1],
+            ]);
+            break;
+        case 'read':
+            echo elgg_view_resource('messages/read', [
+                'guid' => $page[1],
+            ]);
+            break;
+        case 'compose':
+        case 'add':
+            echo elgg_view_resource('messages/send');
+            break;
+        default:
+            return false;
+    }
+    return true;
 }
 
 /**
@@ -117,31 +117,31 @@ 
  * @return array
  */
 function messages_register_topbar($hook, $type, $items, $params) {
-	if (!elgg_is_logged_in()) {
-		return;
-	}
-
-	$user = elgg_get_logged_in_user_entity();
-
-	$text = elgg_echo('messages');
-	$title = $text;
-
-	$num_messages = (int) messages_count_unread();
-	if ($num_messages) {
-		$title .= " (" . elgg_echo("messages:unreadcount", [$num_messages]) . ")";
-	}
-
-	$items[] = ElggMenuItem::factory([
-		'name' => 'messages',
-		'href' => "messages/inbox/$user->username",
-		'text' => $text,
-		'priority' => 600,
-		'title' => $title,
-		'icon' => 'mail',
-		'badge' => $num_messages ? $num_messages : null,
-	]);
-
-	return $items;
+    if (!elgg_is_logged_in()) {
+        return;
+    }
+
+    $user = elgg_get_logged_in_user_entity();
+
+    $text = elgg_echo('messages');
+    $title = $text;
+
+    $num_messages = (int) messages_count_unread();
+    if ($num_messages) {
+        $title .= " (" . elgg_echo("messages:unreadcount", [$num_messages]) . ")";
+    }
+
+    $items[] = ElggMenuItem::factory([
+        'name' => 'messages',
+        'href' => "messages/inbox/$user->username",
+        'text' => $text,
+        'priority' => 600,
+        'title' => $title,
+        'icon' => 'mail',
+        'badge' => $num_messages ? $num_messages : null,
+    ]);
+
+    return $items;
 }
 
 /**
@@ -150,16 +150,16 @@ 
  */
 function messages_can_edit_metadata($hook_name, $entity_type, $return_value, $parameters) {
 
-	global $messagesendflag;
+    global $messagesendflag;
 
-	if ($messagesendflag !== 1) {
-		return;
-	}
+    if ($messagesendflag !== 1) {
+        return;
+    }
 	
-	$entity = elgg_extract('entity', $parameters);
-	if ($entity->getSubtype() == 'messages') {
-		return true;
-	}
+    $entity = elgg_extract('entity', $parameters);
+    if ($entity->getSubtype() == 'messages') {
+        return true;
+    }
 }
 
 /**
@@ -168,30 +168,30 @@ 
  */
 function messages_can_edit($hook_name, $entity_type, $return_value, $parameters) {
 
-	global $messagesendflag;
+    global $messagesendflag;
 	
-	if ($messagesendflag !== 1) {
-		return;
-	}
+    if ($messagesendflag !== 1) {
+        return;
+    }
 	
-	$entity = elgg_extract('entity', $parameters);
-	if ($entity->getSubtype() == 'messages') {
-		return true;
-	}
+    $entity = elgg_extract('entity', $parameters);
+    if ($entity->getSubtype() == 'messages') {
+        return true;
+    }
 }
 
 /**
  * Prevent messages from generating a notification
  */
 function messages_notification_msg($hook_name, $entity_type, $return_value, $params) {
-	$entity = elgg_extract('entity', $params);
-	if (!$entity instanceof ElggEntity) {
-		return;
-	}
+    $entity = elgg_extract('entity', $params);
+    if (!$entity instanceof ElggEntity) {
+        return;
+    }
 		
-	if ($entity->getSubtype() == 'messages') {
-		return false;
-	}
+    if ($entity->getSubtype() == 'messages') {
+        return false;
+    }
 }
 
 /**
@@ -200,11 +200,11 @@ 
  */
 function messages_can_edit_container($hook_name, $entity_type, $return_value, $parameters) {
 
-	global $messagesendflag;
+    global $messagesendflag;
 
-	if ($messagesendflag == 1) {
-		return true;
-	}
+    if ($messagesendflag == 1) {
+        return true;
+    }
 }
 
 /**
@@ -221,104 +221,104 @@ 
  */
 function messages_send($subject, $body, $recipient_guid, $sender_guid = 0, $original_msg_guid = 0, $notify = true, $add_to_sent = true) {
 
-	// @todo remove globals
-	global $messagesendflag;
-	$messagesendflag = 1;
-
-	// @todo remove globals
-	global $messages_pm;
-	if ($notify) {
-		$messages_pm = 1;
-	} else {
-		$messages_pm = 0;
-	}
-
-	// If $sender_guid == 0, set to current user
-	if ($sender_guid == 0) {
-		$sender_guid = (int) elgg_get_logged_in_user_guid();
-	}
-
-	// Initialise 2 new ElggObject
-	$message_to = new ElggObject();
-	$message_sent = new ElggObject();
-
-	$message_to->subtype = "messages";
-	$message_sent->subtype = "messages";
-
-	$message_to->owner_guid = $recipient_guid;
-	$message_to->container_guid = $recipient_guid;
-	$message_sent->owner_guid = $sender_guid;
-	$message_sent->container_guid = $sender_guid;
-
-	$message_to->access_id = ACCESS_PUBLIC;
-	$message_sent->access_id = ACCESS_PUBLIC;
-
-	$message_to->title = $subject;
-	$message_to->description = $body;
-
-	$message_sent->title = $subject;
-	$message_sent->description = $body;
-
-	$message_to->toId = $recipient_guid; // the user receiving the message
-	$message_to->fromId = $sender_guid; // the user receiving the message
-	$message_to->readYet = 0; // this is a toggle between 0 / 1 (1 = read)
-	$message_to->hiddenFrom = 0; // this is used when a user deletes a message in their sentbox, it is a flag
-	$message_to->hiddenTo = 0; // this is used when a user deletes a message in their inbox
-
-	$message_sent->toId = $recipient_guid; // the user receiving the message
-	$message_sent->fromId = $sender_guid; // the user receiving the message
-	$message_sent->readYet = 0; // this is a toggle between 0 / 1 (1 = read)
-	$message_sent->hiddenFrom = 0; // this is used when a user deletes a message in their sentbox, it is a flag
-	$message_sent->hiddenTo = 0; // this is used when a user deletes a message in their inbox
-
-	// Save the copy of the message that goes to the recipient
-	$success = $message_to->save();
-
-	// Save the copy of the message that goes to the sender
-	if ($add_to_sent) {
-		$message_sent->save();
-	}
-
-	$message_to->access_id = ACCESS_PRIVATE;
-	$message_to->save();
-
-	if ($add_to_sent) {
-		$message_sent->access_id = ACCESS_PRIVATE;
-		$message_sent->save();
-	}
-
-	// if the new message is a reply then create a relationship link between the new message
-	// and the message it is in reply to
-	if ($original_msg_guid && $success) {
-		add_entity_relationship($message_sent->guid, "reply", $original_msg_guid);
-	}
-
-	$message_contents = strip_tags($body);
-	if (($recipient_guid != elgg_get_logged_in_user_guid()) && $notify) {
-		$recipient = get_user($recipient_guid);
-		$sender = get_user($sender_guid);
+    // @todo remove globals
+    global $messagesendflag;
+    $messagesendflag = 1;
+
+    // @todo remove globals
+    global $messages_pm;
+    if ($notify) {
+        $messages_pm = 1;
+    } else {
+        $messages_pm = 0;
+    }
+
+    // If $sender_guid == 0, set to current user
+    if ($sender_guid == 0) {
+        $sender_guid = (int) elgg_get_logged_in_user_guid();
+    }
+
+    // Initialise 2 new ElggObject
+    $message_to = new ElggObject();
+    $message_sent = new ElggObject();
+
+    $message_to->subtype = "messages";
+    $message_sent->subtype = "messages";
+
+    $message_to->owner_guid = $recipient_guid;
+    $message_to->container_guid = $recipient_guid;
+    $message_sent->owner_guid = $sender_guid;
+    $message_sent->container_guid = $sender_guid;
+
+    $message_to->access_id = ACCESS_PUBLIC;
+    $message_sent->access_id = ACCESS_PUBLIC;
+
+    $message_to->title = $subject;
+    $message_to->description = $body;
+
+    $message_sent->title = $subject;
+    $message_sent->description = $body;
+
+    $message_to->toId = $recipient_guid; // the user receiving the message
+    $message_to->fromId = $sender_guid; // the user receiving the message
+    $message_to->readYet = 0; // this is a toggle between 0 / 1 (1 = read)
+    $message_to->hiddenFrom = 0; // this is used when a user deletes a message in their sentbox, it is a flag
+    $message_to->hiddenTo = 0; // this is used when a user deletes a message in their inbox
+
+    $message_sent->toId = $recipient_guid; // the user receiving the message
+    $message_sent->fromId = $sender_guid; // the user receiving the message
+    $message_sent->readYet = 0; // this is a toggle between 0 / 1 (1 = read)
+    $message_sent->hiddenFrom = 0; // this is used when a user deletes a message in their sentbox, it is a flag
+    $message_sent->hiddenTo = 0; // this is used when a user deletes a message in their inbox
+
+    // Save the copy of the message that goes to the recipient
+    $success = $message_to->save();
+
+    // Save the copy of the message that goes to the sender
+    if ($add_to_sent) {
+        $message_sent->save();
+    }
+
+    $message_to->access_id = ACCESS_PRIVATE;
+    $message_to->save();
+
+    if ($add_to_sent) {
+        $message_sent->access_id = ACCESS_PRIVATE;
+        $message_sent->save();
+    }
+
+    // if the new message is a reply then create a relationship link between the new message
+    // and the message it is in reply to
+    if ($original_msg_guid && $success) {
+        add_entity_relationship($message_sent->guid, "reply", $original_msg_guid);
+    }
+
+    $message_contents = strip_tags($body);
+    if (($recipient_guid != elgg_get_logged_in_user_guid()) && $notify) {
+        $recipient = get_user($recipient_guid);
+        $sender = get_user($sender_guid);
 		
-		$subject = elgg_echo('messages:email:subject', [], $recipient->language);
-		$body = elgg_echo('messages:email:body', [
-				$sender->name,
-				$message_contents,
-				elgg_get_site_url() . "messages/inbox/" . $recipient->username,
-				$sender->name,
-				elgg_get_site_url() . "messages/compose?send_to=" . $sender_guid
-			],
-			$recipient->language
-		);
-
-		$params = [
-			'object' => $message_to,
-			'action' => 'send',
-			'url' => $message_to->getURL(),
-		];
-		notify_user($recipient_guid, $sender_guid, $subject, $body, $params);
-	}
-
-	$messagesendflag = 0;
-	return $success;
+        $subject = elgg_echo('messages:email:subject', [], $recipient->language);
+        $body = elgg_echo('messages:email:body', [
+                $sender->name,
+                $message_contents,
+                elgg_get_site_url() . "messages/inbox/" . $recipient->username,
+                $sender->name,
+                elgg_get_site_url() . "messages/compose?send_to=" . $sender_guid
+            ],
+            $recipient->language
+        );
+
+        $params = [
+            'object' => $message_to,
+            'action' => 'send',
+            'url' => $message_to->getURL(),
+        ];
+        notify_user($recipient_guid, $sender_guid, $subject, $body, $params);
+    }
+
+    $messagesendflag = 0;
+    return $success;
 }
 
 /**
@@ -331,10 +331,10 @@ 
  * @return string
  */
 function messages_set_url($hook, $type, $url, $params) {
-	$entity = $params['entity'];
-	if (elgg_instanceof($entity, 'object', 'messages')) {
-		return 'messages/read/' . $entity->getGUID();
-	}
+    $entity = $params['entity'];
+    if (elgg_instanceof($entity, 'object', 'messages')) {
+        return 'messages/read/' . $entity->getGUID();
+    }
 }
 
 /**
@@ -349,18 +349,18 @@ 
  * @since 1.9
  */
 function messages_get_unread($user_guid = 0, $limit = null, $offset = 0, $count = false) {
-	return elgg_get_entities_from_metadata([
-		'metadata_name_value_pairs' => [
-			'toId' => $user_guid,
-			'readYet' => 0,
-			'msg' => 1,
-		],
-		'owner_guid' => $user_guid ?: elgg_get_logged_in_user_guid(),
-		'limit' => $limit ?: elgg_get_config('default_limit'),
-		'offset' => $offset,
-		'count' => $count,
-		'distinct' => false,
-	]);
+    return elgg_get_entities_from_metadata([
+        'metadata_name_value_pairs' => [
+            'toId' => $user_guid,
+            'readYet' => 0,
+            'msg' => 1,
+        ],
+        'owner_guid' => $user_guid ?: elgg_get_logged_in_user_guid(),
+        'limit' => $limit ?: elgg_get_config('default_limit'),
+        'offset' => $offset,
+        'count' => $count,
+        'distinct' => false,
+    ]);
 }
 
 /**
@@ -371,7 +371,7 @@ 
  * @return int
  */
 function messages_count_unread($user_guid = 0) {
-	return messages_get_unread($user_guid, 10, 0, true);
+    return messages_get_unread($user_guid, 10, 0, true);
 }
 
 /**
@@ -381,47 +381,47 @@ 
  */
 function messages_prepare_form_vars($recipient_guid = 0) {
 
-	$recipients = [];
-	$recipient = get_user($recipient_guid);
-	if (!empty($recipient)) {
-		$recipients[] = $recipient->getGUID();
-	}
+    $recipients = [];
+    $recipient = get_user($recipient_guid);
+    if (!empty($recipient)) {
+        $recipients[] = $recipient->getGUID();
+    }
 
-	// input names => defaults
-	$values = [
-		'subject' => elgg_get_sticky_value('messages', 'subject', ''),
-		'body' => elgg_get_sticky_value('messages', 'body', ''),
-		'recipients' => elgg_get_sticky_value('messages', 'recipients', $recipients),
-	];
+    // input names => defaults
+    $values = [
+        'subject' => elgg_get_sticky_value('messages', 'subject', ''),
+        'body' => elgg_get_sticky_value('messages', 'body', ''),
+        'recipients' => elgg_get_sticky_value('messages', 'recipients', $recipients),
+    ];
 
-	elgg_clear_sticky_form('messages');
+    elgg_clear_sticky_form('messages');
 
-	return $values;
+    return $values;
 }
 
 /**
  * Add to the user hover menu
  */
 function messages_user_hover_menu($hook, $type, $return, $params) {
-	$user = $params['entity'];
+    $user = $params['entity'];
 
-	if (!elgg_is_logged_in()) {
-		return;
-	}
+    if (!elgg_is_logged_in()) {
+        return;
+    }
 	
-	if (elgg_get_logged_in_user_guid() == $user->guid) {
-		return;
-	}
+    if (elgg_get_logged_in_user_guid() == $user->guid) {
+        return;
+    }
 	
-	$return[] = ElggMenuItem::factory([
-		'name' => 'send',
-		'text' => elgg_echo('messages:sendmessage'),
-		'icon' => 'mail',
-		'href' => "messages/compose?send_to={$user->guid}",
-		'section' => 'action',
-	]);
-
-	return $return;
+    $return[] = ElggMenuItem::factory([
+        'name' => 'send',
+        'text' => elgg_echo('messages:sendmessage'),
+        'icon' => 'mail',
+        'href' => "messages/compose?send_to={$user->guid}",
+        'section' => 'action',
+    ]);
+
+    return $return;
 }
 
 /**
@@ -433,28 +433,28 @@ 
  */
 function messages_purge($event, $type, $user) {
 
-	if (!$user->getGUID()) {
-		return;
-	}
-
-	// make sure we delete them all
-	$entity_disable_override = access_show_hidden_entities(true);
-	$ia = elgg_set_ignore_access(true);
-
-	$options = [
-		'type' => 'object',
-		'subtype' => 'messages',
-		'metadata_name' => 'fromId',
-		'metadata_value' => $user->getGUID(),
-		'limit' => 0,
-	];
-	$batch = new ElggBatch('elgg_get_entities_from_metadata', $options);
-	foreach ($batch as $e) {
-		$e->delete();
-	}
-
-	elgg_set_ignore_access($ia);
-	access_show_hidden_entities($entity_disable_override);
+    if (!$user->getGUID()) {
+        return;
+    }
+
+    // make sure we delete them all
+    $entity_disable_override = access_show_hidden_entities(true);
+    $ia = elgg_set_ignore_access(true);
+
+    $options = [
+        'type' => 'object',
+        'subtype' => 'messages',
+        'metadata_name' => 'fromId',
+        'metadata_value' => $user->getGUID(),
+        'limit' => 0,
+    ];
+    $batch = new ElggBatch('elgg_get_entities_from_metadata', $options);
+    foreach ($batch as $e) {
+        $e->delete();
+    }
+
+    elgg_set_ignore_access($ia);
+    access_show_hidden_entities($entity_disable_override);
 }
 
 /**
@@ -468,7 +468,7 @@ 
  * @return array
  */
 function messages_ecml_views_hook($hook, $entity_type, $return_value, $params) {
-	$return_value['messages/messages'] = elgg_echo('messages');
+    $return_value['messages/messages'] = elgg_echo('messages');
 
-	return $return_value;
+    return $return_value;
 }

Spacing +7 added lines, -7 removed lines

@@ -13,14 +13,14 @@ 
 		elgg_register_menu_item('page', [
 			'name' => 'messages:inbox',
 			'text' => elgg_echo('messages:inbox'),
-			'href' => "messages/inbox/" . elgg_get_logged_in_user_entity()->username,
+			'href' => "messages/inbox/".elgg_get_logged_in_user_entity()->username,
 			'context' => 'messages',
 		]);
 		
 		elgg_register_menu_item('page', [
 			'name' => 'messages:sentmessages',
 			'text' => elgg_echo('messages:sentmessages'),
-			'href' => "messages/sent/" . elgg_get_logged_in_user_entity()->username,
+			'href' => "messages/sent/".elgg_get_logged_in_user_entity()->username,
 			'context' => 'messages',
 		]);
 	}
@@ -64,7 +64,7 @@ 
 
 	elgg_gatekeeper();
 
-	elgg_push_breadcrumb(elgg_echo('messages'), 'messages/inbox/' . $current_user->username);
+	elgg_push_breadcrumb(elgg_echo('messages'), 'messages/inbox/'.$current_user->username);
 
 	if (!isset($page[0])) {
 		$page[0] = 'inbox';
@@ -128,7 +128,7 @@ 
 
 	$num_messages = (int) messages_count_unread();
 	if ($num_messages) {
-		$title .= " (" . elgg_echo("messages:unreadcount", [$num_messages]) . ")";
+		$title .= " (".elgg_echo("messages:unreadcount", [$num_messages]).")";
 	}
 
 	$items[] = ElggMenuItem::factory([
@@ -302,9 +302,9 @@ 
 		$body = elgg_echo('messages:email:body', [
 				$sender->name,
 				$message_contents,
-				elgg_get_site_url() . "messages/inbox/" . $recipient->username,
+				elgg_get_site_url()."messages/inbox/".$recipient->username,
 				$sender->name,
-				elgg_get_site_url() . "messages/compose?send_to=" . $sender_guid
+				elgg_get_site_url()."messages/compose?send_to=".$sender_guid
 			],
 			$recipient->language
 		);
@@ -333,7 +333,7 @@ 
 function messages_set_url($hook, $type, $url, $params) {
 	$entity = $params['entity'];
 	if (elgg_instanceof($entity, 'object', 'messages')) {
-		return 'messages/read/' . $entity->getGUID();
+		return 'messages/read/'.$entity->getGUID();
 	}
 }
 

mod/search/search_hooks.php

Doc Comments +1 added lines, -1 removed lines

@@ -358,7 +358,7 @@
  * @param string $type   Hook type
  * @param array  $value  Array of custom search types
  * @param array  $params Search parameters
- * @return array
+ * @return string[]
  */
 function search_custom_types_tags_hook($hook, $type, $value, $params) {
 	$value[] = 'tags';

Indentation +255 added lines, -255 removed lines

@@ -17,46 +17,46 @@ 
  */
 function search_objects_hook($hook, $type, $value, $params) {
 
-	$params['joins'] = (array) elgg_extract('joins', $params, []);
-	$params['wheres'] = (array) elgg_extract('wheres', $params, []);
+    $params['joins'] = (array) elgg_extract('joins', $params, []);
+    $params['wheres'] = (array) elgg_extract('wheres', $params, []);
 	
-	$db_prefix = elgg_get_config('dbprefix');
+    $db_prefix = elgg_get_config('dbprefix');
 
-	$join = "JOIN {$db_prefix}objects_entity oe ON e.guid = oe.guid";
-	array_unshift($params['joins'], $join);
+    $join = "JOIN {$db_prefix}objects_entity oe ON e.guid = oe.guid";
+    array_unshift($params['joins'], $join);
 
-	$fields = ['title', 'description'];
-	$where = search_get_where_sql('oe', $fields, $params);
-	$params['wheres'][] = $where;
+    $fields = ['title', 'description'];
+    $where = search_get_where_sql('oe', $fields, $params);
+    $params['wheres'][] = $where;
 	
-	$params['count'] = true;
-	$count = elgg_get_entities($params);
+    $params['count'] = true;
+    $count = elgg_get_entities($params);
 	
-	// no need to continue if nothing here.
-	if (!$count) {
-		return ['entities' => [], 'count' => $count];
-	}
+    // no need to continue if nothing here.
+    if (!$count) {
+        return ['entities' => [], 'count' => $count];
+    }
 	
-	$params['count'] = false;
-	if (isset($params['sort']) || !isset($params['order_by'])) {
-		$params['order_by'] = search_get_order_by_sql('e', 'oe', $params['sort'], $params['order']);
-	}
-	$params['preload_owners'] = true;
-	$entities = elgg_get_entities($params);
-
-	// add the volatile data for why these entities have been returned.
-	foreach ($entities as $entity) {
-		$title = search_get_highlighted_relevant_substrings($entity->getDisplayName(), $params['query']);
-		$entity->setVolatileData('search_matched_title', $title);
-
-		$desc = search_get_highlighted_relevant_substrings($entity->description, $params['query']);
-		$entity->setVolatileData('search_matched_description', $desc);
-	}
-
-	return [
-		'entities' => $entities,
-		'count' => $count,
-	];
+    $params['count'] = false;
+    if (isset($params['sort']) || !isset($params['order_by'])) {
+        $params['order_by'] = search_get_order_by_sql('e', 'oe', $params['sort'], $params['order']);
+    }
+    $params['preload_owners'] = true;
+    $entities = elgg_get_entities($params);
+
+    // add the volatile data for why these entities have been returned.
+    foreach ($entities as $entity) {
+        $title = search_get_highlighted_relevant_substrings($entity->getDisplayName(), $params['query']);
+        $entity->setVolatileData('search_matched_title', $title);
+
+        $desc = search_get_highlighted_relevant_substrings($entity->description, $params['query']);
+        $entity->setVolatileData('search_matched_description', $desc);
+    }
+
+    return [
+        'entities' => $entities,
+        'count' => $count,
+    ];
 }
 
 /**
@@ -70,47 +70,47 @@ 
  */
 function search_groups_hook($hook, $type, $value, $params) {
 
-	$params['joins'] = (array) elgg_extract('joins', $params, []);
-	$params['wheres'] = (array) elgg_extract('wheres', $params, []);
+    $params['joins'] = (array) elgg_extract('joins', $params, []);
+    $params['wheres'] = (array) elgg_extract('wheres', $params, []);
 	
-	$db_prefix = elgg_get_config('dbprefix');
+    $db_prefix = elgg_get_config('dbprefix');
 
-	$query = sanitise_string($params['query']);
+    $query = sanitise_string($params['query']);
 
-	$join = "JOIN {$db_prefix}groups_entity ge ON e.guid = ge.guid";
-	array_unshift($params['joins'], $join);
+    $join = "JOIN {$db_prefix}groups_entity ge ON e.guid = ge.guid";
+    array_unshift($params['joins'], $join);
 	
-	$fields = ['name', 'description'];
-	$where = search_get_where_sql('ge', $fields, $params);
-	$params['wheres'][] = $where;
+    $fields = ['name', 'description'];
+    $where = search_get_where_sql('ge', $fields, $params);
+    $params['wheres'][] = $where;
 
-	$params['count'] = true;
-	$count = elgg_get_entities($params);
+    $params['count'] = true;
+    $count = elgg_get_entities($params);
 	
-	// no need to continue if nothing here.
-	if (!$count) {
-		return ['entities' => [], 'count' => $count];
-	}
+    // no need to continue if nothing here.
+    if (!$count) {
+        return ['entities' => [], 'count' => $count];
+    }
 	
-	$params['count'] = false;
-	if (isset($params['sort']) || !isset($params['order_by'])) {
-		$params['order_by'] = search_get_order_by_sql('e', 'ge', $params['sort'], $params['order']);
-	}
-	$entities = elgg_get_entities($params);
-
-	// add the volatile data for why these entities have been returned.
-	foreach ($entities as $entity) {
-		$name = search_get_highlighted_relevant_substrings($entity->getDisplayName(), $query);
-		$entity->setVolatileData('search_matched_title', $name);
-
-		$description = search_get_highlighted_relevant_substrings($entity->description, $query);
-		$entity->setVolatileData('search_matched_description', $description);
-	}
-
-	return [
-		'entities' => $entities,
-		'count' => $count,
-	];
+    $params['count'] = false;
+    if (isset($params['sort']) || !isset($params['order_by'])) {
+        $params['order_by'] = search_get_order_by_sql('e', 'ge', $params['sort'], $params['order']);
+    }
+    $entities = elgg_get_entities($params);
+
+    // add the volatile data for why these entities have been returned.
+    foreach ($entities as $entity) {
+        $name = search_get_highlighted_relevant_substrings($entity->getDisplayName(), $query);
+        $entity->setVolatileData('search_matched_title', $name);
+
+        $description = search_get_highlighted_relevant_substrings($entity->description, $query);
+        $entity->setVolatileData('search_matched_description', $description);
+    }
+
+    return [
+        'entities' => $entities,
+        'count' => $count,
+    ];
 }
 
 /**
@@ -126,101 +126,101 @@ 
  */
 function search_users_hook($hook, $type, $value, $params) {
 
-	$params['joins'] = (array) elgg_extract('joins', $params, []);
-	$params['wheres'] = (array) elgg_extract('wheres', $params, []);
+    $params['joins'] = (array) elgg_extract('joins', $params, []);
+    $params['wheres'] = (array) elgg_extract('wheres', $params, []);
 	
-	$db_prefix = elgg_get_config('dbprefix');
+    $db_prefix = elgg_get_config('dbprefix');
 
-	$query = sanitise_string($params['query']);
+    $query = sanitise_string($params['query']);
 
-	$join = "JOIN {$db_prefix}users_entity ue ON e.guid = ue.guid";
-	array_unshift($params['joins'], $join);
+    $join = "JOIN {$db_prefix}users_entity ue ON e.guid = ue.guid";
+    array_unshift($params['joins'], $join);
 		
-	// username and display name
-	$fields = ['username', 'name'];
-	$where = search_get_where_sql('ue', $fields, $params);
+    // username and display name
+    $fields = ['username', 'name'];
+    $where = search_get_where_sql('ue', $fields, $params);
 
-	// profile fields
-	$profile_fields = array_keys(elgg_get_config('profile_fields'));
+    // profile fields
+    $profile_fields = array_keys(elgg_get_config('profile_fields'));
 	
-	if (!empty($profile_fields)) {
-		$params['joins'][] = "JOIN {$db_prefix}annotations an on e.guid = an.entity_guid";
+    if (!empty($profile_fields)) {
+        $params['joins'][] = "JOIN {$db_prefix}annotations an on e.guid = an.entity_guid";
 		
-		// get the where clauses for the annotation names
-		// can't use egef_annotations() because the n_table join comes too late.
-		$clauses = _elgg_entities_get_metastrings_options('annotation', [
-			'annotation_names' => $profile_fields,
-
-			// avoid notices
-			'annotation_values' => null,
-			'annotation_name_value_pairs' => null,
-			'annotation_name_value_pairs_operator' => null,
-			'annotation_case_sensitive' => null,
-			'order_by_annotation' => null,
-			'annotation_owner_guids' => null,
-		]);
-
-		$params['joins'] = array_merge($clauses['joins'], $params['joins']);
-		$md_where = "(({$clauses['wheres'][0]}) AND md.value LIKE '%$query%')";
+        // get the where clauses for the annotation names
+        // can't use egef_annotations() because the n_table join comes too late.
+        $clauses = _elgg_entities_get_metastrings_options('annotation', [
+            'annotation_names' => $profile_fields,
+
+            // avoid notices
+            'annotation_values' => null,
+            'annotation_name_value_pairs' => null,
+            'annotation_name_value_pairs_operator' => null,
+            'annotation_case_sensitive' => null,
+            'order_by_annotation' => null,
+            'annotation_owner_guids' => null,
+        ]);
+
+        $params['joins'] = array_merge($clauses['joins'], $params['joins']);
+        $md_where = "(({$clauses['wheres'][0]}) AND md.value LIKE '%$query%')";
 		
-		$params['wheres'][] = "(($where) OR ($md_where))";
-	} else {
-		$params['wheres'][] = "$where";
-	}
-
-	$params['count'] = true;
-	$count = elgg_get_entities($params);
-
-	// no need to continue if nothing here.
-	if (!$count) {
-		return ['entities' => [], 'count' => $count];
-	}
+        $params['wheres'][] = "(($where) OR ($md_where))";
+    } else {
+        $params['wheres'][] = "$where";
+    }
+
+    $params['count'] = true;
+    $count = elgg_get_entities($params);
+
+    // no need to continue if nothing here.
+    if (!$count) {
+        return ['entities' => [], 'count' => $count];
+    }
 	
-	$params['count'] = false;
-	if (isset($params['sort']) || !isset($params['order_by'])) {
-		$params['order_by'] = search_get_order_by_sql('e', 'ue', $params['sort'], $params['order']);
-	}
-	$entities = elgg_get_entities($params);
-	/* @var ElggUser[] $entities */
-
-	// add the volatile data for why these entities have been returned.
-	foreach ($entities as $entity) {
-		$title = search_get_highlighted_relevant_substrings($entity->getDisplayName(), $query);
-
-		// include the username if it matches but the display name doesn't.
-		if (false !== strpos($entity->username, $query)) {
-			$username = search_get_highlighted_relevant_substrings($entity->username, $query);
-			$title .= " ($username)";
-		}
-
-		$entity->setVolatileData('search_matched_title', $title);
-
-		if (!empty($profile_fields)) {
-			$matched = '';
-			foreach ($profile_fields as $shortname) {
-				$annotations = $entity->getAnnotations([
-					'annotation_names' => "profile:$shortname",
-					'limit' => false,
-				]);
-				$values = array_map(function (ElggAnnotation $a) {
-					return $a->value;
-				}, $annotations);
-				foreach ($values as $text) {
-					if (stristr($text, $query)) {
-						$matched .= elgg_echo("profile:{$shortname}") . ': '
-								. search_get_highlighted_relevant_substrings($text, $query);
-					}
-				}
-			}
+    $params['count'] = false;
+    if (isset($params['sort']) || !isset($params['order_by'])) {
+        $params['order_by'] = search_get_order_by_sql('e', 'ue', $params['sort'], $params['order']);
+    }
+    $entities = elgg_get_entities($params);
+    /* @var ElggUser[] $entities */
+
+    // add the volatile data for why these entities have been returned.
+    foreach ($entities as $entity) {
+        $title = search_get_highlighted_relevant_substrings($entity->getDisplayName(), $query);
+
+        // include the username if it matches but the display name doesn't.
+        if (false !== strpos($entity->username, $query)) {
+            $username = search_get_highlighted_relevant_substrings($entity->username, $query);
+            $title .= " ($username)";
+        }
+
+        $entity->setVolatileData('search_matched_title', $title);
+
+        if (!empty($profile_fields)) {
+            $matched = '';
+            foreach ($profile_fields as $shortname) {
+                $annotations = $entity->getAnnotations([
+                    'annotation_names' => "profile:$shortname",
+                    'limit' => false,
+                ]);
+                $values = array_map(function (ElggAnnotation $a) {
+                    return $a->value;
+                }, $annotations);
+                foreach ($values as $text) {
+                    if (stristr($text, $query)) {
+                        $matched .= elgg_echo("profile:{$shortname}") . ': '
+                                . search_get_highlighted_relevant_substrings($text, $query);
+                    }
+                }
+            }
 	
-			$entity->setVolatileData('search_matched_description', $matched);
-		}
-	}
-
-	return [
-		'entities' => $entities,
-		'count' => $count,
-	];
+            $entity->setVolatileData('search_matched_description', $matched);
+        }
+    }
+
+    return [
+        'entities' => $entities,
+        'count' => $count,
+    ];
 }
 
 /**
@@ -234,108 +234,108 @@ 
  */
 function search_tags_hook($hook, $type, $value, $params) {
 
-	$params['joins'] = (array) elgg_extract('joins', $params, []);
-	$params['wheres'] = (array) elgg_extract('wheres', $params, []);
-
-	$db_prefix = elgg_get_config('dbprefix');
-
-	$valid_tag_names = elgg_get_registered_tag_metadata_names();
-
-	// @todo will need to split this up to support searching multiple tags at once.
-	$query = sanitise_string($params['query']);
-
-	// if passed a tag metadata name, only search on that tag name.
-	// tag_name isn't included in the params because it's specific to
-	// tag searches.
-	if ($tag_names = get_input('tag_names')) {
-		if (is_array($tag_names)) {
-			$search_tag_names = $tag_names;
-		} else {
-			$search_tag_names = [$tag_names];
-		}
-
-		// check these are valid to avoid arbitrary metadata searches.
-		foreach ($search_tag_names as $i => $tag_name) {
-			if (!in_array($tag_name, $valid_tag_names)) {
-				unset($search_tag_names[$i]);
-			}
-		}
-	} else {
-		$search_tag_names = $valid_tag_names;
-	}
-
-	if (!$search_tag_names) {
-		return ['entities' => [], 'count' => $count];
-	}
-
-	// don't use elgg_get_entities_from_metadata() here because of
-	// performance issues.  since we don't care what matches at this point
-	// use an IN clause to grab everything that matches at once and sort
-	// out the matches later.
-	$params['joins'][] = "JOIN {$db_prefix}metadata md on e.guid = md.entity_guid";
-
-	$access = _elgg_get_access_where_sql([
-		'table_alias' => 'md',
-		'guid_column' => 'entity_guid',
-	]);
-	$sanitised_tags = [];
-
-	foreach ($search_tag_names as $tag) {
-		$sanitised_tags[] = '"' . sanitise_string($tag) . '"';
-	}
-
-	$tags_in = implode(',', $sanitised_tags);
-
-	$params['wheres'][] = "(md.name IN ($tags_in) AND md.value = '$query' AND $access)";
-
-	$params['count'] = true;
-	$count = elgg_get_entities($params);
-
-	// no need to continue if nothing here.
-	if (!$count) {
-		return ['entities' => [], 'count' => $count];
-	}
+    $params['joins'] = (array) elgg_extract('joins', $params, []);
+    $params['wheres'] = (array) elgg_extract('wheres', $params, []);
+
+    $db_prefix = elgg_get_config('dbprefix');
+
+    $valid_tag_names = elgg_get_registered_tag_metadata_names();
+
+    // @todo will need to split this up to support searching multiple tags at once.
+    $query = sanitise_string($params['query']);
+
+    // if passed a tag metadata name, only search on that tag name.
+    // tag_name isn't included in the params because it's specific to
+    // tag searches.
+    if ($tag_names = get_input('tag_names')) {
+        if (is_array($tag_names)) {
+            $search_tag_names = $tag_names;
+        } else {
+            $search_tag_names = [$tag_names];
+        }
+
+        // check these are valid to avoid arbitrary metadata searches.
+        foreach ($search_tag_names as $i => $tag_name) {
+            if (!in_array($tag_name, $valid_tag_names)) {
+                unset($search_tag_names[$i]);
+            }
+        }
+    } else {
+        $search_tag_names = $valid_tag_names;
+    }
+
+    if (!$search_tag_names) {
+        return ['entities' => [], 'count' => $count];
+    }
+
+    // don't use elgg_get_entities_from_metadata() here because of
+    // performance issues.  since we don't care what matches at this point
+    // use an IN clause to grab everything that matches at once and sort
+    // out the matches later.
+    $params['joins'][] = "JOIN {$db_prefix}metadata md on e.guid = md.entity_guid";
+
+    $access = _elgg_get_access_where_sql([
+        'table_alias' => 'md',
+        'guid_column' => 'entity_guid',
+    ]);
+    $sanitised_tags = [];
+
+    foreach ($search_tag_names as $tag) {
+        $sanitised_tags[] = '"' . sanitise_string($tag) . '"';
+    }
+
+    $tags_in = implode(',', $sanitised_tags);
+
+    $params['wheres'][] = "(md.name IN ($tags_in) AND md.value = '$query' AND $access)";
+
+    $params['count'] = true;
+    $count = elgg_get_entities($params);
+
+    // no need to continue if nothing here.
+    if (!$count) {
+        return ['entities' => [], 'count' => $count];
+    }
 	
-	$params['count'] = false;
-	if (isset($params['sort']) || !isset($params['order_by'])) {
-		$params['order_by'] = search_get_order_by_sql('e', null, $params['sort'], $params['order']);
-	}
-	$entities = elgg_get_entities($params);
-
-	// add the volatile data for why these entities have been returned.
-	foreach ($entities as $entity) {
-		$matched_tags_strs = [];
-
-		// get tags for each tag name requested to find which ones matched.
-		foreach ($search_tag_names as $tag_name) {
-			$tags = $entity->getTags($tag_name);
-
-			// @todo make one long tag string and run this through the highlight
-			// function.  This might be confusing as it could chop off
-			// the tag labels.
-			if (in_array(strtolower($query), array_map('strtolower', $tags))) {
-				if (is_array($tags)) {
-					$tag_name_str = elgg_echo("tag_names:$tag_name");
-					$matched_tags_strs[] = "$tag_name_str: " . implode(', ', $tags);
-				}
-			}
-		}
-
-		$title_str = elgg_get_excerpt($entity->getDisplayName(), 300);
-		$desc_str = elgg_get_excerpt($entity->description, 300);
+    $params['count'] = false;
+    if (isset($params['sort']) || !isset($params['order_by'])) {
+        $params['order_by'] = search_get_order_by_sql('e', null, $params['sort'], $params['order']);
+    }
+    $entities = elgg_get_entities($params);
+
+    // add the volatile data for why these entities have been returned.
+    foreach ($entities as $entity) {
+        $matched_tags_strs = [];
+
+        // get tags for each tag name requested to find which ones matched.
+        foreach ($search_tag_names as $tag_name) {
+            $tags = $entity->getTags($tag_name);
+
+            // @todo make one long tag string and run this through the highlight
+            // function.  This might be confusing as it could chop off
+            // the tag labels.
+            if (in_array(strtolower($query), array_map('strtolower', $tags))) {
+                if (is_array($tags)) {
+                    $tag_name_str = elgg_echo("tag_names:$tag_name");
+                    $matched_tags_strs[] = "$tag_name_str: " . implode(', ', $tags);
+                }
+            }
+        }
+
+        $title_str = elgg_get_excerpt($entity->getDisplayName(), 300);
+        $desc_str = elgg_get_excerpt($entity->description, 300);
 		
-		$tags_str = implode('. ', $matched_tags_strs);
-		$tags_str = search_get_highlighted_relevant_substrings($tags_str, $params['query'], 30, 300, true);
-
-		$entity->setVolatileData('search_matched_title', $title_str);
-		$entity->setVolatileData('search_matched_description', $desc_str);
-		$entity->setVolatileData('search_matched_extra', $tags_str);
-	}
-
-	return [
-		'entities' => $entities,
-		'count' => $count,
-	];
+        $tags_str = implode('. ', $matched_tags_strs);
+        $tags_str = search_get_highlighted_relevant_substrings($tags_str, $params['query'], 30, 300, true);
+
+        $entity->setVolatileData('search_matched_title', $title_str);
+        $entity->setVolatileData('search_matched_description', $desc_str);
+        $entity->setVolatileData('search_matched_extra', $tags_str);
+    }
+
+    return [
+        'entities' => $entities,
+        'count' => $count,
+    ];
 }
 
 /**
@@ -348,6 +348,6 @@ 
  * @return array
  */
 function search_custom_types_tags_hook($hook, $type, $value, $params) {
-	$value[] = 'tags';
-	return $value;
+    $value[] = 'tags';
+    return $value;
 }

Spacing +4 added lines, -4 removed lines

@@ -202,12 +202,12 @@ 
 					'annotation_names' => "profile:$shortname",
 					'limit' => false,
 				]);
-				$values = array_map(function (ElggAnnotation $a) {
+				$values = array_map(function(ElggAnnotation $a) {
 					return $a->value;
 				}, $annotations);
 				foreach ($values as $text) {
 					if (stristr($text, $query)) {
-						$matched .= elgg_echo("profile:{$shortname}") . ': '
+						$matched .= elgg_echo("profile:{$shortname}").': '
 								. search_get_highlighted_relevant_substrings($text, $query);
 					}
 				}
@@ -281,7 +281,7 @@ 
 	$sanitised_tags = [];
 
 	foreach ($search_tag_names as $tag) {
-		$sanitised_tags[] = '"' . sanitise_string($tag) . '"';
+		$sanitised_tags[] = '"'.sanitise_string($tag).'"';
 	}
 
 	$tags_in = implode(',', $sanitised_tags);
@@ -316,7 +316,7 @@ 
 			if (in_array(strtolower($query), array_map('strtolower', $tags))) {
 				if (is_array($tags)) {
 					$tag_name_str = elgg_echo("tag_names:$tag_name");
-					$matched_tags_strs[] = "$tag_name_str: " . implode(', ', $tags);
+					$matched_tags_strs[] = "$tag_name_str: ".implode(', ', $tags);
 				}
 			}
 		}

mod/web_services/classes/ElggHMACCache.php

Doc Comments +1 added lines, -1 removed lines

@@ -76,7 +76,7 @@
 	 *
 	 * Not currently implemented in this cache type.
 	 *
-	 * @return true
+	 * @return boolean
 	 */
 	public function clear() {
 		return true;

Indentation +74 added lines, -74 removed lines

@@ -7,89 +7,89 @@
  * @subpackage HMAC
  */
 class ElggHMACCache extends ElggCache {
-	/**
-	 * Set the Elgg cache.
-	 *
-	 * @param int $max_age Maximum age in seconds, 0 if no limit.
-	 */
-	function __construct($max_age = 0) {
-		$this->setVariable("max_age", $max_age);
-	}
+    /**
+     * Set the Elgg cache.
+     *
+     * @param int $max_age Maximum age in seconds, 0 if no limit.
+     */
+    function __construct($max_age = 0) {
+        $this->setVariable("max_age", $max_age);
+    }
 
-	/**
-	 * Save a key
-	 *
-	 * @param string $key  Name
-	 * @param string $data Value
-	 *
-	 * @return boolean
-	 */
-	public function save($key, $data) {
-		$dbprefix = elgg_get_config('dbprefix');
-		$key = sanitise_string($key);
-		$time = time();
+    /**
+     * Save a key
+     *
+     * @param string $key  Name
+     * @param string $data Value
+     *
+     * @return boolean
+     */
+    public function save($key, $data) {
+        $dbprefix = elgg_get_config('dbprefix');
+        $key = sanitise_string($key);
+        $time = time();
 
-		$query = "INSERT into {$dbprefix}hmac_cache (hmac, ts) VALUES ('$key', '$time')";
-		return insert_data($query);
-	}
+        $query = "INSERT into {$dbprefix}hmac_cache (hmac, ts) VALUES ('$key', '$time')";
+        return insert_data($query);
+    }
 
-	/**
-	 * Load a key
-	 *
-	 * @param string $key    Name
-	 * @param int    $offset Offset
-	 * @param int    $limit  Limit
-	 *
-	 * @return string
-	 */
-	public function load($key, $offset = 0, $limit = null) {
-		$dbprefix = elgg_get_config('dbprefix');
-		$key = sanitise_string($key);
+    /**
+     * Load a key
+     *
+     * @param string $key    Name
+     * @param int    $offset Offset
+     * @param int    $limit  Limit
+     *
+     * @return string
+     */
+    public function load($key, $offset = 0, $limit = null) {
+        $dbprefix = elgg_get_config('dbprefix');
+        $key = sanitise_string($key);
 
-		$row = get_data_row("SELECT * from {$dbprefix}hmac_cache where hmac='$key'");
-		if ($row) {
-			return $row->hmac;
-		}
+        $row = get_data_row("SELECT * from {$dbprefix}hmac_cache where hmac='$key'");
+        if ($row) {
+            return $row->hmac;
+        }
 
-		return false;
-	}
+        return false;
+    }
 
-	/**
-	 * Invalidate a given key.
-	 *
-	 * @param string $key Name
-	 *
-	 * @return bool
-	 */
-	public function delete($key) {
-		$dbprefix = elgg_get_config('dbprefix');
-		$key = sanitise_string($key);
+    /**
+     * Invalidate a given key.
+     *
+     * @param string $key Name
+     *
+     * @return bool
+     */
+    public function delete($key) {
+        $dbprefix = elgg_get_config('dbprefix');
+        $key = sanitise_string($key);
 
-		return delete_data("DELETE from {$dbprefix}hmac_cache where hmac='$key'");
-	}
+        return delete_data("DELETE from {$dbprefix}hmac_cache where hmac='$key'");
+    }
 
-	/**
-	 * Clear out all the contents of the cache.
-	 *
-	 * Not currently implemented in this cache type.
-	 *
-	 * @return true
-	 */
-	public function clear() {
-		return true;
-	}
+    /**
+     * Clear out all the contents of the cache.
+     *
+     * Not currently implemented in this cache type.
+     *
+     * @return true
+     */
+    public function clear() {
+        return true;
+    }
 
-	/**
-	 * Clean out old stuff.
-	 *
-	 */
-	public function __destruct() {
-		$dbprefix = elgg_get_config('dbprefix');
-		$time = time();
-		$age = (int) $this->getVariable("max_age");
+    /**
+     * Clean out old stuff.
+     *
+     */
+    public function __destruct() {
+        $dbprefix = elgg_get_config('dbprefix');
+        $time = time();
+        $age = (int) $this->getVariable("max_age");
 
-		$expires = $time - $age;
+        $expires = $time - $age;
 
-		delete_data("DELETE from {$dbprefix}hmac_cache where ts<$expires");
-	}
+        delete_data("DELETE from {$dbprefix}hmac_cache where ts<$expires");
+    }
 }