Merge remote-tracking branch 'upstream/develop' into migration-union

app/Controllers/BaseController.php

@@ -1,4 +1,8 @@
-<?php namespace App\Controllers;
+<?php
+
+namespace App\Controllers;
+
+use CodeIgniter\Controller;
 
 /**
  * Class BaseController
@@ -7,14 +11,11 @@
  * and performing functions that are needed by all your controllers.
  * Extend this class in any new controllers:
  *     class Home extends BaseController
- * 
+ *
  * For security be sure to declare any new methods as protected or private.
- * 
+ *
  * @package CodeIgniter
  */
-
-use CodeIgniter\Controller;
-
 class BaseController extends Controller
 {
 
@@ -35,7 +36,6 @@ public function initController(\CodeIgniter\HTTP\RequestInterface $request, \Cod
 	{
 		// Do Not Edit This Line
 		parent::initController($request, $response, $logger);
-
 		//--------------------------------------------------------------------
 		// Preload any models, libraries, etc, here.
 		//--------------------------------------------------------------------

system/API/ResponseTrait.php

@@ -65,6 +65,7 @@ trait ResponseTrait
 	protected $codes = [
 		'created'                   => 201,
 		'deleted'                   => 200,
+		'no_content'                => 204,
 		'invalid_request'           => 400,
 		'unsupported_response_type' => 400,
 		'invalid_scope'             => 400,
@@ -190,6 +191,21 @@ public function respondDeleted($data = null, string $message = '')
 
 	//--------------------------------------------------------------------
 
+	/**
+	 * Used after a command has been successfully executed but there is no
+	 * meaningful reply to send back to the client.
+	 *
+	 * @param string $message Message.
+	 *
+	 * @return mixed
+	 */
+	public function respondNoContent(string $message = 'No Content')
+	{
+		return $this->respond(null, $this->codes['no_content'], $message);
+	}
+
+	//--------------------------------------------------------------------
+
 	/**
 	 * Used when the client is either didn't send authorization information,
 	 * or had bad authorization credentials. User is encouraged to try again

system/Cache/Handlers/RedisHandler.php

@@ -246,7 +246,7 @@ public function delete(string $key)
 	{
 		$key = $this->prefix . $key;
 
-		return ($this->redis->delete($key) === 1);
+		return ($this->redis->del($key) === 1);
 	}
 
 	//--------------------------------------------------------------------

system/Database/BaseBuilder.php

@@ -1293,7 +1293,7 @@ public function orderBy(string $orderBy, string $direction = '', bool $escape =
 	 *
 	 * @return BaseBuilder
 	 */
-	public function limit(int $value = null, int $offset = 0)
+	public function limit(int $value = null, ?int $offset = 0)
 	{
 		if (! is_null($value))
 		{

system/HTTP/DownloadResponse.php

@@ -138,6 +138,19 @@ public function setFilePath(string $filepath)
 		$this->file = new File($filepath, true);
 	}
 
+	/**
+	 * set name for the download.
+	 *
+	 * @param string $filename
+	 *
+	 * @return $this
+	 */
+	public function setFileName(string $filename)
+	{
+		$this->filename = $filename;
+		return $this;
+	}
+
 	/**
 	 * get content length.
 	 *

system/HTTP/Files/UploadedFile.php

@@ -356,9 +356,9 @@ public function getExtension(): string
 	 *
 	 * @return string|null
 	 */
-	public function guessExtension(): ?string
+	public function guessExtension(): string
 	{
-		return Mimes::guessExtensionFromType($this->getClientMimeType(), $this->getClientExtension());
+		return Mimes::guessExtensionFromType($this->getClientMimeType(), $this->getClientExtension()) ?? $this->getClientExtension();
 	}
 
 	//--------------------------------------------------------------------

tests/system/API/ResponseTraitTest.php

@@ -278,6 +278,15 @@ public function testForbidden()
 		$this->assertEquals($this->formatter->format($expected), $this->response->getBody());
 	}
 
+	public function testNoContent()
+	{
+		$controller = $this->makeController();
+		$controller->respondNoContent('');
+
+		$this->assertEquals('No Content', $this->response->getReason());
+		$this->assertEquals(204, $this->response->getStatusCode());
+	}
+
 	public function testNotFound()
 	{
 		$controller = $this->makeController();

tests/system/HTTP/DownloadResponseTest.php

@@ -95,6 +95,15 @@ public function testSetContentTypeNoCharSet()
 
 		$this->assertEquals('application/octet-stream', $response->getHeaderLine('Content-Type'));
 	}
+
+	public function testSetFileName()
+	{
+		$response = new DownloadResponse('unit-test.txt', true);
+		$response->setFileName('myFile.txt');
+		$response->buildHeaders();
+
+		$this->assertSame('attachment; filename="myFile.txt"; filename*=UTF-8\'\'myFile.txt', $response->getHeaderLine('Content-Disposition'));
+	}
 
 	public function testNoCache()
 	{

user_guide_src/source/dbmgmt/migration.rst

@@ -145,7 +145,7 @@ configuration file::
 	];
 
 This will look for any migrations located at both **APPPATH/Database/Migrations** and
-**ROOTPATH/Database/Migrations**. This makes it simple to include migrations in your
+**ROOTPATH/MyCompany/Database/Migrations**. This makes it simple to include migrations in your
 re-usable, modular code suites.
 
 *************
@@ -208,9 +208,6 @@ for the version. ::
   > php spark migrate:version
   Version:
 
-  // Sequential
-  > php spark migrate:version 007
-
   // Timestamp
   > php spark migrate:version 20161426211300
 

user_guide_src/source/outgoing/api_responses.rst

@@ -48,6 +48,8 @@ exist for the most common use cases::
     respondCreated($data);
     // Item successfully deleted
     respondDeleted($data);
+    // Command executed by no response required
+    respondNoContent($message);
     // Client isn't authorized
     failUnauthorized($description);
     // Forbidden action
@@ -179,6 +181,19 @@ Class Reference
 	    $user = $userModel->delete($id);
 	    return $this->respondDeleted(['id' => $id]);
 
+.. php:method:: respondNoContent(string $message = 'No Content')
+
+    :param string $message: A custom "reason" message to return.
+    :returns: The value of the Response object's send() method.
+
+    Sets the appropriate status code to use when a command was successfully executed by the server but there is no 
+    meaningful reply to send back to the client, typically 204.
+
+    ::
+
+	    sleep(1);
+	    return $this->respondNoContent();        
+
 .. php:method:: failUnauthorized(string $description = 'Unauthorized'[, string $code=null[, string $message = '']])
 
     :param mixed  $description: The error message to show the user.

user_guide_src/source/outgoing/response.rst

@@ -100,6 +100,10 @@ do the following::
 	// Contents of photo.jpg will be automatically read
 	return $response->download('/path/to/photo.jpg', NULL);
 
+Use the optional ``setFileName()`` method to change the filename as it is sent to the client's browser::
+	
+	return $response->download('awkwardEncryptedFileName.fakeExt')->setFileName('expenses.csv');
+
 .. note:: The response object MUST be returned for the download to be sent to the client. This allows the response
     to be passed through all **after** filters before being sent to the client.