TYPO3 CMS Styleguide 使用教程

TYPO3 CMS Styleguide 使用教程

styleguide[READ-ONLY] Subtree split of the TYPO3 Core Extension "styleguide"项目地址:https://gitcode.com/gh_mirrors/styleguide2/styleguide

1. 项目的目录结构及介绍

typo3_cms_styleguide/
├── Classes/
│   ├── Controller/
│   ├── Domain/
│   ├── Service/
│   └── Utility/
├── Configuration/
│   ├── AdditionalConfiguration.php
│   ├── PackageStates.php
│   ├── Settings.php
│   └── TCA/
├── Resources/
│   ├── Private/
│   │   ├── Language/
│   │   ├── Layouts/
│   │   ├── Partials/
│   │   └── Templates/
│   └── Public/
│       ├── Css/
│       ├── Images/
│       ├── JavaScript/
│       └── Icons/
├── Tests/
│   ├── Unit/
│   └── Functional/
├── composer.json
├── ext_emconf.php
├── ext_localconf.php
├── ext_tables.php
└── README.md

目录结构介绍

• Classes/: 包含项目的所有类文件，如控制器、领域模型、服务和工具类。
• Configuration/: 包含项目的配置文件，如数据库配置、包状态和TCA配置。
• Resources/: 包含项目的私有资源（如语言文件、布局、部分和模板）和公共资源（如CSS、图像、JavaScript和图标）。
• Tests/: 包含项目的单元测试和功能测试。
• composer.json: Composer 包管理文件。
• ext_emconf.php: 扩展的元数据配置文件。
• ext_localconf.php: 扩展的本地配置文件。
• ext_tables.php: 扩展的表配置文件。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

ext_localconf.php

<?php
if (!defined('TYPO3_MODE')) {
    die('Access denied.');
}

// 注册扩展的配置
\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addTypoScriptSetup(
    '<INCLUDE_TYPOSCRIPT: source="FILE:EXT:styleguide/Configuration/TypoScript/setup.txt">'
);

ext_tables.php

<?php
if (!defined('TYPO3_MODE')) {
    die('Access denied.');
}

// 注册扩展的表配置
\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addLLrefForTCAdescr(
    'tx_styleguide_domain_model_example',
    'EXT:styleguide/Resources/Private/Language/locallang_csh_tx_styleguide_domain_model_example.xlf'
);

3. 项目的配置文件介绍

composer.json

{
    "name": "typo3-cms/styleguide",
    "type": "typo3-cms-extension",
    "description": "TYPO3 CMS Styleguide",
    "require": {
        "typo3/cms-core": "^10.4"
    },
    "autoload": {
        "psr-4": {
            "TYPO3\\CMS\\Styleguide\\": "Classes/"
        }
    }
}

ext_emconf.php

<?php
$EM_CONF[$_EXTKEY] = [
    'title' => 'Styleguide',
    'description' => 'TYPO3 CMS Styleguide',
    'category' => 'example',
    'state' => 'stable',
    'clearCacheOnLoad' => 1,
    'version' => '1.0.0',
    'constraints' => [
        'depends' => [
            'typo3' => '10.4.0-10.4.99',
        ],
    ],
];

Configuration/AdditionalConfiguration.php

<?php
// 额外的配置设置
$GLOBALS['TYPO3_CONF_VARS']['SYS']['sitename'] = 'Styleguide Site';

以上是 TYPO3 CMS Styleguide 项目的目录结构、启动文件和配置文件的详细介绍。希望这些信息能帮助你更好地理解和使用该项目。

styleguide[READ-ONLY] Subtree split of the TYPO3 Core Extension "styleguide"项目地址:https://gitcode.com/gh_mirrors/styleguide2/styleguide