README

dartmoon/prestashop-module-toolkit is the shared runtime package for the module skeleton. It combines assets, configuration, hooks, console commands, tabs, forms, renderers, filters, downloaders, logging and catalog import helpers in one Composer dependency, while retaining their Dartmoon\… namespaces. The toolkit contains no module build tools.

Documentation

Start with the documentation index and getting started guide. Each library has a usage guide:

Requirements

PHP 8.1+ with the tested PrestaShop 9.2.0 host APIs. Symfony Console is supplied by PrestaShop (6.4 in 9.2); it is a development dependency here, not a second Symfony installation inside every module. Future PrestaShop versions require the integration suite to be rerun; this package does not claim untested future compatibility.

composer require dartmoon/prestashop-module-toolkit:^1.0

Before publication, use a Composer path repository with symlink: false and options.versions.dartmoon/prestashop-module-toolkit: 1.0.0; the skeleton's php bin/module setup --toolkit-path=/path/to/prestashop-module-toolkit does this. Composer replace entries prevent duplicate component packages.

Components

Assets

return \Dartmoon\Assets\AssetManager::forModule($module)->render([
    '_dev/scss/front.scss',
    '_dev/js/front.js',
]);

Resolves Vite's views/assets/manifest.json, including hashed filenames and CSS from static imports. Returns escaped stylesheet links and JavaScript module tags for display hooks. url($entry) resolves an individual public URL. Missing builds are optional; invalid manifests and missing entries report errors.

Config

$config = new \Dartmoon\Config\Config(__DIR__ . '/config');
$value = $config->get('module.api.timeout', 10);

PHP config files return arrays. Dot paths support arbitrary depth and preserve explicit null and false. Files are cached per repository instance and file names cannot traverse directories. Inject a repository for each module. Scoped facade access uses Config::for($module)->get(...); swap($module, $repository) binds a custom instance.

Console

Extend Dartmoon\Console\AbstractCommand, implement execute(): int, and register the command as a Symfony service (the skeleton has an example). $name and $description are configured by the base command. $name and $description remain supported. A custom constructor must call parent::__construct().

Hooks

Extend Dartmoon\Hooks\AbstractHookGroup, set $hooks to canonical PrestaShop names and implement matching public methods accepting an array. Put group classes in the module's $hooks list and use HasHookDispatcher.

Registration validates handlers; lookup is case insensitive. Multiple groups can handle display hooks and their strings are concatenated in registration order. A single handler's return value is preserved, including arrays or booleans; multiple handlers returning structured values throw rather than silently discarding data. Unknown hooks return null for PrestaShop's hook probing; non-hook method typos throw BadMethodCallException. Use canonical hook names rather than legacy aliases (for example, actionFrontControllerSetMedia for asset registration).

Tabs

$tabs = new \Dartmoon\TabManager\TabManager();
$tabs->install([
    ['class_name' => 'AdminMyModule', 'name' => ['en' => 'My module', 'it' => 'Il mio modulo']],
    ['class_name' => 'AdminMyModuleSettings', 'name' => 'Settings',
     'parent_class_name' => 'AdminMyModule', 'route_name' => 'my_module_settings'],
], $module);

Uses the public Tab ObjectModel API, including ACL creation, without depending on a Symfony container or internal Doctrine repositories. Supports icon, visible (defaults to true), wording and wording_domain. Declare parents before children; a missing parent or a tab owned by another module is an error. Repeated installation preserves existing tabs owned by this module. Newly created tabs are rolled back on failure. uninstallForModule($module) removes children first and reports failures; uninstall($definitions) is idempotent. Choose this manager or native Module::$tabs for each tab, not both.

Multilingual text

Dartmoon\Utils\MultiLangText::generate() accepts a string or translation array. Resolution uses locale, language code, ISO code, then numeric language ID; missing translations use the first provided value. An empty array produces empty strings. Disabled languages are included. Load the class using Composer and the case-sensitive MultiLangText.php filename.

Development

composer install
composer test
node --test tests/forms.test.mjs

Unit tests cover configuration isolation and traversal, hook dispatch and return values, console execution, translations, tab ownership, retries, rollback and uninstall failures. The skeleton additionally tests production scoping and two modules loaded in the same process.

See extension points, the complete API reference and testing. The native integration test exercises catalog writes, image rollback, forms, lists and Smarty against a local test shop:

php -d memory_limit=1G tests/integration/prestashop.php /path/to/prestashop

It creates temporary catalog records and removes them in finally; run it on a development installation. FTP failure paths use test doubles without a network server.

dartmoon / prestashop-module-toolkit

Package info

Security

Statistics