MA-946 #time 3h 30m Removed Compatibility layer code and finished

Documentation.

Author: beardyman

.gitignore

@@ -1,5 +1,5 @@
 /vendor/
 .project
 .settings
-.buildPath
+.buildpath
 test/output/

README.md

@@ -75,9 +75,9 @@ try {
 ## Development
 
 ### Setup
-We use [Robo](http://robo.li/) for our task runner, please follow the instructions on their website to install Robo.
+We use [Robo](http://robo.li/) for our task runner.
 
-Run `composer install` inside the directory to install dependecies and development tools.
+Run `composer install` inside the directory to install dependecies and development tools including Robo.
 
 ### Testing
 Once all the dependencies are installed, you can execute the unit tests using `vendor\bin\robo test`

composer.lock

@@ -23,7 +23,7 @@ private function __construct(){}
 	 * @param Array $configMap - Hashmap that contains config values for the SDK to connect to SparkPost
 	 * @throws \Exception
 	 */
-	public static function setConfig($configMap) {
+	public static function setConfig(array $configMap) {
 		//check for API key because its required	
 		if (!isset($configMap['key']) || empty(trim($configMap['key']))){
 			throw new \Exception('You must provide an API key');

lib/MessageSystems/Configuration.php

@@ -420,7 +420,7 @@ public function setRfc822Content ($rfc) {
 	 * @param array $headers Key-value pairs of headers to add to the content of a Transmission
 	 * @return \MessageSystems\Transmission Object
 	 */
-	public function setContentHeaders (Array $headers) {
+	public function setContentHeaders (array $headers) {
 		$this->model['content']['headers'] = $headers;
 		return $this;
 	}
@@ -439,7 +439,7 @@ public function setContentHeaders (Array $headers) {
 	 * @param array $recipient An associative array of recipient data to send a Transmission
 	 * @return \MessageSystems\Transmission Object
 	 */
-	public function addRecipient (Array $recipient) {
+	public function addRecipient (array $recipient) {
 		if(!is_array($this->model['recipients'])) {
 			$this->model['recipients'] = [];
 		}
@@ -460,7 +460,7 @@ public function addRecipient (Array $recipient) {
 	 * @param array $recipients An array of associative arrays containing recipient data
 	 * @return \MessageSystems\Transmission Object
 	 */
-	public function addRecipients (Array $recipients) {
+	public function addRecipients (array $recipients) {
 		if(!is_array($this->model['recipients'])) {
 			$this->model['recipients'] = [];
 		}

lib/MessageSystems/SendGridCompatibility/Email.php

@@ -8,11 +8,21 @@ class SparkPost {
 
 	public $transmission;
 
-	public function __construct($globalOpts) {
+	/**
+	 * @desc Sets up the config for the sdk suite
+	 * @param array $globalOpts
+	 */
+	public function __construct(array $globalOpts) {
 		Configuration::setConfig($globalOpts);
 	}
 
-	public function Transmission(Array $options = null) {
+	/**
+	 * @desc Creates a new Transmission object and returns it.
+	 * @param array $options Transmission constructor options
+	 * @see \MessageSystems\Transmission
+	 * @return \MessageSystems\Transmission
+	 */
+	public function Transmission(array $options = null) {
 		$this->transmission = new Transmission($options);
 		return $this->transmission;
 	}