The Wonderful World of Composer and ZF2

The Wonderful World of
Composer & ZF2
by your friend:
Ryan Weaver
@weaverryan
Thursday, October 25, 12

View Slide

Who is this dude?
• The Symfony “Docs” guy
• KnpLabs US - Symfony & Behat consulting,
training, and Kumbaya
• Writer for KnpUniversity.com
screencasts
• Husband of the much more
talented @leannapelham
knplabs.com
github.com/weaverryan
@weaverryan

View Slide

Intro
Life before components
(The Desert of the Real)
Copyright by Moyan Brenn http://www.flickr.com/aigle_dore

View Slide

Zend Framework 2 consists
of 48 individual
components

View Slide

Components are available
via Composer

View Slide

Snooze...
http://www.ﬂickr.com/photos/ﬁatlux/81268407/

View Slide

Who Cares?

View Slide

We Suck at Sharing
and that sucks for you
@weaverryan
1

View Slide

Including External Libraries
is Depressing

View Slide

The Big Bummer :(
•@weaverryan
• How do I autoload their files?
• Does their library depend on anything else?
• How do I even store their files in my project?

View Slide

Include a Zend Framework 1
component in symfony1

View Slide


View Slide

manually download the
library and commit it
into your project

View Slide

if you don’t want the
WHOLE library, carefully
delete everything except
the dependent components

View Slide

autoloading is completely
custom ... blah gross!

View Slide

Components are the key to
mastering your framework
@weaverryan
2

View Slide

If PHP is big, we’ll thrive
If PHP is small, we’ll die
@weaverryan
3

View Slide

Communities
@weaverryan
PHP is Huge! Right?
http://www.ﬂickr.com/photos/kitty-kat/

View Slide

@weaverryan
PHP > Ruby

View Slide

Fragmentation
@weaverryan
But fragmentation makes us tiny, isolated, and
misguided trend-setters
http://www.ﬂickr.com/photos/slpunk99/7329609744

View Slide

PHP frameworks < Rails
@weaverryan

View Slide

I don’t want a damned
CakePHP Plugin!
@weaverryan
CakePHP
CodeIgniter

View Slide

Fragmentation
@weaverryan
• More information we have to know
• Difficult to hire
• Disjointed forums, StackOverflow
• Interoperability? What’s that?

View Slide

Components are shareable
across all of PHP

View Slide

Act 1
Making Sharing Sexy

View Slide

PHP Framework
Interoperability Group
http://www.php-ﬁg.org/

View Slide

The United Nations of PHP

View Slide

(A)
The Problem of Autoloading

View Slide

My Autoloader doesn’t
like your PHPs
@weaverryan
• The symfony1 autoloader doesn’t know where ZF1
classes live. The Zf1 autoloader doesn’t know where
symfony1 classes live
• Each library has its own autoloader that you must
discover, configure and use

View Slide

like a town where every
store has its own currency

View Slide

From The Mountain:
PSR-0 Class Naming Conventions
@weaverryan
“Thou shalt name your classes by
following a predictable pattern”

View Slide

class:
sfRequest
path:
lib/vendor/symfony/???idk

View Slide

class:
Symfony\Component\HttpFoundation\Request
path:
vendor/symfony/src/Symfony/Component/
HttpFoundation/Request.php

View Slide

use Symfony\Component\ClassLoader\UniversalClassLoader;
$loader = new UniversalClassLoader();
$loader->registerNamespaces(array(
'Zend' => __DIR__.'/path/to/zf'
));
$loader->register();

View Slide

use Symfony\Component\ClassLoader\UniversalClassLoader;
$loader = new UniversalClassLoader();
$loader->registerNamespaces(array(
'Zend' => __DIR__.'/path/to/zf'
));
$loader->register();
** This uses the Symfony2 autoloader. But all PSR-0
autoloaders are really the same.
Composer comes with its own.

View Slide

(B)
Managing Vendors in your
project

View Slide

Composer

View Slide

Act 2
Using Composer
http://KnpUniversity.com/screencast/composer

View Slide

Composer in 5
easy steps
1. Download composer.phar
2. Find package name & version
3. Create composer.json configuration
4. Download via composer install
5. Require autoload.php... then go crazy!

View Slide

curl -s https://getcomposer.org/installer | php
Download Composer.phar
Source: http://getcomposer.org/download/

View Slide

This downloads an
executable file:
composer.phar

View Slide

Execute it...
And it’ll list the
available commands

View Slide

Composer in 5
easy steps

View Slide

Packagist.org
@weaverryan
• Composer installs packages
• A package is a directory that contains
anything (usually PHP classes)
• Every package has a unique name
• The mega-repository for packages is
http://packagist.org

View Slide

Search for
something

View Slide

Find the name of
the package

View Slide

Find the right
version
** Bleeding edge (unstable)
** Development branch
(likely unstable)
** Latest stable version
(safest bet!)

View Slide

knplabs/knp-menu: v1.1.2

View Slide

Composer in 5
easy steps

View Slide

{
"require": {
"knplabs/knp-menu": "v1.1.2"
}
}
Create composer.json

View Slide

Or call
php composer.phar init
to create the composer.json
interactively

View Slide

Composer in 5
easy steps

View Slide

So Far we have...
@weaverryan
• The composer.phar executable
• A composer.json with the name and
version of a package
• ... that’s all!

View Slide

Now we tell Composer to
read composer.json and
download our libraries

View Slide

php composer.phar install

View Slide


View Slide

Hallo Install!
The “install” command does 2 things
1. Downloads all the required libraries into
the vendor/ directory
2. Generates some files to making
autoloading effortless

View Slide

Composer in 5
easy steps

View Slide

use Knp\Menu\MenuFactory;
use Knp\Menu\Renderer\ListRenderer;
$factory = new MenuFactory();
$menu = $factory->createItem('My menu');
$menu->addChild('Home', array('uri' => '/'));
$menu->addChild('Comments', array(
'uri' => '/comments'
))->setAttribute('class', 'comments');
$renderer = new ListRenderer();
echo $renderer->render($menu);
require 'vendor/autoload.php'; That’s the
magic!!!

View Slide


View Slide

Act 3
Composer and
Zend Framework 2

View Slide

Zend Framework 2
• Zend Framework 2 is a group of
components (i.e. normal PHP libraries)
• If you’re using Zend Framework, you
actually have a skeleton that is built to
leverage these components

View Slide

https://github.com/zendframework/ZendSkeletonApplication

View Slide

php composer.phar create-project
A special one-time-use way to
“clone” a project skeleton

View Slide

Typical Usage
php composer.phar create-project package/name local/dir

View Slide

Typical Usage
Don’t forget to download or
copy composer.phar to your
current directory

View Slide

Typical Usage
The command name

View Slide

Typical Usage
use
php composer.phar create-project --help
to learn about any command

View Slide

Typical Usage
The name of the package on Packagist.org

View Slide

Typical Usage
Local path to download the project

View Slide

php composer.phar create-project \
The ZF2 Skeleton App

View Slide

... just breaking a long
shell command onto
multiple lines...

View Slide

--repository-url="http://packages.zendframework.com" \
ZF2 Packages are stored on their own
private “Packagist”

View Slide

zendframework/skeleton-application \
The name of the package on
packages.zendframework.com

View Slide

zendframework/skeleton-application \
zf2
... and our local directory name

View Slide


View Slide

create-project
• Clones the project
• Runs php composer.phar install to
download zendframework/zendframework
into the vendor/ directory
• You now have a project skeleton that uses
Composer to bring in Zf2 #winning

View Slide

Now, how can I bring in other
libraries?

View Slide

{
"name": "zendframework/skeleton-application",
"description": "Skeleton Application for ZF2",
"license": "BSD-3-Clause",
"keywords": [
"framework",
"zf2"
],
"homepage": "http://framework.zend.com/",
"require": {
"php": ">=5.3.3",
"zendframework/zendframework": "2.*",
"knplabs/knp-menu": "v1.1.2"
}
}
Update composer.json

View Slide


View Slide

php composer.phar update
** Remember to download or
copy composer.phar into your
Zf2 skeleton project

View Slide

composer.lock
When you install vendors,
Composer creates a composer.lock
file, with the exact details and
version of all libraries

View Slide

create-project
• install: ignores composer.json and reads
frozen vendors from composer.lock
• update: ignores composer.lock and re-
parses composer.json, updating packages to
the latest version specified there and then
updates composer.lock

View Slide

create-project
• install: use day-to-day to make sure your
vendor libraries are right where they should
be
• update: use only when you’re specifically
adding or upgrading a library

View Slide


View Slide

Start using the library
immediately

View Slide

use Knp\Menu\MenuFactory;
use Knp\Menu\Renderer\ListRenderer;
class IndexController extends AbstractActionController
{
public function indexAction()
{
// would be even better as a service...
$factory = new MenuFactory();
$menu = $factory->createItem('My menu');
$menu->addChild('Home', array('uri' => '/'));
// ...
$renderer = new ListRenderer();
return new ViewModel(array(
'renderedMenu' => $renderer->render($menu)
));
}
}

View Slide

Act 4
Using Zend Framework 2
Components from Anywhere

View Slide

Super Easy...

View Slide

One Trick...

View Slide

ZF2 hosts its packages outside
of Packagist.org...

View Slide

composer.json
{
"repositories": [
{
"type": "composer",
"url": "http://packages.zendframework.com/"
}
]
}
Source:
http://framework.zend.com/downloads/composer
Now your composer looks for
packages at packagist.org
*and* packages.zf.com

View Slide

Add your packages...

View Slide

composer.json
{
"repositories": [
{
"type": "composer",
"url": "http://packages.zendframework.com/"
}
],
"require": {
"zendframework/zend-config": "2.0.*",
"zendframework/zend-http": "2.0.*"
}
}

View Slide

Download composer.phar

View Slide

** if there is no composer.lock yet,
update == install

View Slide

require 'vendor/autoload.php';
This belongs in some
bootstrap file in your app

View Slide

And that’s it!

View Slide

Act 5
Kicking ass in the new
PHP eco-system

View Slide

The PHP Ecosphere
@weaverryan
Zend Framework is only one part of the picture
What other stuff exists?
• Zend Framework
• Symfony
• eZ Components
• Drupal
• ...
• Individuals

View Slide

How do we find good
libraries?

View Slide


View Slide

Some Favorites

View Slide

Mink
behat/mink
http://mink.behat.org/
By @everzet
(this is a current photo)

View Slide

Command a browser, find elements, click
them, and fill out forms
$driver = new \Behat\Mink\Driver\SahiDriver('firefox');
$session->visit('http://my_project.dev/some_page.php');
$page = $session->getPage();
$anchor = $page->find('css', '.something');
$anchor->click();
// get the content of the new page
echo $page->getContent();

View Slide

Monolog
monolog/monolog
https://github.com/Seldaek/monolog
Your Friend Jordi

View Slide

A Logger, where bells and whistles
come standard
use Monolog\Logger;
use Monolog\Handler\StreamHandler;
use Monolog\Handler\FirePHPHandler;
// Create the logger
$logger = new Logger('my_logger');
$logger->pushHandler(new StreamHandler(
__DIR__.'/my_app.log'
));
$logger->pushHandler(new FirePHPHandler());
$logger->addInfo('My logger is now ready');

View Slide

Yay Find More!

View Slide

Epilogue
4 Reasons to get
silly-excited about
the Future

View Slide

1) Look for Participation &
Consolidation

