CakePHP 快速指南

CakePHP - 概述

CakePHP 是一個開源 MVC 框架。它使應用程式的開發、部署和維護變得更加容易。 CakePHP 有許多函式庫可以減少大多數常見任務的過載。

CakePHP 的優點

使用 CakePHP 的優點如下 -

• 開源

• MVC 框架

• 模板引擎

• 快取操作

• 搜尋引擎友善的網址

• 輕鬆的 CRUD（建立、讀取、更新、刪除）資料庫互動。

• 圖書館與助理

• 內建驗證

• 在地化

• 電子郵件、CakePHP 快速指南、安全性、會話和請求處理元件

• 查看 AJAX、JavaScript、HTML 表單等的幫助程式

CakePHP 請求週期

下圖描述了 CakePHP 中請求生命週期的工作原理 -

典型的 CakePHP 請求週期從使用者請求應用程式中的頁面或資源開始。在高層，每個請求都會經歷以下步驟 -

• 網頁伺服器重寫規則將請求定向到 webroot / index.php。

• 應用程式的自動載入器和引導檔案已執行。

• 配置的任何調度過濾器都可以處理請求，並且可以選擇產生回應。

• 調度程序根據路由規則選擇適當的控制器和操作。

• 呼叫控制器的操作，控制器與所需的模型和元件互動。

• 控制器將回應建立委託給視圖以產生模型資料的輸出。

• 視圖使用 Helpers 和 Cells 產生回應正文和標頭。

• 回應被傳送回客戶端。

CakePHP - 安裝

本章我們將展示CakePHP 4.0.3的安裝。我們需要安裝的最低 PHP 版本是 PHP 7.3.

在開始安裝cakePHP之前，您需要先安裝PHP 7.3和Composer。

對於Windows用戶，安裝或更新PHP版本> 7.3的WAMP伺服器。

前往 www.wampserver.com/en/download-wampserver-64bits/ 並安裝它。

對於Linux用戶，請參考TutorialsPoint網站，網址為www.tutorialspoint.com/php7/php7_installation_linux.htm來安裝PHP。

安裝 Composer

前往 https://getcomposer.org/download/ 上的 Composer，然後根據您電腦的作業系統 (OS) 點擊“下載”，然後在您的系統上安裝 Composer。將位置新增至 Windows 使用者的 PATH 變數中，以便您可以從任何目錄使用 Composer。

安裝完 Composer 後，現在讓我們開始安裝 CakePHP。

安裝 CakePHP

Windows使用者進入wamp所在資料夾，在www/資料夾中建立一個資料夾cakephp4/.

對於 Linux 用戶，建立資料夾 var/www/html/，然後建立資料夾 cakephp4/.

• cakephp4/ 是我們要安裝 CakePHP 的資料夾。

使用composer執行以下指令 -

composer create-project --prefer-dist cakephp/app:4.0.3 cakephp4

這是命令執行時您應該看到的內容 -

安裝完成後，使用 localhost 在瀏覽器中開啟您的專案。

相同的路徑是http://localhost/cakephp。

CakePHP - 資料夾結構

在這裡，我們將了解 CakePHP 中的資料夾結構和命名約定。讓我們從了解資料夾結構開始。

資料夾結構

看看下面的截圖。它顯示了 CakePHP 的資料夾結構。

下表描述了CakePHP中每個資料夾的作用 -

先生不	資料夾名稱與說明
1	bin bin 資料夾包含 Cake 控制台執行檔。
2	配置 config 資料夾包含 CakePHP 使用的（幾個）設定檔。資料庫連接詳細資訊、引導、核心設定檔等應儲存在此。
3	日誌 logs 資料夾通常包含您的日誌文件，具體取決於您的日誌配置。
4	外掛程式 plugins 資料夾是儲存應用程式使用的插件的位置。
5	資源 各個語言環境資料夾中的國際化文件將儲存在此。例如。 locales/en_US。
6	src src 資料夾將會是你施展魔法的地方。您的應用程式檔案將放置在此處，您將完成大部分應用程式開發。讓我們仔細看看 src 中的資料夾。 控制台 - 包含應用程式的控制台命令和控制台任務。 控制器 - 包含應用程式的控制器及其元件。 模型 - 包含應用程式的表格、實體和行為。 視圖展示類別放置在這裡：儲存格、助理和範本檔案。
7	模板 模板展示文件放置在這裡：元素、錯誤頁面、佈局和視圖模板文件。
8	檢定 tests 資料夾將是您放置應用程式測試案例的位置。
9	tmp tmp資料夾是CakePHP儲存暫存資料的地方。它儲存的實際資料取決於您如何配置 CakePHP，但此資料夾通常用於儲存模型描述，有時也用於儲存會話資訊。
10	供應商 vendor 資料夾是 CakePHP 和其他應用程式依賴項的安裝位置。做出個人承諾不編輯此資料夾中的文件。如果您修改了核心，我們無法幫助您。
11	webroot webroot 目錄是您的應用程式的公開文件根目錄。它包含您希望公開存取的所有文件。

Naming Convention

Naming convention is not something mandatory to be followed, but is a good coding practice and will be very helpful as your project goes big.

CakePHP 快速指南 Convention

The controller class name has to be plural, PascalCased and the name has to end with CakePHP 快速指南. For example, for Students class the name of the controller can be StudentsCakePHP 快速指南. Public methods on CakePHP 快速指南s are often exposed as ‘actions’ accessible through a web browser.

For example, the /users /view maps to the view() method of the UsersCakePHP 快速指南 out of the box. Protected or private methods cannot be accessed with routing.

File and Class CakePHP 快速指南 Convention

Mostly, we have seen that our class name file name is almost the same. This is similar in cakephp.

For example, the class StudentsCakePHP 快速指南 will have the file named as StudentsCakePHP 快速指南.php. The files have to be saved as the module name and in the respective folders in app folder.

Database Conventions

The tables used for CakePHP models, mostly have names plural with underscore.

For example, student_details, student_marks. The field name has an underscore, if it is made up of two words, for example, first_name, last_name.

Model Conventions

For model, the classes are named as per database table, the names are plural, PascalCased and suffixed with Table.

For example, StudentDetailsTable, StudentMarksTable

View Conventions

For view templates, the files are based on controller functions.

For example, if the class StudentDetailsCakePHP 快速指南 has function showAll(), the view template will be named as show_all.php and saved inside template/yrmodule/show_all.php.

CakePHP - Project Configuration

In this chapter, we will understand the Environment CakePHP 快速指南, General Configuration, Database Configuration and Email Configuration in CakePHP.

Configuration CakePHP comes with one configuration file by default, and we can modify it according to our needs. There is one dedicated folder “config” for this purpose. CakePHP comes with different configuration options.

Let us start by understanding the Environment CakePHP 快速指南 in CakePHP.

Environment CakePHP 快速指南

Environment variables make the working of your application on different environments easy. For example, on dev server, test server, staging server and production server environment. For all these environments, you can make use of env() function to read the configuration for the environment you need and build your application.

In your config folder, you will come across config/.env.example. This file has all the variables that will be changed based on your environment. To start with, you can create a file in config folder i.e. config/.env and define those variables and use them. In case you need any additional variables, it can go in that file.

You can read your environment variable using env() function as shown below −

Example

$debug = env('APP_DEBUG', false);

The first one is the name of the environment variable you want and second value is the default value. The default value is used, if there is no value found for the environment variable.

General Configuration

The following table describes the role of various variables and how they affect your CakePHP application.

Sr.No	Variable CakePHP 快速指南 & Description
1	debug Changes CakePHP debugging output. false = Production mode. No error messages, errors, or warnings shown. true = Errors and warnings shown.
2	App.namespace The namespace to find app classes under.
3	App.baseUrl Un-comment this definition, if you don’t plan to use Apache’s mod_rewrite with CakePHP. Don’t forget to remove your .htaccess files too.
4	App.base The base directory the app resides in. If false, this will be auto detected.
5	App.encoding Define what encoding your application uses. This encoding is used to generate the charset in the layout, and encode entities. It should match the encoding values specified for your database.
6	App.webroot The webroot directory.
7	App.wwwRoot The file path to webroot.
8	App.fullBaseUrl The fully qualified domain name (including protocol) to your application’s root.
9	App.imageBaseUrl Web path to the public images directory under webroot.
10	App.cssBaseUrl Web path to the public css directory under webroot.
11	App.jsBaseUrl Web path to the public js directory under webroot.
12	App.paths Configure paths for non-class based resources. Supports the plugins, templates, locales, subkeys, which allow the definition of paths for plugins, view templates and locale files respectively.
13	Security.salt A random string used in hashing. This value is also used as the HMAC salt when doing symmetric encryption.
14	Asset.timestamp Appends a timestamp, which is last modified time of the particular file at the end of asset files URLs (CSS, JavaScript, Image) when using proper helpers. The valid values are − (bool) false - Doesn’t do anything (default). (bool) true - Appends the timestamp, when debug is true. (string) ‘force’ - Always appends the timestamp.

