I haven't posted any new code in awhile, so I figured I'd share this simple progress bar I use when running long CakePHP shells.

Get It

The code is available on GitHub.

Progress Bar Pr0n

Here's what it looks like in action:

Usage

1. Include the task in your shell. Even though this is a plugin you don't need to use the "PluginName.TaskName" format. Cake finds it somehow. It's magic.

var $tasks = array('ProgressBar');

2. Before whatever your looping through, start the progress bar by passing in the total number of whatever you're doing.

$this->ProgressBar->start(count($loops));

3. Then each time you go through the loop call next:

$this->ProgressBar->next();

Calling ProgressBar::next() will increment the bar one unit. You can also pass in a value to increment more then one unit. For example is you are processing a file you could pass the total file size in at the start and then for each chunk pass how much you processed.

$this->ProgressBar->next(strlen($chunk));

You can also set the progress bar to any point by calling ProgressBar::set(). This isn't a percentage. It's the "x of total" that is done. So if you set the total to 150 and call set with a parameter of 50 it will show the progress bar as 1/3 done.

$this->ProgressBar->set(50);

Done

This post is now 100% complete.