karser/mainsms-bundle

Symfony MainSMSBundle

Getting started with MainSMSBundle

MainSMS, _(*1)

Prerequisites

This version of the bundle requires Symfony 2.1+ and Doctrine ORM 2.2+, _(*2)

Installation

Installation is a quick 3 step process:, _(*3)

1. Download KarserMainSMSBundle using composer
2. Enable the Bundle
3. Configure the KarserMainSMSBundle

Step 1: Download KarserMainSMSBundle using composer

Add KarserMainSMSBundle in your composer.json:, _(*4)

{
    "require": {
        "karser/mainsms-bundle": "dev-master"
    }
}

Now tell composer to download the bundle by running the command:, _(*5)

``` bash $ php ./composer.phar update, <sub>(*6)</sub>

Composer will install the bundle to your project's `vendor/karser` directory.

### Step 2: Enable the bundle

Enable the bundle in the kernel:

``` php
<?php
// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
        new Karser\MainSMSBundle\KarserMainSMSBundle(),
    );
}

Step 3: Configure the KarserMainSMSBundle

Add the following configuration to your config.yml file according to which type of datastore you are using., <sub>(*7)</sub>

``` yaml, <sub>(*8)</sub>

app/config/config.yml

karser_main_sms: project: "%main_sms_project%" key: "%main_sms_key%" use_ssl: "%main_sms_use_ssl%" test_mode: "%main_sms_test_mode%", <sub>(*9)</sub>

``` yaml
# app/config/parameters.yml
parameters:
    main_sms_project:   ~ # project name
    main_sms_key:       ~ # sms key
    main_sms_use_ssl:   ~ # true or false
    main_sms_test_mode: ~ # true or false

If you going to store messages in the database, don't forget to update your schema:, <sub>(*10)</sub>

app/console doctrine:schema:update

Usage Steps

Basic usage

You can send message directly: ``` php $MainSMSModel = $this->get('karser.main_sms.model'); //or use getter trait use \Karser\MainSMSBundle\Model\Getter; $MainSMSModel = $this->getMainSmsModel($this->container); //send message $MainSMSModel->messageSend($number, $message, $sender);, <sub>(*11)</sub>

You can check the balance by cli command:

$ app/console mainsms:balance, <sub>(*12)</sub>

Balance is 6.45, <sub>(*13)</sub>

#### Schedule the message
Ensure that doctrine automapping is enabled:
``` yaml
doctrine:
    orm:
        auto_mapping: true

It maps the message to SMSTask entity and stores to the database. ``` php $MainSMSManager = $this->get('karser.main_sms.manager'); //or use getter trait use \Karser\MainSMSBundle\Manager\Getter; $MainSMSManager = $this->getMainSmsManager($this->container); //schedule message $MainSMSManager->schedule($number, $message, $sender);, <sub>(*14)</sub>

You can send it later by cli command:

$ app/console mainsms:send, <sub>(*15)</sub>

Balance is 6.45 Messages to send 1 . Done. ```, <sub>(*16)</sub>