Sylius/docs/components_and_bundles/bundles/SyliusCustomerBundle/installation.rst
2024-09-27 06:09:00 +02:00

83 lines
2.3 KiB
ReStructuredText

.. rst-class:: outdated
Installation
============
.. danger::
We're sorry but **this documentation section is outdated**. Please have that in mind when trying to use it.
You can help us making documentation up to date via Sylius Github. Thank you!
We assume you're familiar with `Composer <https://packagist.org>`_, a dependency manager for PHP.
Use the following command to add the bundle to your `composer.json` and download the package.
If you have `Composer installed globally <https://getcomposer.org/doc/00-intro.md#globally>`_.
.. code-block:: bash
composer require sylius/customer-bundle
Otherwise you have to download .phar file.
.. code-block:: bash
curl -sS https://getcomposer.org/installer | php
php composer.phar require sylius/customer-bundle
Adding required bundles to the kernel
-------------------------------------
You need to enable the bundle inside the kernel.
If you're not using any other Sylius bundles, you will also need to add `SyliusResourceBundle` and its dependencies to kernel.
Don't worry, everything was automatically installed via Composer.
.. code-block:: php
<?php
// app/AppKernel.php
public function registerBundles()
{
$bundles = array(
new JMS\SerializerBundle\JMSSerializerBundle(),
new Stof\DoctrineExtensionsBundle\StofDoctrineExtensionsBundle(),
new BabDev\PagerfantaBundle\BabDevPagerfantaBundle(),
new winzou\Bundle\StateMachineBundle\winzouStateMachineBundle(),
new Sylius\Bundle\ResourceBundle\SyliusResourceBundle(),
new Sylius\Bundle\CustomerBundle\SyliusCustomerBundle(),
// Other bundles...
new Doctrine\Bundle\DoctrineBundle\DoctrineBundle(),
);
}
Configure Doctrine extensions
-----------------------------
Configure doctrine extensions which are used by the bundle.
.. code-block:: yaml
# app/config/config.yml
stof_doctrine_extensions:
orm:
default:
timestampable: true
Updating database schema
------------------------
Run the following command.
.. code-block:: bash
php bin/console doctrine:schema:update --force
.. warning::
This should be done only in **dev** environment! We recommend using Doctrine migrations, to safely update your schema.
Congratulations! The bundle is now installed and ready to use.