Simple use of sprintf

Recently I came across this line of code:


$number = $object->getNumber() . '-' . substr(('000' . $object->getCounter()), -4, 4);

It is not very intuitive but if you look at it a little closer it becomes clear that the intent of the programmer was to pad the counter with ‘0’ limiting the size to 4. It does this by starting at the 4th character from the end(-4) and then extracting 4 characters from that point. So if the counter was 77 making the concatenated number 00077, it would extract 0077. Basically the last four. This is not very good use of string functions:-)

A simple rule to remember is whenever a particular format is required is to use sprintf or one its variants. That’s what the function is intended to do. I have demonstrated the code both ways.


$dateString = '11122010';
$counter = 5;
//non intuitive
$number = $dateString . '-' . substr(('000' . $counter), -4, 4);
echo $number;

//intuitive
$number = sprintf('%s-%04s', $dateString, $counter);
echo $number; 

Nice and simple!

Advertisements

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s