extending、changelogs 同步完成

monkenWu · monkenWu · commit 4bc010b1f67d · 2021-11-14T14:21:04.000+08:00
diff --git a/source/changelogs/index.rst b/source/changelogs/index.rst
@@ -10,25 +10,28 @@ Version |version|
 See all the changes.
 
 .. toctree::
-        :titlesonly:
+    :titlesonly:
 
-        v4.1.2
-        v4.1.1
-        v4.1.0
-        v4.0.5
-        v4.0.4
-        v4.0.3
-        v4.0.0
-        v4.0.0-rc.4
-        v4.0.0-rc.3
-        v4.0.0-rc.2
-        v4.0.0-rc.1
-        v4.0.0-beta.4
-        v4.0.0-beta.3
-        v4.0.0-beta.2
-        v4.0.0-beta.1
-        v4.0.0-alpha.5
-        v4.0.0-alpha.4
-        v4.0.0-alpha.3
-        v4.0.0-alpha.2
-        v4.0.0-alpha.1
+    v4.1.5
+    v4.1.4
+    v4.1.3
+    v4.1.2
+    v4.1.1
+    v4.1.0
+    v4.0.5
+    v4.0.4
+    v4.0.3
+    v4.0.0
+    v4.0.0-rc.4
+    v4.0.0-rc.3
+    v4.0.0-rc.2
+    v4.0.0-rc.1
+    v4.0.0-beta.4
+    v4.0.0-beta.3
+    v4.0.0-beta.2
+    v4.0.0-beta.1
+    v4.0.0-alpha.5
+    v4.0.0-alpha.4
+    v4.0.0-alpha.3
+    v4.0.0-alpha.2
+    v4.0.0-alpha.1
diff --git a/source/changelogs/v4.1.3.rst b/source/changelogs/v4.1.3.rst
@@ -0,0 +1,25 @@
+Version 4.1.3
+=============
+
+Release Date: June 6, 2021
+
+**4.1.3 release of CodeIgniter4**
+
+Enhancements:
+
+- New functions in the File Helper: ``directory_mirror()`` and ``same_file()``
+- Implemented NexusPHP's ``Tachycardia`` for slow test identification
+- Added a new ``$ttl`` option to ``Cache`` config for future use
+
+Changes:
+
+- Added MySQL 8.0 to the test matrix
+- Improved environment detection from ``$_SERVER``
+- Numerous sweeping code improvements via Rector and analysis
+
+Bugs Fixed:
+
+- Fixed a bug where ``CURLRequest`` would try to use a project URI instead of its base
+- Fixed a bug where CLI mode was not detected under ``cgi-fcgi``
+- Fixed a logic bug in Cookie construction
+- Fixed numerous issues in SQLite3's ``Forge`` class related to an incorrect attribute name
diff --git a/source/changelogs/v4.1.4.rst b/source/changelogs/v4.1.4.rst
@@ -0,0 +1,54 @@
+Version 4.1.4
+=============
+
+Release Date: September 6, 2021
+
+**4.1.4 release of CodeIgniter4**
+
+This release focuses on code style. All changes (except those noted below) are cosmetic to bring the code in line with the new
+`CodeIgniter Coding Standard <https://github.com/CodeIgniter/coding-standard>`_ (based on PSR-12).
+
+Breaking Changes:
+
+- The following methods were changed from "public" to "protected" to match their parent class methods and better align with their uses:
+
+    * ``CodeIgniter\Database\MySQLi\Connection::execute()``
+    * ``CodeIgniter\Database\MySQLi\Connection::_fieldData()``
+    * ``CodeIgniter\Database\MySQLi\Connection::_indexData()``
+    * ``CodeIgniter\Database\MySQLi\Connection::_foreignKeyData()``
+    * ``CodeIgniter\Database\Postgre\Builder::_like_statement()``
+    * ``CodeIgniter\Database\Postgre\Connection::execute()``
+    * ``CodeIgniter\Database\Postgre\Connection::_fieldData()``
+    * ``CodeIgniter\Database\Postgre\Connection::_indexData()``
+    * ``CodeIgniter\Database\Postgre\Connection::_foreignKeyData()``
+    * ``CodeIgniter\Database\SQLSRV\Connection::execute()``
+    * ``CodeIgniter\Database\SQLSRV\Connection::_fieldData()``
+    * ``CodeIgniter\Database\SQLSRV\Connection::_indexData()``
+    * ``CodeIgniter\Database\SQLSRV\Connection::_foreignKeyData()``
+    * ``CodeIgniter\Database\SQLite3\Connection::execute()``
+    * ``CodeIgniter\Database\SQLite3\Connection::_fieldData()``
+    * ``CodeIgniter\Database\SQLite3\Connection::_indexData()``
+    * ``CodeIgniter\Database\SQLite3\Connection::_foreignKeyData()``
+    * ``CodeIgniter\Images\Handlers\GDHandler::_flatten()``
+    * ``CodeIgniter\Images\Handlers\GDHandler::_flip()``
+    * ``CodeIgniter\Images\Handlers\ImageMagickHandler::_flatten()``
+    * ``CodeIgniter\Images\Handlers\ImageMagickHandler::_flip()``
+    * ``CodeIgniter\Test\Mock\MockIncomingRequest::detectURI()``
+    * ``CodeIgniter\Test\Mock\MockSecurity.php::sendCookie()``
+
+- To be compatible with the strict inheritance checks of PHP 8.1, the following method signatures were added return types to match their parents' signatures whenever possible:
+
+    * ``CodeIgniter\Cookie\Cookie::offsetExists()``
+    * ``CodeIgniter\Cookie\Cookie::offsetSet()``
+    * ``CodeIgniter\Cookie\Cookie::offsetUnset()``
+    * ``CodeIgniter\Cookie\CookieStore::getIterator()``
+    * ``CodeIgniter\I18n\Time::__wakeup()``
+    * ``CodeIgniter\Test\Filters\CITestStreamFilter::filter()``
+
+- Related to the strict inheritance checks of PHP 8.1, the following session handlers implementing ``SessionHandlerInterface`` have their public methods modified to match the interface:
+
+    * ``CodeIgniter\Session\Handlers\ArrayHandler``
+    * ``CodeIgniter\Session\Handlers\DatabaseHandler``
+    * ``CodeIgniter\Session\Handlers\FileHandler``
+    * ``CodeIgniter\Session\Handlers\MemcachedHandler``
+    * ``CodeIgniter\Session\Handlers\RedisHandler``
diff --git a/source/changelogs/v4.1.5.rst b/source/changelogs/v4.1.5.rst
@@ -0,0 +1,35 @@
+Version 4.1.5
+#############
+
+Release Date: November 8, 2021
+
+**4.1.5 release of CodeIgniter4**
+
+.. contents::
+    :local:
+    :depth: 1
+
+BREAKING
+========
+
+- Fixed `a bug <https://github.com/codeigniter4/CodeIgniter4/issues/2913>`_ on CSRF protection. Now CSRF protection works on PUT/PATCH/DELETE requests when CSRF filter is applied. If you use such requests, you need to send CSRF token.
+- In the previous version, if you didn't provide your own headers, ``CURLRequest`` would send the request-headers from the browser, due to a bug. As of this version, it does not send them.
+- Fixed ``BaseBuilder::insertBatch()`` return value for ``testMode``. Now it returns SQL string array instead of a number of affected rows. This change was made because of maintaining compatibility between returning types for batch methods. Now the returned data type for ``BaseBuilder::insertBatch()`` is the same as the `updateBatch()` method.
+- Major optimizations have been made to the way data is processed in ``BaseBuilder::insertBatch()`` and ``BaseBuilder::updateBatch()`` methods. This resulted in reduced memory usage and faster query processing. As a trade-off, the result generated by the ``$query->getOriginalQuery()`` method was changed. It no longer returns the query with the binded parameters, but the actual query that was run.
+
+Enhancements
+============
+
+- Added Cache config for reserved characters
+- The ``addForeignKey`` function of the ``Forge`` class can now define composite foreign keys in an array
+- The ``dropKey`` function of the ``Forge`` class can remove key
+
+Changes
+=======
+
+- Always escape identifiers in the ``set``, ``setUpdateBatch``, and ``insertBatch`` functions in ``BaseBuilder``.
+
+Deprecations
+============
+
+- Deprecated ``CodeIgniter\\Cache\\Handlers\\BaseHandler::RESERVED_CHARACTERS`` in favor of the new config property
diff --git a/source/extending/authentication.rst b/source/extending/authentication.rst
@@ -7,4 +7,14 @@ CodeIgniter 刻意不提供內建的認證或授權相關類別，因為已經
 ===============
 
 * 處理登入以及登出的操作應該在成功時觸發相應的 ``login`` 與 ``logout`` 事件。
