mangoweb-sylius / sylius-bulksms-plugin
BulkSMS plugin for Sylius
Installs: 0
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 3
Forks: 0
Open Issues: 0
Type:sylius-plugin
Requires
- php: ^7.1
- ext-curl: *
- ext-json: *
- sylius/sylius: ^1.2.5
- symfony/symfony: ^4.1
Requires (Dev)
- behat/behat: ^3.4
- behat/mink: ^1.7@dev
- behat/mink-browserkit-driver: ^1.3
- behat/mink-extension: ^2.2
- behat/mink-selenium2-driver: ^1.3
- friends-of-behat/context-service-extension: ^1.2
- friends-of-behat/cross-container-extension: ^1.1
- friends-of-behat/service-container-extension: ^1.0
- friends-of-behat/symfony-extension: ^1.2.1
- friends-of-behat/variadic-extension: ^1.1
- lakion/mink-debug-extension: ^1.2.3
- phpstan/phpstan-doctrine: ^0.10
- phpstan/phpstan-shim: ^0.10
- phpstan/phpstan-symfony: ^0.10
- phpstan/phpstan-webmozart-assert: ^0.10
- phpunit/phpunit: ^6.5
- se/selenium-server-standalone: ^3.12
- sylius-labs/coding-standard: ^2.0
This package is auto-updated.
Last update: 2024-11-12 04:34:32 UTC
README
BulkSMS Plugin
Features
- Use https://www.bulksms.com account to send SMS to customers
- Inform your customers with a text message that the package has been sent
- Custom text for every shipping method and language
- Use variables to personalise the text
Installation
- Run
$ composer require mangoweb-sylius/sylius-bulksms-plugin
. - Register
\MangoSylius\BulkSmsPlugin\MangoSyliusBulkSmsPlugin
in your Kernel. - Import
@MangoSyliusBulkSmsPlugin/Resources/config/resources.yml
in the config.yml. - Your Entity
Channel
has to implement\MangoSylius\BulkSmsPlugin\Model\BulkSmsChannelInterface
. You can use TraitMangoSylius\BulkSmsPlugin\Model\BulkSmsChannelTrait
. - Your Entity
ShippingMethodTranslation
has to implement\MangoSylius\BulkSmsPlugin\Model\BulkSmsShippingMethodInterface
. You can use TraitMangoSylius\BulkSmsPlugin\Model\BulkSmsShippingMethodTrait
. - Include template
@MangoSyliusBulkSmsPlugin/channelSmsSegmentForm.html.twig
in@SyliusAdmin/Channel/_form.html.twig
. - Include template
@MangoSyliusBulkSmsPlugin/shippingMethodSmsForm.html.twig
in@SyliusAdmin/ShippingMethod/_form.html.twig
. For guide to use your own entity see Sylius docs - Customizing Models
Usage
First enter BulkSMS credentials and other parameters in channel settings, then enter SMS text for each shipping method. If the text is blank, no SMS will be sent.
You can use the following variables in the text:
{{ orderNumber }}
{{ trackingNumber }}
{{ address.fullName }}
{{ address.company }}
{{ address.street }}
{{ address.postCode }}
{{ address.city }}
{{ address.provinceCode }}
{{ address.provinceName }}
{{ address.countryCode }}
Development
Usage
- Create symlink from .env.dist to .env or create your own .env file
- Develop your plugin in
/src
- See
bin/
for useful commands
Testing
After your changes you must ensure that the tests are still passing.
- Easy Coding Standard
bin/ecs.sh
- PHPStan
bin/phpstan.sh
License
This library is under the MIT license.
Credits
Developed by manGoweb.