{"id":753,"date":"2021-07-30T16:31:07","date_gmt":"2021-07-30T20:31:07","guid":{"rendered":"https:\/\/crossan007.dev\/blog\/?p=753"},"modified":"2021-07-30T16:31:32","modified_gmt":"2021-07-30T20:31:32","slug":"expose-namespaced-php-classes-at-the-root","status":"publish","type":"post","link":"https:\/\/crossan007.dev\/blog\/php\/expose-namespaced-php-classes-at-the-root\/","title":{"rendered":"Expose Namespaced PHP Classes at the Root"},"content":{"rendered":"\n
Tweet<\/a><\/div>\n\n

First off, I sincerely hope that nobody ever finds this blog post useful. Alas, I’m sure there is some soul out there in a situation similar to my own: hang in there friend.<\/p>\n\n\n\n

If you’ve been writing PHP for any length of time, you know how easy it is to write bad<\/strong> PHP: don’t bother with classes, include all your functions in a single 6,000 line file, and certainly don’t set up a folder structure in your git repository. <\/p>\n\n\n\n

So, what do you do when you want to start bringing order to the chaos?<\/p>\n\n\n\n

I found myself in a situation where I had a few hundred PHP files in the root of a repository; each file defining a class. Unfortunately, none were in a namespace. <\/p>\n\n\n\n

Additionally, these were accessible through a manually-defined spl_autoload_register<\/code> function which was part of a common.php<\/code> file that got require_once<\/code>‘d from tons of different places. Some of the places requiring this file were even outside the repository and completely unknown to me. <\/p>\n\n\n\n

I wanted to clean things up, but without breaking unknown code. <\/p>\n\n\n\n

The first thing I wanted to do was establish a namespace for these classes and to introduce a strategic folder hierarchy. A few google searches quickly proved my suspicion: you can’t present classes belonging to a namespace as if they were available at the root namespace (well, you can with use<\/code>, but that is scoped only to the current file; I don’t want to change hundreds of files). See here<\/a> and here<\/a><\/p>\n\n\n\n

This would be a problem if I want to move in-use classes inside a namespace.<\/p>\n\n\n\n

But then I discovered this comment<\/a> and started musing: “hmmm, I can create a class in the root namespace that extends a class in a child namespace” and “spl_autoload_register<\/code> lets me try to find a class before PHP gives up” and “what if I could enumerate all classes in a defined namespace and dynamically instantiate a root-namespace proxy?”<\/p>\n\n\n\n

And that’s exactly what I did:<\/p>\n\n\n\n

\/\/ since we tons of legacy files requiring common.php, \n\/\/ create an autoload proxy for root->ModelV1 until \n\/\/ we can add \"use\" statements to all necessary locations\nspl_autoload_register(function ($class) {\n\tif (strpos($class,\"\\\\\")!== false) {\n\t\t\/\/ only attempt to autoload root-namespace'd classes\n\t\treturn false;\n\t}\n\t$namespacesAvailableAtRoot = array(\"ModelV1\");\n\tforeach ($namespacesAvailableAtRoot as $namespace) {\n\t\tif (class_exists(\t$namespace.\"\\\\\" . $class)) {\n\t\t\t$str = sprintf('Class %s extends %s\\%s {}', $class, $namespace, $class);\n\t\t\t\/\/ this is uugly.  Yes; we're eval-creating new PHP classes at runtime where \n\t\t\t\/\/ the new class exists in the root namespace and extends the class implementation from \n\t\t\t\/\/ ModelV1.\n\t\t\t\/\/ Borrowed from: https:\/\/stackoverflow.com\/a\/13504972\n\t\t\t\/\/ and from: https:\/\/stackoverflow.com\/a\/19890311\n\t\t\teval($str);\n\t\t\treturn true;\n\t\t}\n\t}\n\treturn false;\n});<\/code><\/pre>\n\n\n\n
Again, I hope absolutely nobody finds this useful.  In fact, I hope to thoroughly expunge this code In the Near Future \u2122 (but we all know how that goes)<\/p>\n\n\n\n
Cheers!<\/p>\n","protected":false},"excerpt":{"rendered":"
First off, I sincerely hope that nobody ever finds this blog post useful. Alas, I’m sure there is some soul out there in a situation similar to my own: hang in there friend. If you’ve been writing PHP for any length of time, you know how easy it is to write bad PHP: don’t bother … Continue reading Expose Namespaced PHP Classes at the Root<\/span> →<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":[],"categories":[297],"tags":[295,296,294,39],"yoast_head":"\n\n\n\n\n\n\n\n\n\n\n\n\t\n\t\n\t\n