forked from piotrplenik/clean-code-php
-
Notifications
You must be signed in to change notification settings - Fork 24
/
README.md
1956 lines (1494 loc) · 49 KB
/
README.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Clean Code PHP
Traducción al español de [Clean Code PHP](https://github.com/jupeter/clean-code-php) realizado por [Jupeter](https://github.com/jupeter/).
Si encuentras un error de ortografía, de redacción o de traducción; no dudes en hacer un PR.
## Tabla de contenidos
1. [Introducción](#introducción)
2. [Variables](#variables)
* [Usar variables que tengan significado y sean pronunciables](#usar-variables-que-tengan-significado-y-sean-pronunciables)
* [Usar el mismo vocabulario para el mismo tipo de variable](#usar-el-mismo-vocabulario-para-el-mismo-tipo-de-variable)
* [Usar nombres que puedan ser buscados (parte 1)](#usar-nombres-que-puedan-ser-buscados-parte-1)
* [Usar nombres que puedan ser buscados (parte 2)](#usar-nombres-que-puedan-ser-buscados-parte-2)
* [Usar variables explicativas](#usar-variables-explicativas)
* [Evitar anidación profunda usando return tempranamente (parte 1)](#evitar-anidación-profunda-usando-return-tempranamente-parte-1)
* [Evitar anidación profunda usando return tempranamente (parte 2)](#evitar-anidación-profunda-usando-return-tempranamente-parte-2)
* [Evitar mapas mentales](#evitar-mapas-mentales)
* [No agregar contexto innecesario](#no-agregar-contexto-innecesario)
* [Usar argumentos por defecto en lugar de cortocircuitos o condicionales](#usar-argumentos-por-defecto-en-lugar-de-cortocircuitos-o-condicionales)
3. [Funciones](#funciones)
* [Argumentos de la función (idealmente 2 o menos)](#argumentos-de-la-función-idealmente-2-o-menos)
* [Las funciones deben hacer una cosa](#las-funciones-deben-hacer-una-cosa)
* [Los nombres de las funciones deben indicar lo que hacen](#los-nombres-de-las-funciones-deben-indicar-lo-que-hacen)
* [Las funciones deben tener sólo un nivel de abstracción](#las-funciones-deben-tener-sólo-un-nivel-de-abstracción)
* [No usar banderas como parámetros de funciones](#no-usar-banderas-como-parámetros-de-funciones)
* [Evitar efectos secundarios](#evitar-efectos-secundarios)
* [No escribir funciones globales](#no-escribir-funciones-globales)
* [No usar el patrón Singleton](#no-usar-el-patrón-singleton)
* [Encapsular condicionales](#encapsular-condicionales)
* [Evitar condicionales negativos](#evitar-condicionales-negativos)
* [Evitar condicionales](#evitar-condicionales)
* [Evitar revisión de tipo (parte 1)](#evitar-revisión-de-tipo-parte-1)
* [Evitar revisión de tipo (parte 2)](#evitar-revisión-de-tipo-parte-2)
* [Quitar código muerto](#quitar-código-muerto)
4. [Objetos y estructuras de datos](#objetos-y-estructuras-de-datos)
* [Usar encapsulación de objetos](#usar-encapsulación-de-objetos)
* [Hacer que los objetos tengan partes private/protected](#hacer-que-los-objetos-tengan-partes-privateprotected)
5. [Clases](#clases)
* [Preferir composición antes que herencia](#preferir-composición-antes-que-herencia)
* [Evitar interfaces fluidas](#evitar-interfaces-fluidas)
6. [SOLID](#solid)
* [Principio de responsabilidad única](#principio-de-responsabilidad-única)
* [Principio de abierto/cerrado](#principio-de-abiertocerrado)
* [Principio de la sustitución de Liskov](#principio-de-la-sustitución-de-liskov)
* [Principio de segregación de la interfaz](#principio-de-segregación-de-la-interfaz)
* [Principio de la inversión de dependencia](#principio-de-la-inversión-de-dependencia)
7. [No te repitas](#no-te-repitas)
8. [Traducciones](#traducciones)
## Introducción
Adaptación para PHP de los principios de ingeniería de software descritos por Robert C. Martin en su libro
[*Clean Code*](https://www.amazon.com/Clean-Code-Handbook-Software-Craftsmanship/dp/0132350882). Esta no es una guía de estilo. Es una guía para producir software que sea legible, reutilizable y refactorizable en PHP.
No todos los principios deben ser seguidos estrictamente, e incluso unos pocos serán aceptados totalmente. Estos son una referencia y nada más, pero han sido desarrollados tras los años de experiencia del autor de *Clean Code*.
Inspirado por [clean-code-javascript](https://github.com/ryanmcdermott/clean-code-javascript)
A pesar de que muchos desarrolladores aún utilizan PHP 5, la mayoría de los ejemplos en este artículo funcionan sólo en PHP 7.1+.
## Variables
### Usar variables que tengan significado y sean pronunciables
**Mal:**
```php
$ymdstr = $moment->format('y-m-d');
```
**Bien:**
```php
$currentDate = $moment->format('y-m-d');
```
**[⬆Volver](#tabla-de-contenidos)**
### Usar el mismo vocabulario para el mismo tipo de variable
**Mal:**
```php
getUserInfo();
getUserData();
getUserRecord();
getUserProfile();
```
**Bien:**
```php
getUser();
```
**[⬆Volver](#tabla-de-contenidos)**
### Usar nombres que puedan ser buscados (parte 1)
Leerás más código del que puedas escribir. Es importante que el código que escribimos sea legible y que pueda ser buscado. Dañamos a nuestros lectores al *no* escribir nombres de variables que tengan significado para entender nuestro programa. Crea nombres que puedan ser buscados.
**Mal:**
```php
// ¿Qué diablos significa 448?
$result = $serializer->serialize($data, 448);
```
**Bien:**
```php
$json = $serializer->serialize($data, JSON_UNESCAPED_SLASHES | JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE);
```
### Usar nombres que puedan ser buscados (parte 2)
**Mal:**
```php
// ¿Qué diablos significa 4?
if ($user->access & 4) {
// ...
}
```
**Bien:**
```php
class User
{
const ACCESS_READ = 1;
const ACCESS_CREATE = 2;
const ACCESS_UPDATE = 4;
const ACCESS_DELETE = 8;
}
if ($user->access & User::ACCESS_UPDATE) {
// Editar ...
}
```
**[⬆Volver](#tabla-de-contenidos)**
### Usar variables explicativas
**Mal:**
```php
$address = 'One Infinite Loop, Cupertino 95014';
$cityZipCodeRegex = '/^[^,]+,\s*(.+?)\s*(\d{5})$/';
preg_match($cityZipCodeRegex, $address, $matches);
saveCityZipCode($matches[1], $matches[2]);
```
**Nada mal:**
Está mejor, pero todavía es muy dependiente de la expresión regular.
```php
$address = 'One Infinite Loop, Cupertino 95014';
$cityZipCodeRegex = '/^[^,]+,\s*(.+?)\s*(\d{5})$/';
preg_match($cityZipCodeRegex, $address, $matches);
[, $city, $zipCode] = $matches;
saveCityZipCode($city, $zipCode);
```
**Bien:**
Disminuye la dependencia a la expresión regular al nombrar subpatrones.
```php
$address = 'One Infinite Loop, Cupertino 95014';
$cityZipCodeRegex = '/^[^,]+,\s*(?<city>.+?)\s*(?<zipCode>\d{5})$/';
preg_match($cityZipCodeRegex, $address, $matches);
saveCityZipCode($matches['city'], $matches['zipCode']);
```
**[⬆Volver](#tabla-de-contenidos)**
### Evitar anidación profunda usando return tempranamente (parte 1)
Muchas declaraciones if else pueden hacer tu código difícil de seguir. Explicito es mejor que implícito.
**Mal:**
```php
function isShopOpen($day): bool
{
if ($day) {
if (is_string($day)) {
$day = strtolower($day);
if ($day === 'friday') {
return true;
} elseif ($day === 'saturday') {
return true;
} elseif ($day === 'sunday') {
return true;
} else {
return false;
}
} else {
return false;
}
} else {
return false;
}
}
```
**Bien:**
```php
function isShopOpen(string $day): bool
{
if (empty($day)) {
return false;
}
$openingDays = [
'friday', 'saturday', 'sunday'
];
return in_array(strtolower($day), $openingDays, true);
}
```
**[⬆Volver](#tabla-de-contenidos)**
### Evitar anidación profunda usando return tempranamente (parte 2)
**Mal:**
```php
function fibonacci(int $n)
{
if ($n < 50) {
if ($n !== 0) {
if ($n !== 1) {
return fibonacci($n - 1) + fibonacci($n - 2);
} else {
return 1;
}
} else {
return 0;
}
} else {
return 'Not supported';
}
}
```
**Bien:**
```php
function fibonacci(int $n): int
{
if ($n === 0 || $n === 1) {
return $n;
}
if ($n > 50) {
throw new \Exception('Not supported');
}
return fibonacci($n - 1) + fibonacci($n - 2);
}
```
**[⬆Volver](#tabla-de-contenidos)**
### Evitar mapas mentales
No fuerces al lector de tu código a traducir lo que significa una variable.
Explicito es mejor que implícito.
**Mal:**
```php
$l = ['Austin', 'New York', 'San Francisco'];
for ($i = 0; $i < count($l); $i++) {
$li = $l[$i];
doStuff();
doSomeOtherStuff();
// ...
// ...
// ...
// Espera, ¿Para qué era `$li`?
dispatch($li);
}
```
**Bien:**
```php
$locations = ['Austin', 'New York', 'San Francisco'];
foreach ($locations as $location) {
doStuff();
doSomeOtherStuff();
// ...
// ...
// ...
dispatch($location);
}
```
**[⬆Volver](#tabla-de-contenidos)**
### No agregar contexto innecesario
Si el nombre de tu clase/objeto te dice algo, no lo repitas en el nombre del atributo.
**Mal:**
```php
class Car
{
public $carMake;
public $carModel;
public $carColor;
//...
}
```
**Bien:**
```php
class Car
{
public $make;
public $model;
public $color;
//...
}
```
**[⬆Volver](#tabla-de-contenidos)**
### Usar argumentos por defecto en lugar de cortocircuitos o condicionales
**Nada bien:**
No está bien porque `$breweryName` puede ser `NULL`.
```php
function createMicrobrewery($breweryName = 'Hipster Brew Co.'): void
{
// ...
}
```
**Nada mal:**
Está opción es más entendible que la versión anterior, pero es mejor controlar el valor de la variable.
```php
function createMicrobrewery($name = null): void
{
$breweryName = $name ?: 'Hipster Brew Co.';
// ...
}
```
**Bien:**
Si tienes instalado PHP 7+, entonces puedas usar [implicación de tipos](http://php.net/manual/en/functions.arguments.php#functions.arguments.type-declaration) y así asegurarte de que `$breweryName` no será `NULL`.
```php
function createMicrobrewery(string $breweryName = 'Hipster Brew Co.'): void
{
// ...
}
```
**[⬆Volver](#tabla-de-contenidos)**
## Funciones
### Argumentos de la función (idealmente 2 o menos)
Limitar la cantidad de parámetros de una función es increíblemente importante porque la hace más fácil de probar. Teniendo más de tres lleva a una explosión de combinaciones que tendrás que probar, argumento por argumento.
El caso ideal es cero argumentos. Uno o dos argumentos están bien, pero tres deben ser evitados. Algo más debe ser dicho. Usualmente, si tienes más de dos argumentos significa que estás intentando hacer demasiado en la función. En los casos en que no, la mayoría del tiempo un objeto de alto nivel será suficiente como argumento.
**Mal:**
```php
function createMenu(string $title, string $body, string $buttonText, bool $cancellable): void
{
// ...
}
```
**Bien:**
```php
class MenuConfig
{
public $title;
public $body;
public $buttonText;
public $cancellable = false;
}
$config = new MenuConfig();
$config->title = 'Foo';
$config->body = 'Bar';
$config->buttonText = 'Baz';
$config->cancellable = true;
function createMenu(MenuConfig $config): void
{
// ...
}
```
**[⬆Volver](#tabla-de-contenidos)**
### Las funciones deben hacer una cosa
Esta es por lejos una de las más importantes reglas en ingeniería de software. Cuando las funciones hacen más de una cosa, se vuelven difíciles de hacer, probar y razonar sobre ellas. Cuando puedes aislar una función en una sola acción, ellas pueden ser refactorizadas con facilidad y tu código será mucho más limpio de leer. Si esta es la única regla que sigas de esta guía, estarás por sobre muchos desarrolladores.
**Mal:**
```php
function emailClients(array $clients): void
{
foreach ($clients as $client) {
$clientRecord = $db->find($client);
if ($clientRecord->isActive()) {
email($client);
}
}
}
```
**Bien:**
```php
function emailClients(array $clients): void
{
$activeClients = activeClients($clients);
array_walk($activeClients, 'email');
}
function activeClients(array $clients): array
{
return array_filter($clients, 'isClientActive');
}
function isClientActive(int $client): bool
{
$clientRecord = $db->find($client);
return $clientRecord->isActive();
}
```
**[⬆Volver](#tabla-de-contenidos)**
### Los nombres de las funciones deben indicar lo que hacen
**Mal:**
```php
class Email
{
//...
public function handle(): void
{
mail($this->to, $this->subject, $this->body);
}
}
$message = new Email(...);
// ¿Qué es esto? ¿Un manejador para los mensajes? ¿Ahora escribimos en un archivo?
$message->handle();
```
**Bien:**
```php
class Email
{
//...
public function send(): void
{
mail($this->to, $this->subject, $this->body);
}
}
$message = new Email(...);
// Limpio y obvio
$message->send();
```
**[⬆Volver](#tabla-de-contenidos)**
### Las funciones deben tener sólo un nivel de abstracción
Cuando tienes más de un nivel de abstracción usualmente es porque tu función está haciendo demasiado. Separarlas en funciones lleva a la reutilización y facilita las pruebas.
**Mal:**
```php
function parseBetterJSAlternative(string $code): void
{
$regexes = [
// ...
];
$statements = explode(' ', $code);
$tokens = [];
foreach ($regexes as $regex) {
foreach ($statements as $statement) {
// ...
}
}
$ast = [];
foreach ($tokens as $token) {
// lex...
}
foreach ($ast as $node) {
// convertir...
}
}
```
**También mal:**
Hemos separado algunas de las funcionalidades, pero la función `parseBetterJSAlternative()` todavía es muy compleja e imposible de probar.
```php
function tokenize(string $code): array
{
$regexes = [
// ...
];
$statements = explode(' ', $code);
$tokens = [];
foreach ($regexes as $regex) {
foreach ($statements as $statement) {
$tokens[] = /* ... */;
}
}
return $tokens;
}
function lexer(array $tokens): array
{
$ast = [];
foreach ($tokens as $token) {
$ast[] = /* ... */;
}
return $ast;
}
function parseBetterJSAlternative(string $code): void
{
$tokens = tokenize($code);
$ast = lexer($tokens);
foreach ($ast as $node) {
// convertir...
}
}
```
**Bien:**
Lo mejor es sacar las dependencias de la función `parseBetterJSAlternative()`.
```php
class Tokenizer
{
public function tokenize(string $code): array
{
$regexes = [
// ...
];
$statements = explode(' ', $code);
$tokens = [];
foreach ($regexes as $regex) {
foreach ($statements as $statement) {
$tokens[] = /* ... */;
}
}
return $tokens;
}
}
class Lexer
{
public function lexify(array $tokens): array
{
$ast = [];
foreach ($tokens as $token) {
$ast[] = /* ... */;
}
return $ast;
}
}
class BetterJSAlternative
{
private $tokenizer;
private $lexer;
public function __construct(Tokenizer $tokenizer, Lexer $lexer)
{
$this->tokenizer = $tokenizer;
$this->lexer = $lexer;
}
public function parse(string $code): void
{
$tokens = $this->tokenizer->tokenize($code);
$ast = $this->lexer->lexify($tokens);
foreach ($ast as $node) {
// convertir...
}
}
}
```
**[⬆Volver](#tabla-de-contenidos)**
### No usar banderas como parámetros de funciones
Las banderas le dicen al usuario que la función hace más de una cosa. Las funciones deben hacer sólo una. Divide tus funciones si ellas siguen diferentes caminos basados en un valor booleano.
**Mal:**
```php
function createFile(string $name, bool $temp = false): void
{
if ($temp) {
touch('./temp/'.$name);
} else {
touch($name);
}
}
```
**Bien:**
```php
function createFile(string $name): void
{
touch($name);
}
function createTempFile(string $name): void
{
touch('./temp/'.$name);
}
```
**[⬆Volver](#tabla-de-contenidos)**
### Evitar efectos secundarios
Una función produce un efecto secundario si hace algo más que tomar un valor y devolver otros. Un efecto secundario puede ser escribir en un archivo, modificar alguna variable global, o accidentalmente darle todo tu dinero a un extraño.
Ahora, ocasionalmente necesitaras los efectos secundarios en un programa. Como los ejemplos anteriores, necesitarás escribir en un archivo. Lo que quieres hacer en esos casos es centralizar donde realizarlos. No tengas muchas funciones y clases que escriban un archivo en particular. Ten un servicio que lo haga. Uno y sólo uno.
El punto principal es evitar trampas comunes como compartir estados entre objetos sin alguna estructura, usar tipos de datos mutables que puedan ser escritos por cualquiera, y no centralizar donde el efecto paralelo ocurre. Si puedes hacerlo, serás más feliz que la vasta mayoría de los demás programadores.
**Mal:**
```php
// Variable global referenciada por la siguiente función.
// Si tenemos otra función que use el mismo nombre, ahora será un arreglo y podría romperla.
$name = 'Ryan McDermott';
function splitIntoFirstAndLastName(): void
{
global $name;
$name = explode(' ', $name);
}
splitIntoFirstAndLastName();
var_dump($name); // ['Ryan', 'McDermott'];
```
**Bien:**
```php
function splitIntoFirstAndLastName(string $name): array
{
return explode(' ', $name);
}
$name = 'Ryan McDermott';
$newName = splitIntoFirstAndLastName($name);
var_dump($name); // 'Ryan McDermott';
var_dump($newName); // ['Ryan', 'McDermott'];
```
**[⬆Volver](#tabla-de-contenidos)**
### No escribir funciones globales
Contaminar los globales es una mala práctica en muchos lenguajes porque puedes chocar con otra librería y el usuario de tu API podría no enterarse hasta obtener una excepción en producción. Pensemos en un ejemplo: qué pasaría si esperabas tener un arreglo de configuración. Podrías escribir una función global como `config()`, pero podría chocar con otra librería que haya intentado hacer lo mismo.
**Mal:**
```php
function config(): array
{
return [
'foo' => 'bar',
]
}
```
**Bien:**
```php
class Configuration
{
private $configuration = [];
public function __construct(array $configuration)
{
$this->configuration = $configuration;
}
public function get(string $key): ?string
{
return isset($this->configuration[$key]) ? $this->configuration[$key] : null;
}
}
```
Crea la variable `$configuration` con una instancia de la clase `Configuration`
```php
$configuration = new Configuration([
'foo' => 'bar',
]);
```
Y ahora puedes usar una instancia de la clase `Configuration` en tu aplicación.
**[⬆Volver](#tabla-de-contenidos)**
### No usar el patrón Singleton
Singleton es un [anti-patrón](https://en.wikipedia.org/wiki/Singleton_pattern). Citando a Brian Button:
1. Son usados generalmente como una **instancia global**, ¿Por qué eso es malo? Porque **escondes las dependencias** de tu aplicación en tu código, en lugar de exponerlas mediante interfaces. Hacer algo global para evitar pasarlo es una [hediondez de código](https://en.wikipedia.org/wiki/Code_smell).
2. Violan el [principio de la responsabilidad única](#principio-de-responsabilidad-única): en virtud del hecho de que **ellos controlan su propia creación y ciclo de vida**.
3. Inherentemente causan que el código esté estrechamente [acoplado](https://en.wikipedia.org/wiki/Coupling_%28computer_programming%29). Esto hace que muchas veces sean **difíciles de probar**.
4. Llevan su estado al ciclo de vida de la aplicación. Otro golpe a las pruebas porque **puedes terminar con una situación donde las pruebas necesitan ser ordenadas** lo cual es un gran no para las pruebas unitarias. ¿Por qué? Porque cada prueba unitaria debe hacerse independiente de la otra.
[Misko Hevery](http://misko.hevery.com/about/) ha realizado unas reflexiones interesantes sobre el [origen del problema](http://misko.hevery.com/2008/08/25/root-cause-of-singletons/).
**Mal:**
```php
class DBConnection
{
private static $instance;
private function __construct(string $dsn)
{
// ...
}
public static function getInstance(): DBConnection
{
if (self::$instance === null) {
self::$instance = new self();
}
return self::$instance;
}
// ...
}
$singleton = DBConnection::getInstance();
```
**Bien:**
```php
class DBConnection
{
public function __construct(string $dsn)
{
// ...
}
// ...
}
```
Crea una instancia de la clase `DBConnection` y configúrala con [DSN](http://php.net/manual/en/pdo.construct.php#refsect1-pdo.construct-parameters).
```php
$connection = new DBConnection($dsn);
```
Y ahora debes usar la instancia de `DBConnection` en tu aplicación.
**[⬆Volver](#tabla-de-contenidos)**
### Encapsular condicionales
**Mal:**
```php
if ($article->state === 'published') {
// ...
}
```
**Bien:**
```php
if ($article->isPublished()) {
// ...
}
```
**[⬆Volver](#tabla-de-contenidos)**
### Evitar condicionales negativos
**Mal:**
```php
function isDOMNodeNotPresent(\DOMNode $node): bool
{
// ...
}
if (!isDOMNodeNotPresent($node))
{
// ...
}
```
**Bien:**
```php
function isDOMNodePresent(\DOMNode $node): bool
{
// ...
}
if (isDOMNodePresent($node)) {
// ...
}
```
**[⬆Volver](#tabla-de-contenidos)**
### Evitar condicionales
Esta parece ser una tarea imposible. Al escuchar esto por primera vez, la mayoría de la gente dice, "¿cómo se supone que haré algo sin una declaración `if`?" La respuesta es que la mayoría de las veces puedes usar polimorfismo para lograr el mismo resultado.
La segunda pregunta usualmente es, "bien, eso es genial, ¿pero cómo puedo hacerlo?" La respuesta es un concepto de código limpio que ya hemos aprendido: una función debe hacer sólo una cosa. Cuando tienes clases y funciones que usan declaraciones `if`, estás diciéndole al usuario que tu función hace más de una cosa. Recuerda, hacer sólo una cosa.
**Mal:**
```php
class Airplane
{
// ...
public function getCruisingAltitude(): int
{
switch ($this->type) {
case '777':
return $this->getMaxAltitude() - $this->getPassengerCount();
case 'Air Force One':
return $this->getMaxAltitude();
case 'Cessna':
return $this->getMaxAltitude() - $this->getFuelExpenditure();
}
}
}
```
**Bien:**
```php
interface Airplane
{
// ...
public function getCruisingAltitude(): int;
}
class Boeing777 implements Airplane
{
// ...
public function getCruisingAltitude(): int
{
return $this->getMaxAltitude() - $this->getPassengerCount();
}
}
class AirForceOne implements Airplane
{
// ...
public function getCruisingAltitude(): int
{
return $this->getMaxAltitude();
}
}
class Cessna implements Airplane
{
// ...
public function getCruisingAltitude(): int
{
return $this->getMaxAltitude() - $this->getFuelExpenditure();
}
}
```
**[⬆Volver](#tabla-de-contenidos)**
### Evitar revisión de tipo (parte 1)
PHP es un lenguaje no tipado, lo que quiere decir que tus funciones pueden tener cualquier tipo de argumento.
Algunas veces habrás sentido esta libertad y te habrás tentado a hacer revisión de tipo en tus funciones. Hay muchas maneras de evitar tener que hacerlo.
Lo primero es considerar la consistencia de las APIs.
**Mal:**
```php
function travelToTexas($vehicle): void
{
if ($vehicle instanceof Bicycle) {
$vehicle->pedalTo(new Location('texas'));
} elseif ($vehicle instanceof Car) {
$vehicle->driveTo(new Location('texas'));
}
}
```
**Bien:**
```php
function travelToTexas(Traveler $vehicle): void
{
$vehicle->travelTo(new Location('texas'));
}
```
**[⬆Volver](#tabla-de-contenidos)**
### Evitar revisión de tipo (parte 2)
Si estás trabajando con valores básicos primitivos como cadenas, enteros y arreglos; y estás usando PHP 7+ y no puedes usar polimorfismo pero aún necesitas realizar una revisión de tipo entonces puedes considerar [declaración de tipo](http://php.net/manual/en/functions.arguments.php#functions.arguments.type-declaration) o modo estricto. Esto provee tipado estático sobre la sintaxis estándar de PHP.
El problema con hacer la revisión de tipo manualmente es que requerirá escribir texto adicional que dará una falsa "seguridad de tipado" que no compensará la perdida de legibilidad. Mantén tu código PHP limpio, escribe buenas pruebas, y realiza buenas revisiones.
Dicho de otra forma, realiza todo lo que se ha recomendado pero usando la declaración de tipo estricto en PHP o el modo estricto.
**Mal:**
```php
function combine($val1, $val2): int
{
if (!is_numeric($val1) || !is_numeric($val2)) {
throw new \Exception('Must be of type Number');
}
return $val1 + $val2;
}
```
**Bien:**
```php
function combine(int $val1, int $val2): int
{
return $val1 + $val2;