savannabits / daraja

src/Daraja.php

Doc Comments +12 added lines, -6 removed lines

@@ -55,7 +55,7 @@ 
 
     /**
      * This is used to generate tokens for the live environment
-     * @return mixed
+     * @return null|Daraja
      */
     public function generateLiveToken(){
         if(!isset($this->consumer_key)||!isset($this->consumer_secret)){
@@ -79,12 +79,15 @@ 
         return $this;
     }
 
+    /**
+     * @return resource
+     */
     public function getAccessToken() {
         return $this->access_token;
     }
     /**
      * use this function to generate a sandbox token
-     * @return mixed
+     * @return null|Daraja
      */
     public function generateSandBoxToken(){
 
@@ -170,6 +173,9 @@ 
         return base64_encode($encrypted);
     }
 
+    /**
+     * @param string $publicKeyFile
+     */
     public function preparePublicKey($publicKeyFile) {
         $pkey = file_get_contents($publicKeyFile);
         $pkey = str_replace(["\r", "\n"],"", $pkey);
@@ -219,13 +225,13 @@ 
     }
     /**
      * Use this function to initiate a reversal request. This is the lowest level function that can change even the Organization Id Type.
-     * @param $CommandID | Takes only 'TransactionReversal' Command id
+     * @param string $CommandID | Takes only 'TransactionReversal' Command id
      * @param $Initiator | The name of Initiator to initiating  the request
      * @param $SecurityCredential | 	Encrypted Credential of user getting transaction amount
      * @param $TransactionID | Unique Id received with every transaction response.
      * @param $Amount | Amount
      * @param $ReceiverParty | Organization /MSISDN sending the transaction
-     * @param $RecieverIdentifierType | Type of organization receiving the transaction
+     * @param integer $RecieverIdentifierType | Type of organization receiving the transaction
      * @param $ResultURL | The path that stores information of transaction
      * @param $QueueTimeOutURL | The path that stores information of time out transaction
      * @param $Remarks | Comments that are sent along with the transaction.
@@ -433,10 +439,10 @@ 
      * Use this function to make a transaction status request
      * @param $Initiator | The name of Initiator to initiating the request.
      * @param $SecurityCredential | 	Encrypted password for the initiator to autheticate the transaction request.
-     * @param $CommandID | Unique command for each transaction type, possible values are: TransactionStatusQuery.
+     * @param string $CommandID | Unique command for each transaction type, possible values are: TransactionStatusQuery.
      * @param $TransactionID | Organization Receiving the funds.
      * @param $PartyA | Organization/MSISDN sending the transaction
-     * @param $IdentifierType | Type of organization receiving the transaction
+     * @param integer $IdentifierType | Type of organization receiving the transaction
      * @param $ResultURL | The path that stores information of transaction
      * @param $QueueTimeOutURL | The path that stores information of time out transaction
      * @param $Remarks | 	Comments that are sent along with the transaction