README

它做什么？

使用 TCA 建造者，您可以轻松地以易于理解的方式创建或更改类型列表中的字段。

字段名称中的分号时间已经消失了。

例如

1. 为内容元素或任何其他记录的表单组合字段列表
2. 更改现有定义的类型

在 v1.6.0 中引入 TcaCreator

使用 TCA 创建者，您可以从头创建 TCA 表单，无需考虑默认字段的配置，如 ctrl 部分，或 columns 部分的默认字段。

更多示例请参见 示例部分

安装

通过 composer 安装

composer require spooner-web/tcabuilder

:warning: 在 composer 安装中，包不会在 typo3conf/ext 文件夹中，而是在 vendor 中

通过经典模式安装

1. 前往 https://extensions.typo3.org/extension/tcabuilder
2. 下载 ZIP 文件
3. 使用非 composer 模式将其上传到您的 TYPO3 实例

通过扩展管理器安装

1. 更新您的扩展列表
2. 搜索“tcabuilder”
3. 安装

Composer 无法检出此包

由于 composer 无法检测自托管 GitLab 实例的 ZIP 存档，当部署或构建使用此包的项目时可能会出现问题。

要修复此问题，您需要将 GitLab 内置 packagist API 添加到项目 composer.json 的 repositories 部分

{
	"type": "composer",
	"url": "https://git.spooner.io/api/v4/group/8/-/packages/composer/"
}

使用方法

通用用法

建议在您的扩展 Configuration/TCA/Overrides/ 文件夹的 php 文件中使用 TcaBuilder。

1. 实例化 TcaBuilder 类
2. 设置要配置的表和类型（也可能是一个尚不存在类型）
3. 使用方法进行操作
4. 保存到 TCA
5. 刷新缓存
6. 查看结果

方法

主要方法

操作类型

操作调色板

辅助方法

定位字段、调色板或div的可能值

示例（TCA构建器）

添加自定义内容元素

$tcaBuilder = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance(\SpoonerWeb\TcaBuilder\TcaBuilder::class);
$tcaBuilder
    ->setTable('tt_content') // define table
    ->setType('test') // define type
    ->addDiv('General')
    ->addField('header', '', 'Top header!!')
    ->addField('bodytext')
    ->addField('subheader', 'after:header')
    ->addField('layout', 'before:header')
    ->addDiv('Extra')
    ->addPalette('access')
    ->addPalette('hidden', 'after:bodytext', 'Alternative label')
    ->saveToTca(); // save to TCA

更改现有配置

$tcaBuilder = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance(\SpoonerWeb\TcaBuilder\TcaBuilder::class);
$tcaBuilder
    ->setTable('pages') // define table
    ->setType(\TYPO3\CMS\Frontend\Page\PageRepository::DOKTYPE_LINK) // define type
    ->load() // load definitions
    ->removeField('doktype')
    ->removePalette('external')
    ->removeDiv(1)
    ->addPalette('external', 'after:--palette--;;layout')
    ->saveToTca(); // save back to TCA

$tcaBuilder = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance(\SpoonerWeb\TcaBuilder\TcaBuilder::class);
$tcaBuilder
    ->loadConfiguration('pages', \TYPO3\CMS\Frontend\Page\PageRepository::DOKTYPE_MOUNTPOINT)
    ->removeDiv('LLL:EXT:frontend/Resources/Private/Language/locallang_tca.xlf:pages.tabs.metadata')
    ->movePalette('title', 'after:' . $tcaBuilder->getPaletteString('abstract'), 'New title')
    ->addOverride(
        'title',
        [
            'label' => 'New title',
            'config' => [
                'renderType' => 'inputLink'
            ]
        ]
    )
    ->saveToTca();

使用语言文件

$tcaBuilder = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance(\SpoonerWeb\TcaBuilder\TcaBuilder::class);
$tcaBuilder
    ->loadConfiguration('pages', \TYPO3\CMS\Frontend\Page\PageRepository::DOKTYPE_MOUNTPOINT)
    ->useLocalLangFile('EXT:my_extension/Resources/Private/Language/locallang.xlf')
    ->addField('new_field', '', 'LANG:new_field') // Used label: "LLL:EXT:my_extension/Resources/Private/Language/locallang.xlf:new_field"
    ->saveToTca();

进行最小更改

$tcaBuilder = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance(\SpoonerWeb\TcaBuilder\TcaBuilder::class);
$tcaBuilder
    ->loadConfiguration('tt_content', 'textmedia')
    ->removePalette('headers')
    ->saveToTca();

示例（Tca Creator）

在自定义扩展内创建新表的TCA配置

// Returns the default values of ctrl section
// By default language, version and sorting options are set
// These options can be unset and additional overridden fields can be set
$configuration['ctrl'] = \SpoonerWeb\TcaBuilder\TcaCreator::getControlConfiguration(
    'title',
    'label'    
);

// Returns the default columns depending on the ctrl section configuration
// Example: If ctrl section includes language, this method returns the field configuration
// for all language fields (sys_language_uid, l10n_parent, l10n_diffsource, l10n_source)
$configuration['columns'] = \SpoonerWeb\TcaBuilder\TcaCreator::getColumnsConfiguration(
    $configuration['ctrl'],
    'tx_extension_domain_model_record',
    [
        'title' => [
            'label' => 'My label',
            'config' => [
                'type' => 'input'
            ]
        ]
    ]
);

// Uses TcaBuilder class to create the configuration for the TCA form
$configuration['types'][] = \SpoonerWeb\TcaBuilder\TcaCreator::buildTypesConfiguration()
    ->addDiv('General')
    ->addField('title')
    ->addField('subtitle')
    ->addDiv('Categories')
    ->addField('categories')
    ->returnAsArray();
    
// Now return TCA configuration
return $configuration;