abr4xas / php-instapago

Instapago/InstapagoGateway/InstapagoPayment.php

Doc Comments +2 added lines, -1 removed lines

@@ -233,11 +233,12 @@
      * Realiza Transaccion
      * Efectúa y retornar una respuesta a un metodo de pago.
      *
-     *@param $url endpoint a consultar
+     *@param string $url endpoint a consultar
      *@param $fields datos para la consulta
      *
      *@return $obj array resultados de la transaccion
      * https://github.com/abr4xas/php-instapago/blob/master/help/DOCUMENTACION.md#PENDIENTE
+     * @param string $method
      */
     public function curlTransaccion($url, $fields, $method)
     {

Indentation +268 added lines, -268 removed lines

@@ -39,287 +39,287 @@
  */
 class InstapagoPayment
 {
-    protected $keyId;
-    protected $publicKeyId;
-    public $cardHolder;
-    public $cardHolderId;
-    public $cardNumber;
-    public $cvc;
-    public $expirationDate;
-    public $amount;
-    public $description;
-    public $statusId;
-    public $ipAddres;
-    public $idPago;
-
-    /**
-     * Crear un nuevo objeto de Instapago.
-     *
-     * @param string $keyId       llave privada
-     * @param string $publicKeyId llave publica
-     *                            Requeridas.
-     */
-    public function __construct($keyId, $publicKeyId)
-    {
-        try {
-            if (empty($keyId) && empty($publicKeyId)) {
-                throw new InstapagoException('Los parámetros "keyId" y "publicKeyId" son requeridos para procesar la petición.');
-            }
-
-            if (empty($keyId)) {
-                throw new InstapagoException('El parámetro "keyId" es requerido para procesar la petición. ');
-            }
-
-            if (empty($publicKeyId)) {
-                throw new InstapagoException('El parámetro "publicKeyId" es requerido para procesar la petición.');
-            }
-
-            $this->publicKeyId = $publicKeyId;
-            $this->keyId = $keyId;
-        } catch (InstapagoException $e) {
-            echo $e->getMessage();
-        } // end try/catch
-    }
-
-    /**
-     * Crear un pago
-     * Efectúa un pago con tarjeta de crédito, una vez procesado retornar una respuesta.
-     * https://github.com/abr4xas/php-instapago/blob/master/help/DOCUMENTACION.md#crear-un-pago.
-     */
-    public function payment($amount, $description, $cardHolder, $cardHolderId, $cardNumber, $cvc, $expirationDate, $statusId, $ipAddres)
-    {
-        try {
-            $params = [$amount, $description, $cardHolder, $cardHolderId, $cardNumber, $cvc, $expirationDate, $statusId, $ipAddres];
-            $this->checkRequiredParams($params);
-
-            $this->amount = $amount;
-            $this->description = $description;
-            $this->cardHolder = $cardHolder;
-            $this->cardHolderId = $cardHolderId;
-            $this->cardNumber = $cardNumber;
-            $this->cvc = $cvc;
-            $this->expirationDate = $expirationDate;
-            $this->statusId = $statusId;
-            $this->ipAddres = $ipAddres;
-
-            $url = 'payment'; // endpoint
-
-            $fields = [
-                'KeyID'             => $this->keyId, //required
-                'PublicKeyId'       => $this->publicKeyId, //required
-                'amount'            => $this->amount, //required
-                'description'       => $this->description, //required
-                'cardHolder'        => $this->cardHolder, //required
-                'cardHolderId'      => $this->cardHolderId, //required
-                'cardNumber'        => $this->cardNumber, //required
-                'cvc'               => $this->cvc, //required
-                'expirationDate'    => $this->expirationDate, //required
-                'statusId'          => $this->statusId, //required
-                'IP'                => $this->ipAddres, //required
-            ];
-
-            $obj = $this->curlTransaccion($url, $fields, 'POST');
-            $result = $this->checkResponseCode($obj);
-
-            return $result;
-        } catch (InstapagoException $e) {
-            echo $e->getMessage();
-        } // end try/catch
-    }
-
-    /**
-     * Completar Pago
-     * Este método funciona para procesar un bloqueo o pre-autorización
-     * para así procesarla y hacer el cobro respectivo.
-     * Para usar este método es necesario configurar en `payment()` el parametro statusId a 1
-     * https://github.com/abr4xas/php-instapago/blob/master/help/DOCUMENTACION.md#completar-pago.
-     */
-
-    public function continuePayment($idPago, $amount)
-    {
-        try {
-            $params = [$idPago, $amount];
-            $this->checkRequiredParams($params);
-
-            $this->idPago = $idPago;
-            $this->amount = $amount;
-
-            $url = 'complete'; // endpoint
-
-            $fields = [
-                'KeyID'             => $this->keyId, //required
-                'PublicKeyId'       => $this->publicKeyId, //required
-                'id'                => $this->idPago, //required
-                'amount'            => $this->amount, //required
-            ];
-
-            $obj = $this->curlTransaccion($url, $fields, 'POST');
-            $result = $this->checkResponseCode($obj);
-
-            return $result;
-        } catch (InstapagoException $e) {
-            echo $e->getMessage();
-        } // end try/catch
-    }
-
-    /**
-     * Anular Pago
-     * Este método funciona para procesar una anulación de un pago o un bloqueo.
-     * https://github.com/abr4xas/php-instapago/blob/master/help/DOCUMENTACION.md#anular-pago.
-     */
-    public function cancelPayment($idPago)
-    {
-        try {
-            $params = [$idPago];
-            $this->checkRequiredParams($params);
-
-            $this->idPago = $idPago;
-
-            $url = 'payment'; // endpoint
-
-            $fields = [
-                'KeyID'             => $this->keyId, //required
-                'PublicKeyId'       => $this->publicKeyId, //required
-                'Id'                => $this->idPago, //required
-            ];
-            $obj = $this->curlTransaccion($url, $fields, 'DELETE');
-
-            $result = $this->checkResponseCode($obj);
-            return $result;
-
-        } catch (InstapagoException $e) {
-            echo $e->getMessage();
-        } // end try/catch
-    }
+	protected $keyId;
+	protected $publicKeyId;
+	public $cardHolder;
+	public $cardHolderId;
+	public $cardNumber;
+	public $cvc;
+	public $expirationDate;
+	public $amount;
+	public $description;
+	public $statusId;
+	public $ipAddres;
+	public $idPago;
+
+	/**
+	 * Crear un nuevo objeto de Instapago.
+	 *
+	 * @param string $keyId       llave privada
+	 * @param string $publicKeyId llave publica
+	 *                            Requeridas.
+	 */
+	public function __construct($keyId, $publicKeyId)
+	{
+		try {
+			if (empty($keyId) && empty($publicKeyId)) {
+				throw new InstapagoException('Los parámetros "keyId" y "publicKeyId" son requeridos para procesar la petición.');
+			}
+
+			if (empty($keyId)) {
+				throw new InstapagoException('El parámetro "keyId" es requerido para procesar la petición. ');
+			}
+
+			if (empty($publicKeyId)) {
+				throw new InstapagoException('El parámetro "publicKeyId" es requerido para procesar la petición.');
+			}
+
+			$this->publicKeyId = $publicKeyId;
+			$this->keyId = $keyId;
+		} catch (InstapagoException $e) {
+			echo $e->getMessage();
+		} // end try/catch
+	}
+
+	/**
+	 * Crear un pago
+	 * Efectúa un pago con tarjeta de crédito, una vez procesado retornar una respuesta.
+	 * https://github.com/abr4xas/php-instapago/blob/master/help/DOCUMENTACION.md#crear-un-pago.
+	 */
+	public function payment($amount, $description, $cardHolder, $cardHolderId, $cardNumber, $cvc, $expirationDate, $statusId, $ipAddres)
+	{
+		try {
+			$params = [$amount, $description, $cardHolder, $cardHolderId, $cardNumber, $cvc, $expirationDate, $statusId, $ipAddres];
+			$this->checkRequiredParams($params);
+
+			$this->amount = $amount;
+			$this->description = $description;
+			$this->cardHolder = $cardHolder;
+			$this->cardHolderId = $cardHolderId;
+			$this->cardNumber = $cardNumber;
+			$this->cvc = $cvc;
+			$this->expirationDate = $expirationDate;
+			$this->statusId = $statusId;
+			$this->ipAddres = $ipAddres;
+
+			$url = 'payment'; // endpoint
+
+			$fields = [
+				'KeyID'             => $this->keyId, //required
+				'PublicKeyId'       => $this->publicKeyId, //required
+				'amount'            => $this->amount, //required
+				'description'       => $this->description, //required
+				'cardHolder'        => $this->cardHolder, //required
+				'cardHolderId'      => $this->cardHolderId, //required
+				'cardNumber'        => $this->cardNumber, //required
+				'cvc'               => $this->cvc, //required
+				'expirationDate'    => $this->expirationDate, //required
+				'statusId'          => $this->statusId, //required
+				'IP'                => $this->ipAddres, //required
+			];
+
+			$obj = $this->curlTransaccion($url, $fields, 'POST');
+			$result = $this->checkResponseCode($obj);
+
+			return $result;
+		} catch (InstapagoException $e) {
+			echo $e->getMessage();
+		} // end try/catch
+	}
+
+	/**
+	 * Completar Pago
+	 * Este método funciona para procesar un bloqueo o pre-autorización
+	 * para así procesarla y hacer el cobro respectivo.
+	 * Para usar este método es necesario configurar en `payment()` el parametro statusId a 1
+	 * https://github.com/abr4xas/php-instapago/blob/master/help/DOCUMENTACION.md#completar-pago.
+	 */
+
+	public function continuePayment($idPago, $amount)
+	{
+		try {
+			$params = [$idPago, $amount];
+			$this->checkRequiredParams($params);
+
+			$this->idPago = $idPago;
+			$this->amount = $amount;
+
+			$url = 'complete'; // endpoint
+
+			$fields = [
+				'KeyID'             => $this->keyId, //required
+				'PublicKeyId'       => $this->publicKeyId, //required
+				'id'                => $this->idPago, //required
+				'amount'            => $this->amount, //required
+			];
+
+			$obj = $this->curlTransaccion($url, $fields, 'POST');
+			$result = $this->checkResponseCode($obj);
+
+			return $result;
+		} catch (InstapagoException $e) {
+			echo $e->getMessage();
+		} // end try/catch
+	}
+
+	/**
+	 * Anular Pago
+	 * Este método funciona para procesar una anulación de un pago o un bloqueo.
+	 * https://github.com/abr4xas/php-instapago/blob/master/help/DOCUMENTACION.md#anular-pago.
+	 */
+	public function cancelPayment($idPago)
+	{
+		try {
+			$params = [$idPago];
+			$this->checkRequiredParams($params);
+
+			$this->idPago = $idPago;
+
+			$url = 'payment'; // endpoint
+
+			$fields = [
+				'KeyID'             => $this->keyId, //required
+				'PublicKeyId'       => $this->publicKeyId, //required
+				'Id'                => $this->idPago, //required
+			];
+			$obj = $this->curlTransaccion($url, $fields, 'DELETE');
+
+			$result = $this->checkResponseCode($obj);
+			return $result;
+
+		} catch (InstapagoException $e) {
+			echo $e->getMessage();
+		} // end try/catch
+	}
 
  // cancelPayment
 
-    /**
-     * Información del Pago
-     * Consulta información sobre un pago generado anteriormente.
-     * Requiere como parámetro el `id` que es el código de referencia de la transacción
-     * https://github.com/abr4xas/php-instapago/blob/master/help/DOCUMENTACION.md#información-del-pago.
-     */
-    public function paymentInfo($idPago)
-    {
-        try {
-            $params = [$idPago];
-            $this->checkRequiredParams($params);
+	/**
+	 * Información del Pago
+	 * Consulta información sobre un pago generado anteriormente.
+	 * Requiere como parámetro el `id` que es el código de referencia de la transacción
+	 * https://github.com/abr4xas/php-instapago/blob/master/help/DOCUMENTACION.md#información-del-pago.
+	 */
+	public function paymentInfo($idPago)
+	{
+		try {
+			$params = [$idPago];
+			$this->checkRequiredParams($params);
 
-            $this->idPago = $idPago;
+			$this->idPago = $idPago;
 
-            $url = 'payment'; // endpoint
+			$url = 'payment'; // endpoint
 
-            $fields = [
-                'KeyID'             => $this->keyId, //required
-                'PublicKeyId'       => $this->publicKeyId, //required
-                'id'                => $this->idPago, //required
-            ];
+			$fields = [
+				'KeyID'             => $this->keyId, //required
+				'PublicKeyId'       => $this->publicKeyId, //required
+				'id'                => $this->idPago, //required
+			];
 
-            $obj = $this->curlTransaccion($url, $fields, 'GET');
+			$obj = $this->curlTransaccion($url, $fields, 'GET');
 
-            $result = $this->checkResponseCode($obj);
+			$result = $this->checkResponseCode($obj);
 
-            return $result;
+			return $result;
 
-        } catch (InstapagoException $e) {
-            echo $e->getMessage();
-        } // end try/catch
-    }
+		} catch (InstapagoException $e) {
+			echo $e->getMessage();
+		} // end try/catch
+	}
 
  // paymentInfo
 
-    /**
-     * Realiza Transaccion
-     * Efectúa y retornar una respuesta a un metodo de pago.
-     *
-     *@param $url endpoint a consultar
-     *@param $fields datos para la consulta
-     *
-     *@return $obj array resultados de la transaccion
-     * https://github.com/abr4xas/php-instapago/blob/master/help/DOCUMENTACION.md#PENDIENTE
-     */
-    public function curlTransaccion($url, $fields, $method)
-    {
+	/**
+	 * Realiza Transaccion
+	 * Efectúa y retornar una respuesta a un metodo de pago.
+	 *
+	 *@param $url endpoint a consultar
+	 *@param $fields datos para la consulta
+	 *
+	 *@return $obj array resultados de la transaccion
+	 * https://github.com/abr4xas/php-instapago/blob/master/help/DOCUMENTACION.md#PENDIENTE
+	 */
+	public function curlTransaccion($url, $fields, $method)
+	{
         
 
-        $client = new Client([
-             'base_uri' => 'https://api.instapago.com/',
-             //'debug' => true,
-        ]);
-
-        if ($method == 'GET') {
-            $request = $client->request('GET', $url, [
-                'query' => $fields
-            ]);
-        }
-        if ($method == 'POST' || $method == 'DELETE') {
-            $request = $client->request($method, $url, [
-                'form_params' => $fields
-            ]);
-        }
-
-        $body = $request->getBody()->getContents();
-
-        $obj = json_decode($body);
-
-        return $obj;
-    }
-
-    /**
-     * Verifica Codigo de Estado de transaccion
-     * Verifica y retornar el resultado de la transaccion.
-     *
-     *@param $obj datos de la consulta
-     *
-     *@return $result array datos de transaccion
-     * https://github.com/abr4xas/php-instapago/blob/master/help/DOCUMENTACION.md#PENDIENTE
-     */
-    public function checkResponseCode($obj)
-    {
-        $code = $obj->code;
-
-        if ($code == 400) {
-            throw new InstapagoException('Error al validar los datos enviados.');
-        }
-        if ($code == 401) {
-            throw new InstapagoException('Error de autenticación, ha ocurrido un error con las llaves utilizadas.');
-        }
-        if ($code == 403) {
-            throw new InstapagoException('Pago Rechazado por el banco.');
-        }
-        if ($code == 500) {
-            throw new InstapagoException('Ha Ocurrido un error interno dentro del servidor.');
-        }
-        if ($code == 503) {
-            throw new InstapagoException('Ha Ocurrido un error al procesar los parámetros de entrada. Revise los datos enviados y vuelva a intentarlo.');
-        }
-        if ($code == 201) {
-            return [
-                'code'         => $code,
-                'msg_banco'    => $obj->message,
-                'voucher'      => html_entity_decode($obj->voucher),
-                'id_pago'      => $obj->id,
-                'reference'    => $obj->reference,
-            ];
-        }
-    }
-
-    /**
-     * Verifica parametros para realizar operación
-     * Verifica y retorna exception si algun parametro esta vacio.
-     *
-     *@param $params Array con parametros a verificar
-     *
-     *@return new InstapagoException
-     * https://github.com/abr4xas/php-instapago/blob/master/help/DOCUMENTACION.md#PENDIENTE
-     */
-    private function checkRequiredParams(array $params)
-    {
-        foreach ($params as $param) {
-            if (empty($param)) {
-                throw new InstapagoException('Parámetros faltantes para procesar el pago. Verifique la documentación.');
-            }
-        }
-    }
+		$client = new Client([
+			 'base_uri' => 'https://api.instapago.com/',
+			 //'debug' => true,
+		]);
+
+		if ($method == 'GET') {
+			$request = $client->request('GET', $url, [
+				'query' => $fields
+			]);
+		}
+		if ($method == 'POST' || $method == 'DELETE') {
+			$request = $client->request($method, $url, [
+				'form_params' => $fields
+			]);
+		}
+
+		$body = $request->getBody()->getContents();
+
+		$obj = json_decode($body);
+
+		return $obj;
+	}
+
+	/**
+	 * Verifica Codigo de Estado de transaccion
+	 * Verifica y retornar el resultado de la transaccion.
+	 *
+	 *@param $obj datos de la consulta
+	 *
+	 *@return $result array datos de transaccion
+	 * https://github.com/abr4xas/php-instapago/blob/master/help/DOCUMENTACION.md#PENDIENTE
+	 */
+	public function checkResponseCode($obj)
+	{
+		$code = $obj->code;
+
+		if ($code == 400) {
+			throw new InstapagoException('Error al validar los datos enviados.');
+		}
+		if ($code == 401) {
+			throw new InstapagoException('Error de autenticación, ha ocurrido un error con las llaves utilizadas.');
+		}
+		if ($code == 403) {
+			throw new InstapagoException('Pago Rechazado por el banco.');
+		}
+		if ($code == 500) {
+			throw new InstapagoException('Ha Ocurrido un error interno dentro del servidor.');
+		}
+		if ($code == 503) {
+			throw new InstapagoException('Ha Ocurrido un error al procesar los parámetros de entrada. Revise los datos enviados y vuelva a intentarlo.');
+		}
+		if ($code == 201) {
+			return [
+				'code'         => $code,
+				'msg_banco'    => $obj->message,
+				'voucher'      => html_entity_decode($obj->voucher),
+				'id_pago'      => $obj->id,
+				'reference'    => $obj->reference,
+			];
+		}
+	}
+
+	/**
+	 * Verifica parametros para realizar operación
+	 * Verifica y retorna exception si algun parametro esta vacio.
+	 *
+	 *@param $params Array con parametros a verificar
+	 *
+	 *@return new InstapagoException
+	 * https://github.com/abr4xas/php-instapago/blob/master/help/DOCUMENTACION.md#PENDIENTE
+	 */
+	private function checkRequiredParams(array $params)
+	{
+		foreach ($params as $param) {
+			if (empty($param)) {
+				throw new InstapagoException('Parámetros faltantes para procesar el pago. Verifique la documentación.');
+			}
+		}
+	}
 } // end class