feature #5385 Added a note about the need to require Composer's autoload file (javiereguiluz)

weaverryan · weaverryan · commit 1226b20cb6a0 · 2015-06-19T12:57:51.000-04:00
This PR was merged into the 2.3 branch. Discussion ---------- Added a note about the need to require Composer's autoload file | Q | A | ------------- | --- | Doc fix? | yes | New docs? | no | Applies to | all | Fixed tickets | - This PR tries to finish #4409. I don't know if I applied correctly the ideas proposed by @weaverryan and @wouterj in that PR. Commits ------- 7f1ec8a Added a note about the need to require Composer's autoload file
diff --git a/components/class_loader/introduction.rst b/components/class_loader/introduction.rst
@@ -36,5 +36,7 @@ You can install the component in 2 different ways:
   on `Packagist`_);
 * Use the official Git repository (https://github.com/symfony/ClassLoader).
 
+.. include:: /components/require_autoload.rst.inc
+
 .. _`autoloading mechanism`: http://php.net/manual/en/language.oop5.autoload.php
 .. _Packagist: https://packagist.org/packages/symfony/class-loader
diff --git a/components/config/introduction.rst b/components/config/introduction.rst
@@ -17,6 +17,8 @@ You can install the component in 2 different ways:
 * :doc:`Install it via Composer </components/using_components>` (``symfony/config`` on `Packagist`_);
 * Use the official Git repository (https://github.com/symfony/Config).
 
+.. include:: /components/require_autoload.rst.inc
+
 Sections
 --------
 
diff --git a/components/console/introduction.rst b/components/console/introduction.rst
@@ -20,6 +20,8 @@ You can install the component in 2 different ways:
 * :doc:`Install it via Composer </components/using_components>` (``symfony/console`` on `Packagist`_);
 * Use the official Git repository (https://github.com/symfony/Console).
 
+.. include:: /components/require_autoload.rst.inc
+
 Creating a basic Command
 ------------------------
 
diff --git a/components/css_selector.rst b/components/css_selector.rst
@@ -15,6 +15,8 @@ You can install the component in 2 different ways:
 * :doc:`Install it via Composer </components/using_components>` (``symfony/css-selector`` on `Packagist`_);
 * Use the official Git repository (https://github.com/symfony/CssSelector).
 
+.. include:: /components/require_autoload.rst.inc
+
 Usage
 -----
 
diff --git a/components/debug.rst b/components/debug.rst
@@ -19,6 +19,8 @@ You can install the component in many different ways:
 * :doc:`Install it via Composer </components/using_components>` (``symfony/debug`` on `Packagist`_);
 * Use the official Git repository (https://github.com/symfony/Debug).
 
+.. include:: /components/require_autoload.rst.inc
+
 Usage
 -----
 
diff --git a/components/dependency_injection/introduction.rst b/components/dependency_injection/introduction.rst
@@ -19,6 +19,8 @@ You can install the component in 2 different ways:
 * :doc:`Install it via Composer </components/using_components>` (``symfony/dependency-injection`` on `Packagist`_);
 * Use the official Git repository (https://github.com/symfony/DependencyInjection).
 
+.. include:: /components/require_autoload.rst.inc
+
 Basic Usage
 -----------
 
diff --git a/components/dom_crawler.rst b/components/dom_crawler.rst
@@ -20,6 +20,8 @@ You can install the component in 2 different ways:
 * :doc:`Install it via Composer </components/using_components>` (``symfony/dom-crawler`` on `Packagist`_);
 * Use the official Git repository (https://github.com/symfony/DomCrawler).
 
+.. include:: /components/require_autoload.rst.inc
+
 Usage
 -----
 
diff --git a/components/event_dispatcher/introduction.rst b/components/event_dispatcher/introduction.rst
@@ -56,6 +56,8 @@ You can install the component in 2 different ways:
 * :doc:`Install it via Composer </components/using_components>` (``symfony/event-dispatcher`` on `Packagist`_);
 * Use the official Git repository (https://github.com/symfony/EventDispatcher).
 
+.. include:: /components/require_autoload.rst.inc
+
 Usage
 -----
 
diff --git a/components/filesystem.rst b/components/filesystem.rst
@@ -18,6 +18,8 @@ You can install the component in 2 different ways:
 * :doc:`Install it via Composer </components/using_components>` (``symfony/filesystem`` on `Packagist`_);
 * Use the official Git repository (https://github.com/symfony/Filesystem).
 
+.. include:: /components/require_autoload.rst.inc
+
 Usage
 -----
 
diff --git a/components/finder.rst b/components/finder.rst
@@ -16,6 +16,8 @@ You can install the component in 2 different ways:
 * :doc:`Install it via Composer </components/using_components>` (``symfony/finder`` on `Packagist`_);
 * Use the official Git repository (https://github.com/symfony/Finder).
 
+.. include:: /components/require_autoload.rst.inc
+
 Usage
 -----
 
@@ -308,7 +310,7 @@ The contents of returned files can be read with
 
     foreach ($finder as $file) {
         $contents = $file->getContents();
-        
+
         // ...
     }
 
diff --git a/components/form/introduction.rst b/components/form/introduction.rst
@@ -22,6 +22,8 @@ You can install the component in 2 different ways:
 * :doc:`Install it via Composer </components/using_components>` (``symfony/form`` on `Packagist`_);
 * Use the official Git repository (https://github.com/symfony/Form).
 
+.. include:: /components/require_autoload.rst.inc
+
 Configuration
 -------------
 
diff --git a/components/http_foundation/introduction.rst b/components/http_foundation/introduction.rst
@@ -24,6 +24,8 @@ You can install the component in 2 different ways:
 * :doc:`Install it via Composer </components/using_components>` (``symfony/http-foundation`` on `Packagist`_);
 * Use the official Git repository (https://github.com/symfony/HttpFoundation).
 
+.. include:: /components/require_autoload.rst.inc
+
 .. _component-http-foundation-request:
 
 Request
diff --git a/components/http_kernel/introduction.rst b/components/http_kernel/introduction.rst
@@ -19,6 +19,8 @@ You can install the component in 2 different ways:
 * :doc:`Install it via Composer </components/using_components>` (``symfony/http-kernel`` on Packagist_);
 * Use the official Git repository (https://github.com/symfony/HttpKernel).
 
+.. include:: /components/require_autoload.rst.inc
+
 The Workflow of a Request
 -------------------------
 
diff --git a/components/options_resolver.rst b/components/options_resolver.rst
@@ -16,6 +16,8 @@ You can install the component in 2 different ways:
 * :doc:`Install it via Composer </components/using_components>` (``symfony/options-resolver`` on `Packagist`_);
 * Use the official Git repository (https://github.com/symfony/OptionsResolver).
 
+.. include:: /components/require_autoload.rst.inc
+
 Usage
 -----
 
diff --git a/components/process.rst b/components/process.rst
@@ -15,6 +15,8 @@ You can install the component in 2 different ways:
 * :doc:`Install it via Composer </components/using_components>` (``symfony/process`` on `Packagist`_);
 * Use the official Git repository (https://github.com/symfony/Process).
 
+.. include:: /components/require_autoload.rst.inc
+
 Usage
 -----
 
diff --git a/components/property_access/introduction.rst b/components/property_access/introduction.rst
@@ -20,6 +20,8 @@ You can install the component in two different ways:
 * :doc:`Install it via Composer</components/using_components>` (``symfony/property-access`` on `Packagist`_);
 * Use the official Git repository (https://github.com/symfony/PropertyAccess).
 
+.. include:: /components/require_autoload.rst.inc
+
 Usage
 -----
 
diff --git a/components/require_autoload.rst.inc b/components/require_autoload.rst.inc
@@ -0,0 +1,3 @@
+Then, require the ``vendor/autoload.php`` file to enable the autoloading mechanism
+provided by Composer. Otherwise, your application won't be able to find the classes
+of this Symfony component.
diff --git a/components/routing/introduction.rst b/components/routing/introduction.rst
@@ -16,6 +16,8 @@ You can install the component in 2 different ways:
 * :doc:`Install it via Composer </components/using_components>` (``symfony/routing`` on `Packagist`_);
 * Use the official Git repository (https://github.com/symfony/Routing).
 
+.. include:: /components/require_autoload.rst.inc
+
 Usage
 -----
 
diff --git a/components/security/introduction.rst b/components/security/introduction.rst
@@ -19,6 +19,8 @@ You can install the component in 2 different ways:
 * :doc:`Install it via Composer </components/using_components>` (``symfony/security`` on Packagist_);
 * Use the official Git repository (https://github.com/symfony/Security).
 
+.. include:: /components/require_autoload.rst.inc
+
 Sections
 --------
 
diff --git a/components/serializer.rst b/components/serializer.rst
@@ -33,6 +33,8 @@ You can install the component in 2 different ways:
 * :doc:`Install it via Composer </components/using_components>` (``symfony/serializer`` on `Packagist`_);
 * Use the official Git repository (https://github.com/symfony/Serializer).
 
+.. include:: /components/require_autoload.rst.inc
+
 Usage
 -----
 
diff --git a/components/stopwatch.rst b/components/stopwatch.rst
@@ -20,6 +20,8 @@ You can install the component in two different ways:
 * :doc:`Install it via Composer</components/using_components>` (``symfony/stopwatch`` on `Packagist`_);
 * Use the official Git repository (https://github.com/symfony/Stopwatch).
 
+.. include:: /components/require_autoload.rst.inc
+
 Usage
 -----
 
diff --git a/components/templating/introduction.rst b/components/templating/introduction.rst
@@ -21,6 +21,8 @@ You can install the component in 2 different ways:
 * :doc:`Install it via Composer </components/using_components>` (``symfony/templating`` on `Packagist`_);
 * Use the official Git repository (https://github.com/symfony/Templating).
 
+.. include:: /components/require_autoload.rst.inc
+
 Usage
 -----
 
diff --git a/components/translation/introduction.rst b/components/translation/introduction.rst
@@ -16,6 +16,8 @@ You can install the component in 2 different ways:
 * :doc:`Install it via Composer </components/using_components>` (``symfony/translation`` on `Packagist`_);
 * Use the official Git repository (https://github.com/symfony/Translation).
 
+.. include:: /components/require_autoload.rst.inc
+
 Constructing the Translator
 ---------------------------
 
diff --git a/components/yaml/introduction.rst b/components/yaml/introduction.rst
@@ -34,6 +34,8 @@ You can install the component in 2 different ways:
 * :doc:`Install it via Composer </components/using_components>` (``symfony/yaml`` on `Packagist`_);
 * Use the official Git repository (https://github.com/symfony/Yaml).
 
+.. include:: /components/require_autoload.rst.inc
+
 Why?
 ----
 

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	+Then, require the ``vendor/autoload.php`` file to enable the autoloading mechanism
	`2`	`+provided by Composer. Otherwise, your application won't be able to find the classes`
	`3`	`+of this Symfony component.`