README

Yii 应用程序模板

为快速创建项目，Yii 3 应用程序模板是最佳选择

要求

• PHP 8.1 或更高版本。

安装

如果您没有 Composer，您可以通过在 getcomposer.org 上查看说明来安装它。

然后，您可以使用以下命令安装此项目模板

composer create-project --stability=dev yiisoft/app <your project>

为了启动开发网络服务器，请运行

composer run serve

现在，您应该可以通过控制台打印的 URL 访问应用程序。通常它是 http://localhost:8080。

目录结构

应用程序模板具有以下结构

config/             Configuration files.
docs/               Documentation.
public/             Files publically accessible from the Internet.
    assets/         Published assets.
    index.php       Entry script.
resources/          Application resources.
    assets/         Asset bundle resources.
    layout/         Layout view templates.
    messages/
    views/          View templates.
runtime/            Files generated during runtime.
src/                Application source code.
    Asset/          Asset bundle definitions.
    Command/        Console commands.
    Controller/     Web controller classes.
    EventHandler/
    Handler/
    ViewInjection/
tests/              A set of Codeception tests for the application.
vendor/             Installed Composer packages.

配置

您可以在 config 目录中找到配置。有多种配置，其中最有趣的是 common\params.php。以下是其各个部分的详细信息

应用程序服务

有多个预配置的应用程序服务。

别名

'yiisoft/aliases' => [
    'aliases' => [
        // standard directory aliases
        '@root' => dirname(__DIR__),
        '@assets' => '@root/public/assets',
        '@assetsUrl' => '/assets',
        '@npm' => '@root/node_modules',
        '@public' => '@root/public',
        '@resources' => '@root/resources',
        '@runtime' => '@root/runtime',
        '@views' => '@root/resources/views'
    ],
],

请参阅指南中的 "别名"。

缓存

'yiisoft/cache-file' => [
    'file-cache' => [
        // cache directory path
        'path' => '@runtime/cache'
    ],
],

日志目标文件

use Psr\Log\LogLevel;

'yiisoft/log-target-file' => [
    'file-target' => [
        // route directory file log
        'file' => '@runtime/logs/app.log',
        // levels logs target
        'levels' => [
            LogLevel::EMERGENCY,
            LogLevel::ERROR,
            LogLevel::WARNING,
            LogLevel::INFO,
            LogLevel::DEBUG,
        ],
    ],
    'file-rotator' => [
        // maximum file size, in kilo-bytes. Defaults to 10240, meaning 10MB.
        'maxfilesize' => 10,
        // number of files used for rotation. Defaults to 5.
        'maxfiles' => 5,
        // the permission to be set for newly created files.
        'filemode' => null,
        // Whether to rotate files by copy and truncate in contrast to rotation by renaming files.
        'rotatebycopy' => null
    ],
],

请参阅指南中的 "日志记录"。

会话

'yiisoft/session' => [
    'session' => [
        // options for cookies
        'options' => ['cookie_secure' => 0],
        // session handler
        'handler' => null
    ],
],

视图

'yiisoft/view' => [
    // Custom parameters that are shared among view templates.
    'defaultParameters' => [
        'applicationParameters' => 'App\ApplicationParameters',
        'assetManager' => 'Yiisoft\Assets\AssetManager',
    ],
    'theme' => [
        // Apply pathMap example: ['@resources/layout' => '@resources/theme'] in yiisoft/app
        // Apply pathMap example: ['@resources/layout' => '@modulealiases/theme'] in module
        'pathMap' => [],
        'basePath' => '',
        'baseUrl' => '',
    ],    
],

Yii 调试

'yiisoft/yii-debug' => [
    // enabled/disabled debugger
    'enabled' => true
],

应用程序布局参数

'app' => [
    'charset' => 'UTF-8',
    'language' => 'en',
    'name' => 'My Project',
],

测试

模板附带可立即使用的 Codeception 配置。要执行测试，请运行

composer run serve > ./runtime/yii.log 2>&1 &
vendor/bin/codecept run

静态分析

代码使用 Psalm 进行静态分析。要运行静态分析

./vendor/bin/psalm

支持

如果您需要帮助或有任何问题，请访问 Yii 论坛。您还可以查看其他 Yii 社区资源。

许可

Yii 应用程序模板是免费软件。它根据 BSD 许可证发布。有关更多信息，请参阅 LICENSE。

由 Yii 软件 维护。

支持项目

关注更新