Step 1: Create the module class<\/strong><\/p>\n\n\n\n here, we have created the module class file “wkcreatedemoproduct\/wkcreatedemoproduct.php<\/strong>“<\/p>\n\n\n\n In this class, we are initializing the module, controllers tab, and redirecting the configuration page to modern page routes. <\/p>\n\n\n\n Also, note that we are using a new translation system in this example module. Please refer to the documentation<\/a> for more information.<\/p>\n\n\n\n Step 2: Define routes<\/strong><\/p>\n\n\n\n Create routes.yml file inside the wkcreatedemoproduct\/config<\/strong> folder<\/p>\n\n\n\n In this file, we have provided the path from the legacy controller to the modern page controller<\/p>\n\n\n\n <\/p>\n\n\n\n Step 3: Define services<\/strong><\/p>\n\n\n\n Create a services.yml file inside the wkcreatedemoproduct\/config <\/strong>folder<\/p>\n\n\n\n In the given code, we have defined our own services. These will be used for form creation and form handling. Each service is created inside the wkcreatedemoproduct\\Form<\/strong> folder<\/p>\n\n\n\n Step: 4<\/strong> Create services class<\/strong><\/p>\n\n\n\n Now create a service class in the wkcreatedemoproduct\\Form<\/strong><\/strong> folder<\/p>\n\n\n\n i) First service (demo_configuration_text) class DemoConfigurationTextType is created for form view<\/p>\n\n\n\n ii) Second service (demo_configuration_text_data_configuration) class DemoConfigurationTextDataConfiguration is created for the data process<\/p>\n\n\n\n iii) Third service (demo_configuration_text_form_data_provider) class DemoConfigurationTextFormDataProvider is created for getter and setter purpose<\/p>\n\n\n\n Step 5:<\/strong> Create a controller <\/strong><\/p>\n\n\n\n DemoProductConfigurationController<\/strong> controller is created to handle the request, It must be inside the wkcreatedemoproduct\/src\/Controller<\/strong> folder<\/p>\n\n\n\n Step 6: Create view<\/strong><\/p>\n\n\n\n Twig file form.html.twig <\/strong>path: wkcreatedemoproduct\/views\/templates\/admin\/<\/p>\n\n\n\n Step 7: Define the composer file<\/strong><\/p>\n\n\n\n Create composer.json<\/strong> file for autoloading<\/p>\n\n\n\n Step 8: Installation<\/strong><\/p>\n\n\n\n Copy created a module on the modules directory of PrestaShop and run the composer command composer install<\/strong> to install all dependencies. The complete module folder structure is attached in the screenshot.<\/p>\n\n\n\n After installing the module, you will controller tab in the left menu sidebar and the configuration form<\/p>\n\n\n\n In the above example, we have created some fields using components, check the documentation<\/a> for more information.<\/p>\n\n\n\n That\u2019s all about this blog.<\/p>\n\n\n\n If any issues or doubts please feel free to mention them in the comment section.<\/p>\n\n\n\n I would be happy to help.<\/p>\n\n\n\n Also, you can explore our PrestaShop Development Services<\/a> & a large range of quality PrestaShop Modules<\/a>.<\/p>\n\n\n\n For any doubt contact us at support@webkul.com<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"declare(strict_types=1);\n\nuse PrestaShop\\PrestaShop\\Adapter\\SymfonyContainer;\n\nclass WkCreateDemoProduct extends Module\n{\n public function __construct()\n {\n $this->name = 'wkcreatedemoproduct';\n $this->author = 'Webkul';\n $this->version = '1.0.0';\n $this->need_instance = 0;\n\n $this->bootstrap = true;\n parent::__construct();\n\n $this->displayName = $this->trans('Create demo products', [], 'Modules.Wkcreatedemoproduct.Admin');\n $this->description = $this->trans(\n 'Module created for the Demo product creation purpose on PrestaShop store',\n [],\n 'Modules.Wkcreatedemoproduct.Admin'\n );\n\n $this->ps_versions_compliancy = ['min' => '8.0.0', 'max' => '8.99.99'];\n }\n\n public function getTabs()\n {\n return [\n [\n 'class_name' => 'AdminWkCreateDemoProduct', \/\/ Creating tab in admin menu\n 'visible' => true,\n 'name' => 'Demo Product Data',\n 'parent_class_name' => 'CONFIGURE',\n ]\n ];\n }\n\n public function getContent()\n {\n $route = SymfonyContainer::getInstance()->get('router')->generate('demo_product_configuration_form');\n \/\/ redirecting to controller, symfony route\n Tools::redirectAdmin($route);\n }\n\n public function isUsingNewTranslationSystem()\n {\n \/\/ Used this for new translations system, It will avoid redirection of translation page on legacy controller\n return true;\n }\n}<\/pre>\n\n\n\ndemo_product_configuration_form:\n path: \/wkcreatedemoproduct\/configuration\n methods: [GET, POST]\n defaults:\n _controller: 'PrestaShop\\Module\\WkCreateDemoProduct\\Controller\\DemoProductConfigurationController::index'\n # Needed to work with tab system\n _legacy_controller: AdminWkCreateDemoProduct\n _legacy_link: AdminWkCreateDemoProduct<\/pre>\n\n\n\n
services:\n _defaults:\n public: true\n prestashop.module.wkcreatedemoproduct.form.type.demo_configuration_text:\n class: 'PrestaShop\\Module\\WkCreateDemoProduct\\Form\\DemoConfigurationTextType'\n parent: 'form.type.translatable.aware'\n public: true\n tags:\n - { name: form.type }\n\n prestashop.module.wkcreatedemoproduct.form.demo_configuration_text_form_data_provider:\n class: 'PrestaShop\\Module\\WkCreateDemoProduct\\Form\\DemoConfigurationTextFormDataProvider'\n arguments:\n - '@prestashop.module.wkcreatedemoproduct.form.demo_configuration_text_data_configuration'\n\n prestashop.module.wkcreatedemoproduct.form.demo_configuration_text_form_data_handler:\n class: 'PrestaShop\\PrestaShop\\Core\\Form\\Handler'\n arguments:\n - '@form.factory'\n - '@prestashop.core.hook.dispatcher'\n - '@prestashop.module.wkcreatedemoproduct.form.demo_configuration_text_form_data_provider'\n - 'PrestaShop\\Module\\WkCreateDemoProduct\\Form\\DemoConfigurationTextType'\n - 'DemoConfiguration'\n\n prestashop.module.wkcreatedemoproduct.form.demo_configuration_text_data_configuration:\n class: PrestaShop\\Module\\WkCreateDemoProduct\\Form\\DemoConfigurationTextDataConfiguration\n arguments: ['@prestashop.adapter.legacy.configuration']<\/pre>\n\n\n\ndeclare(strict_types=1);\n\nnamespace PrestaShop\\Module\\WkCreateDemoProduct\\Form;\n\nuse PrestaShopBundle\\Form\\Admin\\Type\\FormattedTextareaType;\nuse PrestaShopBundle\\Form\\Admin\\Type\\GeneratableTextType;\nuse PrestaShopBundle\\Form\\Admin\\Type\\MoneyWithSuffixType;\nuse Symfony\\Component\\Form\\Extension\\Core\\Type\\NumberType;\nuse PrestaShopBundle\\Form\\Admin\\Type\\TranslatableType;\nuse PrestaShopBundle\\Form\\Admin\\Type\\TranslatorAwareType;\nuse Symfony\\Component\\Form\\FormBuilderInterface;\nuse Symfony\\Component\\Validator\\Constraints\\Length;\n\nclass DemoConfigurationTextType extends TranslatorAwareType\n{\n \/**\n * {@inheritdoc}\n *\/\n public function buildForm(FormBuilderInterface $builder, array $options): void\n {\n $builder\n ->add('product_name', TranslatableType::class, [\n 'label' => $this->trans('First product name', 'Modules.Wkcreatedemoproduct.Admin'),\n 'required' => true,\n 'options' => [\n 'constraints' => [\n new Length([\n 'max' => 128,\n ]),\n ],\n ],\n ])\n ->add('product_prefix', GeneratableTextType::class, [\n 'label' => $this->trans('Name prefix', 'Modules.Wkcreatedemoproduct.Admin'),\n 'generated_value_length' => 5,\n ])\n ->add('product_short_desc', TranslatableType::class, [\n 'label' => $this->trans('Product short description', 'Modules.Wkcreatedemoproduct.Admin'),\n 'type' => FormattedTextareaType::class,\n 'help' => $this->trans('Character limit < 21844 and text does not contains <>={}', 'Modules.Wkcreatedemoproduct.Admin'),\n 'required' => true,\n 'options' => [\n 'constraints' => [\n new Length([\n 'max' => 21844,\n ]),\n ],\n ],\n ])\n ->add('product_qty', NumberType::class, [\n 'label' => $this->trans('Product quantity', 'Modules.Wkcreatedemoproduct.Admin'),\n 'unit' => 'unit',\n ]);\n }\n}<\/pre>\n\n\n\n\ndeclare(strict_types=1);\n\nnamespace PrestaShop\\Module\\WkCreateDemoProduct\\Form;\n\nuse PrestaShop\\PrestaShop\\Core\\Configuration\\DataConfigurationInterface;\nuse PrestaShop\\PrestaShop\\Core\\ConfigurationInterface;\nuse PrestaShop\\PrestaShop\\Adapter\\Language\\LanguageDataProvider;\nuse Validate;\nuse Tools;\n\n\/**\n * Configuration is used to save data to configuration table and retrieve from it\n *\/\nfinal class DemoConfigurationTextDataConfiguration implements DataConfigurationInterface\n{\n public const WK_PRODUCT_NAME = 'WK_DEMO_PRODUCT_WK_PRODUCT_NAME';\n public const WK_PRODUCT_SHORT_DESC = 'WK_DEMO_PRODUCT_WK_PRODUCT_SHORT_DESC';\n public const WK_PRODUCT_PREFIX = 'WK_DEMO_PRODUCT_WK_PRODUCT_PREFIX';\n public const WK_PRODUCT_QTY = 'WK_DEMO_PRODUCT_WK_PRODUCT_QTY';\n \/**\n * @var ConfigurationInterface\n *\/\n private $configuration;\n\n \/**\n * @param ConfigurationInterface $configuration\n *\/\n public function __construct(ConfigurationInterface $configuration)\n {\n $this->configuration = $configuration;\n }\n\n \/**\n * {@inheritdoc}\n *\/\n public function getConfiguration(): array\n {\n $return = [];\n\n if ($productName = $this->configuration->get(static::WK_PRODUCT_NAME)) {\n $return['product_name'] = $productName;\n }\n if ($productShortDesc = $this->configuration->get(static::WK_PRODUCT_SHORT_DESC)) {\n $return['product_short_desc'] = $productShortDesc;\n }\n if ($productPrefix = $this->configuration->get(static::WK_PRODUCT_PREFIX)) {\n $return['product_prefix'] = $productPrefix;\n }\n if ($productQty = $this->configuration->get(static::WK_PRODUCT_QTY)) {\n $return['product_qty'] = $productQty;\n }\n\n return $return;\n }\n\n \/**\n * {@inheritdoc}\n *\/\n public function updateConfiguration(array $configuration): array\n {\n $errors = $this->validateConfiguration($configuration);\n if (!empty($errors)) {\n return $errors;\n }\n $this->configuration->set(static::WK_PRODUCT_NAME, $configuration['product_name']);\n $this->configuration->set(static::WK_PRODUCT_SHORT_DESC, $configuration['product_short_desc'], null, ['html' => true]);\n \/* Adding html => true allows for configuration->set to save HTML values *\/\n $this->configuration->set(static::WK_PRODUCT_PREFIX, $configuration['product_prefix']);\n $this->configuration->set(static::WK_PRODUCT_QTY, $configuration['product_qty']);\n\n \/* Errors are returned here. *\/\n return [];\n }\n\n \/**\n * Ensure the parameters passed are valid.\n *\n * @param array $configuration\n *\n * @return bool Returns array\n *\/\n public function validateConfiguration(array $configuration): array\n {\n $errors = [];\n $objLangDataProvider = new LanguageDataProvider();\n $languages = $objLangDataProvider->getLanguages(false);\n foreach ($languages as $lang) {\n if (!trim($configuration['product_name'][$lang['id_lang']])) {\n $errors[] = sprintf(\n $this->l('Product name is required in %s.'),\n $lang['name']\n );\n } elseif (!Validate::isCatalogName($configuration['product_name'][$lang['id_lang']])) {\n $errors[] = sprintf(\n $this->l('Product name is not valid in %s.'),\n $lang['name']\n );\n } elseif (Tools::strlen($configuration['product_name'][$lang['id_lang']]) > 128) {\n $this->errors[] = sprintf(\n $this->trans('Product name is too long. It must have 128 character or less in %s.', 'Modules.Wkcreatedemoproduct.Admin'),\n $lang['name']\n );\n }\n if (!trim($configuration['product_short_desc'][$lang['id_lang']])) {\n $errors[] = sprintf(\n $this->trans('Product short description is required in %s.', 'Modules.Wkcreatedemoproduct.Admin'),\n $lang['name']\n );\n } elseif (!Validate::isCleanHtml($configuration['product_short_desc'][$lang['id_lang']])) {\n $errors[] = sprintf(\n $this->trans('Product short description is not valid in %s.', 'Modules.Wkcreatedemoproduct.Admin'),\n $lang['name']\n );\n } elseif (Tools::strlen($configuration['product_short_desc'][$lang['id_lang']]) > 21844) {\n $this->errors[] = sprintf(\n $this->trans('Product short description too long. It must have 21844 character or less in %s.', 'Modules.Wkcreatedemoproduct.Admin'),\n $lang['name']\n );\n }\n if (!$configuration['product_qty']) {\n $errors[] = $this->trans('Product quantity is required.', 'Modules.Wkcreatedemoproduct.Admin');\n } elseif (!Validate::isUnsignedInt($configuration['product_qty'])) {\n $errors[] = $this->trans('Product quantity is invalid.', 'Modules.Wkcreatedemoproduct.Admin');\n }\n return $errors;\n }\n }\n}<\/pre>\n\n\n\n\ndeclare(strict_types=1);\n\nnamespace PrestaShop\\Module\\WkCreateDemoProduct\\Form;\n\nuse PrestaShop\\PrestaShop\\Core\\Configuration\\DataConfigurationInterface;\nuse PrestaShop\\PrestaShop\\Core\\Form\\FormDataProviderInterface;\n\n\/**\n * Provider ir responsible for providing form data, in this case it's as simple as using configuration to do that\n *\n * Class DemoConfigurationTextFormDataProvider\n *\/\nclass DemoConfigurationTextFormDataProvider implements FormDataProviderInterface\n{\n \/**\n * @var DataConfigurationInterface\n *\/\n private $demoConfigurationTextDataConfiguration;\n\n \/**\n * @param DataConfigurationInterface $demoConfigurationTextDataConfiguration\n *\/\n public function __construct(DataConfigurationInterface $demoConfigurationTextDataConfiguration)\n {\n $this->demoConfigurationTextDataConfiguration = $demoConfigurationTextDataConfiguration;\n }\n\n \/**\n * {@inheritdoc}\n *\/\n public function getData(): array\n {\n return $this->demoConfigurationTextDataConfiguration->getConfiguration();\n }\n\n \/**\n * {@inheritdoc}\n *\/\n public function setData(array $data): array\n {\n return $this->demoConfigurationTextDataConfiguration->updateConfiguration($data);\n }\n}<\/pre>\n\n\n\ndeclare(strict_types=1);\n\nnamespace PrestaShop\\Module\\WkCreateDemoProduct\\Controller;\n\nuse PrestaShopBundle\\Controller\\Admin\\FrameworkBundleAdminController;\nuse Symfony\\Component\\HttpFoundation\\Request;\nuse Symfony\\Component\\HttpFoundation\\Response;\n\nclass DemoProductConfigurationController extends FrameworkBundleAdminController\n{\n public function index(Request $request): Response\n {\n $textFormDataHandler = $this->get('prestashop.module.wkcreatedemoproduct.form.demo_configuration_text_form_data_handler');\n\n $textForm = $textFormDataHandler->getForm();\n $textForm->handleRequest($request);\n\n if ($textForm->isSubmitted() && $textForm->isValid()) {\n \/** You can return array of errors in form handler and they can be displayed to user with flashErrors *\/\n $errors = $textFormDataHandler->save($textForm->getData());\n if (empty($errors)) {\n $this->addFlash('success', $this->trans('Successful update.', 'Admin.Notifications.Success'));\n\n return $this->redirectToRoute('demo_product_configuration_form');\n }\n\n $this->flashErrors($errors);\n }\n\n return $this->render('@Modules\/wkcreatedemoproduct\/views\/templates\/admin\/form.html.twig', [\n 'demoConfigurationTextForm' => $textForm->createView(),\n ]);\n }\n}<\/pre>\n\n\n\n{% extends '@PrestaShop\/Admin\/layout.html.twig' %}\n\n{# PrestaShop made some modifications to the way forms are displayed to work well with PrestaShop in order to benefit from those you need to use ui kit as theme#}\n{% form_theme demoConfigurationTextForm '@PrestaShop\/Admin\/TwigTemplateForm\/prestashop_ui_kit.html.twig' %}\n\n{% block content %}\n {{ form_start(demoConfigurationTextForm) }}\n <div class="card">\n <h3 class="card-header">\n <i class="material-icons">settings<\/i> {{ 'Demo products settings'|trans({}, 'Modules.Wkcreatedemoproduct.Admin') }}\n <\/h3>\n <div class="card-body">\n <div class="form-wrapper">\n {{ form_widget(demoConfigurationTextForm) }}\n <\/div>\n <\/div>\n <div class="card-footer">\n <div class="d-flex justify-content-end">\n <button class="btn btn-primary float-right" id="save-button">\n {{ 'Create sample products'|trans({}, 'Modules.Wkcreatedemoproduct.Admin') }}\n <\/button>\n <\/div>\n <\/div>\n <\/div>\n {{ form_end(demoConfigurationTextForm) }}\n{% endblock %}\n\n{% block javascripts %}\n {{ parent() }}\n <script src="{{ asset('..\/modules\/wkcreatedemoproduct\/views\/js\/admin.js') }}"><\/script>\n{% endblock %}<\/pre>\n\n\n\n{\n "name": "prestashop\/wkcreatedemoproduct",\n "description": "PrestaShop - DEMO Products",\n "license": "AFL-3.0",\n "authors": [{\n "name": "Webkul"\n }],\n "autoload": {\n "psr-4": {\n "PrestaShop\\\\Module\\\\WkCreateDemoProduct\\\\": "src\/"\n }\n },\n "require": {\n "php": ">=7.1.0"\n },\n "config": {\n "preferred-install": "dist",\n "prepend-autoloader": false\n },\n "type": "prestashop-module"\n}<\/pre>\n\n\n\n![\"screenshot-2023.03.30-17_37_48\"](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/03\/screenshot-2023.03.30-17_37_48.png\")
<\/figure>\n\n\n\n![\"screenshot-2023.03.30-17_42_07\"](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/03\/screenshot-2023.03.30-17_42_07.png\")
<\/figure>\n\n\n\n![\"screenshot-2023.03.30-17_46_01\"](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/03\/screenshot-2023.03.30-17_46_01.png\")
<\/figure>\n\n\n\n