Sulu Skeleton 项目安装与使用教程

Sulu Skeleton 项目安装与使用教程

skeleton Project template for starting your new project based on the Sulu content management system 项目地址: https://gitcode.com/gh_mirrors/skeleton4/skeleton

1. 项目目录结构及介绍

Sulu Skeleton 项目是基于 Sulu 内容管理系统的一个项目模板，其目录结构如下：

sulu/skeleton/
├── admin/                 # 管理后台相关文件
├── bin/                   # 可执行脚本
├── config/                # 配置文件
├── public/                # 公共文件，如入口文件
├── src/                   # 源代码目录
├── templates/             # 模板文件
├── tests/                 # 测试文件
├── translations/          # 翻译文件
├── var/                   # 存储日志、缓存等
│   ├── env/               # 环境配置文件
│   ├── stage/            # 阶段环境配置文件
│   ├── test/             # 测试环境配置文件
├── .gitattributes         # Git 属性配置
├── .gitignore             # Git 忽略文件配置
├── LICENSE                # 许可证文件
├── README.md              # 项目说明文件
├── composer.json          # Composer 配置文件
├── phpunit.xml.dist       # PHPUnit 配置文件
├── rector.php             # Rector 配置文件
├── symfony.lock           # Symfony 锁文件

目录详细介绍

• admin/: 包含管理后台的静态资源和前端代码。
• bin/: 包含可执行脚本，如用于启动项目的命令。
• config/: 包含项目的配置文件，如路由、服务配置等。
• public/: 包含项目的公共文件，如入口文件 index.php。
• src/: 包含项目的源代码，如控制器、实体等。
• templates/: 包含项目的模板文件，用于渲染页面。
• tests/: 包含项目的测试代码。
• translations/: 包含项目的翻译文件。
• var/: 用于存储日志、缓存等临时文件。
• .gitattributes 和 .gitignore: 用于配置 Git 的属性和忽略文件。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文件。
• composer.json: Composer 配置文件，用于管理依赖。
• phpunit.xml.dist: PHPUnit 测试框架的配置文件。
• rector.php: Rector 代码重构工具的配置文件。
• symfony.lock: Symfony 锁文件，用于锁定依赖版本。

2. 项目的启动文件介绍

项目的启动文件通常位于 public/ 目录下，主要是 index.php 文件。该文件是项目的入口点，负责初始化和运行应用程序。

public/index.php 示例

<?php

use App\Kernel;

require_once dirname(__DIR__).'/vendor/autoload.php';

$kernel = new Kernel('dev', true);
$request = \Symfony\Component\HttpFoundation\Request::createFromGlobals();
$response = $kernel->handle($request);
$response->send();
$kernel->terminate($request, $response);

启动文件说明

• autoload.php: 引入 Composer 的自动加载文件，用于加载项目依赖。
• Kernel: 项目的主内核类，负责处理请求和响应。
• Request: 创建一个全局请求对象。
• handle: 处理请求并返回响应。
• send: 发送响应。
• terminate: 终止请求处理。

3. 项目的配置文件介绍

项目的配置文件主要位于 config/ 目录下，包含多种配置，如路由、服务、数据库等。

主要配置文件

• config/packages/*.yaml: 包含不同功能的配置文件，如 framework.yaml、doctrine.yaml 等。
• config/routes.yaml: 路由配置文件，定义了项目的路由规则。
• config/services.yaml: 服务配置文件，定义了项目的服务和服务容器。

示例配置

config/packages/framework.yaml

framework:
    secret: '%env(APP_SECRET)%'
    router:
        utf8: true
    csrf_protection: true
    form: true
    session:
        handler_id: session.handler.native_file
        save_path: '%kernel.project_dir%/var/cache/session'
    serializer:
        enabled: true

config/routes.yaml

app_homepage:
    path: /
    controller: App\Controller\DefaultController::index

config/services.yaml

services:
    _defaults:
        autowire: true
        autoconfigure: true
    App\Controller\:
        resource: '../src/Controller/'
        tags: ['controller.service_arguments']

配置文件说明

• **

skeleton Project template for starting your new project based on the Sulu content management system 项目地址: https://gitcode.com/gh_mirrors/skeleton4/skeleton