Inform your customers via text message
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
doc
features
src
tests
.editorconfig
.gitignore
.travis.yml
README.md
behat.yml.dist
composer.json
easy-coding-standard.yml
logo.png
node_modules
phpstan.neon
phpunit.xml.dist

README.md

SMS Manager Plugin

Features

  • Use https://smsmanager.cz 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

  1. Run $ composer require mangoweb-sylius/sylius-smsmanager-plugin.
  2. Register \MangoSylius\SmsManagerPlugin\MangoSyliusSmsManagerPlugin in your Kernel.
  3. Import @MangoSyliusSmsManagerPlugin/Resources/config/resources.yml in the config.yml.
  4. Your Entity Channel has to implement \MangoSylius\SmsManagerPlugin\Model\SmsManagerChannelInterface. You can use Trait MangoSylius\SmsManagerPlugin\Model\SmsManagerChannelTrait.
  5. Your Entity ShippingMethodTranslation has to implement \MangoSylius\SmsManagerPlugin\Model\SmsManagerShippingMethodInterface. You can use Trait MangoSylius\SmsManagerPlugin\Model\SmsManagerShippingMethodTrait.
  6. Include template @MangoSyliusSmsManagerPlugin/channelSmsSegmentForm.html.twig in @SyliusAdmin/Channel/_form.html.twig.
  7. Include template @MangoSyliusSmsManagerPlugin/shippingMethodSmsForm.html.twig in @SyliusAdmin/ShippingMethod/_form.html.twig. For guide to use your own entity see Sylius docs - Customizing Models

Usage

First enter SMS Manager 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.