Rapid Development of Zend Expressive Modules

Zend Expressive Module Quick Development Guide: Building Read-Only Blog Module

This article will share some Zend Expressive module development tips to help you quickly build a fully functional read-only blog module. Make sure you have set up the development environment according to the previous tutorial, including installing and configuring Zend Expressive, Doctrine, Gulp and abstract reflection factory (about 10 minutes).

In this tutorial, we will quickly build a simple read-only blog module (list blog posts from the database) to demonstrate the rapid development capabilities of Zend Expressive.

Module settings

Run the following command in your Expressive application:

<code class="language-bash">./vendor/bin/expressive module:create Blog</code>

This will generate the basic code of the Blog module and automatically register it in your application and Composer autoloader.

Doctrine entities and database tables

Next, create the Blog entity and database table. First, we need to let the application know that the module provides the Doctrine entity.

Open src/Blog/src/ConfigProvider.php and add the following code:

<code class="language-php">public function __invoke()
{
    return [
        'dependencies' => $this->getDependencies(),
        'doctrine'     => $this->getDoctrine(),
        'templates'    => $this->getTemplates(),
    ];
}

public function getDoctrine(): array
{
    return [
        'driver' => [
            'orm_default' => [
                'drivers' => [
                    'Blog\Entity' => 'blog_entity',
                ],
            ],
            'blog_entity' => [
                'class' => \Doctrine\ORM\Mapping\Driver\SimplifiedYamlDriver::class,
                'cache' => 'array',
                'paths' => [
                    dirname(__DIR__) . '/config/doctrine' => 'Blog\Entity',
                ],
            ],
        ],
    ];
}</code>

Create the src/Blog/config/doctrine file in the BlogPost.orm.yml directory, with the following content:

<code class="language-yaml">---
Blog\Entity\BlogPost:
  type: entity
  table: blog_post
  id:
    id:
      type: integer
      generator:
        strategy: AUTO
  fields:
    title:
      type: string
      length: 255
    content:
      type: string
      length: 16777215</code>

Run./vendor/bin/doctrine orm:generate-entities src. Since Doctrine does not support the directory structure of the PSR-4 standard, it is necessary to move src/Blog/Entity to src/Blog/src/Entity. Then run the following command to create the database table:

<code class="language-bash">./vendor/bin/doctrine orm:schema-tool:create</code>

You can run the following SQL statement to populate the database table:

<code class="language-sql">INSERT INTO expressive.blog_post VALUES 
(null, 'Post 1', 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.'),
(null, 'Post 2', 'Mauris in libero laoreet, euismod lorem eget, tincidunt justo.'),
(null, 'Post 3', 'Donec sed diam congue, ultrices tellus at, venenatis felis.');</code>

Route settings

Expressive module does not directly register routes. We need to use a small trick to achieve it: create a src/Blog/src/Factory/RoutesDelegator.php file, with the following content:

<code class="language-php"><?php
namespace Blog\Factory;

use Blog\Action;
use Psr\Container\ContainerInterface;
use Zend\Expressive\Application;

class RoutesDelegator
{
    public function __invoke(ContainerInterface $container, $serviceName, callable $callback)
    {
        $app = $callback();
        include __DIR__ . '/../../config/routes.php';
        return $app;
    }
}</code>

Add the following code in src/Blog/src/ConfigProvider.php's getDependencies() method:

<code class="language-php">'delegators' => [
    \Zend\Expressive\Application::class => [
        Factory\RoutesDelegator::class,
    ],
],</code>

Create src/Blog/config/routes.phpFile and add blog route:

<code class="language-php"><?php

use Blog\Action;

$app->get('/blog', Action\BlogPostListAction::class, 'blog_post_list');
$app->get('/blog/view/:blog_post_id', Action\BlogPostViewAction::class, 'blog_post_view');</code>

Action and templates

Next, create an Action to handle the routing request and create a template file. (The Action and template code are the same as the original text, omitted here, please refer to the original text.)

The implementation of creation, editing and deletion functions is reserved for exercises.

Summary

This tutorial shows the ease of quickly building a read-only blog module with Zend Expressive. With just a few files and a few minutes of work, you can create a list page that displays articles from the database and prepare for subsequent additions such as /edit and /delete.

(The following are the original FAQs section, slightly adjusted)

Zend Expressive Rapid Development FAQ

• What is Zend Expressive? Zend Expressive is a PHP-based mini middleware framework built on Zend Stratigility and supports PSR-7 middleware.

• How to install Zend Expressive? Using Composer: composer require zendframework/zend-expressive

• The advantages of Zend Expressive? Rapid development, simple and flexible, supports various application types (microservices to single-body applications), and supports a variety of routing and template systems.

• How to create modules in Zend Expressive? Create a new directory under the src directory of the application, including the ConfigProvider class, and return the module configuration array (including dependencies, routes, and templates).

• How to add a route in Zend Expressive? Add a new entry in the ConfigProvider key of the configuration array of the module routes class.

• How to use templates in Zend Expressive? Zend Expressive supports a variety of template engines (Twig, Plates, Zend View). Add an entry in the ConfigProvider key of the configuration array of the templates class.

• How to handle errors in Zend Expressive? Zend Expressive contains default error handling middleware. You can create custom middleware to handle errors.

• How to test Zend Expressive app? Use PHPUnit.

• How to deploy Zend Expressive applications? Deploy like any other PHP application, you can use Apache, Nginx, or PHP built-in servers.

• Where can I find more resources about Zend Expressive? Zend Framework official website, Zend Expressive documentation and Zend Framework community forum.

The above is the detailed content of Rapid Development of Zend Expressive Modules. For more information, please follow other related articles on the PHP Chinese website!