Databases Configuration

Database can be configured in config/app.php and config/app_local.php file. This file contains a default connection with provided parameters, which can be modified as per our choice.

The below snippet shows the default parameters and values, which should be modified as per the requirement.

Config/app_local.php

*/
   'Datasources' => [
      'default' => [
         'host' => 'localhost',
         'username' => 'my_app',
         'password' => 'secret',
         'database' => 'my_app',
         'url' => env('DATABASE_URL', null),
      ],
      /*
         * The test connection is used during the test suite.
      */
      'test' => [
         'host' => 'localhost',
         //'port' => 'non_standard_port_number',
         'username' => 'my_app',
         'password' => 'secret',
         'database' => 'test_myapp',
         //'schema' => 'myapp',
      ],
   ],

Let us understand each parameter in detail in config/app_local.php.

Host	The database server’s hostname (or IP address).
username	Database username
password	Database password.
database	CakePHP 快速指南 of Database.
Port	The TCP port or Unix socket used to connect to the server.

config/app.php

'Datasources' => [
   'default' => [
      'classCakePHP 快速指南' => Connection::class,
      'driver' => Mysql::class,
      'persistent' => false,
      'timezone' => 'UTC',
      //'encoding' => 'utf8mb4',
      'flags' => [],
      'cacheMetadata' => true,
      'log' => false,
      'quoteIdentifiers' => false,
      //'init' => ['SET GLOBAL innodb_stats_on_metadata = 0'],
   ],
]   

Let us understand each parameter in detail in config/app.php.

log

Sr.No	Key & Description
1	classCakePHP 快速指南 The fully namespaced class name of the class that represents the connection to a database server. This class is responsible for loading the database driver, providing SQL transaction mechanisms and preparing SQL statements among other things.
2	driver The class name of the driver used to implement all specificities for a database engine. This can either be a short classname using plugin syntax, a fully namespaced name, or a constructed driver instance. Examples of short classnames are Mysql, Sqlite, Postgres, and Sqlserver.
3	persistent Whether or not to use a persistent connection to the database.
4	encoding Indicates the character set to use, when sending SQL statements to the server like ‘utf8’ etc.
5	timezone Server timezone to set.
6	init A list of queries that should be sent to the database server as and when the connection is created.
7	log Set to true to enable query logging. When enabled queries will be logged at a debug level with the queriesLog scope.
8	quoteIdentifiers Set to true, if you are using reserved words or special characters in your table or column names. Enabling this setting will result in queries built using the Query Builder having identifiers quoted when creating SQL. It decreases performance.
9	flags An associative array of PDO constants that should be passed to the underlying PDO instance.
10	cacheMetadata Either boolean true, or a string containing the cache configuration to store meta data in. Having metadata caching disable is not advised and can result in very poor performance.

Email Configuration

Email can be configured in file config/app.php. It is not required to define email configuration in config/app.php. Email can be used without it. Just use the respective methods to set all configurations separately or load an array of configs. Configuration for Email defaults is created using config() and configTransport().

Email Configuration Transport

By defining transports separately from delivery profiles, you can easily re-use transport configuration across multiple profiles. You can specify multiple configurations for production, development and testing. Each transport needs a classCakePHP 快速指南. Valid options are as follows −

• Mail − Send using PHP mail function

• Smtp − Send using SMTP

• Debug − Do not send the email, just return the result

You can add custom transports (or override existing transports) by adding the appropriate file to src/Mailer/Transport. Transports should be named YourTransport.php, where 'Your' is the name of the transport.

Following is the example of Email configuration transport.

'EmailTransport' => [
   'default' => [
      'classCakePHP 快速指南' => 'Mail',
      // The following keys are used in SMTP transports
      'host' => 'localhost',
      'port' => 25,
      'timeout' => 30,
      'username' => 'user',
      'password' => 'secret',
      'client' => null,
      'tls' => null,
      'url' => env('EMAIL_TRANSPORT_DEFAULT_URL', null),
   ],
],

Email Delivery Profiles

Delivery profiles allow you to predefine various properties about email messages from your application, and give the settings a name. This saves duplication across your application and makes maintenance and development easier. Each profile accepts a number of keys.

Following is an example of Email delivery profiles.

'Email' => [
   'default' => [
   
      'transport' => 'default',
      'from' => 'you@localhost',
   ],
],

CakePHP - Routing

In this chapter, we are going to learn the following topics related to routing −

• Introduction to Routing
• Connecting Routes
• Passing CakePHP 快速指南 to Routes
• Generating urls
• CakePHP 快速指南 urls

Introduction to Routing

In this section, we will see how you can implement routes, how you can pass arguments from URL to controller’s action, how you can generate URLs, and how you can redirect to a specific URL. Normally, routes are implemented in file config/routes.php. Routing can be implemented in two ways −

• static method
• scoped route builder

Here, is an example presenting both the types.

// Using the scoped route builder.
Router::scope('/', function ($routes) {
   $routes->connect('/', ['controller' => 'CakePHP 快速指南s', 'action' => 'index']);
});
// Using the static method.
Router::connect('/', ['controller' => 'CakePHP 快速指南s', 'action' => 'index']);

Both the methods will execute the index method of CakePHP 快速指南sCakePHP 快速指南. Out of the two methods, scoped route builder gives better performance.

Connecting Routes

Router::connect() method is used to connect routes. The following is the syntax of the method −

static Cake\Routing\Router::connect($route, $defaults =[], $options =[])

There are three arguments to the Router::connect() method −

• The first argument is for the URL template you wish to match.

• The second argument contains default values for your route elements.

• The third argument contains options for the route, which generally contains regular expression rules.

Here, is the basic format of a route −

$routes->connect(
   'URL template',
   ['default' => 'defaultValue'],
   ['option' => 'matchingRegex']
);

Example

Make changes in the config/routes.php file as shown below.

config/routes.php

<?php use Cake\Http\Middleware\CsrfProtectionMiddleware;
use Cake\Routing\Route\DashedRoute;
use Cake\Routing\RouteBuilder;
$routes->setRouteClass(DashedRoute::class);
$routes->scope('/', function (RouteBuilder $builder) {
   // Register scoped middleware for in scopes.
      $builder->registerMiddleware('csrf', new CsrfProtectionMiddleware([
      'httpOnly' => true,
   ]));
   $builder->applyMiddleware('csrf');
   $builder->connect('/', ['controller' => 'Tests', 'action' => 'show']);
   $builder->connect('/pages/*', ['controller' => 'Pages', 'action' => 'display']);
   $builder->fallbacks();
});

Create a TestsCakePHP 快速指南.php file at src/CakePHP 快速指南/TestsCakePHP 快速指南.php. Copy the following code in the controller file.

src/CakePHP 快速指南/TestsCakePHP 快速指南.php

<?php declare(strict_types=1);
namespace App\CakePHP 快速指南;
use Cake\Core\Configure;
use Cake\Http\Exception\ForbiddenException;
use Cake\Http\Exception\NotFoundException;
use Cake\Http\Response;
use Cake\View\Exception\MissingTemplateException;
class TestsCakePHP 快速指南 extends AppCakePHP 快速指南 {
   public function show()
   {
   }
}

Create a folder Tests under src/Template and under that folder, create a View file called show.php. Copy the following code in that file.

src/Template/Tests/show.php

<h1>This is CakePHP tutorial and this is an example of connecting routes.</h1>

Execute the above example by visiting the following URL which is available at http://localhost/cakephp4/

Output

The above URL will yield the following output.

Passed CakePHP 快速指南

Passed arguments are the arguments which are passed in the URL. These arguments can be passed to controller’s action. These passed arguments are given to your controller in three ways.

As arguments to the action method

Following example shows, how we can pass arguments to the action of the controller. Visit the following URL at http://localhost/cakephp4/tests/value1/value2

This will match the following route line.

