CMS教程 - 创建文章控制器¶
创建了我们的模型之后，我们需要一个用于文章的控制器。在CakePHP中，控制器处理HTTP请求并执行模型方法中包含的业务逻辑，以准备响应。我们将把这个新的控制器放在一个名为 ArticlesController.php 的文件中，放在 src/Controller 目录下。下面是基本的控制器的样子:
<?php
// src/Controller/ArticlesController.php
namespace App\Controller;
class ArticlesController extends AppController
{
}
现在，让我们为我们的控制器添加一个动作。动作是与控制器方法相关联的路由。例如，当用户请求 www.example.com/articles/index （也可以是 www.example.com/articles ），CakePHP将调用您的 ArticlesController 的 index 方法。该方法应该查询模型层，并通过在视图中渲染模板来准备响应。该动作的代码如下所示:
<?php
// src/Controller/ArticlesController.php
namespace App\Controller;
class ArticlesController extends AppController
{
public function index()
{
$articles = $this->paginate($this->Articles);
$this->set(compact('articles'));
}
}
通过在我们的 ArticlesController 中定义 index() 函数，用户现在可以通过请求 www.example.com/articles/index 来访问其中的逻辑。类似地，如果我们定义了一个名为 foobar() 的函数，用户将能够通过 www.example.com/articles/foobar 来访问它。您可能会想以一种允许您获得特定URL的方式来命名您的控制器和动作。不要这样做。相反，遵循 CakePHP约定 中创建可读性强、有意义的动作名称。然后，您可以使用 Routing 来将您想要的URL与您创建的动作连接起来。
我们的控制器动作非常简单。它从数据库中获取一个分页的文章集合，使用通过命名约定自动加载的Articles模型。然后，它使用 set() 将文章传递给模板（我们很快会创建）。CakePHP在控制器动作完成后会自动渲染模板。
创建文章列表模板¶
既然我们的控制器从模型中获取数据并准备好视图上下文，让我们为索引动作创建一个视图模板。
CakePHP的视图模板是插入到应用程序布局中的呈现风格的PHP代码。虽然我们将在这里创建HTML，但视图也可以生成JSON、CSV甚至像PDF这样的二进制文件。
布局是包围视图的呈现代码。布局文件包含常见的站点元素，如标题、页脚和导航元素。您的应用程序可以有多个布局，并且可以在它们之间切换，但现在，让我们只使用默认布局。
CakePHP的模板文件存储在名为与其对应的控制器同名的文件夹中的 templates 文件夹中。因此，在这种情况下，我们需要创建一个名为’Articles’的文件夹。将以下代码添加到您的应用程序中:
<!-- 文件：templates/Articles/index.php -->
<h1>Articles</h1>
<table>
<tr>
<th>Title</th>
<th>Created</th>
</tr>
<!-- 这里是我们通过$articles查询对象进行迭代的地方，打印出文章信息 -->
<?php foreach ($articles as $article): ?>
<tr>
<td>
<?= $this->Html->link($article->title, ['action' => 'view', $article->slug]) ?>
</td>
<td>
<?= $article->created->format(DATE_RFC850) ?>
</td>
</tr>
<?php endforeach; ?>
</table>
在上一节中，我们使用 set() 将’articles’变量传递给视图。传递给视图的变量在视图模板中作为局部变量可用，我们在上面的代码中使用了它们。
您可能已经注意到使用了一个名为 $this->Html 的对象。这是CakePHP的 HtmlHelper 的一个实例。CakePHP提供了一组视图助手，用于执行诸如创建链接、表单和分页按钮等任务。您可以在它们的章节中了解更多关于 Helpers 的信息，但这里需要注意的重要一点是， link() 方法将生成一个带有给定链接文本（第一个参数）和URL（第二个参数）的HTML链接。
在CakePHP中指定URL时，建议使用数组或 命名路由。这些语法允许您利用CakePHP提供的反向路由功能。
此时，您应该能够将浏览器指向 http://localhost:8765/articles/index 。您应该能够看到正确格式化的文章标题和表格列表的列表视图。
创建查看动作¶
如果您在文章列表页面中点击“查看”链接之一，您将看到一个错误页面，上面显示着还没有实现该动作的信息。让我们来修复一下:
// 添加到现有的 src/Controller/ArticlesController.php 文件
public function view($slug = null)
{
$article = $this->Articles->findBySlug($slug)->firstOrFail();
$this->set(compact('article'));
}
虽然这是一个简单的动作，但我们使用了一些强大的CakePHP功能。我们首先使用 findBySlug() ，它是一个 动态查找器。该方法允许我们创建一个基本查询，通过给定的slug找到文章。然后，我们使用 firstOrFail() 来获取第一条记录，或抛出一个 NotFoundException 。
我们的动作接受一个 $slug 参数，但是这个参数从哪里来呢？如果用户请求 /articles/view/first-post ，那么值“first-post”将作为 $slug 通过CakePHP的路由和调度层传递。如果我们使用保存的新动作重新加载浏览器，我们将看到另一个CakePHP错误页面，告诉我们缺少一个视图模板；让我们来修复一下。
创建查看模板¶
让我们为我们的新的“查看”动作创建一个视图模板，并将其放在 templates/Articles/view.php 中:
<!-- 文件：templates/Articles/view.php -->
<h1><?= h($article->title) ?></h1>
<p><?= h($article->body) ?></p>
<p><small>Created: <?= $article->created->format(DATE_RFC850) ?></small></p>
<p><?= $this->Html->link('Edit', ['action' => 'edit', $article->slug]) ?></p>
您可以通过尝试在 /articles/index 上点击链接或手动访问URL（如 /articles/view/first-post ）来验证它是否正常工作。
添加文章¶
在创建了基本的读取视图之后，我们需要使新文章的创建成为可能。首先在 ArticlesController 中创建一个 add() 动作。我们的控制器现在应该如下所示:
<?php
// src/Controller/ArticlesController.php
namespace App\Controller;
use App\Controller\AppController;
class ArticlesController extends AppController
{
public function index()
{
$articles = $this->paginate($this->Articles);
$this->set(compact('articles'));
}
public function view($slug)
{
$article = $this->Articles->findBySlug($slug)->firstOrFail();
$this->set(compact('article'));
}
public function add()
{
$article = $this->Articles->newEmptyEntity();
if ($this->request->is('post')) {
$article = $this->Articles->patchEntity($article, $this->request->getData());
// 暂时硬编码user_id，并在构建身份验证时将其删除
$article->user_id = 1;
if ($this->Articles->save($article)) {
$this->Flash->success(__('Your article has been saved.'));
return $this->redirect(['action' => 'index']);
}
$this->Flash->error(__('Unable to add your article.'));
}
$this->set('article', $article);
}
}
下面是 add() 动作的功能：
如果请求的HTTP方法是POST，请尝试使用Articles模型保存数据。
如果由于某种原因保存失败，只需渲染视图。这样我们就有机会向用户显示验证错误或其他警告。
每个CakePHP请求都包含一个请求对象，可以使用 $this->request 来访问它。请求对象包含有关刚刚接收到的请求的信息。我们使用 Cake\Http\ServerRequest::is() 方法来检查请求是否为HTTP POST请求。
我们的POST数据可以在 $this->request->getData() 中获得。如果您想查看它的样子，可以使用 pr() 或 debug() 函数将其打印出来。为了保存我们的数据，我们首先将POST数据“marshal”到一个Article实体中。然后，使用我们之前创建的ArticlesTable持久化实体。
保存新文章后，我们使用FlashComponent的 success() 方法将消息设置到会话中。 success 方法是使用PHP的`魔术方法特性 <https://php.net/manual/en/language.oop5.overloading.php#object.call>`_ 提供的。Flash消息将在重定向后显示在下一页上。在我们的布局中，我们有 <?= $this->Flash->render() ?> ，它显示闪存消息并清除相应的会话变量。最后，在保存完成后，我们使用 Cake\Controller\Controller::redirect 将用户重定向到文章列表。参数 ['action' => 'index'] 转换为URL /articles ，即 ArticlesController 的index动作。您可以参考API中的 Cake\Routing\Router::url() 函数，以查看您可以为各种CakePHP函数指定URL的格式。
创建添加模板¶
下面是我们的添加视图模板:
<!-- 文件：templates/Articles/add.php -->
<h1>Add Article</h1>
<?php
echo $this->Form->create($article);
// 现在先硬编码用户。
echo $this->Form->control('user_id', ['type' => 'hidden', 'value' => 1]);
echo $this->Form->control('title');
echo $this->Form->control('body', ['rows' => '3']);
echo $this->Form->button(__('Save Article'));
echo $this->Form->end();
?>
我们使用FormHelper生成HTML表单的起始标签。下面是 $this->Form->create() 生成的HTML:
<form method="post" action="/articles/add">
因为我们调用 create() 而没有指定URL选项，所以 FormHelper 假设我们希望表单提交回当前动作。
$this->Form->control() 方法用于创建具有相同名称的表单元素。第一个参数告诉CakePHP它们对应的字段，第二个参数允许您指定各种选项 - 在这种情况下，文本区域的行数。这里使用了一些内省和约定。 control() 将根据指定的模型字段输出不同的表单元素，并使用词形变化生成标签文本。您可以使用选项自定义标签、输入或表单控件的任何其他方面。 $this->Form->end() 调用关闭了表单。
现在让我们返回并更新我们的 templates/Articles/index.php 视图，以包含一个新的“添加文章”链接。在 <table> 之前添加以下行:
<?= $this->Html->link('Add Article', ['action' => 'add']) ?>
添加简单的Slug生成¶
如果我们现在保存一篇文章，保存将失败，因为我们没有创建一个slug属性，而且该列是 NOT NULL 。Slug值通常是文章标题的URL安全版本。我们可以使用ORM的 :ref:`beforeSave()回调 <table-callbacks>`来填充我们的slug:
<?php
// 在 src/Model/Table/ArticlesTable.php 中
namespace App\Model\Table;
use Cake\ORM\Table;
// 引入Text类
use Cake\Utility\Text;
// 引入EventInterface类
use Cake\Event\EventInterface;
// 添加以下方法。
public function beforeSave(EventInterface $event, $entity, $options)
{
if ($entity->isNew() && !$entity->slug) {
$sluggedTitle = Text::slug($entity->title);
// 将slug修剪为模式中定义的最大长度
$entity->slug = substr($sluggedTitle, 0, 191);
}
}
这段代码很简单，没有考虑到重复的slug。但我们稍后会解决这个问题。
添加编辑动作¶
我们的应用程序现在可以保存文章，但我们不能编辑它们。让我们现在纠正一下。在您的 ArticlesController 中添加以下动作:
// 在 src/Controller/ArticlesController.php 中
// 添加以下方法。
public function edit($slug)
{
$article = $this->Articles
->findBySlug($slug)
->firstOrFail();
if ($this->request->is(['post', 'put'])) {
$this->Articles->patchEntity($article, $this->request->getData());
if ($this->Articles->save($article)) {
$this->Flash->success(__('Your article has been updated.'));
return $this->redirect(['action' => 'index']);
}
$this->Flash->error(__('Unable to update your article.'));
}
$this->set('article', $article);
}
此动作首先确保用户已尝试访问现有记录。如果他们没有传递 $slug 参数，或者文章不存在，将抛出一个 NotFoundException ，并且CakePHP的错误处理程序将呈现适当的错误页面。
接下来，动作检查请求是否为POST或PUT请求。如果是，则使用POST/PUT数据更新我们的文章实体，使用 patchEntity() 方法。最后，我们调用 save() ，设置适当的闪存消息，并重定向或显示验证错误。
创建编辑模板¶
编辑模板应该如下所示:
<!-- 文件：templates/Articles/edit.php -->
<h1>Edit Article</h1>
<?php
echo $this->Form->create($article);
echo $this->Form->control('user_id', ['type' => 'hidden']);
echo $this->Form->control('title');
echo $this->Form->control('body', ['rows' => '3']);
echo $this->Form->button(__('Save Article'));
echo $this->Form->end();
?>
此模板输出编辑表单（填充了值），以及任何必要的验证错误消息。
现在，您可以更新您的索引视图，添加链接以允许用户编辑特定的文章:
<!-- 文件：templates/Articles/index.php (添加编辑链接) -->
<h1>Articles</h1>
<p><?= $this->Html->link("Add Article", ['action' => 'add']) ?></p>
<table>
<tr>
<th>Title</th>
<th>Created</th>
<th>Action</th>
</tr>
<!-- 这里是我们通过$articles查询对象进行迭代的地方，打印出文章信息 -->
<?php foreach ($articles as $article): ?>
<tr>
<td>
<?= $this->Html->link($article->title, ['action' => 'view', $article->slug]) ?>
</td>
<td>
<?= $article->created->format(DATE_RFC850) ?>
</td>
<td>
<?= $this->Html->link('Edit', ['action' => 'edit', $article->slug]) ?>
</td>
</tr>
<?php endforeach; ?>
</table>
更新文章的验证规则¶
到目前为止，我们的文章没有进行输入验证。让我们通过使用 验证器 来修复这个问题:
// src/Model/Table/ArticlesTable.php
// 在命名空间声明下面添加此use语句，以导入Validator类
use Cake\Validation\Validator;
// 添加以下方法。
public function validationDefault(Validator $validator): Validator
{
$validator
->notEmptyString('title')
->minLength('title', 10)
->maxLength('title', 255)
->notEmptyString('body')
->minLength('body', 10);
return $validator;
}
validationDefault() 方法告诉CakePHP在调用 save() 方法时如何验证您的数据。在这里，我们指定标题和正文字段都不能为空，并具有一定的长度约束。
CakePHP的验证引擎功能强大且灵活。它提供了一套常用规则，用于处理电子邮件地址、IP地址等任务，并提供了添加自定义验证规则的灵活性。有关更多信息，请查看 Validation 文档。
现在，您的验证规则已经就位，请尝试向验证错误消息自动显示的表单中添加一个空标题或正文的文章，以查看它的工作原理。
添加删除动作¶
接下来，让我们为用户提供删除文章的方式。首先，在 ArticlesController 中添加一个 delete() 动作:
// src/Controller/ArticlesController.php
// 添加以下方法。
public function delete($slug)
{
$this->request->allowMethod(['post', 'delete']);
$article = $this->Articles->findBySlug($slug)->firstOrFail();
if ($this->Articles->delete($article)) {
$this->Flash->success(__('The {0} article has been deleted.', $article->title));
return $this->redirect(['action' => 'index']);
}
}
此逻辑删除由 $slug 指定的文章，并使用 $this->Flash->success() 在将用户重定向到 /articles 后显示确认消息。如果用户尝试使用GET请求删除文章， allowMethod() 将抛出异常。未捕获的异常将被CakePHP的异常处理程序捕获，并显示一个漂亮的错误页面。有许多内置的 Exceptions 可用于指示您的应用程序可能需要生成的各种HTTP错误。
由于我们只执行逻辑并重定向到另一个动作，因此此动作没有模板。您可能希望使用链接更新您的索引模板，以允许用户删除文章:
<!-- 文件：templates/Articles/index.php (添加删除链接) -->
<h1>Articles</h1>
<p><?= $this->Html->link("Add Article", ['action' => 'add']) ?></p>
<table>
<tr>
<th>Title</th>
<th>Created</th>
<th>Action</th>
</tr>
<!-- 这里是我们通过$articles查询对象进行迭代的地方，打印出文章信息 -->
<?php foreach ($articles as $article): ?>
<tr>
<td>
<?= $this->Html->link($article->title, ['action' => 'view', $article->slug]) ?>
</td>
<td>
<?= $article->created->format(DATE_RFC850) ?>
</td>
<td>
<?= $this->Html->link('Edit', ['action' => 'edit', $article->slug]) ?>
<?= $this->Form->postLink(
'Delete',
['action' => 'delete', $article->slug],
['confirm' => 'Are you sure?'])
?>
</td>
</tr>
<?php endforeach; ?>
</table>
使用 postLink() 将创建一个链接，使用JavaScript执行POST请求来删除我们的文章。
通过基本的文章管理设置，我们将创建 标签和用户表的基本动作。