From 129dffd085d9084d402e889c1757322f2cc26450 Mon Sep 17 00:00:00 2001 From: Jack-Benny Persson Date: Thu, 31 Jul 2014 21:17:57 +0200 Subject: [PATCH] Added README, HISTORY and LICENSE files --- HISTORY | 5 +++++ LICENSE | 15 +++++++++++++ README.md | 41 ++++++++++++++++++++++++++++++++++ class.php => cellsyntClass.php | 2 ++ 4 files changed, 63 insertions(+) create mode 100644 HISTORY create mode 100644 LICENSE create mode 100644 README.md rename class.php => cellsyntClass.php (99%) diff --git a/HISTORY b/HISTORY new file mode 100644 index 0000000..5826b0e --- /dev/null +++ b/HISTORY @@ -0,0 +1,5 @@ +0.1 - 2014-07-31 + First relase of the class + + +Note: For more history information, please see the git log diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..80983d3 --- /dev/null +++ b/LICENSE @@ -0,0 +1,15 @@ +Copyright (C) 2014 Jack-Benny Persson + +This program is free software; you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation; either version 2 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program; if not, write to the Free Software +Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA diff --git a/README.md b/README.md new file mode 100644 index 0000000..71ca39c --- /dev/null +++ b/README.md @@ -0,0 +1,41 @@ +# cellsyntClass # +This is a PHP class for sending SMS messages through Cellsynt's +(http://www.cellsynt.se) API. It's made to be as easy and straight forward as +possible, so anyone can implement it in their own applications. + +## Usage ## +Start with including the file cellsyntClass.php in your application. Next off +create a new object of the class 'Cellsynt' with appropriate parameters, +username, password etc. Then, to actually send an SMS call the objects function +call 'sendSMS' with the parameters phone number, message and optionally expiry +date. See the quick example below. + + sendSMS("0046701234567", "This is just a test SMS!"); + ?> + +### List of avaliable parameters ### +Parameters for the class in order: + + * username (required) + * password (required) + * originator type (optional, default is 'alpha') + * originator (optional, default is 'Cellsynt') + * concatenated (optional, default is maximum, 6) + * charset (optional, default is UTF-8) + * type (optional, default is text (only text and flash works with this class)) + +Parameters for the sendSMS function in order: + + * phone number (required) + * message (required) + * expiry date (optional, Unix Timestamp when message should expire) + +## Copyright ## +This class is written by Jack-Benny Persson and released under GNU GPL +version 2. + +Note that I am not in any way affiliated with Cellsynt. diff --git a/class.php b/cellsyntClass.php similarity index 99% rename from class.php rename to cellsyntClass.php index 3892b94..ccb9b2a 100644 --- a/class.php +++ b/cellsyntClass.php @@ -19,6 +19,8 @@ /* + Version 0.1 + Usage example: $MySMS = new Cellsynt("myuser", "mYpaSS", "alpha", "Test"); print $MySMS->sendSMS("0046701234567", "This is my SMS!");