How to Install and Use the Components ===================================== .. note:: This section is based on `Symfony2 documentation `_. If you're starting a new project (or already have a project) that will use one or more components, the easiest way to integrate everything is with `Composer`_. Composer is smart enough to download the component(s) that you need and take care of autoloading so that you can begin using the libraries immediately. This article will take you through using :doc:`/components/MultiTenancy/index`, though this applies to using any component. Using the MultiTenancy Component -------------------------------- **1.** If you're creating a new project, create a new empty directory for it. **2.** Open a console and use Composer to grab the library. .. code-block:: bash composer require swp/multi-tenancy The name ``swp/multi-tenancy`` is written at the top of the documentation for the component. .. tip:: `Install composer`_ if you don't have it already present on your system. 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 swp/multi-tenancy``. **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. .. code-block:: php setTenant($tenant); var_dump($tenantContext->getTenant()); // ... Now what? --------- Now that the component is installed and autoloaded, read the specific component's documentation to find out more about how to use it. And have fun! .. _Composer: https://getcomposer.org .. _Install composer: https://getcomposer.org/download/