Upgrade to Pro — share decks privately, control downloads, hide ads and more …

Composer: From Beginner to Expert

Jonathan Klein
September 07, 2014

Composer: From Beginner to Expert

A talk I gave at Northeast PHP 2014. Links from this talk are at jkle.in/composer.

Jonathan Klein

September 07, 2014
Tweet

More Decks by Jonathan Klein

Other Decks in Technology

Transcript

  1. Composer:
    From Beginner to Expert
    Northeast PHP 2014
    Jonathan Klein
    @jonathanklein

    View Slide

  2. jkle.in/composer

    View Slide

  3. View Slide

  4. “The best way to use
    3rd party code”

    View Slide

  5. “…and autoload
    your code”

    View Slide

  6. View Slide

  7. View Slide

  8. View Slide

  9. A Story in Three Acts
    1. Dependency Management

    View Slide

  10. A Story in Three Acts
    1. Dependency Management

    View Slide

  11. A Story in Three Acts
    1. Using 3rd Party Code

    View Slide

  12. A Story in Three Acts
    1. Using 3rd Party Code
    2. Autoloading Your Code

    View Slide

  13. A Story in Three Acts
    1. Using 3rd Party Code
    2. Autoloading Your Code
    3. Publishing Packages

    View Slide

  14. Using 3rd Party Code

    View Slide

  15. Install Composer

    View Slide

  16. curl -sS https://getcomposer.org/installer | php
    !
    mv composer.phar /usr/bin/composer

    View Slide

  17. View Slide

  18. View Slide

  19. View Slide

  20. View Slide

  21. https://www.flickr.com/photos/monkeywobble/2124397478

    View Slide

  22. https://www.flickr.com/photos/adrianblack/3358661327

    View Slide

  23. Three Ways Composer Helps

    View Slide

  24. Three Ways Composer Helps
    1. Simple JSON Config File (composer.json)

    View Slide

  25. Three Ways Composer Helps
    1. Simple JSON Config File (composer.json)
    2. Repository of Code (Packagist)

    View Slide

  26. Three Ways Composer Helps
    1. Simple JSON Config File (composer.json)
    2. Repository of Code (Packagist)
    3. Generated Autoload File (autoload.php)

    View Slide

  27. Simplest JSON Config File
    {
    }

    View Slide

  28. Simplest JSON Config File
    {
    "require": {
    "monolog/monolog": "1.10.*"
    }
    }

    View Slide

  29. Simplest JSON Config File
    {
    "require": {
    "monolog/monolog": "1.10.*"
    }
    } Vendor Name

    View Slide

  30. Simplest JSON Config File
    {
    "require": {
    "monolog/monolog": "1.10.*"
    }
    } Vendor Name Package Name

    View Slide

  31. Simplest JSON Config File
    {
    "require": {
    "monolog/monolog": "1.10.*"
    }
    } Vendor Name Package Name
    Version Number

    View Slide

  32. Composer + Packagist

    View Slide

  33. View Slide

  34. View Slide

  35. View Slide

  36. Simplest JSON Config File
    {
    "require": {
    "monolog/monolog": "1.10.*"
    }
    } Vendor Name Package Name
    Version Number

    View Slide

  37. View Slide

  38. View Slide

  39. View Slide

  40. View Slide

  41. $ composer install

    View Slide

  42. Vendor Directory

    View Slide

  43. View Slide

  44. Vendor Directory

    View Slide

  45. View Slide

  46. View Slide

  47. $ composer install

    View Slide

  48. Using The Code
    require 'vendor/autoload.php';
    !
    $log = new Monolog\Logger('name');
    !
    …snip…
    !
    $log->addWarning('Foo');

    View Slide

  49. Using The Code
    require 'vendor/autoload.php';
    !
    $log = new Monolog\Logger('name');
    !
    …snip…
    !
    $log->addWarning('Foo');
    Generated autoload file

    View Slide

  50. View Slide

  51. View Slide

  52. View Slide

  53. {
    "require": {
    "monolog/monolog": "1.10.*",
    "filp/whoops": "1.*",
    "respect/validation": "0.5.*",
    "swiftmailer/swiftmailer": "5.0.*"
    }
    }
    composer.json

    View Slide

  54. $ composer update

    View Slide

  55. composer require filp/whoops:1.*
    composer require respect/validation:0.5.*
    composer require swiftmailer/swiftmailer:5.0.*

    View Slide

  56. Using The Code
    !
    require 'vendor/autoload.php';
    !
    use Respect\Validation\Validator as v;
    !
    $log = new Monolog\Logger('name');
    $whoops = new \Whoops\Run;
    Swift::init('swiftmailer_configurator');
    !
    $number = 123;
    v::numeric()->validate($number);

    View Slide

  57. Using The Code
    !
    require 'vendor/autoload.php';
    !
    use Respect\Validation\Validator as v;
    !
    $log = new Monolog\Logger('name');
    $whoops = new \Whoops\Run;
    Swift::init('swiftmailer_configurator');
    !
    $number = 123;
    v::numeric()->validate($number);

    View Slide

  58. Using The Code
    !
    require 'vendor/autoload.php';
    !
    use Respect\Validation\Validator as v;
    !
    $log = new Monolog\Logger('name');
    $whoops = new \Whoops\Run;
    Swift::init('swiftmailer_configurator');
    !
    $number = 123;
    v::numeric()->validate($number);

    View Slide

  59. Versioning

    View Slide

  60. {
    "require": {
    "monolog/monolog": "1.10.*",
    "filp/whoops": "1.*",
    "respect/validation": "0.5.*",
    "swiftmailer/swiftmailer": "5.0.*"
    }
    }

    View Slide

  61. composer.lock

    View Slide

  62. composer.lock
    Commit this

    View Slide

  63. View Slide

  64. $ composer update

    View Slide

  65. View Slide

  66. View Slide

  67. vendor/autoload.php
    is regenerated

    View Slide

  68. vendor/autoload.php
    should be the only include
    in your application

    View Slide

  69. “What about MY Code?”

    View Slide

  70. Autoloading Your Code

    View Slide

  71. {
    "require": {
    "monolog/monolog": "1.10.*"
    },
    !
    "autoload": {
    "psr-4": {"Acme\\": "src/"}
    }
    }

    View Slide

  72. {
    "require": {
    "monolog/monolog": "1.10.*"
    },
    !
    "autoload": {
    "psr-4": {"Acme\\": "src/"}
    }
    }
    WTF?

    View Slide

  73. PSR: PHP Specification Request

    View Slide

  74. View Slide

  75. Approved Standards
    PSR-0 Autoloading
    PSR-1 Basic Coding Standard
    PSR-2 Coding Style Guide
    PSR-3 Logger Interface
    PSR-4 Improved Autoloading

    View Slide

  76. Approved Standards
    PSR-0 Autoloading
    PSR-1 Basic Coding Standard
    PSR-2 Coding Style Guide
    PSR-3 Logger Interface
    PSR-4 Improved Autoloading

    View Slide

  77. Approved Standards
    PSR-0 Autoloading
    PSR-1 Basic Coding Standard
    PSR-2 Coding Style Guide
    PSR-3 Logger Interface
    PSR-4 Improved Autoloading

    View Slide

  78. What Improved?

    View Slide

  79. What Improved?
    1. Underscores no longer
    designate directories

    View Slide

  80. What Improved?
    1. Underscores no longer
    designate directories
    2. Namespaces can map to
    arbitrary folders

    View Slide

  81. View Slide

  82. View Slide

  83. View Slide

  84. {
    "require": {
    "monolog/monolog": "1.10.*"
    },
    !
    "autoload": {
    "psr-4": {
    "Acme\\": "src/"
    }
    }
    }

    View Slide

  85. {
    "require": {
    "monolog/monolog": "1.10.*"
    },
    !
    "autoload": {
    "psr-4": {
    "Acme\\": ["src/", "tests/"]
    }
    }
    }

    View Slide

  86. View Slide

  87. Takeaway: Use PSR-4

    View Slide

  88. Autoloading code
    !
    require 'vendor/autoload.php';
    !
    $foo = new \Acme\Foo\Bar\Baz();
    // src/Foo/Bar/Baz.php

    View Slide

  89. {
    "require": {
    "monolog/monolog": "1.10.*"
    },
    !
    "autoload": {
    "psr-4": {"Acme\\": "src/Foo/Bar/"}
    }
    }

    View Slide

  90. Autoloading code
    !
    require 'vendor/autoload.php';
    !
    $foo = new \Acme\Baz();
    // src/Foo/Bar/Baz.php

    View Slide

  91. !
    namespace Acme;
    !
    class Baz{
    !
    function __construct() {
    echo "Hello, World";
    }
    }

    View Slide

  92. {
    "require": {
    "monolog/monolog": "1.10.*"
    },
    !
    "autoload": {
    "psr-4": {
    "Acme\\": "src/",
    "Vendor\\Namespace\\": ""
    }
    }
    }

    View Slide

  93. “What About Functions?”

    View Slide

  94. {
    "require": {
    "monolog/monolog": "1.10.*"
    },
    !
    "autoload": {
    "psr-4": {"Acme\\": "src/"},
    "files": ["src/functions.php"]
    }
    }

    View Slide

  95. View Slide

  96. View Slide

  97. Publishing Packages

    View Slide

  98. {
    "require": {
    "monolog/monolog": "1.10.*"
    },
    !
    "autoload": {
    "psr-4": {"Acme\\": "src/Foo/Bar/"}
    }
    }

    View Slide

  99. {
    "name": "acme/hello",
    "description": "Prints Hello, World",
    "require": {
    "monolog/monolog": "1.10.*"
    },
    !
    "autoload": {
    "psr-4": {"Acme\\": "src/Foo/Bar/"}
    }
    }

    View Slide

  100. View Slide

  101. View Slide

  102. View Slide

  103. Private Repository
    with Satis

    View Slide

  104. Bonus: Advanced Usage

    View Slide

  105. {
    "require": {
    "monolog/monolog": "1.10.*"
    },
    !
    "require-dev": {
    "phpunit/phpunit": "3.7.*",
    "mockery/mockery": "0.7.*"
    }
    }

    View Slide

  106. {
    "scripts": {
    "post-update-cmd": "MyVendor\\MyClass::postUpdate",
    "post-package-install": [
    "MyVendor\\MyClass::postPackageInstall"
    ],
    "post-install-cmd": [
    "MyVendor\\MyClass::warmCache",
    "phpunit -c app/"
    ]
    }
    }

    View Slide

  107. {
    "scripts": {
    "post-update-cmd": "MyVendor\\MyClass::postUpdate",
    "post-package-install": [
    "MyVendor\\MyClass::postPackageInstall"
    ],
    "post-install-cmd": [
    "MyVendor\\MyClass::warmCache",
    "phpunit -c app/"
    ]
    }
    }

    View Slide

  108. {
    "scripts": {
    "post-update-cmd": "MyVendor\\MyClass::postUpdate",
    "post-package-install": [
    "MyVendor\\MyClass::postPackageInstall"
    ],
    "post-install-cmd": [
    "MyVendor\\MyClass::warmCache",
    "phpunit -c app/"
    ]
    }
    }

    View Slide

  109. Other Useful Commands

    View Slide

  110. Other Useful Commands
    composer init

    View Slide

  111. Other Useful Commands
    composer init
    composer remove

    View Slide

  112. Other Useful Commands
    composer init
    composer remove
    composer validate

    View Slide

  113. Other Useful Commands
    composer init
    composer remove
    composer validate
    composer self-update

    View Slide

  114. Other Useful Commands
    composer init
    composer remove
    composer validate
    composer self-update
    composer diagnose

    View Slide

  115. Other Useful Commands
    composer init
    composer remove
    composer validate
    composer self-update
    composer diagnose
    composer status

    View Slide

  116. Wrap Up

    View Slide

  117. Wrap Up
    • Include 3rd Party Code

    View Slide

  118. Wrap Up
    • Include 3rd Party Code
    • Autoload Your Own Code

    View Slide

  119. Wrap Up
    • Include 3rd Party Code
    • Autoload Your Own Code
    • Publish Packages

    View Slide

  120. Thanks!

    View Slide

  121. !
    jkle.in/composer
    !
    @jonathanklein
    [email protected]
    www.etsy.com/careers

    View Slide