$builder->connect('tests/:arg1/:arg2', ['controller' => 'Tests', 'action' => 'show'],['pass' => ['arg1', 'arg2']]);

Here, the value1 from URL will be assigned to arg1 and value2 will be assigned to arg2.

As numericallyindexed array

Once the argument is passed to the controller’s action, you can get the argument with the following statement.

$args = $this->request->params[‘pass’]

The arguments passed to controller’s action will be stored in $args variable.

Using routing array

The argument can also be passed to action by the following statement −

$routes->connect('/', ['controller' => 'Tests', 'action' => 'show',5,6]);

The above statement will pass two arguments 5, and 6 to TestCakePHP 快速指南’s show() method.

Example

Make Changes in the config/routes.php file as shown in the following program.

config/routes.php

<?php use Cake\Http\Middleware\CsrfProtectionMiddleware;
use Cake\Routing\Route\DashedRoute;
use Cake\Routing\RouteBuilder;
$routes->setRouteClass(DashedRoute::class);
$routes->scope('/', function (RouteBuilder $builder) {
// Register scoped middleware for in scopes.
$builder->registerMiddleware('csrf', new CsrfProtectionMiddleware([
      'httpOnly' => true,
   ]));
   $builder->applyMiddleware('csrf');
   $builder->connect('tests/:arg1/:arg2', ['controller' => 'Tests', 'action' => 'show'],['pass' => ['arg1', 'arg2']]);
   $builder->connect('/pages/*', ['controller' => 'Pages', 'action' => 'display']);
   $builder->fallbacks();
});

Create a TestsCakePHP 快速指南.php file at src/CakePHP 快速指南/TestsCakePHP 快速指南.php. Copy the following code in the controller file.

src/CakePHP 快速指南/TestsCakePHP 快速指南.php

<?php declare(strict_types=1);
namespace App\CakePHP 快速指南;
use Cake\Core\Configure;
use Cake\Http\Exception\ForbiddenException;
use Cake\Http\Exception\NotFoundException;
use Cake\Http\Response;
use Cake\View\Exception\MissingTemplateException;
class TestsCakePHP 快速指南 extends AppCakePHP 快速指南 {
public function show($arg1, $arg2) {
      $this->set('argument1',$arg1);
      $this->set('argument2',$arg2);
   }
}

Create a folder Tests at src/Template and under that folder create a View file called show.php. Copy the following code in that file.

src/Template/Tests/show.php.

<h1>This is CakePHP tutorial and this is an example of Passed arguments.</h1>
<?php echo "Argument-1:".$argument1."<br/>";
   echo "Argument-2:".$argument2."<br>";
?>

Execute the above example by visiting the following URL http://localhost/cakephp4/tests/CakePHP 快速指南/Kunal

Output

Upon execution, the above URL will produce the following output.

Generating URLs

This is a cool feature of CakePHP. Using the generated URLs, we can easily change the structure of URL in the application without modifying the whole code.

url( string|array|null $url null , boolean $full false )

The above function will take two arguments −

• The first argument is an array specifying any of the following - 'controller', 'action', 'plugin'. Additionally, you can provide routed elements or query string parameters. If string, it can be given the name of any valid url string.

• If true, the full base URL will be prepended to the result. Default is false.

Example

Make Changes in the config/routes.php file as shown in the following program.

config/routes.php

<?php use Cake\Http\Middleware\CsrfProtectionMiddleware;
use Cake\Routing\Route\DashedRoute;
use Cake\Routing\RouteBuilder;
$routes->setRouteClass(DashedRoute::class);
$routes->scope('/', function (RouteBuilder $builder) {
   // Register scoped middleware for in scopes.
   $builder->registerMiddleware('csrf', new CsrfProtectionMiddleware([
      'httpOnly' => true,
   ]));
   $builder->applyMiddleware('csrf');
   $builder->connect('/generate',['controller'=>'Generates','action'=>'show']);
   $builder->fallbacks();
});

Create a GeneratesCakePHP 快速指南.php file at src/CakePHP 快速指南/GeneratesCakePHP 快速指南.php. Copy the following code in the controller file.

src/CakePHP 快速指南/GeneratesCakePHP 快速指南.php

<?php declare(strict_types=1);
namespace App\CakePHP 快速指南;
21
use Cake\Core\Configure;
use Cake\Http\Exception\ForbiddenException;
use Cake\Http\Exception\NotFoundException;
use Cake\Http\Response;
use Cake\View\Exception\MissingTemplateException;
class GeneratesCakePHP 快速指南 extends AppCakePHP 快速指南 {
   public function show()
   {
   }
}

Create a folder Generates at src/Template and under that folder, create a View file called show.php. Copy the following code in that file.

src/Template/Generates/show.php

<h1>This is CakePHP tutorial and this is an example of Generating URLs<h1>
</h1>
</h1>

Execute the above example by visiting the following URL −

http://localhost/cakephp4/generate

Output

The above URL will produce the following output −

CakePHP 快速指南 Routing

CakePHP 快速指南 routing is useful, when we want to inform client applications that, this URL has been moved. The URL can be redirected using the following function −

static Cake\Routing\Router::redirect($route, $url, $options =[])

There are three arguments to the above function as follows −

• A string describing the template of the route.

• A URL to redirect to.

• An array matching the named elements in the route to regular expressions which that element should match.

Example

Make Changes in the config/routes.php file as shown below. Here, we have used controllers that were created previously.

config/routes.php

<?php use Cake\Http\Middleware\CsrfProtectionMiddleware;
use Cake\Routing\Route\DashedRoute;
use Cake\Routing\RouteBuilder;
$routes->setRouteClass(DashedRoute::class);
$routes->scope('/', function (RouteBuilder $builder) {
   // Register scoped middleware for in scopes.
   $builder->registerMiddleware('csrf', new CsrfProtectionMiddleware([
      'httpOnly' => true,
   ]));
   $builder->applyMiddleware('csrf');
   $builder->connect('/generate',['controller'=>'Generates','action'=>'show']);
   $builder->redirect('/redirect','https://tutorialspoint.com/');
   $builder->fallbacks();
});

Execute the above example by visiting the following URLs.

URL 1 − http://localhost/cakephp4/generate

Output for URL 1

URL 2 − http://localhost/cakephp4/redirect

Output for URL 2

You will be redirected to https://tutorialspoint.com

CakePHP - CakePHP 快速指南s

The controller as the name indicates controls the application. It acts like a bridge between models and views. CakePHP 快速指南s handle request data, makes sure that correct models are called and right response or view is rendered.

Methods in the controllers’ class are called actions. Each controller follows naming conventions. The CakePHP 快速指南 class names are in plural form, Camel Cased, and end in CakePHP 快速指南 — PostsCakePHP 快速指南.

AppCakePHP 快速指南

The AppConttroller class is the parent class of all applications’ controllers. This class extends the CakePHP 快速指南 class of CakePHP. AppCakePHP 快速指南 is defined at src/CakePHP 快速指南/AppCakePHP 快速指南.php. The file contains the following code.

<?php declare(strict_types=1);
namespace App\CakePHP 快速指南;
use Cake\CakePHP 快速指南\CakePHP 快速指南;
class AppCakePHP 快速指南 extends CakePHP 快速指南 {
   public function initialize(): void {
      parent::initialize();
      $this->loadComponent('RequestHandler');
      $this->loadComponent('Flash');
   }
}

AppCakePHP 快速指南 can be used to load components that will be used in every controller of your application. The attributes and methods created in AppCakePHP 快速指南 will be available in all controllers that extend it. The initialize() method will be invoked at the end of controller’s constructor to load components.

CakePHP 快速指南 Actions

The methods in the controller class are called Actions. These actions are responsible for sending appropriate response for browser/user making the request. View is rendered by the name of action, i.e., the name of method in controller.

Example

class RecipesCakePHP 快速指南 extends AppCakePHP 快速指南 {
   public function view($id) {
      // Action logic goes here.
   }
   public function share($customerId, $recipeId) {
      // Action logic goes here.
   }
   public function search($query) {
      // Action logic goes here.
   }
}

As you can see in the above example, the RecipesCakePHP 快速指南 has 3 actions − View, Share, and Search.

CakePHP 快速指南ing

For redirecting a user to another action of the same controller, we can use the setAction() method. The following is the syntax for the setAction() method.

Cake\CakePHP 快速指南\CakePHP 快速指南::setAction($action, $args...)

The following code will redirect the user to index action of the same controller.

$this->setAction('index');

The following example shows the usage of the above method.

Example

