Daniel Gomes @danielcsgomes October 17, 2013 icon by Austin Andrews © http://thenounproject.com/Templarian How to Build Console Applications

• Software Engineer @ GuestCentric Systems • ZCE PHP 5.3, OCP MySQL 5 Developer, CSM • @danielcsgomes about me

Lots of scripts Too many di!erent tools Tedious and boring

Centralize your tools Have interactive tools Easy to use by everyone Usage manual what about

Meet symfony Console Component

• Application • Command • Input • Output • Helpers • Events • Formatters console component toolset

APPLICATION COMMAND A COMMAND B COMMAND C plug-in & run

{ "require": { "symfony/console": "2.3.*@dev" } } install via composer zero dependencies

run(); Bootstrapping the application

$ php app.php

basic command

// Command/CacheClearCommand.php namespace DCSG\Command; use Symfony\Component\Console\Command\Command; class CacheClearCommand extends Command { protected function configure() { $this ->setName('cache:clear') ->setDescription('Clears Application Cache') ->setHelp(<<cache:clear command removes all files inside the cache directory. EOF ); } // ... }

add(new CacheClearCommand()); $app->run(); adding to application

$ php app.php

$ php app.php help cache:clear

add arguments

• ordered • input type: • optional • required • array arguments are:

// Command/CacheClearCommand.php $this->addArgument( 'directory', // name InputArgument::OPTIONAL, // input type 'The cache directory', // description './cache' // default value ); adding an argument

add options

• unordered • input type: • optional • required • array • none (no input) options are:

// CacheClearCommand.php $this->addOption( 'force', // name 'f', // shortname InputOption::VALUE_NONE, // input type 'Forces to clear the cache.' // description ); adding an option

add logic

// Command/CacheClearCommand.php protected function execute( InputInterface $input, OutputInterface $output) { // Logic here } execute the command

// Command/CacheClearCommand.php protected function execute(InputInterface $input, OutputInterface $output) { // Reads the Input $directory = $input->getArgument('directory'); // Removes all files inside the directory $counter = 0; $files = glob($cacheDir . '/*'); foreach ($files as $file) { if (is_file($file)) { unlink($file); $counter++; } } // Writes the Output $output->writeln(sprintf('Cache cleared. Removed %d files.', $counter)); }

always validate the input

// Command/CacheClearCommand.php // Reads the Input $directory = $input->getArgument('directory'); // Validate the argument input if (false === $cacheDir = realpath($directory)) { throw new \InvalidArgumentException('Directory does't exist.'); } // InputOption::VALUE_NONE does not need to be validate // since it does not accept parameters // in this case will return true or false $force = $input->getOption('force');

$ php app.php cache:clear /foo/bar

interact with the user

• Dialog helper • Formatter helper • Progress helper • Table helper

dialog HELPER

// Symfony/Component/Console/Helper/DialogHelper.php public function select(...){...} public function ask(...){...} public function askConfirmation(...){...} public function askHiddenResponse(...){...} public function askAndValidate(...){...} public function askHiddenResponseAndValidate (...){...}

// Command/CacheClearCommand.php // ... // Ask the user if it's the right directory $dialog = $this->getHelperSet()->get('dialog'); $answer = $dialog->askConfirmation( $output, sprintf('Remove all files in: %s ? (no)', $cacheDir), false // default value ); // ... Remove all files in: ./cache ? (no) yes OUTPUT

OUTPUT // examples/Helpers/select.php $colors = array('Red', 'Blue', 'Green', 'Yellow'); // Ask the user the favorite color $dialog = $this->getHelperSet()->get('dialog'); $colorIndex = $dialog->select( $output, 'What color do you like?', $colors ); // Writes the Output $output->writeln( sprintf('The color you like is %s.', $colors[$colorIndex]) );

formatter HELPER

OUTPUT $formatter = $this->getHelperSet()->get('formatter'); $formattedLine = $formatter->formatSection( 'SomeSection', 'Here is some message related to that section' ); $output->writeln($formattedLine); $msg = array('Something went wrong'); $formattedBlock = $formatter->formatBlock($msg, 'error'); $output->writeln($formattedBlock); $msg = array('Custom Colors'); $formattedBlock = $formatter->formatBlock($msg, 'bg=blue;fg=white'); $output->writeln($formattedBlock);

progress helper

05/50 [== ] 10% 25/50 [============= ] 50% 50/50 [============================] 100% $progress = $this->getHelperSet()->get('progress'); $progress->start($output, 50); $i = 0; while ($i++ < 50) { $progress->advance(); } $progress->finish(); OUTPUT

table helper

$table = $this->getHelperSet()->get('table'); $table ->setHeaders(array('Color', 'HEX')) ->setRows( array( array('Red', '#ff0000'), array('Blue', '#0000ff'), array('Green', '#008000'), array('Yellow', '#ffff00') ) ); $table->render($output); OUTPUT

command events

• command - before run • exception - on exceptions • terminate - before return exit code the events

testing Commands

public function testCacheClear() { $application = new Application(); $application->add(new CacheClearCommand()); // Mock the DialogHelper to skip interact // ... $command = $application->find('cache:clear'); // Add Mock to command $commandTester = new CommandTester($command); $commandTester->execute(array( 'command' => 'cache:clear', 'directory' => './cache' )); $this->assertFileNotExists($filename); }

// Symfony/Component/Console/Tester/CommandTester.php class CommandTester { private $command; private $input; private $output; public function __construct(Command $command){..} public function execute(array $input, array $options=array()){..} public function getDisplay($normalize = false){..} public function getInput(){..} public function getOutput(){..} } command tester

$ ./vendor/bin/phpunit

dependency injection in your application

Application Container CacheClearCommand FileSystem Finder Services setContainer(...) getContainer() addCommand() ... Other Commands

namespace Symfony\Component\DependencyInjection; interface ContainerAwareInterface { public function setContainer( ContainerInterface $container = null ); } container aware interface

// DCSG/Application.php class Application extends BaseApplication implements ContainerAwareInterface { private $container; public function setContainer(..){..} public function getContainer(){..} } implement in the application

// DCSG/Command/CacheClearCommand.php // ... $container = $this->getApplication()->getContainer(); $fs = $container->get('filesystem'); $finder = $container->get('finder'); $files = $finder->in($cacheDir); $fs->remove($files); // ... usage in the command

http://goo.gl/h0Xcfe http://symfony.com/doc/current/components/process.html Long running processes resources http://symfony.com/doc/current/components/console/index.html http://symfony.com/doc/current/cookbook/console/index.html http://symfony.com/doc/current/cookbook/service_container/index.html http://symfony.com/doc/current/components/dependency_injection/index.html Symfony2 Docs Cron jobs http://www.cyberciti.biz/faq/how-do-i-add-jobs-to-cron-under-linux-or-unix-oses/ Source Code https://github.com/danielcsgomes/phplx-how-to-build-console-app https://github.com/symfony/Console

@danielcsgomes | me@danielcsgomes.com | http://danielcsgomes.com Photo by Jian Awe © http://www."ickr.com/photos/qqjawe/6511141237 Please give feedback: https://joind.in/9615 Questions?