Skip to content

Commit

Permalink
Updating component usage to use composer require
Browse files Browse the repository at this point in the history
  • Loading branch information
weaverryan committed Nov 5, 2014
1 parent cef629c commit 8a50c9c
Showing 1 changed file with 21 additions and 44 deletions.
65 changes: 21 additions & 44 deletions components/using_components.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,40 +20,33 @@ Using the Finder Component

**1.** If you're creating a new project, create a new empty directory for it.

**2.** Create a new file called ``composer.json`` and paste the following into it:
**2.** Open a terminal and use Composer to grab the library.

.. code-block:: json
{
"require": {
"symfony/finder": "2.3.*"
}
}
If you already have a ``composer.json`` file, just add this line to it. You
may also need to adjust the version (e.g. ``2.2.2`` or ``2.3.*``).

You can research the component names and versions at `packagist.org`_.
.. code-block:: bash
**3.** `Install composer`_ if you don't already have it present on your system:
$ composer require symfony/finder
**4.** Download the vendor libraries and generate the ``vendor/autoload.php`` file:
The name ``symfony/finder`` is written at the top of the documentation for
whatever component you want.

.. code-block:: bash
.. tip::

$ php composer.phar install
If you get a command not found for ``composer``, you'll need to
`Install composer`_. Depending on how you install, you may end up with
a ``composer.phar`` file in your directory. In that case, no worries!
Just run ``php composer.phar require symfony/finder``.

**5.** Write your code:
**3.** Write your code!

Once Composer has downloaded the component(s), all you need to do is include
the ``vendor/autoload.php`` file that was generated by Composer. This file
takes care of autoloading all of the libraries so that you can use them
immediately::

// File: src/script.php
// File example: src/script.php

// update this to the path to the "vendor/" directory, relative to this file
require_once '../vendor/autoload.php';
require_once __DIR__.'../vendor/autoload.php';

use Symfony\Component\Finder\Finder;

Expand All @@ -62,33 +55,18 @@ immediately::

// ...

.. tip::

If you want to use all of the Symfony Components, then instead of adding
them one by one:

.. code-block:: json
Using all of the Components
---------------------------

{
"require": {
"symfony/finder": "2.3.*",
"symfony/dom-crawler": "2.3.*",
"symfony/css-selector": "2.3.*"
}
}
If you want to use all of the Symfony Components, then instead of adding
them one by one, you can include the ``symfony/symfony`` package:

you can use:

.. code-block:: json
.. code-block:: bash
{
"require": {
"symfony/symfony": "2.3.*"
}
}
$ composer require symfony/symfony
This will include the Bundle and Bridge libraries, which you may not
actually need.
This will also include the Bundle and Bridge libraries, which you may or
may not actually need.

Now what?
---------
Expand All @@ -100,4 +78,3 @@ And have fun!

.. _Composer: http://getcomposer.org
.. _Install composer: http://getcomposer.org/download/
.. _packagist.org: https://packagist.org/

0 comments on commit 8a50c9c

Please sign in to comment.