forked from piotrplenik/clean-code-php
-
Notifications
You must be signed in to change notification settings - Fork 13
/
Copy pathREADME.md
2073 lines (1563 loc) · 51.9 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
# PHP Temiz Kod
## İçindekiler
1. [Giriş](#giriş)
2. [Değişkenler](#değişkenler)
* [Anlamlı ve telaffuz edilebilir değişken isimleri kullanın](#anlamlı-ve-telaffuz-edilebilir-değişken-isimleri-kullanın)
* [Aynı türden değişkenler için aynı kelimeleri kullanın](#aynı-türden-değişkenler-için-aynı-kelimeleri-kullanın)
* [Aranabilir isimler kullanın (bölüm 1)](#aranabilir-isimler-kullanın-bölüm-1)
* [Aranabilir isimler kullanın (bölüm 2)](#aranabilir-isimler-kullanın-bölüm-2)
* [Açıklayıcı değişkenler kullanın](#açıklayıcı-değişkenler-kullanın)
* [Çok fazla iç içe kullanımdan ve geri döndürmeden kaçının (bölüm 1)](#Çok-fazla-iç-içe-kullanımdan-ve-geri-döndürmeden-kaçının-bölüm-1)
* [Çok fazla iç içe kullanımdan ve geri döndürmeden kaçının (bolum 2)](#Çok-fazla-iç-içe-kullanımdan-ve-geri-döndürmeden-kaçının-bölüm-1)
* [Zihin Haritasından Kaçının](#zihin-haritasından-kaçının)
* [Gereksiz bağlam eklemeyin](#gereksiz-bağlam-eklemeyin)
* [Kısaltmalar veya şartlılar yerine varsayılan argümanları kullanın](#kısaltmalar-veya-şartlılar-yerine-varsayılan-argümanları-kullanın)
3. [Karşılaştırma](#karşılaştırma)
* [Aynı karşılaştırmayı kullanın](#aynı-karşılaştırmayı-kullanın)
4. [Fonksiyonlar](#fonksiyonlar)
* [Fonksiyon Parametreleri (2 veya daha az ideal)](#fonksiyon-parametreleri-2-veya-daha-az-ideal)
* [Fonksiyonlar bir şey yapmalı](#fonksiyonlar-bir-şey-yapmalı)
* [Fonksiyon isimleri ne yaptıklarını söylemeli](#fonksiyon-isimleri-ne-yaptıklarını-söylemeli)
* [Fonksiyonlar sadece bir seviye soyutlama olmalıdır](#fonksiyonlar-sadece-bir-seviye-soyutlama-olmalıdır)
* [Bayrakları, fonksiyon parametreleri olarak kullanmayın](#bayrakları-fonksiyon-parametreleri-olarak-kullanmayın)
* [Yan Etkilerden Kaçının](#yan-etkilerden-kaçının)
* [Global Fonksiyonlar yazmayın](#global-fonksiyonlar-yazmayın)
* [Singleton desenini kullanmayın](#singleton-desenini-kullanmayın)
* [Koşulları kapsülleyin](#koşulları-kapsülleyin)
* [Olumsuz koşullardan kaçının](#olumsuz-koşullardan-kaçının)
* [Koşullardan kaçının](#koşullardan-kaçının)
* [Tür kontrolünden kaçının (bölüm 1)](#tür-kontrolünden-kaçının-bölüm-1)
* [Tür kontrolünden kaçının (bölüm 2)](#tür-kontrolünden-kaçının-bölüm-2)
* [Ölü Kodu kaldırın](#Ölü-kodu-kaldırın)
5. [Nesneler ve Veri Yapıları](#nesneler-ve-veri-yapıları)
* [Nesne kapsülleme kullanın](#nesne-kapsülleme-kullanın)
* [Nesnelerin `private/protected` üyelere sahip olmasını sağlayın](#nesnelerin-privateprotected-üyelere-sahip-olmasını-sağlayın)
6. [Sınıflar](#sınıflar)
* [Kalıtım üzerinden birleşimi tercih edin](#kalıtım-üzerinden-birleşimi-tercih-edin)
* [Akıcı (`Fluent`) arayüzlerden kaçının](#akıcı-fluent-arayüzlerden-kaçının)
* [`final` sınıflarını tercih edin](#final-sınıflarını-tercih-edin)
7. [SOLID](#solid)
* [Tek Sorumluluk Prensibi (SRP)](#tek-sorumluluk-prensibi-srp)
* [Açık/Kapalı Prensibi (OCP)](#açıkkapalı-prensibi-ocp)
* [Liskov'un Yerine Geçme Prensibi (LSP)](#liskovun-yerine-geçme-prensibi-lsp)
* [Arayüz Ayırma Prensibi (ISP)](#arayüz-ayırma-prensibi-isp)
* [Bağlılığı Tersine Çevirme Prensibi (DIP)](#bağlılığı-tersine-Çevirme-prensibi-dip)
8. [Kendinizi Tekrar Etmeyin (DRY)](#kendinizi-tekrar-etmeyin-dry)
9. [Çeviriler](#Çeviriler)
## Giriş
Yazılım mühendisliği prensipleri,Robert C. Martin'in [*Temiz Kod*](https://www.amazon.com/Clean-Code-Handbook-Software-Craftsmanship/dp/0132350882) kitabından, PHP için uyarlanmıştır. Bu bir stil kılavuzu değildir. PHP’de okunabilir, yeniden kullanılabilir ve düzenlenebilir yazılımlar üretmek için bir kılavuzdur.
Buradaki her prensibe tamamen uyulmamalıdır, ve evrensel olarak daha az kabul edilecek. Bunlar ilke ve başka birşey değildir, ama bunlar *Temiz Kod* yazarlarının uzun yıllara dayanan kolektif deneyimlerine göre kodlanmıştır.
[temiz-kod-javascript](https://github.com/ryanmcdermott/clean-code-javascript) den ilham alınmıştır.
Çoğu geliştirici hala PHP 5 kullanıyor olsa da, bu makaledeki örneklerin çoğu sadece PHP 7.1+ ile çalışmaktadır.
## Değişkenler
### Anlamlı ve telaffuz edilebilir değişken isimleri kullanın
**Kötü:**
```php
$ymdstr = $moment->format('y-m-d');
```
**İyi:**
```php
$currentDate = $moment->format('y-m-d');
```
**[⬆ yukarı çık](#İçindekiler)**
### Aynı türden değişkenler için aynı kelimeleri kullanın
**Kötü:**
```php
getUserInfo();
getUserData();
getUserRecord();
getUserProfile();
```
**İyi:**
```php
getUser();
```
**[⬆ yukarı çık](#İçindekiler)**
### Aranabilir isimler kullanın (bölüm 1)
Yazacağımızdan daha fazla kod okuyacağız. Önemli olan okunabilir ve aranabilir kod yazmamızdır. Değişkenleri anlamlı *isimlendirmezsek* programımızı anlamaya çalışan okuyucularımıza zarar verebiliriz.
İsimleri aranabilir yapın.
**Kötü:**
```php
// 448 ne için ?
$result = $serializer->serialize($data, 448);
```
**İyi:**
```php
$json = $serializer->serialize($data, JSON_UNESCAPED_SLASHES | JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE);
```
### Aranabilir isimler kullanın (bölüm 2)
**Kötü:**
```php
// 4 ne için?
if ($user->access & 4) {
// ...
}
```
**İyi:**
```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) {
// düzenle ...
}
```
**[⬆ yukarı çık](#İçindekiler)**
### Açıklayıcı değişkenler kullanın
**Kötü:**
```php
$address = 'One Infinite Loop, Cupertino 95014';
$cityZipCodeRegex = '/^[^,]+,\s*(.+?)\s*(\d{5})$/';
preg_match($cityZipCodeRegex, $address, $matches);
saveCityZipCode($matches[1], $matches[2]);
```
**Fena Değil:**
Daha iyi ama hala regex'e son derece bağlıyız.
```php
$address = 'One Infinite Loop, Cupertino 95014';
$cityZipCodeRegex = '/^[^,]+,\s*(.+?)\s*(\d{5})$/';
preg_match($cityZipCodeRegex, $address, $matches);
[, $city, $zipCode] = $matches;
saveCityZipCode($city, $zipCode);
```
**İyi:**
Alt şablonlara ad vererek regex bağımlılığını azaltın.
```php
$address = 'One Infinite Loop, Cupertino 95014';
$cityZipCodeRegex = '/^[^,]+,\s*(?<city>.+?)\s*(?<zipCode>\d{5})$/';
preg_match($cityZipCodeRegex, $address, $matches);
saveCityZipCode($matches['city'], $matches['zipCode']);
```
**[⬆ yukarı çık](#İçindekiler)**
### Çok fazla iç içe kullanımdan ve geri döndürmeden kaçının (bölüm 1)
Çok fazla if-else ifadeleri kodun takip edilmesini zorlaştırır. Direkt olmak, dolaylı olmaktan iyidir.
**Kötü:**
```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;
}
}
```
**İyi:**
```php
function isShopOpen(string $day): bool
{
if (empty($day)) {
return false;
}
$openingDays = [
'friday', 'saturday', 'sunday'
];
return in_array(strtolower($day), $openingDays, true);
}
```
**[⬆ yukarı çık](#İçindekiler)**
### Çok fazla iç içe kullanımdan ve geri döndürmeden kaçının (bölüm 2)
**Kötü:**
```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';
}
}
```
**İyi:**
```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);
}
```
**[⬆ yukarı çık](#İçindekiler)**
### Zihin Haritasından Kaçının
Okuyucuyu, kodunuzdaki değişkenin ne demek olduğunu tercüme etmek için zorlamayın. Direkt olmak, dolaylı olmaktan iyidir.
**Kötü:**
```php
$l = ['Austin', 'New York', 'San Francisco'];
for ($i = 0; $i < count($l); $i++) {
$li = $l[$i];
doStuff();
doSomeOtherStuff();
// ...
// ...
// ...
// Bekle, yeniden `$li` ne için?
dispatch($li);
}
```
**İyi:**
```php
$locations = ['Austin', 'New York', 'San Francisco'];
foreach ($locations as $location) {
doStuff();
doSomeOtherStuff();
// ...
// ...
// ...
dispatch($location);
}
```
**[⬆ yukarı çık](#İçindekiler)**
### Gereksiz bağlam eklemeyin
Sınıf/Nesne isimleriniz bir şey anlatıyorsa, bunu değişken adınızda tekrarlamayın.
**Kötü:**
```php
class Car
{
public $carMake;
public $carModel;
public $carColor;
//...
}
```
**İyi:**
```php
class Car
{
public $make;
public $model;
public $color;
//...
}
```
**[⬆ yukarı çık](#İçindekiler)**
### Kısaltmalar veya şartlılar yerine varsayılan argümanları kullanın
**İyi Değil:**
Bu iyi değil çünkü `$breweryName`, `NULL` olabilir.
```php
function createMicrobrewery($breweryName = 'Hipster Brew Co.'): void
{
// ...
}
```
**Fena Değil:**
Bu düşünce bir önceki versiyondan daha anlaşılır ama değişkenin değerini kontrol etse daha iyi olur.
```php
function createMicrobrewery($name = null): void
{
$breweryName = $name ?: 'Hipster Brew Co.';
// ...
}
```
**İyi:**
[tür ipucu](http://php.net/manual/en/functions.arguments.php#functions.arguments.type-declaration) kullanabilirsiniz ve `$breweryName` öğesinin `NULL` olmadığından emin olun.
```php
function createMicrobrewery(string $breweryName = 'Hipster Brew Co.'): void
{
// ...
}
```
**[⬆ yukarı çık](#İçindekiler)**
## Karşılaştırma
### [Aynı karşılaştırmayı](http://php.net/manual/en/language.operators.comparison.php) kullanın.
**İyi Değil:**
Basit karşılaştırma harf dizinleri bir ifadeyi tam sayıya döndürür.
```php
$a = '42';
$b = 42;
if ($a != $b) {
// İfade her zaman geçer.
}
```
`$a != $b` karşılaştırması `FALSE` değerini döndürüyor ama aslında `TRUE`!
Harf dizini `42`, tam sayı olan `42` den farklıdır.
**İyi:**
Aynı karşılaştırma türü ve değeri karşılaştırır.
```php
$a = '42';
$b = 42;
if ($a !== $b) {
// İfade doğrulandı.
}
```
`$a !== $b` karşılaştırması `TRUE` değerini döndürür.
**[⬆ yukarı çık](#İçindekiler)**
## Fonksiyonlar
### Fonksiyon Parametreleri (2 veya daha az ideal)
Fonksiyon parametrelerinin miktarını sınırlamak inanılmaz derecede önemlidir çünkü fonksiyonunuzu test etmeyi kolaylaştırır. Üç *leads* ten fazlasının olması, her bir ayrı argümana sahip tonlarca farklı durumu test etmeniz gereken bir kombinatoryal patlamaya yol açar.
Sıfır argümanlar ideal durumdur. Bir veya iki argüman iyidir fakat üç argümandan kaçınılmalıdır. Bundan daha fazlası birleştirilmelidir. Genellikle iki argümandan fazlası varsa fonksiyonunuz çok fazlasını yapmaya çalışır.
Olmadığı durumlarda çoğu zaman yüksek seviye bir nesne bir argüman olarak yeterli olacaktır.
**Kötü:**
```php
function createMenu(string $title, string $body, string $buttonText, bool $cancellable): void
{
// ...
}
```
**İyi:**
```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
{
// ...
}
```
**[⬆ yukarı çık](#İçindekiler)**
### Fonksiyonlar bir şey yapmalı
Bu, yazılım mühendisliğinde açık ara en önemli kuraldır. Fonksiyonlar bir şeyden fazlasını yaptığında bunları oluşturmak, test etmek ve akıl yürütmek daha zordur. Bir fonksiyonu sadece bir eyleme ayırdığında, kolayca düzenlenebilir ve kodunuz daha temiz okunacaktır. Eğer bu kılavuzdan bunda başka bir şey almazsanız bile, birçok geliştiriciden önde olacaksınız.
**Kötü:**
```php
function emailClients(array $clients): void
{
foreach ($clients as $client) {
$clientRecord = $db->find($client);
if ($clientRecord->isActive()) {
email($client);
}
}
}
```
**İyi:**
```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();
}
```
**[⬆ yukarı çık](#İçindekiler)**
### Fonksiyon isimleri ne yaptıklarını söylemeli
**Kötü:**
```php
class Email
{
//...
public function handle(): void
{
mail($this->to, $this->subject, $this->body);
}
}
$message = new Email(...);
// Bu nedir? Mesaj için `handle` ? Şimdi bir dosyaya mı yazıyoruz ?
$message->handle();
```
**İyi:**
```php
class Email
{
//...
public function send(): void
{
mail($this->to, $this->subject, $this->body);
}
}
$message = new Email(...);
// Temiz ve açık
$message->send();
```
**[⬆ yukarı çık](#İçindekiler)**
### Fonksiyonlar sadece bir seviye soyutlama olmalıdır
Birden fazla soyutlama seviyeniz olduğu zaman fonksiyonunuz genellikle çok fazla şey yapıyordur. Fonksiyonları ayırmak tekrar kullanılabilirlik ve daha kolay test edilebilirlik sağlar.
**Kötü:**
```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) {
// parse...
}
}
```
**Çok Kötü:**
Bazı fonksiyonellikleri gerçekleştirdik ama `parseBetterJSAlternative()` fonksiyonu hala çok karmaşık ve test edilebilir değil.
```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) {
// parse...
}
}
```
**İyi:**
En iyi çözüm `parseBetterJSAlternative()` fonksiyonundaki bağımlılıkları ortadan kaldırmaktır.
```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) {
// parse...
}
}
}
```
**[⬆ yukarı çık](#İçindekiler)**
### Bayrakları, fonksiyon parametreleri olarak kullanmayın.
Bayraklar, kullanıcılarınıza bu fonksiyonun birden fazla şey yapacağını söyler.
Fonksiyonlar bir şey yapmalıdır. Eğer bir `boolean` tabanlı farklı kod yollarını takip ediyorsanız, fonksiyonlarınızı bölün.
**Kötü:**
```php
function createFile(string $name, bool $temp = false): void
{
if ($temp) {
touch('./temp/'.$name);
} else {
touch($name);
}
}
```
**İyi:**
```php
function createFile(string $name): void
{
touch($name);
}
function createTempFile(string $name): void
{
touch('./temp/'.$name);
}
```
**[⬆ yukarı çık](#İçindekiler)**
### Yan Etkilerden Kaçının
Bir fonksiyon, bir değeri almak ve başka değer veya değerleri geri döndürmek dışında bir şey yaparsa bir yan etki üretir.
Bir yan etki bir dosyaya yazılabilir, global değişkenleri değiştirebilir veya bir yabancıya bütün paranızı yanlışlıkla bağlayabilir.
Şimdi, bir sebeple programında yan etkilere ihtiyacınız var. Önceki örnekteki gibi, belki bir dosyaya yazmanız gerekebilir.
Yapmak istediğiniz şey, yaptığınızı merkezileştirmektir. Belirli bir dosyaya birkaç fonksiyon ve sınıflar yazılmasına gerek yoktur. Bunu yapan bir servis var. Bir ve sadece bir tane.
Ana nokta, herhangi bir yapıya sahip olmayan nesneler arasındaki paylaşım durumu gibi ortak tuzaklardan kaçınmaktır. Herhangi bir şeye göre yazılabilen ve yan etkilerin meydana geldiği yeri merkezileştirmeyen değişebilen veri türleri kullanılmalıdır. Eğer bunu yapabiliyorsanız diğer programcıların büyük çoğunluğundan daha mutlu olacaksınız.
**Kötü:**
```php
// Global değişkenler, aşağıdaki fonksiyonları referans alır.
// Bu ismi kullanan başka fonksiyonumuz olsaydı, şimdi bir dizi olurdu ve bozulurdu.
$name = 'Ryan McDermott';
function splitIntoFirstAndLastName(): void
{
global $name;
$name = explode(' ', $name);
}
splitIntoFirstAndLastName();
var_dump($name); // ['Ryan', 'McDermott'];
```
**İyi:**
```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'];
```
**[⬆ yukarı çık](#İçindekiler)**
### Global Fonksiyonlar yazmayın
Global kirletme birçok dilde kötü bir uygulama yöntemidir. Çünkü başka bir kütüphane ile çakışabilir ve API'nızın kullanıcısı ürününüzden istisna elde edene kadar bilemezdiniz. Hadi bir örnek düşünelim: Eğer konfigürasyon dizisine sahip olmak isteseniz ne olurdu?
`config()` gibi global fonksiyon yazabilirsiniz ama aynı şeyi yapmaya çalışan başka bir kütüphaneyle çakışabilir.
**Kötü:**
```php
function config(): array
{
return [
'foo' => 'bar',
]
}
```
**İyi:**
```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;
}
}
```
Yapılandırmayı yükleyin ve `Configuration` sınıfının örneğini oluşturun.
```php
$configuration = new Configuration([
'foo' => 'bar',
]);
```
Ve şimdi uygulamanızda `Configuration` örneğini kullanmalısınız.
**[⬆ yukarı çık](#İçindekiler)**
### Singleton desenini kullanmayın
Singeton bir [anti-pattern'dir](https://en.wikipedia.org/wiki/Singleton_pattern). Brian Button'un yorumuyla:
1. Genellikle **global örnek** kullanırlar, neden bu kadar kötü ki? Çünkü bunları arayüzlerde göstermek yerine uygulamanızın kodlarında **bağımlılıkları saklıyorsunuz**. Global bir şeyler yapmak, [kod kokusu](https://en.wikipedia.org/wiki/Code_smell) etrafında dolaşmamaktır.
2. [Tek Sorumluluk Prensibi (SRP)](#single-responsibility-principle-srp)'ni ihlal ediyorlar :
**kendi kreasyonlarını ve yaşam döngülerini kontrol ettikleri** gerçeğiyle.
3. Bunlar doğal olarak kodun sıkı sıkıya [bağlanmış](https://en.wikipedia.org/wiki/Coupling_%28computer_programming%29) olmasına neden olurlar. Birçok durumda testi zorlaştırmak için onları kandırır.
4. Uygulamanın yaşam süresi kadar durum taşıyorlar. Başka bir test yaptıktan sonra birim testleri için büyük bir hiç olan **testlerin sıralı olması gereken bir durumla karşılaşabilirsiniz.** Neden? Çünkü her birim testi diğerlerinden bağımsız olmalıdır.
[Problemin kökü](http://misko.hevery.com/2008/08/25/root-cause-of-singletons/) hakkında [Misko Hevery](http://misko.hevery.com/about/) 'in çok güzel düşünceleri var.
**Kötü:**
```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();
```
**İyi:**
```php
class DBConnection
{
public function __construct(string $dsn)
{
// ...
}
// ...
}
```
`DBConnection` sınıfının örneğini oluşturun ve [DSN](http://php.net/manual/en/pdo.construct.php#refsect1-pdo.construct-parameters) ile yapılandırın.
```php
$connection = new DBConnection($dsn);
```
Ve şimdi uygulamanızda `DBConnection` örneğini kullanmalısınız.
**[⬆ yukarı çık](#İçindekiler)**
### Koşulları kapsülleyin
**Kötü:**
```php
if ($article->state === 'published') {
// ...
}
```
**İyi:**
```php
if ($article->isPublished()) {
// ...
}
```
**[⬆ yukarı çık](#İçindekiler)**
### Olumsuz koşullardan kaçının
**Kötü:**
```php
function isDOMNodeNotPresent(\DOMNode $node): bool
{
// ...
}
if (!isDOMNodeNotPresent($node))
{
// ...
}
```
**İyi:**
```php
function isDOMNodePresent(\DOMNode $node): bool
{
// ...
}
if (isDOMNodePresent($node)) {
// ...
}
```
**[⬆ yukarı çık](#İçindekiler)**
### Koşullardan kaçının
Bu imkansız bir iş gibi görünüyor. Bunu ilk duyduğunda, birçok insan şöyle der;
"Bir `if` koşulu olmadan nasıl bir şey yapayım ki?" Bunun cevabı ise çoğu durumda aynı işi gerçekleştirmek için polimorfizm(`polymorphism`) kullanabilmenizdir. Genellikle ikinci soru ise; "tamam bu harika ama neden bunu yapmak isterdim?" Bunun cevabı öğrendiğimiz bir önceki temiz kod kavramıdır: bir fonksiyon sadece bir şey yapmalı. `if` koşuluna sahip sınıflar ve fonksiyonlarınız olduğu zaman, kullanıcılarınıza fonksiyonunuzun birden fazla şey yaptığınız söylersiniz. Unutmayın, sadece bir şey yapın.
**Kötü:**
```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();
}
}
}
```
**İyi:**
```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();
}
}
```
**[⬆ yukarı çık](#İçindekiler)**
### Tür kontrolünden kaçının (bölüm 1)
PHP türlendirilmemiş, bu da fonksiyonlarınızın herhangi bir türde argümanı alabileceğini anlamına geliyor.
Bu özgürlük bazen sizi zora sokabilir ve fonksiyonlarınızda tür kontrolü yapmak cazip hale gelir. Bunu yapmaktan kaçınmanın bir çok yolu vardır. Dikkate alınacak ilk şey tutarlı API'lardır.