-* 定義 "目前使用者" 的模組應該定義函數 ``user_id()`` 來回傳使用者的唯一識別符號，對於 "目前沒有使用者" 登入應該回傳 ``null`` 。
+* 定義 "目前使用者" 的模組應該定義函數 ``user_id()`` 來回傳使用者的唯一識別符號，對於 "目前沒有使用者" 登入應該回傳 ``null`` 。
+
+符合上述建議的模組可以透過在 **composer.json** 中加入以下內容來表示相容性。
+
+::
+
+    "provide": {
+        "codeigniter4/authentication-implementation": "1.0"
+    },
+
+你可以在 `Packagist <https://packagist.org/providers/codeigniter4/authentication-implementation>`_ 上查閱提供上述實作模組列表。
diff --git a/source/extending/basecontroller.rst b/source/extending/basecontroller.rst
@@ -6,16 +6,16 @@ CodeIgniter 的核心控制器不應該被改變，但是在 **app/Controllers/B
 
 ::
 
-	<?php
+    <?php
 
-	namespace App\Controllers;
+    namespace App\Controllers;
 
-	use CodeIgniter\Controller;
+    use CodeIgniter\Controller;
 
-	class Home extends BaseController
-	{
-		// ...
-	}
+    class Home extends BaseController
+    {
+        // ...
+    }
 
 
 預載組件
