search_hooks.php ➔ search_objects_hook() - Code Metrics - Inspection of "Merge pull request #11259 from jdalsem/drop-user-s..." - Elgg/Elgg - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 5063d9...a1994b )

by Jeroen

created 2017-10-12 17:58 UTC

search_hooks.php ➔ search_objects_hook() C

↳ Parent: Project

Complexity

Conditions	10
Paths	70

Size

Total Lines	64
Code Lines	38

Duplication

Lines	29
Ratio	45.31 %

Importance

Changes

Metric	Value
cc	10
eloc	38
nc	70
nop	4
dl	29
loc	64
rs	6.309
c	0
b	0
f	0

How to fix Long Method Complexity

<?php
/**
 * Elgg core search.
 *
 * @package Elgg
 * @subpackage Search
 */

/**
 * Get objects that match the search parameters.
 *
 * @param string $hook   Hook name
 * @param string $type   Hook type
 * @param array  $value  Empty array
 * @param array  $params Search parameters
 * @return array
 */
function search_objects_hook($hook, $type, $value, $params) {


	$params['joins'] = (array) elgg_extract('joins', $params, []);
	$params['wheres'] = (array) elgg_extract('wheres', $params, []);
	
	$query = sanitise_string($params['query']);

	$query_parts = explode(' ', $query);

	$db_prefix = elgg_get_config('dbprefix');
	
	$params['joins'][] = "JOIN {$db_prefix}metadata md ON e.guid = md.entity_guid";
	
	$fields = ['title', 'description'];
	$wheres = [];
	foreach ($fields as $field) {

		$sublikes = [];
		foreach ($query_parts as $query_part) {
			$query_part = sanitise_string($query_part);

			if (strlen($query_part) == 0) {
				continue;
			}
			$sublikes[] = "(md.value LIKE '%{$query_part}%')";
		}
		
		if (empty($sublikes)) {
			continue;
		}
		
		$wheres[] = "(md.name = '{$field}' AND (" . implode(' AND ', $sublikes) . "))";
	}
	
	if (!empty($wheres)) {

		$params['wheres'][] = '(' . implode(' OR ', $wheres) . ')';
	}
	
	$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', '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) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
		$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,
	];
}

/**
 * Get groups that match the search parameters.
 *
 * @param string $hook   Hook name
 * @param string $type   Hook type
 * @param array  $value  Empty array
 * @param array  $params Search parameters
 * @return array
 */
function search_groups_hook($hook, $type, $value, $params) {


	$params['joins'] = (array) elgg_extract('joins', $params, []);
	$params['wheres'] = (array) elgg_extract('wheres', $params, []);
	
	$query = sanitise_string($params['query']);

	$query_parts = explode(' ', $query);

	$db_prefix = elgg_get_config('dbprefix');

	$params['joins'][] = "JOIN {$db_prefix}metadata md ON e.guid = md.entity_guid";
	
	$fields = ['name', 'description'];
	$wheres = [];
	foreach ($fields as $field) {

		$sublikes = [];
		foreach ($query_parts as $query_part) {
			$query_part = sanitise_string($query_part);

			if (strlen($query_part) == 0) {
				continue;
			}
			$sublikes[] = "(md.value LIKE '%{$query_part}%')";
		}
		
		if (empty($sublikes)) {
			continue;
		}
		
		$wheres[] = "(md.name = '{$field}' AND (" . implode(' AND ', $sublikes) . "))";
	}
	
	if (!empty($wheres)) {

		$params['wheres'][] = '(' . implode(' OR ', $wheres) . ')';
	}
		
	$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', '', $params['sort'], $params['order']);
	}
	$entities = elgg_get_entities($params);

	// add the volatile data for why these entities have been returned.
	foreach ($entities as $entity) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
		$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,
	];
}

/**
 * Get users that match the search parameters.
 *
 * Searches on username, display name, and profile fields
 *
 * @param string $hook   Hook name
 * @param string $type   Hook type
 * @param array  $value  Empty array
 * @param array  $params Search parameters
 * @return array
 */
