Elgg / Elgg

engine/classes/Elgg/Database/AccessCollections.php

Doc Comments +1 added lines, -1 removed lines

@@ -711,7 +711,7 @@
 	 * @see get_members_of_access_collection()
 	 *
 	 * @param int $collection_id The collection ID
-	 * @return \ElggAccessCollection|false
+	 * @return string
 	 */
 	public function get($collection_id) {
 

engine/classes/Elgg/I18n/Translator.php

Doc Comments +3 added lines, -3 removed lines

@@ -78,7 +78,7 @@ 
 	/**
 	 * Get a map of all loaded translations
 	 *
-	 * @return array
+	 * @return string
 	 */
 	public function getLoadedTranslations() {
 		return $this->translations;
@@ -478,7 +478,7 @@ 
 	 *
 	 * @param string $language Language
 	 *
-	 * @return int
+	 * @return double
 	 */
 	public function getLanguageCompleteness($language) {
 
@@ -579,7 +579,7 @@ 
 	/**
 	 * Returns an array of language codes.
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	public static function getAllLanguageCodes() {
 		return [

Spacing +5 added lines, -5 removed lines

@@ -65,7 +65,7 @@ 
 	 */
 	public function __construct(Config $config) {
 		$this->config = $config;
-		$this->defaultPath = dirname(dirname(dirname(dirname(__DIR__)))) . "/languages/";
+		$this->defaultPath = dirname(dirname(dirname(dirname(__DIR__))))."/languages/";
 	}
 
 	/**
@@ -98,7 +98,7 @@ 
 	public function translate($message_key, array $args = [], $language = "") {
 		if (!is_string($message_key) || strlen($message_key) < 1) {
 			_elgg_services()->logger->warn(
-				'$message_key needs to be a string in ' . __METHOD__ . '(), ' . gettype($message_key) . ' provided'
+				'$message_key needs to be a string in '.__METHOD__.'(), '.gettype($message_key).' provided'
 			);
 			return '';
 		}
@@ -327,7 +327,7 @@ 
 	 * @return bool Success
 	 */
 	public function registerPluginTranslations($path) {
-		$languages_path = rtrim($path, "\\/") . "/languages";
+		$languages_path = rtrim($path, "\\/")."/languages";
 
 		// don't need to have translations
 		if (!is_dir($languages_path)) {
@@ -385,7 +385,7 @@ 
 			}
 
 			if (in_array($language_file, $load_language_files) || $load_all) {
-				$result = (include $path . $language_file);
+				$result = (include $path.$language_file);
 				if ($result === false) {
 					$return = false;
 					continue;
@@ -466,7 +466,7 @@ 
 			
 			$completeness = $this->getLanguageCompleteness($k);
 			if ($completeness < 100) {
-				$installed[$k] .= " (" . $completeness . "% " . $this->translate('complete') . ")";
+				$installed[$k] .= " (".$completeness."% ".$this->translate('complete').")";
 			}
 		}
 

engine/classes/Elgg/Assets/ExternalFiles.php

Spacing +1 added lines, -1 removed lines

@@ -180,7 +180,7 @@
 			return $v->loaded == true && $v->location == $location;
 		});
 		if ($items) {
-			array_walk($items, function(&$v, $k){
+			array_walk($items, function(&$v, $k) {
 				$v = $v->url;
 			});
 		}

engine/lib/actions.php

Doc Comments +2 added lines, -2 removed lines

@@ -151,7 +151,7 @@ 
  *
  * @param string $action The action being performed
  *
- * @return mixed True if valid or redirects.
+ * @return boolean True if valid or redirects.
  * @access private
  */
 function action_gatekeeper($action) {
@@ -182,7 +182,7 @@ 
 /**
  * Regenerate a new site key (32 bytes: "z" to indicate format + 186-bit key in Base64 URL).
  *
- * @return mixed The site secret hash
+ * @return string The site secret hash
  * @access private
  */
 function init_site_secret() {

engine/classes/Elgg/Database/SiteSecret.php

Spacing +1 added lines, -1 removed lines

@@ -108,7 +108,7 @@
 	 * @return SiteSecret
 	 */
 	public static function regenerate(ElggCrypto $crypto, ConfigTable $table) {
-		$key = 'z' . $crypto->getRandomString(31);
+		$key = 'z'.$crypto->getRandomString(31);
 
 		$table->set(self::CONFIG_KEY, $key);
 

engine/classes/Elgg/Application.php

Doc Comments +3 added lines, -3 removed lines

@@ -453,7 +453,7 @@ 
 	/**
 	 * Elgg's front controller. Handles basically all incoming URL requests.
 	 *
-	 * @return bool True if Elgg will handle the request, false if the server should (PHP-CLI server)
+	 * @return boolean|null True if Elgg will handle the request, false if the server should (PHP-CLI server)
 	 */
 	public static function index() {
 		$req = Request::createFromGlobals();
@@ -470,7 +470,7 @@ 
 	/**
 	 * Routes the request, booting core if not yet booted
 	 *
-	 * @return bool False if Elgg wants the PHP CLI server to handle the request
+	 * @return boolean|null False if Elgg wants the PHP CLI server to handle the request
 	 */
 	public function run() {
 		$config = $this->services->config;
@@ -781,7 +781,7 @@ 
 	 * @param int    $linenum  The line number the error was raised at
 	 * @param array  $vars     An array that points to the active symbol table where error occurred
 	 *
-	 * @return true
+	 * @return boolean
 	 * @throws \Exception
 	 * @access private
 	 */

Spacing +22 added lines, -22 removed lines

@@ -95,13 +95,13 @@ 
 		}
 
 		if ($config->elgg_config_locks) {
-			$lock = function ($name) use ($config) {
+			$lock = function($name) use ($config) {
 				$config->lock($name);
 			};
 		} else {
 			// the installer needs to build an application with defaults then update
 			// them after they're validated, so we don't want to lock them.
-			$lock = function () {
+			$lock = function() {
 			};
 		}
 
@@ -113,7 +113,7 @@ 
 		}
 
 		if ($config->dataroot) {
-			$config->dataroot = rtrim($config->dataroot, '\\/') . DIRECTORY_SEPARATOR;
+			$config->dataroot = rtrim($config->dataroot, '\\/').DIRECTORY_SEPARATOR;
 		} else {
 			if (!$config->installer_running) {
 				throw new ConfigurationException('Config value "dataroot" is required.');
@@ -122,14 +122,14 @@ 
 		$lock('dataroot');
 
 		if ($config->cacheroot) {
-			$config->cacheroot = rtrim($config->cacheroot, '\\/') . DIRECTORY_SEPARATOR;
+			$config->cacheroot = rtrim($config->cacheroot, '\\/').DIRECTORY_SEPARATOR;
 		} else {
 			$config->cacheroot = $config->dataroot;
 		}
 		$lock('cacheroot');
 
 		if ($config->wwwroot) {
-			$config->wwwroot = rtrim($config->wwwroot, '/') . '/';
+			$config->wwwroot = rtrim($config->wwwroot, '/').'/';
 		} else {
 			$config->wwwroot = $this->services->request->sniffElggUrl();
 		}
@@ -148,8 +148,8 @@ 
 		$locked_props = [
 			'site_guid' => 1,
 			'path' => Paths::project(),
-			'plugins_path' => Paths::project() . "mod/",
-			'pluginspath' => Paths::project() . "mod/",
+			'plugins_path' => Paths::project()."mod/",
+			'pluginspath' => Paths::project()."mod/",
 			'url' => $config->wwwroot,
 		];
 		foreach ($locked_props as $name => $value) {
@@ -197,7 +197,7 @@ 
 		}
 
 		$setups = [];
-		$path = Paths::elgg() . 'engine/lib';
+		$path = Paths::elgg().'engine/lib';
 
 		// include library files, capturing setup functions
 		foreach (self::getEngineLibs() as $file) {
@@ -258,7 +258,7 @@ 
 		$config = $this->services->config;
 
 		if ($this->isTestingApplication()) {
-			throw new \RuntimeException('Unit tests should not call ' . __METHOD__);
+			throw new \RuntimeException('Unit tests should not call '.__METHOD__);
 		}
 
 		if ($config->boot_complete) {
@@ -297,7 +297,7 @@ 
 			// as a custom plugin that is always loaded last and can't be disabled...
 			if (!$config->system_cache_loaded) {
 				// configure view locations for the custom plugin (not Elgg core)
-				$viewsFile = Paths::project() . 'views.php';
+				$viewsFile = Paths::project().'views.php';
 				if (is_file($viewsFile)) {
 					$viewsSpec = Includer::includeFile($viewsFile);
 					if (is_array($viewsSpec)) {
@@ -314,7 +314,7 @@ 
 			}
 
 			// This is root directory start.php
-			$root_start = Paths::project() . "start.php";
+			$root_start = Paths::project()."start.php";
 			if (is_file($root_start)) {
 				require $root_start;
 			}
@@ -364,7 +364,7 @@ 
 		if (isset(self::$public_services[$name])) {
 			return $this->services->{$name};
 		}
-		trigger_error("Undefined property: " . __CLASS__ . ":\${$name}");
+		trigger_error("Undefined property: ".__CLASS__.":\${$name}");
 	}
 
 	/**
@@ -414,7 +414,7 @@ 
 			if ($spec['request'] instanceof Request) {
 				$spec['service_provider']->setValue('request', $spec['request']);
 			} else {
-				throw new \InvalidArgumentException("Given request is not a " . Request::class);
+				throw new \InvalidArgumentException("Given request is not a ".Request::class);
 			}
 		}
 
@@ -428,7 +428,7 @@ 
 		if ($spec['handle_shutdown']) {
 			// we need to register for shutdown before Symfony registers the
 			// session_write_close() function. https://github.com/Elgg/Elgg/issues/9243
-			register_shutdown_function(function () {
+			register_shutdown_function(function() {
 				// There are cases where we may exit before this function is defined
 				if (function_exists('_elgg_shutdown_hook')) {
 					_elgg_shutdown_hook();
@@ -478,7 +478,7 @@ 
 			}
 
 			// overwrite value from settings
-			$www_root = rtrim($request->getSchemeAndHttpHost() . $request->getBaseUrl(), '/') . '/';
+			$www_root = rtrim($request->getSchemeAndHttpHost().$request->getBaseUrl(), '/').'/';
 			$config->wwwroot = $www_root;
 			$config->wwwroot_cli_server = $www_root;
 		}
@@ -556,7 +556,7 @@ 
 		ini_set('display_errors', 1);
 		$is_cli = (php_sapi_name() === 'cli');
 
-		$forward = function ($url) use ($is_cli) {
+		$forward = function($url) use ($is_cli) {
 			if ($is_cli) {
 				echo "Open $url in your browser to continue.";
 				exit;
@@ -576,14 +576,14 @@ 
 		}
 		
 		$site_url = _elgg_config()->url;
-		$site_host = parse_url($site_url, PHP_URL_HOST) . '/';
+		$site_host = parse_url($site_url, PHP_URL_HOST).'/';
 
 		// turn any full in-site URLs into absolute paths
 		$forward_url = get_input('forward', '/admin', false);
 		$forward_url = str_replace([$site_url, $site_host], '/', $forward_url);
 
 		if (strpos($forward_url, '/') !== 0) {
-			$forward_url = '/' . $forward_url;
+			$forward_url = '/'.$forward_url;
 		}
 
 		if ($is_cli || (get_input('upgrade') == 'upgrade')) {
@@ -605,7 +605,7 @@ 
 			}
 		} else {
 			$rewriteTester = new \ElggRewriteTester();
-			$url = elgg_get_site_url() . "__testing_rewrite?__testing_rewrite=1";
+			$url = elgg_get_site_url()."__testing_rewrite?__testing_rewrite=1";
 			if (!$rewriteTester->runRewriteTest($url)) {
 				// see if there is a problem accessing the site at all
 				// due to ip restrictions for example
@@ -792,9 +792,9 @@ 
 	 * @access private
 	 */
 	public function handleErrors($errno, $errmsg, $filename, $linenum, $vars) {
-		$error = date("Y-m-d H:i:s (T)") . ": \"$errmsg\" in file $filename (line $linenum)";
+		$error = date("Y-m-d H:i:s (T)").": \"$errmsg\" in file $filename (line $linenum)";
 
-		$log = function ($message, $level) {
+		$log = function($message, $level) {
 			if (self::$core_loaded) {
 				return elgg_log($message, $level);
 			}
@@ -850,7 +850,7 @@ 
 	 * @deprecated
 	 */
 	public function loadSettings() {
-		trigger_error(__METHOD__ . ' is no longer needed and will be removed.');
+		trigger_error(__METHOD__.' is no longer needed and will be removed.');
 	}
 
 	/**

engine/classes/Elgg/Application/CacheHandler.php

Doc Comments -1 removed lines

@@ -74,7 +74,6 @@
 	/**
 	 * Handle a request for a cached view
 	 *
-	 * @param array $path URL path
 	 * @return Response (unprepared)
 	 */
 	public function handleRequest(Request $request) {

Spacing +4 added lines, -4 removed lines

@@ -116,7 +116,7 @@ 
 				return $this->send403();
 			}
 
-			$etag = '"' . md5($content) . '"';
+			$etag = '"'.md5($content).'"';
 			$this->setRevalidateHeaders($etag, $response);
 			if ($this->is304($etag)) {
 				return Response::create()->setNotModified();
@@ -131,7 +131,7 @@ 
 		}
 
 		// trust the client but check for an existing cache file
-		$filename = $config->cacheroot . "views_simplecache/$ts/$viewtype/$view";
+		$filename = $config->cacheroot."views_simplecache/$ts/$viewtype/$view";
 		if (file_exists($filename)) {
 			$this->sendCacheHeaders($etag, $response);
 			return BinaryFileResponse::create($filename, 200, $response->headers->all());
@@ -150,7 +150,7 @@ 
 
 		$lastcache = (int) $config->lastcache;
 
-		$filename = $config->cacheroot . "views_simplecache/$lastcache/$viewtype/$view";
+		$filename = $config->cacheroot."views_simplecache/$lastcache/$viewtype/$view";
 
 		if ($lastcache == $ts) {
 			$this->sendCacheHeaders($etag, $response);
@@ -213,7 +213,7 @@ 
 	 */
 	protected function isCacheableView($view) {
 		if (preg_match('~^languages/(.*)\.js$~', $view, $m)) {
-			return in_array($m[1],  _elgg_services()->translator->getAllLanguageCodes());
+			return in_array($m[1], _elgg_services()->translator->getAllLanguageCodes());
 		}
 		return _elgg_services()->views->isCacheableView($view);
 	}

engine/classes/Elgg/Database/ConfigTable.php

Doc Comments +1 added lines, -1 removed lines

@@ -129,7 +129,7 @@
 	 *
 	 * @param string $name The name of the config value
 	 *
-	 * @return mixed|null
+	 * @return string|boolean
 	 */
 	function get($name) {
 		$sql = "

engine/lib/elgglib.php

Doc Comments +11 added lines, -11 removed lines

@@ -249,7 +249,7 @@ 
  *
  * @param string $location 'head' or 'footer'
  *
- * @return array
+ * @return string[]
  * @since 1.8.0
  */
 function elgg_get_loaded_js($location = 'head') {
@@ -300,7 +300,7 @@ 
 /**
  * Get the loaded CSS URLs
  *
- * @return array
+ * @return string[]
  * @since 1.8.0
  */
 function elgg_get_loaded_css() {
@@ -355,7 +355,7 @@ 
  * @param string $type     Type of file: js or css
  * @param string $location Page location
  *
- * @return array
+ * @return string[]
  * @since 1.8.0
  */
 function elgg_get_loaded_external_files($type, $location) {
@@ -370,7 +370,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.
  */
@@ -438,7 +438,7 @@ 
 /**
  * Display a system message on next page load.
  *
- * @param string|array $message Message or messages to add
+ * @param string $message Message or messages to add
  *
  * @return bool
  */
@@ -635,7 +635,7 @@ 
  * @param string $object_type The object type
  * @param string $object      The object involved in the event
  *
- * @return true
+ * @return boolean
  *
  * @see elgg_trigger_before_event
  */
@@ -816,7 +816,7 @@ 
  * @param string $hook Hook name
  * @param string $type Hook type
  *
- * @return array
+ * @return callable[]
  *
  * @since 2.0.0
  */
@@ -830,7 +830,7 @@ 
  * @param string $event Event name
  * @param string $type  Object type
  *
- * @return array
+ * @return callable[]
  *
  * @since 2.0.0
  */
@@ -880,7 +880,7 @@ 
  * A {@elgg_plugin_hook debug log} is called.  If a handler returns
  * false, it will stop the default logging method.
  *
- * @param mixed $value     The value
+ * @param string $value     The value
  * @param bool  $to_screen Display to screen?
  * @return void
  * @since 1.7.0
@@ -1222,7 +1222,7 @@ 
  * Extract class names from an array with key "class", optionally merging into a preexisting set.
  *
  * @param array           $array    Source array
- * @param string|string[] $existing Existing name(s)
+ * @param string[] $existing Existing name(s)
  * @return string[]
  *
  * @since 2.3.0
@@ -1787,7 +1787,7 @@ 
  * @param array  $params empty
  *
  * @elgg_plugin_hook unit_tests system
- * @return array
+ * @return string[]
  * @access private
  */
 function _elgg_api_test($hook, $type, $value, $params) {

Spacing +15 added lines, -15 removed lines

@@ -379,16 +379,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);
@@ -418,7 +418,7 @@ 
 	$path = rtrim($path, " \n\t\0\x0B/");
 
 	if ($append_slash) {
-		$path = $path . '/';
+		$path = $path.'/';
 	}
 
 	return $path;
@@ -951,7 +951,7 @@ 
 	$query = isset($parts['query']) ? "?{$parts['query']}" : '';
 	$fragment = isset($parts['fragment']) ? "#{$parts['fragment']}" : '';
 
-	$string = $scheme . $host . $port . $path . $query . $fragment;
+	$string = $scheme.$host.$port.$path.$query.$fragment;
 
 	if ($html_encode) {
 		return htmlspecialchars($string, ENT_QUOTES, 'UTF-8', false);
@@ -1360,7 +1360,7 @@ 
  */
 function _elgg_normalize_plural_options_array($options, $singulars) {
 	foreach ($singulars as $singular) {
-		$plural = $singular . 's';
+		$plural = $singular.'s';
 
 		if (array_key_exists($singular, $options)) {
 			if ($options[$singular] === ELGG_ENTITIES_ANY_VALUE) {
@@ -1408,7 +1408,7 @@ 
 		// demoted to NOTICE from DEBUG so javascript is not corrupted
 		elgg_log("Page {$uri} generated in $time seconds", 'INFO');
 	} catch (Exception $e) {
-		$message = 'Error: ' . get_class($e) . ' thrown within the shutdown handler. ';
+		$message = 'Error: '.get_class($e).' thrown within the shutdown handler. ';
 		$message .= "Message: '{$e->getMessage()}' in file {$e->getFile()} (line {$e->getLine()})";
 		error_log($message);
 		error_log("Exception trace stack: {$e->getTraceAsString()}");
@@ -1444,7 +1444,7 @@ 
 			$view = implode('/', array_slice($segments, 1));
 		} else {
 			// form views start with "forms", not "form"
-			$view = 'forms/' . implode('/', array_slice($segments, 1));
+			$view = 'forms/'.implode('/', array_slice($segments, 1));
 		}
 
 		$ajax_api = _elgg_services()->ajax;
@@ -1510,7 +1510,7 @@ 
 function _elgg_favicon_page_handler($segments) {
 	header("HTTP/1.1 404 Not Found", true, 404);
 
-	header('Expires: ' . gmdate('D, d M Y H:i:s \G\M\T', strtotime("+1 week")), true);
+	header('Expires: '.gmdate('D, d M Y H:i:s \G\M\T', strtotime("+1 week")), true);
 	header("Pragma: public", true);
 	header("Cache-Control: public", true);
 
@@ -1540,7 +1540,7 @@ 
 		$return = str_replace(' desc', ' asc', $order_by);
 	} else {
 		// no order specified, so default to desc since mysql defaults to asc
-		$return = $order_by . ' desc';
+		$return = $order_by.' desc';
 	}
 
 	return $return;
@@ -1791,10 +1791,10 @@ 
  * @access private
  */
 function _elgg_api_test($hook, $type, $value, $params) {
-	$value[] = Paths::elgg() . 'engine/tests/ElggTravisInstallTest.php';
-	$value[] = Paths::elgg() . 'engine/tests/ElggCoreHelpersTest.php';
-	$value[] = Paths::elgg() . 'engine/tests/ElggCoreRegressionBugsTest.php';
-	$value[] = Paths::elgg() . 'engine/tests/ElggBatchTest.php';
+	$value[] = Paths::elgg().'engine/tests/ElggTravisInstallTest.php';
+	$value[] = Paths::elgg().'engine/tests/ElggCoreHelpersTest.php';
+	$value[] = Paths::elgg().'engine/tests/ElggCoreRegressionBugsTest.php';
+	$value[] = Paths::elgg().'engine/tests/ElggBatchTest.php';
 	return $value;
 }
 
@@ -1802,7 +1802,7 @@ 
  * @see \Elgg\Application::loadCore Do not do work here. Just register for events.
  */
 return function(\Elgg\EventsService $events, \Elgg\HooksRegistrationService $hooks) {
-	$events->registerHandler('cache:flush', 'system', function () {
+	$events->registerHandler('cache:flush', 'system', function() {
 		_elgg_services()->boot->invalidateCache();
 	});