archer/clickatell-bundle

Symfony ClickatellBundle

Installs: 12 479

Dependents: 0

Suggesters: 0

Stars: 2

Watchers: 1

Forks: 2

Open Issues: 1

Type:symfony-bundle

0.1.0 2016-08-17 12:37 UTC

README

Clickatell

Prerequisites

This version of the bundle requires Symfony 2.1+

Translations

If you wish to use default texts provided in this bundle, you have to make sure you have translator enabled in your config.

# app/config/config.yml

framework:
    translator: ~

For more information about translations, check Symfony documentation.

Installation

Installation is a quick 5 step process:

  1. Download ArcherClickatellBundle using composer
  2. Enable the Bundle
  3. Create your Message class
  4. Configure the ArcherClickatellBundle
  5. Update your database schema

Step 1: Download ArcherClickatellBundle using composer

Add ArcherClickatellBundle in your composer.json:

{
    "require": {
        "archer/clickatell-bundle": "dev-master"
    }
}

Now tell composer to download the bundle by running the command:

$ php composer.phar update archer/clickatell-bundle

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

Step 2: Enable the bundle

Enable the bundle in the kernel:

<?php
// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
        new Archer\ClickatellBundle\ArcherClickatellBundle(),
    );
}

Step 3: Create your Message class

The goal of this bundle is to persist some Message class to a database (MySql, MongoDB, CouchDB, etc).

The bundle provides base classes which are already mapped for most fields to make it easier to create your entity. Here is how you use it:

  1. Extend the base Message class (the class to use depends of your storage)
  2. Map the id field. It must be protected as it is inherited from the parent class.

Note:

The doc uses a bundle named AcmeMessageBundle. If you want to use the same name, you need to register it in your kernel. But you can of course place your Message class in the bundle you want.

Warning:

If you override the __construct() method in your Message class, be sure to call parent::__construct(), as the base Message class depends on this to initialize some fields.

a) Doctrine ORM Message class

If you're persisting your message via the Doctrine ORM, then your message class should live in the Entity namespace of your bundle and look like this to start:

<?php
// src/Acme/MessageBundle/Entity/Message.php

namespace Acme\MessageBundle\Entity;

use Archer\ClickatellBundle\Entity\Message as BaseMessage;
use Doctrine\ORM\Mapping as ORM;

/**
 * @ORM\Entity
 * @ORM\Table(name="clickatell_message")
 */
class Message extends BaseMessage
{
    /**
     * @ORM\Id
     * @ORM\Column(type="integer")
     * @ORM\GeneratedValue(strategy="AUTO")
     */
    protected $id;

    public function __construct()
    {
        parent::__construct();
        // your own logic
    }
}

b) MongoDB Message class c) CouchDB Message class d) Propel Message class

Step 4: Configure the ArcherClickatell

Add the following configuration to your config.yml file according to which type of datastore you are using.

# app/config/config.yml
archer_clickatell:
    user:                 ~ # your username for clickatell
    password:             ~ # your password for clickatell
    api_id:               ~ # your id for clickatell
    message_class:  Acme\MessageBundle\Entity\Message
# app/config/config.xml
<!-- app/config/config.xml -->

<archer_clickatell:config
    user="username"
    password="password"
    api-id="api_id"
    message-class="Acme\MessageBundle\Entity\Message"
/>

Step 5: Update your database schema

Now that the bundle is configured, the last thing you need to do is update your database schema because you have added a new entity, the Message class which you created in Step 4.

For ORM run the following command.

$ php app/console doctrine:schema:update --force

Usage Steps

//send  Sms
$form = $this->get('clickatell.send_message.form');
$form->bind($this->getRequest());
if ($form->isValid()) {
    $message = $form->getData();
    $clickatell = $this->get('clickatell.http');
    $response = $clickatell->sendMessage($message->getToPhone(), $message->getText());
}