Managing Dependencies with Composer (Lone Star PHP 2014)

Traditionally, managing third-party code in PHP projects has not been a trivial task. Fortunately, the PHP community now has Composer, a top-notch dependency manager. Learn what Composer is and how you can put it to work for fun and profit. You will see how to set up a new project, find packages, as well as how to create and distribute your own packages.

Transcript

1. Managing Dependencies with Composer Lone Star PHP April 26th, 2014
2. Beau Simensen @beausimensen +BeauSimensen beau.io
3. Dragonfly Development @dflydev dflydev.com
4. boogio.com @wearboogio reflxlabsinc.com @reflxlabs
6. Dependency Management
7. composer.json
8. { “name”: “acme/my-project”, “description”: “Acme’s My Project”, “license”: “MIT”, “require”: { “silex/silex”: “1.1.*” }, “autoload”: { “psr-4”: { “Acme\\MyProject\\”: “src” } } }
9. { “name”: “acme/my-project”, “description”: “Acme’s My Project”, “license”: “MIT”, “require”: { “silex/silex”: “1.1.*” }, “autoload”: { “psr-4”: { “Acme\\MyProject\\”: “src” } } }
10. vendor-name/project-name A package's name cannot change and must be all lowercase
11. { “name”: “acme/my-project”, “description”: “Acme’s My Project”, “license”: “MIT”, “require”: { “silex/silex”: “1.1.*” }, “autoload”: { “psr-4”: { “Acme\\MyProject\\”: “src” } } }
12. { “name”: “acme/my-project”, “description”: “Acme’s My Project”, “license”: “MIT”, “require”: { “silex/silex”: “1.1.*” }, “autoload”: { “psr-4”: { “Acme\\MyProject\\”: “src” } } }
13. $ composer install Loading composer repositories with package information Installing dependencies (including require-dev) - Installing psr/log (1.0.0) - Installing symfony/routing (v2.3.7) - Installing symfony/debug (v2.3.7) - Installing symfony/http-foundation (v2.3.7) - Installing symfony/event-dispatcher (v2.3.7) - Installing symfony/http-kernel (v2.3.7) - Installing pimple/pimple (v1.1.0) - Installing silex/silex (v1.1.2) Writing lock file Generating autoload files $
14. The packages are installed into a directory named vendor
15. vendor =
16. require “vendor/autoload.php”;
17. { “name”: “acme/my-project”, “description”: “Acme’s My Project”, “license”: “MIT”, “require”: { “silex/silex”: “1.1.*” }, “autoload”: { “psr-4”: { “Acme\\MyProject\\”: “src” } } }
18. Autoloading
19. # Acme\User is not defined ! $user = new Acme\User(); ! # Acme\User is defined
20. Magic! since 5
21. function ($class) { if ($class === "Acme\\Account\\User") { // do something to cause this class // to become defined require __DIR__."/src/user.inc"; } }
22. Composer is a configurable autoloader
23. Each Composer package gets to configure its own rules
24. psr-0
25. PHP-FIG PHP Framework Interoperability Group php-fig.com
26. Namespaces are directories
27. Classes are files with .php suffix
28. Acme\Account\User
29. Acme/Account/User.php
30. PSR-0 also supports legacy PEAR style naming conventions
31. Acme\Account\User ! Acme_Account_User
32. Acme/Account/User.php ! Acme/Account/User.php
33. { "autoload": { "psr-0": { "Acme\\Account\\": "src" } } } ! new Acme\Account\User(); ! # src/Acme/Account/User.php
34. { "autoload": { "psr-0": { "Acme_Account_": "src" } } } ! new Acme_Account_User(); ! # src/Acme/Account/User.php
35. psr-4
36. PHP-FIG PHP Framework Interoperability Group php-fig.com
37. Composer currently recommends new projects use PSR-4
38. Very similar to PSR-0
39. Only supports namespaces (this means no PEAR style naming)
40. Requires a namespace prefix and base directory for mapping
41. Acme\Account\User (class) ! Acme\Account (namespace prefix) ! src (base directory) ! src/User.php (resulting file path)
42. { "autoload": { "psr-4": { "Acme\\Account\\": "src" } } } ! new Acme\Account\User(); ! # src/User.php
43. files
44. Explicitly include specific files
45. { “autoload”: { “files”: [ “src/foo.class.php”, “src/bar.class.php” ] } }
46. { “autoload”: { “files”: [“src/functions.php”] } }
47. { “autoload”: { “files”: [“src/autoload.php”] } }
48. The files autoloader is really an alwaysloader
49. classmap
50. A key => value map of class names to files on disk
51. { “autoload”: { “classmap”: [ “src/includes/”, “resources/config.php” ] } }
52. It will look inside .php and .inc files to find classes
53. The classmap is generated anytime Composer dumps its autoloader
54. Extremely fast and powerful but not very developer friendly
55. { “name”: “acme/my-project”, “description”: “Acme’s My Project”, “license”: “MIT”, “require”: { “silex/silex”: “1.1.*” }, “autoload”: { “psr-4”: { “Acme\\MyProject\\”: “src” } } }
56. { “name”: “acme/my-project”, “description”: “Acme’s My Project”, “license”: “MIT”, “require”: { “silex/silex”: “1.1.*” }, “autoload”: { “psr-4”: { “Acme\\MyProject\\”: “src” } } }
57. Versioning
58. If you want to leverage Composer to its fullest use Semantic Versioning
59. semver.org
60. MAJOR.MINOR.PATCH Which number do you increment and why?
61. MAJOR.MINOR.PATCH When you break backwards compatibility
62. MAJOR.MINOR.PATCH When you add backwards compatible features
63. MAJOR.MINOR.PATCH When you make backwards compatible bug fixes
64. Semantic Versioning lets you know what you're getting into
65. Safe 1.3.* Only get bug fixes
66. Reasonably Safe 1.* Get bug fixes and new features
67. Crazy Sauce * Composer allows this, but don't. Just don't.
68. Versions from Tags
69. 2.0.1 2.0.1 (2.0.*)
70. v2.0.1 2.0.1 (2.0.*)
71. 2.0.1-RC1 2.0.1-RC1 (2.0.*@RC)
72. 3.4-cuddly-cat 3.4-cuddly-cat (3.4-cuddly-cat)
73. 2.0.1g 2.0.1g (2.0.1g)
74. Versions from Branches
75. 2.0 2.0.x-dev (2.0.*@dev)
76. Named branches default to their name with a dev- prefix
77. master dev-master (dev-master)
78. 2.0-experimental dev-2.0-experimental (2.0.*@dev won't work!)
79. Named branches can be aliased to be semver friendly
80. { “extra”: { “branch-alias”: { “dev-master”: “2.0.x-dev” } } }
81. master dev-master / 2.0.x-dev (dev-master or 2.0.*@dev)
82. Basic Usage
83. Install Composer getcomposer.org/download
84. $ curl -sS https://getcomposer.org/installer | php $ php composer.phar --version WARNING Security people think this is bad (but it is all the rage)
85. $ chmod 755 composer.phar $ mv composer.phar ~/bin/composer $ composer --version
86. composer.json and composer.lock
87. composer.json describes a package and its dependencies
88. { “name”: “acme/my-project”, “description”: “Acme’s My Project”, “license”: “MIT”, “require”: { “silex/silex”: “1.1.*” }, “autoload”: { “psr-4”: { “Acme\\MyProject\\”: “src” } } }
89. composer.lock describes exactly what should be installed
90. $ composer install Loading composer repositories with package information Installing dependencies (including require-dev) - Installing psr/log (1.0.0) - Installing symfony/routing (v2.3.7) - Installing symfony/debug (v2.3.7) - Installing symfony/http-foundation (v2.3.7) - Installing symfony/event-dispatcher (v2.3.7) - Installing symfony/http-kernel (v2.3.7) - Installing pimple/pimple (v1.1.0) - Installing silex/silex (v1.1.2) Writing lock file Generating autoload files $
91. Check your composer.lock into your repository
92. Common Commands
93. $ composer install If composer.lock exists, install exactly what is in the lock file. ! Otherwise, read composer.json to find out what should be installed, install the dependencies, and write out composer.lock.
94. $ composer update Installs dependencies from composer.json and creates or updates composer.lock.
95. $ composer require [pkg] Add a package to composer.json. ! The [pkg] is the name with a version constraint. ! foo/bar:1.0.0 or foo/bar=1.0.0 or "foo/bar 1.0.0"
96. $ composer diag Check environment and composer.json for common errors
97. $ composer validate Check composer.json for common errors
98. Publishing and Discovery
99. packagist.org
100. Over 25,800 packages
101. Publishing is as easy as pasting your repository's GitHub URL
102. Check Packagist before you start a new library from scratch
103. Choose an autoloading strategy
104. Choose PSR-4 for new projects
105. Use Semantic Versioning
106. Use Packagist
107. #composer look for simensen and say "hi" freenode IRC
108. Questions? @beausimensen +BeauSimensen ddd.io/lsp14-composer joind.in
109. Migrating from PSR-0 to PSR-4
110. { "autoload": { "psr-0": { "Acme\\Account\\": "src" } } } ! new Acme\Account\User(); ! # src/Acme/Account/User.php
111. { "autoload": { "psr-4": { "Acme\\Account\\": "src/Acme/Account" } } } ! new Acme\Account\User(); ! # src/Acme/Account/User.php
112. Stability and the Root Package
113. A package is the root package while it is being developed
114. The root package is defined in the working composer.json
115. Stability is controlled by the root package
116. { “require”: { “silex/silex”: “~1.1@dev”, “symfony/http-foundation”: “@beta” }, “minimum-stability”: “alpha” }