@@ -25,19 +25,19 @@ CodeIgniter 的核心控制器不應該被改變，但是在 **app/Controllers/B
 
 ::
 
-	protected $helpers = ['html', 'text'];
+    protected $helpers = ['html', 'text'];
 
 任何需要載入的組件或需要處理的資料都應該加入到建構函數 ``initController()`` 中。例如：你的專案大量使用到會談程式庫，你可以會需要在這裡啟動它：
 
 ::
 
-	public function initController(...)
-	{
-		// 請不要編輯這行
-		parent::initController($request, $response, $logger);
-		
-		$this->session = \Config\Services::session();
-	}
+    public function initController(...)
+    {
+        // 請不要編輯這行
+        parent::initController($request, $response, $logger);
+        
+        $this->session = \Config\Services::session();
+    }
 
 新增方法
 ==================
@@ -53,7 +53,7 @@ CodeIgniter 的核心控制器不應該被改變，但是在 **app/Controllers/B
 
 ::
 
-	class Home extends \CodeIgniter\Controller
-	{
-	
-	}
+    class Home extends \CodeIgniter\Controller
+    {
+    
+    }
diff --git a/source/extending/contributing.rst b/source/extending/contributing.rst
@@ -2,53 +2,6 @@
 為 CodeIgniter 貢獻
 ###########################
 
-CodeIgniter 是一個社群促使開發的專案，接受來自社群的程式碼與使用手冊的貢獻。這些貢獻以發出問題或 `拉取請求 <https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests>`_ 的形式在 GitHub 上的 `CodeIgniter4 儲存庫 <https://github.com/codeigniter4/CodeIgniter4>`_ 中提交。
+CodeIgniter 是一個社群驅動開發的專案，接受來自社群的程式碼與使用手冊的貢獻。這些貢獻以發出問題或 `拉取請求 <https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests>`_ 的形式在 GitHub 上的 `CodeIgniter4 儲存庫 <https://github.com/codeigniter4/CodeIgniter4>`_ 中提交。
 