Make changes in the config/routes.php file as shown in the following program.

config/routes.php

<?php use Cake\Http\Middleware\CsrfProtectionMiddleware;
use Cake\Routing\Route\DashedRoute;
use Cake\Routing\RouteBuilder;
$routes->setRouteClass(DashedRoute::class);
$routes->scope('/', function (RouteBuilder $builder) {
   // Register scoped middleware for in scopes.
   $builder->registerMiddleware('csrf', new CsrfProtectionMiddleware([
      'httpOnly' => true,
   ]));
   $builder->applyMiddleware('csrf'); 
   $builder->connect('/redirect-controller',['controller'=>'CakePHP 快速指南s','action'=>'action1']);
   $builder->connect('/redirect-controller2',['controller'=>'CakePHP 快速指南s','action'=>'action2']);
   $builder->fallbacks();
});

Create a CakePHP 快速指南sCakePHP 快速指南.php file at src/CakePHP 快速指南/CakePHP 快速指南sCakePHP 快速指南.php. Copy the following code in the controller file.

src/CakePHP 快速指南/CakePHP 快速指南sCakePHP 快速指南.php

<?php declare(strict_types=1);
namespace App\CakePHP 快速指南;
use Cake\Core\Configure;
use Cake\Http\Exception\ForbiddenException;
use Cake\Http\Exception\NotFoundException;
use Cake\Http\Response;
use Cake\View\Exception\MissingTemplateException;
class CakePHP 快速指南sCakePHP 快速指南 extends AppCakePHP 快速指南 {
   public function action1() {
   }
   public function action2(){
      echo "redirecting from action2";
      $this->setAction('action1');
   }
}

Create a directory CakePHP 快速指南s at src/Template and under that directory create a View file called action1.php. Copy the following code in that file.

src/Template/CakePHP 快速指南s/action1.php

<h1>This is an example of how to redirect within controller.</h1>

Execute the above example by visiting the following URL.

http://localhost/cakephp4/redirect-controller

Output

Upon execution, you will receive the following output.

Now, visit the following URL: http://localhost/cakephp4/redirect-controller2

The above URL will give you the following output.

Loading Models

In CakePHP, a model can be loaded using the loadModel() method. The following is the syntax for the loadModel() method −

Cake\CakePHP 快速指南\CakePHP 快速指南::loadModel(string $modelClass, string $type)

There are two arguments to the above function as follows −

• The first argument is the name of model class.

• The second argument is the type of repository to load.

Example

If you want to load CakePHP 快速指南s model in a controller, then it can be loaded by writing the following line in controller’s action.

$this->loadModel('CakePHP 快速指南s');

CakePHP - Views

The letter “V” in the MVC is for Views. Views are responsible for sending output to user based on request. View Classes is a powerful way to speed up the development process.

View Templates

The View Templates file of CakePHP gets data from controller and then render the output so that it can be displayed properly to the user. We can use variables, various control structures in template.

Template files are stored in src/Template/, in a directory named after the controller that uses the files, and named after the action it corresponds to. For example, the Viewfile for the Products controller’s “view()” action, would normally be found in src/Template/Products/view.php.

In short, the name of the controller (ProductsCakePHP 快速指南) is same as the name of the folder (Products) but without the word CakePHP 快速指南 and name of action/method (view()) of the controller (ProductsCakePHP 快速指南) is same as the name of the View file(view.php).

View CakePHP 快速指南

View variables are variables which get the value from controller. We can use as many variables in view templates as we want. We can use the set() method to pass values to variables in views. These set variables will be available in both the view and the layout your action renders. The following is the syntax of the set() method.

Cake\View\View::set(string $var, mixed $value)

This method takes two arguments − the name of the variable and its value.

Example

Make Changes in the config/routes.php file as shown in the following program.

config/routes.php

<?php use Cake\Http\Middleware\CsrfProtectionMiddleware;
use Cake\Routing\Route\DashedRoute;
use Cake\Routing\RouteBuilder;
$routes->setRouteClass(DashedRoute::class);
$routes->scope('/', function (RouteBuilder $builder) {
   // Register scoped middleware for in scopes.
   $builder->registerMiddleware('csrf', new CsrfProtectionMiddleware([
      'httpOnly' => true,
   ]));
   $builder->applyMiddleware('csrf');
   $builder->connect('template',['controller'=>'Products','action'=>'view']);
   $builder->fallbacks();
});

Create a ProductsCakePHP 快速指南.php file at src/CakePHP 快速指南/ProductsCakePHP 快速指南.php. Copy the following code in the controller file.

src/CakePHP 快速指南/ProductsCakePHP 快速指南.php

<?php declare(strict_types=1);
namespace App\CakePHP 快速指南;
use Cake\Core\Configure;
use Cake\Http\Exception\ForbiddenException;
use Cake\Http\Exception\NotFoundException;
use Cake\Http\Response;
use Cake\View\Exception\MissingTemplateException;
class ProductsCakePHP 快速指南 extends AppCakePHP 快速指南 {
public function view(){
      $this->set('Product_CakePHP 快速指南','XYZ');
   }
}

Create a directory Products at src/Template and under that folder create a View file called view.php. Copy the following code in that file.

Value of variable is: <?php echo $Product_CakePHP 快速指南; ? >

Execute the above example by visiting the following URL.

http://localhost/cakephp4/template

Output

The above URL will produce the following output.

CakePHP - Extending Views

Many times, while making web pages, we want to repeat certain part of pages in other pages. CakePHP has such facility by which one can extend view in another view and for this, we need not repeat the code again.

The extend() method is used to extend views in View file. This method takes one argument, i.e., the name of the view file with path. Don’t use extension .ctp while providing the name of the View file.

Example

Make changes in the config/routes.php file as shown in the following program.

config/routes.php

<?php use Cake\Http\Middleware\CsrfProtectionMiddleware;
use Cake\Routing\Route\DashedRoute;
use Cake\Routing\RouteBuilder;
$routes->setRouteClass(DashedRoute::class);
$routes->scope('/', function (RouteBuilder $builder) {
   $builder->registerMiddleware('csrf', new CsrfProtectionMiddleware([
      'httpOnly' => true,
   ]));
   $builder->applyMiddleware('csrf');
   $builder->connect('extend',['controller'=>'Extends','action'=>'index']);
   $builder->fallbacks();
});

Create an ExtendsCakePHP 快速指南.php file at src/CakePHP 快速指南/ExtendsCakePHP 快速指南.php. Copy the following code in the controller file.

src/CakePHP 快速指南/ExtendsCakePHP 快速指南.php

<?php namespace App\CakePHP 快速指南;
   use App\CakePHP 快速指南\AppCakePHP 快速指南;
   class ExtendsCakePHP 快速指南 extends AppCakePHP 快速指南{
      public function index(){
      }
   }
?>

Create a directory Extends at src/Template and under that folder create a View file called header.php. Copy the following code in that file.

src/Template/Extends/header.php

<div align="center">
   <h1>Common Header</h1>
</div>
= $this->fetch('content') ?>

Create another View under Extends directory called index.php. Copy the following code in that file. Here, we are extending the above view header.php.

src/Template/Extends/index.php

<?php $this->extend('header'); ?>
This is an example of extending view.

Execute the above example by visiting the following URL http://localhost/cakephp4/extend

Output

Upon execution, you will receive the following output.

CakePHP - View Elements

Certain parts of the web pages are repeated on multiple web pages, but at different locations. CakePHP can help us reuse these repeated parts. These reusable parts are called Elements - help box, extra menu, etc. An element is basically a mini-view. We can also pass variables in elements.

