@mytechtoday/augment-extensions 0.7.0 → 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (483) hide show
  1. package/AGENTS.md +265 -232
  2. package/README.md +956 -771
  3. package/augment-extensions/coding-standards/bash/README.md +196 -196
  4. package/augment-extensions/coding-standards/bash/module.json +163 -163
  5. package/augment-extensions/coding-standards/bash/rules/naming-conventions.md +336 -336
  6. package/augment-extensions/coding-standards/bash/rules/universal-standards.md +289 -289
  7. package/augment-extensions/coding-standards/css/README.md +40 -40
  8. package/augment-extensions/coding-standards/css/examples/css-examples.css +550 -550
  9. package/augment-extensions/coding-standards/css/module.json +44 -44
  10. package/augment-extensions/coding-standards/css/rules/css-modern-features.md +448 -448
  11. package/augment-extensions/coding-standards/css/rules/css-standards.md +492 -492
  12. package/augment-extensions/coding-standards/html/README.md +40 -40
  13. package/augment-extensions/coding-standards/html/examples/html-examples.html +267 -267
  14. package/augment-extensions/coding-standards/html/examples/responsive-layout.html +505 -505
  15. package/augment-extensions/coding-standards/html/module.json +44 -44
  16. package/augment-extensions/coding-standards/html/rules/html-standards.md +349 -349
  17. package/augment-extensions/coding-standards/html-css-js/README.md +194 -194
  18. package/augment-extensions/coding-standards/html-css-js/examples/async-examples.js +487 -487
  19. package/augment-extensions/coding-standards/html-css-js/examples/css-examples.css +550 -550
  20. package/augment-extensions/coding-standards/html-css-js/examples/dom-examples.js +667 -667
  21. package/augment-extensions/coding-standards/html-css-js/examples/html-examples.html +267 -267
  22. package/augment-extensions/coding-standards/html-css-js/examples/javascript-examples.js +612 -612
  23. package/augment-extensions/coding-standards/html-css-js/examples/responsive-layout.html +505 -505
  24. package/augment-extensions/coding-standards/html-css-js/module.json +48 -48
  25. package/augment-extensions/coding-standards/html-css-js/rules/async-patterns.md +515 -515
  26. package/augment-extensions/coding-standards/html-css-js/rules/css-modern-features.md +448 -448
  27. package/augment-extensions/coding-standards/html-css-js/rules/css-standards.md +492 -492
  28. package/augment-extensions/coding-standards/html-css-js/rules/dom-manipulation.md +439 -439
  29. package/augment-extensions/coding-standards/html-css-js/rules/html-standards.md +349 -349
  30. package/augment-extensions/coding-standards/html-css-js/rules/javascript-standards.md +486 -486
  31. package/augment-extensions/coding-standards/html-css-js/rules/performance.md +463 -463
  32. package/augment-extensions/coding-standards/html-css-js/rules/tooling.md +543 -543
  33. package/augment-extensions/coding-standards/js/README.md +46 -46
  34. package/augment-extensions/coding-standards/js/examples/async-examples.js +487 -487
  35. package/augment-extensions/coding-standards/js/examples/dom-examples.js +667 -667
  36. package/augment-extensions/coding-standards/js/examples/javascript-examples.js +612 -612
  37. package/augment-extensions/coding-standards/js/module.json +49 -49
  38. package/augment-extensions/coding-standards/js/rules/async-patterns.md +515 -515
  39. package/augment-extensions/coding-standards/js/rules/dom-manipulation.md +439 -439
  40. package/augment-extensions/coding-standards/js/rules/javascript-standards.md +486 -486
  41. package/augment-extensions/coding-standards/js/rules/performance.md +463 -463
  42. package/augment-extensions/coding-standards/js/rules/tooling.md +543 -543
  43. package/augment-extensions/coding-standards/php/README.md +248 -248
  44. package/augment-extensions/coding-standards/php/examples/api-endpoint-example.php +204 -204
  45. package/augment-extensions/coding-standards/php/examples/cli-command-example.php +206 -206
  46. package/augment-extensions/coding-standards/php/examples/legacy-refactoring-example.php +234 -234
  47. package/augment-extensions/coding-standards/php/examples/web-application-example.php +211 -211
  48. package/augment-extensions/coding-standards/php/examples/woocommerce-extension-example.php +215 -215
  49. package/augment-extensions/coding-standards/php/examples/wordpress-plugin-example.php +189 -189
  50. package/augment-extensions/coding-standards/php/module.json +166 -166
  51. package/augment-extensions/coding-standards/php/rules/api-development.md +480 -480
  52. package/augment-extensions/coding-standards/php/rules/category-configuration.md +332 -332
  53. package/augment-extensions/coding-standards/php/rules/cli-tools.md +472 -472
  54. package/augment-extensions/coding-standards/php/rules/cms-integration.md +561 -561
  55. package/augment-extensions/coding-standards/php/rules/code-quality.md +402 -402
  56. package/augment-extensions/coding-standards/php/rules/documentation.md +425 -425
  57. package/augment-extensions/coding-standards/php/rules/ecommerce.md +627 -627
  58. package/augment-extensions/coding-standards/php/rules/error-handling.md +336 -336
  59. package/augment-extensions/coding-standards/php/rules/legacy-migration.md +677 -677
  60. package/augment-extensions/coding-standards/php/rules/naming-conventions.md +279 -279
  61. package/augment-extensions/coding-standards/php/rules/performance.md +392 -392
  62. package/augment-extensions/coding-standards/php/rules/psr-standards.md +186 -186
  63. package/augment-extensions/coding-standards/php/rules/security.md +358 -358
  64. package/augment-extensions/coding-standards/php/rules/testing.md +403 -403
  65. package/augment-extensions/coding-standards/php/rules/type-declarations.md +331 -331
  66. package/augment-extensions/coding-standards/php/rules/web-applications.md +426 -426
  67. package/augment-extensions/coding-standards/powershell/README.md +154 -154
  68. package/augment-extensions/coding-standards/powershell/examples/admin-example.ps1 +272 -272
  69. package/augment-extensions/coding-standards/powershell/examples/automation-example.ps1 +173 -173
  70. package/augment-extensions/coding-standards/powershell/examples/cloud-example.ps1 +243 -243
  71. package/augment-extensions/coding-standards/powershell/examples/cross-platform-example.ps1 +297 -297
  72. package/augment-extensions/coding-standards/powershell/examples/dsc-example.ps1 +224 -224
  73. package/augment-extensions/coding-standards/powershell/examples/legacy-migration-example.ps1 +340 -340
  74. package/augment-extensions/coding-standards/powershell/examples/module-example.psm1 +255 -255
  75. package/augment-extensions/coding-standards/powershell/module.json +165 -165
  76. package/augment-extensions/coding-standards/powershell/rules/administrative-tools.md +439 -439
  77. package/augment-extensions/coding-standards/powershell/rules/automation-scripts.md +240 -240
  78. package/augment-extensions/coding-standards/powershell/rules/cloud-orchestration.md +384 -384
  79. package/augment-extensions/coding-standards/powershell/rules/configuration-schema.md +383 -383
  80. package/augment-extensions/coding-standards/powershell/rules/cross-platform-scripts.md +482 -482
  81. package/augment-extensions/coding-standards/powershell/rules/dsc-configurations.md +296 -296
  82. package/augment-extensions/coding-standards/powershell/rules/error-handling.md +314 -314
  83. package/augment-extensions/coding-standards/powershell/rules/legacy-migrations.md +466 -466
  84. package/augment-extensions/coding-standards/powershell/rules/modules-functions.md +244 -244
  85. package/augment-extensions/coding-standards/powershell/rules/naming-conventions.md +266 -266
  86. package/augment-extensions/coding-standards/powershell/rules/performance-optimization.md +209 -209
  87. package/augment-extensions/coding-standards/powershell/rules/security-practices.md +314 -314
  88. package/augment-extensions/coding-standards/powershell/rules/testing-guidelines.md +268 -268
  89. package/augment-extensions/coding-standards/powershell/rules/universal-standards.md +197 -197
  90. package/augment-extensions/coding-standards/python/README.md +48 -48
  91. package/augment-extensions/coding-standards/python/examples/best-practices.py +373 -373
  92. package/augment-extensions/coding-standards/python/module.json +30 -30
  93. package/augment-extensions/coding-standards/python/rules/async-patterns.md +884 -884
  94. package/augment-extensions/coding-standards/python/rules/best-practices.md +232 -232
  95. package/augment-extensions/coding-standards/python/rules/code-organization.md +220 -220
  96. package/augment-extensions/coding-standards/python/rules/documentation.md +831 -831
  97. package/augment-extensions/coding-standards/python/rules/error-handling.md +1008 -1008
  98. package/augment-extensions/coding-standards/python/rules/naming-conventions.md +172 -172
  99. package/augment-extensions/coding-standards/python/rules/testing.md +409 -409
  100. package/augment-extensions/coding-standards/python/rules/tooling.md +446 -446
  101. package/augment-extensions/coding-standards/python/rules/type-hints.md +253 -253
  102. package/augment-extensions/coding-standards/react/README.md +45 -45
  103. package/augment-extensions/coding-standards/react/module.json +27 -27
  104. package/augment-extensions/coding-standards/react/rules/component-patterns.md +214 -214
  105. package/augment-extensions/coding-standards/react/rules/hooks-best-practices.md +235 -235
  106. package/augment-extensions/coding-standards/react/rules/performance.md +300 -300
  107. package/augment-extensions/coding-standards/react/rules/state-management.md +265 -265
  108. package/augment-extensions/coding-standards/react/rules/typescript-react.md +271 -271
  109. package/augment-extensions/coding-standards/typescript/README.md +45 -45
  110. package/augment-extensions/coding-standards/typescript/module.json +27 -27
  111. package/augment-extensions/coding-standards/typescript/rules/naming-conventions.md +225 -225
  112. package/augment-extensions/collections/html-css-js/README.md +82 -82
  113. package/augment-extensions/collections/html-css-js/collection.json +41 -41
  114. package/augment-extensions/domain-rules/api-design/README.md +41 -41
  115. package/augment-extensions/domain-rules/api-design/module.json +27 -27
  116. package/augment-extensions/domain-rules/api-design/rules/authentication.md +263 -263
  117. package/augment-extensions/domain-rules/api-design/rules/documentation.md +395 -395
  118. package/augment-extensions/domain-rules/api-design/rules/error-handling.md +290 -290
  119. package/augment-extensions/domain-rules/api-design/rules/graphql-api.md +313 -313
  120. package/augment-extensions/domain-rules/api-design/rules/rest-api.md +214 -214
  121. package/augment-extensions/domain-rules/api-design/rules/versioning.md +268 -268
  122. package/augment-extensions/domain-rules/database/README.md +161 -161
  123. package/augment-extensions/domain-rules/database/examples/flat-database-example.md +793 -793
  124. package/augment-extensions/domain-rules/database/examples/hybrid-database-example.md +1132 -1132
  125. package/augment-extensions/domain-rules/database/examples/nosql-document-example.md +868 -868
  126. package/augment-extensions/domain-rules/database/examples/nosql-graph-example.md +805 -805
  127. package/augment-extensions/domain-rules/database/examples/relational-schema-example.md +621 -621
  128. package/augment-extensions/domain-rules/database/examples/vector-database-example.md +965 -965
  129. package/augment-extensions/domain-rules/database/module.json +28 -28
  130. package/augment-extensions/domain-rules/database/rules/flat-databases.md +624 -624
  131. package/augment-extensions/domain-rules/database/rules/nosql-databases.md +588 -588
  132. package/augment-extensions/domain-rules/database/rules/nosql-document-stores.md +856 -856
  133. package/augment-extensions/domain-rules/database/rules/nosql-graph-databases.md +778 -778
  134. package/augment-extensions/domain-rules/database/rules/nosql-key-value-stores.md +963 -963
  135. package/augment-extensions/domain-rules/database/rules/performance-optimization.md +1076 -1076
  136. package/augment-extensions/domain-rules/database/rules/relational-databases.md +697 -697
  137. package/augment-extensions/domain-rules/database/rules/relational-indexing.md +671 -671
  138. package/augment-extensions/domain-rules/database/rules/relational-query-optimization.md +607 -607
  139. package/augment-extensions/domain-rules/database/rules/relational-schema-design.md +907 -907
  140. package/augment-extensions/domain-rules/database/rules/relational-transactions.md +783 -783
  141. package/augment-extensions/domain-rules/database/rules/security-standards.md +980 -980
  142. package/augment-extensions/domain-rules/database/rules/universal-best-practices.md +485 -485
  143. package/augment-extensions/domain-rules/database/rules/vector-databases.md +521 -521
  144. package/augment-extensions/domain-rules/database/rules/vector-embeddings.md +858 -858
  145. package/augment-extensions/domain-rules/database/rules/vector-indexing.md +934 -934
  146. package/augment-extensions/domain-rules/design/color/themes/catppuccin-latte/README.md +23 -23
  147. package/augment-extensions/domain-rules/design/color/themes/catppuccin-latte/module.json +26 -26
  148. package/augment-extensions/domain-rules/design/color/themes/catppuccin-mocha/README.md +23 -23
  149. package/augment-extensions/domain-rules/design/color/themes/catppuccin-mocha/module.json +26 -26
  150. package/augment-extensions/domain-rules/design/color/themes/dracula/README.md +23 -23
  151. package/augment-extensions/domain-rules/design/color/themes/dracula/module.json +26 -26
  152. package/augment-extensions/domain-rules/design/color/themes/gruvbox-dark/README.md +23 -23
  153. package/augment-extensions/domain-rules/design/color/themes/gruvbox-dark/module.json +26 -26
  154. package/augment-extensions/domain-rules/design/color/themes/gruvbox-light/README.md +23 -23
  155. package/augment-extensions/domain-rules/design/color/themes/gruvbox-light/module.json +26 -26
  156. package/augment-extensions/domain-rules/design/color/themes/high-contrast/README.md +27 -27
  157. package/augment-extensions/domain-rules/design/color/themes/high-contrast/module.json +26 -26
  158. package/augment-extensions/domain-rules/design/color/themes/monokai/README.md +23 -23
  159. package/augment-extensions/domain-rules/design/color/themes/monokai/module.json +26 -26
  160. package/augment-extensions/domain-rules/design/color/themes/nord/README.md +23 -23
  161. package/augment-extensions/domain-rules/design/color/themes/nord/module.json +26 -26
  162. package/augment-extensions/domain-rules/design/color/themes/one-dark/README.md +23 -23
  163. package/augment-extensions/domain-rules/design/color/themes/one-dark/module.json +26 -26
  164. package/augment-extensions/domain-rules/design/color/themes/one-light/README.md +23 -23
  165. package/augment-extensions/domain-rules/design/color/themes/one-light/module.json +26 -26
  166. package/augment-extensions/domain-rules/design/color/themes/solarized-dark/README.md +23 -23
  167. package/augment-extensions/domain-rules/design/color/themes/solarized-dark/module.json +26 -26
  168. package/augment-extensions/domain-rules/design/color/themes/solarized-light/README.md +23 -23
  169. package/augment-extensions/domain-rules/design/color/themes/solarized-light/module.json +26 -26
  170. package/augment-extensions/domain-rules/design/color/themes/tokyo-night/README.md +23 -23
  171. package/augment-extensions/domain-rules/design/color/themes/tokyo-night/module.json +26 -26
  172. package/augment-extensions/domain-rules/mcp/README.md +150 -150
  173. package/augment-extensions/domain-rules/mcp/examples/compressed-example.md +522 -522
  174. package/augment-extensions/domain-rules/mcp/examples/graph-augmented-example.md +520 -520
  175. package/augment-extensions/domain-rules/mcp/examples/hybrid-example.md +570 -570
  176. package/augment-extensions/domain-rules/mcp/examples/state-based-example.md +427 -427
  177. package/augment-extensions/domain-rules/mcp/examples/token-based-example.md +435 -435
  178. package/augment-extensions/domain-rules/mcp/examples/vector-based-example.md +502 -502
  179. package/augment-extensions/domain-rules/mcp/module.json +49 -49
  180. package/augment-extensions/domain-rules/mcp/rules/compressed-mcp.md +595 -595
  181. package/augment-extensions/domain-rules/mcp/rules/configuration.md +345 -345
  182. package/augment-extensions/domain-rules/mcp/rules/graph-augmented-mcp.md +687 -687
  183. package/augment-extensions/domain-rules/mcp/rules/hybrid-mcp.md +636 -636
  184. package/augment-extensions/domain-rules/mcp/rules/state-based-mcp.md +484 -484
  185. package/augment-extensions/domain-rules/mcp/rules/testing-validation.md +360 -360
  186. package/augment-extensions/domain-rules/mcp/rules/token-based-mcp.md +393 -393
  187. package/augment-extensions/domain-rules/mcp/rules/universal-rules.md +194 -194
  188. package/augment-extensions/domain-rules/mcp/rules/vector-based-mcp.md +625 -625
  189. package/augment-extensions/domain-rules/security/README.md +41 -41
  190. package/augment-extensions/domain-rules/security/module.json +28 -28
  191. package/augment-extensions/domain-rules/security/rules/authentication-security.md +361 -361
  192. package/augment-extensions/domain-rules/security/rules/encryption.md +208 -208
  193. package/augment-extensions/domain-rules/security/rules/input-validation.md +294 -294
  194. package/augment-extensions/domain-rules/security/rules/owasp-top-10.md +339 -339
  195. package/augment-extensions/domain-rules/security/rules/secure-coding.md +293 -293
  196. package/augment-extensions/domain-rules/security/rules/web-security.md +268 -268
  197. package/augment-extensions/domain-rules/seo-sales-marketing/ANNOUNCEMENT.md +143 -0
  198. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/README.md +140 -136
  199. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/SCHEMA-VALIDATION-REPORT.md +216 -216
  200. package/augment-extensions/domain-rules/seo-sales-marketing/TEST-VALIDATION.md +129 -0
  201. package/augment-extensions/domain-rules/seo-sales-marketing/USAGE-GUIDES.md +254 -0
  202. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/brand-kit-example.yaml +292 -292
  203. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/campaign-brief-example.yaml +389 -389
  204. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/content-calendar-example.yaml +643 -643
  205. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/email-newsletter-example.md +376 -376
  206. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/landing-page-example.md +934 -934
  207. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/ppc-ad-copy-example.md +301 -301
  208. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/seo-blog-post-example.md +347 -347
  209. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/social-media-campaign-example.md +606 -606
  210. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/module.json +50 -50
  211. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/affiliate-influencer-marketing.md +593 -593
  212. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/asset-management.md +418 -418
  213. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/brand-consistency.md +210 -210
  214. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/content-marketing.md +337 -337
  215. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/conversion-optimization.md +455 -455
  216. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/direct-sales.md +499 -499
  217. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/email-marketing.md +439 -439
  218. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/legal-compliance.md +227 -227
  219. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/ppc-advertising.md +569 -569
  220. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/seo-optimization.md +470 -470
  221. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/social-media-marketing.md +414 -414
  222. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/universal-marketing.md +177 -177
  223. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/asset-inventory.schema.json +247 -247
  224. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/brand-kit.schema.json +326 -326
  225. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/campaign-brief.schema.json +342 -342
  226. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/color-palette.schema.json +223 -223
  227. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/content-template.schema.json +383 -383
  228. package/augment-extensions/domain-rules/wordpress/README.md +163 -163
  229. package/augment-extensions/domain-rules/wordpress/module.json +32 -32
  230. package/augment-extensions/domain-rules/wordpress/rules/coding-standards.md +617 -617
  231. package/augment-extensions/domain-rules/wordpress/rules/directory-structure.md +270 -270
  232. package/augment-extensions/domain-rules/wordpress/rules/file-patterns.md +423 -423
  233. package/augment-extensions/domain-rules/wordpress/rules/gutenberg-blocks.md +493 -493
  234. package/augment-extensions/domain-rules/wordpress/rules/performance.md +568 -568
  235. package/augment-extensions/domain-rules/wordpress/rules/plugin-development.md +510 -510
  236. package/augment-extensions/domain-rules/wordpress/rules/project-detection.md +251 -251
  237. package/augment-extensions/domain-rules/wordpress/rules/rest-api.md +501 -501
  238. package/augment-extensions/domain-rules/wordpress/rules/security.md +564 -564
  239. package/augment-extensions/domain-rules/wordpress/rules/theme-development.md +388 -388
  240. package/augment-extensions/domain-rules/wordpress/rules/woocommerce.md +441 -441
  241. package/augment-extensions/domain-rules/wordpress-plugin/README.md +139 -139
  242. package/augment-extensions/domain-rules/wordpress-plugin/examples/ajax-plugin.md +1599 -1599
  243. package/augment-extensions/domain-rules/wordpress-plugin/examples/custom-post-type-plugin.md +1727 -1727
  244. package/augment-extensions/domain-rules/wordpress-plugin/examples/gutenberg-block-plugin.md +428 -428
  245. package/augment-extensions/domain-rules/wordpress-plugin/examples/gutenberg-block.md +422 -422
  246. package/augment-extensions/domain-rules/wordpress-plugin/examples/mvc-plugin.md +1623 -1623
  247. package/augment-extensions/domain-rules/wordpress-plugin/examples/object-oriented-plugin.md +1343 -1343
  248. package/augment-extensions/domain-rules/wordpress-plugin/examples/rest-endpoint.md +734 -734
  249. package/augment-extensions/domain-rules/wordpress-plugin/examples/settings-page-plugin.md +1350 -1350
  250. package/augment-extensions/domain-rules/wordpress-plugin/examples/simple-procedural-plugin.md +503 -503
  251. package/augment-extensions/domain-rules/wordpress-plugin/examples/singleton-plugin.md +971 -971
  252. package/augment-extensions/domain-rules/wordpress-plugin/module.json +53 -53
  253. package/augment-extensions/domain-rules/wordpress-plugin/rules/activation-hooks.md +770 -770
  254. package/augment-extensions/domain-rules/wordpress-plugin/rules/admin-interface.md +874 -874
  255. package/augment-extensions/domain-rules/wordpress-plugin/rules/ajax-handlers.md +629 -629
  256. package/augment-extensions/domain-rules/wordpress-plugin/rules/asset-management.md +559 -559
  257. package/augment-extensions/domain-rules/wordpress-plugin/rules/context-providers.md +709 -709
  258. package/augment-extensions/domain-rules/wordpress-plugin/rules/cron-jobs.md +736 -736
  259. package/augment-extensions/domain-rules/wordpress-plugin/rules/database-management.md +1057 -1057
  260. package/augment-extensions/domain-rules/wordpress-plugin/rules/documentation-standards.md +463 -463
  261. package/augment-extensions/domain-rules/wordpress-plugin/rules/frontend-functionality.md +478 -478
  262. package/augment-extensions/domain-rules/wordpress-plugin/rules/gutenberg-blocks.md +818 -818
  263. package/augment-extensions/domain-rules/wordpress-plugin/rules/internationalization.md +416 -416
  264. package/augment-extensions/domain-rules/wordpress-plugin/rules/migration.md +667 -667
  265. package/augment-extensions/domain-rules/wordpress-plugin/rules/performance-optimization.md +878 -878
  266. package/augment-extensions/domain-rules/wordpress-plugin/rules/plugin-architecture.md +693 -693
  267. package/augment-extensions/domain-rules/wordpress-plugin/rules/plugin-structure.md +352 -352
  268. package/augment-extensions/domain-rules/wordpress-plugin/rules/rest-api.md +818 -818
  269. package/augment-extensions/domain-rules/wordpress-plugin/rules/scaffolding-workflow.md +624 -624
  270. package/augment-extensions/domain-rules/wordpress-plugin/rules/security-best-practices.md +866 -866
  271. package/augment-extensions/domain-rules/wordpress-plugin/rules/testing-patterns.md +1165 -1165
  272. package/augment-extensions/domain-rules/wordpress-plugin/rules/testing.md +414 -414
  273. package/augment-extensions/domain-rules/wordpress-plugin/rules/vscode-integration.md +751 -751
  274. package/augment-extensions/domain-rules/wordpress-plugin/rules/woocommerce-integration.md +949 -949
  275. package/augment-extensions/domain-rules/wordpress-plugin/rules/wordpress-org-submission.md +458 -458
  276. package/augment-extensions/examples/design-patterns/README.md +37 -37
  277. package/augment-extensions/examples/design-patterns/examples/behavioral-patterns.md +370 -370
  278. package/augment-extensions/examples/design-patterns/examples/creational-patterns.md +250 -250
  279. package/augment-extensions/examples/design-patterns/examples/structural-patterns.md +264 -264
  280. package/augment-extensions/examples/design-patterns/module.json +27 -27
  281. package/augment-extensions/examples/gutenberg-block-plugin/README.md +101 -101
  282. package/augment-extensions/examples/gutenberg-block-plugin/examples/testimonial-block.md +428 -428
  283. package/augment-extensions/examples/gutenberg-block-plugin/module.json +40 -40
  284. package/augment-extensions/examples/rest-api-plugin/README.md +98 -98
  285. package/augment-extensions/examples/rest-api-plugin/examples/task-manager-api.md +1299 -1299
  286. package/augment-extensions/examples/rest-api-plugin/module.json +40 -40
  287. package/augment-extensions/examples/woocommerce-extension/README.md +98 -98
  288. package/augment-extensions/examples/woocommerce-extension/examples/product-customizer.md +763 -763
  289. package/augment-extensions/examples/woocommerce-extension/module.json +40 -40
  290. package/augment-extensions/workflows/beads/README.md +135 -135
  291. package/augment-extensions/workflows/beads/examples/complete-workflow-example.md +278 -278
  292. package/augment-extensions/workflows/beads/module.json +55 -55
  293. package/augment-extensions/workflows/beads/rules/best-practices.md +398 -398
  294. package/augment-extensions/workflows/beads/rules/file-format.md +327 -327
  295. package/augment-extensions/workflows/beads/rules/manual-setup.md +315 -315
  296. package/augment-extensions/workflows/beads/rules/workflow.md +326 -326
  297. package/augment-extensions/workflows/beads-integration/IMPLEMENTATION-STATUS.md +145 -145
  298. package/augment-extensions/workflows/beads-integration/README.md +143 -143
  299. package/augment-extensions/workflows/beads-integration/config/defaults.json +32 -32
  300. package/augment-extensions/workflows/beads-integration/config/schema.json +140 -140
  301. package/augment-extensions/workflows/beads-integration/examples/basic-task-generation.md +293 -293
  302. package/augment-extensions/workflows/beads-integration/module.json +75 -75
  303. package/augment-extensions/workflows/beads-integration/rules/core-rules.md +219 -219
  304. package/augment-extensions/workflows/beads-integration/rules/effectiveness-standards.md +256 -256
  305. package/augment-extensions/workflows/beads-integration/rules/task-generation.md +607 -607
  306. package/augment-extensions/workflows/database/README.md +195 -195
  307. package/augment-extensions/workflows/database/ai-prompt-testing.md +295 -295
  308. package/augment-extensions/workflows/database/examples/migration-example.md +498 -498
  309. package/augment-extensions/workflows/database/examples/optimization-example.md +496 -496
  310. package/augment-extensions/workflows/database/examples/schema-design-example.md +444 -444
  311. package/augment-extensions/workflows/database/module.json +42 -42
  312. package/augment-extensions/workflows/database/rules/data-migration.md +249 -249
  313. package/augment-extensions/workflows/database/rules/documentation-standards.md +339 -339
  314. package/augment-extensions/workflows/database/rules/migration-workflow.md +352 -352
  315. package/augment-extensions/workflows/database/rules/optimization-workflow.md +435 -435
  316. package/augment-extensions/workflows/database/rules/schema-design-workflow.md +535 -535
  317. package/augment-extensions/workflows/database/rules/testing-patterns.md +305 -305
  318. package/augment-extensions/workflows/database/rules/workflow.md +458 -458
  319. package/augment-extensions/workflows/wordpress-plugin/README.md +232 -232
  320. package/augment-extensions/workflows/wordpress-plugin/ai-prompts.md +839 -839
  321. package/augment-extensions/workflows/wordpress-plugin/bead-decomposition-patterns.md +854 -854
  322. package/augment-extensions/workflows/wordpress-plugin/examples/complete-plugin-example.md +540 -540
  323. package/augment-extensions/workflows/wordpress-plugin/examples/custom-post-type-example.md +1083 -1083
  324. package/augment-extensions/workflows/wordpress-plugin/examples/feature-addition-workflow.md +669 -669
  325. package/augment-extensions/workflows/wordpress-plugin/examples/plugin-creation-workflow.md +597 -597
  326. package/augment-extensions/workflows/wordpress-plugin/examples/secure-form-handler-example.md +925 -925
  327. package/augment-extensions/workflows/wordpress-plugin/examples/security-audit-workflow.md +752 -752
  328. package/augment-extensions/workflows/wordpress-plugin/examples/wordpress-org-submission-workflow.md +773 -773
  329. package/augment-extensions/workflows/wordpress-plugin/module.json +49 -49
  330. package/augment-extensions/workflows/wordpress-plugin/rules/best-practices.md +942 -942
  331. package/augment-extensions/workflows/wordpress-plugin/rules/development-workflow.md +702 -702
  332. package/augment-extensions/workflows/wordpress-plugin/rules/submission-workflow.md +728 -728
  333. package/augment-extensions/workflows/wordpress-plugin/rules/testing-workflow.md +775 -775
  334. package/augment-extensions/writing-standards/screenplay/README.md +339 -300
  335. package/augment-extensions/writing-standards/screenplay/_templates/README.md +121 -121
  336. package/augment-extensions/writing-standards/screenplay/_templates/genre-template.md +153 -153
  337. package/augment-extensions/writing-standards/screenplay/_templates/style-template.md +243 -243
  338. package/augment-extensions/writing-standards/screenplay/_templates/theme-template.md +213 -213
  339. package/augment-extensions/writing-standards/screenplay/examples/aaa-hollywood-scene.fountain +164 -164
  340. package/augment-extensions/writing-standards/screenplay/examples/beat-sheet-example.yaml +95 -95
  341. package/augment-extensions/writing-standards/screenplay/examples/character-profile-example.yaml +116 -116
  342. package/augment-extensions/writing-standards/screenplay/examples/commercial-30sec.fountain +151 -151
  343. package/augment-extensions/writing-standards/screenplay/examples/independent-monologue.fountain +67 -67
  344. package/augment-extensions/writing-standards/screenplay/examples/news-segment.fountain +142 -142
  345. package/augment-extensions/writing-standards/screenplay/examples/plot-outline-example.yaml +184 -184
  346. package/augment-extensions/writing-standards/screenplay/examples/tv-episode-teaser.fountain +204 -204
  347. package/augment-extensions/writing-standards/screenplay/genres/README.md +181 -181
  348. package/augment-extensions/writing-standards/screenplay/genres/examples/.gitkeep +2 -2
  349. package/augment-extensions/writing-standards/screenplay/genres/module.json +70 -70
  350. package/augment-extensions/writing-standards/screenplay/genres/rules/.gitkeep +2 -2
  351. package/augment-extensions/writing-standards/screenplay/genres/rules/action.md +399 -399
  352. package/augment-extensions/writing-standards/screenplay/genres/rules/adventure.md +407 -407
  353. package/augment-extensions/writing-standards/screenplay/genres/rules/animation.md +293 -293
  354. package/augment-extensions/writing-standards/screenplay/genres/rules/biographical.md +293 -293
  355. package/augment-extensions/writing-standards/screenplay/genres/rules/comedy.md +401 -401
  356. package/augment-extensions/writing-standards/screenplay/genres/rules/documentary.md +293 -293
  357. package/augment-extensions/writing-standards/screenplay/genres/rules/drama.md +409 -409
  358. package/augment-extensions/writing-standards/screenplay/genres/rules/fantasy.md +293 -293
  359. package/augment-extensions/writing-standards/screenplay/genres/rules/historical.md +293 -293
  360. package/augment-extensions/writing-standards/screenplay/genres/rules/horror.md +268 -268
  361. package/augment-extensions/writing-standards/screenplay/genres/rules/musical.md +294 -294
  362. package/augment-extensions/writing-standards/screenplay/genres/rules/mystery.md +293 -293
  363. package/augment-extensions/writing-standards/screenplay/genres/rules/noir.md +294 -294
  364. package/augment-extensions/writing-standards/screenplay/genres/rules/romance.md +293 -293
  365. package/augment-extensions/writing-standards/screenplay/genres/rules/sci-fi.md +289 -289
  366. package/augment-extensions/writing-standards/screenplay/genres/rules/superhero.md +293 -293
  367. package/augment-extensions/writing-standards/screenplay/genres/rules/thriller.md +294 -294
  368. package/augment-extensions/writing-standards/screenplay/genres/rules/western.md +293 -293
  369. package/augment-extensions/writing-standards/screenplay/module.json +124 -124
  370. package/augment-extensions/writing-standards/screenplay/rules/aaa-hollywood-films.md +339 -339
  371. package/augment-extensions/writing-standards/screenplay/rules/ai-integration-testing.md +329 -329
  372. package/augment-extensions/writing-standards/screenplay/rules/character-development.md +169 -169
  373. package/augment-extensions/writing-standards/screenplay/rules/commercials.md +437 -437
  374. package/augment-extensions/writing-standards/screenplay/rules/dialogue-writing.md +263 -263
  375. package/augment-extensions/writing-standards/screenplay/rules/diversity-inclusion.md +261 -261
  376. package/augment-extensions/writing-standards/screenplay/rules/examples-guide.md +315 -315
  377. package/augment-extensions/writing-standards/screenplay/rules/file-organization.md +213 -0
  378. package/augment-extensions/writing-standards/screenplay/rules/formatting-validation.md +413 -413
  379. package/augment-extensions/writing-standards/screenplay/rules/fountain-format.md +372 -372
  380. package/augment-extensions/writing-standards/screenplay/rules/independent-films.md +374 -374
  381. package/augment-extensions/writing-standards/screenplay/rules/live-tv-productions.md +443 -443
  382. package/augment-extensions/writing-standards/screenplay/rules/narrative-structures.md +207 -207
  383. package/augment-extensions/writing-standards/screenplay/rules/news-broadcasts.md +444 -444
  384. package/augment-extensions/writing-standards/screenplay/rules/pacing-timing.md +331 -331
  385. package/augment-extensions/writing-standards/screenplay/rules/quality-review-checklist.md +334 -334
  386. package/augment-extensions/writing-standards/screenplay/rules/quick-reference.md +299 -299
  387. package/augment-extensions/writing-standards/screenplay/rules/screen-continuity.md +263 -263
  388. package/augment-extensions/writing-standards/screenplay/rules/streaming-content.md +412 -412
  389. package/augment-extensions/writing-standards/screenplay/rules/trope-management.md +370 -370
  390. package/augment-extensions/writing-standards/screenplay/rules/tv-series.md +374 -374
  391. package/augment-extensions/writing-standards/screenplay/rules/universal-formatting.md +339 -339
  392. package/augment-extensions/writing-standards/screenplay/rules/vscode-integration.md +277 -277
  393. package/augment-extensions/writing-standards/screenplay/rules/web-content.md +393 -393
  394. package/augment-extensions/writing-standards/screenplay/schemas/beat-sheet.json +332 -332
  395. package/augment-extensions/writing-standards/screenplay/schemas/character-profile.json +247 -247
  396. package/augment-extensions/writing-standards/screenplay/schemas/feature-selection.json +200 -200
  397. package/augment-extensions/writing-standards/screenplay/schemas/plot-outline.json +233 -233
  398. package/augment-extensions/writing-standards/screenplay/schemas/screenplay-config.json +245 -245
  399. package/augment-extensions/writing-standards/screenplay/schemas/trope-inventory.json +221 -221
  400. package/augment-extensions/writing-standards/screenplay/styles/README.md +159 -159
  401. package/augment-extensions/writing-standards/screenplay/styles/examples/.gitkeep +2 -2
  402. package/augment-extensions/writing-standards/screenplay/styles/examples/style-applications.md +1449 -1449
  403. package/augment-extensions/writing-standards/screenplay/styles/module.json +64 -64
  404. package/augment-extensions/writing-standards/screenplay/styles/rules/.gitkeep +2 -2
  405. package/augment-extensions/writing-standards/screenplay/styles/rules/dialogue-centric.md +520 -520
  406. package/augment-extensions/writing-standards/screenplay/styles/rules/ensemble.md +499 -499
  407. package/augment-extensions/writing-standards/screenplay/styles/rules/epic.md +497 -497
  408. package/augment-extensions/writing-standards/screenplay/styles/rules/experimental.md +492 -492
  409. package/augment-extensions/writing-standards/screenplay/styles/rules/flashback.md +509 -509
  410. package/augment-extensions/writing-standards/screenplay/styles/rules/linear.md +490 -490
  411. package/augment-extensions/writing-standards/screenplay/styles/rules/minimalist.md +499 -499
  412. package/augment-extensions/writing-standards/screenplay/styles/rules/non-linear.md +501 -501
  413. package/augment-extensions/writing-standards/screenplay/styles/rules/poetic.md +499 -499
  414. package/augment-extensions/writing-standards/screenplay/styles/rules/realistic.md +498 -498
  415. package/augment-extensions/writing-standards/screenplay/styles/rules/satirical.md +499 -499
  416. package/augment-extensions/writing-standards/screenplay/styles/rules/surreal.md +508 -508
  417. package/augment-extensions/writing-standards/screenplay/styles/rules/voice-over.md +500 -500
  418. package/augment-extensions/writing-standards/screenplay/themes/README.md +158 -158
  419. package/augment-extensions/writing-standards/screenplay/themes/examples/.gitkeep +2 -2
  420. package/augment-extensions/writing-standards/screenplay/themes/examples/common-mistakes-and-fixes.md +643 -643
  421. package/augment-extensions/writing-standards/screenplay/themes/examples/complete-scene-example.md +311 -311
  422. package/augment-extensions/writing-standards/screenplay/themes/examples/individual-theme-examples.md +562 -562
  423. package/augment-extensions/writing-standards/screenplay/themes/examples/multi-theme-weaving.md +538 -538
  424. package/augment-extensions/writing-standards/screenplay/themes/examples/theme-application-guide.md +432 -432
  425. package/augment-extensions/writing-standards/screenplay/themes/examples/theme-integration-across-acts.md +637 -637
  426. package/augment-extensions/writing-standards/screenplay/themes/module.json +66 -66
  427. package/augment-extensions/writing-standards/screenplay/themes/rules/.gitkeep +2 -2
  428. package/augment-extensions/writing-standards/screenplay/themes/rules/ambition.md +458 -458
  429. package/augment-extensions/writing-standards/screenplay/themes/rules/betrayal.md +490 -490
  430. package/augment-extensions/writing-standards/screenplay/themes/rules/environment.md +458 -458
  431. package/augment-extensions/writing-standards/screenplay/themes/rules/fate.md +459 -459
  432. package/augment-extensions/writing-standards/screenplay/themes/rules/friendship.md +491 -491
  433. package/augment-extensions/writing-standards/screenplay/themes/rules/growth.md +491 -491
  434. package/augment-extensions/writing-standards/screenplay/themes/rules/identity.md +490 -490
  435. package/augment-extensions/writing-standards/screenplay/themes/rules/isolation.md +464 -464
  436. package/augment-extensions/writing-standards/screenplay/themes/rules/justice.md +461 -461
  437. package/augment-extensions/writing-standards/screenplay/themes/rules/love.md +489 -489
  438. package/augment-extensions/writing-standards/screenplay/themes/rules/power.md +494 -494
  439. package/augment-extensions/writing-standards/screenplay/themes/rules/redemption.md +483 -483
  440. package/augment-extensions/writing-standards/screenplay/themes/rules/revenge.md +489 -489
  441. package/augment-extensions/writing-standards/screenplay/themes/rules/survival.md +496 -496
  442. package/augment-extensions/writing-standards/screenplay/themes/rules/technology.md +463 -463
  443. package/augment-extensions/writing-standards/screenplay/utils/__tests__/file-organization.test.ts +169 -0
  444. package/augment-extensions/writing-standards/screenplay/utils/file-organization.ts +165 -0
  445. package/cli/MODULES.md +302 -302
  446. package/cli/dist/cli.js +109 -22
  447. package/cli/dist/cli.js.map +1 -1
  448. package/cli/dist/commands/gui.d.ts.map +1 -1
  449. package/cli/dist/commands/gui.js +54 -6
  450. package/cli/dist/commands/gui.js.map +1 -1
  451. package/cli/dist/commands/init.d.ts.map +1 -1
  452. package/cli/dist/commands/init.js +76 -23
  453. package/cli/dist/commands/init.js.map +1 -1
  454. package/cli/dist/commands/self-remove.d.ts.map +1 -1
  455. package/cli/dist/commands/self-remove.js +48 -74
  456. package/cli/dist/commands/self-remove.js.map +1 -1
  457. package/cli/dist/commands/show.d.ts +11 -0
  458. package/cli/dist/commands/show.d.ts.map +1 -1
  459. package/cli/dist/commands/show.js +120 -0
  460. package/cli/dist/commands/show.js.map +1 -1
  461. package/cli/dist/commands/showCompleted.d.ts +21 -0
  462. package/cli/dist/commands/showCompleted.d.ts.map +1 -0
  463. package/cli/dist/commands/showCompleted.js +225 -0
  464. package/cli/dist/commands/showCompleted.js.map +1 -0
  465. package/cli/dist/commands/skill.js +88 -88
  466. package/cli/dist/commands/update.d.ts +2 -0
  467. package/cli/dist/commands/update.d.ts.map +1 -1
  468. package/cli/dist/commands/update.js +67 -1
  469. package/cli/dist/commands/update.js.map +1 -1
  470. package/cli/dist/utils/beadsCompletedChecker.d.ts +72 -0
  471. package/cli/dist/utils/beadsCompletedChecker.d.ts.map +1 -0
  472. package/cli/dist/utils/beadsCompletedChecker.js +198 -0
  473. package/cli/dist/utils/beadsCompletedChecker.js.map +1 -0
  474. package/cli/dist/utils/catalog-sync.js +13 -13
  475. package/cli/dist/utils/extractCommandHelp.d.ts +51 -0
  476. package/cli/dist/utils/extractCommandHelp.d.ts.map +1 -0
  477. package/cli/dist/utils/extractCommandHelp.js +250 -0
  478. package/cli/dist/utils/extractCommandHelp.js.map +1 -0
  479. package/cli/dist/utils/install-rules.js +55 -55
  480. package/cli/dist/utils/mcp-integration.js +44 -44
  481. package/cli/dist/utils/rule-install-hooks.js +8 -8
  482. package/modules.md +667 -630
  483. package/package.json +85 -85