function search_users_hook($hook, $type, $value, $params) {


	$params['joins'] = (array) elgg_extract('joins', $params, []);
	$params['wheres'] = (array) elgg_extract('wheres', $params, []);
	
	$query = sanitise_string($params['query']);

	$query_parts = explode(' ', $query);

	$db_prefix = elgg_get_config('dbprefix');
	
	$params['joins'][] = "JOIN {$db_prefix}metadata md ON e.guid = md.entity_guid";
	
	$fields = ['username', 'name'];
	$wheres = [];
	foreach ($fields as $field) {

		$sublikes = [];
		foreach ($query_parts as $query_part) {
			$query_part = sanitise_string($query_part);

			if (strlen($query_part) == 0) {
				continue;
			}
			$sublikes[] = "(md.value LIKE '%{$query_part}%')";
		}
		
		if (empty($sublikes)) {
			continue;
		}
		
		$wheres[] = "(md.name = '{$field}' AND (" . implode(' AND ', $sublikes) . "))";
	}
	
	// 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";
		
		// 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']);
		$wheres[] = "(({$clauses['wheres'][0]}) AND an.value LIKE '%$query%')";
	}

	if (!empty($wheres)) {

		$params['wheres'][] = '(' . implode(' OR ', $wheres) . ')';
	}

	$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) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
		$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,
	];
}

/**
 * Get entities with tags that match the search parameters.
 *
 * @param string $hook   Hook name
 * @param string $type   Hook type
 * @param array  $value  Empty array
 * @param array  $params Search parameters
 * @return array
 */
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];
function someFunction() {
    $x = 5;
    echo $x;
}
	}

	// 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) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
		$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,
	];
}

/**
 * Register tags as a custom search type.
 *
 * @param string $hook   Hook name
 * @param string $type   Hook type
 * @param array  $value  Array of custom search types
 * @param array  $params Search parameters
 * @return array
 */
function search_custom_types_tags_hook($hook, $type, $value, $params) {

	$value[] = 'tags';
	return $value;
}


1		<?php
2		/**
3		* Elgg core search.
4		*
5		* @package Elgg
6		* @subpackage Search
7		*/
8
9		/**
10		* Get objects that match the search parameters.
11		*
12		* @param string $hook Hook name
13		* @param string $type Hook type
14		* @param array $value Empty array
15		* @param array $params Search parameters
16		* @return array
17		*/
18		function search_objects_hook($hook, $type, $value, $params) {
		0 ignored issues – show Unused Code introduced 2016-07-19 12:41 UTC by Report Bug Copy Issue Report The parameter `$hook` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Unused Code introduced 2016-07-19 12:41 UTC by Report Bug Copy Issue Report The parameter `$type` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Unused Code introduced 2016-07-19 12:41 UTC by Report Bug Copy Issue Report The parameter `$value` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
19
20		$params['joins'] = (array) elgg_extract('joins', $params, []);
21		$params['wheres'] = (array) elgg_extract('wheres', $params, []);
22
23		$query = sanitise_string($params['query']);
		0 ignored issues – show Deprecated Code introduced 2016-12-13 11:47 UTC by Report Bug Copy Issue Report The function `sanitise_string()` has been deprecated with message: Use query parameters where possible This function has been deprecated. The supplier of the file has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the function will be removed from the class and what other function to use instead. Loading history...
24		$query_parts = explode(' ', $query);
25
26		$db_prefix = elgg_get_config('dbprefix');
27
28		$params['joins'][] = "JOIN {$db_prefix}metadata md ON e.guid = md.entity_guid";
29
30		$fields = ['title', 'description'];
31		$wheres = [];
32	View Code Duplication	foreach ($fields as $field) {
		1 ignored issue – show Duplication introduced 2017-10-09 10:28 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
33		$sublikes = [];
34		foreach ($query_parts as $query_part) {
35		$query_part = sanitise_string($query_part);
		0 ignored issues – show Deprecated Code introduced 2017-01-14 12:45 UTC by Report Bug Copy Issue Report The function `sanitise_string()` has been deprecated with message: Use query parameters where possible This function has been deprecated. The supplier of the file has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the function will be removed from the class and what other function to use instead. Loading history...
36		if (strlen($query_part) == 0) {

Elgg / Elgg

Push — master ( 5063d9...a1994b )

search_hooks.php ➔ search_objects_hook() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like