Il manquait le module LocalPickup dans mon Git
This commit is contained in:
101
local/modules/LocalPickup/README.md
Normal file
101
local/modules/LocalPickup/README.md
Normal file
@@ -0,0 +1,101 @@
|
||||
LocalPickup module
|
||||
==================
|
||||
author: Thelia <info@thelia.net>
|
||||
|
||||
Summary
|
||||
-------
|
||||
|
||||
fr_FR:
|
||||
1. Installation
|
||||
2. Utilisation
|
||||
3. Boucles
|
||||
4. Intégration
|
||||
|
||||
en_US:
|
||||
1. Install notes
|
||||
2. How to use
|
||||
3. Loops
|
||||
4. Integration
|
||||
|
||||
fr_FR
|
||||
-----
|
||||
|
||||
### Installation
|
||||
|
||||
#### Manually
|
||||
|
||||
* Copiez le module dans le dossier ```<thelia_root>/local/modules/``` et assurez-vous que le nom du module est bien LocalPickup.
|
||||
* Activez le depuis votre interface d'administration Thelia.
|
||||
|
||||
#### Composer
|
||||
|
||||
Ajoutez le module à votre fichier composer.json principal :
|
||||
|
||||
```
|
||||
composer require thelia/local-pickup-module:~1.0
|
||||
```
|
||||
|
||||
### Utilisation
|
||||
|
||||
Pour utiliser le module de retrait sur place, allez dans le back-office, onglet Modules, et activez le,
|
||||
puis cliquez sur "Configurer" sur la ligne du module. Renseignez le prix que vous souhaitez donner au retrait sur place
|
||||
et enregistrez.
|
||||
|
||||
### Boucles
|
||||
|
||||
1. `address.local`
|
||||
Même sorties que la boucle `address`, mais avec l'adresse du magasin au lieu de celle du client.
|
||||
- Arguments:
|
||||
1. id | obligatoire | id de l'adresse du client
|
||||
- Sorties:
|
||||
Les mêmes variables que la boucle address, mais l'adresse donnée est celle du magasin.
|
||||
- Utilisation:
|
||||
```
|
||||
{loop type="address.local" name="yourloopname" id="1"}
|
||||
<!-- your template -->
|
||||
{/loop}```
|
||||
|
||||
### Intégration
|
||||
|
||||
L'integration utilise les hooks et ne nécessite pas de travaux particuliers.
|
||||
|
||||
en_US
|
||||
-----
|
||||
|
||||
### Installation notes
|
||||
|
||||
#### Manually
|
||||
|
||||
* Copy the module into ```<thelia_root>/local/modules/``` directory and be sure that the name of the module is LocalPickup.
|
||||
* Activate it in your thelia administration panel
|
||||
|
||||
#### Composer
|
||||
|
||||
Add it in your main thelia composer.json file:
|
||||
|
||||
```
|
||||
composer require thelia/local-pickup-module:~1.0
|
||||
```
|
||||
|
||||
### Usage
|
||||
|
||||
To use the module, you first need to activate it in the back-office, tab Modules, and click on "Configure" on the line
|
||||
of the module. Enter the price you want for local pickup and save.
|
||||
|
||||
### Loops
|
||||
1. `address.local`
|
||||
Same output as the `address` loop, with the store adresse instead of the customer address.
|
||||
- Arguments:
|
||||
1. id | mandatory | id of the customer's address
|
||||
- Output:
|
||||
The same variables as address loop, but the given address is the store's address.
|
||||
- Usage:
|
||||
```
|
||||
{loop type="address.local" name="yourloopname" id="1"}
|
||||
<!-- your template -->
|
||||
{/loop}
|
||||
```
|
||||
|
||||
### Integration
|
||||
|
||||
The modules uses hooks, and does not require specific work.
|
||||
Reference in New Issue
Block a user