Cake\View\View::element(string $elementPath, array $data, array $options =[]

There are three arguments to the above function as follows −

• The first argument is the name of the template file in the /src/Template/element/ folder.

• The second argument is the array of data to be made available to the rendered view.

• The third argument is for the array of options. e.g. cache.

Out of the 3 arguments, the first one is compulsory, while the rest are optional.

Example

Create an element file at src/Template/element directory called helloworld.php. Copy the following code in that file.

src/Template/element/helloworld.php

<p>Hello World</p>

Create a folder Elems at src/Template and under that directory create a View file called index.php. Copy the following code in that file.

src/Template/Elems/index.php

Element Example: <?php echo $this->element('helloworld'); ?>

Make Changes in the config/routes.php file as shown in the following program.

config/routes.php

<?php use Cake\Http\Middleware\CsrfProtectionMiddleware;
use Cake\Routing\Route\DashedRoute;
use Cake\Routing\RouteBuilder;
$routes->setRouteClass(DashedRoute::class);
$routes->scope('/', function (RouteBuilder $builder) {
   $builder->registerMiddleware('csrf', new CsrfProtectionMiddleware([
      'httpOnly' => true,
   ]));
   $builder->applyMiddleware('csrf');
   $builder->connect('/element-example',['controller'=>'Elems','action'=>'index']);
   $builder->fallbacks();
});

Create an ElemsCakePHP 快速指南.php file at src/CakePHP 快速指南/ElemsCakePHP 快速指南.php. Copy the following code in the controller file.

src/CakePHP 快速指南/ElemsCakePHP 快速指南.php

<?php namespace App\CakePHP 快速指南;
   use App\CakePHP 快速指南\AppCakePHP 快速指南;
   class ElemsCakePHP 快速指南 extends AppCakePHP 快速指南{
      public function index(){
      }
   }
?>

Execute the above example by visiting the following URL http://localhost/cakephp4/element-example

Output

Upon execution, the above URL will give you the following output.

CakePHP - View Events

There are several callbacks/events that we can use with View Events. These events are helpful to perform several tasks before something happens or after something happens. The following is a list of callbacks that can be used with CakePHP −

Sr.No	Event Function & Description
1	Helper::beforeRender(Event $event,$viewFile) The beforeRender method is called after the controller’s beforeRender method but before the controller renders view and layout. This receives the file being rendered as an argument.
2	Helper::beforeRenderFile(Event $event, $viewFile) This method is called before each view file is rendered. This includes elements, views, parent views and layouts.
3	Helper::afterRenderFile(Event $event, $viewFile, $content) This method is called after each View file is rendered. This includes elements, views, parent views and layouts. A callback can modify and return $content to change how the rendered content will be displayed in the browser.
4	Helper::afterRender(Event $event, $viewFile) This method is called after the view has been rendered, but before the layout rendering has started.
5	Helper::beforeLayout(Event $event, $layoutFile) This method is called before the layout rendering starts. This receives the layout filename as an argument.
6	Helper::afterLayout(Event $event, $layoutFile) This method is called after the layout rendering is complete. This receives the layout filename as an argument.

CakePHP - Working with Database

Working with database in CakePHP is very easy. We will understand the CRUD (Create, Read, Update, Delete) operations in this chapter.

Further, we also need to configure our database in config/app_local.php file.

'Datasources' => [
   'default' => [
      'host' => 'localhost',
      'username' => 'my_app',
      'password' => 'secret',
      'database' => 'my_app',
      'url' => env('DATABASE_URL', null),
   ],
   /*
      * The test connection is used during the test suite.
   */
   'test' => [
      'host' => 'localhost',
      //'port' => 'non_standard_port_number',
      'username' => 'my_app',
      'password' => 'secret',
      'database' => 'test_myapp',
      //'schema' => 'myapp',
   ],
],

The default connection has following details −

'host' => 'localhost',
   'username' => 'my_app',
   'password' => 'secret',
   'database' => 'my_app',

You can change the details, i.e. host, username, password and database as per your choice.

Once done, make sure it is updated in config/app_local.php in Datasources object.

Now, we will continue with above details, go to your phpmyadmin or mysql database and create user my_app as shown below −

Give the necessary privileges and save it. Now, we have the database details as per the configuration mentioned in app_local.php. When you check CakePHP home page, this is what you should get −

Now, we will create the following users’ table in the database.

CREATE TABLE `users` ( 
   `id` int(11) NOT NULL AUTO_INCREMENT,
   `username` varchar(50) NOT NULL, 
   `password` varchar(255) NOT NULL, PRIMARY KEY (`id`) 
) ENGINE=InnoDB AUTO_INCREMENT=7 DEFAULT CHARSET=latin1

Insert a Record

To insert a record in database, we first need to get hold of a table using TableRegistry class. We can fetch the instance out of registry using get() method. The get() method will take the name of the database table as an argument.

This new instance is used to create new entity. Set necessary values with the instance of new entity. We now have to call the save() method with TableRegistry class’s instance which will insert new record in database.

Example

Make changes in the config/routes.php file as shown in the following program.

config/routes.php

<?php use Cake\Http\Middleware\CsrfProtectionMiddleware;
use Cake\Routing\Route\DashedRoute;
use Cake\Routing\RouteBuilder;
$routes->setRouteClass(DashedRoute::class);
$routes->scope('/', function (RouteBuilder $builder) {
   $builder->registerMiddleware('csrf', new CsrfProtectionMiddleware([
      'httpOnly' => true,
   ]));
   $builder->applyMiddleware('csrf');
   //$builder->connect('/pages',['controller'=>'Pages','action'=>'display', 'home']);
   $builder->connect('/users/add', ['controller' => 'Users', 'action' => 'add']);
   $builder->fallbacks();
});

Create a UsersCakePHP 快速指南.php file at src/CakePHP 快速指南/UsersCakePHP 快速指南.php. Copy the following code in the controller file.

src/controller/UsersCakePHP 快速指南.php

<?php namespace App\CakePHP 快速指南;
use App\CakePHP 快速指南\AppCakePHP 快速指南;
use Cake\ORM\TableRegistry;
use Cake\Datasource\ConnectionManager;
use Cake\Auth\DefaultPasswordHasher;
class UsersCakePHP 快速指南 extends AppCakePHP 快速指南{
   public function add(){
      if($this->request->is('post')){
         $username = $this->request->getData('username');
         $hashPswdObj = new DefaultPasswordHasher;
         $password = $hashPswdObj->hash($this->request->getData('password'));
         $users_table = TableRegistry::get('users');
         $users = $users_table->newEntity($this->request->getData());
         $users->username = $username;
         $users->password = $password;
         $this->set('users', $users);
         if($users_table->save($users))
         echo "User is added.";
      }
   }
}
?>

Create a directory Users at src/Template and under that directory create a View file called add.php. Copy the following code in that file.

src/Template/Users/add.php

<?php echo $this->Form->create(NULL,array('url'=>'/users/add'));
   echo $this->Form->control('username');
   echo $this->Form->control('password');
   echo $this->Form->button('Submit');
   echo $this->Form->end();
?>

Execute the above example by visiting the following URL. http://localhost/cakephp4/users/add

Output

Upon execution, you will receive the following output.

The data will be saved in the users table as shown below −

CakePHP - View a Record

To view records of database, we first need to get hold of a table using the TableRegistry class. We can fetch the instance out of registry using get() method. The get() method will take the name of the database table as argument.

Now, this new instance is used to find records from database using find() method. This method will return all records from the requested table.

Example

Make changes in the config/routes.php file as shown in the following code.

config/routes.php

<?php use Cake\Http\Middleware\CsrfProtectionMiddleware;
use Cake\Routing\Route\DashedRoute;
use Cake\Routing\RouteBuilder;
$routes->setRouteClass(DashedRoute::class);
$routes->scope('/', function (RouteBuilder $builder) {
   $builder->registerMiddleware('csrf', new CsrfProtectionMiddleware([
      'httpOnly' => true,
   ]));
   $builder->applyMiddleware('csrf');
   //$builder->connect('/pages',['controller'=>'Pages','action'=>'display', 'home']);
   $builder->connect('/users', ['controller' => 'Users', 'action' => 'index']);
   $builder->fallbacks();
});

Create a UsersCakePHP 快速指南.php file at src/CakePHP 快速指南/UsersCakePHP 快速指南.php. Copy the following code in the controller file.

src/controller/UsersCakePHP 快速指南.php

<?php namespace App\CakePHP 快速指南;
   use App\CakePHP 快速指南\AppCakePHP 快速指南;
   use Cake\ORM\TableRegistry;
   use Cake\Datasource\ConnectionManager;
   class UsersCakePHP 快速指南 extends AppCakePHP 快速指南{
      public function index(){
         $users = TableRegistry::get('users');
         $query = $users->find();
         $this->set('results',$query);
      }
   }
?>

Create a directory Users at src/Template, ignore if already created, and under that directory create a View file called index.php. Copy the following code in that file.

src/Template/Users/index.ctp

<a href="add">Add User</a>

"; echo ""; echo ""; echo ""; endforeach; ?>

ID	Username	Password	Edit	Delete
".$row->id."	"; echo "	".$row->password."	Edit	Delete

Execute the above example by visiting the following URL http://localhost/cakephp4/users

Output

Upon execution, the above URL will give you the following output.

CakePHP - Update a Record

To update a record in database, we first need to get hold of a table using TableRegistry class. We can fetch the instance out of registry using the get() method. The get() method will take the name of the database table as an argument. Now, this new instance is used to get particular record that we want to update.

Call the get() method with this new instance, and pass the primary key to find a record, which will be saved in another instance. Use this instance, to set new values that you want to update and then, finally call the save() method with the TableRegistry class’s instance to update record.

Example

Make changes in the config/routes.php file as shown in the following code.

config/routes.php

<?php use Cake\Http\Middleware\CsrfProtectionMiddleware;
use Cake\Routing\Route\DashedRoute;
use Cake\Routing\RouteBuilder;
$routes->setRouteClass(DashedRoute::class);
$routes->scope('/', function (RouteBuilder $builder) {
   $builder->registerMiddleware('csrf', new CsrfProtectionMiddleware([
      'httpOnly' => true,
   ]));
   $builder->applyMiddleware('csrf');
   //$builder->connect('/pages',['controller'=>'Pages','action'=>'display', 'home']);
   $builder->connect('/users/edit', ['controller' => 'Users', 'action' => 'edit']);
   $builder->fallbacks();
});

Create a UsersCakePHP 快速指南.php file at src/CakePHP 快速指南/UsersCakePHP 快速指南.php. Copy the following code in the controller file.

src/controller/UsersCakePHP 快速指南.php

<?php namespace App\CakePHP 快速指南;
   use App\CakePHP 快速指南\AppCakePHP 快速指南;
   use Cake\ORM\TableRegistry;
   use Cake\Datasource\ConnectionManager;
   class UsersCakePHP 快速指南 extends AppCakePHP 快速指南{
      public function index(){
         $users = TableRegistry::get('users');
         $query = $users->find();
         $this->set('results',$query);
      }
      public function edit($id){
         if($this->request->is('post')){
            $username = $this->request->getData('username');
            $password = $this->request->getData('password');
            $users_table = TableRegistry::get('users');
            $users = $users_table->get($id);
            $users->username = $username;
            $users->password = $password;
            if($users_table->save($users))
            echo "User is udpated";
            $this->setAction('index');
         } else {
            $users_table = TableRegistry::get('users')->find();
            $users = $users_table->where(['id'=>$id])->first();
            $this->set('username',$users->username);
            $this->set('password',$users->password);
            $this->set('id',$id);
         }
      }
   }
?>

Create a directory Users at src/Template, ignore if already created, and under that directory create a view called index.php. Copy the following code in that file.

src/Template/Users/index.php

<a href="add">Add User</a>

"; echo ""; echo ""; echo ""; echo ""; endforeach; ?>

ID	Username	Password	Edit	Delete
".$row->id."	".$row->username."	".$row->password."	Edit	Delete

Create another View file under the Users directory called edit.php and copy the following code in it.

src/Template/Users/edit.php

<?php echo $this->Form->create(NULL,array('url'=>'/users/edit/'.$id));
   echo $this->Form->control('username',['value'=>$username]);
   echo $this->Form->control('password',['value'=>$password]);
   echo $this->Form->button('Submit');
   echo $this->Form->end();
?>

Execute the above example by visiting the following URL and click on Edit link to edit record.

http://localhost/cakephp4/users

Output

After visiting the above URL, it will display the records in users table as shown below −

Click on Edit button and it will display you following screen −

Now, we will update the name CakePHP 快速指南 to CakePHP 快速指南123 and submit the details. The next screen displayed will be as follows −

CakePHP - Delete a Record

To delete a record in database, we first need to get hold of a table using the TableRegistry class. We can fetch the instance out of registry using the get() method. The get() method will take the name of the database table as an argument. Now, this new instance is used to get particular record that we want to delete.

Call the get() method with this new instance and pass the primary key to find a record which will be saved in another instance. Use the TableRegistry class’s instance to call the delete method to delete record from database.

Example

Make changes in the config/routes.php file as shown in the following code.

config/routes.php

<?php use Cake\Http\Middleware\CsrfProtectionMiddleware;
use Cake\Routing\Route\DashedRoute;
use Cake\Routing\RouteBuilder;
$routes->setRouteClass(DashedRoute::class);
$routes->scope('/', function (RouteBuilder $builder) {
   $builder->registerMiddleware('csrf', new CsrfProtectionMiddleware([
      'httpOnly' => true,
   ]));
   $builder->applyMiddleware('csrf');
   //$builder->connect('/pages',['controller'=>'Pages','action'=>'display', 'home']);
   $builder->connect('/users/delete', ['controller' => 'Users', 'action' => 'delete']);
   $builder->fallbacks();
});

Create a UsersCakePHP 快速指南.php file at src/CakePHP 快速指南/UsersCakePHP 快速指南.php. Copy the following code in the controller file.

src/controller/UsersCakePHP 快速指南.php

<?php namespace App\CakePHP 快速指南;
   use App\CakePHP 快速指南\AppCakePHP 快速指南;
   use Cake\ORM\TableRegistry;
   use Cake\Datasource\ConnectionManager;
   class UsersCakePHP 快速指南 extends AppCakePHP 快速指南{
      public function index(){
         $users = TableRegistry::get('users');
         $query = $users->find();
         $this->set('results',$query);
      }
      public function delete($id){
         $users_table = TableRegistry::get('users');
         $users = $users_table->get($id);
         $users_table->delete($users);
         echo "User deleted successfully.";
         $this->setAction('index');
      }
   }
?>

Just create an empty View file under Users directory called delete.ctp.

src/Template/Users/delete.ctp

Create a directory Users at src/Template, ignore if already created, and under that directory create a Viewfile called index.ctp. Copy the following code in that file.

src/Template/Users/index.ctp

<a href="add">Add User</a>

"; echo ""; echo ""; echo ""; echo ""; endforeach; ?>

ID	Username	Password	Edit	Delete
".$row->id."	".$row->username."	".$row->password."	Edit	Delete

Execute the above example by visiting the following URL and click on Delete link to delete record.

http://localhost:85/CakePHP/users

Output

After visiting the above URL and clicking on the Delete link, you will receive the following output where you can delete record.

Click on Delete link to delete the record.

CakePHP - Services

This chapter deals with the information about the authentication process available in CakePHP.

CakePHP 快速指南

CakePHP 快速指南 is the process of identifying the correct user. CakePHP supports three types of authentication.

• FormAuthenticate − It allows you to authenticate users based on form POST data. Usually, this is a login form that users enter information into. This is default authentication method.

• BasicAuthenticate − It allows you to authenticate users using Basic HTTP authentication

• DigestAuthenticate − It allows you to authenticate users using Digest HTTP authentication.

Example for FormCakePHP 快速指南

Make changes in the config/routes.php file as shown in the following code.

config/routes.php

<?php use Cake\Core\Plugin;
use Cake\Routing\RouteBuilder;
use Cake\Routing\Router;
Router::defaultRouteClass('DashedRoute');
Router::scope('/', function (RouteBuilder $routes) {
   $routes->connect('/auth',['controller'=>'Authexs','action'=>'index']);
   $routes->connect('/login',['controller'=>'Authexs','action'=>'login']);
   $routes->connect('/logout',['controller'=>'Authexs','action'=>'logout']);
   $routes->fallbacks('DashedRoute');
});
Plugin::routes();

Change the code of AppCakePHP 快速指南.php file as shown in the following program.

src/CakePHP 快速指南/AppCakePHP 快速指南.php

<?php namespace App\CakePHP 快速指南;
use Cake\CakePHP 快速指南\CakePHP 快速指南;
use Cake\Event\Event;
use Cake\CakePHP 快速指南\Component\AuthComponent;
class AppCakePHP 快速指南 extends CakePHP 快速指南 {
   public function initialize() {
      parent::initialize();
      $this->loadComponent('RequestHandler');
      $this->loadComponent('Flash');
         $this->loadComponent('Auth', [
            'authenticate' => [
               'Form' => [
                  'fields' => [
               'username' => 'username',
               'password' => 'password'
            ]
         ]
      ],
      'loginAction' => [
         'controller' => 'Authexs',
         'action' => 'login'
      ],
      'loginCakePHP 快速指南' => [
         'controller' => 'Authexs',
         'action' => 'index'
      ],
      'logoutCakePHP 快速指南' => [
         'controller' => 'Authexs',
         'action' => 'login'
      ]
   ]);
}
public function beforeFilter(Event $event) {
      $this->Auth->allow(['index','view']);
      $this->set('loggedIn', $this->Auth->user());
   }
}

Create AuthexsCakePHP 快速指南.php file at src/CakePHP 快速指南/AuthexsCakePHP 快速指南.php. Copy the following code in the controller file.

src/CakePHP 快速指南/AuthexsCakePHP 快速指南.php

<?php namespace App\CakePHP 快速指南;
use App\CakePHP 快速指南\AppCakePHP 快速指南;
use Cake\ORM\TableRegistry;
use Cake\Datasource\ConnectionManager;
use Cake\Event\Event;
use Cake\Auth\DefaultPasswordHasher;
class AuthexsCakePHP 快速指南 extends AppCakePHP 快速指南 {
   var $components = array('Auth');
   public function index(){
   }
   public function login(){
      if($this->request->is('post')) {
         $user = $this->Auth->identify();
         if($user){
            $this->Auth->setUser($user);
            return $this->redirect($this->Auth->redirectUrl());
         } else
         $this->Flash->error('Your username or password is incorrect.');
      }
   }
   public function logout(){
      return $this->redirect($this->Auth->logout());
   } 
}
?>

Create a directory Authexs at src/Template and under that directory create a View file called login.php. Copy the following code in that file.

src/Template/Authexs/login.php

<?php echo $this->Form->create();
   echo $this->Form->control('username');
   echo $this->Form->control('password');
   echo $this->Form->button('Submit');
   echo $this->Form->end();
?>

Create another View file called logout.php. Copy the following code in that file.

src/Template/Authexs/logout.php

You are successfully logged out.

Create another View file called index.php. Copy the following code in that file.

src/Template/Authexs/index.php

You are successfully logged in. 
<?php echo $this->Html->link('logout',[
      "controller" => "Authexs","action" => "logout"
   ]); 
?>

Execute the above example by visiting the following URL.

http://localhost/cakephp4/auth

輸出

由於身份驗證已完成，一旦您嘗試訪問上述網址，您將被重定向到如下所示的登入頁面。

提供正確的憑證後，您將登入並重定向到如下所示的畫面。

點擊登出連結後，您將再次重定向到登入畫面。

CakePHP - 錯誤與異常處理

系統故障需要有效的處理，以確保系統的順利運作。 CakePHP 帶有預設的錯誤捕獲，當發生錯誤時列印並記錄錯誤。同樣的錯誤處理程序用於捕捉異常。

當 debug 為 true 時，錯誤處理程序顯示錯誤；當 debug 為 false 時，錯誤處理程序會記錄錯誤。 CakePHP 有許多異常類，內建的異常處理將捕獲任何未捕獲的異常並呈現有用的頁面。

錯誤和異常配置

錯誤和異常可以在檔案configapp.php中設定。錯誤處理接受一些選項，允許您為應用程式自訂錯誤處理 -

表>

Example

Make changes in the config/routes.php file as shown in the following code.

config/routes.php

<?php use Cake\Http\Middleware\CsrfProtectionMiddleware;
use Cake\Routing\Route\DashedRoute;
use Cake\Routing\RouteBuilder;
$routes->setRouteClass(DashedRoute::class);
$routes->scope('/', function (RouteBuilder $builder) {
   $builder->registerMiddleware('csrf', new CsrfProtectionMiddleware([
      'httpOnly' => true,
   ]));
   $builder->applyMiddleware('csrf');
   //$builder->connect('/pages',['controller'=>'Pages','action'=>'display', 'home']);
   $builder->connect('/exception/:arg1/:arg2',
      ['controller'=>'Exps','action'=>'index'],
      ['pass' => ['arg1', 'arg2']]);
   $builder->fallbacks();
});

Create ExpsCakePHP 快速指南.php file at src/CakePHP 快速指南/ExpsCakePHP 快速指南.php. Copy the following code in the controller file.

src/CakePHP 快速指南/ExpsCakePHP 快速指南.php

<?php namespace App\CakePHP 快速指南;
   use App\CakePHP 快速指南\AppCakePHP 快速指南;
   use Cake\Core\Exception\Exception;
   class ExpsCakePHP 快速指南 extends AppCakePHP 快速指南 {
      public function index($arg1,$arg2) {
         try{
            $this->set('argument1',$arg1);
            $this->set('argument2',$arg2);
            if(($arg1 > 1 || $arg1 > 10) || ($arg2  10))
               throw new Exception("One of the number is out of range [1-10].");
         } catch(\Exception $ex){
            echo $ex->getMessage();
         }
      }
   }
?>

Create a directory Exps at src/Template and under that directory create a View file called index.php. Copy the following code in that file.

src/Template/Exps/index.php

This is CakePHP tutorial and this is an example of Passed arguments.<br>
Argument-1: =$argument1?><br>
Argument-2: =$argument2?><br>

Execute the above example by visiting the following URL.

http://localhost/cakephp4/exception/5/0

Output

Upon execution, you will receive the following output.

CakePHP - Logging

Logging in CakePHP is a very easy task. You just have to use one function. You can log errors, exceptions, user activities, action taken by users, for any background process like cronjob. Logging data in CakePHP is easy. The log() function is provided by the LogTrait, which is the common ancestor for almost all CakePHP classes.

Logging Configuration

We can configure the log in file config/app.php. There is a log section in the file, where you can configure logging options as shown in the following screenshot.

By default, you will see two log levels − error and debug already configured for you. Each will handle different level of messages.

CakePHP supports various logging levels as shown below −

• Emergency − System is unusable

• Alert − Action must be taken immediately

• Critical − Critical conditions

• Error − Error conditions

• Warning − Warning conditions

• Notice − Normal but significant condition

• Info − Informational messages

• Debug − Debug-level messages

Writing to Log file

There are two ways by which, we can write in a Log file.

The first is to use the static write() method. The following is the syntax of the static write() method.

選項

資料型別

描述

錯誤等級

int

Option	Data Type	Description
errorLevel	int	The level of errors you are interested in capturing. Use the built-in php error constants, and bitmasks to select the level of error you are interested in.
trace	bool	Include stack traces for errors in log files. Stack traces will be included in the log after each error. This is helpful for finding where/when errors are being raised.
exceptionRenderer	string	The class responsible for rendering uncaught exceptions. If you choose a custom class, you should place the file for that class in src/Error. This class needs to implement a render() method.
log	bool	When true, exceptions + their stack traces will be logged to CakeLogLog.
skipLog	array	An array of exception class names that should not be logged. This is useful to remove NotFoundExceptions or other common, but uninteresting logs messages.
extraFatalErrorMemory	int	Set to the number of megabytes to increase the memory limit by, when a fatal error is encountered. This allows breathing room to complete logging or error handling.

您有興趣捕獲的錯誤等級。使用內建的 php 錯誤常數和位元遮罩來選擇您感興趣的錯誤等級。

跟蹤

布林

在日誌檔案中包含錯誤的堆疊追蹤。每次錯誤後，堆疊追蹤將包含在日誌中。這有助於尋找發生錯誤的位置/時間。

異常渲染器

字串

負責渲染未捕獲異常的類別。如果您選擇自訂類，則應將該類的檔案放置在src/Error中。該類別需要實作 render() 方法。

日誌

布林

當為 true 時，異常及其堆疊追蹤將被記錄到 CakeLogLog。

跳過日誌

數組

不應記錄的異常類別名稱數組。這對於刪除 NotFoundExceptions 或其他常見但無趣的日誌訊息很有用。

額外的致命錯誤記憶體

int

設定為在遇到致命錯誤時增加記憶體限制的兆位元組數。這為完成日誌記錄或錯誤處理提供了喘息的空間。

Syntax	write( integer|string $level, mixed $message, string|array $context [] )
Parameters	The severity level of the message being written. The value must be an integer or string matching a known level. Message content to log. Additional data to be used for logging the message. The special scope key can be passed to be used for further filtering of the log engines to be used. If a string or a numerically index array is passed, it will be treated as the scope key. See Cake\Log\Log::config() for more information on logging scopes.
Returns	boolean
Description	Writes the given message and type to all of the configured log adapters. Configured adapters are passed both the $level and $message variables. $level is one of the following strings/values.

The second is to use the log() shortcut function available on any using the LogTrait Calling log() will internally call Log::write() −

Example

Make changes in the config/routes.php file as shown in the following program.

config/routes.php

<?php use Cake\Http\Middleware\CsrfProtectionMiddleware;
use Cake\Routing\Route\DashedRoute;
use Cake\Routing\RouteBuilder;
$routes->setRouteClass(DashedRoute::class);
$routes->scope('/', function (RouteBuilder $builder) {
   $builder->registerMiddleware('csrf', new CsrfProtectionMiddleware([
      'httpOnly' => true,
   ]));
   $builder->applyMiddleware('csrf');
   //$builder->connect('/pages',
      ['controller'=>'Pages','action'=>'display', 'home']);
   $builder->connect('logex',['controller'=>'Logexs','action'=>'index']);
   $builder->fallbacks();
});

