phake - Rake/Make for PHP 5.3 
© 2010 Jason Frame [ [email protected] / @jaz303 ]
Released under the MIT License.
A wee clone of Ruby's rake for PHP 5.3. Uses closures for ultimate coolness.
Questions abut phake? Come and chat in #phake on Freenode!
Usage
- Download
- Create a
Phakefilein the current directory or a parent directory - Invoke
./phake task:nameto invoke task or./phake -Tto list defined tasks
Defining Tasks
Define tasks like this:
task('dependency1', function() {
echo "i will run first!\n";
});
task('dependency2', function() {
echo "i will run second!\n";
});
task('task_name', 'dependency1', 'dependency2', function() {
echo "i will run last!\n";
});
This task would be invoked from the command line by ./phake task_name
Task bodies are optional if you want to create some sort of "super-task" that just invokes a bunch of others:
task('foo', 'dep1', 'dep2');
And multiple bodies can be added to tasks, all of which will be executed when the task is invoked:
task('foo', function() { echo "task work item 1\n"; });
task('foo', function() { echo "task work item 2\n"; });
Grouping Tasks
Like Rake, we can group tasks:
group('db', function() {
task('init', function() {
echo "i'm initialising the database\n";
});
});
This would be invoked by ./phake db:init
Describing Tasks
Call desc() immediately before defining a task to set its description:
desc("Initialises the database");
task('db_init', function() { echo "oh hai it's a database\n"; });
Output from ./phake -T:
db_init Initialises the database
After/Before Blocks
Sometimes you may want to specify that some code should run before or after a task (distinct from dependencies), a bit like Capistrano. Phake supports this:
before('foo', function() { ... });
after('baz:bar', function() { ... });
Task Arguments
Phake allows arguments to specified on the command line:
# Execute task `quux` with the given args
./phake quux name=Jason city=Glasgow
This format must be matched exactly; do not put spaces between = and the argument name/value. If you need to put spaces in the argument value, place the entire assignment in quotes.
Arguments are made available to tasks by the application object's ArrayAccess implementation:
task('task_with_args', function($app) {
$name = $app['name'];
$city = $app['city'];
// do some stuff...
});
Aborting Execution
To abort execution of a task sequence, simply throw an exception.
desc('Demonstrate failure');
task('fail', function() {
throw new Exception;
});
Running phake fail will yield:
- jason@disco phake % ./bin/phake fail
(in /Users/jason/dev/projects/phake)
aborted!
Exception
(See full trace by running task with --trace)
A Somewhat More Complete Example
This is what a complete Phakefile might look like. It also highlights some of the more complex name resolution issues arising when dealing with groups.
Here's the output from ./phake (implied task to run is default):
jason@ratchet phake [master*] $ ./phake
(in /Users/jason/dev/projects/phake)
I am the outer environment. I should run first.
I am the inner environment. I should run second.
I am initialising the database...
Running unit tests...
Running a second batch of unit tests...
All tests complete! (
)
And the corresponding output from phake -T:
jason@ratchet phake [master*] $ ./phake -T
(in /Users/jason/dev/projects/phake)
database Initialises the database connection
environment Load the application environment
test:all:run Run absolutely every test everywhere!
test:units Run the unit tests
Bash Autocompletion
Bashkim Isai has created phake-autocomplete, a bash-completion script for phake task names.
1.4k Nov 29, 2022
4.6k Jan 7, 2023
2.7k Dec 27, 2022
386 Dec 27, 2022
1.8k Jan 2, 2023
1.1k Jan 2, 2023
10.3k Jan 1, 2023
327 Jan 5, 2023
469 Dec 2, 2022
286 Nov 12, 2022
331 Jan 3, 2023
529 Jan 4, 2023
1.8k Dec 30, 2022
18.8k Jan 4, 2023
67 Sep 12, 2022
13 Dec 7, 2022
44 Dec 7, 2022