@@ -1,677 +1,677 @@
1
- # PHP Legacy Code Migration Best Practices
2
-
3
- ## Overview
4
-
5
- This guide provides strategies for refactoring legacy PHP code to modern standards, including introducing namespaces, adding type hints, implementing dependency injection, and applying design patterns.
6
-
7
- ## Refactoring Strategies
8
-
9
- ### Strangler Fig Pattern
10
-
11
- **Gradually replace legacy code** without a complete rewrite.
12
-
13
- ```php
14
- <?php
15
-
16
- // Step 1: Create new implementation alongside legacy code
17
- namespace App\Services;
18
-
19
- class ModernUserService
20
- {
21
- public function createUser(string $name, string $email): User
22
- {
23
- // New implementation with type hints, validation, etc.
24
- $user = new User();
25
- $user->name = $name;
26
- $user->email = $email;
27
- $user->save();
28
-
29
- return $user;
30
- }
31
- }
32
-
33
- // Step 2: Create adapter/facade to route to new or old implementation
34
- class UserServiceFacade
35
- {
36
- private $modernService;
37
- private $useModern;
38
-
39
- public function __construct(ModernUserService $modernService, bool $useModern = false)
40
- {
41
- $this->modernService = $modernService;
42
- $this->useModern = $useModern;
43
- }
44
-
45
- public function createUser($name, $email)
46
- {
47
- if ($this->useModern) {
48
- return $this->modernService->createUser($name, $email);
49
- } else {
50
- // Call legacy function
51
- return legacy_create_user($name, $email);
52
- }
53
- }
54
- }
55
-
56
- // Step 3: Gradually migrate callers to use facade
57
- // Step 4: Enable modern implementation via feature flag
58
- // Step 5: Remove legacy code once fully migrated
59
- ```
60
-
61
- ### Characterization Tests
62
-
63
- **Write tests for legacy code before refactoring:**
64
-
65
- ```php
66
- <?php
67
-
68
- use PHPUnit\Framework\TestCase;
69
-
70
- class LegacyUserFunctionsTest extends TestCase
71
- {
72
- /**
73
- * Characterization test - documents current behavior
74
- */
75
- public function test_legacy_create_user_returns_user_id()
76
- {
77
- $userId = legacy_create_user('John Doe', 'john@example.com');
78
-
79
- $this->assertIsInt($userId);
80
- $this->assertGreaterThan(0, $userId);
81
- }
82
-
83
- /**
84
- * Test edge cases
85
- */
86
- public function test_legacy_create_user_with_duplicate_email()
87
- {
88
- legacy_create_user('User 1', 'test@example.com');
89
-
90
- $this->expectException(\Exception::class);
91
- legacy_create_user('User 2', 'test@example.com');
92
- }
93
- }
94
- ```
95
-
96
- ## Introducing Namespaces (PSR-4)
97
-
98
- ### Before: No Namespaces
99
-
100
- ```php
101
- <?php
102
-
103
- // includes/User.php
104
- class User
105
- {
106
- public $id;
107
- public $name;
108
-
109
- public function save()
110
- {
111
- // Save to database
112
- }
113
- }
114
-
115
- // includes/UserRepository.php
116
- class UserRepository
117
- {
118
- public function find($id)
119
- {
120
- // Find user
121
- }
122
- }
123
- ```
124
-
125
- ### After: With Namespaces
126
-
127
- ```php
128
- <?php
129
-
130
- // src/Models/User.php
131
- namespace App\Models;
132
-
133
- class User
134
- {
135
- private int $id;
136
- private string $name;
137
-
138
- public function save(): void
139
- {
140
- // Save to database
141
- }
142
- }
143
-
144
- // src/Repositories/UserRepository.php
145
- namespace App\Repositories;
146
-
147
- use App\Models\User;
148
-
149
- class UserRepository
150
- {
151
- public function find(int $id): ?User
152
- {
153
- // Find user
154
- }
155
- }
156
-
157
- // composer.json
158
- {
159
- "autoload": {
160
- "psr-4": {
161
- "App\\": "src/"
162
- }
163
- }
164
- }
165
- ```
166
-
167
- ### Migration Steps
168
-
169
- ```php
170
- <?php
171
-
172
- // Step 1: Add namespace to class
173
- namespace App\Models;
174
-
175
- class User
176
- {
177
- // Existing code
178
- }
179
-
180
- // Step 2: Update all references
181
- // Before:
182
- $user = new User();
183
-
184
- // After:
185
- use App\Models\User;
186
- $user = new User();
187
-
188
- // Or:
189
- $user = new \App\Models\User();
190
-
191
- // Step 3: Set up autoloading
192
- require 'vendor/autoload.php';
193
-
194
- // Step 4: Remove old require/include statements
195
- // Before:
196
- require_once 'includes/User.php';
197
-
198
- // After: (not needed with autoloading)
199
- ```
200
-
201
- ## Adding Type Hints Incrementally
202
-
203
- ### Level 1: Add Return Types
204
-
205
- ```php
206
- <?php
207
-
208
- // Before
209
- function getUser($id)
210
- {
211
- return User::find($id);
212
- }
213
-
214
- // After
215
- function getUser($id): ?User
216
- {
217
- return User::find($id);
218
- }
219
- ```
220
-
221
- ### Level 2: Add Parameter Types
222
-
223
- ```php
224
- <?php
225
-
226
- // Before
227
- function createUser($name, $email)
228
- {
229
- // ...
230
- }
231
-
232
- // After
233
- function createUser(string $name, string $email): User
234
- {
235
- // ...
236
- }
237
- ```
238
-
239
- ### Level 3: Add Property Types (PHP 7.4+)
240
-
241
- ```php
242
- <?php
243
-
244
- // Before
245
- class User
246
- {
247
- public $id;
248
- public $name;
249
- public $email;
250
- public $createdAt;
251
- }
252
-
253
- // After
254
- class User
255
- {
256
- public int $id;
257
- public string $name;
258
- public string $email;
259
- public ?\DateTime $createdAt = null;
260
- }
261
- ```
262
-
263
- ### Level 4: Add Strict Types
264
-
265
- ```php
266
- <?php
267
-
268
- declare(strict_types=1);
269
-
270
- namespace App\Models;
271
-
272
- class User
273
- {
274
- public function __construct(
275
- private int $id,
276
- private string $name,
277
- private string $email
278
- ) {}
279
- }
280
- ```
281
-
282
- ## Dependency Injection
283
-
284
- ### Before: Global Dependencies
285
-
286
- ```php
287
- <?php
288
-
289
- // Legacy code with global database connection
290
- function getUser($id)
291
- {
292
- global $db;
293
-
294
- $stmt = $db->prepare("SELECT * FROM users WHERE id = ?");
295
- $stmt->execute([$id]);
296
- return $stmt->fetch();
297
- }
298
-
299
- // Usage
300
- $user = getUser(123);
301
- ```
302
-
303
- ### After: Constructor Injection
304
-
305
- ```php
306
- <?php
307
-
308
- namespace App\Repositories;
309
-
310
- use PDO;
311
-
312
- class UserRepository
313
- {
314
- private PDO $db;
315
-
316
- public function __construct(PDO $db)
317
- {
318
- $this->db = $db;
319
- }
320
-
321
- public function find(int $id): ?array
322
- {
323
- $stmt = $this->db->prepare("SELECT * FROM users WHERE id = ?");
324
- $stmt->execute([$id]);
325
- return $stmt->fetch() ?: null;
326
- }
327
- }
328
-
329
- // Usage with DI container
330
- $container = new Container();
331
- $container->bind(PDO::class, function() {
332
- return new PDO('mysql:host=localhost;dbname=mydb', 'user', 'pass');
333
- });
334
-
335
- $userRepo = $container->make(UserRepository::class);
336
- $user = $userRepo->find(123);
337
- ```
338
-
339
- ### Service Container
340
-
341
- ```php
342
- <?php
343
-
344
- namespace App\Container;
345
-
346
- class Container
347
- {
348
- private array $bindings = [];
349
- private array $instances = [];
350
-
351
- public function bind(string $abstract, callable $concrete): void
352
- {
353
- $this->bindings[$abstract] = $concrete;
354
- }
355
-
356
- public function singleton(string $abstract, callable $concrete): void
357
- {
358
- $this->bind($abstract, function() use ($abstract, $concrete) {
359
- if (!isset($this->instances[$abstract])) {
360
- $this->instances[$abstract] = $concrete();
361
- }
362
- return $this->instances[$abstract];
363
- });
364
- }
365
-
366
- public function make(string $abstract): object
367
- {
368
- if (isset($this->bindings[$abstract])) {
369
- return $this->bindings[$abstract]();
370
- }
371
-
372
- return $this->resolve($abstract);
373
- }
374
-
375
- private function resolve(string $class): object
376
- {
377
- $reflector = new \ReflectionClass($class);
378
- $constructor = $reflector->getConstructor();
379
-
380
- if (!$constructor) {
381
- return new $class();
382
- }
383
-
384
- $dependencies = [];
385
- foreach ($constructor->getParameters() as $param) {
386
- $type = $param->getType();
387
- if ($type && !$type->isBuiltin()) {
388
- $dependencies[] = $this->make($type->getName());
389
- }
390
- }
391
-
392
- return $reflector->newInstanceArgs($dependencies);
393
- }
394
- }
395
- ```
396
-
397
- ## Refactoring Procedural to OOP
398
-
399
- ### Before: Procedural Code
400
-
401
- ```php
402
- <?php
403
-
404
- // functions.php
405
- function calculate_order_total($items, $tax_rate, $shipping_cost)
406
- {
407
- $subtotal = 0;
408
- foreach ($items as $item) {
409
- $subtotal += $item['price'] * $item['quantity'];
410
- }
411
-
412
- $tax = $subtotal * $tax_rate;
413
- $total = $subtotal + $tax + $shipping_cost;
414
-
415
- return [
416
- 'subtotal' => $subtotal,
417
- 'tax' => $tax,
418
- 'shipping' => $shipping_cost,
419
- 'total' => $total
420
- ];
421
- }
422
-
423
- function apply_discount($total, $discount_code)
424
- {
425
- global $db;
426
-
427
- $discount = $db->query("SELECT * FROM discounts WHERE code = '$discount_code'")->fetch();
428
-
429
- if ($discount) {
430
- return $total - ($total * $discount['percentage'] / 100);
431
- }
432
-
433
- return $total;
434
- }
435
- ```
436
-
437
- ### After: Object-Oriented Code
438
-
439
- ```php
440
- <?php
441
-
442
- namespace App\Services;
443
-
444
- use App\Models\Order;
445
- use App\Repositories\DiscountRepository;
446
-
447
- class OrderCalculator
448
- {
449
- private float $taxRate;
450
-
451
- public function __construct(
452
- private DiscountRepository $discountRepo,
453
- float $taxRate = 0.08
454
- ) {
455
- $this->taxRate = $taxRate;
456
- }
457
-
458
- public function calculateTotal(Order $order): OrderTotal
459
- {
460
- $subtotal = $this->calculateSubtotal($order->items);
461
- $tax = $subtotal * $this->taxRate;
462
- $shipping = $this->calculateShipping($order);
463
- $total = $subtotal + $tax + $shipping;
464
-
465
- return new OrderTotal(
466
- subtotal: $subtotal,
467
- tax: $tax,
468
- shipping: $shipping,
469
- total: $total
470
- );
471
- }
472
-
473
- public function applyDiscount(float $total, string $discountCode): float
474
- {
475
- $discount = $this->discountRepo->findByCode($discountCode);
476
-
477
- if (!$discount || !$discount->isValid()) {
478
- return $total;
479
- }
480
-
481
- return $total - ($total * $discount->percentage / 100);
482
- }
483
-
484
- private function calculateSubtotal(array $items): float
485
- {
486
- return array_reduce($items, function($sum, $item) {
487
- return $sum + ($item->price * $item->quantity);
488
- }, 0.0);
489
- }
490
-
491
- private function calculateShipping(Order $order): float
492
- {
493
- // Shipping calculation logic
494
- return 10.00;
495
- }
496
- }
497
-
498
- class OrderTotal
499
- {
500
- public function __construct(
501
- public readonly float $subtotal,
502
- public readonly float $tax,
503
- public readonly float $shipping,
504
- public readonly float $total
505
- ) {}
506
- }
507
- ```
508
-
509
- ## Extracting Classes from Large Files
510
-
511
- ### Before: God Class
512
-
513
- ```php
514
- <?php
515
-
516
- class User
517
- {
518
- public function save() { /* ... */ }
519
- public function delete() { /* ... */ }
520
- public function sendEmail($subject, $body) { /* ... */ }
521
- public function hashPassword($password) { /* ... */ }
522
- public function validateEmail($email) { /* ... */ }
523
- public function generateToken() { /* ... */ }
524
- public function logActivity($action) { /* ... */ }
525
- // 50+ more methods...
526
- }
527
- ```
528
-
529
- ### After: Single Responsibility
530
-
531
- ```php
532
- <?php
533
-
534
- namespace App\Models;
535
-
536
- class User
537
- {
538
- public function save(): void { /* ... */ }
539
- public function delete(): void { /* ... */ }
540
- }
541
-
542
- namespace App\Services;
543
-
544
- class UserMailer
545
- {
546
- public function sendWelcomeEmail(User $user): void { /* ... */ }
547
- public function sendPasswordReset(User $user): void { /* ... */ }
548
- }
549
-
550
- class PasswordHasher
551
- {
552
- public function hash(string $password): string { /* ... */ }
553
- public function verify(string $password, string $hash): bool { /* ... */ }
554
- }
555
-
556
- class EmailValidator
557
- {
558
- public function validate(string $email): bool { /* ... */ }
559
- }
560
-
561
- class TokenGenerator
562
- {
563
- public function generate(): string { /* ... */ }
564
- }
565
-
566
- class ActivityLogger
567
- {
568
- public function log(User $user, string $action): void { /* ... */ }
569
- }
570
- ```
571
-
572
- ## Database Query Migration
573
-
574
- ### Before: Direct Queries
575
-
576
- ```php
577
- <?php
578
-
579
- function getActiveUsers()
580
- {
581
- global $db;
582
-
583
- $result = mysql_query("SELECT * FROM users WHERE active = 1");
584
- $users = [];
585
-
586
- while ($row = mysql_fetch_assoc($result)) {
587
- $users[] = $row;
588
- }
589
-
590
- return $users;
591
- }
592
- ```
593
-
594
- ### After: Query Builder/ORM
595
-
596
- ```php
597
- <?php
598
-
599
- namespace App\Repositories;
600
-
601
- use Illuminate\Database\Capsule\Manager as DB;
602
- use App\Models\User;
603
-
604
- class UserRepository
605
- {
606
- public function getActiveUsers(): array
607
- {
608
- return User::where('active', true)->get()->toArray();
609
- }
610
-
611
- // Or with query builder
612
- public function getActiveUsersQueryBuilder(): array
613
- {
614
- return DB::table('users')
615
- ->where('active', true)
616
- ->get()
617
- ->toArray();
618
- }
619
- }
620
- ```
621
-
622
- ## Best Practices
623
-
624
- ### ✅ DO
625
-
626
- - Write characterization tests before refactoring
627
- - Use strangler fig pattern for gradual migration
628
- - Introduce namespaces incrementally
629
- - Add type hints progressively (return types first)
630
- - Implement dependency injection
631
- - Extract classes with single responsibility
632
- - Use modern PHP features (7.4+, 8.0+)
633
- - Migrate to PSR-4 autoloading
634
- - Replace global variables with dependency injection
635
- - Use ORM/query builder instead of raw SQL
636
- - Document migration decisions
637
- - Keep legacy code working during migration
638
-
639
- ### ❌ DON'T
640
-
641
- - Attempt complete rewrite without tests
642
- - Break existing functionality
643
- - Mix old and new patterns in same class
644
- - Skip testing during migration
645
- - Remove legacy code before migration complete
646
- - Ignore backward compatibility
647
- - Rush the migration process
648
- - Forget to update documentation
649
- - Leave dead code in codebase
650
- - Use deprecated PHP features in new code
651
-
652
- ## Migration Checklist
653
-
654
- - [ ] Write characterization tests for legacy code
655
- - [ ] Set up PSR-4 autoloading
656
- - [ ] Introduce namespaces incrementally
657
- - [ ] Add return type hints
658
- - [ ] Add parameter type hints
659
- - [ ] Add property type hints
660
- - [ ] Implement dependency injection
661
- - [ ] Extract single-responsibility classes
662
- - [ ] Migrate to ORM/query builder
663
- - [ ] Remove global variables
664
- - [ ] Update to modern PHP version (8.0+)
665
- - [ ] Enable strict types
666
- - [ ] Remove deprecated function calls
667
- - [ ] Update documentation
668
- - [ ] Remove dead code
669
-
670
- ## Tools
671
-
672
- - **PHPStan** - Static analysis to find bugs
673
- - **Rector** - Automated refactoring tool
674
- - **PHP-CS-Fixer** - Code style fixer
675
- - **PHPUnit** - Testing framework
676
- - **Composer** - Dependency management and autoloading
677
-
1
+ # PHP Legacy Code Migration Best Practices
2
+
3
+ ## Overview
4
+
5
+ This guide provides strategies for refactoring legacy PHP code to modern standards, including introducing namespaces, adding type hints, implementing dependency injection, and applying design patterns.
6
+
7
+ ## Refactoring Strategies
8
+
9
+ ### Strangler Fig Pattern
10
+
11
+ **Gradually replace legacy code** without a complete rewrite.
12
+
13
+ ```php
14
+ <?php
15
+
16
+ // Step 1: Create new implementation alongside legacy code
17
+ namespace App\Services;
18
+
19
+ class ModernUserService
20
+ {
21
+ public function createUser(string $name, string $email): User
22
+ {
23
+ // New implementation with type hints, validation, etc.
24
+ $user = new User();
25
+ $user->name = $name;
26
+ $user->email = $email;
27
+ $user->save();
28
+
29
+ return $user;
30
+ }
31
+ }
32
+
33
+ // Step 2: Create adapter/facade to route to new or old implementation
34
+ class UserServiceFacade
35
+ {
36
+ private $modernService;
37
+ private $useModern;
38
+
39
+ public function __construct(ModernUserService $modernService, bool $useModern = false)
40
+ {
41
+ $this->modernService = $modernService;
42
+ $this->useModern = $useModern;
43
+ }
44
+
45
+ public function createUser($name, $email)
46
+ {
47
+ if ($this->useModern) {
48
+ return $this->modernService->createUser($name, $email);
49
+ } else {
50
+ // Call legacy function
51
+ return legacy_create_user($name, $email);
52
+ }
53
+ }
54
+ }
55
+
56
+ // Step 3: Gradually migrate callers to use facade
57
+ // Step 4: Enable modern implementation via feature flag
58
+ // Step 5: Remove legacy code once fully migrated
59
+ ```
60
+
61
+ ### Characterization Tests
62
+
63
+ **Write tests for legacy code before refactoring:**
64
+
65
+ ```php
66
+ <?php
67
+
68
+ use PHPUnit\Framework\TestCase;
69
+
70
+ class LegacyUserFunctionsTest extends TestCase
71
+ {
72
+ /**
73
+ * Characterization test - documents current behavior
74
+ */
75
+ public function test_legacy_create_user_returns_user_id()
76
+ {
77
+ $userId = legacy_create_user('John Doe', 'john@example.com');
78
+
79
+ $this->assertIsInt($userId);
80
+ $this->assertGreaterThan(0, $userId);
81
+ }
82
+
83
+ /**
84
+ * Test edge cases
85
+ */
86
+ public function test_legacy_create_user_with_duplicate_email()
87
+ {
88
+ legacy_create_user('User 1', 'test@example.com');
89
+
90
+ $this->expectException(\Exception::class);
91
+ legacy_create_user('User 2', 'test@example.com');
92
+ }
93
+ }
94
+ ```
95
+
96
+ ## Introducing Namespaces (PSR-4)
97
+
98
+ ### Before: No Namespaces
99
+
100
+ ```php
101
+ <?php
102
+
103
+ // includes/User.php
104
+ class User
105
+ {
106
+ public $id;
107
+ public $name;
108
+
109
+ public function save()
110
+ {
111
+ // Save to database
112
+ }
113
+ }
114
+
115
+ // includes/UserRepository.php
116
+ class UserRepository
117
+ {
118
+ public function find($id)
119
+ {
120
+ // Find user
121
+ }
122
+ }
123
+ ```
124
+
125
+ ### After: With Namespaces
126
+
127
+ ```php
128
+ <?php
129
+
130
+ // src/Models/User.php
131
+ namespace App\Models;
132
+
133
+ class User
134
+ {
135
+ private int $id;
136
+ private string $name;
137
+
138
+ public function save(): void
139
+ {
140
+ // Save to database
141
+ }
142
+ }
143
+
144
+ // src/Repositories/UserRepository.php
145
+ namespace App\Repositories;
146
+
147
+ use App\Models\User;
148
+
149
+ class UserRepository
150
+ {
151
+ public function find(int $id): ?User
152
+ {
153
+ // Find user
154
+ }
155
+ }
156
+
157
+ // composer.json
158
+ {
159
+ "autoload": {
160
+ "psr-4": {
161
+ "App\\": "src/"
162
+ }
163
+ }
164
+ }
165
+ ```
166
+
167
+ ### Migration Steps
168
+
169
+ ```php
170
+ <?php
171
+
172
+ // Step 1: Add namespace to class
173
+ namespace App\Models;
174
+
175
+ class User
176
+ {
177
+ // Existing code
178
+ }
179
+
180
+ // Step 2: Update all references
181
+ // Before:
182
+ $user = new User();
183
+
184
+ // After:
185
+ use App\Models\User;
186
+ $user = new User();
187
+
188
+ // Or:
189
+ $user = new \App\Models\User();
190
+
191
+ // Step 3: Set up autoloading
192
+ require 'vendor/autoload.php';
193
+
194
+ // Step 4: Remove old require/include statements
195
+ // Before:
196
+ require_once 'includes/User.php';
197
+
198
+ // After: (not needed with autoloading)
199
+ ```
200
+
201
+ ## Adding Type Hints Incrementally
202
+
203
+ ### Level 1: Add Return Types
204
+
205
+ ```php
206
+ <?php
207
+
208
+ // Before
209
+ function getUser($id)
210
+ {
211
+ return User::find($id);
212
+ }
213
+
214
+ // After
215
+ function getUser($id): ?User
216
+ {
217
+ return User::find($id);
218
+ }
219
+ ```
220
+
221
+ ### Level 2: Add Parameter Types
222
+
223
+ ```php
224
+ <?php
225
+
226
+ // Before
227
+ function createUser($name, $email)
228
+ {
229
+ // ...
230
+ }
231
+
232
+ // After
233
+ function createUser(string $name, string $email): User
234
+ {
235
+ // ...
236
+ }
237
+ ```
238
+
239
+ ### Level 3: Add Property Types (PHP 7.4+)
240
+
241
+ ```php
242
+ <?php
243
+
244
+ // Before
245
+ class User
246
+ {
247
+ public $id;
248
+ public $name;
249
+ public $email;
250
+ public $createdAt;
251
+ }
252
+
253
+ // After
254
+ class User
255
+ {
256
+ public int $id;
257
+ public string $name;
258
+ public string $email;
259
+ public ?\DateTime $createdAt = null;
260
+ }
261
+ ```
262
+
263
+ ### Level 4: Add Strict Types
264
+
265
+ ```php
266
+ <?php
267
+
268
+ declare(strict_types=1);
269
+
270
+ namespace App\Models;
271
+
272
+ class User
273
+ {
274
+ public function __construct(
275
+ private int $id,
276
+ private string $name,
277
+ private string $email
278
+ ) {}
279
+ }
280
+ ```
281
+
282
+ ## Dependency Injection
283
+
284
+ ### Before: Global Dependencies
285
+
286
+ ```php
287
+ <?php
288
+
289
+ // Legacy code with global database connection
290
+ function getUser($id)
291
+ {
292
+ global $db;
293
+
294
+ $stmt = $db->prepare("SELECT * FROM users WHERE id = ?");
295
+ $stmt->execute([$id]);
296
+ return $stmt->fetch();
297
+ }
298
+
299
+ // Usage
300
+ $user = getUser(123);
301
+ ```
302
+
303
+ ### After: Constructor Injection
304
+
305
+ ```php
306
+ <?php
307
+
308
+ namespace App\Repositories;
309
+
310
+ use PDO;
311
+
312
+ class UserRepository
313
+ {
314
+ private PDO $db;
315
+
316
+ public function __construct(PDO $db)
317
+ {
318
+ $this->db = $db;
319
+ }
320
+
321
+ public function find(int $id): ?array
322
+ {
323
+ $stmt = $this->db->prepare("SELECT * FROM users WHERE id = ?");
324
+ $stmt->execute([$id]);
325
+ return $stmt->fetch() ?: null;
326
+ }
327
+ }
328
+
329
+ // Usage with DI container
330
+ $container = new Container();
331
+ $container->bind(PDO::class, function() {
332
+ return new PDO('mysql:host=localhost;dbname=mydb', 'user', 'pass');
333
+ });
334
+
335
+ $userRepo = $container->make(UserRepository::class);
336
+ $user = $userRepo->find(123);
337
+ ```
338
+
339
+ ### Service Container
340
+
341
+ ```php
342
+ <?php
343
+
344
+ namespace App\Container;
345
+
346
+ class Container
347
+ {
348
+ private array $bindings = [];
349
+ private array $instances = [];
350
+
351
+ public function bind(string $abstract, callable $concrete): void
352
+ {
353
+ $this->bindings[$abstract] = $concrete;
354
+ }
355
+
356
+ public function singleton(string $abstract, callable $concrete): void
357
+ {
358
+ $this->bind($abstract, function() use ($abstract, $concrete) {
359
+ if (!isset($this->instances[$abstract])) {
360
+ $this->instances[$abstract] = $concrete();
361
+ }
362
+ return $this->instances[$abstract];
363
+ });
364
+ }
365
+
366
+ public function make(string $abstract): object
367
+ {
368
+ if (isset($this->bindings[$abstract])) {
369
+ return $this->bindings[$abstract]();
370
+ }
371
+
372
+ return $this->resolve($abstract);
373
+ }
374
+
375
+ private function resolve(string $class): object
376
+ {
377
+ $reflector = new \ReflectionClass($class);
378
+ $constructor = $reflector->getConstructor();
379
+
380
+ if (!$constructor) {
381
+ return new $class();
382
+ }
383
+
384
+ $dependencies = [];
385
+ foreach ($constructor->getParameters() as $param) {
386
+ $type = $param->getType();
387
+ if ($type && !$type->isBuiltin()) {
388
+ $dependencies[] = $this->make($type->getName());
389
+ }
390
+ }
391
+
392
+ return $reflector->newInstanceArgs($dependencies);
393
+ }
394
+ }
395
+ ```
396
+
397
+ ## Refactoring Procedural to OOP
398
+
399
+ ### Before: Procedural Code
400
+
401
+ ```php
402
+ <?php
403
+
404
+ // functions.php
405
+ function calculate_order_total($items, $tax_rate, $shipping_cost)
406
+ {
407
+ $subtotal = 0;
408
+ foreach ($items as $item) {
409
+ $subtotal += $item['price'] * $item['quantity'];
410
+ }
411
+
412
+ $tax = $subtotal * $tax_rate;
413
+ $total = $subtotal + $tax + $shipping_cost;
414
+
415
+ return [
416
+ 'subtotal' => $subtotal,
417
+ 'tax' => $tax,
418
+ 'shipping' => $shipping_cost,
419
+ 'total' => $total
420
+ ];
421
+ }
422
+
423
+ function apply_discount($total, $discount_code)
424
+ {
425
+ global $db;
426
+
427
+ $discount = $db->query("SELECT * FROM discounts WHERE code = '$discount_code'")->fetch();
428
+
429
+ if ($discount) {
430
+ return $total - ($total * $discount['percentage'] / 100);
431
+ }
432
+
433
+ return $total;
434
+ }
435
+ ```
436
+
437
+ ### After: Object-Oriented Code
438
+
439
+ ```php
440
+ <?php
441
+
442
+ namespace App\Services;
443
+
444
+ use App\Models\Order;
445
+ use App\Repositories\DiscountRepository;
446
+
447
+ class OrderCalculator
448
+ {
449
+ private float $taxRate;
450
+
451
+ public function __construct(
452
+ private DiscountRepository $discountRepo,
453
+ float $taxRate = 0.08
454
+ ) {
455
+ $this->taxRate = $taxRate;
456
+ }
457
+
458
+ public function calculateTotal(Order $order): OrderTotal
459
+ {
460
+ $subtotal = $this->calculateSubtotal($order->items);
461
+ $tax = $subtotal * $this->taxRate;
462
+ $shipping = $this->calculateShipping($order);
463
+ $total = $subtotal + $tax + $shipping;
464
+
465
+ return new OrderTotal(
466
+ subtotal: $subtotal,
467
+ tax: $tax,
468
+ shipping: $shipping,
469
+ total: $total
470
+ );
471
+ }
472
+
473
+ public function applyDiscount(float $total, string $discountCode): float
474
+ {
475
+ $discount = $this->discountRepo->findByCode($discountCode);
476
+
477
+ if (!$discount || !$discount->isValid()) {
478
+ return $total;
479
+ }
480
+
481
+ return $total - ($total * $discount->percentage / 100);
482
+ }
483
+
484
+ private function calculateSubtotal(array $items): float
485
+ {
486
+ return array_reduce($items, function($sum, $item) {
487
+ return $sum + ($item->price * $item->quantity);
488
+ }, 0.0);
489
+ }
490
+
491
+ private function calculateShipping(Order $order): float
492
+ {
493
+ // Shipping calculation logic
494
+ return 10.00;
495
+ }
496
+ }
497
+
498
+ class OrderTotal
499
+ {
500
+ public function __construct(
501
+ public readonly float $subtotal,
502
+ public readonly float $tax,
503
+ public readonly float $shipping,
504
+ public readonly float $total
505
+ ) {}
506
+ }
507
+ ```
508
+
509
+ ## Extracting Classes from Large Files
510
+
511
+ ### Before: God Class
512
+
513
+ ```php
514
+ <?php
515
+
516
+ class User
517
+ {
518
+ public function save() { /* ... */ }
519
+ public function delete() { /* ... */ }
520
+ public function sendEmail($subject, $body) { /* ... */ }
521
+ public function hashPassword($password) { /* ... */ }
522
+ public function validateEmail($email) { /* ... */ }
523
+ public function generateToken() { /* ... */ }
524
+ public function logActivity($action) { /* ... */ }
525
+ // 50+ more methods...
526
+ }
527
+ ```
528
+
529
+ ### After: Single Responsibility
530
+
531
+ ```php
532
+ <?php
533
+
534
+ namespace App\Models;
535
+
536
+ class User
537
+ {
538
+ public function save(): void { /* ... */ }
539
+ public function delete(): void { /* ... */ }
540
+ }
541
+
542
+ namespace App\Services;
543
+
544
+ class UserMailer
545
+ {
546
+ public function sendWelcomeEmail(User $user): void { /* ... */ }
547
+ public function sendPasswordReset(User $user): void { /* ... */ }
548
+ }
549
+
550
+ class PasswordHasher
551
+ {
552
+ public function hash(string $password): string { /* ... */ }
553
+ public function verify(string $password, string $hash): bool { /* ... */ }
554
+ }
555
+
556
+ class EmailValidator
557
+ {
558
+ public function validate(string $email): bool { /* ... */ }
559
+ }
560
+
561
+ class TokenGenerator
562
+ {
563
+ public function generate(): string { /* ... */ }
564
+ }
565
+
566
+ class ActivityLogger
567
+ {
568
+ public function log(User $user, string $action): void { /* ... */ }
569
+ }
570
+ ```
571
+
572
+ ## Database Query Migration
573
+
574
+ ### Before: Direct Queries
575
+
576
+ ```php
577
+ <?php
578
+
579
+ function getActiveUsers()
580
+ {
581
+ global $db;
582
+
583
+ $result = mysql_query("SELECT * FROM users WHERE active = 1");
584
+ $users = [];
585
+
586
+ while ($row = mysql_fetch_assoc($result)) {
587
+ $users[] = $row;
588
+ }
589
+
590
+ return $users;
591
+ }
592
+ ```
593
+
594
+ ### After: Query Builder/ORM
595
+
596
+ ```php
597
+ <?php
598
+
599
+ namespace App\Repositories;
600
+
601
+ use Illuminate\Database\Capsule\Manager as DB;
602
+ use App\Models\User;
603
+
604
+ class UserRepository
605
+ {
606
+ public function getActiveUsers(): array
607
+ {
608
+ return User::where('active', true)->get()->toArray();
609
+ }
610
+
611
+ // Or with query builder
612
+ public function getActiveUsersQueryBuilder(): array
613
+ {
614
+ return DB::table('users')
615
+ ->where('active', true)
616
+ ->get()
617
+ ->toArray();
618
+ }
619
+ }
620
+ ```
621
+
622
+ ## Best Practices
623
+
624
+ ### ✅ DO
625
+
626
+ - Write characterization tests before refactoring
627
+ - Use strangler fig pattern for gradual migration
628
+ - Introduce namespaces incrementally
629
+ - Add type hints progressively (return types first)
630
+ - Implement dependency injection
631
+ - Extract classes with single responsibility
632
+ - Use modern PHP features (7.4+, 8.0+)
633
+ - Migrate to PSR-4 autoloading
634
+ - Replace global variables with dependency injection
635
+ - Use ORM/query builder instead of raw SQL
636
+ - Document migration decisions
637
+ - Keep legacy code working during migration
638
+
639
+ ### ❌ DON'T
640
+
641
+ - Attempt complete rewrite without tests
642
+ - Break existing functionality
643
+ - Mix old and new patterns in same class
644
+ - Skip testing during migration
645
+ - Remove legacy code before migration complete
646
+ - Ignore backward compatibility
647
+ - Rush the migration process
648
+ - Forget to update documentation
649
+ - Leave dead code in codebase
650
+ - Use deprecated PHP features in new code
651
+
652
+ ## Migration Checklist
653
+
654
+ - [ ] Write characterization tests for legacy code
655
+ - [ ] Set up PSR-4 autoloading
656
+ - [ ] Introduce namespaces incrementally
657
+ - [ ] Add return type hints
658
+ - [ ] Add parameter type hints
659
+ - [ ] Add property type hints
660
+ - [ ] Implement dependency injection
661
+ - [ ] Extract single-responsibility classes
662
+ - [ ] Migrate to ORM/query builder
663
+ - [ ] Remove global variables
664
+ - [ ] Update to modern PHP version (8.0+)
665
+ - [ ] Enable strict types
666
+ - [ ] Remove deprecated function calls
667
+ - [ ] Update documentation
668
+ - [ ] Remove dead code
669
+
670
+ ## Tools
671
+
672
+ - **PHPStan** - Static analysis to find bugs
673
+ - **Rector** - Automated refactoring tool
674
+ - **PHP-CS-Fixer** - Code style fixer
675
+ - **PHPUnit** - Testing framework
676
+ - **Composer** - Dependency management and autoloading
677
+