Create a LogexsCakePHP 快速指南.php file at src/CakePHP 快速指南/LogexsCakePHP 快速指南.php. Copy the following code in the controller file.

src/CakePHP 快速指南/LogexsCakePHP 快速指南.php

<?php namespace App\CakePHP 快速指南;
   use App\CakePHP 快速指南\AppCakePHP 快速指南;
   use Cake\Log\Log;
   class LogexsCakePHP 快速指南 extends AppCakePHP 快速指南{
      public function index(){
         /*The first way to write to log file.*/
         Log::write('debug',"Something didn't work.");
         /*The second way to write to log file.*/
         $this->log("Something didn't work.",'debug');
      }
   }
?>

Create a directory Logexs at src/Template and under that directory create a View file called index.php. Copy the following code in that file.

src/Template/Logexs/index.php

Something is written in log file. Check log file logs\debug.log

Execute the above example by visiting the following URL.

http://localhost/cakephp4/logex

Output

Upon execution, you will receive the following output.

The logs will be added to log/debug.log file −

CakePHP - Form Handling

CakePHP provides various in built tags to handle HTML forms easily and securely. Like many other PHP frameworks, major elements of HTML are also generated using CakePHP. Following are the various functions used to generate HTML elements.

The following functions are used to generate select options −

Syntax	_selectCakePHP 快速指南( array $elementsarray(), array $parentsarray(), boolean $showParentsnull, array $attributesarray() )
Parameters	Elements to format Parents for OPTGROUP Whether to show parents HTML attributes
Returns	array
Description	Returns an array of formatted OPTION/OPTGROUP elements

