Composer

Composer is a tool for managing dependencies in PHP projects. This talk will introduce Composer and its associated package repository Packagist. The key features and benefits of using Composer will be explored and through practical demonstrations you will gain a working knowledge of using Composer for dependency management.

Transcript

1. Tom Corrigan rostercloud.com @t_corrigan Melbourne PHP Users Group October 2012 Tuesday, 16 October 12
2. What is Composer? “Composer is a tool for dependency management. It allows you to declare the dependent libraries your project needs and it will install them in your project for you.” [http://getcomposer.org/doc/00-intro.md] Tuesday, 16 October 12
3. What does that mean? Tuesday, 16 October 12
4. What does that mean? • Scope is per project, not global Tuesday, 16 October 12
5. What does that mean? • Scope is per project, not global • Resolves dependencies Tuesday, 16 October 12
6. What does that mean? • Scope is per project, not global • Resolves dependencies • Runs installation tasks Tuesday, 16 October 12
7. Who’s using Composer? Tuesday, 16 October 12
8. Packagist Tuesday, 16 October 12
9. Packagist Tuesday, 16 October 12
10. Packagist • Composer’s default repository Tuesday, 16 October 12
11. Packagist • Composer’s default repository • Put your open source libraries here Tuesday, 16 October 12
12. Packagist • Composer’s default repository • Put your open source libraries here • Great resource for well maintained PHP libraries Tuesday, 16 October 12
13. Statistics [https://packagist.org/statistics] Tuesday, 16 October 12
14. Statistics • Over 4000 packages listed on packagist.org [https://packagist.org/statistics] Tuesday, 16 October 12
15. Statistics • Over 4000 packages listed on packagist.org • More than 4,500,000 package installations over the last 6 months [https://packagist.org/statistics] Tuesday, 16 October 12
16. Installing Composer Tuesday, 16 October 12
17. Installing Composer Locally: Tuesday, 16 October 12
18. Installing Composer Locally: $ cd /project/path $ curl -s https://getcomposer.org/installer | php Tuesday, 16 October 12
19. Installing Composer Locally: $ cd /project/path $ curl -s https://getcomposer.org/installer | php Globally: Tuesday, 16 October 12
20. Installing Composer Locally: $ cd /project/path $ curl -s https://getcomposer.org/installer | php Globally: $ sudo mv composer.phar /usr/local/bin/composer Tuesday, 16 October 12
21. Staying current Tuesday, 16 October 12
22. Staying current Locally: Tuesday, 16 October 12
23. Staying current Locally: $ cd /project/path $ php composer.phar self-update Tuesday, 16 October 12
24. Staying current Locally: $ cd /project/path $ php composer.phar self-update Globally: Tuesday, 16 October 12
25. Staying current Locally: $ cd /project/path $ php composer.phar self-update Globally: $ composer self-update Tuesday, 16 October 12
26. Using Composer Tuesday, 16 October 12
27. Using Composer • Define project dependencies Tuesday, 16 October 12
28. Using Composer • Define project dependencies • Install them Tuesday, 16 October 12
29. Using Composer • Define project dependencies • Install them • Bootstrap the autoloader Tuesday, 16 October 12
30. Define your dependencies Tuesday, 16 October 12
31. Define your dependencies composer.json Tuesday, 16 October 12
32. Define your dependencies composer.json { "require": { "phpmelb/project1": "1.0.2" "phpmelb/project2": "1.0.*" "phpmelb/project3": ">=1.0,<2.0" "phpmelb/project4": "4d3fe5feaf" "phpmelb/project5": "dev-master" } } Tuesday, 16 October 12
33. Install Tuesday, 16 October 12
34. Install $ composer install Tuesday, 16 October 12
35. Install $ composer install vendor/ .composer/ phpmelb/ project1/ project2/ project3/ project4/ autoload.php Tuesday, 16 October 12
36. Using the autoloader <?php require 'vendor/autoload.php'; $foo = new PHPMelb\Project1\Foo(); $bar = new PHPMelb_Project2_Bar(); ... Tuesday, 16 October 12
37. Tuesday, 16 October 12
38. { "name": "symfony/framework-standard-edition", "description": "The \"Symfony Standard Edition\" distribution", Tuesday, 16 October 12
39. { "name": "symfony/framework-standard-edition", "description": "The \"Symfony Standard Edition\" distribution", "autoload": { "psr-0": { "": "src/" } }, Tuesday, 16 October 12
40. { "name": "symfony/framework-standard-edition", "description": "The \"Symfony Standard Edition\" distribution", "autoload": { "psr-0": { "": "src/" } }, Tuesday, 16 October 12
41. { "name": "symfony/framework-standard-edition", "description": "The \"Symfony Standard Edition\" distribution", "autoload": { "psr-0": { "": "src/" } }, "require": { "php": ">=5.3.3", "symfony/symfony": "2.1.*", "doctrine/orm": ">=2.2.3,<2.4-dev", "doctrine/doctrine-bundle": "1.0.*", "twig/extensions": "1.0.*", "symfony/assetic-bundle": "2.1.*", "symfony/swiftmailer-bundle": "2.1.*", "symfony/monolog-bundle": "2.1.*", "sensio/distribution-bundle": "2.1.*", "sensio/framework-extra-bundle": "2.1.*", "sensio/generator-bundle": "2.1.*", "jms/security-extra-bundle": "1.2.*", "jms/di-extra-bundle": "1.1.*" }, Tuesday, 16 October 12
42. { "name": "symfony/framework-standard-edition", "description": "The \"Symfony Standard Edition\" distribution", "autoload": { "psr-0": { "": "src/" } }, "require": { "php": ">=5.3.3", "symfony/symfony": "2.1.*", "doctrine/orm": ">=2.2.3,<2.4-dev", "doctrine/doctrine-bundle": "1.0.*", "twig/extensions": "1.0.*", "symfony/assetic-bundle": "2.1.*", "symfony/swiftmailer-bundle": "2.1.*", "symfony/monolog-bundle": "2.1.*", "sensio/distribution-bundle": "2.1.*", "sensio/framework-extra-bundle": "2.1.*", "sensio/generator-bundle": "2.1.*", "jms/security-extra-bundle": "1.2.*", "jms/di-extra-bundle": "1.1.*" }, "scripts": { "post-install-cmd": [ "Sensio\\Bundle\\DistributionBundle\\Composer\\ScriptHandler::buildBootstrap", "Sensio\\Bundle\\DistributionBundle\\Composer\\ScriptHandler::clearCache", "Sensio\\Bundle\\DistributionBundle\\Composer\\ScriptHandler::installAssets", "Sensio\\Bundle\\DistributionBundle\\Composer\\ScriptHandler::installRequirementsFile" ], "post-update-cmd": [ "Sensio\\Bundle\\DistributionBundle\\Composer\\ScriptHandler::buildBootstrap", "Sensio\\Bundle\\DistributionBundle\\Composer\\ScriptHandler::clearCache", "Sensio\\Bundle\\DistributionBundle\\Composer\\ScriptHandler::installAssets", "Sensio\\Bundle\\DistributionBundle\\Composer\\ScriptHandler::installRequirementsFile" ] }, Tuesday, 16 October 12
43. { "name": "symfony/framework-standard-edition", "description": "The \"Symfony Standard Edition\" distribution", "autoload": { "psr-0": { "": "src/" } }, "require": { "php": ">=5.3.3", "symfony/symfony": "2.1.*", "doctrine/orm": ">=2.2.3,<2.4-dev", "doctrine/doctrine-bundle": "1.0.*", "twig/extensions": "1.0.*", "symfony/assetic-bundle": "2.1.*", "symfony/swiftmailer-bundle": "2.1.*", "symfony/monolog-bundle": "2.1.*", "sensio/distribution-bundle": "2.1.*", "sensio/framework-extra-bundle": "2.1.*", "sensio/generator-bundle": "2.1.*", "jms/security-extra-bundle": "1.2.*", "jms/di-extra-bundle": "1.1.*" }, "scripts": { "post-install-cmd": [ "Sensio\\Bundle\\DistributionBundle\\Composer\\ScriptHandler::buildBootstrap", "Sensio\\Bundle\\DistributionBundle\\Composer\\ScriptHandler::clearCache", "Sensio\\Bundle\\DistributionBundle\\Composer\\ScriptHandler::installAssets", "Sensio\\Bundle\\DistributionBundle\\Composer\\ScriptHandler::installRequirementsFile" ], "post-update-cmd": [ "Sensio\\Bundle\\DistributionBundle\\Composer\\ScriptHandler::buildBootstrap", "Sensio\\Bundle\\DistributionBundle\\Composer\\ScriptHandler::clearCache", "Sensio\\Bundle\\DistributionBundle\\Composer\\ScriptHandler::installAssets", "Sensio\\Bundle\\DistributionBundle\\Composer\\ScriptHandler::installRequirementsFile" ] }, "config": { "bin-dir": "bin" }, Tuesday, 16 October 12
44. { "name": "symfony/framework-standard-edition", "description": "The \"Symfony Standard Edition\" distribution", "autoload": { "psr-0": { "": "src/" } }, "require": { "php": ">=5.3.3", "symfony/symfony": "2.1.*", "doctrine/orm": ">=2.2.3,<2.4-dev", "doctrine/doctrine-bundle": "1.0.*", "twig/extensions": "1.0.*", "symfony/assetic-bundle": "2.1.*", "symfony/swiftmailer-bundle": "2.1.*", "symfony/monolog-bundle": "2.1.*", "sensio/distribution-bundle": "2.1.*", "sensio/framework-extra-bundle": "2.1.*", "sensio/generator-bundle": "2.1.*", "jms/security-extra-bundle": "1.2.*", "jms/di-extra-bundle": "1.1.*" }, "scripts": { "post-install-cmd": [ "Sensio\\Bundle\\DistributionBundle\\Composer\\ScriptHandler::buildBootstrap", "Sensio\\Bundle\\DistributionBundle\\Composer\\ScriptHandler::clearCache", "Sensio\\Bundle\\DistributionBundle\\Composer\\ScriptHandler::installAssets", "Sensio\\Bundle\\DistributionBundle\\Composer\\ScriptHandler::installRequirementsFile" ], "post-update-cmd": [ "Sensio\\Bundle\\DistributionBundle\\Composer\\ScriptHandler::buildBootstrap", "Sensio\\Bundle\\DistributionBundle\\Composer\\ScriptHandler::clearCache", "Sensio\\Bundle\\DistributionBundle\\Composer\\ScriptHandler::installAssets", "Sensio\\Bundle\\DistributionBundle\\Composer\\ScriptHandler::installRequirementsFile" ] }, "config": { "bin-dir": "bin" }, "minimum-stability": "dev", Tuesday, 16 October 12
45. { "name": "symfony/framework-standard-edition", "description": "The \"Symfony Standard Edition\" distribution", "autoload": { "psr-0": { "": "src/" } }, "require": { "php": ">=5.3.3", "symfony/symfony": "2.1.*", "doctrine/orm": ">=2.2.3,<2.4-dev", "doctrine/doctrine-bundle": "1.0.*", "twig/extensions": "1.0.*", "symfony/assetic-bundle": "2.1.*", "symfony/swiftmailer-bundle": "2.1.*", "symfony/monolog-bundle": "2.1.*", "sensio/distribution-bundle": "2.1.*", "sensio/framework-extra-bundle": "2.1.*", "sensio/generator-bundle": "2.1.*", "jms/security-extra-bundle": "1.2.*", "jms/di-extra-bundle": "1.1.*" }, "scripts": { "post-install-cmd": [ "Sensio\\Bundle\\DistributionBundle\\Composer\\ScriptHandler::buildBootstrap", "Sensio\\Bundle\\DistributionBundle\\Composer\\ScriptHandler::clearCache", "Sensio\\Bundle\\DistributionBundle\\Composer\\ScriptHandler::installAssets", "Sensio\\Bundle\\DistributionBundle\\Composer\\ScriptHandler::installRequirementsFile" ], "post-update-cmd": [ "Sensio\\Bundle\\DistributionBundle\\Composer\\ScriptHandler::buildBootstrap", "Sensio\\Bundle\\DistributionBundle\\Composer\\ScriptHandler::clearCache", "Sensio\\Bundle\\DistributionBundle\\Composer\\ScriptHandler::installAssets", "Sensio\\Bundle\\DistributionBundle\\Composer\\ScriptHandler::installRequirementsFile" ] }, "config": { "bin-dir": "bin" }, "minimum-stability": "dev", Tuesday, 16 October 12
46. { "name": "symfony/framework-standard-edition", "description": "The \"Symfony Standard Edition\" distribution", "autoload": { "psr-0": { "": "src/" } }, "require": { "php": ">=5.3.3", "symfony/symfony": "2.1.*", "doctrine/orm": ">=2.2.3,<2.4-dev", "doctrine/doctrine-bundle": "1.0.*", "twig/extensions": "1.0.*", "symfony/assetic-bundle": "2.1.*", "symfony/swiftmailer-bundle": "2.1.*", "symfony/monolog-bundle": "2.1.*", "sensio/distribution-bundle": "2.1.*", "sensio/framework-extra-bundle": "2.1.*", "sensio/generator-bundle": "2.1.*", "jms/security-extra-bundle": "1.2.*", "jms/di-extra-bundle": "1.1.*" }, "scripts": { "post-install-cmd": [ "Sensio\\Bundle\\DistributionBundle\\Composer\\ScriptHandler::buildBootstrap", "Sensio\\Bundle\\DistributionBundle\\Composer\\ScriptHandler::clearCache", "Sensio\\Bundle\\DistributionBundle\\Composer\\ScriptHandler::installAssets", "Sensio\\Bundle\\DistributionBundle\\Composer\\ScriptHandler::installRequirementsFile" ], "post-update-cmd": [ "Sensio\\Bundle\\DistributionBundle\\Composer\\ScriptHandler::buildBootstrap", "Sensio\\Bundle\\DistributionBundle\\Composer\\ScriptHandler::clearCache", "Sensio\\Bundle\\DistributionBundle\\Composer\\ScriptHandler::installAssets", "Sensio\\Bundle\\DistributionBundle\\Composer\\ScriptHandler::installRequirementsFile" ] }, "config": { "bin-dir": "bin" }, "minimum-stability": "dev", "extra": { "symfony-app-dir": "app", "symfony-web-dir": "web" } } Tuesday, 16 October 12
47. Composer: Killer Features Tuesday, 16 October 12
48. Composer: Killer Features • composer.lock Tuesday, 16 October 12
49. Composer: Killer Features • composer.lock • Satis - Your private repository Tuesday, 16 October 12
50. Composer: Killer Features • composer.lock • Satis - Your private repository • composer installers Tuesday, 16 October 12
51. Composer: Killer Features • composer.lock • Satis - Your private repository • composer installers • Get started with a new framework project directly from composer Tuesday, 16 October 12
52. composer.lock Tuesday, 16 October 12
53. composer.lock • Used when you call composer install Tuesday, 16 October 12
54. composer.lock • Used when you call composer install • Updated by composer update Tuesday, 16 October 12
55. composer.lock • Used when you call composer install • Updated by composer update • Everybody runs the exact same version of dependencies Tuesday, 16 October 12
56. Satis Tuesday, 16 October 12
57. Satis • Your very own packagist for your proprietary code Tuesday, 16 October 12
58. Satis • Your very own packagist for your proprietary code • Eases deployment Tuesday, 16 October 12
59. Satis • Your very own packagist for your proprietary code • Eases deployment • Composer will connect to it securely Tuesday, 16 October 12
60. Satis • Your very own packagist for your proprietary code • Eases deployment • Composer will connect to it securely • HTTPS -Public key Tuesday, 16 October 12
61. Satis • Your very own packagist for your proprietary code • Eases deployment • Composer will connect to it securely • HTTPS -Public key • SSH Tuesday, 16 October 12
62. Satis • Your very own packagist for your proprietary code • Eases deployment • Composer will connect to it securely • HTTPS -Public key • SSH • See https://github.com/composer/satis Tuesday, 16 October 12
63. Composer Installers •CakePHP •cakephp-plugin •CodeIgniter •codeigniter-library •codeigniter-third-party •codeigniter-module •Drupal •drupal-module •drupal-theme •drupal-profile •drupal-drush •FuelPHP •fuelphp-module •Joomla •joomla-component •joomla-module •joomla-template •joomla-plugin •joomla-library •Kohana •kohana-module •Laravel •laravel-library •Lithium •lithium-library •lithium-source •Magento •magento-library •magento-skin •magento-theme •Mako •mako-package •MediaWiki •mediawiki-extension •phpBB •phpbb-extension •PPI •ppi-module •SilverStripe •silverstripe-module •silverstripe-theme •symfony1 •symfony1-plugin •WordPress •wordpress-plugin •wordpress-theme •Zend •zend-library •zend-extra Tuesday, 16 October 12
64. Composer Installers • Bring the power and ease of Composer to your framework/CMS •CakePHP •cakephp-plugin •CodeIgniter •codeigniter-library •codeigniter-third-party •codeigniter-module •Drupal •drupal-module •drupal-theme •drupal-profile •drupal-drush •FuelPHP •fuelphp-module •Joomla •joomla-component •joomla-module •joomla-template •joomla-plugin •joomla-library •Kohana •kohana-module •Laravel •laravel-library •Lithium •lithium-library •lithium-source •Magento •magento-library •magento-skin •magento-theme •Mako •mako-package •MediaWiki •mediawiki-extension •phpBB •phpbb-extension •PPI •ppi-module •SilverStripe •silverstripe-module •silverstripe-theme •symfony1 •symfony1-plugin •WordPress •wordpress-plugin •wordpress-theme •Zend •zend-library •zend-extra Tuesday, 16 October 12
65. Composer Installers • Bring the power and ease of Composer to your framework/CMS • Magically installs packages/ plugins to the correct location for framework •CakePHP •cakephp-plugin •CodeIgniter •codeigniter-library •codeigniter-third-party •codeigniter-module •Drupal •drupal-module •drupal-theme •drupal-profile •drupal-drush •FuelPHP •fuelphp-module •Joomla •joomla-component •joomla-module •joomla-template •joomla-plugin •joomla-library •Kohana •kohana-module •Laravel •laravel-library •Lithium •lithium-library •lithium-source •Magento •magento-library •magento-skin •magento-theme •Mako •mako-package •MediaWiki •mediawiki-extension •phpBB •phpbb-extension •PPI •ppi-module •SilverStripe •silverstripe-module •silverstripe-theme •symfony1 •symfony1-plugin •WordPress •wordpress-plugin •wordpress-theme •Zend •zend-library •zend-extra Tuesday, 16 October 12
66. Composer Installers • Bring the power and ease of Composer to your framework/CMS • Magically installs packages/ plugins to the correct location for framework • See https://github.com/ composer/installers •CakePHP •cakephp-plugin •CodeIgniter •codeigniter-library •codeigniter-third-party •codeigniter-module •Drupal •drupal-module •drupal-theme •drupal-profile •drupal-drush •FuelPHP •fuelphp-module •Joomla •joomla-component •joomla-module •joomla-template •joomla-plugin •joomla-library •Kohana •kohana-module •Laravel •laravel-library •Lithium •lithium-library •lithium-source •Magento •magento-library •magento-skin •magento-theme •Mako •mako-package •MediaWiki •mediawiki-extension •phpBB •phpbb-extension •PPI •ppi-module •SilverStripe •silverstripe-module •silverstripe-theme •symfony1 •symfony1-plugin •WordPress •wordpress-plugin •wordpress-theme •Zend •zend-library •zend-extra Tuesday, 16 October 12
67. Setup a new project • Symfony2 composer create-project symfony/framework-standard-edition path/to/install • Zend Framework 2 composer create-project --repository-url="http:// packages.zendframework.com" zendframework/skeleton-application path/to/ install Tuesday, 16 October 12
68. ? Tuesday, 16 October 12
69. Thankyou Further Reading: http://getcomposer.org http://packagist.org http://symfony.com/video/26/in-depth-with-composer/English Slides available at https://speakerdeck.com/u/tommygnr Tuesday, 16 October 12