Add a lot of documentation, documentation script, update class docblocks

[delatbabel]

I updated class docblocks for all of the gateways including links to web sites where available. I also added a simple script to create the API documentation, might be useful to some people while developing. No functionality changes.

[delatbabel]

I added a gateway interface for bulksms.com plus test case, and updated some documentation. For some strange reason I can't get the unit tests to run on my local development environment, it's PHP 5.5.9 with phpUnit 3.7.28 and gives me an error as follows:

PHP Fatal error: Class 'Buzz\Client\AbstractStream' not found in /home/del/develop/github/xi-sms/vendor/kriswallsmith/buzz/test/Buzz/Test/Client/AbstractStreamTest.php on line 11

Clearly some dependency issue that phpUnit is not picking up from the vendor/ tree when it should be. Let me know if you have any success with the unit tests.

[pekkis]

Thanks! Will go thru and comment further!

[delatbabel]

I just added a few more small documentation changes.

[PKJedi]

Project uses 4 space indentation.

[delatbabel]

I converted to 4 space indents.

[PKJedi]

Would the following work?

return http_build_query($post_fields);

[delatbabel]

No, not quite, because of the way that http_build_query encodes spaces.

[PKJedi]

Sorry for the delay. The documentation stuff is looks good, could move that into a separate PR? The gateway implementation has some further CS issues, try and make it match PSR rules. (camelCase, tabs->4spaces, etc.)

[PKJedi]

Would the following work?

$from = array_keys($special_chrs);
$to = array_values($special_chrs);
$ret_msg = str_replace($from, $to, $body);

[delatbabel]

It would for 7 bit messages but not for 16 bit messages because it would not be unicode safe.

[delatbabel]

It's not really feasible for me to roll back a month old PR to start again and re-work it into two separate PRs. I can work on fixing the gateway code later but it was based on the implementation supplied to me from Bulk SMS.

To be honest I thought this project had been abandoned so I started working on something else.

[delatbabel]

Unit tests are working fine now except for a long standing error with the MessageBirdGatewayTest. This uses constants that aren't declared, and should be using a mock but is not. I will PR that later.