Merge pull request #1951 from atishamte/system

System typos changes & code cleanup

Author: lonnieezell

system/CLI/BaseCommand.php

@@ -142,6 +142,7 @@ abstract public function run(array $params);
 	 * @param array  $params
 	 *
 	 * @return mixed
+	 * @throws \ReflectionException
 	 */
 	protected function call(string $command, array $params = [])
 	{
@@ -183,6 +184,8 @@ public function __get(string $key)
 		{
 			return $this->$key;
 		}
+
+		return null;
 	}
 
 	//--------------------------------------------------------------------
@@ -192,7 +195,7 @@ public function __get(string $key)
 	 */
 	public function showHelp()
 	{
-		// 4 spaces insted of tab
+		// 4 spaces instead of tab
 		$tab = '   ';
 		CLI::write(lang('CLI.helpDescription'), 'yellow');
 		CLI::write($tab . $this->description);
@@ -236,7 +239,7 @@ public function showHelp()
 	 *
 	 * @return integer
 	 */
-	public function getPad($array, int $pad)
+	public function getPad(array $array, int $pad): int
 	{
 		$max = 0;
 		foreach ($array as $key => $value)

system/CLI/CLI.php

@@ -517,7 +517,7 @@ public static function color(string $text, string $foreground, string $backgroun
 	 * Get the number of characters in string having encoded characters
 	 * and ignores styles set by the color() function
 	 *
-	 * @param string $string
+	 * @param ?string $string
 	 *
 	 * @return integer
 	 */
@@ -594,8 +594,8 @@ public static function getHeight(int $default = 32): int
 	 * Displays a progress bar on the CLI. You must call it repeatedly
 	 * to update it. Set $thisStep = false to erase the progress bar.
 	 *
-	 * @param integer $thisStep
-	 * @param integer $totalSteps
+	 * @param integer|boolean   $thisStep
+	 * @param integer           $totalSteps
 	 */
 	public static function showProgress($thisStep = 1, int $totalSteps = 10)
 	{

system/CLI/CommandRunner.php

@@ -197,7 +197,7 @@ protected function createCommandList()
 	 *
 	 * @return array
 	 */
-	public function getCommands()
+	public function getCommands(): array
 	{
 		return $this->commands;
 	}

system/CLI/Console.php

@@ -73,7 +73,7 @@ public function __construct(CodeIgniter $app)
 	 * @param boolean $useSafeOutput
 	 *
 	 * @return \CodeIgniter\HTTP\RequestInterface|\CodeIgniter\HTTP\Response|\CodeIgniter\HTTP\ResponseInterface|mixed
-	 * @throws \CodeIgniter\Router\RedirectException
+	 * @throws \Exception
 	 */
 	public function run(bool $useSafeOutput = false)
 	{

system/Cache/Handlers/FileHandler.php

@@ -377,7 +377,7 @@ protected function writeFile($path, $data, $mode = 'wb')
 	 *
 	 * @return boolean
 	 */
-	protected function deleteFiles($path, $del_dir = false, $htdocs = false, $_level = 0)
+	protected function deleteFiles(string $path, bool $del_dir = false, bool $htdocs = false, int $_level = 0): bool
 	{
 		// Trim the trailing slash
 		$path = rtrim($path, '/\\');
@@ -423,7 +423,7 @@ protected function deleteFiles($path, $del_dir = false, $htdocs = false, $_level
 	 *
 	 * @return array|false
 	 */
-	protected function getDirFileInfo($source_dir, $top_level_only = true, $_recursion = false)
+	protected function getDirFileInfo(string $source_dir, bool $top_level_only = true, bool $_recursion = false)
 	{
 		static $_filedata = [];
 		$relative_path    = $source_dir;
@@ -474,45 +474,50 @@ protected function getDirFileInfo($source_dir, $top_level_only = true, $_recursi
 	 *
 	 * @return array|false
 	 */
-	protected function getFileInfo(string $file, array $returned_values = ['name', 'server_path', 'size', 'date'])
+	protected function getFileInfo(string $file, $returned_values = ['name', 'server_path', 'size', 'date'])
 	{
 		if (! is_file($file))
 		{
 			return false;
 		}
 
+		if (is_string($returned_values))
+		{
+			$returned_values = explode(',', $returned_values);
+		}
+
 		foreach ($returned_values as $key)
 		{
 			switch ($key)
 			{
 				case 'name':
-					$fileinfo['name'] = basename($file);
+					$fileInfo['name'] = basename($file);
 					break;
 				case 'server_path':
-					$fileinfo['server_path'] = $file;
+					$fileInfo['server_path'] = $file;
 					break;
 				case 'size':
-					$fileinfo['size'] = filesize($file);
+					$fileInfo['size'] = filesize($file);
 					break;
 				case 'date':
-					$fileinfo['date'] = filemtime($file);
+					$fileInfo['date'] = filemtime($file);
 					break;
 				case 'readable':
-					$fileinfo['readable'] = is_readable($file);
+					$fileInfo['readable'] = is_readable($file);
 					break;
 				case 'writable':
-					$fileinfo['writable'] = is_writable($file);
+					$fileInfo['writable'] = is_writable($file);
 					break;
 				case 'executable':
-					$fileinfo['executable'] = is_executable($file);
+					$fileInfo['executable'] = is_executable($file);
 					break;
 				case 'fileperms':
-					$fileinfo['fileperms'] = fileperms($file);
+					$fileInfo['fileperms'] = fileperms($file);
 					break;
 			}
 		}
 
-		return $fileinfo;
+		return $fileInfo;
 	}
 
 	//--------------------------------------------------------------------

system/Cache/Handlers/MemcachedHandler.php

@@ -38,6 +38,7 @@
 namespace CodeIgniter\Cache\Handlers;
 
 use CodeIgniter\Cache\CacheInterface;
+use CodeIgniter\Exceptions\CriticalError;
 
 /**
  * Mamcached cache handler
@@ -133,7 +134,7 @@ public function initialize()
 		}
 		elseif ($this->memcached instanceof \Memcache)
 		{
-			// Third parameter is persistance and defaults to TRUE.
+			// Third parameter is persistence and defaults to TRUE.
 			$this->memcached->addServer(
 					$this->config['host'], $this->config['port'], true, $this->config['weight']
 			);

system/Cache/Handlers/WincacheHandler.php

@@ -215,7 +215,7 @@ public function getCacheInfo()
 	 * Returns detailed information about the specific item in the cache.
 	 *
 	 * @codeCoverageIgnore
-	 * @param              string $key Cache item name.
+	 * @param   string  $key Cache item name.
 	 *
 	 * @return mixed
 	 */

system/CodeIgniter.php

@@ -37,6 +37,7 @@
 
 namespace CodeIgniter;
 
+use Closure;
 use CodeIgniter\Filters\Exceptions\FilterException;
 use CodeIgniter\HTTP\DownloadResponse;
 use CodeIgniter\HTTP\RedirectResponse;
@@ -51,6 +52,7 @@
 use CodeIgniter\HTTP\CLIRequest;
 use CodeIgniter\Router\RouteCollectionInterface;
 use CodeIgniter\Exceptions\PageNotFoundException;
+use Exception;
 
 /**
  * This class is the core of the framework, and will analyse the
@@ -281,7 +283,7 @@ public function useSafeOutput(bool $safe = true)
 	 * @param boolean                                      $returnResponse
 	 *
 	 * @return \CodeIgniter\HTTP\RequestInterface|\CodeIgniter\HTTP\Response|\CodeIgniter\HTTP\ResponseInterface|mixed
-	 * @throws \CodeIgniter\Router\RedirectException
+	 * @throws \CodeIgniter\Router\Exceptions\RedirectException
 	 */
 	protected function handleRequest(RouteCollectionInterface $routes = null, $cacheConfig, bool $returnResponse = false)
 	{
@@ -545,7 +547,7 @@ public function displayCache($config)
 			$cachedResponse = unserialize($cachedResponse);
 			if (! is_array($cachedResponse) || ! isset($cachedResponse['output']) || ! isset($cachedResponse['headers']))
 			{
-				throw new \Exception('Error unserializing page cache');
+				throw new Exception('Error unserializing page cache');
 			}
 
 			$headers = $cachedResponse['headers'];
@@ -687,7 +689,7 @@ public function displayPerformanceMetrics(string $output): string
 	 *                                         of the config file.
 	 *
 	 * @return string
-	 * @throws \CodeIgniter\Router\RedirectException
+	 * @throws \CodeIgniter\Router\Exceptions\RedirectException
 	 */
 	protected function tryToRouteIt(RouteCollectionInterface $routes = null)
 	{
@@ -849,7 +851,7 @@ protected function display404errors(PageNotFoundException $e)
 		// Is there a 404 Override available?
 		if ($override = $this->router->get404Override())
 		{
-			if ($override instanceof \Closure)
+			if ($override instanceof Closure)
 			{
 				echo $override($e->getMessage());
 			}

system/Commands/Database/MigrateLatest.php

@@ -144,7 +144,7 @@ public function run(array $params = [])
 	 * @param  array $params
 	 * @return boolean
 	 */
-	private function isAllNamespace(array $params)
+	private function isAllNamespace(array $params): bool
 	{
 		if (array_search('-all', $params) !== false)
 		{

system/Commands/Database/MigrateRollback.php

@@ -164,7 +164,7 @@ public function run(array $params = [])
 	 * @param  array $params
 	 * @return boolean
 	 */
-	private function isAllNamespace(array $params)
+	private function isAllNamespace(array $params): bool
 	{
 		if (array_search('-all', $params) !== false)
 		{