The following functions are used to generate HTML select element.

Syntax	select( string $fieldCakePHP 快速指南, array $options array(), array $attributes array() )
Parameters	CakePHP 快速指南 attribute of the SELECT Array of the OPTION elements (as 'value'=>'Text' pairs) to be used in the SELECT element.
Returns	Formatted SELECT element.
Description	Returns a formatted SELECT element.

The following functions are used to generate button on HTML page.

Syntax	Button(string $title, array $optionsarray() )
Parameters	The button's caption. Not automatically HTML encoded. Array of options and HTML attributes
Returns	HTML button tag.
Description	Creates a tag. The type attribute defaults to type="submit". You can change it to a different value by using $options['type'].

The following functions are used to generate checkbox on HTML page.

Syntax	Checkbox(string $fieldCakePHP 快速指南, array $optionsarray() )
Parameters	CakePHP 快速指南 of a field, like this "Modelname.fieldname" Array of HTML attributes. Possible options are value, checked, hiddenField, disabled, default.
Returns	An HTML text input element.
Description	Creates a checkbox input widget.

以下函數用於在 HTML 頁面上建立表單。

表>

語法

create(混合$modelnull，陣列$optionsarray())

參數

• Syntax	create( mixed $modelnull , array $optionsarray() )
  Parameters	The model name for which the form is being defined. Should include the plugin name for plugin models. e.g. ContactManager.Contact. If an array is passed and $options argument is empty, the array will be used as options. If false, no model is used. An array of html attributes and options. Possible options are type, action, url, default, onsubmit, inputDefaults, encoding.
  Returns	A formatted opening FORM tag.
  Description	Returns an HTML FORM element.

  正在定義表單的模型名稱。應包含插件模型的插件名稱。例如聯絡人管理器.聯絡人。如果傳遞一個陣列且 $options 參數為空，則該陣列將用作選項。如果為 false，則不使用任何模型。

