Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
1 | <?php |
||
40 | class InstapagoPayment |
||
41 | { |
||
42 | protected $keyId; |
||
43 | protected $publicKeyId; |
||
44 | public $cardHolder; |
||
45 | public $cardHolderId; |
||
46 | public $cardNumber; |
||
47 | public $cvc; |
||
48 | public $expirationDate; |
||
49 | public $amount; |
||
50 | public $description; |
||
51 | public $statusId; |
||
52 | public $ipAddres; |
||
53 | public $idPago; |
||
54 | |||
55 | /** |
||
56 | * Crear un nuevo objeto de Instapago. |
||
57 | * |
||
58 | * @param string $keyId llave privada |
||
59 | * @param string $publicKeyId llave publica |
||
60 | * Requeridas. |
||
61 | */ |
||
62 | public function __construct($keyId, $publicKeyId) |
||
63 | { |
||
64 | try { |
||
65 | if (empty($keyId) && empty($publicKeyId)) { |
||
66 | throw new InstapagoException('Los parámetros "keyId" y "publicKeyId" son requeridos para procesar la petición.'); |
||
67 | } |
||
68 | |||
69 | if (empty($keyId)) { |
||
70 | throw new InstapagoException('El parámetro "keyId" es requerido para procesar la petición. '); |
||
71 | } |
||
72 | |||
73 | if (empty($publicKeyId)) { |
||
74 | throw new InstapagoException('El parámetro "publicKeyId" es requerido para procesar la petición.'); |
||
75 | } |
||
76 | |||
77 | $this->publicKeyId = $publicKeyId; |
||
78 | $this->keyId = $keyId; |
||
79 | } catch (InstapagoException $e) { |
||
80 | echo $e->getMessage(); |
||
81 | } // end try/catch |
||
82 | } |
||
83 | |||
84 | /** |
||
85 | * Crear un pago |
||
86 | * Efectúa un pago con tarjeta de crédito, una vez procesado retornar una respuesta. |
||
87 | * https://github.com/abr4xas/php-instapago/blob/master/help/DOCUMENTACION.md#crear-un-pago. |
||
88 | */ |
||
89 | public function payment($amount, $description, $cardHolder, $cardHolderId, $cardNumber, $cvc, $expirationDate, $statusId, $ipAddres) |
||
90 | { |
||
91 | try { |
||
92 | $params = [$amount, $description, $cardHolder, $cardHolderId, $cardNumber, $cvc, $expirationDate, $statusId, $ipAddres]; |
||
93 | $this->checkRequiredParams($params); |
||
94 | |||
95 | $this->amount = $amount; |
||
96 | $this->description = $description; |
||
97 | $this->cardHolder = $cardHolder; |
||
98 | $this->cardHolderId = $cardHolderId; |
||
99 | $this->cardNumber = $cardNumber; |
||
100 | $this->cvc = $cvc; |
||
101 | $this->expirationDate = $expirationDate; |
||
102 | $this->statusId = $statusId; |
||
103 | $this->ipAddres = $ipAddres; |
||
104 | |||
105 | $url = 'payment'; // endpoint |
||
106 | |||
107 | $fields = [ |
||
108 | 'KeyID' => $this->keyId, //required |
||
109 | 'PublicKeyId' => $this->publicKeyId, //required |
||
110 | 'amount' => $this->amount, //required |
||
111 | 'description' => $this->description, //required |
||
112 | 'cardHolder' => $this->cardHolder, //required |
||
113 | 'cardHolderId' => $this->cardHolderId, //required |
||
114 | 'cardNumber' => $this->cardNumber, //required |
||
115 | 'cvc' => $this->cvc, //required |
||
116 | 'expirationDate' => $this->expirationDate, //required |
||
117 | 'statusId' => $this->statusId, //required |
||
118 | 'IP' => $this->ipAddres, //required |
||
119 | ]; |
||
120 | |||
121 | $obj = $this->curlTransaccion($url, $fields, 'POST'); |
||
122 | $result = $this->checkResponseCode($obj); |
||
123 | |||
124 | return $result; |
||
125 | } catch (InstapagoException $e) { |
||
126 | echo $e->getMessage(); |
||
127 | } // end try/catch |
||
128 | } |
||
129 | |||
130 | /** |
||
131 | * Completar Pago |
||
132 | * Este método funciona para procesar un bloqueo o pre-autorización |
||
133 | * para así procesarla y hacer el cobro respectivo. |
||
134 | * Para usar este método es necesario configurar en `payment()` el parametro statusId a 1 |
||
135 | * https://github.com/abr4xas/php-instapago/blob/master/help/DOCUMENTACION.md#completar-pago. |
||
136 | */ |
||
137 | |||
138 | public function continuePayment($idPago, $amount) |
||
164 | |||
165 | /** |
||
166 | * Anular Pago |
||
167 | * Este método funciona para procesar una anulación de un pago o un bloqueo. |
||
168 | * https://github.com/abr4xas/php-instapago/blob/master/help/DOCUMENTACION.md#anular-pago. |
||
169 | */ |
||
170 | View Code Duplication | public function cancelPayment($idPago) |
|
171 | { |
||
172 | try { |
||
173 | $params = [$idPago]; |
||
174 | $this->checkRequiredParams($params); |
||
175 | |||
176 | $this->idPago = $idPago; |
||
177 | |||
178 | $url = 'payment'; // endpoint |
||
179 | |||
180 | $fields = [ |
||
181 | 'KeyID' => $this->keyId, //required |
||
182 | 'PublicKeyId' => $this->publicKeyId, //required |
||
183 | 'Id' => $this->idPago, //required |
||
184 | ]; |
||
185 | $obj = $this->curlTransaccion($url, $fields, 'DELETE'); |
||
186 | |||
187 | $result = $this->checkResponseCode($obj); |
||
188 | return $result; |
||
189 | |||
190 | } catch (InstapagoException $e) { |
||
191 | echo $e->getMessage(); |
||
192 | } // end try/catch |
||
193 | } |
||
194 | |||
195 | // cancelPayment |
||
196 | |||
197 | /** |
||
198 | * Información del Pago |
||
199 | * Consulta información sobre un pago generado anteriormente. |
||
200 | * Requiere como parámetro el `id` que es el código de referencia de la transacción |
||
201 | * https://github.com/abr4xas/php-instapago/blob/master/help/DOCUMENTACION.md#información-del-pago. |
||
202 | */ |
||
203 | View Code Duplication | public function paymentInfo($idPago) |
|
204 | { |
||
205 | try { |
||
206 | $params = [$idPago]; |
||
207 | $this->checkRequiredParams($params); |
||
208 | |||
209 | $this->idPago = $idPago; |
||
210 | |||
211 | $url = 'payment'; // endpoint |
||
212 | |||
213 | $fields = [ |
||
214 | 'KeyID' => $this->keyId, //required |
||
215 | 'PublicKeyId' => $this->publicKeyId, //required |
||
216 | 'id' => $this->idPago, //required |
||
217 | ]; |
||
218 | |||
219 | $obj = $this->curlTransaccion($url, $fields, 'GET'); |
||
220 | |||
221 | $result = $this->checkResponseCode($obj); |
||
222 | |||
223 | return $result; |
||
224 | |||
225 | } catch (InstapagoException $e) { |
||
226 | echo $e->getMessage(); |
||
227 | } // end try/catch |
||
228 | } |
||
229 | |||
230 | // paymentInfo |
||
231 | |||
232 | /** |
||
233 | * Realiza Transaccion |
||
234 | * Efectúa y retornar una respuesta a un metodo de pago. |
||
235 | * |
||
236 | *@param $url endpoint a consultar |
||
237 | *@param $fields datos para la consulta |
||
238 | * |
||
239 | *@return $obj array resultados de la transaccion |
||
240 | * https://github.com/abr4xas/php-instapago/blob/master/help/DOCUMENTACION.md#PENDIENTE |
||
241 | */ |
||
242 | public function curlTransaccion($url, $fields, $method) |
||
243 | { |
||
244 | |||
245 | |||
246 | $client = new Client([ |
||
247 | 'base_uri' => 'https://api.instapago.com/', |
||
248 | //'debug' => true, |
||
249 | ]); |
||
250 | |||
251 | if ($method == 'GET') { |
||
252 | $request = $client->request('GET', $url, [ |
||
253 | 'query' => $fields |
||
254 | ]); |
||
255 | } |
||
256 | if ($method == 'POST' || $method == 'DELETE') { |
||
257 | $request = $client->request($method, $url, [ |
||
258 | 'form_params' => $fields |
||
259 | ]); |
||
260 | } |
||
261 | |||
262 | $body = $request->getBody()->getContents(); |
||
263 | |||
264 | $obj = json_decode($body); |
||
265 | |||
266 | return $obj; |
||
267 | } |
||
268 | |||
269 | /** |
||
270 | * Verifica Codigo de Estado de transaccion |
||
271 | * Verifica y retornar el resultado de la transaccion. |
||
272 | * |
||
273 | *@param $obj datos de la consulta |
||
274 | * |
||
275 | *@return $result array datos de transaccion |
||
276 | * https://github.com/abr4xas/php-instapago/blob/master/help/DOCUMENTACION.md#PENDIENTE |
||
277 | */ |
||
278 | public function checkResponseCode($obj) |
||
279 | { |
||
280 | $code = $obj->code; |
||
281 | |||
282 | if ($code == 400) { |
||
283 | throw new InstapagoException('Error al validar los datos enviados.'); |
||
284 | } |
||
285 | if ($code == 401) { |
||
286 | throw new InstapagoException('Error de autenticación, ha ocurrido un error con las llaves utilizadas.'); |
||
287 | } |
||
288 | if ($code == 403) { |
||
289 | throw new InstapagoException('Pago Rechazado por el banco.'); |
||
290 | } |
||
291 | if ($code == 500) { |
||
292 | throw new InstapagoException('Ha Ocurrido un error interno dentro del servidor.'); |
||
293 | } |
||
294 | if ($code == 503) { |
||
295 | throw new InstapagoException('Ha Ocurrido un error al procesar los parámetros de entrada. Revise los datos enviados y vuelva a intentarlo.'); |
||
296 | } |
||
297 | if ($code == 201) { |
||
298 | return [ |
||
299 | 'code' => $code, |
||
300 | 'msg_banco' => $obj->message, |
||
301 | 'voucher' => html_entity_decode($obj->voucher), |
||
302 | 'id_pago' => $obj->id, |
||
303 | 'reference' => $obj->reference, |
||
304 | ]; |
||
305 | } |
||
306 | } |
||
307 | |||
308 | /** |
||
309 | * Verifica parametros para realizar operación |
||
310 | * Verifica y retorna exception si algun parametro esta vacio. |
||
311 | * |
||
312 | *@param $params Array con parametros a verificar |
||
313 | * |
||
314 | *@return new InstapagoException |
||
315 | * https://github.com/abr4xas/php-instapago/blob/master/help/DOCUMENTACION.md#PENDIENTE |
||
316 | */ |
||
317 | private function checkRequiredParams(array $params) |
||
325 | } // end class |
||
326 |
The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file.
The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place.
To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1.