Tech Note: Stinky's Refactoring Binge
Science | Sat, Sep 27, 2008 at 5:34:06 pm PDT
Stinky Beaumont is project-managing a major code refactoring process this weekend, that we’ve been putting off because it’s painful. We’re talking duplicated code. Global variables. Inconsistent variable naming. Remnants from the days before we started coding smart, instead of just getting it working. It’s not all like this, but the Ajax-based comments code in particular still had a funny smell in some neglected corners. In other words, it worked but it wasn’t sleek.
We’re replacing duplicated code with object methods, or functions where the procedural code still needs more untangling. Replacing global variables with constants where possible, object properties where not.
It’s happening bit by bit, piece by piece, step by step. While loop by function call. Much of the ‘new comments’ logic has now been refactored in this way, and the front page and daily archives pages now use a common display interface.
And with that, I’m opening registration for a very limited time.
UPDATE at 9/27/08 5:45:20 pm:
Here’s a tip that comes in handy for eliminating global variables in PHP.
Constants are very useful for this purpose. They’re automatically available in the global scope. But they’re limited to numbers or strings. No arrays. Bummer.
But you can define an array, then serialize it and define the resulting serialized string as a constant. Then when you need to use it, even within a function or object method, you can simply unserialize the array and you’re good to go. For example, to define the serialized array:
$myItems = array('item1', 'item2', 'item3');
define('MY_ITEMS', serialize($myItems));
Then, to access the “array constant:”
$array = unserialize(MY_ITEMS);
UPDATE at 9/28/08 9:54:46 am:
LGF reader “scrad” pointed out that you can access any variable in the global scope (including arrays and objects) by using PHP's $GLOBALS array. The above example could also be coded this way (eliminating the overhead of the serialize/unserialize functions):
$myItems = array('item1', 'item2', 'item3');
To access the second item in the array:
$item2 = $GLOBALS['myItems'][1];