View Slide

Shared
Building-blocks
@weaverryan
• Drupal
• phpBB
• Midgard
• Zikula
• eZ Publish
• ...

View Slide

Less Library
Duplication?
@weaverryan
• Zend/Form
• Zend/Serializer
• Zend/Http
• Zend/EventManager
• Zend/Log
• Zend/Navigation
• ...
• Symfony/Form
• Symfony/Serializer
• Symfony/HttpFoundation
• Symfony/EventDispatcher
• Monolog
• KnpMenu
• ...

View Slide

2) More high quality,
community-grown libraries

View Slide

Solving 1 specific problem
is a low barrier to entry

View Slide

Find them, fork them.

View Slide

Write their docs :)

View Slide

Programmers that write
docs get hugs

View Slide

3) Easier upgrades

View Slide

4) Grow your Community

View Slide

Solutions exist outside of
your framework

View Slide

Weier O'Phinney will not come
to your house and tell you
about them

View Slide

Image: http://framework.zend.com/404

View Slide

Cast your vote by using the
best libraries and improving
them

View Slide

and realize the power of
the entire PHP community

View Slide

Thanks...
Ryan Weaver
@weaverryan
KnpUniversity.com
PHP Tutorial Screencasts

View Slide

... and we love you!
Ryan Weaver
@weaverryan
joind.in/7038

View Slide

The Wonderful World of Composer and ZF2

The Wonderful World of Composer and ZF2

weaverryan

More Decks by weaverryan

Other Decks in Technology

Featured

Transcript