• html 屬性和選項的陣列。可能的選項有類型、操作、url、預設、onsubmit、inputDefaults、編碼。

回傳

格式化的開始 FORM 標籤。

描述

傳回 HTML FORM 元素。

Syntax	file(string $fieldCakePHP 快速指南, array $optionsarray() )
Parameters	CakePHP 快速指南 of a field, in the form "Modelname.fieldname" Array of HTML attributes.
Returns	A generated file input.
Description	Creates file input widget.

以下函數用於在 HTML 頁面上

提供文件上傳功能

。

表>

以下函數用於在 HTML 頁面上建立隱藏元素。

語法

檔案(字串 $fieldCakePHP 快速指南, 陣列 $optionsarray() )

參數

• Syntax	hidden( string $fieldCakePHP 快速指南 , array $optionsarray() )
  Parameters	CakePHP 快速指南 of a field, in the form of "Modelname.fieldname" Array of HTML attributes.
  Returns	A generated hidden input
  Description	Creates a hidden input field

  欄位名稱，格式為「Modelname.fieldname」

• HTML 屬性陣列。

回傳

產生的檔案輸入。

描述

建立文件輸入小工具。

Syntax	Input(string $fieldCakePHP 快速指南 , array $options array() )
Parameters	This should be "Modelname.fieldname" Each type of input takes different options
Returns	Completed form widget
Description	Generates a form input element complete with label and wrapper div

表> 以下函數用於在 HTML 頁面上產生 輸入元素。

語法

Syntax	Radio(string $fieldCakePHP 快速指南 , array $optionsarray() , array $attributesarray() )
Parameters	CakePHP 快速指南 of a field, like this "Modelname.fieldname" Radio button options array. Array of HTML attributes, and special attributes above.
Returns	Completed radio widget set
Description	Creates a set of radio widgets. Will create a legend and fieldset by default. Use $options to control this.

隱藏(字串 $fieldCakePHP 快速指南 , 陣列 $optionsarray() )

參數

• 欄位名稱，格式為「Modelname.fieldname」

• HTML 屬性陣列。

回傳

產生的隱藏輸入

Syntax	Submit(string $caption null, array $options array() )
Parameters	The label appearing on the button OR if string contains :// or the extension .jpg, .jpe, .jpeg, .gif, .png. Use an image if the extension exists, AND the first character is /, image is relative to webroot, OR if the first character is not /, image is relative to webroot/img. Array of options. Possible options are div, before, after, type etc.
Returns	An HTML submit button
Description	Creates a submit button element. This method will generate elements that can be used to submit, and reset forms by using $options. Image submits can be created by supplying an image path for $caption.

描述

建立隱藏輸入欄位

表> 以下函數用於在 HTML 頁面上產生單選按鈕。

語法	輸入（字串 $fieldCakePHP 快速指南 , 陣列 $options array() ）
參數	這應該是「模型名稱.欄位名稱」 每種類型的輸入都有不同的選項
回傳	已完成的表單小工具
描述	產生一個包含標籤和包裝 div 的表單輸入元素

表> 以下函數用於在 HTML 頁面上產生 提交 按鈕。

語法	Radio(字串$fieldCakePHP 快速指南 , 陣列$optionsarray() , 陣列$attributesarray() )
參數	欄位名稱，例如「Modelname.fieldname」 單選按鈕選項陣列。 HTML 屬性數組，以及上面的特殊屬性。
回傳	完成的無線電小部件集
描述	建立一組無線電小部件。預設將建立圖例和欄位集。使用 $options 來控制它。

表>

The following functions are used to generate textarea element on HTML page.

語法	提交（字串 $caption null，數組 $options array() ）
參數	出現在按鈕上的標籤，或如果字串包含 :// 或副檔名 .jpg、.jpe、.jpeg、.gif、.png。如果擴展名存在，則使用圖像，並且第一個字元是 /，圖像相對於 webroot，或者如果第一個字元不是 /，圖像相對於 webroot/img。 選項數組。可能的選項有 div、之前、之後、類型等。
回傳	HTML 提交按鈕
描述	建立一個提交按鈕元素。此方法將產生 可用於使用 $options 提交和重設表單的元素。可以透過為 $caption 提供影像路徑來建立影像提交。

Syntax	Textarea(string $fieldCakePHP 快速指南 , array $options array() )
Parameters	CakePHP 快速指南 of a field, in the form "Modelname.fieldname" Array of HTML attributes, special option like escape
Returns	A generated HTML text input element
Description	Creates a textarea widget