@@ -5,74 +5,46 @@ How to Install 3rd Party Bundles
5
5
================================
6
6
7
7
Most bundles provide their own installation instructions. However, the
8
- basic steps for installing a bundle are the same.
8
+ basic steps for installing a bundle are the same:
9
9
10
- Add Composer Dependencies
11
- -------------------------
10
+ * `A) Add Composer Dependencies `_
11
+ * `B) Enable the Bundle `_
12
+ * `C) Configure the Bundle `_
12
13
13
- Starting from Symfony 2.1, dependencies are managed with Composer. It's
14
- a good idea to learn some basics of Composer in ` their documentation `_.
14
+ A) Add Composer Dependencies
15
+ ----------------------------
15
16
16
- Before you can use Composer to install a bundle, you should look for a
17
- `Packagist `_ package of that bundle. For example, if you search for the popular
18
- `FOSUserBundle `_ you will find a package called `friendsofsymfony/user-bundle `_.
17
+ Dependencies are managed with Composer, so if Composer is new to you, learn
18
+ some basics in `their documentation `_. This has 2 steps:
19
19
20
- .. note ::
21
-
22
- Packagist is the main archive for Composer. If you are searching
23
- for a bundle, the best thing you can do is check out
24
- `KnpBundles `_, it is the unofficial archive of Symfony Bundles. If
25
- a bundle contains a ``README `` file, it is displayed there and if it
26
- has a Packagist package it shows a link to the package. It's a
27
- really useful site to begin searching for bundles.
28
-
29
- Now that you have the package name, you should determine the version
30
- you want to use. Usually different versions of a bundle correspond to
31
- a particular version of Symfony. This information should be in the ``README ``
32
- file. If it isn't, you can use the version you want. If you choose an incompatible
33
- version, Composer will throw dependency errors when you try to install. If
34
- this happens, you can try a different version.
35
-
36
- In the case of the FOSUserBundle, the ``README `` file has a caution that version
37
- 1.2.0 must be used for Symfony 2.0 and 1.3+ for Symfony 2.1+. Packagist displays
38
- example ``require `` statements for all existing versions of a package. The
39
- current development version of FOSUserBundle is ``"friendsofsymfony/user-bundle": "2.0.*@dev" ``.
40
-
41
- Now you can add the bundle to your ``composer.json `` file and update the
42
- dependencies. You can do this manually:
43
-
44
- 1. **Add it to the ``composer.json`` file: **
45
-
46
- .. code-block :: json
20
+ 1) Find out the Name of the Bundle on Packagist
21
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
47
22
48
- {
49
- ...,
50
- "require" : {
51
- ...,
52
- "friendsofsymfony/user-bundle" : " 2.0.*@dev"
53
- }
54
- }
23
+ The README for a bundle (e.g. `FOSUserBundle `_) usually tells you its name
24
+ (e.g. ``friendsofsymfony/user-bundle ``). If it doesn't, you can search for
25
+ the library on the `Packagist.org `_ site.
55
26
56
- 2. ** Update the dependency: **
27
+ .. note ::
57
28
58
- .. code-block :: bash
29
+ Looking for bundles? Try searching at `KnpBundles.com `_: the unofficial
30
+ archive of Symfony Bundles.
59
31
60
- $ php composer.phar update friendsofsymfony/user-bundle
32
+ 2) Install the Bundle via Composer
33
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
61
34
62
- or update all dependencies
35
+ Now that you know the package name, you can install it via Composer:
63
36
64
37
.. code-block :: bash
65
38
66
- $ php composer.phar update
39
+ $ php composer.phar require friendsofsymfony/user-bundle
67
40
68
- Or you can do this in one command:
69
-
70
- .. code-block :: bash
41
+ This will choose the best version for your project, add it to ``composer.json ``
42
+ and download the library into the ``vendor/ `` directory. If you need a specific
43
+ version, add a ``: `` and the version right after the library name (see
44
+ `composer require `_).
71
45
72
- $ php composer.phar require friendsofsymfony/user-bundle:2.0.* @dev
73
-
74
- Enable the Bundle
75
- -----------------
46
+ B) Enable the Bundle
47
+ --------------------
76
48
77
49
At this point, the bundle is installed in your Symfony project (in
78
50
``vendor/friendsofsymfony/ ``) and the autoloader recognizes its classes.
@@ -96,13 +68,13 @@ The only thing you need to do now is register the bundle in ``AppKernel``::
96
68
}
97
69
}
98
70
99
- Configure the Bundle
100
- --------------------
71
+ C) Configure the Bundle
72
+ -----------------------
101
73
102
- Usually a bundle requires some configuration to be added to app's
103
- ``app/config/config.yml `` file . The bundle's documentation will likely
104
- describe that configuration. But you can also get a reference of the
105
- bundle's config via the ``config:dump-reference `` command.
74
+ It's pretty common for a bundle to need some additional setup or configuration
75
+ in ``app/config/config.yml ``. The bundle's documentation will tell you about
76
+ the configuration, but you can also get a reference of the bundle's config
77
+ via the ``config:dump-reference `` command.
106
78
107
79
For instance, in order to look the reference of the ``assetic `` config you
108
80
can use this:
@@ -137,10 +109,10 @@ Other Setup
137
109
-----------
138
110
139
111
At this point, check the ``README `` file of your brand new bundle to see
140
- what to do next.
112
+ what to do next. Have fun!
141
113
142
114
.. _their documentation : http://getcomposer.org/doc/00-intro.md
143
- .. _Packagist : https://packagist.org
115
+ .. _Packagist.org : https://packagist.org
144
116
.. _FOSUserBundle : https://github.com/FriendsOfSymfony/FOSUserBundle
145
- .. _`friendsofsymfony/user-bundle` : https://packagist.org/packages/friendsofsymfony/user-bundle
146
117
.. _KnpBundles : http://knpbundles.com/
118
+ .. _`composer require` : https://getcomposer.org/doc/03-cli.md#require
0 commit comments