-發出問題是一種快速指出 BUG 的方法，如果你在 CodeIgniter 或 使用手冊發現了錯誤，那麼請你先檢查幾件事：
-
-- 是否從未有人針對這個錯誤發出問題
-- 這個問題是否已經被修復了（查看分支或尋找已經被關閉的問題）
-- 是不是真的有很明顯的問題需要你去解決？
-
-問題回報是非常用的方法，但更好的方案是透過分叉主儲存庫並提交修改到你自己的副本中，再回到 GitHub 發送拉取請求（這需要你使用 Git 版本控制系統）。
-
-詳情請見儲存庫中的 `貢獻至 CodeIgniter4 <https://github.com/codeigniter4/CodeIgniter4/tree/develop/contributing>`_　部分。
-
-*******
-支援
-*******
-
-請注意， GitHub 儲存庫並不是回答一般問題的地方！如果你在使用某項功能遇到了非錯誤的困難，你可以：
-
-- 在 `論壇 <http://forum.codeigniter.com/>`_ 上創建主題
-- 在 `Slack <https://codeigniterchat.slack.com/>`_ 提出你的問題
-
-如果你確定你的使用方法是否正確，或是你真的發現了 BUG ，煩請先至論壇上詢問。
-
-********
-安全性
-********
-
-你是否發現了 CodeIgniter 中的安全性問題？
-
-請 *不要* 公開它們，請你發送電子郵件至 security@codeigniter.com ，或在 `HackerOne <https://hackerone.com/codeigniter>`_ 上的頁面傳送問題報告。
-
-如果你真的發現了嚴重的漏洞，我們很願意將這個功勞歸功於你，並紀載至 `ChangeLog <../changelogs/index.html>`_ 上。
-
-****************************
-如何撰寫好的問題回報
-****************************
-
-使用一個具有描述性的主題，例如：解釋器程式庫無法正確解釋逗號（ parser library chokes on commas ），而不是一個模糊的標題：你的程式碼壞掉了（ your code broke ）。
-
-在一個問題回報中只提出一個問題。
-
-請列出你所知道發生問題的版本（例如： 4.0.1 ）或是組件為何（例如：解釋器）。
-
-解釋一下你預期會有什麼結果，但卻發生了什麼問題。如果有的話也可以提供：錯誤訊息以及堆疊追蹤的資訊。
-
-如果簡短的程式碼塊有助於你解釋錯誤的話，也請附上。你可以使用 pastebin 或 Dropbox 的工具，來幫助你處理較長的程式碼與螢幕截圖——不要將它們直接置於問題報告中。
-
-如果你知道如何解決這個問題，你可以在自己的分叉與分支中這麼做，並且提交一個拉取請求給主儲存庫，而上面的問題報告也請附在拉取請求中。
-
-如果你的問題報告能描述出重現問題的方法，那就太好了！如果你能包含重現問題的單元測試，那就更好了！因為這樣可以幫助修復問題人員可以有更明確的目標。
+如果你想要做出貢獻，請查閱我們儲存庫中的 `貢獻 CodeIgniter4 <https://github.com/codeigniter4/CodeIgniter4/tree/develop/contributing>`_ 。
diff --git a/source/extending/core_classes.rst b/source/extending/core_classes.rst
@@ -57,19 +57,19 @@
     }
 
 
-然後，你得修改 ``routes`` 服務，改成載入你的類別：
+然後，你得修改在 **app/Config/Services.php** 的 ``routes`` 服務，改成載入你的類別：
 
 ::
 
-	public static function routes(bool $getShared = true)
-	{
-		if ($getShared)
-		{
-			return static::getSharedInstance('routes');
-		}
+    public static function routes(bool $getShared = true)
+    {
+        if ($getShared)
+        {
+            return static::getSharedInstance('routes');
+        }
 
-		return new RouteCollection(static::locator(), config('Modules'));
-	}
+        return new RouteCollection(static::locator(), config('Modules'));
+    }
 
 擴充核心系統類別
 ======================
@@ -82,29 +82,35 @@
 
 ::
 
-    <?php namespace App\Libraries;
+    <?php
+
+    namespace App\Libraries;
 
     use CodeIgniter\Router\RouteCollection;
 
     class RouteCollection extends RouteCollection
     {
-
+        // ...
     }
 
 如果你需要在你的類別中使用建構函數，請確定你同時運作了父類別的擴充函數：
 
 ::
 
-    <?php namespace App\Libraries;
+    <?php
+
+    namespace App\Libraries;
 
     use CodeIgniter\Router\RouteCollection as BaseRouteCollection;
 
     class RouteCollection extends BaseRouteCollection
     {
-         public function __construct()
-         {
-             parent::__construct();
-         }
-     }
+        public function __construct()
+        {
+            parent::__construct();
+
+            // your code here
+        }
+    }
 
 **Tip ：** 在你的類別中，任何與父類別相同的函數都將被使用，而不會使用原生的函數，這就是所謂的方法覆寫，你可以利用這種方式大幅度地修改 CodeIgniter 的核心。
