README

Base foundation extension for Maispace TYPO3 projects. Provides shared TypoScript configuration, page layout definitions, and pulls in all TYPO3 backend/infrastructure extensions that the project requires. Mail dispatch is handled by mai_mail — no external mail queue package is declared here.

Requires: TYPO3 13.4 LTS / 14.1 · PHP 8.2+

Installation

composer require maispace/mai-base

Development

Linting

composer lint:check     # Run all linters
composer lint:fix       # Fix auto-fixable issues

Testing

composer test           # Run all tests
composer test:unit      # Run unit tests only

Shared Icon Contract

mai_base provides three generic SVG icons that every other maispace extension uses as its default backend icons. Extensions depend on mai_base being loaded first; the icons and their pre-registered TYPO3 identifiers are then available globally.

Icon files

Pre-registered identifiers

mai_base/Configuration/Icons.php registers the following identifiers globally the moment the extension is loaded. Downstream extensions must not redeclare these identifiers.

Usage patterns

1 — TCA record icon (->setIconFile())

Use the raw SVG path directly in the TCA builder chain:

// Configuration/TCA/tx_myext_myrecord.php
$builder
    ->setLabel('title')
    ->setIconFile('EXT:mai_base/Resources/Public/Icons/generic_table.svg');

Alternatively, register an extension-specific identifier in Configuration/Icons.php pointing to the shared source, then reference that identifier from TCA:

// Configuration/Icons.php
return [
    'tx_myext_myrecord' => [
        'provider' => \TYPO3\CMS\Core\Imaging\IconProvider\SvgIconProvider::class,
        'source'   => 'EXT:mai_base/Resources/Public/Icons/generic_table.svg',
    ],
];

2 — Content element / plugin icon

Pass the pre-registered 'mai-content' identifier when registering a CType:

// Configuration/TCA/Overrides/tt_content.php
(new CType('maispace_myplugin', $lang('ctype.myplugin'), 'mai-content'))
    ->addDefaultHeaderPalette()
    ->register();

3 — Backend module icon

Set iconIdentifier to the pre-registered 'mai-backend-module' value:

// Configuration/Backend/Modules.php
return [
    'mai_myext' => [
        'parent'          => 'tools',
        'iconIdentifier'  => 'mai-backend-module',
        // …
    ],
];

Rules

• Use the shared icons during extension scaffolding — creating a unique icon per extension is optional and only required once a distinct visual identity is needed.
• Never re-register mai-table, mai-content, mai-backend-module, or mai-extension in a downstream extension — the mai-* namespace is reserved for mai_base.
• Never declare scssphp/scssphp or symfony/mailer in this extension — see the architecture constraints in AGENTS.md.

License

GPL-2.0-or-later — see LICENSE for details.