Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ebiggio/prestashop-customer-dni

PrestaShop module to handle the DNI at customer level.
https://github.com/ebiggio/prestashop-customer-dni

prestashop prestashop-8 prestashop-free-module prestashop-module

Last synced: 2 days ago
JSON representation

PrestaShop module to handle the DNI at customer level.

Awesome Lists containing this project

README 

        
# [WIP] Module logo PrestaShop Customer DNI module

## Version 0.9.0



By default, PrestaShop does not allow setting the customer's DNI (National Identity Document) when creating an account.

Instead, the field is saved at the address level, which for some cases is not the most appropriate. There's also no additional validation for the DNI field;

a customer can have multiple addresses with different DNIs, and even the same DNI can be used for multiple addresses for different customers. 

This module adds a new field to the registration and edit form of the customer, changing the handling of the DNI field at the customer's personal information level.

The module also provides additional validation options for the DNI field, such as making it required, unique, and validating it against a regular expression.



## Features



- Adds a new field to the registration and edit form of the customer, allowing them to save their DNI.

- Displays the DNI field in the back office as well, so it can be easily viewed and edited by back office users. It also displays the DNI in the customer list.

- Allows setting the DNI as required, unique, and validate it against a regular expression using the module's configuration page.

- Option to overwrite the DNI field of the addresses when the customer DNI changes, so that value is copied to all the addresses of that customer. Useful for modules that use the address DNI field.

- Additional validations can be added by uploading a custom validation class inside the module's `custom_validators` folder. The module includes a custom validator that checks if the DNI is a valid chilean RUT.

- The DNI is stored in a new table in the database, linked to the customer's ID, so it can be easily retrieved and used in other modules or customizations.

- The module is fully translatable.



## Requirements



- Tested on PrestaShop 8.1, but should work on any version of PrestaShop 1.7.7 or higher.

- Developed using PHP 8.1



## Installation



1. Download this repository to a folder named `customer_dni`, and compress it into a ZIP file.

2. Upload the ZIP file to your PrestaShop instance. You can do this by going to the back office of your PrestaShop store and navigating to the `Modules` section.

Click on the `Upload a module` button and select the ZIP file you just created. You can also upload the ZIP file directly to the `modules` folder of your PrestaShop installation.

If you choose this method, make sure to extract the ZIP file after uploading it, so the `customer_dni` folder is created inside the `modules` folder.

After uploading the ZIP file, the module should appear in the list of modules in the back office, where you can install it.

3. Once the module is installed, click on the `Configure` button to access the module's configuration page.

4. Configure the module according to your needs and save the changes.

5. The module is now ready to use. The DNI field should be displayed in the registration and edit form of the customer.



## Configuration



The module has a configuration page where you can set the following options:



- **Display customer DNI in back-office**: Show the DNI field in the customer list of the back office, which also allows filtering and ordering by DNI value. 

- **Mark as required**: Make the DNI field required in the registration and edit form of the customer.

- **Mark as unique**: Make the DNI field unique, so the same DNI cannot be used by multiple customers.

- **Overwrite address DNI field**: Overwrite the default DNI field in the address form, so when the customer saves the DNI in the customer form,

it is also saved in the address DNI field for **all** the addresses related to that customer.

Keep in mind that the default DNI field for the address has a maximum length of 16 characters, so if the customer DNI is longer than that, it will be truncated.

- **Validate against a regular expression**: Set a regular expression to use for validating the DNI.

- **Use custom validators**: Enable the use of custom validators for the DNI field.

You can upload a custom validation class inside the module's `custom_validators` folder to add additional validations to the DNI field.



## Usage



Once the module is installed and configured, the DNI field should be displayed in the registration and edit form of the customer. The DNI field is also displayed in the back office, so users with customer edit permissions can easily edit it.



The DNI field is stored in a new table in the database, linked to the customer's ID.

Upon resetting or uninstalling the module, the DNI field will be removed from the customer form, but previously saved DNI data will remain in the module's `customer_dni` table.



You can use the DNI field in other modules or customizations by retrieving it directly from the database table `customer_dni` using the customer's ID.



## Customization



You can customize the module by adding additional validators for the DNI field.

To do this, add a custom validator class that implements the `CustomValidator` interface to the `custom_validators` folder.

The module has a built-in custom validator that checks the DNI against the chilean RUT format.

You can use this class as a reference to create your own custom validator.



## License



This module is released under GNU General Public License version 3. You can find a copy of the license in the [LICENSE](LICENSE) file.



## TODOs



Ideas for future improvements not covered in the current version of the module:



- Add support for PrestaShop 1.7.6 and earlier versions.

- Allow selecting the location of the DNI field in the customer form of the front office (e.g., before or after the email field).

- Validate the DNI during customer creation through the API.

- Define hooks to set and retrieve a customer's DNI programmatically.

- Define hooks to add additional custom validations to the customer's DNI programmatically.