Sylius Documentation¶

Sylius is a modern e-commerce solution for PHP, based on Symfony Framework.

Note

This documentation assumes you have a working knowledge of the Symfony Framework. If you’re not familiar with Symfony, please start with reading the Quick Tour from the Symfony documentation.

Tip

Getting Started with Sylius, The Book, Customization Guide, The Cookbook, BDD Guide and Performance Guide are chapters describing the usage of the whole Sylius platform, on the examples for Sylius-Standard distribution.

For tips on using only some bundles of Sylius head to Bundles and Components docs.

Getting Started with Sylius¶

The essential guide for the Sylius newcomers that want to know it’s most important features, quickly see the power of customization and run their first Sylius shop within a few hours.

Getting Started with Sylius¶

Getting started with Sylius - Online course (8h)

LEARN NOW

This tutorial is dedicated to Sylius newcomers, who want to quickly check our system out - see basic configuration, do some small customizations, and be able to sell the first products in their new webshop. It shows the quickest and simplest way from an idea (“I want to sell some stuff online”) to the first results (“I can sell some stuff online!”).

Installation¶

So you want to try creating an online shop with Sylius? Great! The first step is the most important one, so let’s start with the Sylius project installation via Composer. We will be using the latest stable version of Sylius - 1.7.

Before installation¶

There are some prerequisites that your local environment should fulfill before installation (not many of them).

For more details, take a look at this chapter in The Book.

Project setup¶

The easiest way to install Sylius on your local machine is to use the following command:

composer create-project sylius/sylius-standard MyFirstShop

It will create a MyFirstShop directory with a brand new Sylius application inside.

Warning

Beware! The next step includes the database setup. It will set your database credentials (username, password, and database name) in the file with environment variables (.env is the most basic one).

To launch a Sylius application initial data has to be set up: an administrator account and base locale. Run the Sylius installation command to do that.

cd MyFirstShop
bin/console sylius:install

This command will do several things for you - the first two steps are checking if your environment fulfills technical requirements, and setting the project database. You will also be asked if you want to have default fixtures loaded into your database - let’s say “No” to that, we will configure the store manually.

It’s essential to put some attention to the 3rd installation step. There you configure your default administrator account, which will be later used to access Sylius admin panel.

To derive joy from Sylius SemanticUI-based views, you should use yarn to load our assets.

yarn install
yarn build

That’s it! You’re ready to launch your empty Sylius-based web store.

Launching application¶

For the testing reasons, the fastest way to start the application is using Symfony binary. It can be downloaded from here. Let’s also start browsing the application from the Admin panel.

symfony serve
open http://127.0.0.1:8000/admin

Great! You are closer to the final goal. Let’s configure your application a little bit, to make it usable by some future customers.

Learn more¶

Installation chapter in The Book

Basic configuration¶

The first place you should check out in the Admin panel is the Configuration section. There you can find a bunch of modules used to customize your shop the most basic data.

Channel¶

The most important one is the Channels section. It should consist of one channel already created by you with the installation command. Channels contain the most basic data about your store, like available locales, currencies, shop billing data, etc. You can modify the channel’s configuration:

Locale¶

Sylius supports internationalization on many levels - you can easily add new locales to your shop to allow your customers browsing it in their desired language. As set in the installation command, the only Locale available right now should be English (United States). This will be the base locale of your shop, therefore all of your products or taxons etc. have to be created with at an english name at least.

Currency¶

Each channel operates only on one Base Currency, but prices can be shown in multiple Currencies, with a ratio between them configured by Exchange rates. For now, the only available currency should be USD, which was also created by the sylius:install command.

Note

All the previous data was created by the installation command - but you should also add two more things to the store configuration to make it work in 100%. It will also be required to have them in the next chapter of this guide.

Country¶

Most of the shops ship their merchandise to various countries in the world. To configure which countries will be available as shipping destinations in your store, you should add some countries in the Countries section.

Adding a country:

Added country displayed on the index page:

Zone¶

The last configuration step is creating a zone. They are used for various reasons, like shipping and taxing operations, and can consist of countries, provinces or other zones.

Let’s create one, basic zone named United States for the only country in the system (also United States). This way the basic shop configuration is done!

Learn more¶

Shipping & Payment¶

The basic configuration is done. We can now proceed to let potential customers buy our merchandise. During the checkout process, they should be able to define how do they want their order to be shipped, as well as how they would pay for that.

Shipping method¶

Sylius allows configuring different ways to ship the order, depending on shipping address (the Zone concept is essential there!), or affiliation to some specific Shipping Category. Let’s then create a shipping method called “FedEx” that would cost $10.00 for a whole order.

Payment method¶

Customer should also be able to choose, how they are willing to pay. At least one payment method is required - let’s make it “Cash on delivery”. Before creation, we need to specify the payment method gateway, which is a way for processing the payment (Offline, PayPal Commerce Platform, PayPal Express Checkout and Stripe are supported by default).

Gateway selection:

Payment method creation:

Attention

Psst! You can find integrations with more payment gateways if you take a look at some Sylius plugins

Great! The only thing left is creating some products, and we can go shopping!

Learn more¶

First product¶

We move to one of the most important sections of the Admin panel - products management. As you can see, the Catalog section in the menu is quite extended, but we will, for now, focus on product creation only.

You can pick a simple or configurable product type before its creation. Making long story short - simple is a product that has just one version, configurable is a product where the customer gets to choose some options of it (like size or colour). Check out the Products chapter in The Book for more information.

During the product creation, you can decide about many of its traits. How much does it cost? Is it a physical product that requires shipping? Should it be tracked within the inventory system? On which channel will it be available? Should it have some taxes added during the checkout or not? Take a while to explore these options later, right now let’s fill only the most critical data:

Summary¶

Great, the first stage is done! The whole checkout process is described in this part of the documentation.

We can now move to some more advanced parts of the tutorial - Sylius features customization and deploying it into the server, to make it available to the world.

Learn more¶

Shop Customizations¶

What makes Sylius unique from other e-commerce systems is not only its highly developed community or clean code base. The developer experience has always been a great advantage of this platform - and it includes easiness of customization and great extendability.

Let’s get the benefit from these features and make some simple customization, to make your store even more suitable for your business needs.

Logo¶

You can start with the shop panel. The default templates are elegant and straightforward, but for sure you would like to make them unique for your online store. Maybe some colors should be different? Or even the whole product page does not look like you want? Fortunately, twig templates are easy to override or customize (take a look at Customizing Templates chapter for more info).

In the beginning, try a very simple, but also one of the most crucial changes - displaying your shop logo in place of the Sylius logo.

Default logo in shop panel:

The first step is to detect which template is responsible for displaying the logo and therefore which should be overridden to customize a logo image.

It’s placed in SyliusShopBundle, at Resources/views/Layout/Header/_logo.html.twig path, so to override it, you should create the templates/shop/Layout/Header/_logo.html.twig file and copy the original file content. Next, replace the img element source with a link to the logo or properly imported asset image (take a look at Symfony assets documentation for more info).

The other way to achieve this is to modify the configuration of the sylius.shop.layout.header.grid template event. Here for sake of example the same logo file templates/shop/Layout/Header/_logo.html.twig used as in the example above. Add the configuration to the file that stores your sylius template event settings:

# config.yaml

sylius_ui:
    events:
        sylius.shop.layout.header.grid:
            blocks:
                logo: 'bundles/SyliusShopBundle/Layout/Header/_logo.html.twig'

If you want to learn more about template customization with sylius template events - click here.

Hint

We encourage to create and register another .yaml file to store template changes for more clarity in configuration files.

Hint

Psst! To speed up your learning path you can just put a logo file into the public/assets/ directory. Just remember, it should not be committed into the repository or put on the server, it’s just for the testing reasons!

At the end of customization, the overridden file would look similar to this:

<div class="column">
    <a href="{{ path('sylius_shop_homepage') }}"><img src="{{ asset('assets/logo.png') }}" alt="Logo" class="ui small image" /></a>
</div>

A custom logo should now be displayed on the Shop panel header:

Great! You’ve managed to customize a template in Sylius! Let’s move to something a little bit more complicated but also much more satisfying - introducing your own business logic into the system.

Custom business logic¶

Templates customization is just the beginning of the broad spectrum of customization possibilities in Sylius. There are very few things in Sylius you’re not able to customize or override. Let’s take a look at one of the typical example of customizing Sylius default logic, in this case, logic related to shipments and their cost. It’s time for a custom shipping calculator.

Custom shipping calculator¶

Each shipping calculator is able to calculate a shipping cost for the provided order. This calculation is usually based on bought products and some configuration done by Administrator. By default Sylius provides FlatRateCalculator and PerUnitRateCalculator (their names are quite self-explaining), but it’s sometimes not enough. So let’s say your store packs ordered products in parcels and you need to charge a customer for each of them.

You should start with the implementation of your custom shipping calculator service. Remember, that it must implement the CalculatorInterface from Shipping Component. Let’s name it ParcelCalculator and place it in src/ShippingCalculator directory.

<?php
# src/ShippingCalculator/ParcelCalculator.php

declare(strict_types=1);

namespace App\ShippingCalculator;

use Sylius\Component\Shipping\Calculator\CalculatorInterface;
use Sylius\Component\Shipping\Model\ShipmentInterface;

final class ParcelCalculator implements CalculatorInterface
{
    public function calculate(ShipmentInterface $subject, array $configuration): int
    {
        $parcelSize = $configuration['size'];
        $parcelPrice = $configuration['price'];

        $numberOfPackages = ceil($subject->getUnits()->count() / $parcelSize);

        return (int) ($numberOfPackages * $parcelPrice);
    }

    public function getType(): string
    {
        return 'parcel';
    }
}

Two more things are needed to make it work. A form type, that would be used to pass some data to the $configuration array in the calculator service, and a proper service registration in the services.yaml file.

<?php
# src/Form/Type/ParcelShippingCalculatorType.php

declare(strict_types=1);

namespace App\Form\Type;

use Sylius\Bundle\MoneyBundle\Form\Type\MoneyType;
use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\Extension\Core\Type\NumberType;
use Symfony\Component\Form\FormBuilderInterface;

final class ParcelShippingCalculatorType extends AbstractType
{
    public function buildForm(FormBuilderInterface $builder, array $options): void
    {
        $builder
            ->add('size', NumberType::class)
            ->add('price', MoneyType::class, [
                'currency' => 'USD',
            ])
        ;
    }
}

Attention

The currency needed for MoneyType in the proposed implementation hardcoded just for testing reasons. In a real application, you should get the proper currency code from the repository, context or some configuration file.

# config/services.yml

services:
    # ...

    App\ShippingCalculator\ParcelCalculator:
        tags:
            -
                {
                    name: sylius.shipping_calculator,
                    calculator: "parcel",
                    label: "Parcel",
                    form_type: App\Form\Type\ParcelShippingCalculatorType
                }

That’s it! You should now be able to select your shipping calculator during the creation or edition of a shipping method.

You can also see the results of your customization on checkout shipping step, how the shipping fee changes depending on how many products you have in the cart.

For 1 product:

For 4 products:

This customization will also work when using unified API without any extra steps:

First, you need to pick up a new cart:

curl -X POST "https://master.demo.sylius.com/api/v2/shop/orders" -H "accept: application/ld+json"

With body:

{
    "localeCode": "string"
}

Note

The localeCode value is optional in the body of cart pickup. This means that if you won’t provide it, the default locale from the channel will be used.

This should return a response with tokenValue which we would need for the next API calls:

{
    //...
    "shippingState": "string",
    "tokenValue": "CART_TOKEN",
    "id": 123,
    //...
}

Then we need to add a product to the cart but first, it would be good to have any. You can use this call to retrieve some products:

curl -X GET "https://master.demo.sylius.com/api/v2/shop/products?page=1&itemsPerPage=30" -H  "accept: application/ld+json"

And choose any product variant IRI that you would like to add to your cart:

curl --location --request PATCH 'https://master.demo.sylius.com/api/v2/shop/orders/CART_TOKEN/items' -H 'Content-Type: application/merge-patch+json'

With a chosen product variant in the body:

{
    "productVariant": "/api/v2/shop/product-variants/PRODUCT_VARIANT_CODE",
    "quantity": 1
}

This should return a response with the cart that should contain a shippingTotal:

{
    //...
    "taxTotal": 0,
    "shippingTotal": 500,
    "orderPromotionTotal": 0,
    //...
}

Attention

API returns costs in decimal numbers that’s why in response it is 500 currency unit shipping total (which stands for 5 USD in this case).

Now let’s change the quantity of our product variant. We can do it by calling the endpoint above once again, or by utilizing the changeQuantity endpoint:

curl --location --request PATCH 'https://master.demo.sylius.com/api/v2/shop/orders/CART_TOKEN/items/ORDER_ITEM_ID' -H 'Content-Type: application/merge-patch+json'

With new quantity in the body:

{
  "quantity": 4
}

Which should return a response with the cart:

{
    //...
    "taxTotal": 0,
    "shippingTotal": 1000,
    "orderPromotionTotal": 0,
    //...
}

Amazing job! You’ve just provided your own logic into a Sylius-based system. Therefore, your store can provide a unique experience for your Customers. Basing on this knowledge, you’re ready to customize your shop even more and make it as suitable to your business needs as possible.

Learn more¶

Plugin installation¶

Sylius is easy to customize to your business needs, but not all of the customizations you have to do on your own! Sylius supports creating plugins, that are the best way to extend its functionality and share these new features with the Community. You can already benefit from some plugins developed by us (Sylius Core team) or the Community. All of the plugins officially approved are listed on our website, but even more of them can be seen in the Sylius ecosystem.

To give you a quick overview of how easy-to-use and powerful plugins can be, let’s install the SyliusCmsPlugin (developed by BitBag), one of the most popular extensions to Sylius.

Plugin’s installation instruction is widely explained in plugin’s documentation and consists of standard steps, that you can see in most of Sylius plugins:

plugin installation with composer
configuration (including routing importing)
database update
some extra steps (installing CKEditor, in this plugin’s case)

After the installation you should be able to use plugin’s features in your shop:

Usage of the plugin is one of the quickest ways to customize the store to your needs. We already have lots of plugins in the ecosystem, and their number is growing, so remember to check for the existing solution before implementing it on your own. There is no need to reinvent the wheel :)

Learn more¶

Deployment¶

Development usually takes most of the time in project implementation, but we should not forget about what’s at the end of this process - application deployment into the server. We believe, that it should be as easy and understandable as possible. There are many servers which you can choose for your store deployment: in our documentation you will find an easy Platform.sh guide.

Check it out!

Tip

👉 How to deploy Sylius to Platform.sh?

Summary¶

We hope you’ve enjoyed your first journey with Sylius. Basing on the already gathered knowledge you have now plenty of possibilities to use Sylius, customize it and add new functionalities with your own or Community’s code.

There are a few tips at the end of this tutorial:

if you want to improve your knowledge about Sylius features, take a look at The Book
if you’re interested in making more customizations, you should read some chapters from The Customization Guide
if you want to share your work with the Community, check out the Sylius Plugins chapter

And the most important - if you want to become a part of our collectivity, join our Slack, Forum and follow our repository to be always up-to-date with the newest Sylius releases. If you have any ideas about how to make Sylius better and want to support us on catalyzing trade with technology - open issues, pull requests and join discussions on Github. Sylius is only strong with the Community :)

Good luck!

Warning

Be aware, that this guide is written for developers! To understand every chapter correctly, you need to have at least a foggy idea about object-oriented programming and PHP language. Symfony experience will also be handy.

The Book¶

The Developer’s guide to leveraging the flexibility of Sylius. Here you will find all the concepts used in the Sylius platform. The Book helps to understand how Sylius works.

The Book¶

The Developer’s guide to leveraging the flexibility of Sylius. Here you will find all the concepts used in Sylius. The Books helps to understand how Sylius works.

Introduction¶

Introduction aims to describe the philosophy of Sylius. It will also teach you about environments before you start installing it.

Introduction¶

This is the beginning of the journey with Sylius. We will start with a basic insight into terms that we use in Sylius Documentation.

Introduction to Sylius¶

Sylius is a game-changing e-commerce solution for PHP, based on the Symfony framework.

Philosophy¶

Sylius is completely open source (MIT license) and free, maintained by a diverse and creative community of developers and companies.

What are our core values and what makes us different from other solutions?

Components based approach
Unlimited flexibility and simple customization
Developer-friendly, using latest technologies
Developed using best practices and BDD approach
Highest quality of code

And much more, but we will let you discover it yourself.

Sylius Plus¶

There exists a commercial edition of Sylius, which is called Sylius Plus.

Sylius Plus gives you all the power of Open Source and much more. It comes with a set of enterprise-grade features and technical support from its creators. As the state-of-the-art eCommerce platform, it reduces risks and increases your ROI.

In this documentation you will find also chapters dedicated to features introduced by the Sylius Plus edition, they will be marked with a frame just like this section.

The Three Natures of Sylius¶

Sylius is constructed from fully decoupled and flexible e-commerce components for PHP. It is also a set of Symfony bundles, which integrate the components into the full-stack framework. On top of that, Sylius is also a complete e-commerce platform crafted from all these building blocks.

It is your choice how to use Sylius, you can benefit from the components with any framework, integrate selected bundles into existing or new Symfony app or built your application on top of Sylius platform.

Sylius Platform¶

This book is about our full-stack e-commerce platform, which is a standard Symfony application providing the most common webshop and a foundation for custom systems.

Leveraging Symfony Bundles¶

If you prefer to build your very custom system step by step and from scratch, you can integrate the standalone Symfony bundles. For the installation instructions, please refer to the appropriate bundle documentation.

E-Commerce Components for PHP¶

If you use a different framework than Symfony, you are welcome to use Sylius components, which will make it much easier to implement a webshop with any PHP application and project. They provide you with default models, services and logic for all aspects of e-commerce, completely separated and ready to use.

Roadmap¶

Are you wondering about Sylius plans for the next releases? If so then you should follow our Roadmap. Through our Slack and Forum you can contribute by conversation and votes on the most desired features and improvements.

Final Thoughts¶

Depending on how you want to use Sylius, continue reading The Book, which covers the usage of the full stack solution, browse the Bundles Reference or learn about The Components.

Understanding Environments¶

Every Sylius application is the combination of code and a set of configuration that dictates how that code should function. The configuration may define the database being used, whether or not something should be cached, or how verbose logging should be. In Symfony, the idea of “environments” is the idea that the same codebase can be run using multiple different configurations. For example, the dev environment should use configuration that makes development easy and friendly, while the prod environment should use a set of configuration optimized for speed.

Development¶

Development environment or dev, as the name suggests, should be used for development purposes. It is much slower than production, because it uses much less aggressive caching and does a lot of processing on every request. However, it allows you to add new features or fix bugs quickly, without worrying about clearing the cache after every change.

Sylius console runs in dev environment by default. You can access the website in dev mode via the /index.php file in the public/ directory. (under your website root)

Production¶

Production environment or prod is your live website environment. It uses proper caching and is much faster than other environments. It uses live APIs and sends out all e-mails.

To run Sylius console in prod environment, add the following parameters to every command call:

bin/console --env=prod --no-debug cache:clear

You can access the website in production mode via the /index.php file in your website root (public/) or just / path. (on Apache)

Test¶

Test environment or test is used for automated testing. Most of the time you will not access it directly.

To run Sylius console in test environment, add the following parameters to every command call:

bin/console --env=test cache:clear

Final Thoughts¶

You can read more about Symfony environments in this cookbook article.

Installation¶

The installation chapter is of course a comprehensive guide to installing Sylius on your machine, but it also provides a general instruction on upgrading Sylius in your project.

Installation¶

The process of installing Sylius together with the requirements to run it efficiently.

System Requirements¶

Here you will find the list of system requirements that have to be adhered to be able to use Sylius. First of all have a look at the requirements for running Symfony.

Read about the LAMP stack and the MAMP stack.

Operating Systems¶

The recommended operating systems for running Sylius are the Unix systems - Linux, MacOS.

Web server and configuration¶

In the production environment we do recommend using Apache web server ≥ 2.2.

While developing the recommended way to work with your Symfony application is to use PHP’s built-in web server.

Go there to see the full reference to the web server configuration.

PHP required modules and configuration¶

PHP version:

PHP

^7.4|^8.0

PHP extensions:

gd	No specific configuration
exif	No specific configuration
fileinfo	No specific configuration
intl	No specific configuration

PHP configuration settings:

memory_limit	≥1024M
date.timezone	Europe/Warsaw

Warning

Use your local timezone, for example America/Los_Angeles or Europe/Berlin. See https://php.net/manual/en/timezones.php for the list of all available timezones.

Database¶

By default, the database connection is pre-configured to work with a following MySQL configuration:

MySQL

5.7+, 8.0+

Note

You might also use any other RDBMS (like PostgreSQL), but our database migrations support MySQL only.

Access rights¶

Most of the application folders and files require only read access, but a few folders need also the write access for the Apache/Nginx user:

var/cache
var/log
public/media

You can read how to set these permissions in the Symfony - setting up permissions section.

Installation¶

The Sylius main application can serve as an end-user app, as well as a foundation for your custom e-commerce application.

To create your Sylius-based application, first make sure you use PHP 7.4 or higher and have Composer installed.

Note

In order to inform you about newest Sylius releases and be aware of shops based on Sylius, the Core Team uses an internal statistical service called GUS. The only data that is collected and stored in its database are hostname, user agent, locale, environment (test, dev or prod), current Sylius version and the date of last contact. If you do not want your shop to send requests to GUS, please visit this guide for further instructions.

Initiating A New Sylius Project¶

To begin creating your new project, run this command:

composer create-project sylius/sylius-standard acme

Note

Make sure to use PHP ^7.4|^8.0. Using an older PHP version will result in installing an older version of Sylius.

This will create a new Symfony project in the acme directory. Next, move to the project directory:

cd acme

Sylius uses environment variables to configure the connection with database and mailer services. You can look up the default values in .env file and customise them by creating .env.local with variables you want to override. For example, if you want to change your database name from the default sylius_%kernel.environment% to my_custom_sylius_database, the contents of that new file should look like the following snippet:

DATABASE_URL=mysql://username:password@host/my_custom_sylius_database

After everything is in place, run the following command to install Sylius:

php bin/console sylius:install

Warning

During the sylius:install command you will be asked to provide important information, but also its execution ensures that the default currency (USD) and the default locale (English - US) are set. They can be changed later, respectively in the “Configuration > Channels” section of the admin and in the config/services.yaml file. If you want to change these before running the installation command, set the locale and sylius_installer_currency parameters in the config/services.yaml file. From now on all the prices will be stored in the database in USD as integers, and all the products will have to be added with a base american english name translation.

Installing assets¶

In order to see a fully functional frontend you will need to install its assets.

Sylius uses Gulp to build frontend assets using Yarn as a JavaScript package manager.

Having Yarn installed, go to your project directory to install the dependencies:

yarn install

Then build the frontend assets by running:

yarn build

Accessing the Shop¶

We strongly recommend using the Symfony Local Web Server by running the symfony server:start command and then accessing http://127.0.0.1:8000 in your web browser to see the shop.

Note

Get to know more about using Symfony Local Web Server in the Symfony server documentation. If you are using a built-in server check here.

You can log to the administrator panel located at /admin with the credentials you have provided during the installation process.

How to start developing? - Project Structure¶

After you have successfully gone through the installation process of Sylius-Standard you are probably going to start developing within the framework of Sylius.

In the root directory of your project you will find these important subdirectories:

config/ - here you will be adding the yaml configuration files including routing, security, state machines configurations etc.
var/log/ - these are the logs of your application
var/cache/ - this is the cache of you project
src/ - this is where you will be adding all you custom logic in the App
public/ - there you will be placing assets of your project

Tip

As it was mentioned before we are basing on Symfony, that is why we’ve adopted its approach to architecture. Read more in the Symfony documentation. Read also about the best practices while structuring your project.

Contributing¶

If you would like to contribute to Sylius - please go to the Contribution Guide

Sylius Plus Installation¶

Sylius Plus is an advanced extension to Sylius applications that adds new features and experience. As it is a private package it cannot be installed by every Sylius user, but only by those having the license.

Installing Sylius Plus as a plugin to a Sylius application¶

Important Requirements

PHP	^8.0
sylius/sylius	^1.10.1
Symfony	^4.4 \|\| ^5.4

0. Prepare project:

Tip

If it is a new project you are initiating, then first install Sylius-Standard in version ^1.10 according to these instructions.

If you’re installing Plus package to an existing project, then make sure you’re upgraded to sylius/sylius ^1.10.

1. Configure access to the private Packagist package in composer by using the Access Token you have been given with your license.

composer config --global --auth http-basic.sylius.repo.packagist.com token YOUR_TOKEN

2. Configure the repository with Sylius Plus for your organisation, require it and then run composer update:

composer config repositories.plus composer https://sylius.repo.packagist.com/ShortNameOfYourOrganization/
composer require "sylius/plus:^1.0.0-ALPHA.6" --no-update
composer update --no-scripts
composer sync-recipes

3. Configure Sylius Plus in config/bundles.php:

// config/bundles.php

return [
   //...
   Sylius\Plus\SyliusPlusPlugin::class => ['all' => true],
];

4. Import Sylius Plus configuration files:

# config/packages/_sylius.yaml
imports:
# ...
    - { resource: "@SyliusPlusPlugin/Resources/config/config.yaml" }

Warning

Recommended Sylius version to use with Sylius Plus is 1.11. If, for any reason, you need to use Sylius 1.10, it’s required to customise some API configurations. Run the following commands, to do it:

mkdir config/api_platform/
cp -R vendor/sylius/plus/etc/sylius-1.10/Resources/config/api_resources/* config/api_platform/
rm vendor/sylius/plus/src/Resources/config/api_resources/Customer.xml
rm vendor/sylius/plus/src/Resources/config/api_resources/Order.xml

5. Configure Shop, Admin and Admin API routing:

# config/routes/sylius_shop.yaml
# ...

sylius_plus_shop:
    resource: "@SyliusPlusPlugin/Resources/config/shop_routing.yaml"
    prefix: /{_locale}
    requirements:
        _locale: ^[a-z]{2}(?:_[A-Z]{2})?$

# config/routes/sylius_admin.yaml:
# ...

sylius_plus_admin:
    resource: "@SyliusPlusPlugin/Resources/config/admin_routing.yaml"
    prefix: /admin

6. Add traits that enhance Sylius models:

AdminUser
Channel
Customer
Order
ProductVariant
Shipment

// src/Entity/User/AdminUser.php
<?php

declare(strict_types=1);

namespace App\Entity\User;

use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\ORM\Mapping as ORM;
use Sylius\Component\Channel\Model\ChannelAwareInterface;
use Sylius\Component\Core\Model\AdminUser as BaseAdminUser;
use Sylius\Component\Core\Model\AdminUserInterface;
use Sylius\Plus\ChannelAdmin\Domain\Model\AdminChannelAwareTrait;
use Sylius\Plus\Entity\LastLoginIpAwareInterface;
use Sylius\Plus\Entity\LastLoginIpAwareTrait;
use Sylius\Plus\Rbac\Domain\Model\AdminUserInterface as RbacAdminUserInterface;
use Sylius\Plus\Rbac\Domain\Model\RoleableTrait;
use Sylius\Plus\Rbac\Domain\Model\ToggleablePermissionCheckerTrait;

/**
 * @ORM\Entity
 * @ORM\Table(name="sylius_admin_user")
 */
class AdminUser extends BaseAdminUser implements AdminUserInterface, RbacAdminUserInterface, ChannelAwareInterface, LastLoginIpAwareInterface
{
    use AdminChannelAwareTrait;
    use LastLoginIpAwareTrait;
    use ToggleablePermissionCheckerTrait;
    use RoleableTrait;

    public function __construct()
    {
        parent::__construct();

        $this->rolesResources = new ArrayCollection();
    }
}

// src/Entity/Channel/Channel.php
<?php

declare(strict_types=1);

namespace App\Entity\Channel;

use Doctrine\ORM\Mapping as ORM;
use Sylius\Component\Core\Model\Channel as BaseChannel;
use Sylius\Component\Core\Model\ChannelInterface;
use Sylius\Plus\BusinessUnits\Domain\Model\BusinessUnitAwareTrait;
use Sylius\Plus\BusinessUnits\Domain\Model\ChannelInterface as BusinessUnitsChannelInterface;
use Sylius\Plus\CustomerPools\Domain\Model\ChannelInterface as CustomerPoolsChannelInterface;
use Sylius\Plus\CustomerPools\Domain\Model\CustomerPoolAwareTrait;
use Sylius\Plus\Returns\Domain\Model\ChannelInterface as ReturnsChannelInterface;
use Sylius\Plus\Returns\Domain\Model\ReturnRequestsAllowedAwareTrait;

/**
 * @ORM\Entity
 * @ORM\Table(name="sylius_channel")
 */
class Channel extends BaseChannel implements ChannelInterface, ReturnsChannelInterface, BusinessUnitsChannelInterface, CustomerPoolsChannelInterface
{
    use ReturnRequestsAllowedAwareTrait;
    use CustomerPoolAwareTrait;
    use BusinessUnitAwareTrait;
}

// src/Entity/Customer/Customer.php
<?php

declare(strict_types=1);

namespace App\Entity\Customer;

use Doctrine\ORM\Mapping as ORM;
use Sylius\Component\Core\Model\Customer as BaseCustomer;
use Sylius\Component\Core\Model\CustomerInterface;
use Sylius\Plus\CustomerPools\Domain\Model\CustomerInterface as CustomerPoolsCustomerInterface;
use Sylius\Plus\CustomerPools\Domain\Model\CustomerPoolAwareTrait;
use Sylius\Plus\Loyalty\Domain\Model\CustomerInterface as LoyaltyCustomerInterface;
use Sylius\Plus\Loyalty\Domain\Model\LoyaltyAwareTrait;

/**
 * @ORM\Entity
 * @ORM\Table(name="sylius_customer")
 */
class Customer extends BaseCustomer implements CustomerInterface, CustomerPoolsCustomerInterface, LoyaltyCustomerInterface
{
    use CustomerPoolAwareTrait;
    use LoyaltyAwareTrait;
}

// src/Entity/Order/Order.php
<?php

declare(strict_types=1);

namespace App\Entity\Order;

use Doctrine\ORM\Mapping as ORM;
use Sylius\Component\Core\Model\Order as BaseOrder;
use Sylius\Component\Core\Model\OrderInterface;
use Sylius\Plus\Returns\Domain\Model\OrderInterface as ReturnsOrderInterface;
use Sylius\Plus\Returns\Domain\Model\ReturnRequestAwareTrait;

/**
 * @ORM\Entity
 * @ORM\Table(name="sylius_order")
 */
class Order extends BaseOrder implements OrderInterface, ReturnsOrderInterface
{
    use ReturnRequestAwareTrait;
}

// src/Entity/Product/ProductVariant.php
<?php

declare(strict_types=1);

namespace App\Entity\Product;

use Doctrine\ORM\Mapping as ORM;
use Sylius\Component\Core\Model\ProductVariant as BaseProductVariant;
use Sylius\Component\Core\Model\ProductVariantInterface;
use Sylius\Component\Product\Model\ProductVariantTranslationInterface;
use Sylius\Plus\Inventory\Domain\Model\InventorySourceStocksAwareTrait;
use Sylius\Plus\Inventory\Domain\Model\ProductVariantInterface as InventoryProductVariantInterface;

/**
 * @ORM\Entity()
 * @ORM\Table(name="sylius_product_variant")
 */
class ProductVariant extends BaseProductVariant implements ProductVariantInterface, InventoryProductVariantInterface
{
    use InventorySourceStocksAwareTrait {
        __construct as private initializeProductVariantTrait;
    }

    public function __construct()
    {
        parent::__construct();

        $this->initializeProductVariantTrait();
    }

    protected function createTranslation(): ProductVariantTranslationInterface
    {
        return new ProductVariantTranslation();
    }
}

// src/Entity/Shipping/Shipment.php
<?php

declare(strict_types=1);

namespace App\Entity\Shipping;

use Doctrine\ORM\Mapping as ORM;
use Sylius\Component\Core\Model\Shipment as BaseShipment;
use Sylius\Component\Core\Model\ShipmentInterface;
use Sylius\Plus\Inventory\Domain\Model\InventorySourceAwareTrait;
use Sylius\Plus\Inventory\Domain\Model\ShipmentInterface as InventoryShipmentInterface;

/**
 * @ORM\Entity()
 * @ORM\Table(name="sylius_shipment")
 */
class Shipment extends BaseShipment implements ShipmentInterface, InventoryShipmentInterface
{
    use InventorySourceAwareTrait;
}

7. Install wkhtmltopdf binary:

Default configuration assumes enabled PDF file generator. If you don’t want to use that feature change your app configuration:

# config/packages/sylius_plus.yaml
sylius_plus:
    pdf_generator:
        enabled: false

Warning

Sylius Plus uses both the Sylius Invoicing and Sylius Refund plugins which have their own configuration for disabling PDF Generator.

Check if you have wkhtmltopdf binary. If not, you can download it here.

By default wkhtmltopdf is installed in /usr/local/bin/wkhtmltopdf directory.

Tip

If you not sure if you have already installed wkhtmltopdf and where it is located, write the following command in the terminal: which wkhtmltopdf

In case wkhtmltopdf is not located in /usr/local/bin/wkhtmltopdf, add the following snippet at the end of your application’s .env file:

###> knplabs/knp-snappy-bundle ###
WKHTMLTOPDF_PATH=/your-path
###< knplabs/knp-snappy-bundle ###

8. Update the database using migrations:

bin/console doctrine:migrations:migrate

9. Install Sylius with Sylius Plus fixtures:

bin/console sylius:install -s plus

Tip

If you want to completely (re)install the application, you can run this command with the no interaction flag -n.

bin/console sylius:install -s plus -n

10. Copy templates that are overridden by Sylius Plus into templates/bundles:

cp -fr vendor/sylius/plus/src/Resources/templates/bundles/* templates/bundles

11. Install JS libraries using Yarn:

yarn install
yarn build
bin/console assets:install --ansi

12. Rebuild cache for proper display of all translations:

bin/console cache:clear
bin/console cache:warmup

13. For more details check the installation guides for all plugins installed as dependencies with Sylius Plus.

Phew! That’s all, you can now run the application just like you usually do with Sylius (using Symfony Server for example).

Upgrading Sylius Plus¶

To upgrade Sylius Plus in an existing application, please follow upgrade instructions from Sylius/PlusInformationCenter repository.

Upgrading¶

Sylius regularly releases new versions according to our Release Cycle. Each minor release comes with an UPGRADE.md file, which is meant to help in the upgrading process.

Update the Sylius library version constraint by modifying the ``composer.json`` file:
{ "require": { "sylius/sylius": "^1.7" } }
Upgrade dependencies by running a Composer command:
composer update sylius/sylius --with-all-dependencies
If this does not help, it is a matter of debugging the conflicting versions and working out how your composer.json should look after the upgrade. You can check what version of Sylius is installed by running composer show sylius/sylius command.
Follow the instructions found in the ``UPGRADE.md`` file for a given minor release.

Upgrading Sylius Plus¶

Sylius regularly releases new versions, usually every two weeks. Each release comes with an UPGRADE.md file, which is meant to help in the upgrading process.

Update the Sylius Plus version constraint by modifying the ``composer.json`` file:

{
    "require": {
        "sylius/plus": "^1.0.0-ALPHA.6"
    }
}

Upgrade dependencies by running a Composer command:
composer update sylius/plus --with-all-dependencies
If this does not help, it is a matter of debugging the conflicting versions and working out how your composer.json should look after the upgrade. You can check what version of Sylius is installed by running composer show sylius/plus command.
Follow the instructions found in the ``UPGRADE.md`` file for a given minor release.

Note

As Sylius Plus is a private repository its README files (and CHANGELOG) have been exposed in a separate public repository which can be found here: https://github.com/Sylius/PlusInformationCenter

Architecture¶

The key to understanding principles of Sylius internal organization. Here you will learn about the Resource layer, state machines, events and general non e-commerce concepts adopted in the platform, like E-mails or Fixtures.

Architecture¶

Before we dive separately into every Sylius concept, you need to have an overview of how our main application is structured. In this chapter we will sketch this architecture and our basic, cornerstone concepts, but also some supportive approaches, that you need to notice.

Architecture Overview¶

Before we dive separately into every Sylius concept, you need to have an overview of how our main application is structured. You already know that Sylius is built from components and Symfony bundles, which are integration layers with the framework.

All bundles share the same conventions for naming things and the way of data persistence. Sylius, by default, uses the Doctrine ORM for managing all entities.

For deeper understanding of how Doctrine works, please refer to the excellent documentation on their official website.

Fullstack Symfony¶

Sylius is based on Symfony, which is a leading PHP framework to create web applications. Using Symfony allows developers to work better and faster by providing them with certainty of developing an application that is fully compatible with the business rules, that is structured, maintainable and upgradable, but also it allows to save time by providing generic re-usable modules.

Learn more about Symfony.

Doctrine¶

Doctrine is a family of PHP libraries focused on providing data persistence layer. The most important are the object-relational mapper (ORM) and the database abstraction layer (DBAL). One of Doctrine’s key features is the possibility to write database queries in Doctrine Query Language (DQL) - an object-oriented dialect of SQL.

To learn more about Doctrine - see their documentation.

Twig¶

Twig is a modern template engine for PHP that is really fast, secure and flexible. Twig is being used by Symfony.

To read more about Twig, go here.

API Platform¶

API Platform is a modern solution for developing high quality APIs. API Platform works by default with Symfony and depends on its components.

Architecture¶

On the below image you can see the symbolic representation of Sylius architecture.

Keep on reading this chapter to learn more about each of its parts: Shop, Admin, API, Core, Components and Bundles.

Division into Components, Bundles, Platform¶

Components¶

Every single component of Sylius can be used standalone. Taking the Taxation component as an example, its only responsibility is to calculate taxes, it does not matter whether these will be taxes for products or anything else, it is fully decoupled. In order to let the Taxation component operate on your objects you need to have them implementing the TaxableInterface. Since then they can have taxes calculated. Such approach is true for every component of Sylius. Besides components that are strictly connected to the e-commerce needs, we have plenty of components that are more general. For instance Attribute, Mailer, Locale etc.

All the components are packages available via Packagist.

Resource Layer¶

We created an abstraction on top of Doctrine, in order to have a consistent and flexible way to manage all the resources. By “resource” we understand every model in the application. Simplest examples of Sylius resources are “product”, “order”, “tax_category”, “promotion”, “user”, “shipping_method” and so on…

There are two types of resources in Sylius:

registered by default - their names begin with sylius.* for example: sylius.product
custom resources, from your application which have a separate convention. We place them under sylius_resource: resource_name: in the config.yml. For these we recommend using the naming convention of app.* for instance app.my_entity.

Sylius resource management system lives in the SyliusResourceBundle and can be used in any Symfony project.

Services¶

For every resource you have four essential services available:

Factory
Manager
Repository
Controller

Let us take the “product” resource as an example. By default, it is represented by an object of a class that implements the Sylius\Component\Core\Model\ProductInterface.

Factory¶

The factory service gives you an ability to create new default objects. It can be accessed via the sylius.factory.product id (for the Product resource of course).

<?php

public function myAction()
{
    $factory = $this->container->get('sylius.factory.product');

    /** @var ProductInterface $product **/
    $product = $factory->createNew();
}

Note

Creating resources via this factory method makes the code more testable, and allows you to change the model class easily.

Manager¶

The manager service is just an alias to appropriate Doctrine’s ObjectManager and can be accessed via the sylius.manager.product id. API is exactly the same and you are probably already familiar with it:

<?php

public function myAction()
{
    $manager = $this->container->get('sylius.manager.product');

    // Assuming that the $product1 exists in the database we can perform such operations:
    $manager->remove($product1);

    // If we have created the $product2 using a factory, we can persist it in the database.
    $manager->persist($product2);

    // Before performing a flush, the changes we have made, are not saved. There is only the $product1 in the database.
    $manager->flush(); // Saves changes in the database.

    //After these operations we have only $product2 in the database. The $product1 has been removed.
}

Repository¶

Repository is defined as a service for every resource and shares the API with standard Doctrine ObjectRepository. It contains two additional methods for creating a new object instance and a paginator provider.

The repository service is available via the sylius.repository.product id and can be used like all the repositories you have seen before.

<?php

public function myAction()
{
    $repository = $this->container->get('sylius.repository.product');

    $product = $repository->find(4); // Get product with id 4, returns null if not found.
    $product = $repository->findOneBy(['slug' => 'my-super-product']); // Get one product by defined criteria.

    $products = $repository->findAll(); // Load all the products!
    $products = $repository->findBy(['special' => true]); // Find products matching some custom criteria.
}

Tip

An important feature of the repositories are the add($resource) and remove($resource) methods, which take a resource as an argument and perform the adding/removing action with a flush inside.

These actions can be used when the performance of operations is negligible. If you want to perform operations on large sets of data we recommend using the manager instead.

Every Sylius repository supports paginating resources. To create a Pagerfanta instance use the createPaginator method:

<?php

public function myAction(Request $request)
{
    $repository = $this->container->get('sylius.repository.product');

    $products = $repository->createPaginator();
    $products->setMaxPerPage(3);
    $products->setCurrentPage($request->query->get('page', 1));

    // Now you can return products to template and iterate over it to get products from current page.
}

Paginator can be created for a specific criteria and with desired sorting:

<?php

public function myAction(Request $request)
{
    $repository = $this->container->get('sylius.repository.product');

    $products = $repository->createPaginator(['foo' => true], ['createdAt' => 'desc']);
    $products->setMaxPerPage(3);
    $products->setCurrentPage($request->query->get('page', 1));
}

Controller¶

This service is the most important for every resource and provides a format agnostic CRUD controller with the following actions:

[GET] showAction() for getting a single resource
[GET] indexAction() for retrieving a collection of resources
[GET/POST] createAction() for creating new resource
[GET/PUT] updateAction() for updating an existing resource
[DELETE] deleteAction() for removing an existing resource

As you see, these actions match the common operations in any REST API and yes, they are format agnostic. This means, all Sylius controllers can serve HTML, JSON or XML, depending on what you request.

Additionally, all these actions are very flexible and allow you to use different templates, forms, repository methods per route. The bundle is very powerful and allows you to register your own resources as well. To give you some idea of what is possible, here are some examples!

Displaying a resource with a custom template and repository methods:

# config/routes.yaml
app_product_show:
    path: /products/{slug}
    methods: [GET]
    defaults:
        _controller: sylius.controller.product:showAction
        _sylius:
            template: AppStoreBundle:Product:show.html.twig # Use a custom template.
            repository:
                method: findForStore # Use a custom repository method.
                arguments: [$slug] # Pass the slug from the url to the repository.

Creating a product using custom form and a redirection method:

# config/routes.yaml
app_product_create:
    path: /my-stores/{store}/products/new
    methods: [GET, POST]
    defaults:
        _controller: sylius.controller.product:createAction
        _sylius:
            form: AppStoreBundle/Form/Type/CustomFormType # Use this form type!
            template: AppStoreBundle:Product:create.html.twig # Use a custom template.
            factory:
                method: createForStore # Use a custom factory method to create a product.
                arguments: [$store] # Pass the store name from the url.
            redirect:
                route: app_product_index # Redirect the user to their products.
                parameters: [$store]

All other methods have the same level of flexibility and are documented in the SyliusResourceBundle.

State Machine¶

In Sylius we are using the Winzou StateMachine Bundle. State Machines are an approach to handling changes occurring in the system frequently, that is extremely flexible and very well organised.

Every state machine will have a predefined set of states, that will be stored on an entity that is being controlled by it. These states will have a set of defined transitions between them, and a set of callbacks - a kind of events, that will happen on defined transitions.

States¶

States of a state machine are defined as constants on the model of an entity that the state machine is controlling.

How to configure states? Let’s see on the example from Checkout state machine.

# CoreBundle/Resources/config/app/state_machine/sylius_order_checkout.yml
winzou_state_machine:
    sylius_order_checkout:
        # list of all possible states:
        states:
            cart: ~
            addressed: ~
            shipping_selected: ~
            payment_selected: ~
            completed: ~

Transitions¶

On the graph it would be the connection between two states, defining that you can move from one state to another subsequently.

How to configure transitions? Let’s see on the example of our Checkout state machine. Having states configured we can have a transition between the cart state to the addressed state.

# CoreBundle/Resources/config/app/state_machine/sylius_order_checkout.yml
winzou_state_machine:
    sylius_order_checkout:
        transitions:
            address:
                from: [cart, addressed, shipping_selected, payment_selected]  # here you specify which state is the initial
                to: addressed                                                 # there you specify which state is final for that transition

Callbacks¶

Callbacks are used to execute some code before or after applying transitions. Winzou StateMachineBundle adds the ability to use Symfony services in the callbacks.

How to configure callbacks? Having a configured transition, you can attach a callback to it either before or after the transition. Callback is simply a method of a service you want to be executed.

# CoreBundle/Resources/config/app/state_machine/sylius_order_checkout.yml
winzou_state_machine:
     sylius_order_checkout:
          callbacks:
               # callbacks may be called before or after specified transitions, in the checkout state machine we've got callbacks only after transitions
               after:
                    sylius_process_cart:
                        on: ["address", "select_shipping", "select_payment"]
                        do: ["@sylius.order_processing.order_processor", "process"]
                        args: ["object"]

Configuration¶

In order to use a state machine, you have to define a graph beforehand. A graph is a definition of states, transitions and optionally callbacks - all attached on an object from your domain. Multiple graphs may be attached to the same object.

In Sylius the best example of a state machine is the one from checkout. It has five states available: cart, addressed, shipping_selected, payment_selected and completed - which can be achieved by applying some transitions to the entity. For example, when selecting a shipping method during the shipping step of checkout we should apply the select_shipping transition, and after that the state would become shipping_selected.

# CoreBundle/Resources/config/app/state_machine/sylius_order_checkout.yml
winzou_state_machine:
    sylius_order_checkout:
        class: "%sylius.model.order.class%" # class of the domain object - in our case Order
        property_path: checkoutState
        graph: sylius_order_checkout
        state_machine_class: "%sylius.state_machine.class%"
        # list of all possible states:
        states:
            cart: ~
            addressed: ~
            shipping_selected: ~
            payment_selected: ~
            completed: ~
        # list of all possible transitions:
        transitions:
            address:
                from: [cart, addressed, shipping_selected, payment_selected] # here you specify which state is the initial
                to: addressed                                                # there you specify which state is final for that transition
            select_shipping:
                from: [addressed, shipping_selected, payment_selected]
                to: shipping_selected
            select_payment:
                from: [payment_selected, shipping_selected]
                to: payment_selected
            complete:
                from: [payment_selected]
                to: completed
        # list of all callbacks:
        callbacks:
        # callbacks may be called before or after specified transitions, in the checkout state machine we've got callbacks only after transitions
            after:
                sylius_process_cart:
                    on: ["address", "select_shipping", "select_payment"]
                    do: ["@sylius.order_processing.order_processor", "process"]
                    args: ["object"]
                sylius_create_order:
                    on: ["complete"]
                    do: ["@sm.callback.cascade_transition", "apply"]
                    args: ["object", "event", "'create'", "'sylius_order'"]
                sylius_hold_inventory:
                    on: ["complete"]
                    do: ["@sylius.inventory.order_inventory_operator", "hold"]
                    args: ["object"]
                sylius_assign_token:
                    on: ["complete"]
                    do: ["@sylius.unique_id_based_order_token_assigner", "assignTokenValueIfNotSet"]
                    args: ["object"]

Learn more¶

Translations¶

Sylius uses the approach of personal translations - where each entity is bound with a translation entity, that has it’s own table (instead of keeping all translations in one table for the whole system). This results in having the ProductTranslation class and sylius_product_translation table for the Product entity.

The logic of handling translations in Sylius is in the ResourceBundle

The fields of an entity that are meant to be translatable are saved on the translation entity, only their getters and setters are also on the original model.

Let’s see an example:

Assuming that we would like to have a translatable model of a Supplier, we need a Supplier class and a SupplierTranslation class.

<?php

namespace App\Entity;

use Sylius\Component\Resource\Model\AbstractTranslation;

class SupplierTranslation extends AbstractTranslation
{
    /**
     * @var string
     */
    protected $name;

    /**
     * @return string
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * @param string $name
     */
    public function setName($name)
    {
        $this->name = $name;
    }
}

The actual entity has access to its translation by using the TranslatableTrait which provides the getTranslation() method.

Warning

Remember that the Translations collection of the entity (from the TranslatableTrait) has to be initialized in the constructor!

<?php

namespace App\Entity;

use Sylius\Component\Resource\Model\TranslatableInterface;
use Sylius\Component\Resource\Model\TranslatableTrait;

class Supplier implements TranslatableInterface
{
    use TranslatableTrait {
        __construct as private initializeTranslationsCollection;
    }

    public function __construct()
    {
        $this->initializeTranslationsCollection();
    }

    /**
     * @return string
     */
    public function getName()
    {
        return $this->getTranslation()->getName();
    }

    /**
     * @param string $name
     */
    public function setName($name)
    {
        $this->getTranslation()->setName($name);
    }
}

Fallback Translations¶

The getTranslation() method gets a translation for the current locale, while we are in the shop, but we can also manually impose the locale - getTranslation('pl_PL') will return a polish translation if there is a translation in this locale.

But when the translation for the chosen locale is unavailable, instead the translation for the fallback locale (the one that was either set in config/services.yaml or using the setFallbackLocale() method from the TranslatableTrait on the entity) is used.

How to add a new translation programmatically?¶

You can programmatically add a translation to any of the translatable resources in Sylius. Let’s see how to do it on the example of a ProductTranslation.

// Find a product to add a translation to it

/** @var ProductInterface $product */
$product = $this->container->get('sylius.repository.product')->findOneBy(['code' => 'radiohead-mug-code']);

// Create a new translation of product, give it a translated name and slug in the chosen locale

/** @var ProductTranslation $translation */
$translation = new ProductTranslation();

$translation->setLocale('pl_PL');
$translation->setName('Kubek Radiohead');
$translation->setSlug('kubek-radiohead');

// Add the translation to your product
$product->addTranslation($translation);

// Remember to save the product after adding the translation
$this->container->get('sylius.manager.product')->flush();

Learn more¶

E-Mails¶

Sylius is sending various e-mails and this chapter is a reference about all of them. Continue reading to learn what e-mails are sent, when and how to customize the templates. To understand how e-mail sending works internally, please refer to SyliusMailerBundle documentation. And to learn more about mailer services configuration, read the dedicated cookbook.

User Confirmation¶

Every time a customer registers via the registration form, a user registration e-mail is sent to them.

Code: user_registration

The default template: @SyliusShop/Email/userRegistration.html.twig

You also have the following parameters available:

user: Instance of the user model
channel: Currently used channel
localeCode: Currently used locale code

Email Verification¶

When a customer registers via the registration form, besides the User Confirmation an Email Verification is sent.

Code: verification_token

The default template: @SyliusShop/Email/verification.html.twig

You also have the following parameters available:

user: Instance of the user model
channel: Currently used channel
localeCode: Currently used locale code

Password Reset¶

This e-mail is used when the user requests to reset their password in the login form.

Code: reset_password_token

The default template: @SyliusShop/Email/passwordReset.html.twig

You also have the following parameters available:

user: Instance of the user model
channel: Currently used channel
localeCode: Currently used locale code

Order Confirmation¶

This e-mail is sent when order is placed.

Code: order_confirmation

The default template: @SyliusShop/Email/orderConfirmation.html.twig

You also have the following parameters available:

order: Instance of the order, with all its data
channel: Channel in which an order was placed
localeCode: Locale code in which an order was placed

Shipment Confirmation¶

This e-mail is sent when the order’s shipping process has started.

Code: shipment_confirmation

The default template: @SyliusAdmin/Email/shipmentConfirmation.html.twig

You have the following parameters available:

shipment: Shipment instance
order: Instance of the order, with all its data
channel: Channel in which an order was placed
localeCode: Locale code in which an order was placed

Contact Request¶

This e-mail is sent when a customer validates contact form.

Code: contact_request

The default template: @SyliusShop/Email/contactRequest.html.twig

You have the following parameters available:

data: An array of submitted data from form
channel: Channel in which an order was placed
localeCode: Locale code in which an order was placed

Return Requests Emails¶

Hint

What are Return Requests? Check here!

Return Request Confirmation¶

This email is sent after return request has been created by a customer.

Code: sylius_plus_return_request_confirmation

The default template: @SyliusPlusPlugin/Returns/Infrastructure /Resources/views/Emails/returnRequestConfirmation.html.twig

Parameters:

order - for which the return request has been created

Return Request Acceptation¶

This email is sent when the administrator accepts a return request.

Code: sylius_plus_return_request_accepted

The default template: @SyliusPlusPlugin/Returns/Infrastructure /Resources/views/Emails/returnRequestAcceptedNotification.html.twig

Parameters:

returnRequest which has been accepted
order of the accepted return request

Return Request Rejection¶

This email is sent when the administrator rejects a return request.

Code: sylius_plus_return_request_rejected

The default template: @SyliusPlusPlugin/Returns/Infrastructure /Resources/views/Emails/returnRequestRejectedNotification.html.twig

Parameters:

returnRequest which has been rejected
order of the rejected return request

Return Request Resolution Change¶

This email is sent when the administrator changes return request’s resolution proposed by a customer.

Code: sylius_plus_return_request_resolution_changed

The default template: @SyliusPlusPlugin/Returns/Infrastructure /Resources/views/Emails/returnRequestResolutionChangedNotification.html.twig

Parameters:

returnRequest whose resolution has been changed
order of the modified return request

Return Request: Repaired Items Sent¶

This email is sent when the administrator marks that a return request’s repaired items have been sent back to the Customer.

Code: sylius_plus_return_request_repaired_items_sent

The default template: @SyliusPlusPlugin/Returns/Infrastructure /Resources/views/Emails/returnRequestRepairedItemsSentNotification.html.twig

Parameters:

returnRequest of which the items were sent
order of the return request

How to send an Email programmatically?¶

For sending emails Sylius is using a dedicated service - Sender. Additionally we have EmailManagers for Order Confirmation(OrderEmailManager) and for Shipment Confirmation(ShipmentEmailManager).

Tip

While using Sender you have the available emails of Sylius available under constants in:

Example using Sender:

/** @var SenderInterface $sender */
$sender = $this->container->get('sylius.email_sender');

$sender->send(\Sylius\Bundle\UserBundle\Mailer\Emails::EMAIL_VERIFICATION_TOKEN, ['sylius@example.com'], ['user' => $user, 'channel' => $channel, 'localeCode' => $localeCode]);

Example using EmailManager:

/** @var OrderEmailManagerInterface $sender */
$orderEmailManager = $this->container->get('sylius.email_manager.order');

$orderEmailManager->sendConfirmationEmail($order);

Learn more¶

Mailer - Documentation

Contact¶

The functionality of contacting the shop support/admin is in Sylius very basic. Each Channel of your shop may have a contactEmail configured on it. This will be the email address to support.

Contact form¶

The contact form can be found on the /contact route.

Note

When the contactEmail is not configured on the channel, the customer will see the following flash message:

The form itself has only two fields email (which will be filled automatically for the logged in users) and message.

ContactEmailManager¶

The ContactEmailManager service is responsible for the sending of a contact request email. It can be found under the sylius.email_manager.contact service id.

ContactController¶

The controller responsible for the request action handling is the ContactController. It has the sylius.controller.shop.contact service id.

Configuration¶

The routing for contact can be found in the Sylius/Bundle/ShopBundle/Resources/config/routing/contact.yml file. By overriding that routing you will be able to customize redirect url, error flash, success flash, form and its template.

You can also change the template of the email that is being sent by simply overriding it in your project in the templates/bundles/SyliusShopBundle/Email/contactRequest.html.twig file.

Learn more¶

Emails - Documentation

Fixtures¶

Fixtures are used mainly for testing, but also for having your shop in a certain state, having defined data - they ensure that there is a fixed environment in which your application is working.

Note

They way Fixtures are designed in Sylius is well described in the FixturesBundle documentation.

What are the available fixtures in Sylius?¶

To check what fixtures are defined in Sylius run:

php bin/console sylius:fixtures:list

How to load Sylius fixtures?¶

The recommended way to load the predefined set of Sylius fixtures is here:

php bin/console sylius:fixtures:load

What data is loaded by fixtures in Sylius?¶

All files that serve for loading fixtures of Sylius are placed in the Sylius/Bundle/CoreBundle/Fixture/* directory.

And the specified data for fixtures is stored in the Sylius/Bundle/CoreBundle/Resources/config/app/fixtures.yml file.

Available configuration options¶

locale¶

Configuration key	Function
load_default_locale	Determine if default shop locale (defined as %locale%) parameter will be loaded. True by default.
locales	Array of locale codes, which will be loaded. Empty by default.

Learn more¶

FixturesBundle documentation

Events¶

Tip

You can learn more about events in general in the Symfony documentation.

What is the naming convention of Sylius events?¶

The events that are designed for the entities have a general naming convention: sylius.entity_name.event_name.

The examples of such events are: sylius.product.pre_update, sylius.shop_user.post_create, sylius.taxon.pre_create.

Events reference¶

All Sylius bundles are using SyliusResourceBundle, which has some built-in events.

Event	Description
sylius.<resource>.pre_create	Before persist
sylius.<resource>.post_create	After flush
sylius.<resource>.pre_update	Before flush
sylius.<resource>.post_update	After flush
sylius.<resource>.pre_delete	Before remove
sylius.<resource>.post_delete	After flush
sylius.<resource>.initialize_create	Before creating view
sylius.<resource>.initialize_update	Before creating view

CRUD events rules¶

As you should already know, every resource controller is represented by the sylius.controller.<resource_name> service. Several useful events are dispatched during execution of every default action of this controller. When creating a new resource via the createAction method, 2 events occur.

First, before the persist() is called on the resource, the sylius.<resource_name>.pre_create event is dispatched.

And after the data storage is updated, sylius.<resource_name>.post_create is triggered.

The same set of events is available for the update and delete operations. All the dispatches are using the GenericEvent class and return the resource object by the getSubject method.

Checkout events rules¶

To dispatch checkout steps the events names are overloaded. See _sylius.event in src/Sylius/Bundle/ShopBundle/Resources/config/routing/checkout.yml

Event	Description
sylius.order.initialize_address	Before creating address view
sylius.order.initialize_select_shipping	Before creating shipping view
sylius.order.initialize_payment	Before creating payment view
sylius.order.initialize_complete	Before creating complete view

What events are already used in Sylius?¶

Even though Sylius has events as entry points to each resource only some of these points are already used in our usecases.

The events already used in Sylius are described in the Book alongside the concepts they concern.

Tip

What is more you can easily check all the Sylius events in your application by using this command:

php bin/console debug:event-dispatcher | grep sylius

Customizations¶

Note

Customizing logic via Events vs. State Machines

The logic in which Sylius operates can be customized in two ways. First of them is using the state machines: what is really useful when you need to modify business logic for instance modify the flow of the checkout, and the second is listening on the kernel events related to the entities, which is helpful for modifying the HTTP responses visible directly to the user, like displaying notifications, sending emails.

Learn more¶

Sylius Documentation: The Book

Configuration¶

Having knowledge about basics of our architecture we will introduce the three most important concepts - Channels, Locales and Currencies. These things have to be configured before you will have a Sylius application up and running.

Configuration¶

Having knowledge about basics of our architecture we will introduce the three most important concepts - Channels, Locales and Currencies. These things have to be configured before you will have a Sylius application up and running.

Channels¶

In the modern world of e-commerce your website is no longer the only point of sale for your goods.

Channel model represents a single sales channel, which can be one of the following things:

Webstore
Mobile application
Cashier in your physical store

Or pretty much any other channel type you can imagine.

What may differ between channels? Particularly anything from your shop configuration:

products,
currencies,
locales (language),
countries,
themes,
hostnames,
taxes,
payment and shipping methods,
menu.

A Channel has a code, a name and a color.

In order to make the system more convenient for the administrator - there is just one, shared admin panel. Also users are shared among the channels.

Tip

In the dev environment you can easily check what channel you are currently on in the Symfony debug toolbar.

Different menu root¶

By default, Sylius will render the same menu for all channels defined in the store, which will be all the children of the taxon with the code category. You can customize this behaviour by specifying a menu taxon in the “Look & feel” section of desired channel.

With this configuration, this particular channel will expose a menu starting from the children of the chosen taxon (T-Shirt taxon in this example):

_images/channel_menu_with_menu_taxon.png

Rest of the channels will still render only children of category taxon.

How to get the current channel?

You can get the current channel from the channel context.

$channel = $this->container->get('sylius.context.channel')->getChannel();

Warning

Beware! When using multiple channels, remember to configure hostname for each of them. If missing, default context would not be able to provide appropriate channel and it will result in an error.

Note

The channel is by default determined basing on the hostname, but you can customize that behaviour. To do that you have to implement the Sylius\Component\Channel\Context\ChannelContextInterface and register it as a service under the sylius.context.channel tag. Optionally you can add a priority="-64" since the default ChannelContext has a priority="-128", and by default a priority="0" is assigned.

Note

Moreover if the channel depends mainly on the request you can implement the Sylius\Component\Channel\Context\RequestBased\RequestResolverInterface with its findChannel(Request $request) method and register it under the sylius.context.channel.request_based.resolver tag.

Shop Billing Data¶

For Invoicing and Credit Memo purposes Channels are supplied with a section named Shop Billing Data, which is editable on the Channel create/update form.

Business Units¶

Sylius Plus is supplied with an enhanced version of Shop Billing Data from open source edition. It is also used for Invoicing and Refunds purposes, but it is a separate entity, that you can create outside of the Channel and then just pick a previously created Business Unit on the Channel form.

Learn more¶

Channel - Component Documentation.

Note

In order to add a new locale to your store you have to assign it to a channel.

Locales¶

To support multiple languages we are using Locales in Sylius. Locales are language codes standardized by the ISO 15897.

Tip

In the dev environment you can easily check what locale you are currently using in the Symfony debug toolbar:

Base Locale¶

During the installation you provided a default base locale. This is the language in which everything in your system will be saved in the database - all the product names, texts on website, e-mails etc.

Locale Context¶

To manage the currently used language, we use the LocaleContext. You can always access it with the ID sylius.context.locale in the container.

<?php

public function fooAction()
{
    $locale = $this->get('sylius.context.locale')->getLocaleCode();
}

The locale context can be injected into any of your services and give you access to the currently used locale.

Available Locales Provider¶

The Locale Provider service (sylius.locale_provider) is responsible for returning all languages available for the current user. By default, returns all configured locales. You can easily modify this logic by overriding this service.

<?php

public function fooAction()
{
    $locales = $this->get('sylius.locale_provider')->getAvailableLocalesCodes();

    foreach ($locales as $locale) {
        echo $locale;
    }
}

To get all languages configured in the store, regardless of your availability logic, use the locales repository:

<?php

$locales = $this->get('sylius.repository.locale')->findAll();

Learn more¶

Locale - Component Documentation.

Currencies¶

Sylius supports multiple currencies per store and makes it very easy to manage them.

There are several approaches to processing several currencies, but we decided to use the simplest solution we are storing all money values in the base currency per channel and convert them to other currencies with exchange rates.

Note

The base currency to the first channel is set during the installation of Sylius and it has the exchange rate equal to “1.000”.

Tip

In the dev environment you can easily check the base currency in the Symfony debug toolbar:

Currency Context¶

By default, user can switch the current currency in the frontend of the store.

To manage the currently used currency, we use the CurrencyContext. You can always access it through the sylius.context.currency id.

<?php

public function fooAction()
{
    $currency = $this->get('sylius.context.currency')->getCurrency();
}

Currency Converter¶

The Sylius\Component\Currency\Converter\CurrencyConverter is a service available under the sylius.currency_converter id.

It allows you to convert money values from one currency to another.

This solution is used for displaying an approximate value of price when the desired currency is different from the base currency of the current channel.

Available Currencies Provider¶

The default menu for selecting currency is using a service - CurrencyProvider - with the sylius.currency_provider id, which returns all enabled currencies. This is your entry point if you would like override this logic and return different currencies for various scenarios.

<?php

public function fooAction()
{
    $currencies = $this->get('sylius.currency_provider')->getAvailableCurrencies();
}

Switching Currency of a Channel¶

We may of course change the currency used by a channel. For that we have the sylius.storage.currency service, which implements the Sylius\Component\Core\Currency\CurrencyStorageInterface with methods ->set(ChannelInterface $channel, $currencyCode) and ->get(ChannelInterface $channel).

$container->get('sylius.storage.currency')->set($channel, 'PLN');

Displaying Currencies in the templates¶

There are some useful helpers for rendering money values in the front end. Simply import the money macros of the ShopBundle in your twig template and use the functions to display the value:

..
{% import "@SyliusShop/Common/Macro/money.html.twig" as money %}
..

<span class="price">{{ money.format(price, 'EUR') }}</span>

Sylius provides you with some handy Global Twig variables to facilitate displaying money values even more.

Learn more¶

Customers¶

This chapter will tell you more about the way Sylius handles users, customers and admins. There is also a subchapter dedicated to addresses of your customers.

Customers¶

This chapter will tell you more about the way Sylius handles users, customers and admins. There is also a subchapter dedicated to addresses of your customers.

Customer and ShopUser¶

For handling customers of your system Sylius is using a combination of two entities - Customer and ShopUser. The difference between these two entities is simple: the Customer is a guest in your shop and the ShopUser is a user registered in the system - they have an account.

Customer¶

The Customer entity was created to collect data about non-registered guests of the system - ones that has been buying without having an account or that have somehow provided us their e-mail.

How to create a Customer programmatically?¶

As usual, use a factory. The only required field for the Customer entity is email, provide it before adding it to the repository.

/** @var CustomerInterface $customer */
$customer = $this->container->get('sylius.factory.customer')->createNew();

$customer->setEmail('customer@test.com');

$this->container->get('sylius.repository.customer')->add($customer);

The Customer entity can of course hold other information besides an email, it can be for instance firstName, lastName or birthday.

Note

The relation between the Customer and ShopUser is bidirectional. Both entities hold a reference to each other.

ShopUser¶

ShopUser entity is designed for customers that have registered in the system - they have an account with both e-mail and password. They can visit and modify their account.

While creating new account the existence of the provided email in the system is checked - if the email was present - it will already have a Customer therefore the existing one will be assigned to the newly created ShopUser, if not - a new Customer will be created together with the ShopUser.

How to create a ShopUser programmatically?¶

Assuming that you have a Customer (either retrieved from the repository or a newly created one) - use a factory to create a new ShopUser, assign the existing Customer and a password via the setPlainPassword() method.

/** @var ShopUserInterface $user */
$user = $this->container->get('sylius.factory.shop_user')->createNew();

// Now let's find a Customer by their e-mail:
/** @var CustomerInterface $customer */
$customer = $this->container->get('sylius.repository.customer')->findOneBy(['email' => 'customer@test.com']);

// and assign it to the ShopUser
$user->setCustomer($customer);
$user->setPlainPassword('pswd');

$this->container->get('sylius.repository.shop_user')->add($user);

Changing the ShopUser password¶

The already set password of a ShopUser can be easily changed via the setPlainPassword() method.

$user->getPassword(); // returns encrypted password - 'pswd'

$user->setPlainPassword('resu1');
// the password will now be 'resu1' and will become encrypted while saving the user in the database

Customer related events¶

Event id	Description
`sylius.customer.post_register`	dispatched when a new Customer is registered
`sylius.customer.pre_update`	dispatched when a Customer is updated
`sylius.oauth_user.post_create`	dispatched when an OAuthUser is created
`sylius.oauth_user.post_update`	dispatched when an OAuthUser is updated
`sylius.shop_user.post_create`	dispatched when a User is created
`sylius.shop_user.post_update`	dispatched when a User is updated
`sylius.shop_user.pre_delete`	dispatched before a User is deleted
`sylius.user.email_verification.token`	dispatched when a verification token is requested
`sylius.user.password_reset.request.token`	dispatched when a reset password token is requested
`sylius.user.pre_password_change`	dispatched before user password is changed
`sylius.user.pre_password_reset`	dispatched before user password is reset
`sylius.user.security.implicit_login`	dispatched when an implicit login is done
`security.interactive_login`	dispatched when an interactive login is done

Learn more¶

User - Component Documentation

Customer Pools¶

Customer Pool is a collection of Customers that is assigned to a specific channel. Thanks to this concept, if you have two channels, each of them has a separate customer pool, then customers that have accounts in channel A, and have not registered in channel B, will not be able to log in to channel B with credentials they have specified in channel A (which is the behaviour happening in Sylius open source edition). This feature allows you to sell via multiple channels, creating a illusion of shopping in completely different stores, while you still have one administration panel.

Managing Customer Pools¶

Customer pools management is available in the administration panel in the Customers section.

New customer pools can be added through the admin UI in the section Customer pools or via fixtures, as it is configured in src/Resource/config/fixtures.yaml for the plus fixture suite.

The configuration looks like that:

sylius_fixtures:
    suites:
        default:
            fixtures:
                customer_pool:
                    priority: 1
                    options:
                        custom:
                            default:
                                name: "Default"
                                code: "default"

Customer Pool can be assigned to a Channel, but only during its _creation_ in Admin panel. Currently it is not possible to modify the User Pool after the channel is created, as it would lead to certain edge cases with customers losing access to channels, after improper admin operations.

There is also a possibility to choose a specific customer pool during channel or shop customer creation in fixtures (remember to create a customer pool before assigning it to a channel):

sylius_fixtures:
    suites:
        default:
            fixtures:
                channel:
                    options:
                        custom:
                            mobile:
                                name: "Mobile"
                                code: "mobile"
                                locales:
                                    - "en_US"
                                currencies:
                                    - "USD"
                                customer_pool: "default"
                                enabled: true
                shop_user:
                    options:
                        custom:
                            -
                                email: "plus@example.com"
                                first_name: "John"
                                last_name: "Doe"
                                password: "sylius"
                                customer_pool: "default"

How to create a Customer Pool programmatically?¶

As usual, use a factory. The only required fields for the CustomerPool entity are code and name, provide them before adding it to the repository.

/** @var CustomerPoolInterface $customerPool */
$customerPool = $this->container->get('sylius_plus.factory.customer_pool')->createNew();

$customerPool->setCode('HOME_POOL');
$customerPool->setName('Home Pool');

$this->container->get('sylius_plus.repository.customer_pool')->add($customerPool);

In order to assign a Customer Pool to a Channel programmatically use this simple trick:

// given that you have a $channel from repository, and a $customerPool just created above

$channel->setCustomerPool($customerPool);

Learn more¶

Channels - Concept Documentation

AdminUser¶

The AdminUser entity extends the User entity. It is created to enable administrator accounts that have access to the administration panel.

How to create an AdminUser programmatically?¶

The AdminUser is created just like every other entity, it has its own factory. By default it will have an administration role assigned.

/** @var AdminUserInterface $admin */
$admin = $this->container->get('sylius.factory.admin_user')->createNew();

$admin->setEmail('administrator@test.com');
$admin->setPlainPassword('pswd');

$this->container->get('sylius.repository.admin_user')->add($admin);

Administration Security¶

In Sylius by default you have got the administration panel routes (/admin/*) secured by a firewall - its configuration can be found in the security.yaml file.

Only the logged in AdminUsers are eligible to enter these routes.

Access Control via Administrator Roles (ACL/RBAC)¶

RBAC (Role Based Access Control) or ACL (Access Control Layer) is an approach to restricting system access for users using roles system. It is required by the majority of companies on the enterprise level, thus it is provided in the Sylius Plus edition.

A Role is a set of permissions to perform certain operations within the system, which is assigned to a chosen Administrator.

In Sylius Plus implementation of this system, we are basing on routing to determine what kind of permissions are there to be assigned. This allows us to for example give a role access to only show actions of a chosen entity (like Products or Orders).

It is important to know that one Administrator can have multiple roles assigned.

The RBAC system in Sylius Plus let’s you also to temporarily disable the Permission Checker for a chosen Administrator.

Tip

You can disable permission checker for administrator not only via the UI, but also with a Symfony command:

bin/console sylius-plus-rbac:disable-admin-permission-checker <email>

The Sylius Plus fixture suite provides a few roles as examples on how you can shape the roles in your system:

SUPER_ADMIN with access to everything including roles management
PRODUCT_MANAGER with access to product catalog management with inventory, associations, options, taxons etc.
FULFILLMENT_WORKER with access to order management, product catalog show, inventory management and shipments

Customizing the permissions tree¶

How to add a new permission?¶

Let’s assume that you would like to add a new permission to ACL. You will need to add these few lines to the config.yml:

# config/packages/_sylius.yaml
# ...

sylius_plus:
    permissions:
        # Each permission must have a unique id, if you want the route to be protected, as id you need to enter the name route.
        app_admin_product_import:
            parent: data_transfer # Here, specify parent in the permission tree.
            label: product_import # Here, specify the name that will be displayed in the admin panel.
            enabled: true # Here you specify whether the permission is to be active, this field is not required, by default is set to true.

You can also add permission while defining the route. However, this will not work when you have defined or imported permissions with the same id in the config.yml:

# config/routes/sylius_admin.yaml
# ...

app_admin_product_import:
    path: /admin/products/import
    methods: [GET]
    defaults:
        _sylius_plus_rbac:
            parent: data_transfer
            label: product_import
            enabled: true

For this permission you will need to add translations:

sylius_plus.rbac.parent.data_transfer
sylius_plus.rbac.action.product_import

How to modify a permission?¶

If you would like to modify an existing permission of for example the permission to payment complete:

# config/packages/_sylius.yaml
# ...

sylius_plus:
    permissions:
        sylius_admin_order_payment_complete:
            parent: orders_shop
            label: order_payment_complete

You can also modify the permission on the route is overwritten, only this will not work when you have defined or imported permissions with the same id in config.yml:

# config/routes/sylius_admin.yaml
# ...

sylius_admin_order_payment_complete:
    path: /admin/orders/{orderId}/payments/{id}/complete
    methods: [PUT]
    defaults:
        # ...

        _sylius_plus_rbac:
            parent: orders_shop
            label: order_payment_complete

You can find the default configuration of some permissions in the src/Resources/config/permissions.yaml file.

How to delete a permission?¶

If you want to remove a permission, you have to overwrite the permission configuration and and set the enabled field to false:

# config/packages/_sylius.yaml
# ...

sylius_plus:
    permissions:
        sylius_admin_order_payment_complete:
            enabled: false

or for overwriting a route, although this will not work when you have defined or imported permissions with the same id in the config.yml:

# config/routes/sylius_admin.yaml
# ...

sylius_admin_order_payment_complete:
    path: /admin/orders/{orderId}/payments/{id}/complete
    methods: [PUT]
    defaults:
        # ...

        _sylius_plus_rbac:
            enabled: false

“Access denied” view customization¶

When an administrator does not have access to a given route, the Twig’s path() and url() functions will return ACCESS_DENIED. You can adjust the view using the css and javascript selectors. For example:

a[href="ACCESS_DENIED"].button {
   display: none !important;
}

More examples can be found in the src/Resources/public/* path.

You can also use a twig function:

{% if sylius_plus_rbac_has_permission("sylius_admin_order_payment_complete") %}
    {# ... #}

{% endif %}

Administrators per Channel¶

It is a possible to choose a channel to which an Administrator has access. It is done on the Administrator’s configuration page. If a channel is not chosen on an Administrator then they will have access to all channels.

Having chosen a channel on an Administrator, their access will get restricted within the Sales section of the main menu in the Admin Panel. Thus they will see only orders, payments, shipments, return requests, invoices and credit memos from the channel they have access to.

Additional Admin User Fixtures¶

Three new fields have been added to the Admin User fixtures: channel, roles and enable_permission_checker. They can be configured as below:

sylius_fixtures:
    suites:
        default:
            fixtures:
                channel:
                    options:
                        custom:
                             -   email: 'sylius@example.com'
                                 username: 'sylius'
                                 password: 'sylius'
                                 channel: 'DEFAULT_CHANNEL_CODE'
                                 roles:
                                     - 'SUPER_ADMIN_CODE'
                                 enable_permission_checker: true

Learn more¶

Customer & ShopUser - Documentation

Addresses¶

Countries¶

Countries are a part of the Addressing concept. The Country entity represents a real country that your shop is willing to sell its goods in (for example the UK). It has an ISO code to be identified easily (ISO 3166-1 alpha-2).

Countries might also have Provinces, which is in fact a general name for an administrative division, within a country. Therefore we understand provinces as states of the USA, voivodeships of Poland, cantons of Belgium or Bundesländer of Germany.

How to add a country?¶

To give you a better insight into Countries, let’s have a look on how to prepare and add a Country to the system programmatically. We will do it with a province at once.

You will need factories for countries and provinces in order to create them:

/** @var CountryInterface $country */
$country = $this->container->get('sylius.factory.country')->createNew();

/** @var ProvinceInterface $province */
$province = $this->container->get('sylius.factory.province')->createNew();

To the newly created objects assign codes.

// US - the United States of America
$country->setCode('US');
// US_CA - California
$province->setCode('US_CA');

Provinces may be added to a country via a collection. Create one and add the province object to it and using the prepared collection add the province to the Country.

$provinces = new ArrayCollection();
$provinces->add($province);

$country->setProvinces($provinces);

You can of course simply add single province:

$country->addProvince($province);

Finally you will need a repository for countries to add the country to your system.

/** @var RepositoryInterface $countryRepository */
$countryRepository = $this->get('sylius.repository.country');

$countryRepository->add($country);

From now on the country will be available to use in your system.

Learn more¶

Zones¶

Zones are a part of the Addressing concept.

Zones and ZoneMembers¶

Zones consist of ZoneMembers. It can be any kind of zone you need - for instance if you want to have all the EU countries in one zone, or just a few chosen countries that have the same taxation system in one zone, or you can even distinguish zones by the ZIP code ranges in the USA.

Three different types of zones are available:

country zone, which consists of countries.
province zone, which is constructed from provinces.
zone, which is a group of other zones.

How to add a Zone?¶

Let’s see how you can add a Zone to your system programmatically.

Firstly you will need a factory for zones - There is a specific one.

/** @var ZoneFactoryInterface $zoneFactory */
$zoneFactory = $this->container->get('sylius.factory.zone');

Using the ZoneFactory create a new zone with its members. Let’s take the UK as an example.

/** @var ZoneInterface $zone */
$zone = $zoneFactory->createWithMembers(['GB_ENG', 'GB_NIR', 'GB_SCT'. 'GB_WLS']);

Now give it a code, name and type:

$zone->setCode('GB');
$zone->setName('United Kingdom');
// available types are the type constants from the ZoneInterface
$zone->setType(ZoneInterface::TYPE_PROVINCE);

Finally get the zones repository from the container and add the newly created zone to the system.

/** @var RepositoryInterface $zoneRepository */
$zoneRepository = $this->container->get('sylius.repository.zone');

$zoneRepository->add($zone);

Matching a Zone¶

Zones are not very useful alone, but they can be a part of a complex taxation/shipping or any other system. A service implementing the ZoneMatcherInterface is responsible for matching the Address to a specific Zone.

/** @var ZoneMatcherInterface $zoneMatcher */
$zoneMatcher = $this->get('sylius.zone_matcher');
$zone = $zoneMatcher->match($user->getAddress());

ZoneMatcher can also return all matching zones. (not only the most suitable one)

/** @var ZoneMatcherInterface $zoneMatcher */
$zoneMatcher = $this->get('sylius.zone_matcher');
$zones = $zoneMatcher->matchAll($user->getAddress());

Internally, Sylius uses this service to define the shipping and billing zones of an Order, but you can use it for many different things and it is totally up to you.

Learn more¶

Addresses¶

Every address in Sylius is represented by the Address model. It has a few important fields:

firstName
lastName
phoneNumber
company
countryCode
provinceCode
street
city
postcode

Note

The Address has a relation to a Customer - which is really useful during the Checkout addressing step.

How to create an Address programmatically?¶

In order to create a new address, use a factory. Then complete your address with required data.

/** @var AddressInterface $address */
$address = $this->container->get('sylius.factory.address')->createNew();

$address->setFirstName('Harry');
$address->setLastName('Potter');
$address->setCompany('Ministry of Magic');
$address->setCountryCode('UK');
$address->setProvinceCode('UKJ');
$address->setCity('Little Whinging');
$address->setStreet('4 Privet Drive');
$address->setPostcode('000001');

// and finally having the address you can assign it to any Order
$order->setShippingAddress($address);

Learn more¶

Address Book¶

The Address Book concept is a very convenient solution for the customers of your shop, that come back. Once they provide an address it is saved in the system and can be reused the next time.

Sylius handles the address book in a not complex way:

The Addresses Collection on a Customer¶

On the Customer entity we are holding a collection of addresses:

class Customer {
    /**
     * @var Collection|AddressInterface[]
     */
    protected $addresses;
}

We can operate on it as usual - by adding and removing objects.

Besides the Customer entity has a default address field that is the default address used both for shipping and billing, the one that will be filling the form fields by default.

How to add an address to the address book manually?¶

If you would like to add an address to the collection of Addresses of a chosen customer that’s all what you should do:

Create a new address:

/** @var AddressInterface $address */
$address = $this->container->get('sylius.factory.address')->createNew();

$address->setFirstName('Ronald');
$address->setLastName('Weasley');
$address->setCompany('Ministry of Magic');
$address->setCountryCode('UK');
$address->setProvinceCode('UKJ');
$address->setCity('Otter St Catchpole');
$address->setStreet('The Burrow');
$address->setPostcode('000001');

Then find a customer to which you would like to assign it, and add the address.

$customer = $this->container->get('sylius.repository.customer')->findOneBy(['email' => 'ron.weasley@magic.com']);

$customer->addAddress($address);

Remember to flush the customer’s manager to save this change.

$this->container->get('sylius.manager.customer')->flush();

Learn more¶

Products¶

This is a guide to understanding products handling in Sylius together with surrounding concepts. Read about Associations, Reviews, Attributes, Taxons etc.

Products¶

This is a guide to understanding products handling in Sylius together with surrounding concepts.

Products¶

Product model represents unique products in your Sylius store. Every product can have different variations and attributes.

Warning

Each product has to have at least one variant to be sold in the shop.

How to create a Product?¶

Before we learn how to create products that can be sold, let’s see how to create a product without its complex dependencies.

/** @var ProductFactoryInterface $productFactory **/
$productFactory = $this->get('sylius.factory.product');

/** @var ProductInterface $product */
$product = $productFactory->createNew();

Creating an empty product is not enough to save it in the database. It needs to have a name, a code and a slug.

$product->setName('T-Shirt');
$product->setCode('00001');
$product->setSlug('t-shirt');

/** @var RepositoryInterface $productRepository */
$productRepository = $this->get('sylius.repository.product');

$productRepository->add($product);

After being added via the repository, your product will be in the system. But the customers won’t be able to buy it.

Variants¶

ProductVariant represents a unique kind of product and can have its own pricing configuration, inventory tracking etc.

Variants may be created out of Options of the product, but you are also able to use product variations system without the options at all.

Virtual Product Variants, that do not require shipping¶

Tip

On the ProductVariant there is a possibility to make a product virtual - by setting its shippingRequired property to false. In such a way you can have products that will be downloadable or installable for instance.

How to create a Product with a Variant?¶

You may need to sell product in different Variants - for instance you may need to have books both in hardcover and in paperback. Just like before, use a factory, create the product, save it in the Repository. And then using the ProductVariantFactory create a variant for your product.

/** @var ProductVariantFactoryInterface $productVariantFactory **/
$productVariantFactory = $this->get('sylius.factory.product_variant');

/** @var ProductVariantInterface $productVariant */
$productVariant = $productVariantFactory->createNew();

Having created a Variant, provide it with the required attributes and attach it to your Product.

$productVariant->setName('Hardcover');
$productVariant->setCode('1001');
$productVariant->setPosition(1);
$productVariant->setProduct($product);

Finally save your Variant in the database using a repository.

/** @var RepositoryInterface $productVariantRepository */
$productVariantRepository = $this->get('sylius.repository.product_variant');

$productVariantRepository->add($productVariant);

Options¶

In many cases, you will want to have product with different variations. The simplest example would be a piece of clothing, like a T-Shirt available in different sizes and colors or a glass available in different shapes or colors. In order to automatically generate appropriate variants, you need to define options.

Every option type is represented by ProductOption and references multiple ProductOptionValue entities.

For example you can have two options - Size and Color. Each of them will have their own values.

Size
- S
- M
- L
- XL
- XXL
Color
- Red
- Green
- Blue

After defining possible options for a product let’s move on to Variants which are in fact combinations of options.

How to create a Product with Options and Variants?¶

Firstly let’s learn how to prepare an exemplary Option and its values.

/** @var ProductOptionInterface $option */
$option = $this->get('sylius.factory.product_option')->createNew();
$option->setCode('t_shirt_color');
$option->setName('T-Shirt Color');

// Prepare an array with values for your option, with codes, locale code and option values.
$valuesData = [
    'OV1' => ['locale' => 'en_US', 'value' => 'Red'],
    'OV2' => ['locale' => 'en_US', 'value' => 'Blue'],
    'OV3' => ['locale' => 'en_US', 'value' => 'Green'],
];

foreach ($valuesData as $code => $values) {
    /** @var ProductOptionValueInterface $optionValue */
    $optionValue = $this->get('sylius.factory.product_option_value')->createNew();

    $optionValue->setCode($code);
    $optionValue->setFallbackLocale($values['locale']);
    $optionValue->setCurrentLocale($values['locale']);
    $optionValue->setValue($values['value']);

    $option->addValue($optionValue);
}

After you have an Option created and you keep it as $option variable let’s add it to the Product and generate Variants.

// Assuming that you have a basic product let's add the previously created option to it.
$product->addOption($option);

// Having option of a product you can generate variants. Sylius has a service for that operation.
/** @var ProductVariantGeneratorInterface $variantGenerator */
$variantGenerator = $this->get('sylius.generator.product_variant');

$variantGenerator->generate($product);

// And finally add the product, with its newly generated variants to the repository.
/** @var RepositoryInterface $productRepository */
$productRepository = $this->get('sylius.repository.product');

$productRepository->add($product);

Learn more:¶

Product Reviews¶

Product Reviews are a marketing tool that let your customers give opinions about the products they buy in your shop. They have a rating and comment.

Rating¶

The rating of a product review is required and must be between 1 and 5.

Product review state machine¶

When you look inside the CoreBundle/Resources/config/app/state_machine/sylius_product_review.yml you will find out that a Review can have 3 different states:

new,
accepted,
rejected

There are only two possible transitions: accept (from new to accepted) and reject (from new to rejected).

When a review is accepted the average rating of a product is updated.

How is the average rating calculated?¶

The average rating is updated by the AverageRatingUpdater service.

It wraps the AverageRatingCalculator, and uses it inside the updateFromReview method.

How to add a ProductReview programmatically?¶

Create a new review using a factory:

/** @var ReviewInterface $review */
$review = $this->container->get('sylius.factory.product_review')->createNew();

Fill the content of your review.

$review->setTitle('My Review');
$review->setRating(5);
$review->setComment('This product is really great');

Then get a customer from the repository, which you would like to make an author of this review.

$customer = $this->container->get('sylius.repository.customer')->findOneBy(['email' => 'john.doe@test.com']);

$review->setAuthor($customer);

Remember to set the object that is the subject of your review and then add the review to the repository.

$review->setReviewSubject($product);

$this->container->get('sylius.repository.product_review')->add($review);

Learn more¶

Product Associations¶

Associations of products can be used as a marketing tool for suggesting your customers, what products to buy together with the one they are currently considering. Associations can increase your shop’s efficiency. You choose what strategy you prefer. They are fully configurable.

Association Types¶

The type of an association can be different. If you sell food you can suggest inspiring ingredients, if you sell products for automotive you can suggest buying some tools that may be useful for a home car mechanic. Exemplary association types can be: up-sell, cross-sell, accessories, alternatives and whatever you imagine.

How to create a new Association Type?¶

Create a new Association Type using a dedicated factory. Give the association a code and a name to easily recognize the type.

/** @var ProductAssociationTypeInterface $associationType */
$associationType = $this->container->get('sylius.factory.product_association_type')->createNew();

$associationType->setCode('accessories');
$associationType->setName('Accessories');

To have the new association type in the system add it to the repository.

$this->container->get('sylius.repository.product_association_type')->add($associationType);

How to add a new Association to a Product?¶

Find in your system a product to which you would like to add an association. We will use a Go Pro camera as an example.

$product = $this->container->get('sylius.repository.product')->findOneBy(['code' => 'go-pro-camera']);

Next create a new Association which will connect our camera with its accessories. Such an association needs the AssociationType we have created in the previous step above.

/** @var ProductAssociationInterface $association */
$association = $this->container->get('sylius.factory.product_association')->createNew();

/** @var ProductAssociationTypeInterface $associationType */
$associationType = $this->container->get('sylius.repository.product_association_type')->findOneBy(['code' => 'accessories']);

$association->setType($associationType);

Let’s add all products from a certain taxon to the association we have created. To do that find a desired taxon by code and get all its products. Perfect accessories for a camera will be SD cards.

/** @var TaxonInterface $taxon */
$taxon = $this->container->get('sylius.repository.taxon')->findOneBy(['code' => 'sd-cards']);

$associatedProducts = $this->container->get('sylius.repository.product')->findByTaxon($taxon);

Having a collection of products from the SD cards taxon iterate over them and add them one by one to the association.

foreach ($associatedProducts as $associatedProduct) {
    $association->addAssociatedProduct($associatedProduct);
}

Finally add the created association with SD cards to our Go Pro camera product.

$product->addAssociation($association);

And to save everything in the database you need to add the created association to the repository.

$this->container->get('sylius.repository.product_association')->add($association);

In the previous example we used a custom query in the product repository, here is the implementation:

use Sylius\Bundle\CoreBundle\Doctrine\ORM\ProductRepository as BaseProductRepository;

class ProductRepository extends BaseProductRepository
{
    public function findByTaxon(Taxon $taxon): array
    {
        return $this->createQueryBuilder('p')
            ->join('p.productTaxons', 'pt')
            ->where('pt.taxon = :taxon')
            ->setParameter('taxon', $taxon)
            ->getQuery()
            ->getResult()
         ;
    }
}

Learn more:¶

Product - Concept Documentation

Attributes¶

Attributes in Sylius are used to describe traits shared among entities. The best example are products, that may be of the same category and therefore they will have many similar attributes such as number of pages for a book, brand of a T-shirt or simply details of any product.

Attribute¶

The Attribute model has a translatable name (like for instance Book pages), code (book_pages) and type (integer). There are a few available types of an Attribute:

text (default)
checkbox
integer
percent
textarea
date
datetime
select

What these types may be useful for?

text - brand of a T-Shirt
checkbox - show whether a T-Shirt is made of cotton or not
integer - number of elements when a product is a set of items.
percent - show how much cotton is there in a piece of clothing
textarea - display more detailed information about a product
date - release date of a movie
datetime - accurate date and time of an event
select - genre(s) of a book. one or more of them can be selected

Non-translatable attribute¶

Some attributes (dates, author name) don’t need a different value in each locale. For those attributes, we introduced the possibility to disable translation. Shop Owner declares values only once and regardless of the chosen locale customer will see a proper attribute value.

Warning

Once the attribute has disabled translatability it will erase attribute values in all locales for this attribute.

How to create an Attribute?¶

To give you a better insight into Attributes, let’s have a look how to prepare and add an Attribute with a Product to the system programatically.

To assign Attributes to Products firstly you will need a factory for ProductAttributes. The AttributeFactory has a special method createTyped($type), where $type is a string.

The Attribute needs a code and a name before it can be saved in the repository.

/** @var AttributeFactoryInterface $attributeFactory */
$attributeFactory = $this->container->get('sylius.factory.product_attribute');

/** @var AttributeInterface $attribute */
$attribute = $attributeFactory->createTyped('text');

$attribute->setName('Book cover');
$attribute->setCode('book_cover');

$this->container->get('sylius.repository.product_attribute')->add($attribute);

In order to assign value to your Attribute you will need a factory of ProductAttributeValues, use it to create a new value object.

/** @var FactoryInterface $attributeValueFactory */
$attributeValueFactory = $this->container->get('sylius.factory.product_attribute_value');

/** @var AttributeValueInterface $hardcover */
$hardcover = $attributeValueFactory->createNew();

Attach the new AttributeValue to your Attribute and set its value, which is what will be rendered in frontend.

$hardcover->setAttribute($attribute);

$hardcover->setValue('hardcover');

Finally let’s find a product that will have your newly created attribute.

/** @var ProductInterface $product */
$product = $this->container->get('sylius.repository.product')->findOneBy(['code' => 'code']);

$product->addAttribute($hardcover);

Now let’s see what has to be done if you would like to add an attribute of integer type. Let’s find such a one in the repository, it will be for example the BOOK-PAGES attribute.

/** @var AttributeInterface $bookPagesAttribute */
$bookPagesAttribute = $this->container->get('sylius.repository.product_attribute')->findOneBy(['code' => 'BOOK-PAGES']);

/** @var AttributeValueInterface $pages */
$pages = $attributeValueFactory->createNew();

$pages->setAttribute($bookPagesAttribute);

$pages->setValue(500);

$product->addAttribute($pages);

After adding attributes remember to flush the product manager.

$this->container->get('sylius.manager.product')->flush();

Your Product will now have two Attributes.

Learn more¶

Attribute - Component Documentation

Pricing¶

Pricing is a part of Sylius responsible for providing the product prices per channel.

Note

All prices in Sylius are saved in the base currency of each channel separately.

Currency per Channel¶

As you already know Sylius operates on Channels.

Each channel has a base currency in which all prices are saved.

Note

Whenever you operate on concepts that have specified values per channel (like ProductVariant’s price, Promotion’s fixed discount etc.)

Exchange Rates¶

Each currency defined in the system should have an ExchangeRate configured.

ExchangeRate is a separate entity that holds a relation between two currencies and specifies their exchange rate.

Exchange rates are used for viewing the approximate price in a currency different from the base currency of a channel.

Learn more¶

Taxons¶

We understand Taxons in Sylius as you would normally define categories. Sylius gives you a possibility to categorize your products in a very flexible way, which is one of the most vital functionalities of the modern e-commerce systems. The Taxons system in Sylius works in a hierarchical way. Let’s see exemplary categories trees:

Category
 |
 |\__ Clothes
 |         \_ T-Shirts
 |          \_ Shirts
 |           \_ Dresses
 |            \_ Shoes
 |
 \__ Books
         \_ Fantasy
          \_ Romance
           \_ Adventure
            \_ Other

Gender
 |
 \_ Male
  \_ Female

How to create a Taxon?¶

As always with Sylius resources, to create a new object you need a factory. If you want to create a single, not nested category:

/** @var FactoryInterface $taxonFactory */
$taxonFactory = $this->get('sylius.factory.taxon');

/** @var TaxonInterface $taxon */
$taxon = $taxonFactory->createNew();

$taxon->setCode('category');
$taxon->setName('Category');

But if you want to have a tree of categories, create another taxon and add it as a child to the previously created one.

/** @var TaxonInterface $childTaxon */
$childTaxon = $taxonFactory->createNew();

$childTaxon->setCode('clothes');
$childTaxon->setName('Clothes');

$taxon->addChild($childTaxon);

Finally the parent taxon has to be added to the system using a repository, all its child taxons will be added with it.

/** @var TaxonRepositoryInterface $taxonRepository */
$taxonRepository = $this->get('sylius.repository.taxon');

$taxonRepository->add($taxon);

How to assign a Taxon to a Product?¶

In order to categorize products you will need to assign your taxons to them - via the addProductTaxon() method on Product.

/** @var ProductInterface $product */
$product = $this->container->get('sylius.factory.product')->createNew();
$product->setCode('product_test');
$product->setName('Test');

/** @var TaxonInterface $taxon */
$taxon = $this->container->get('sylius.factory.taxon')->createNew();
$taxon->setCode('food');
$taxon->setName('Food');

/** @var RepositoryInterface $taxonRepository */
$taxonRepository = $this->container->get('sylius.repository.taxon');
$taxonRepository->add($taxon);


/** @var ProductTaxonInterface $productTaxon */
$productTaxon = $this->container->get('sylius.factory.product_taxon')->createNew();
$productTaxon->setTaxon($taxon);
$productTaxon->setProduct($product);

$product->addProductTaxon($productTaxon);

/** @var EntityManagerInterface $productManager */
$productManager = $this->container->get('sylius.manager.product');

$productManager->persist($product);
$productManager->flush();

What is the mainTaxon of a Product?¶

The product entity in Sylius core has a field mainTaxon. This field is used, for instance, for breadcrumbs generation. But you can also use it for your own logic, like for instance links generation.

To set it on your product you need to use the setMainTaxon() method.

Learn more¶

Inventory¶

Sylius leverages a very simple approach to inventory management. The current stock of an item is stored on the ProductVariant entity as the onHand value.

InventoryUnit¶

InventoryUnit has a relation to a Stockable on it, in case of Sylius Core it will be a relation to the ProductVariant that implements the StockableInterface on the OrderItemUnit that implements the InventoryUnitInterface.

It represents a physical unit of the product variant that is in the shop.

Inventory On Hold¶

Putting inventory items onHold is a way of reserving them before the customer pays for the order. Items are put on hold when the checkout is completed.

Tip

Putting items onHold does not remove them from onHand yet. If a customer buys 2 tracked items out of 5 being in the inventory (5 onHand), after the checkout there will be 5 onHand and 2 onHold.

Availability Checker¶

There is a service that will help you check the availability of items in the inventory - AvailabilityChecker.

It has two methods isStockAvailable (is there at least one item available) and isStockSufficient (is there a given amount of items available).

Tip

There are two respective twig functions for checking inventory: sylius_inventory_is_available and sylius_inventory_is_sufficient.

OrderInventoryOperator¶

Inventory Operator is the service responsible for managing the stock amounts of every ProductVariant on an Order with the following methods:

hold - is called when the order’s checkout is completed, it puts the inventory units onHold, while still not removing them from onHand,
sell - is called when the order’s payment are assigned with the state paid. The inventory items are then removed from onHold and onHand,
release - is a way of making onHold items of an order back to only onHand,
giveBack - is a way of returning sold items back to the inventory onHand,
cancel - this method works both when the order is paid and unpaid. It uses both giveBack and release methods.

How does Inventory work on examples?¶

Tip

You can see all use cases we have designed in Sylius in our Behat scenarios for inventory.

Learn more¶

Multi-Source Inventory¶

Sylius Plus has a much more complex approach to inventory management than the open source version. Unlike the open source version, that allows to specify one stock amount value for each variant, the Sylius Plus Multi-Source Inventory gives you a possibility to create several Inventory Sources and specify different stock amounts of variants for different Inventory Sources.

Admin can create multiple Inventory Sources (IS). For each IS they can choose Channels it will be available for. Let’s say you have 2 channels - “DACH” and “France”, and you have three magazines in Paris, in Berlin, and in Vienna, so you’d probably want the “France” channel to be fulfilled from the Parisian magazine only.

The experience for the Customer is seamless, they are not aware of multiple magazines, their orders are fulfilled just like it was. As an Administrator, you will additionally see which Inventory Source was chosen for the Order’s shipment to be fulfilled from. The system is prepared to be supporting shipments splitting on one order and fulfilling from multiple magazines in the near future.

Inventory Source¶

Inventory Source is the place from which a shipment of an order will be shipped from, it can be understood as a magazine, a fulfillment centre, physical store etc.

Administrators can add, modify and remove Inventory Sources in the admin panel.

Each IS has its own inventory management page, where you can manage stock levels of all items available int his inventory.

_images/inventory_source_stock_management.png

In order to make a product tracked within an Inventory Source, you have to go to it’s ProductVariant’s Inventory tab on the edit page.

_images/product_variant_stock_management.png

After an Order with tracked products is placed you will see from which IS its Shipment should be shipped.

InventorySourceStock on ProductVariant¶

Each simple Product and each Product Variant of a configurable Product can have stock in the Inventory Sources available for channels the product is available in. You can specify stocks on products and then manage them also in the Inventory section, where you will see the inventory of each IS separately.

inventorySourceStock is a property that behaves exactly like the stockAmount field you know from open source single-source inventory, so it has both onHand and onHold values that are modified when Orders are placed and fulfilled in your shop.

The tracking of a Product can be disabled.

Inventory Source resolving¶

The current implementation provides one main resolver, that can use multiple inventory sources filters.

There are two filters provided by default:

Sufficient, with priority = 0, that provides all inventory sources able to handle all ordered products;
EnabledChannel, with priority = 8, that provides inventory sources enabled for the current channel;

Filters always return an array of inventory sources, however resolver picks the first of them or throws an UnresolvedInventorySource exception if no inventory source can be resolved.

It’s possible to add more inventory sources filter, with higher or lower priority. Such a service must implement SyliusPlusInventoryApplicationFilterInventorySourcesFilterInterface and be registered with sylius_plus.inventory.inventory_sources_filter tag, with priority attribute set.

Note

How to create a custom Inventory Sources Filter? Read this Cookbook.

Resolving InventorySourceStock for ordered products¶

Warning

Standard Sylius distribution is releasing a stock inventory when the whole order is paid, while in Plus version, it has been switched to be released after shipment has been shipped.

How does Multi-Source Inventory work on examples?¶

Tip

You can see all use cases we have designed in Sylius Plus by browsing the Behat scenarios for inventory in the vendor package after installing Sylius Plus.

Multi-source inventory fixtures¶

Inventory Sources fixtures¶

This fixture creates Inventory Sources without products (empty) enabled in chosen channels:

hamburg_warehouse:
   code: 'hamburg_warehouse'
   name: 'Hamburg Warehouse'
   channels:
      - 'HOME_WEB'
      - 'FASHION_WEB'

Inventory Source Stocks fixtures¶

This fixture adds inventory source stock to chosen Inventory Source, you can choose which taxons and channels you want to include in each inventory source.

When declaring both options, a union of sets will be resolved.

stocks_in_frankfurt_warehouse:
    inventory_source: 'frankfurt_warehouse'
    products_from:
        taxons_codes:
            - 'caps'
            - 'dresses'
        channels_codes:
            - 'HOME_WEB'
            - 'FASHION_WEB'

Learn more¶

Search¶

Having a products search functionality in an eCommerce system is a very popular use case. Sylius provides a products search functionality that is a grid filter.

Grid filters¶

For simple use cases of products search use the filters of grids. For example, the shop’s categories each have a search filter in the products grid:

# Sylius/Bundle/ShopBundle/Resources/config/grids/product.yml
filters:
    search:
        type: string
        label: false
        options:
            fields: [translation.name]
        form_options:
            type: contains

It searches by product names that contains a string that the user typed in the search bar.

The search bar looks like below:

ElasticSearch¶

When the grids filtering is not enough for you, and your needs are more complex you should go for the ElasticSearch integration.

There is the BitBagCommerce/SyliusElasticsearchPlugin integration extension, which you can use to extend Sylius functionalities with ElasticSearch.

All you have to do is require the plugin in your project via composer, install the ElasticSearch server, and configure ElasticSearch in your application. Everything is well described in the BitBagCommerce/SyliusElasticsearchPlugin’s readme.

Learn more¶

Carts & Orders¶

In this chapter you will learn everything you need to know about orders in Sylius. This concept comes together with a few additional ones, like promotions, payments, shipments or checkout in general.

You should also have a look here if you are looking for Cart, which is in Sylius an Order in the cart state.

Carts & Orders¶

In this chapter you will learn everything you need to know about orders in Sylius. This concept comes together with a few additional ones, like promotions, payments, shipments or checkout in general.

Warning

Cart in Sylius is in fact an Order in the state cart.

Orders¶

Order model is one of the most important in Sylius, where many concepts of e-commerce meet. It represents an order that can be either placed or in progress (cart).

Order holds a collection of OrderItem instances, which represent products from the shop, as its physical copies, with chosen variants and quantities.

Each Order is assigned to the channel in which it has been created as well as the language the customer was using while placing the order. The order currency code will be the base currency of the current channel by default.

How to create an Order programmatically?¶

To programmatically create an Order you will of course need a factory.

/** @var FactoryInterface $orderFactory */
$orderFactory = $this->container->get('sylius.factory.order');

/** @var OrderInterface $order */
$order = $orderFactory->createNew();

Then get a channel to which you would like to add your Order. You can get it from the context or from the repository by code for example.

/** @var ChannelInterface $channel */
$channel = $this->container->get('sylius.context.channel')->getChannel();

$order->setChannel($channel);

Next give your order a locale code.

/** @var string $localeCode */
$localeCode = $this->container->get('sylius.context.locale')->getLocaleCode();

$order->setLocaleCode($localeCode);

And a currency code:

$currencyCode = $this->container->get('sylius.context.currency')->getCurrencyCode();

$order->setCurrencyCode($currencyCode);

What is more the proper Order instance should also have the Customer assigned. You can get it from the repository by email.

/** @var CustomerInterface $customer */
$customer = $this->container->get('sylius.repository.customer')->findOneBy(['email' => 'shop@example.com']);

$order->setCustomer($customer);

A very important part of creating an Order is adding OrderItems to it. Assuming that you have a Product with a ProductVariant assigned already in the system:

/** @var ProductVariantInterface $variant */
$variant = $this->container->get('sylius.repository.product_variant')->findOneBy([]);

// Instead of getting a specific variant from the repository
// you can get the first variant of off a product by using $product->getVariants()->first()
// or use the **VariantResolver** service - either the default one or your own.
// The default product variant resolver is available at id - 'sylius.product_variant_resolver.default'

/** @var OrderItemInterface $orderItem */
$orderItem = $this->container->get('sylius.factory.order_item')->createNew();
$orderItem->setVariant($variant);

In order to change the amount of items use the OrderItemQuantityModifier.

$this->container->get('sylius.order_item_quantity_modifier')->modify($orderItem, 3);

You can also change maximum order item quantity parameter in config/services.xml.

<!-- config/services.xml -->
<parameters>
    <parameter key="sylius.order_item_quantity_modifier.limit">9999</parameter> # by default it is 9999
</parameters>

Add the item to the order. And then call the CompositeOrderProcessor on the order to have everything recalculated.

$order->addItem($orderItem);

$this->container->get('sylius.order_processing.order_processor')->process($order);

Note

This CompositeOrderProcessor is one of the most powerful concepts. It handles whole order calculation logic and allows for really granular operations over the order. It is called multiple times in the checkout process, and internally it works like this:

Finally you have to save your order using the repository.

/** @var OrderRepositoryInterface $orderRepository */
$orderRepository = $this->container->get('sylius.repository.order');

$orderRepository->add($order);

The Order State Machine¶

Order has also its own state, which can have the following values:

cart - before the checkout is completed, it is the initial state of an Order,
new - when checkout is completed the cart is transformed into a new order,
fulfilled - when the order payments and shipments are completed,
cancelled - when the order was cancelled.

Tip

The state machine of order is an obvious extension to the state machine of checkout.

Shipments of an Order¶

An Order in Sylius holds a collection of Shipments on it. Each shipment in that collection has its own shipping method and has its own state machine. This lets you divide an order into several different shipments that have own shipping states (like sending physical objects via DHL and sending a link to downloadable files via e-mail).

Tip

If you are not familiar with the shipments concept check the documentation.

State machine of Shipping in an Order¶

How to add a Shipment to an Order?¶

You will need to create a shipment, give it a desired shipping method and add it to the order. Remember to process the order using order processor and then flush the order manager.

/** @var ShipmentInterface $shipment */
$shipment = $this->container->get('sylius.factory.shipment')->createNew();

$shipment->setMethod($this->container->get('sylius.repository.shipping_method')->findOneBy(['code' => 'UPS']));

$order->addShipment($shipment);

$this->container->get('sylius.order_processing.order_processor')->process($order);
$this->container->get('sylius.manager.order')->flush();

Shipping costs of an Order¶

Shipping costs of an order are stored as Adjustments. When a new shipment is added to a cart the order processor assigns a shipping adjustment to the order that holds the cost.

Shipping a Shipment with a state machine transition¶

Just like in every state machine you can execute its transitions manually. To ship a shipment of an order you have to apply two transitions request_shipping and ship.

$stateMachineFactory = $this->container->get('sm.factory');

$stateMachine = $stateMachineFactory->get($order, OrderShippingTransitions::GRAPH);
$stateMachine->apply(OrderShippingTransitions::TRANSITION_REQUEST_SHIPPING);
$stateMachine->apply(OrderShippingTransitions::TRANSITION_SHIP);

$this->container->get('sylius.manager.order')->flush();

After that the shippingState of your order will be shipped.

Payments of an Order¶

An Order in Sylius holds a collection of Payments on it. Each payment in that collection has its own payment method and has its own payment state. It lets you to divide paying for an order into several different methods that have own payment states.

Tip

If you are not familiar with the Payments concept check the documentation.

State machine of Payment in an Order¶

How to add a Payment to an Order?¶

You will need to create a payment, give it a desired payment method and add it to the order. Remember to process the order using order processor and then flush the order manager.

/** @var PaymentInterface $payment */
$payment = $this->container->get('sylius.factory.payment')->createNew();

$payment->setMethod($this->container->get('sylius.repository.payment_method')->findOneBy(['code' => 'offline']));

$payment->setCurrencyCode($currencyCode);

$order->addPayment($payment);

Completing a Payment with a state machine transition¶

Just like in every state machine you can execute its transitions manually. To pay for a payment of an order you have to apply two transitions request_payment and pay.

$stateMachineFactory = $this->container->get('sm.factory');

$stateMachine = $stateMachineFactory->get($order, OrderPaymentTransitions::GRAPH);
$stateMachine->apply(OrderPaymentTransitions::TRANSITION_REQUEST_PAYMENT);
$stateMachine->apply(OrderPaymentTransitions::TRANSITION_PAY);

$this->container->get('sylius.manager.order')->flush();

If it was the only payment assigned to that order now the paymentState of your order will be paid.

Creating an Order via admin panel¶

After installing the Sylius/AdminOrderCreationPlugin it is possible to create Orders for a chosen Customer from the administrator perspective.

You will be able to choose any products, assign custom prices for items, choose payment and shipping methods. Moreover it is possible to reorder an order that has already been placed.

Customer Order operations: reorder & cancellation¶

With the usage of other Sylius official plugins your Customers will be able to:

cancel unpaid Orders in the “My Account” section -> Customer Order Cancellation Plugin
reorder one of their previously placed Orders -> Customer Reorder Plugin

Learn more¶

Cart flow¶

Picture the following situation - a user comes to a Sylius shop and they say: “Someone’s been using my cart! And they filled it all up with some items!” Let’s avoid such moments of surprise by shedding some light on Sylius cart flow, shall we?

Cart in Sylius represents an Order that is not placed yet. It represents an order that is in progress (not placed yet).

Note

In Sylius each visitor has their own cart. It can be cleared either by placing an order, removing items manually or using cart clearing command.

There are several cart flows, depending on the user being logged in or what items are currently placed in the cart.

First scenario:

Given there is a not logged in user
And this user adds a blue T-Shirt to the cart
And this user adds a red cap to the cart
And there is a customer identified by email "sylius@example.com" with not empty cart
When the not logged in user logs in using "sylius@example.com" email
Then the cart created by a not logged in user should be dropped
And the cart previously created by the user identified by "sylius@example.com" should be set as the current one

Second scenario:

Given there is a not logged in user
And this user adds a blue T-Shirt to the cart
And this user adds a red cap to the cart
And there is a customer identified by email "sylius@example.com" with an empty cart
When the not logged in user logs in using "sylius@example.com" email
Then the cart created by a not logged in user should not be dropped
And it should be set as the current cart

Third scenario:

Given there is a customer identified by email "sylius@example.com" with an empty cart
And this user adds a blue T-Shirt to the cart
And this user adds a red cap to the cart
When the user logs out
And views the cart
Then the cart should be empty

Note

The cart mentioned in the last scenario will we available once you log in again.

Learn more¶

Taxation¶

Sylius’ taxation system allows you to apply appropriate taxes for different items, billing zones and using custom calculators.

Tax Categories¶

In order to process taxes in your store, you need to configure at least one TaxCategory, which represents a specific type of merchandise. If all your items are taxed with the same rate, you can have a simple “Taxable Goods” category assigned to all items.

If you sell various products and some of them have different taxes applicable, you could create multiple categories. For example, “Clothing”, “Books” and “Food”.

Additionally to tax categories, you can have different zones, in order to apply correct taxes for customers coming from any country in the world.

How to create a TaxCategory programmatically?¶

In order to create a TaxCategory use the dedicated factory. Your TaxCategory requires a name and a code.

/** @var TaxCategoryInterface $taxCategory */
$taxCategory = $this->container->get('sylius.factory.tax_category')->createNew();

$taxCategory->setCode('taxable_goods');
$taxCategory->setName('Taxable Goods');

$this->container->get('sylius.repository.tax_category')->add($taxCategory);

Since now you will have a new TaxCategory available.

How to set a TaxCategory on a ProductVariant?¶

In order to have taxes calculated for your products you have to set TaxCategories for each ProductVariant you create. Read more about Products and Variants here.

/** @var TaxCategoryInterface $taxCategory */
$taxCategory = $this->container->get('sylius.repository.tax_category')->findOneBy(['code' => 'taxable_goods']);

/** @var ProductVariantInterface $variant */
$variant = $this->container->get('sylius.repository.product_variant')->findOneBy(['code' => 'mug']);

$variant->setTaxCategory($taxCategory);

Tax Rates¶

A tax rate is essentially a percentage amount charged based on the sales price. Tax rates also contain other important information:

Whether product prices are inclusive of this tax
The zone in which the order address must fall within
The tax category that a product must belong to in order to be considered taxable
Calculator to use for computing the tax

TaxRates included in price¶

The TaxRate entity has a field for configuring if you would like to have taxes included in the price of a subject or not.

If you have a TaxCategory with a 23% VAT TaxRate includedInPrice ($taxRate->isIncludedInPrice() returns true), then the price shown on the ProductVariant in that TaxCategory will be increased by 23% all the time. See the Behat scenario below:

Given the store has included in price "VAT" tax rate of 23%
And the store has a product "T-Shirt" priced at "$10.00"
When I add product "T-Shirt" to my cart
Then my cart total should be "$10.00"
And my cart taxes should be "$1.87"

If the TaxRate will not be included ($taxRate->isIncludedInPrice() returns false) then the price of ProductVariant will be shown without taxes, but when this ProductVariant will be added to cart taxes will be shown in the Taxes Total in the cart. See the Behat scenario below:

Given the store has excluded from price "VAT" tax rate of 23%
And the store has a product "T-Shirt" priced at "$10.00"
When I add product "T-Shirt" to my cart
Then my cart total should be "$12.30"
And my cart taxes should be "$2.30"

How to create a TaxRate programmatically?¶

Note

Before creating a tax rate you need to know that you can have different tax zones, in order to apply correct taxes for customers coming from any country in the world. To understand how zones work, please refer to the Zones chapter of this book.

Use a factory to create a new, empty TaxRate. Provide a code, a name. Set the amount of charge in float. Then choose a calculator and zone (retrieved from the repository beforehand).

Finally you can set the TaxCategory of your new TaxRate.

/** @var TaxRateInterface $taxRate */
$taxRate = $this->container->get('sylius.factory.tax_rate')->createNew();

$taxRate->setCode('7%');
$taxRate->setName('7%');
$taxRate->setAmount(0.07);
$taxRate->setCalculator('default');

// Get a Zone from the repository, for example the 'US' zone
/** @var ZoneInterface $zone */
$zone = $this->container->get('sylius.repository.zone')->findOneBy(['code' => 'US']);

$taxRate->setZone($zone);

// Get a TaxCategory from the repository, for example the 'alcohol' category
/** @var TaxCategoryInterface $taxCategory */
$taxCategory = $this->container->get('sylius.repository.tax_category')->findOneBy(['code' => 'alcohol']);

$taxRate->setCategory($taxCategory);

$this->container->get('sylius.repository.tax_rate')->add($taxRate);

Default Tax Zone¶

The default tax zone concept is used for situations when we want to show taxes included in price even when we do not know the address of the Customer, therefore we cannot choose a proper Zone, which will have proper TaxRates.

Since we are using the concept of Channels, we will use the Zone assigned to the Channel as default Zone for Taxation.

Note

To understand how zones work, please refer to the Zones chapter of this book.

Applying Taxes¶

For applying Taxes Sylius is using the OrderTaxesProcessor, which has the services that implement the OrderTaxesApplicatorInterface inside.

Calculators¶

For calculating Taxes Sylius is using the DefaultCalculator. You can create your custom calculator for taxes by creating a class that implements the CalculatorInterface and registering it as a sylius.tax_calculator.your_calculator_name service.

Learn more¶

Adjustments¶

Adjustment is a resource closely connected to the Orders’ concept. It influences the order’s total.

Adjustments may appear on the Order, the OrderItems and the OrderItemUnits.

There are a few types of adjustments in Sylius:

Order Promotion Adjustments,
OrderItem Promotion Adjustments,
OrderItemUnit Promotion Adjustments,
Shipping Adjustments,
Shipping Promotion Adjustments,
Tax Adjustments

And they can be generally divided into three groups: promotion adjustments, shipping adjustments and taxes adjustments.

Also note that adjustments can be either positive: charges (with a +) or negative: discounts (with a -).

How to create an Adjustment programmatically?¶

The Adjustments alone are a bit useless. They should be created alongside Orders.

As usual, get a factory and create an adjustment. Then give it a type - you can find all the available types on the AdjustmentInterface. The adjustment needs also the amount - which is the amount of money that will be added to the orders total.

Note

The amount is always saved in the base currency.

Additionally you can set the label that will be displayed on the order view and whether your adjustment is neutral - neutral adjustments do not affect the order’s total (like for example taxes included in price).

/** @var AdjustmentInterface $adjustment */
$adjustment = $this->container->get('sylius.factory.adjustment')->createNew();

$adjustment->setType(AdjustmentInterface::ORDER_PROMOTION_ADJUSTMENT);
$adjustment->setAmount(200);
$adjustment->setNeutral(false);
$adjustment->setLabel('Test Promotion Adjustment');

$order->addAdjustment($adjustment);

Note

Remember that if you are creating OrderItem adjustments you have to add them on the OrderItem level. The same happens with the OrderItemUnit adjustments, which have to be added on the OrderItemUnit level.

To see changes on the order you need to update it in the database.

$this->container->get('sylius.manager.order')->flush();

Tip

An adjustment can be locked with $adjustment->lock(). It can be useful when the total order price is recalculated and a promotion isn’t applicable anymore but you still want it to be applied to the order. In case of an expired coupon that still should be included in the order for example.

Learn more¶

Promotions¶

The system of Promotions in Sylius is really flexible. It is a combination of promotion rules and actions.

Promotions have a few parameters - a unique code, name, usageLimit, the period of time when it works. There is a possibility to define exclusive promotions (no other can be applied if an exclusive promotion was applied) and priority that is useful for them, because the exclusive promotion should get the top priority.

Tip

The usageLimit of a promotion is the total number of times this promotion can be used.

Tip

Promotion priorities are numbers that you assign to the promotion. The larger the number, the higher the priority. So a promotion with priority 3 would be applied before a promotion with priority set to 1.

What can you use the priority for? Well, imagine that you have two different promotions, one’s action is to give 10% discount on whole order and the other one gives 5$ discount from the order total. Business (and money) wise, which one should we apply first? ;)

How to create a Promotion programmatically?¶

Just as usual, use a factory. The promotion needs a code and a name.

/** @var PromotionInterface $promotion */
$promotion = $this->container->get('sylius.factory.promotion')->createNew();

$promotion->setCode('simple_promotion_1');
$promotion->setName('Simple Promotion');

Of course an empty promotion would be useless - it is just a base for adding Rules and Actions. Let’s see how to make it functional.

Promotion Rules¶

The promotion Rules restrict in what circumstances a promotion will be applied. An appropriate RuleChecker (each Rule type has its own RuleChecker) may check if the Order:

Contains a number of items from a specified taxon (for example: contains 4 products that are categorized as t-shirts)
Has a specified total price of items from a given taxon (for example: all mugs in the order cost 20$ in total)
Has total price of at least a defined value (for example: the orders’ items total price is equal at least 50$)

And many more similar, suitable to your needs.

Rule Types¶

The types of rules that are configured in Sylius by default are:

Cart Quantity - checks if there is a given amount of items in the cart,
Item Total - checks if items in the cart cost a given amount of money,
Taxon - checks if there is at least one item from given taxons in the cart,
Items From Taxon Total - checks in the cart if items from a given taxon cost a given amount of money,
Nth Order - checks if this is for example the second order made by the customer,
Shipping Country - checks if the order’s shipping address is in a given country.

How to create a new PromotionRule programmatically?¶

Creating a PromotionRule is really simple since we have the PromotionRuleFactory. It has dedicated methods for creating all types of rules available by default.

In the example you can see how to create a simple Cart Quantity rule. It will check if there are at least 5 items in the cart.

/** @var PromotionRuleFactoryInterface $ruleFactory */
$ruleFactory = $this->container->get('sylius.factory.promotion_rule');

$quantityRule = $ruleFactory->createCartQuantity('5');

// add your rule to the previously created Promotion
$promotion->addRule($quantityRule);

Note

Rules are just constraints that have to be fulfilled by an order to make the promotion eligible. To make something happen to the order you will need Actions.

PromotionRules configuration reference¶

Each PromotionRule type has a very specific structure of its configuration array:

PromotionRule type	Rule Configuration Array
`cart_quantity`	`['count' => $count]`
`item_total`	`[$channelCode => ['amount' => $amount]]`
`has_taxon`	`['taxons' => $taxons]`
`total_of_items_from_taxon`	`[$channelCode => ['taxon' => $taxonCode, 'amount' => $amount]]`
`nth_order`	`['nth' => $nth]`
`contains_product`	`['product_code' => $productCode]`

Promotion Actions¶

Promotion Action is basically what happens when the rules of a Promotion are fulfilled, what discount is applied on the whole Order (or its Shipping cost).

There are a few kinds of actions in Sylius:

fixed discount on the order (for example: -5$ off the order total)
percentage discount on the order (for example: -10% on the whole order)
fixed unit discount (for example: -1$ off the order total but distributed and applied on each order item unit)
percentage unit discount (for example: -10% off the order total but distributed and applied on each order item unit)
shipping discount (for example: -6$ on the costs of shipping)

Tip

Actions are applied on all items in the Order. If you are willing to apply discounts on specific items in the order check Filters at the bottom of this article.

How to create an PromotionAction programmatically?¶

In order to create a new PromotionAction we can use the dedicated PromotionActionFactory.

It has special methods for creating all types of actions available by default. In the example below you can see how to create a simple Fixed Discount action, that reduces the total of an order by 10$.

/** @var PromotionActionFactoryInterface $actionFactory */
$actionFactory = $this->container->get('sylius.factory.promotion_action');

$action = $actionFactory->createFixedDiscount(10);

// add your action to the previously created Promotion
$promotion->addAction($action);

Note

All Actions are assigned to a Promotion and are executed while the Promotion is applied. This happens via the CompositeOrderProcessor service. See details of applying Promotions below.

And finally after you have an PromotionAction and a PromotionRule assigned to the Promotion add it to the repository.

$this->container->get('sylius.repository.promotion')->add($promotion);

PromotionActions configuration reference¶

Each PromotionAction type has a very specific structure of its configuration array:

PromotionAction type	Action Configuration Array
`order_fixed_discount`	`[$channelCode => ['amount' => $amount]]`
`unit_fixed_discount`	`[$channelCode => ['amount' => $amount]]`
`order_percentage_discount`	`['percentage' => $percentage]`
`unit_percentage_discount`	`[$channelCode => ['percentage' => $percentage]]`
`shipping_percentage_discount`	`['percentage' => $percentage]`

Applying Promotions¶

Promotions in Sylius are handled by the PromotionProcessor which inside uses the PromotionApplicator.

The PromotionProcessor’s method process() is executed on the subject of promotions - an Order:

firstly it iterates over the promotions of a given Order and first reverts them all,
then it checks the eligibility of all promotions available in the system on the given Order
and finally it applies all the eligible promotions to that order.

How to apply a Promotion manually?¶

Let’s assume that you would like to apply a 10% discount on everything somewhere in your code.

To achieve that, create a Promotion with an PromotionAction that gives 10% discount. You don’t need rules.

/** @var PromotionInterface $promotion */
$promotion = $this->container->get('sylius.factory.promotion')->createNew();

$promotion->setCode('discount_10%');
$promotion->setName('10% discount');

/** @var PromotionActionFactoryInterface $actionFactory */
$actionFactory = $this->container->get('sylius.factory.promotion_action');

$action = $actionFactory->createPercentageDiscount(10);

$promotion->addAction($action);

$this->container->get('sylius.repository.promotion')->add($promotion);

// and now get the PromotionApplicator and use it on an Order (assuming that you have one)
$this->container->get('sylius.promotion_applicator')->apply($order, $promotion);

Promotion Filters¶

Filters are really handy when you want to apply promotion’s actions to groups of products in an Order. For example if you would like to apply actions only on products from a desired taxon - use the available by default TaxonFilter.

Read these scenarios regarding promotion filters to have a better understanding of them.

Learn more¶

Coupons¶

The concept of coupons is closely connected to the Promotions Concept.

Coupon Parameters¶

A Coupon besides a code has a date when it expires, the usageLimit and it counts how many times it was already used.

How to create a coupon with a promotion programmatically?¶

Warning

The promotion has to be couponBased = true in order to be able to hold a collection of Coupons that belong to it.

Let’s create a promotion that will have a single coupon that activates the free shipping promotion.

/** @var PromotionInterface $promotion */
$promotion = $this->container->get('sylius.factory.promotion')->createNew();

$promotion->setCode('free_shipping');
$promotion->setName('Free Shipping');

Remember to set a channel for your promotion and to make it couponBased!

$promotion->addChannel($this->container->get('sylius.repository.channel')->findOneBy(['code' => 'US_Web_Store']));

$promotion->setCouponBased(true);

Then create a coupon and add it to the promotion:

/** @var CouponInterface $coupon */
$coupon = $this->container->get('sylius.factory.promotion_coupon')->createNew();

$coupon->setCode('FREESHIPPING');

$promotion->addCoupon($coupon);

Now create an PromotionAction that will take place after applying this promotion - 100% discount on shipping

/** @var PromotionActionFactoryInterface $actionFactory */
$actionFactory = $this->container->get('sylius.factory.promotion_action');

// Provide the amount in float ( 1 = 100%, 0.1 = 10% )
$action = $actionFactory->createShippingPercentageDiscount(1);

$promotion->addAction($action);

$this->container->get('sylius.repository.promotion')->add($promotion);

Finally to see the effects of your promotion with coupon you need to apply a coupon on the Order.

How to apply a coupon to an Order?¶

To apply your promotion with coupon that gives 100% discount on the shipping costs you need an order that has shipments. Set your promotion coupon on that order - this is what happens when a customer provides a coupon code during checkout.

And after that call the OrderProcessor on the order to have the promotion applied.

$order->setPromotionCoupon($coupon);

$this->container->get('sylius.order_processing.order_processor')->process($order);

Promotion Coupon Generator¶

Making up new codes might become difficult if you would like to prepare a lot of coupons at once. That is why Sylius provides a service that generates random codes for you - CouponGenerator. In its PromotionCouponGeneratorInstruction you can define the amount of coupons that will be generated, the length of their codes, expiration date and usage limit.

// Find a promotion you desire in the repository
$promotion = $this->container->get('sylius.repository.promotion')->findOneBy(['code' => 'simple_promotion']);

// Get the CouponGenerator service
/** @var CouponGeneratorInterface $generator */
$generator = $this->container->get('sylius.promotion_coupon_generator');

// Then create a new empty PromotionCouponGeneratorInstruction
/** @var PromotionCouponGeneratorInstructionInterface $instruction */
$instruction = new PromotionCouponGeneratorInstruction();

// By default the instruction will generate 5 coupons with codes of length equal to 6
// You can easily change it with the ``setAmount()`` and ``setLength()`` methods
$instruction->setAmount(10);

// Coupon prefix and suffix are not mandatory but can be used to make coupon code more human-friendly
$instruction->setPrefix('NEW_YEAR_');
$instruction->setSuffix('_SALE');

// Now use the ``generate()`` method with your instruction on the promotion where you want to have Coupons
$generator->generate($promotion, $instruction);

The above piece of code will result in a set of 10 coupons that will work with the promotion identified by the simple_promotion code.

Learn more¶

Shipments¶

A Shipment is a representation of a shipping request for an Order. Sylius can attach multiple shipments to each single Order. Shipment consists of ShipmentUnits, which are a representation of OrderItemUnits from its Order.

How is a Shipment created for an Order?¶

Warning

Read more about creating Orders where the process of assigning Shipments is clarified.

Splitting shipments¶

As mentioned in the beginning Sylius Order holds a collection of Shipments. In Sylius Plus edition Orders can be fulfilled partially, therefore it is possible to split the default Order’s shipment.

To do it Sylius Plus provides a UI, where you can choose which items from the initial shipments you’d like to extract to a new split shipment and send it (providing a tracking code or not). Shipments of an Order can be split as long as there remains one shipment in state ready.

The Shipment State Machine¶

A Shipment that is attached to an Order will have its own state machine with the following states available: cart, ready, cancelled, shipped.

The allowed transitions between these states are:

transitions:
     create:
         from: [cart]
         to: ready
     ship:
         from: [ready]
         to: shipped
     cancel:
         from: [ready]
         to: cancelled

Shipping Methods¶

ShippingMethod in Sylius is an entity that represents the way an order can be shipped to a customer.

How to create a ShippingMethod programmatically?¶

As usual use a factory to create a new ShippingMethod. Give it a code, set a desired shipping calculator and set a zone. It also need a configuration, for instance of the amount (cost). At the end add it to the system using a repository.

$shippingMethod = $this->container->get('sylius.factory.shipping_method')->createNew();

$shippingMethod->setCode('DHL');
$shippingMethod->setCalculator(DefaultCalculators::FLAT_RATE);
$shippingMethod->setConfiguration(['channel_code' => ['amount' => 50]]);

$zone = $this->container->get('sylius.repository.zone')->findOneByCode('US');
$shippingMethod->setZone($zone);

$this->container->get('sylius.repository.shipping_method')->add($shippingMethod);

In order to have your shipping method available in checkout add it to a desired channel.

$channel = $this->container->get('sylius.repository.channel')->findOneByCode('channel_code');
$channel->addShippingMethod($shippingMethod);

Shipping method rules¶

The shipping method Rules restrict in what circumstances a shipping method is available. An appropriate RuleChecker (each Rule type has its own RuleChecker) may check if:

All products belong to a certain taxon
The order total is greater than a given amount
The total weight is below a given number
The total volume is below a given value

And many more similar, suitable to your needs.

Rule Types¶

The types of rules that are configured in Sylius by default are:

Items total greater than or equal - checks if the items total is greater than or equal to a given amount
Items total less than or equal - checks if the items total is less than or equal to a given amount
Total weight greater than or equal - checks if the total weight of the order is greater than or equal to a given number
Total weight less than or equal - checks if the total weight of the order is less than or equal to a given number

Shipping Zones¶

Sylius has an approach of Zones used also for shipping. As in each e-commerce you may be willing to ship only to certain countries for example. Therefore while configuring your ShippingMethods pay special attention to the zones you are assigning to them. You have to prepare methods for each zone, because the available methods are retrieved for the zone the customer has basing on his address.

Shipping Cost Calculators¶

The shipping cost calculators are services that are used to calculate the cost for a given shipment.

The CalculatorInterface has a method calculate() that takes object with a configuration and returns integer that is the cost of shipping for that subject. It also has a getType() method that works just like in the forms.

To select a proper service we have a one that decides for us - the DelegatingCalculator. Basing on the ShippingMethod assigned on the Shipment it will get its calculator type and configuration and calculate the cost properly.

$shippingCalculator = $this->container->get('sylius.shipping_calculator');

$cost = $shippingCalculator->calculate($shipment);

Built-in Calculators¶

The already defined calculators in Sylius are described as constants in the SyliusComponentShippingCalculatorDefaultCalculators

FlatRateCalculator - just returns the amount from the ShippingMethod’s configuration.
PerUnitRateCalculator - returns the amount from the ShippingMethod’s configuration multiplied by the units count.

Shipment complete events¶

There are two events that are triggered on the shipment ship action:

Event id
`sylius.shipment.pre_ship`
`sylius.shipment.post_ship`

Learn more¶

Payments¶

Sylius contains a very flexible payments management system with support for many gateways (payment providers). We are using a payment abstraction library - Payum, which handles all sorts of capturing, refunding and recurring payments logic.

On Sylius side, we integrate it into our checkout and manage all the payment data.

Payment¶

Every payment in Sylius, successful or failed, is represented by the Payment model, which contains basic information and a reference to appropriate order.

Invoices¶

By installing the Sylius/InvoicingPlugin you can enhance your Sylius application with the automatic generation of invoicing documents for each Order’s payment.

Sylius invoices have their own numbers, issuing dates, consist of shop and customer’s data, the order items with prices and quantity and separated taxes section. Their templates can be changed, and of course the moment of invoice generation can be customized.

Payment State Machine¶

A Payment that is assigned to an order will have it’s own state machine with a few available states: cart, new, processing, completed, failed, cancelled, refunded.

The available transitions between these states are:

transitions:
    create:
        from: [cart]
        to: new
    process:
        from: [new]
        to: processing
    authorize:
        from: [new, processing]
        to: authorized
    complete:
        from: [new, processing, authorized]
        to: completed
    fail:
        from: [new, processing]
        to: failed
    cancel:
        from: [new, processing, authorized]
        to: cancelled
    refund:
        from: [completed]
        to: refunded

Of course, you can define your own states and transitions to create a workflow, that perfectly matches your needs. Full configuration can be seen in the PaymentBundle/Resources/config/app/state_machine.yml.

Changes to payment happen through applying appropriate transitions.

How to create a Payment programmatically?¶

We cannot create a Payment without an Order, therefore let’s assume that you have an Order to which you will assign a new payment.

$payment = $this->container->get('sylius.factory.payment')->createNew();

$payment->setOrder($order);
$payment->setCurrencyCode('USD');

$this->container->get('sylius.repository.payment')->add($payment);

Tip

Not familiar with the Order concept? Check here.

Payment Methods¶

A PaymentMethod represents a way that your customer pays during the checkout process. It holds a reference to a specific gateway with custom configuration. Gateway is configured for each payment method separately using the payment method form.

How to create a PaymentMethod programmatically?¶

As usual, use a factory to create a new PaymentMethod and give it a unique code.

$paymentMethod = $this->container->get('sylius.factory.payment_method')->createWithGateway('offline');
$paymentMethod->setCode('ALFA1');

$this->container->get('sylius.repository.payment_method')->add($paymentMethod);

In order to have your new payment method available in the checkout remember to add your desired channel to the payment method:

$paymentMethod->addChannel($channel);

Payment Gateway configuration¶

Payment Gateways that already have a Sylius bridge¶

First you need to create the configuration form type for your gateway. Have a look at the configuration form types of

Then you should register its configuration form type with sylius.gateway_configuration_type tag. After that it will be available in the Admin panel in the gateway choice dropdown.

Tip

If you are not sure how your configuration form type should look like, head to Payum documentation.

Other Payment Gateways¶

Note

Learn more about integrating payment gateways in the dedicated guide and in the Payum docs.

When the Payment Gateway you are trying to use does have a bridge available and you integrate them on your own, use our guide on extension development.

Troubleshooting¶

Sylius stores the payment output inside the details column of the sylius_payment table. It can provide valuable information when debugging the payment process.

PayPal Error Code 10409¶

The 10409 code, also known as the “Checkout token was issued for a merchant account other than yours” error. You have most likely changed the PayPal credentials during the checkout process. Clear the cache and try again:

bin/console cache:clear

Payment complete events¶

There are two events that are triggered on the payment complete action:

Event id
`sylius.payment.pre_complete`
`sylius.payment.post_complete`

Learn more¶

Invoices¶

An Invoice is a commercial document issued by the shop, that is a sort of confirmation of the sale transaction. It indicates the products, quantities, agreed prices for these products. An invoice contains usually also payment terms (like due date, or if it was already paid). From the shop’s point of view, an invoice is a sales invoice. From the customer’s point of view, an invoice is a purchase invoice.

Invoicing in Sylius¶

Sylius is providing invoicing engine via a free open-source plugin. The plugin installation guide you will find in the plugin’s README.

Having the plugin installed, you will notice a new main menu item among “Sales” section - “Invoices”. It allows you to access the index of all invoices issued at your shop (sortable and with filters as most of the grids).

Moreover a section on admin Order show page is added: Invoices. This same section will appear also on the Order show page for customers in the shop.

When is the Invoice issued?¶

The invoices are generated by default when the Order is placed (so after the customer clicks the Confirm button at the end of checkout). After that the Invoice is already downloadable for both the Admin and Customer.

Tip

In order to customize the moment when the Invoice is generated, you will need to override the logic around a specific event listener and the OrderPlacedProducer. <https://github.com/Sylius/InvoicingPlugin/blob/master/src/Resources/config/services/events.xml#L13:L23>

Sending and downloading Invoices¶

Sending invoice is an action separate from its generation. By default the Invoice is sent to customer when the Order’s payment is paid.

Of course you can customize it by overriding a part of configuration placed in config.yml file. You can customize this file by adding new state machine event listeners or editing existing ones.

Shop Billing Data¶

The Invoicing plugin for the invoicing sake is using a feature of Sylius Channels. Each channel has a separate section for providing billing data of the shop, that will be placed on the invoice.

Learn more¶

Checkout¶

Checkout is a process that begins when the Customer decides to finish their shopping and pay for their order. The process of specifying address, payment and a way of shipping transforms the Cart into an Order.

Checkout State Machine¶

The Order Checkout state machine has 5 states available: cart, addressed, shipping_selected, payment_selected, completed and a set of defined transitions between them. These states are saved as the checkoutState of the Order.

Besides the steps of checkout, each of them can be done more than once. For instance if the Customer changes their mind and after selecting payment they want to change the shipping address they have already specified, they can of course go back and readdress it.

The transitions on the order checkout state machine are:

transitions:
    address:
        from: [cart, addressed, shipping_selected, shipping_skipped, payment_selected, payment_skipped]
        to: addressed
    skip_shipping:
        from: [addressed]
        to: shipping_skipped
    select_shipping:
        from: [addressed, shipping_selected, payment_selected, payment_skipped]
        to: shipping_selected
    skip_payment:
        from: [shipping_selected, shipping_skipped]
        to: payment_skipped
    select_payment:
        from: [payment_selected, shipping_skipped, shipping_selected]
        to: payment_selected
    complete:
        from: [payment_selected, payment_skipped]
        to: completed

Steps of Checkout¶

Checkout in Sylius is divided into 4 steps. Each of these steps occurs when the Order goes into a certain state. See the Checkout state machine in the state_machine/sylius_order_checkout.yml together with the routing file for checkout: checkout.yml.

Note

Before performing Checkout you need to have an Order created.

Addressing¶

This is a step where the customer provides both shipping and billing addresses.

Transition after step	Template
`cart`-> `addressed`	`SyliusShopBundle:Checkout:addressing.html.twig`

How to perform the Addressing Step programmatically?¶

Firstly if the Customer is not yet set on the Order it will be assigned depending on the case:

An already logged in User - the Customer is set for the Order using the CartBlamerListener, that determines the user basing on the event.
A Customer or User that was present in the system before (we’ve got their e-mail) - the Customer instance is updated via cascade, the order is assigned to it.
A new Customer with unknown e-mail - a new Customer instance is created and assigned to the order.

Note

Before Sylius v1.7 a User (i.e. we have their e-mail and they are registered) had to login before they could complete the checkout process. If you want this constraint on your checkout, you can add this to your application:

 <?xml version="1.0" encoding="UTF-8"?>

<constraint-mapping xmlns="http://symfony.com/schema/dic/constraint-mapping" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://symfony.com/schema/dic/constraint-mapping http://symfony.com/schema/dic/services/constraint-mapping-1.0.xsd">
    <class name="Sylius\Component\Core\Model\Customer">
        <constraint name="Sylius\Bundle\CoreBundle\Validator\Constraints\RegisteredUser">
            <option name="message">sylius.customer.email.registered</option>
            <option name="groups">sylius_customer_checkout_guest</option>
        </constraint>
    </class>
</constraint-mapping>

Hint

If you do not understand the Users and Customers concept in Sylius go to the Users Concept documentation.

The typical Address consists of: country, city, street and postcode - to assign it to an Order either create it manually or retrieve from the repository.

/** @var AddressInterface $address */
$address = $this->container->get('sylius.factory.address')->createNew();

$address->setFirstName('Anne');
$address->setLastName('Shirley');
$address->setStreet('Avonlea');
$address->setCountryCode('CA');
$address->setCity('Canada');
$address->setPostcode('C0A 1N0');

$order->setShippingAddress($address);
$order->setBillingAddress($address);

Having the Customer and the Address set you can apply a state transition to your order. Get the StateMachine for the Order via the StateMachineFactory with a proper schema, and apply a transition and of course flush your order after that via the manager.

$stateMachineFactory = $this->container->get('sm.factory');

$stateMachine = $stateMachineFactory->get($order, OrderCheckoutTransitions::GRAPH);
$stateMachine->apply(OrderCheckoutTransitions::TRANSITION_ADDRESS);

$this->container->get('sylius.manager.order')->flush();

What happens during the transition?

The method process($order) of the CompositeOrderProcessor is run.

Selecting shipping¶

It is a step where the customer selects the way their order will be shipped to them. Basing on the ShippingMethods configured in the system the options for the Customer are provided together with their prices.

Transition after step	Template
`addressed`-> `shipping_selected`	`SyliusShopBundle:Checkout:shipping.html.twig`

How to perform the Selecting shipping Step programmatically?¶

Before approaching this step be sure that your Order is in the addressed state. In this state your order will already have a default ShippingMethod assigned, but in this step you can change it and have everything recalculated automatically.

Firstly either create new (see how in the Shipments concept) or retrieve a ShippingMethod from the repository to assign it to your order’s shipment created defaultly in the addressing step.

// Let's assume you have a method with code 'DHL' that has everything set properly
$shippingMethod = $this->container->get('sylius.repository.shipping_method')->findOneByCode('DHL');

// Shipments are a Collection, so even though you have one Shipment by default you have to iterate over them
foreach ($order->getShipments() as $shipment) {
    $shipment->setMethod($shippingMethod);
}

After that get the StateMachine for the Order via the StateMachineFactory with a proper schema, and apply a proper transition and flush the order via the manager.

$stateMachineFactory = $this->container->get('sm.factory');

$stateMachine = $stateMachineFactory->get($order, OrderCheckoutTransitions::GRAPH);
$stateMachine->apply(OrderCheckoutTransitions::TRANSITION_SELECT_SHIPPING);

$this->container->get('sylius.manager.order')->flush();

What happens during the transition?

The method process($order) of the CompositeOrderProcessor is run. Here this method is responsible for: controlling the shipping charges which depend on the chosen ShippingMethod, controlling the promotions that depend on the shipping method.

Skipping shipping step¶

What if in the order you have only products that do not require shipping (they are downloadable for example)?

Note

When all of the ProductVariants of the order have the shippingRequired property set to false, then Sylius assumes that the whole order does not require shipping, and the shipping step of checkout will be skipped.

Selecting payment¶

This is a step where the customer chooses how are they willing to pay for their order. Basing on the PaymentMethods configured in the system the possibilities for the Customer are provided.

Transition after step	Template
`shipping_selected`-> `payment_selected`	`SyliusShopBundle:Checkout:payment.html.twig`

How to perform the Selecting payment step programmatically?¶

Before this step your Order should be in the shipping_selected state. It will have a default Payment selected after the addressing step, but in this step you can change it.

Firstly either create new (see how in the Payments concept) or retrieve a PaymentMethod from the repository to assign it to your order’s payment created defaultly in the addressing step.

// Let's assume that you have a method with code 'paypal' configured
$paymentMethod = $this->container->get('sylius.repository.payment_method')->findOneByCode('paypal');

// Payments are a Collection, so even though you have one Payment by default you have to iterate over them
foreach ($order->getPayments() as $payment) {
    $payment->setMethod($paymentMethod);
}

After that get the StateMachine for the Order via the StateMachineFactory with a proper schema, and apply a proper transition and flush the order via the manager.

$stateMachineFactory = $this->container->get('sm.factory');

$stateMachine = $stateMachineFactory->get($order, OrderCheckoutTransitions::GRAPH);
$stateMachine->apply(OrderCheckoutTransitions::TRANSITION_SELECT_PAYMENT);

$this->container->get('sylius.manager.order')->flush();

What happens during the transition?

The method process($order) of the CompositeOrderProcessor is run and checks all the adjustments on the order.

Finalizing¶

In this step the customer gets an order summary and is redirected to complete the payment they have selected.

Transition after step	Template
`payment_selected`-> `completed`	`SyliusShopBundle:Checkout:summary.html.twig`

How to complete Checkout programmatically?¶

Before executing the completing transition you can set some notes to your order.

$order->setNotes('Thank you dear shop owners! I am allergic to tape so please use something else for packaging.');

After that get the StateMachine for the Order via the StateMachineFactory with a proper schema, and apply a proper transition and flush the order via the manager.

$stateMachineFactory = $this->container->get('sm.factory');

$stateMachine = $stateMachineFactory->get($order, OrderCheckoutTransitions::GRAPH);
$stateMachine->apply(OrderCheckoutTransitions::TRANSITION_COMPLETE);

$this->container->get('sylius.manager.order')->flush();

What happens during the transition?

The Order will have the checkoutState - completed,
The Order will have the general state - new instead of cart it has had before the transition,
When the Order is transitioned from cart to new the paymentState is set to awaiting_payment and the shippingState to ready

The Checkout is finished after that.

Checkout related events¶

On each step of checkout a dedicated event is triggered.

Event id
`sylius.order.pre_address`
`sylius.order.post_address`
`sylius.order.pre_select_shipping`
`sylius.order.post_select_shipping`
`sylius.order.pre_payment`
`sylius.order.post_payment`
`sylius.order.pre_complete`
`sylius.order.post_complete`

Learn more¶

Returns¶

Return is the process of requesting and then bringing back merchandise, from a customer to the merchant, for a refund or exchange. In distance sales like e-commerce returns (especially in the cooling-off period) are required by legislation.

Return Requests (Return Merchandise Agreements)¶

After a registered Customer makes an Order in a Sylius Plus shop, they are able to access it in their My Account section in shop. Each fulfilled (paid and sent) Order has a Returns section, where the Customer can request a Return.

As you can see above, the Customer can choose which items they want to return, what resolution do they expect and provide a written reason, including images as proofs of item damage for example.

There are three resolutions provided out-of-the-box:

refund (give money back to the Customer)
replacement (wrong items ordered, or sent should be replaced by the merchant to other specified by the customer)
repair (the item(s) are damaged and should be repaired by the merchant according to the guarantee)

Customizing the available resolutions¶

In order to remove one of the predefined resolutions:

Removing one of possible resolutions Overwrite the ReturnRequestResolutionsProvider service:

# services.yaml

Sylius\Plus\Returns\Domain\Provider\ReturnRequestResolutionsProvider:
    class: Sylius\Plus\Returns\Application\Provider\StringReturnRequestResolutionsProvider
    arguments:
        - ['refund', 'repair'] # the "replacement" resolution has been removed

In order to add a custom Resolution:

Overwrite the ReturnRequestResolutionsProvider service and add a translation of the new resolution:

# services.yaml

Sylius\Plus\Returns\Domain\Provider\ReturnRequestResolutionsProvider:
    class: Sylius\Plus\Returns\Application\Provider\StringReturnRequestResolutionsProvider
    arguments:
        - ['refund', 'repair', 'size_change']

# messages.en.yaml

sylius_plus:

ui:

returns:

size_change: “Size change”

After the Customer places a Return Request for chosen items they will not be able to place another Return Requests for these items, they although can cancel the Return Request and then place it again.

Tip

Each placed Return Request has a pdf confirmation document on it, that can be downloaded from the return request show page by both administrator and customer.

New Return Requests management¶

Once a Return Request is placed it will become visible to the Administrators of the shop. They will get an email and be able to see it in the Admin panel.

The administrators can manage the return request in state new (newly placed) here:

As you can see above the Admin can:

change the resolution of the Return Request - if the chosen one cannot be fulfilled, the Customer will get a notifying email
accept/reject the Return Request providing a reasoning to the Customer, the Customer will get a notifying email

A Return Request that becomes rejected can no longer get processed. The Customer needs to open a new one if they still feel the need to return the items.

Accepted Return Requests management¶

After a Return Request gets accepted it can be processed according to the resolution that was chosen.

Refund¶

Return requests that have the refund resolution chosen, have an option to at once accept the return request and proceed to the refunding process with just one button.

If you do not do the refund then, after accepting, the return request management section will look like that:

Besides making a refund, you can mark here that a package from customer has been received; or resolve the return request, after which you will no longer be able to process it.

Tip

To learn about the refunding process check the Refunds documentation section.

Replacement¶

Same as for other resolutions you are able to mark returned items as received, make an additional refund, resolving the request.

But also, as you can see in the image above, you can make a replacement Order. This will help you create a new Order with the items requested by the customer. While preparing a replacement Order you can modify the items being replaced, so that you can for example change the size, color, quantity or even send a completely different item. The Order will be free and marked as replacement, so you won’t loose it. This feature let’s you properly track the inventory and new shipment.

Repair¶

Same as for other resolutions you are able to mark returned items as received, make an additional refund, resolving the request, What is specific for return requests of repair type, you are able to the mark repaired items as sent, after you have received them.

API coverage¶

Sylius Plus provides a route that allows accepting or rejecting return request with an API call:

POST /api/v1/return-requests/{id}/accept

The id is an id of return request that we want to accept. Content of the request may contain response of return request:

{
    "response": "Return request confirmed and accepted."
}

POST /api/v1/return-requests/{id}/reject

The id is an id of return request that we want to accept. Content of the request may contain response of return request:

{
    "response": "We are not able to replace this item."
}

The response can also be empty:

{}

Learn more¶

Refunds¶

Return is a two-step (Returns & Refunds) process of a customer giving previously purchased item(s) back to the shop, and in turn receiving a financial refund in the original payment method, exchange for another item etc.. Sylius is providing both steps of this process: one via a free open-source plugin (Refunds) and the other via the Sylius Plus version (Returns).

How to refund money to a Customer in Sylius?¶

Having the plugin installed you will notice a new button on admin Order show page, the “Refunds” button in the top-right corner. On the refunds paged for this Order you are able to refund order items all at once or one by one fully or partially, you can also return the shipping cost. The original payment method of the order is chosen, but it can be modified.

Credit Memos¶

After creating a refund it is documented in the system with a Credit Memo document, which is an opposite to an invoice. Credit Memos look like invoices, although not for incomes but for store’s account charges. Credit Memos appear as a separate section under Sales in the left admin menu.

Refund Payments¶

Alongside the Credit Memo document, a new refund Payment is created in response to a Refund. This is a convenient object, with which you can automate the process of paying the refunds to the customer;s account.

Learn more¶

API¶

Warning

The new, unified Sylius API is still under development, that’s why the whole ApiBundle is tagged with @experimental. This means that all code from ApiBundle is excluded from Backward Compatibility Promise.

This chapter will explain to you how to start with our new API, show concepts used in it, and you will inform you why we have decided to rebuild entire api from scratch. To use this API remember to generate JWT token. For more information, please visit jwt package documentation

This part of the documentation is about the currently developed unified API for the Sylius platform.

API¶

Warning

The new, unified Sylius API is still under development, that’s why the whole ApiBundle is tagged with @experimental. This means that all code from ApiBundle is excluded from Backward Compatibility Promise.

To use this API remember to generate JWT token. For more information, please visit jwt package documentation.

This part of the documentation is about the currently developed unified API for the Sylius platform.

Introduction¶

Warning

The new, unified Sylius API is still under development, that’s why the whole ApiBundle is tagged with @experimental. This means that all code from ApiBundle is excluded from Backward Compatibility Promise. You can enable entire API by changing the flag sylius_api.enabled to true in config/packages/_sylius.yaml.

We have decided that we should rebuild our API and use API Platform to build a truly mature, multi-purpose API which can define a new standard for headless e-commerce backends.

We will be supporting API Platform out-of-the-box. Secondly, it means that both APIs (Admin API and Shop API) will be deprecated. We are not dropping them right now, but they will not receive further development. In the later phase, we should provide an upgrade path for currently working apps. Last, but not least, you can already track our progress. All the PR’s will be aggregated in this issue and the documentation can be already found here.

Authorization¶

In the new API all admin routes are protected by JWT authentication. If you would like to test these endpoints in our Swagger UI docs, you need to retrieve a JWT token first. You could do that by using an endpoint with default credentials for API administrators:

_images/api_platform_authentication_endpoint.png

In the response, you will get a token that has to be passed in each request header. In the Swagger UI, you can set the authentication token for each request.

_images/api_platform_authentication_response.png

Notice the Authorize button and unlocked padlock near the available URLs:

Click the Authorize button and put the authentication token (remember about the Bearer prefix):

After clicking Authorize, you should see locked padlock near URLs and the proper header should be added to each API call:

Sylius API paths¶

All paths in new API have the same prefix structure: /api/v2/admin/ or /api/v2/shop/ The /api/v2 prefix part indicates the API version and the /admin/ or /shop/ prefixes are necessary for authorization purposes. When you are adding a new path to API resource configuration, you should remember to add also proper prefix.

You can declare the entire path for each operation (without /api/v2/ as this part is configured globally):

<collectionOperation name="admin_get">
    <attribute name="method">GET</attribute>
    <attribute name="path">admin/orders</attribute>
</collectionOperation>

or you can add a proper prefix for all paths in the chosen resource:

<attribute name="route_prefix">shop</attribute>

Note

In some situations, you may need to add a path with a custom structure, in this case, you will probably need to configure also the appropriate access in the security file (config/security.yaml)

Legacy API¶

We have decided to rebuild our APIs and unify them with API Platform. Previously we had 2 separate APIs for shop (SyliusShopAPi Plugin), and for admin (SyliusAdminApiBundle). Both of them are using the FOSRestBundle, and make operation using commands and events. This approach is easy to understand and implement, but when we need to customize something we need to overwrite many files (command, event, command handler, event listener etc). The second reason to create a new Sylius API from scratch is that the API Platform is a modern framework for API and it replaces FOSRestBundle. We will fix security issues in our legacy APIs but all new features will be developed only in the new API.

Themes¶

Here you will learn basics about the Theming concept of Sylius. How to change the theme of your shop? keep reading!

Themes¶

Theming is a method of customizing how your channels look like in Sylius. Each channel can have a different theme.

What is the purpose of using themes?¶

There are some criteria that you have to analyze before choosing either standard Symfony template overriding or themes.

When you should choose standard template overriding:

you have only one channel
or you do not need different looks/themes on each of you channels
you need only basic changes in the views (changing colors, some blocks rearranging)

When you should use Sylius themes:

you have more than one channel for a single Sylius instance
and you want each channel to have their own look and behaviour
you change a lot of things in the views

How to enable themes in a project?¶

To use themes inside of your project you need to add these few lines to your config/packages/sylius_theme.yaml.

sylius_theme:
    sources:
        filesystem:
            directories:
                 - "%kernel.project_dir%/themes"

How to create themes?¶

Let’s see how to customize the login view inside of your custom theme.

Inside of the themes/ directory create a new directory for your theme:

Let it be CrimsonTheme/ for instance.

Create composer.json for your theme:

{
    "name": "acme/crimson-theme",
    "authors": [
        {
            "name": "James Potter",
            "email": "prongs@example.com"
        }
    ],
    "extra": {
        "sylius-theme": {
            "title": "Crimson Theme"
        }
    }
}

Install theme assets

Theme assets are installed by running the sylius:theme:assets:install command, which is supplementary for and should be used after assets:install.

bin/console sylius:theme:assets:install

The command run with --symlink or --relative parameters creates symlinks for every installed asset file, not for entire asset directory (eg. if AcmeBundle/Resources/public/asset.js exists, it creates symlink public/bundles/acme/asset.js leading to AcmeBundle/Resources/public/asset.js instead of symlink public/bundles/acme/ leading to AcmeBundle/Resources/public/). When you create a new asset or delete an existing one, it is required to rerun this command to apply changes (just as the hard copy option works).

Note

Whenever you install a new bundle with assets you will need to run sylius:theme:assets:install again to make sure they are accessible in your theme.

Customize a template:

In order to customize the login view you should take the content of @SyliusShopBundle/views/login.html.twig file and …

Before theme-bundle v2, paste it to your theme directory: themes/CrimsonTheme/SyliusShopBundle/views/login.html.twig (There is more information in the official documentation about theme structure v1.5.1)
From theme-bundle v2, paste it to your theme directory: themes/CrimsonTheme/templates/bundles/SyliusShopBundle/login.html.twig (There is more information in the official documentation about theme structure v2.0.0)

Let’s remove the registration column in this example:

{% extends '@SyliusShop/layout.html.twig' %}

{% form_theme form '@SyliusUi/Form/theme.html.twig' %}

{% import '@SyliusUi/Macro/messages.html.twig' as messages %}

{% block content %}
    {% include '@SyliusShop/Login/_header.html.twig' %}
    <div class="ui padded segment">
        <div class="ui one column very relaxed stackable grid">
            <div class="column">
                <h4 class="ui dividing header">{{ 'sylius.ui.registered_customers'|trans }}</h4>
                <p>{{ 'sylius.ui.if_you_have_an_account_sign_in_with_your_email_address'|trans }}.</p>
                {{ form_start(form, {'action': path('sylius_shop_login_check'), 'attr': {'class': 'ui loadable form', 'novalidate': 'novalidate'}}) }}
                {% include '@SyliusShop/Login/_form.html.twig' %}
                <button type="submit" class="ui blue submit button">{{ 'sylius.ui.login'|trans }}</button>
                <a href="{{ path('sylius_shop_request_password_reset_token') }}" class="ui right floated button">{{ 'sylius.ui.forgot_password'|trans }}</a>
                {{ form_end(form, {'render_rest': false}) }}
            </div>
        </div>
    </div>
{% endblock %}

Tip

Learn more about customizing templates here.

You can check major modifications in theme-bundle structure and configuration here

Choose your new theme on the channel:

In the administration panel go to channels and change the theme of your desired channel to Crimson Theme.

If changes are not yet visible, clear the cache:

php bin/console cache:clear

Learn more¶

Theme - Bundle Documentation.

Theming with BootstrapTheme¶

This tutorial will guide you on how to create your own theme based on BootstrapTheme using Webpack. If you haven’t used Webpack yet, here you can learn how to do it.

Tutorial is divided into 3 parts:

Creating a new theme based on BootstrapTheme
Webpack Encore configuration
Customization

1. Creating a new theme based on BootstrapTheme¶

Install BootstrapTheme

composer require sylius/bootstrap-theme

In the config/packages/_sylius.yaml file, add the path to the installed package

sylius_theme:
    sources:
        filesystem:
            directories:
                - "%kernel.project_dir%/vendor/sylius/bootstrap-theme"
                - "%kernel.project_dir%/themes"

Create your custom theme based on BootstrapTheme. In the themes directory, create a new folder - name it as you like, e.g. BootstrapChildTheme and create composer.json with basic information

{
    "name": "acme/bootstrap-child-theme",
    "description": "Bootstrap child theme",
    "license": "MIT",
    "authors": [
        {
            "name": "James Potter",
            "email": "prongs@example.com"
        }
    ],
    "extra": {
        "sylius-theme": {
            "title": "Bootstrap child theme",
            "parents": [ "sylius/bootstrap-theme" ]
        }
    }
}

Now you can go to the channel settings in the admin panel and select the created theme as default.

2. Webpack Encore configuration¶

You need to prepare a new theme for working with webpack and include it in the build process.

Install missing BootstrapTheme dependencies

yarn add sass-loader@^7.0.0 node-sass lodash.throttle -D
yarn add bootstrap bootstrap.native glightbox axios form-serialize @fortawesome/fontawesome-svg-core @fortawesome/free-brands-svg-icons @fortawesome/free-regular-svg-icons @fortawesome/free-solid-svg-icons

in theme/BootstrapChildTheme/assets create 2 files: entry.js and scss/index.scss

entry.js is the main file for your theme. All files used in the theme will be imported here. First, add the files used in the BootstrapTheme and your newly created scss file

import '../../../vendor/sylius/bootstrap-theme/assets/js/index';
import './scss/index.scss';
import '../../../vendor/sylius/bootstrap-theme/assets/media/sylius-logo.png';
import '../../../vendor/sylius/bootstrap-theme/assets/js/fontawesome';

index.scss is the main file for styles, import styles used in the BootstrapTheme

@import '../../../../vendor/sylius/bootstrap-theme/assets/scss/index';

In the webpack.config.js file, add configurations for the new theme

Encore.reset();
Encore
  .setOutputPath('public/bootstrap-theme')
  .setPublicPath('/bootstrap-theme')
  .addEntry('app', './themes/BootstrapChildTheme/assets/entry.js')
  .disableSingleRuntimeChunk()
  .cleanupOutputBeforeBuild()
  .enableSassLoader()
  .enableSourceMaps(!Encore.isProduction())
  .enableVersioning(Encore.isProduction());

const bootstrapThemeConfig = Encore.getWebpackConfig();
bootstrapThemeConfig.name = 'bootstrapTheme';

Also add bootstrapThemeConfig to export at the end of the file.

In the app config, add paths where the compiled files will be located:

In the config/packages/assets.yaml add:

framework:
    assets:
        packages:
            bootstrapTheme:
                json_manifest_path: '%kernel.project_dir%/public/bootstrap-theme/manifest.json'

and in the config/packages/webpack_encore.yaml add:

webpack_encore:
    output_path: '%kernel.project_dir%/public/build/default'
    builds:
        bootstrapTheme: '%kernel.project_dir%/public/bootstrap-theme'

Now you can use one of the commands yarn encore dev, yarn encore production or yarn encore dev-server to compile all assets. Open the page - everything should work.

3. Customization¶

Changing styles¶

To add new styles, create a new scss file in your theme’s assets folder, and then import it into the index.scss. After compilation, new styles should appear on the page.

You can also override the default styles used in BootstrapTheme by changing some variables. To do that, create a file _variables.scss in the assets folder, change e.g. primary color by typing $primary: blue;, and then import this file into index.scss.

Tip

Variables should be overwritten before importing styles from BootstrapTheme, so the _variables.scss file should be imported at the beginning of the index.scss file.

Adding new assets¶

To add new assets to the theme, such as scripts or images, simply place them in your theme’s directory and then import them into the file entry.js

Overwriting templates¶

To overwrite the template, copy the selected twig file from BootstrapTheme and paste it into the same place in your theme. For example, if you want to change something in the layout.html.twig file, copy it to themes/BootstrapChildTheme/SyliusShopBundle/views

Sylius Plus¶

Sylius Plus, which is a licensed edition of Sylius, gives you all the power of Open Source and much more. It comes with a set of enterprise-grade features and technical support from its creators. As the state-of-the-art eCommerce platform, it reduces risks and increases your ROI.

Documentation sections of The Book referring to Sylius Plus features are:

Loyalty Rule¶

Adding new Loyalty Rule Configuration to API¶

After creating a new loyalty rule configuration you need to add a new LoyaltyRuleActionDataTransformer that implements Sylius\Plus\Loyalty\Infrastructure\DataTransformer\LoyaltyRuleActionDataTransformerInterface To be more flexible, new LoyaltyRuleConfiguration is created by new DTO object: Sylius\Plus\Loyalty\Application\DTO\LoyaltyRuleAction that has configuration field as an array That field allows you to add any configuration and in the aftermath, you have to transform this object to Sylius\Plus\Loyalty\Domain\Model\LoyaltyRuleConfiguration\LoyaltyRuleConfigurationInterface instance by your custom LoyaltyRuleActionDataTransformer Exemplary LoyaltyRuleActionYourCustomConfigurationDataTransformer for new your_custom_configuration configuration type:

use Sylius\Plus\Loyalty\Application\DTO\LoyaltyRuleActionInterface as LoyaltyRuleActionInterfaceDTO;
use Sylius\Plus\Loyalty\Domain\Model\LoyaltyRuleActionInterface as LoyaltyRuleActionInterfaceModel;

final class LoyaltyRuleActionYourCustomConfigurationDataTransformer implements LoyaltyRuleActionDataTransformerInterface
{
    /** @var LoyaltyRuleActionFactoryInterface */
    private $loyaltyRuleActionFactory;

    public function __construct(LoyaltyRuleActionFactoryInterface $loyaltyRuleActionFactory)
    {
        $this->loyaltyRuleActionFactory = $loyaltyRuleActionFactory;
    }

    public function transform(LoyaltyRuleActionInterfaceDTO $object, string $to, array $context = []): LoyaltyRuleActionInterfaceModel
    {
        //$object is an input LoyaltyRuleActionInterfaceDTO instance that allow you get new changes and create/update a LoyaltyRuleActionInterfaceModel object

        if (isset($context['object_to_populate'])) {
            /** @var LoyaltyRuleActionInterfaceModel $loyaltyRuleAction */
            $loyaltyRuleAction = $context['object_to_populate'];

            //update object while using PUT or PATCH method

            return $loyaltyRuleAction;
        }

        //create new LoyaltyRuleActionInterfaceModel object while using POST method

        return $this
            ->loyaltyRuleActionFactory
            ->createNewWithDataAndConfiguration('your_custom_configuration', $configuration)
        ;
    }

    public function supportsTransformation(string $actionType): bool
    {
        return $actionType === 'your_custom_configuration';
    }
}

Next you must register LoyaltyRuleActionYourCustomConfigurationDataTransformer as a service with tag sylius_plus.api.loyalty_rule_action_data_transformer and key that is same as given configuration type:

<service id="...\LoyaltyRuleActionYourCustomConfigurationDataTransformer" public="true">
    <argument type="service" id="Sylius\Plus\Loyalty\Application\Factory\LoyaltyRuleActionFactory" />
    <tag name="sylius_plus.api.loyalty_rule_action_data_transformer" key="your_custom_configuration" />
</service>

Sylius Plugins¶

The collection of Sylius Plugins and basic introduction to the concept of plugins.

Sylius Plugins¶

Sylius as a platform has a lot of space for various customizations and extensions. It aims to provide a simple schema for developing plugins. Anything you can imagine can be implemented and added to the Sylius framework as a plugin.

What are the plugins for?¶

The plugins either modify or extend Sylius default behaviour, providing useful features that are built on top of the Sylius Core.

Exemplary features may be: Social media buttons, newsletter, wishlists, payment gateways integrations etc.

Tip

The list of all Sylius Plugins (official and approved) is available on the Sylius website here.

How to create a plugin for Sylius?¶

Sylius plugin is nothing more but a regular Symfony bundle adding custom behaviour to the default Sylius application.

The best way to create your own plugin is to use Sylius plugin skeleton, which has built-in infrastructure for designing and testing using Behat.

Note

This doc is a very short introduction to plugin development. For a more detailed guide please head to Sylius Plugins.

Quickstart to plugins development:

1. Create project using Composer.¶

composer create-project sylius/plugin-skeleton SyliusMyFirstPlugin

Note

The plugin can be created anywhere, not only inside a Sylius application, because it already has the test environment inside.

2. Get familiar with basic plugin design.¶

The skeleton comes with simple application that greets a customer. There are feature scenarios in features directory; exemplary bundle with a controller, a template and a routing configuration in src; and the testing infrastructure in tests.

Note

The tests/Application directory contains a sample Symfony application used to test your plugin.

3. Remove boilerplate files and rename your bundle.¶

In most cases you don’t want your Sylius plugin to greet the customer like it is now, so feel free to remove unnecessary controllers, assets and features. You will also want to change the plugin’s namespace from Acme\SyliusExamplePlugin to a more meaningful one. Keep in mind that these changes also need to be done in tests/Application and composer.json.

Tip

Refer to chapter 5 for the naming conventions to be used.

4. Implement your awesome features.¶

Looking at existing Sylius plugins like

is a great way to start developing your own plugins.

You are strongly encouraged to use BDD with Behat, phpspec and PhpUnit to ensure your plugin’s extraordinary quality.

Tip

For the plugins, the suggested way of modifying Sylius is using the Customization Guide. There you will find a lot of help while trying to modify templates, state machines, controllers and many, many more.

5. Naming conventions¶

Besides the way you are creating plugins (based on our skeleton or on your own), there are a few naming conventions that should be followed:

Repository name should use PascalCase, must have a Sylius* prefix and a Plugin suffix

Project composer name should use dashes as a separator, must have a sylius prefix and a plugin suffix, e.g.: sylius-invoice-plugin.

Bundle class name should start with vendor name, followed by Sylius and suffixed by Plugin (instead of Bundle), e.g.: VendorNameSyliusInvoicePlugin.

Bundle extension should be named similar, but suffixed by the Symfony standard Extension, e.g.: VendorNameSyliusInvoiceExtension.

Bundle class must use the Sylius\Bundle\CoreBundle\Application\SyliusPluginTrait trait.

Namespace should follow PSR-4. The top-level namespace should be the vendor name. The second-level should be prefixed by Sylius and suffixed by Plugin (e.g. VendorName\SyliusInvoicePlugin)

Note

Following the naming strategy for the bundle class & extension class prevents configuration key collision. Following the convention mentioned above generates the default configuration key as e.g. vendor_name_sylius_invoice_plugin.

The rules are to be applied to all bundles which will provide an integration with the whole Sylius platform (sylius/sylius or sylius/core-bundle as dependency).

Reusable components for the whole Symfony community, which will be based just on some Sylius bundles should follow the regular Symfony conventions.

Example¶

Assuming you are creating the invoicing plugin as used above, this will result in the following set-up.

1. Name your repository: vendor-name/sylius-invoice-plugin.

2. Create bundle class in src/VendorNameSyliusInvoicePlugin.php:

<?php

declare(strict_types=1);

namespace VendorName\SyliusInvoicePlugin;

use Sylius\Bundle\CoreBundle\Application\SyliusPluginTrait;
use Symfony\Component\HttpKernel\Bundle\Bundle;

final class VendorNameSyliusInvoicePlugin extends Bundle
{
    use SyliusPluginTrait;
}

3. Create extension class in src/DependencyInjection/VendorNameSyliusInvoiceExtension.php:

<?php

declare(strict_types=1);

namespace VendorName\SyliusInvoicePlugin\DependencyInjection;

use Symfony\Component\Config\FileLocator;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Extension\Extension;
use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;

final class VendorNameSyliusInvoiceExtension extends Extension
{
    public function load(array $configs, ContainerBuilder $container): void
    {
        $config = $this->processConfiguration($this->getConfiguration([], $container), $configs);
        $loader = new XmlFileLoader($container, new FileLocator(__DIR__ . '/../Resources/config'));
    }
}

4. In composer.json, define the correct namespacing for the PSR-4 autoloader:

{
    "autoload": {
        "psr-4": {
            "VendorName\\SyliusInvoicePlugin\\": "src/"
        }
    },
    "autoload-dev": {
        "psr-4": {
            "Tests\\VendorName\\SyliusInvoicePlugin\\": "tests/"
        }
    }
}

🏗️ Plugin Development Guide¶

Sylius plugins are one of the most powerful ways to extend Sylius functionalities. They’re not bounded by Sylius release cycle and can be developed quicker and more effectively. They also allow sharing our (developers) work in an open-source community, which is not possible with regular application customizations.

BDD methodology says the most accurate way to explain some process is using an example. With respect to that rule, let’s create some simple first plugin together!

Idea¶

The most important thing is a concept. You should be aware, that not every customization should be made as a plugin for Sylius. If you:

share the common logic between multiple projects
think provided feature could be useful for the whole Sylius community and want to share it for free or sell it

then you should definitely consider the creation of a plugin. On the other hand, if:

your feature is specific for your project
you don’t want to share your work in the community (maybe yet)

then don’t be afraid to make a regular Sylius customization.

Tip

For needs of this tutorial, we will implement a simple plugin, making it possible to mark a product variant available on demand.

How to start?¶

The first step is to create a new plugin using our PluginSkeleton.

composer create-project sylius/plugin-skeleton IronManSyliusProductOnDemandPlugin

Note

Remember about naming convention! Sylius plugin should start with your vendor name, followed by Sylius prefix and with Plugin suffix at the end. Let’s say your vendor name is IronMan. Come on IronMan, let’s create your plugin!

Naming changes¶

PluginSkeleton provides some default classes and configurations. However, they must have some default values and names that should be changed to reflect your plugin functionality. Basing on the vendor and plugin names established above, these are the changes that should be made:

In composer.json:
- sylius/plugin-skeleton -> iron-man/sylius-product-on-demand-plugin
- Acme example plugin for Sylius. -> Plugin allowing to mark product variants as available on demand in Sylius. (or sth similar)
- Acme\\SyliusExamplePlugin\\ -> IronMan\\SyliusProductOnDemandPlugin\\ (the same changes should be done in namespaces in src/ directory
- Tests\\Acme\\SyliusExamplePlugin\\ -> Tests\\IronMan\\SyliusProductOnDemandPlugin\\ (the same changes should be done in namespaces in tests/ directory
AcmeSyliusExamplePlugin should be renamed to IronManSyliusProductOnDemandPlugin
AcmeSyliusExampleExtension should be renamed to IronManSyliusProductOnDemandExtension
In src/DependencyInjection/Configuration.php:
- acme_sylius_example_plugin -> iron_man_sylius_product_on_demand_plugin
In tests/Application/config/bundles.php:
- Acme\SyliusExamplePlugin\AcmeSyliusExamplePlugin::class -> IronMan\SyliusProductOnDemandPlugin\IronManSyliusProductOnDemandPlugin::class
In phpspec.yml.dist (if you want to use PHPSpec in your plugin):
- Acme\SyliusExamplePlugin -> IronMan\SyliusProductOnDemandPlugin
Don’t forget to re-build up the list of files to autoload with composer dump-autoload

That’s it! All other files are just a boilerplate to show you what can be done in the Sylius plugin. They can be deleted with no harm:

All files from features/ directory
src/Controller/GreetingController.php
src/Resources/config/admin_routing.yml
src/Resources/config/shop_routing.yml
src/Resources/public/greeting.js
src/Resources/views/dynamic_greeting.html.twig
src/Resources/views/static_greeting.html.twig
All files from tests/Behat/Page/Shop/ (with corresponding services)
tests/Behat/Context/Ui/Shop/WelcomeContext.php (with corresponding service)

You should also delete Behat suite named greeting_customer from tests/Behat/Resources/suites.yml.

Important

You don’t have to remove all these files mentioned above. They can be adapted to suit your plugin functionality. However, as they provide default, dummy features only for the presentation reasons, it’s just easier to delete them and implement new ones on your own.

Important

After you have change name of plugin, please run in your main directory of plugin (cd MyPlugin/ && composer install). If you don’t rerun this command you may have this error : `bash $ (cd tests/Application && bin/console assets:install public -e test) PHP Fatal error: Uncaught Symfony\Component\Debug\Exception\ClassNotFoundException: Attempted to load class "Kernel" from namespace "Tests\FMDD\SyliusEmailOrderAdminPlugin\Application". Did you forget a "use" statement for e.g. "Symfony\Component\HttpKernel\Kernel" or "Sylius\Bundle\CoreBundle\Application\Kernel"? in C:\Users\FMDD\Plugins\SyliusEmailOrderAdminPlugin\tests\Application\bin\console:36 Stack trace: #0 {main} thrown in C:\Users\FMDD\Plugins\SyliusEmailOrderAdminPlugin\tests\Application\bin\console on line 36 `

Specification¶

We strongly encourage you to follow our BDD path in implementing Sylius plugins. In fact, proper tests are one of the requirements to have your plugin officially accepted.

Attention

Even though we’re big fans of our Behat and PHPSpec-based workflow, we do not enforce you to use the same libraries. We strongly believe that properly tested code is the biggest value, but everyone should feel well with their own tests. If you’re not familiar with PHPSpec, but know PHPUnit (or anything else) by heart - keep rocking with your favorite tool!

Scenario¶

Let’s start with describing how marking a product variant available on demand should work

@managing_product_variants
Feature: Marking a variant as available on demand
    In order to inform customer about possibility to order a product variant on demand
    As an Administrator
    I want to be able to mark product variant as available on demand

    Background:
        Given the store operates on a single channel in "United States"
        And the store has a "Iron Man Suite" configurable product
        And the product "Iron Man Suite" has a "Mark XLVI" variant priced at "$400000"
        And I am logged in as an administrator

    @ui
    Scenario: Marking product variant as available on demand
        When I want to modify the "Mark XLVI" product variant
        And I mark it as available on demand
        And I save my changes
        Then I should be notified that it has been successfully edited
        And this variant should be available on demand

What is really important, usually you don’t need to implement the whole Behat scenario on your own! In the example above only 2 steps would need a custom implementation. Rest of them can be easily reused from Sylius Behat suite.

Important

If you’re not familiar with our BDD workflow with Behat, take a look at our BDD guide. All Behat configurations (contexts, pages, services, suites etc.) are explained there in details.

Behavior implementation¶

<?php

declare(strict_types=1);

namespace Tests\IronMan\SyliusProductOnDemandPlugin\Behat\Context\Ui\Admin;

use Behat\Behat\Context\Context;
use IronMan\SyliusProductOnDemandPlugin\Entity\ProductVariantInterface;
use Tests\IronMan\SyliusProductOnDemandPlugin\Behat\Page\Ui\Admin\ProductVariantUpdatePageInterface;
use Webmozart\Assert\Assert;

final class ManagingProductVariantsContext implements Context
{
    /** @var ProductVariantUpdatePageInterface */
    private $productVariantUpdatePage;

    public function __construct(ProductVariantUpdatePageInterface $productVariantUpdatePage)
    {
        $this->productVariantUpdatePage = $productVariantUpdatePage;
    }

    /**
     * @When I mark it as available on demand
     */
    public function markVariantAsAvailableOnDemand(): void
    {
        $this->productVariantUpdatePage->markAsAvailableOnDemand();
    }

    /**
     * @Then /^(this variant) should be available on demand$/
     */
    public function thisVariantShouldBeAvailableOnDemand(ProductVariantInterface $productVariant): void
    {
        $this->productVariantUpdatePage->open([
            'id' => $productVariant->getId(),
            'productId' => $productVariant->getProduct()->getId(),
        ]);

        Assert::true($this->productVariantUpdatePage->isAvailableOnDemand());
    }
}

First step is done - we have a failing test, that that is going to go green when we implement a desired functionality.

Implementation¶

The goal of our plugin is simple - we need to extend the ProductVariant entity and provide a new flag, that could be set on the product variant form. Following customizations are done just like in the Sylius Customization Guide, take a look at customizing models, form and template.

Attention

PluginSkeleton is focused on delivering the most friendly and testable environment. That’s why in tests/Application directory, there is a tiny Sylius application placed, with your plugin already used. Thanks to that, you can test your plugin with Behat scenarios within Sylius application without installing it to any test app manually! There is, however, one important consequence of such an architecture. Everything that should be done by a plugin user (configuration import, templates copying etc.) should also be done in tests/Application to simulate the real developer behavior - and therefore make your new features testable.

Model¶

The only field we need to add is an additional $availableOnDemand boolean. To allow plugin’s user to use multiple plugins extending the same entity, it’s recommended to provide a trait with new properties and methods, together with ORM mapping written in annotations (if necessary). Providing an interface containing new methods is advisable.

<?php

// src/Model/ProductVariantTrait.php

declare(strict_types=1);

namespace IronMan\SyliusProductOnDemandPlugin\Model;

trait ProductVariantTrait
{
    /**
     * @var bool
     *
     * @ORM\Column(type="boolean", name="available_on_demand")
     */
    private $availableOnDemand = false;

    public function setAvailableOnDemand(bool $availableOnDemand): void
    {
        $this->availableOnDemand = $availableOnDemand;
    }

    public function isAvailableOnDemand(): bool
    {
        return $this->availableOnDemand;
    }
}

<?php

// src/Model/ProductVariantInterface.php

declare(strict_types=1);

namespace IronMan\SyliusProductOnDemandPlugin\Entity;

interface ProductVariantInterface
{
    public function setAvailableOnDemand(bool $availableOnDemand): void;

    public function isAvailableOnDemand(): bool;
}

Warning

Remember that if you modify or add some mapping, you should either provide a migration for the plugin user (that could be copied to their migration folder) or mention the requirement of migration generation in the installation instructions.

Form¶

To make our new field available in Admin panel, a form extension is required:

<?php

// src/Form/Extension/ProductVariantTypeExtension.php

declare(strict_types=1);

namespace IronMan\SyliusProductOnDemandPlugin\Form\Extension;

use Symfony\Component\Form\AbstractTypeExtension;
use Symfony\Component\Form\Extension\Core\Type\CheckboxType;
use Sylius\Bundle\ProductBundle\Form\Type\ProductVariantType;
use Symfony\Component\Form\FormBuilderInterface;

final class ProductVariantTypeExtension extends AbstractTypeExtension
{
    public function buildForm(FormBuilderInterface $builder, array $options): void
    {
        $builder->add('availableOnDemand', CheckboxType::class, [
            'label' => 'iron_man_sylius_product_on_demand_plugin.ui.available_on_demand',
        ]);
    }

    public function getExtendedType(): string
    {
        return ProductVariantType::class;
    }
}

Translation keys placed in src/Resources/translations/message.{locale}.yml will be resolved automatically.

# src/Resources/translations/message.en.yml

iron_man_sylius_product_on_demand_plugin:
    ui:
        available_on_demand: Available on demand

And in your services.yml file:

# src/Resources/config/services.yml

services:
    iron_man_sylius_product_on_demand_plugin.form.extension.type.product_variant:
        class: IronMan\SyliusProductOnDemandPlugin\Form\Extension\ProductVariantTypeExtension
        tags:
            - { name: form.type_extension, extended_type: Sylius\Bundle\ProductBundle\Form\Type\ProductVariantType }

Again, you must remember about importing src/Resources/config/services.yml in tests/Application/config/services.yaml.

Template¶

The last step is extending the template of a product variant form. It can be done in three ways:

by overwriting template
by using sonata block events
by writing a theme

For the needs of this tutorial, we will go the first way. What’s crucial, we need to determine which template should be overwritten. Naming for twig files in Sylius, both in ShopBundle and AdminBundle are pretty clear and straightforward. In this specific case, the template to override is src/Sylius/Bundle/AdminBundle/Resources/views/ProductVariant/Tab/_details.html.twig. It should be copied to src/Resources/views/SyliusAdminBundle/ProductVariant/Tab/ directory, and additional field should be placed somewhere in the template.

{# src/Resources/views/SyliusAdminBundle/ProductVariant/Tab/_details.html.twig #}

{#...#}

<div class="ui segment">
    <h4 class="ui dividing header">{{ 'sylius.ui.inventory'|trans }}</h4>
    {{ form_row(form.onHand) }}
    {{ form_row(form.tracked) }}
    {{ form_row(form.version) }}
    {{ form_row(form.availableOnDemand) }}
</div>

{#...#}

Warning

Beware! Implementing a new template on the plugin level is not everything! You must remember that this template should be copied to templates/bundles/SyliusAdminBundle/ directory (with whole catalogs structure, means /ProductVariant/Tab in the application that uses your plugin - and therefore it should be mentioned in installation instruction. The same thing should be done for your test application (you should have tests/Application/templates/bundles/SyliusAdminBundle/ catalog with this template copied).

Take a look at customizing the templates section in the documentation, for a better understanding of this topic.

Summary¶

Congratulations! You’ve created your first, fully tested and documented, customization to Sylius inside a Sylius plugin!

As a result, you should see a new field in product variant form:

_images/product_variant_available_on_demand.png

As you can see, there are some things to do at the beginning of development, but now, when you are already familiar with the whole structure, each next feature can be provided faster than the previous ones.

What’s next?¶

Of course, it’s only the beginning. You could think about plenty of new features associated with this new product variant field. What could be the next step?

customizing a product variant grid, to see new field on the index page
customizing template of product details page, to show information to customer if product is not available, but can be ordered on demand
allowing to order not available yet, but available on demand variants and therefore customizing the whole order processing and inventory operations

and even more. The limit is only your imagination (and business value, of course!). For more inspiration, we strongly recommend our customizing guide.

At the end, do not hesitate to contact us at contact@sylius.com when you manage to implement a new plugin. We would be happy to check it out and add it to our approved plugins list!

Note

Beware, that to have your plugin officially accepted, it needs to be created with respect to clean-code principles and properly tested!

Future¶

We are working hard to make creating Sylius plugins even more developer- and user-friendly. Be in touch with the PluginSkeleton notifications and other announcements from Sylius community. Our plugins base is growing fast - why not be a part of it?

See also

Sylius Plugins: The collection of Sylius Plugins and basic introduction to the concept of plugins.
The Customization Guide: Sylius customization techniques available to use also in plugins.

Official Sylius Plugins¶

Sylius as an organization is providing some of its own plugins in the open source model. All the official plugins developed by Sylius can be found in the github organization (just like the main repository).

You can recognize a Sylius official plugin by this badge in its readme:

The current list is as follows:

Sylius Store¶

As the Sylius is an open-source project, it has an awesome community of users and developers. Therefore our ecosystem flourishes with plugins created outside of our organization. These plugins can be listed in our Sylius Store or even become officially approved by us when they meet specific requirements.

How to have a Plugin listed on Sylius Store?¶

Since Sylius is an open-source platform, there is a precise flow for the plugin to become officially adopted by the community.

1. Develop the plugin using the official Plugin Development guide.

2. Remember about the tests and code quality! Check out Technical requirements for more details.

Warning

Beware! Your plugin needs to have at least one tag (even if it’s 0.1). We’re not putting plugins in dev-master version into the Sylius Store.

3. Send it to the project maintainers. The preferred way is to use plugin request submit form.

4. One of our Plugin Curators will contact you with the feedback regarding your plugin’s code quality, test suite, and general feeling. They will also ask you to provide some changes in the code (if needed) to make this plugin visible in the Sylius Store.

5. Wait for your Plugin to be featured in the list of plugins on the Sylius website.

Technical requirements¶

Below you can find a list of requirements that your plugin needs to fulfill to pass the Sylius Core Team review. Try to follow them and your plugin’s approval process will be faster and more efficient!

Must have¶

Every plugin must fulfill these requirements to be listed on the Sylius Store. We’re happy to accept new extensions to our platform, but it’s also crucial for us to keep their high standards.

Name of the plugin:

Does the name clearly say what kind of feature the plugin provides?
Does the plugin name contain the vendor’s name?
Are all configuration roots and all classes appropriately named?
Generally, does the plugin fulfills naming conventions?

Documentation:

Does the plugin contain a description of its features?
Is there a description of the plugin installation?
Does the documentation consist of any screenshots (if the plugin provides any visual content)?

Installation:

Is it possible to install the plugin on a fresh Sylius-Standard application with no problems?
Is every step needed for installation and configuration explained in the documentation? Are there any assumptions that could be confusing for less experienced developers?

Coding standards:

Does the code apply at least PSR-1?

Should have¶

If you want your plugin to be officially approved by Sylius Core Team, there are more things to do. Only plugins with the highest standards of code and properly developed test suite could get the “Approved by Sylius” mark, which makes them more visible in the community and ensures users about their quality. When Sylius approve a plugin, you can recognize it also by this badge below in its readme file:

Coding standards:

Does the code follow SOLID principles?
Are conventions in the code consistent with each other (are the same conventions used for the same concepts)?
Does the code apply some other PSR’s?

Tests:

Are there any unit tests for the plugin’s classes? They can be written in PHPSpec, PHPUnit or any other working and reliable unit testing library
Does the unit tests cover at least the most crucial classes in the plugin (those which contain important business logic)?
Does the plugin include some functional/acceptance tests (written in Behat/PHPUnit or similar tool)?
Are the core features of the plugin described and tests by them?
Do the functional/acceptance tests describe most of the application business-related features?

Continuous integration:

Is there any CI tool used in the plugin’s repository (CircleCI, Travis CI, Jenkins)?

Organization¶

This chapter describes the rules and processes we use to organize our work.

Organization¶

The Release Cycle¶

This document explains the release cycle of the Sylius project (i.e. the code & documentation hosted on the main Sylius/Sylius repository).

Sylius follows the Semantic Versioning strategy:

A new Sylius patch version (e.g. 1.0.1, 1.0.2, etc.) comes out usually once a month, depending on the number of bug fixes developed
A new Sylius minor version (e.g. 1.1, 1.2, etc.) is released depending on various factors (see below), usually once a few months

New Sylius minor releases will drop unsupported PHP versions.

Scope-based vs time-based¶

Sylius release cycle is not strictly time-based (contrary to the Symfony release cycle). Based on the experience from over 10 minor versions, we decided that time is not the only reason on which we should rely when planning the new Sylius’ version. Therefore, each new minor release of Sylius takes in consideration:

what we would like to include in it (features, improvements, fixes)
when we would like to release it (based on the Team capacity, estimated amount of work and experience from previous minor releases development)

Note

The natural consequence of such a decision is uncertainty regarding the exact time of the next minor version release. We try to estimate it as precisely as possible, but sometimes delays cannot be avoided. We believe that releasing a good product is more important than releasing it fast 🤖

Development¶

The full development period for any minor version is divided into two phases:

Development: First 5/6 of the time intended for the release to add new features and to enhance existing ones.
Stabilization: Last 1/6 of the time intended for the release to fix bugs, prepare the release, and wait for the whole Sylius ecosystem (third-party libraries, plugins, and projects using Sylius) to catch up.

During both periods, any new feature can be reverted if it won’t be finished in time or won’t be stable enough to be included in the coming release.

Maintenance¶

Each minor Sylius version is maintained for a fixed period of time after its release. This maintenance is divided into:

Bug fixes and security fixes: During this period, being eight months long, all issues can be fixed. The end of this period is referenced as being the end of maintenance of a release.
Security fixes only: During this period, being sixteen months long, only security related issues can be fixed. The end of this period is referenced as being the end of life of a release.

Future release¶

Version	Development starts	Stabilization starts	Release date
1.12	Feb 14, 2022	Q3 2022	Q3 2022

Supported versions¶

Version	Release date	End of maintenance	End of life	Status
1.11	Feb 14, 2022	Oct 13, 2022	Jun 17, 2023	Fully supported
1.10	Jun 29, 2021	May 14, 2022	Jan 14, 2023	Fully supported
1.9	Mar 1, 2021	Nov 1, 2021	Jul 1, 2022	Security support only

Unsupported versions¶

Version	Release date	End of maintenance	End of life
1.8	Sep 14, 2020	May 14, 2021	Jan 14, 2022
1.7	Mar 2, 2020	Nov 16, 2020	Jul 16, 2021
1.6	Aug 29, 2019	Apr 29, 2020	Dec 29, 2020
1.5	May 10, 2019	Jan 10, 2020	Sep 10, 2020
1.4	Feb 4, 2019	Oct 4, 2019	Jun 4, 2020
1.3	Oct 1, 2018	Jun 1, 2019	Feb 1, 2020
1.2	Jun 13, 2018	Feb 13, 2019	Oct 13, 2019
1.1	Feb 12, 2018	Oct 12, 2018	Jun 12, 2019
1.0	Sep 13, 2017	May 13, 2018	Jan 13, 2019

Backward Compatibility¶

All Sylius releases have to comply with our Backward Compatibility Promise.

Whenever keeping backward compatibility is not possible, the feature, the enhancement or the bug fix will be scheduled for the next major version.

Backward Compatibility Promise¶

Sylius follows a versioning strategy called Semantic Versioning. It means that only major releases include BC breaks, whereas minor releases include new features without breaking backwards compatibility.

Since Sylius is based on Symfony, our BC promise extends Symfony’s Backward Compatibility Promise with a few new rules and exceptions stated in this document. We also follow Symfony’s Experimental Features process to be able to innovate safely.

Minor and patch releases¶

Patch releases (such as 1.0.x, 1.1.x, etc.) do not require any additional work apart from cleaning the Symfony cache.

Minor releases (such as 1.1.0, 1.2.0, etc.) require to run database migrations.

Code covered¶

This BC promise applies to all of Sylius’ PHP code except for:

code tagged with @internal or @experimental tags

event listeners

model and repository interfaces

PHPUnit tests (located at tests/, src/**/Tests/)

PHPSpec tests (located at src/**/spec/)

Behat tests (located at src/Sylius/Behat/)

final controllers (their service name is still covered with BC promise)

Additional rules¶

Models & model interfaces¶

In order to fulfill the constant Sylius’ need to evolve, model interfaces are excluded from this BC promise. Methods may be added to the interface, but backwards compatibility is promised as long as your custom model extends the one from Sylius, which is true for most cases.

Repositories & repository interfaces¶

Following the reasoning same as above and due to technological constraints, repository interfaces are also excluded from this BC promise.

Event listeners¶

They are excluded from this BC promise, but they should be as simple as possible and always call another service. Behaviour they’re providing (the end result) is still included in BC promise.

Final controllers¶

It is allowed to change their dependencies, but the behaviour they’re providing is still included in BC promise. The service name and class name will not change.

Routing¶

The currently present routes cannot have their name changed, but optional parameters might be added to them. All the new routes will start with sylius_ prefix in order to avoid conflicts.

Services¶

Services names cannot change, but new services might be added with sylius. or Sylius\\ prefix.

Templates¶

Neither template events, block or templates themselves cannot be deleted or renamed.

Deprecations¶

Before we remove or replace code covered by this backwards compatibility promise, it is first deprecated in the next minor release before being removed in the next major release.

A code is marked as deprecated by adding a @deprecated PHPDoc to relevant classes, methods, properties:

/**
 * @deprecated Deprecated since version 1.X. Use XXX instead.
 */

The deprecation message should indicate the version in which the class/method was deprecated and how the feature was replaced (whenever possible).

A PHP \E_USER_DEPRECATED error must also be triggered to help people with the migration:

@trigger_error(
    'XXX() is deprecated since version 2.X and will be removed in 2.Y. Use XXX instead.',
    \E_USER_DEPRECATED
);

Sylius Team¶

The following people are creating Sylius Core Team:

Łukasz Chruściel (lchrusciel)
Grzegorz Sadowski (GSadee)
Mateusz Zalewski (Zales0123)
Loïc Frémont (loic425)
Victor Vasiloi (vvasiloi)
Stephane Decock (Roshyo)

Theirs accountabilities are:

Reviews and merges pull requests
Triages and reacts to issues

In addition, they are supported by:

Product Owner¶

Builds and refines the Product Backlog and Roadmap
Gathers feedback from all stakeholders

This role is currently held by:

Magdalena Sadowska (CoderMaggie)

Vision¶

Creates and iterates over the long term Sylius Vision

This role is currently held by:

Paweł Jędrzejewski (pjedrzejewski)

Core Release Manager¶

Defines and publishes the Release Cycle and Backward Compatibility Promise
Coaches contributors and Core Team on the backwards-compatibility impact of code changes

This role is currently held by:

Mateusz Zalewski (Zales0123)

Plugins Manager¶

Triages and reviews incoming issues and pull requests on supported plugins
Schedules and releases new versions of the supported plugins

This role is currently held by:

Grzegorz Sadowski (GSadee)

Architect¶

Makes key architectural decisions and documenting them in form of ADRs
Research and prototyping of possible architectures and technical solutions upon request, laying out foundations if necessary, proactively seeking input and feedback from our Open Source community and customers
Defines target versions of key dependencies and drives their upgrade initiatives

This role is currently held by:

Łukasz Chruściel (lchrusciel)
Mateusz Zalewski (Zales0123)

API Designer¶

Reviews the PRs related to API
Minimizes the feature parity gap between regular and headless Sylius implementations but also old APIs and the new Unified API
Defines API contracts (request & response schema and conventions)
Maintains the ShopAPIPlugin and AdminApiBundle
Provides actionable instructions for migration to the new API

This role is currently held by:

Łukasz Chruściel (lchrusciel)

Documentation Editor-in-chief¶

Evolves the high-level structure of our documentation
Reviews and merges PR’s to the documentation
Maintains the documentation issues
Takes care of the READMEs in all Sylius repositories

This role is currently held by:

Magdalena Sadowska (CoderMaggie)

Sylius Technical Libraries¶

Developing and maintaining Sylius Technical Libraries
Developing and maintaining SyliusLabs organization repositories

This role is currently held by:

Mateusz Zalewski (Zales0123)

Support¶

How to get support for Sylius?

Support¶

Besides documentation we have a very friendly community which provides support for all Sylius users seeking help!

At Sylius we have 3 main channels for communication and support.

Slack¶

Most of us use Slack for their online communication with co-workers. We know that it is not convenient to have another chat window open, therefore we’ve chosen Slack for the live communication with the community. Slack is supposed to handle the most urgent questions in the fastest way possible.

The most important rooms for newcomers are:

#general - for discussions about Sylius development itself, #docs - for discussions related to the documentation, #support - for asking questions and helping others, #random - for the non-work banter and water cooler conversation.

But there are many more specific channels also. If you have any suggestions regarding its organization, please let us know on Slack!

Slack requires inviting new members, but this can be done automatically, just go to sylius.com/slack, enter your email and you will get an invitation. If possible, please use your GitHub username - it will help us to recognize each other easily!

Forum¶

In response to the rapid growth of our Ecosystem, we decided it is necessary to launch a brand new platform for support and exchanging experience. On the contrary to Slack, our Forum is much easier to follow, on Slack unless you are a part of the discussion when it is happening, it might be difficult to catch up when you have been offline. Forum has a search engine so it is convenient to browse for what is interesting for you.

The Sylius Community Forum is meant for everyone who is interested in eCommerce technology and Sylius. We invite both existing and new community members to join the discussion and help shape the ecosystem, products & services we are building. Get to know other community members, ask for support, suggest an improvement or discuss your challenge.

You can register via email, Twitter & GitHub by going to https://forum.sylius.com/ and hitting the “Sign-Up” button.

StackOverflow¶

We also encourage asking Sylius related questions on the stackoverflow.com platform.

Search for the question before asking, maybe someone has already solved your problem,
Be specific about your question, this is what SO is about, concrete questions and solutions,
Be sure to tag them with sylius tag - it will make it easier to find for people who can answer it.
Try also tagging your questions with the symfony tag - the Symfony community is very big and might be really helpful with Sylius related questions, as we are basing on Symfony.

To view all Sylius related questions - visit this link. You can also search for phrase.

Support

Contributing¶

Guides you how to contribute to Sylius.

Contributing¶

Note

This section is based on the great Symfony documentation.

Install to Contribute¶

Before you can start contributing to Sylius code or documentation, you should install Sylius locally.

To install Sylius main application from our main repository and contribute, run the following command:

composer create-project sylius/sylius

This will create a new Sylius project in sylius directory. When all the dependencies are installed, you should create .env file basing on provides .env.dist files. The most important parameter that need to be set, is DATABASE_URL.

DATABASE_URL=mysql://username:password@host/database_name_%kernel.environment%

After everything is in place, run the following commands:

cd sylius # Move to the newly created directory
php bin/console sylius:install

The sylius:install command actually runs several other commands, which will ask you some questions and check if everything is setup to run Sylius properly.

This package contains our main Sylius development repository, with all the components and bundles in the src/ folder.

In order to see a fully functional frontend you will need to install its assets.

Sylius already has a gulpfile.babel.js, therefore you just need to get Gulp using Node.js.

Having Node.js installed go to your project directory and run:

yarn install

And now you can use gulp for installing views, by just running a simple command:

yarn build

For the contributing process questions, please refer to the Contributing Guide that comes up in the following chapters:

Contributing Code¶

Submitting a Patch¶

Patches are the best way to provide a bug fix or to propose enhancements to Sylius.

Step 1: Setup your Environment¶

Install the Software Stack¶

Before working on Sylius, set a Symfony friendly environment up with the following software:

Git
PHP version 7.3 or above
MySQL

Configure Git¶

Set your user information up with your real name and a working email address:

git config --global user.name "Your Name"
git config --global user.email "you@example.com"

Tip

If you are new to Git, you are highly recommended to read the excellent and free ProGit book.

Tip

If your IDE creates configuration files inside the directory of the project, you can use global .gitignore file (for all projects) or .git/info/exclude file (per project) to ignore them. See Github’s documentation.

Tip

Windows users: when installing Git, the installer will ask what to do with line endings, and will suggest replacing all LF with CRLF. This is the wrong setting if you wish to contribute to Sylius. Selecting the as-is method is your best choice, as Git will convert your line feeds to the ones in the repository. If you have already installed Git, you can check the value of this setting by typing:

git config core.autocrlf

This will return either “false”, “input” or “true”; “true” and “false” being the wrong values. Change it to “input” by typing:

git config --global core.autocrlf input

Replace –global by –local if you want to set it only for the active repository

Get the Sylius Source Code¶

Get the Sylius source code:

Create a GitHub account and sign in;
Fork the Sylius repository (click on the “Fork” button);
After the “forking action” has completed, clone your fork locally (this will create a Sylius directory):

git clone git@github.com:USERNAME/Sylius.git

Add the upstream repository as a remote:

cd sylius
git remote add upstream git://github.com/Sylius/Sylius.git

Step 2: Work on your Patch¶

The License¶

Before you start, you must know that all patches you are going to submit must be released under the MIT license, unless explicitly specified in your commits.

Choose the right Base Branch¶

Before starting to work on a patch, you must determine on which branch you need to work. It will be:

1.7, if you are fixing a bug for an existing feature or want to make a change that falls into the list of acceptable changes in patch versions
master, if you are adding a new feature.

Note

All bug fixes merged into the 1.7 maintenance branch are also merged into master on a regular basis.

Create a Topic Branch¶

Each time you want to work on a patch for a bug or on an enhancement, create a topic branch, starting from the previously chosen base branch:

git checkout -b BRANCH_NAME master

Tip

Use a descriptive name for your branch (issue_XXX where XXX is the GitHub issue number is a good convention for bug fixes).

The above checkout command automatically switches the code to the newly created branch (check the branch you are working on with git branch).

Work on your Patch¶

Work on the code as much as you want and commit as much as you want; but keep in mind the following:

Practice BDD, which is the development methodology we use at Sylius;
Follow coding standards (use git diff --check to check for trailing spaces – also read the tip below);
Do atomic and logically separate commits (use the power of git rebase to have a clean and logical history);
Squash irrelevant commits that are just about fixing coding standards or fixing typos in your own code;
Never fix coding standards in some existing code as it makes the code review more difficult (submit CS fixes as a separate patch);
In addition to this “code” pull request, you must also update the documentation when appropriate. See more in contributing documentation section.
Write good commit messages (see the tip below).

Tip

A good commit message is composed of a summary (the first line), optionally followed by a blank line and a more detailed description. The summary should start with the Component you are working on in square brackets ([Cart], [Taxation], …). Use a verb (fixed ..., added ..., …) to start the summary and don’t add a period at the end.

Prepare your Patch for Submission¶

When your patch is not about a bug fix (when you add a new feature or change an existing one for instance), it must also include the following:

An explanation of the changes in the relevant CHANGELOG file(s) (the [BC BREAK] or the [DEPRECATION] prefix must be used when relevant);
An explanation on how to upgrade an existing application in the relevant UPGRADE file(s) if the changes break backward compatibility or if you deprecate something that will ultimately break backward compatibility.

Step 3: Submit your Patch¶

Whenever you feel that your patch is ready for submission, follow the following steps.

Rebase your Patch¶

Before submitting your patch, update your branch (needed if it takes you a while to finish your changes):

If you are basing on the master branch:

git checkout master
git fetch upstream
git merge upstream/master
git checkout BRANCH_NAME
git rebase master

If you are basing on the 1.7 branch:

git checkout 1.7
git fetch upstream
git merge upstream/1.7
git checkout BRANCH_NAME
git rebase 1.7

When doing the rebase command, you might have to fix merge conflicts. git status will show you the unmerged files. Resolve all the conflicts, then continue the rebase:

git add ... # add resolved files
git rebase --continue

Push your branch remotely:

git push --force-with-lease origin BRANCH_NAME

Make a Pull Request¶

Warning

Please remember that bug fixes must be submitted against the 1.7 branch, but features and deprecations against the master branch. Just accordingly to which branch you chose as the base branch before.

You can now make a pull request on the Sylius/Sylius GitHub repository.

To ease the core team work, always include the modified components in your pull request message, like in:

[Cart] Fixed something
[Taxation] [Addressing] Added something

The pull request description must include the following checklist at the top to ensure that contributions may be reviewed without needless feedback loops and that your contributions can be included into Sylius as quickly as possible:

| Q               | A
| --------------- | -----
| Branch?         | 1.7 or master
| Bug fix?        | no/yes
| New feature?    | no/yes
| BC breaks?      | no/yes
| Deprecations?   | no/yes
| Related tickets | fixes #X, partially #Y, mentioned in #Z
| License         | MIT

An example submission could now look as follows:

| Q               | A
| --------------- | -----
| Branch?         | 1.7
| Bug fix?        | yes
| New feature?    | no
| BC breaks?      | no
| Deprecations?   | no
| Related tickets | fixes #12
| License         | MIT

The whole table must be included (do not remove lines that you think are not relevant).

Some answers to the questions trigger some more requirements:

If you answer yes to “Bug fix?”, check if the bug is already listed in the Sylius issues and reference it/them in “Related tickets”;

If you answer yes to “New feature?”, you should submit a pull request to the documentation;

If you answer yes to “BC breaks?”, the patch must contain updates to the relevant CHANGELOG and UPGRADE files;

If you answer yes to “Deprecations?”, the patch must contain updates to the relevant CHANGELOG and UPGRADE files;

If some of the previous requirements are not met, create a todo-list and add relevant items:

- [ ] Fix the specs as they have not been updated yet
- [ ] Submit changes to the documentation
- [ ] Document the BC breaks

If the code is not finished yet because you don’t have time to finish it or because you want early feedback on your work, add an item to todo-list:

- [ ] Finish the feature
- [ ] Gather feedback for my changes

As long as you have items in the todo-list, please prefix the pull request title with “[WIP]”.

In the pull request description, give as much details as possible about your changes (don’t hesitate to give code examples to illustrate your points). If your pull request is about adding a new feature or modifying an existing one, explain the rationale for the changes. The pull request description helps the code review.

Rework your Patch¶

Based on the feedback on the pull request, you might need to rework your patch. Before re-submitting the patch, rebase with your base branch (master or 1.7), don’t merge; and force the push to the origin:

git rebase -f upstream/master
git push --force-with-lease origin BRANCH_NAME

or

git rebase -f upstream/1.7
git push --force-with-lease origin BRANCH_NAME

Note

When doing a push --force-with-lease, always specify the branch name explicitly to avoid messing other branches in the repo (--force-with-lease tells Git that you really want to mess with things so do it carefully).

Often, Sylius team members will ask you to “squash” your commits. This means you will convert many commits to one commit. To do this, use the rebase command:

git rebase -i upstream/master
git push --force-with-lease origin BRANCH_NAME

or

git rebase -i upstream/1.7
git push --force-with-lease origin BRANCH_NAME

After you type this command, an editor will popup showing a list of commits:

pick 1a31be6 first commit
pick 7fc64b4 second commit
pick 7d33018 third commit

To squash all commits into the first one, remove the word pick before the second and the last commits, and replace it by the word squash or just s. When you save, Git will start rebasing, and if successful, will ask you to edit the commit message, which by default is a listing of the commit messages of all the commits. When you are finished, execute the push command.

Security Issues¶

If you think that you have found a security issue in Sylius, don’t use the bug tracker and do not post it publicly. Instead, all security issues must be sent to security@sylius.com. Emails sent to this address are forwarded to the Sylius Core Team Members responsible for the framework’s security. Please do not reveal the issue publicly until the security fix is released and announced by Sylius.

Note

We will not publish security releases during Saturday or Sunday, except for the vulnerabilities made public.

Coding Standards¶

You can check your code for Sylius coding standard by running the following command:

vendor/bin/ecs check src tests

Some of the violations can be automatically fixed by running the same command with --fix suffix like:

vendor/bin/ecs check src tests --fix

Note

Most of Sylius coding standard checks are extracted to SyliusLabs/CodingStandard package so that reusing them in your own projects or Sylius plugins is effortless. Too learn about details, take a look at its README.

Sylius License¶

Sylius is released under the MIT license.

According to Wikipedia:

“It is a permissive license, meaning that it permits reuse within proprietary software on the condition that the license is distributed with that software. The license is also GPL-compatible, meaning that the GPL permits combination and redistribution with software that uses the MIT License.”

The License¶

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Contributing Documentation¶

Contributing to the Documentation¶

The documentation is as important as the code. It follows the exact same principles: DRY, tests, ease of maintenance, extensibility, optimization, and refactoring just to name a few. And of course, documentation has bugs, typos, hard to read tutorials, and many more.

Contributing¶

Before contributing, you need to become familiar with the markup language used by the documentation.

The Sylius documentation is hosted on GitHub, in the main repository:

https://github.com/Sylius/Sylius

If you want to submit a patch, fork the official repository on GitHub and then clone your fork to you local destination:

git clone git@github.com:YOUR_USERNAME/Sylius.git

Under the name origin you will have from now on the access to your fork. Add also the main repository as the upstream remote.

git remote add upstream git@github.com:Sylius/Sylius.git

Choose the right Base Branch¶

Before starting to work on a patch, you must determine on which branch you need to work. It will be:

1.x, if you are fixing or adding docs for features that exist in one of those versions,
master, if you are documenting a new feature, that was not in 1.x

Note

All bug fixes merged into the 1.x maintenance branches are also merged into master on a regular basis.

Create a dedicated branch for your changes (for organization):

git checkout -b docs/improving_foo_and_bar

You can now make your changes directly to this branch and commit them. Remember to name your commits descriptively, keep them possibly small, with just unitary changes (such that change something only in one part of the docs, not everywhere).

When you’re done, push this branch to your GitHub fork and initiate a pull request.

Your pull request will be reviewed, you will be asked to apply fixes if necessary and then it will be merged into the main repository.

Testing Documentation¶

To test the documentation before a commit you need to install Sphinx and needed dependencies.

Tip

Official Sphinx installation guide : www.sphinx-doc.org

Note

If you are using docker - you can try building your documentation with: Sylius Documentation Builder

Our recommendation is to install Sphinx via Pip.

We suggest to install & use Sphinx v1.8.5

pip3 install -Iv sphinx==1.8.5

pip3 install --no-cache-dir -r ./docs/requirements.txt

Then run

sphinx-build -b html ./docs ./docs/build

and view the generated HTML files in the docs/build directory. You can open them in your browser and check how they look!

Warning

If you have problems with using Sphinx, please make sure that you’re using Python 3. Using pip, try to uninstall old dependencies and install latest version Python and Sphinx.

pip uninstall sphinx
pip3 uninstall sphinx

If you have installed old sphinx by your operating system tools like: brew, apt-get or yum, you have to uninstall it too.

Creating a Pull Request¶

Following the example, the pull request will be from your improving_foo_and_bar branch to the Sylius master branch by default.

GitHub covers the topic of pull requests in detail.

Note

The Sylius documentation is licensed under a Creative Commons Attribution-Share Alike 3.0 Unported License.

Warning

You should always prefix the PR name with a [Documentation] tag!

You can prefix the title of your pull request in a few cases:

[WIP] (Work in Progress) is used when you are not yet finished with your pull request, but you would like it to be reviewed. The pull request won’t be merged until you say it is ready.
[ComponentName] if you are contributing docs that regard on of the Sylius Components.
[BundleName] when you add documentation of the Sylius Bundles.
[Behat] if you modify something in the the BDD guide.
[API] when you are contributing docs to the API guide.

For instance if your pull request is about documentation of some feature of the Resource bundle, but it is still a work in progress it should look like : [WIP][Documentation][ResourceBundle] Arbitrary feature documentation.

Documenting new Features or Behavior Changes¶

If you’re documenting a brand new feature or a change that’s been made in Sylius, you should precede your description of the change with a .. versionadded:: 1.X tag and a short description:

.. versionadded:: 1.3
    The ``getProductDiscount`` method was introduced in Sylius 1.3.

Standards¶

All documentation in the Sylius Documentation should follow the documentation standards.

Reporting an Issue¶

The easiest contributions you can make is reporting issues: a typo, a grammar mistake, a bug in a code example, a missing explanation, and so on.

Steps:

Submit a new issue in the GitHub tracker;
(optional) Submit a patch.

Documentation Format¶

The Sylius documentation uses the reStructuredText as its markup language and Sphinx for building the output (HTML, PDF, …).

reStructuredText¶

reStructuredText “is an easy-to-read, what-you-see-is-what-you-get plaintext markup syntax and parser system”.

You can learn more about its syntax by reading existing Sylius documents or by reading the reStructuredText Primer on the Sphinx website.

If you are familiar with Markdown, be careful as things are sometimes very similar but different:

Lists starts at the beginning of a line (no indentation is allowed);
Inline code blocks use double-ticks (``like this``).

Sphinx¶

Sphinx is a build system that adds some nice tools to create documentation from the reStructuredText documents. As such, it adds new directives and interpreted text roles to standard reST markup.

Syntax Highlighting¶

All code examples uses PHP as the default highlighted language. You can change it with the code-block directive:

.. code-block:: yaml

    { foo: bar, bar: { foo: bar, bar: baz } }

If your PHP code begins with <?php, then you need to use html+php as the highlighted pseudo-language:

.. code-block:: html+php

    <?php echo $this->foobar(); ?>

Note

A list of supported languages is available on the Pygments website.

Configuration Blocks¶

Whenever you show a configuration, you must use the configuration-block directive to show the configuration in all supported configuration formats (PHP, YAML, and XML)

.. configuration-block::

    .. code-block:: yaml

        # Configuration in YAML

    .. code-block:: xml

        <!-- Configuration in XML //-->

    .. code-block:: php

        // Configuration in PHP

The previous reST snippet renders as follow:

YAML
```
# Configuration in YAML
```
XML
```

```
PHP
```
// Configuration in PHP
```

The current list of supported formats are the following:

Markup format	Displayed
html	HTML
xml	XML
php	PHP
yaml	YAML
json	JSON
jinja	Twig
html+jinja	Twig
html+php	PHP
ini	INI
php-annotations	Annotations

Adding Links¶

To add links to other pages in the documents use the following syntax:

:doc:`/path/to/page`

Using the path and filename of the page without the extension, for example:

:doc:`/book/architecture`

:doc:`/components_and_bundles/bundles/SyliusAddressingBundle/installation`

The link’s text will be the main heading of the document linked to. You can also specify an alternative text for the link:

:doc:`Simple CRUD </components_and_bundles/bundles/SyliusResourceBundle/installation>`

You can also link to pages outside of the documentation, for instance to the Github.

`Github`_ //it is an intext link.

At the bottom of the document in which you are using your link add a reference:

.. _`Github`: http://www.github.com // with a url to your desired destination.

Documentation Standards¶

In order to help the reader as much as possible and to create code examples that look and feel familiar, you should follow these standards.

Sphinx¶

The following characters are chosen for different heading levels: level 1 is =, level 2 -, level 3 ~, level 4 . and level 5 ";
Each line should break approximately after the first word that crosses the 72nd character (so most lines end up being 72-78 characters);
The :: shorthand is preferred over .. code-block:: php to begin a PHP code block (read the Sphinx documentation to see when you should use the shorthand);
Inline hyperlinks are not used. Separate the link and their target definition, which you add on the bottom of the page;
Inline markup should be closed on the same line as the open-string;

Example¶

Example
=======

When you are working on the docs, you should follow the
`Sylius Documentation`_ standards.

Level 2
-------

A PHP example would be::

    echo 'Hello World';

Level 3
~~~~~~~

.. code-block:: php

    echo 'You cannot use the :: shortcut here';

.. _`Sylius Documentation`: https://docs.sylius.com/en/latest/contributing/documentation/standards.html

Code Examples¶

The code follows the Sylius Coding Standards as well as the Twig Coding Standards;
To avoid horizontal scrolling on code blocks, we prefer to break a line correctly if it crosses the 85th character, which in many IDEs is signalised by a vertical line;
When you fold one or more lines of code, place ... in a comment at the point of the fold. These comments are:

// ... (php),
# ... (yaml/bash),
{# ... #} (twig)
<!-- ... --> (xml/html),
; ... (ini),
... (text)

When you fold a part of a line, e.g. a variable value, put ... (without comment) at the place of the fold;
Description of the folded code: (optional) If you fold several lines: the description of the fold can be placed after the ... If you fold only part of a line: the description can be placed before the line;
If useful to the reader, a PHP code example should start with the namespace declaration;
When referencing classes, be sure to show the use statements at the top of your code block. You don’t need to show all use statements in every example, just show what is actually being used in the code block;
If useful, a codeblock should begin with a comment containing the filename of the file in the code block. Don’t place a blank line after this comment, unless the next line is also a comment;
You should put a $ in front of every bash line.

Formats¶

Configuration examples should show recommended formats using configuration blocks. The recommended formats (and their orders) are:

Configuration (including services and routing): YAML
Validation: XML
Doctrine Mapping: XML

Example¶

// src/Foo/Bar.php
namespace Foo;

use Acme\Demo\Cat;
// ...

class Bar
{
    // ...

    public function foo($bar)
    {
        // set foo with a value of bar
        $foo = $bar;

        $cat = new Cat($foo);

        // ... check if $bar has the correct value

        return $cat->baz($bar, /*...*/);
    }
}

Caution

In YAML you should put a space after { and before } (e.g. { _controller: ... }), but this should not be done in Twig (e.g. {'hello' : 'value'}).

Language Standards¶

For sections, use the following capitalization rules: Capitalization of the first word, and all other words, except for closed-class words:

The Vitamins are in my Fresh California Raisins
Please use appropriate, informative, rather formal language;
Do not place any kind of advertisements in the documentation;
The documentation should be neutral, without judgements, opinions. Make sure you do not favor anyone, our community is great as a whole, there is no need to point who is better than the rest of us;
You should use a form of you instead of we (i.e. avoid the first person point of view: use the second instead);
When referencing a hypothetical person, such as “a user with a session cookie”, gender-neutral pronouns (they/their/them) should be used. For example, instead of:
- he or she, use they
- him or her, use them
- his or her, use their
- his or hers, use theirs
- himself or herself, use themselves

Sylius Documentation License¶

The Sylius documentation is licensed under a Creative Commons Attribution-Share Alike 3.0 Unported License.

You are free:

to Share — to copy, distribute and transmit the work;
to Remix — to adapt the work.

Under the following conditions:

Attribution — You must attribute the work in the manner specified by the author or licensor (but not in any way that suggests that they endorse you or your use of the work);
Share Alike — If you alter, transform, or build upon this work, you may distribute the resulting work only under the same or similar license to this one.

With the understanding that:

Waiver — Any of the above conditions can be waived if you get permission from the copyright holder;
Public Domain — Where the work or any of its elements is in the public domain under applicable law, that status is in no way affected by the license;
Other Rights — In no way are any of the following rights affected by the license:
- Your fair dealing or fair use rights, or other applicable copyright exceptions and limitations;
- The author’s moral rights;
- Rights other persons may have either in the work itself or in how the work is used, such as publicity or privacy rights.
Notice — For any reuse or distribution, you must make clear to others the license terms of this work. The best way to do this is with a link to this web page.

This is a human-readable summary of the Legal Code (the full license).

Contributing Translations¶

Sylius application is fully translatable, and what is more it is translated by the community to a variety of languages!

Sylius translations are kept on Crowdin.

How to contribute translations in any language?¶

The process of submitting new translations in any existing language is really simple:

First of all you need an account on Crowdin. If do not have one, please sign up.
Find a piece of Sylius and translate it to chosen language here.
After approval from the Crowdin community it will be automatically synced into the main repository.

That’s all! You can start translating.

Contributing Code¶

Contributing Documentation¶

Contributing Translations¶

The Customization Guide¶

The Customization Guide is helpful while wanting to adapt Sylius to your personal business needs.

The Customization Guide¶

The Customization Guide is helpful while wanting to adapt Sylius to your personal business needs.

Customizing Models¶

All models in Sylius are placed in the Sylius\Component\*ComponentName*\Model namespaces alongside with their interfaces.

Warning

Many models in Sylius are extended in the Core component. If the model you are willing to override exists in the Core you should be extending the Core one, not the base model from the component.

Warning

Removing the generated and executed doctrine migration may cause warnings while a new migration is executed. To avoid it, we suggest you do not delete the migration.

Note

Note that there are translatable models in Sylius also. The guide to translatable entities can be found below the regular one.

Why would you customize a Model?¶

To give you an idea of some purposes of models customizing have a look at a few examples:

Add flag field to the Country
Add secondNumber to the Customer
Change the reviewSubject of a Review (in Sylius we have ProductReviews but you can imagine for instance a CustomerReview)
Add icon to the PaymentMethod

And of course many similar operations limited only by your imagination.

Let’s now see how you should perform such customizations.

How to customize a Model?¶

Tip

You can browse the full implementation of this example on this GitHub Pull Request.

Let’s take the Sylius\Component\Addressing\Country as an example. This one is not extended in Core. How can you check that?

For the Country run:

php bin/console debug:container --parameter=sylius.model.country.class

As a result you will get the Sylius\Component\Addressing\Model\Country - this is the class that you need to be extending.

Assuming that you would want to add another field on the model - for instance a flag, where the flag is a variable that stores your image URL

1. The first thing to do is to add your field to the App\Entity\Addressing\Country class, which extends the base Sylius\Component\Addressing\Model\Country class.

Apply the following changes to the src/Entity/Addressing/Country.php file that already exists in Sylius-Standard.

<?php

declare(strict_types=1);

namespace App\Entity\Addressing;

use Doctrine\ORM\Mapping as ORM;
use Sylius\Component\Addressing\Model\Country as BaseCountry;
use Sylius\Component\Addressing\Model\CountryInterface;

/**
 * @ORM\Entity()
 * @ORM\Table(name="sylius_country")
 */
class Country extends BaseCountry implements CountryInterface
{
    /** @ORM\Column(type="string", nullable=true) */
    private $flag;

    public function getFlag(): ?string
    {
        return $this->flag;
    }

    public function setFlag(string $flag): void
    {
        $this->flag = $flag;
    }
}

2. After that you’ll need to check the model’s class in the config/packages/_sylius.yaml.

Under the sylius_* where * is the name of the bundle of the model you are customizing, in our case it will be the SyliusAddressingBundle -> sylius_addressing.

That in Sylius-Standard configuration is overridden already.

sylius_addressing:
    resources:
        country:
            classes:
                model: App\Entity\Addressing\Country

You can check if the configuration in config/_sylius.yaml is correct by running:

php bin/console debug:container --parameter=sylius.model.country.class

If all is well the output should look like:

---------------------------- -------------------------------------------
 Parameter                    Value
---------------------------- -------------------------------------------
 sylius.model.country.class   App\Entity\Addressing\Country
---------------------------- -------------------------------------------

Tip

In some cases you will see an error stating that the there is something wrong with the resource configuration: Unrecognized option "classes" under... When this happens, please refer to How to get Sylius Resource configuration from the container?.

3. Update the database. There are two ways to do it.

via direct database schema update:

php bin/console doctrine:schema:update --force

via migrations:

Which we strongly recommend over updating the schema.

php bin/console doctrine:migrations:diff
php bin/console doctrine:migrations:migrate

Tip

Read more about the database modifications and migrations in the Symfony documentation here.

4. Additionally if you want to give the administrator an ability to add the flag to any of countries, you’ll need to update its form type. Check how to do it here.

What happens while overriding Models?¶

Parameter sylius.model.country.class contains App\Entity\Addressing\Country.
sylius.repository.country represents Doctrine repository for your new class.
sylius.manager.country represents Doctrine object manager for your new class.
sylius.controller.country represents the controller for your new class.
All Doctrine relations to Sylius\Component\Addressing\Model\Country are using your new class as target-entity, you do not need to update any mappings.
CountryType form type is using your model as data_class.
Sylius\Component\Addressing\Model\Country is automatically turned into Doctrine Mapped Superclass.

How to customize a translatable Model?¶

Tip

You can browse the full implementation of this example on this GitHub Pull Request.

One of translatable entities in Sylius is the Shipping Method. Let’s try to extend it with a new field. Shipping methods may have different delivery time, let’s save it on the estimatedDeliveryTime field.

Just like for regular models you can also check the class of translatable models like that:

php bin/console debug:container --parameter=sylius.model.shipping_method.class

1. The first thing to do is to add your own fields in class App\Entity\Shipping\ShippingMethod extending the base Sylius\Component\Core\Model\ShippingMethod class.

Apply the following changes to the src/Entity/Shipping/ShippingMethod.php file existing in Sylius-Standard.

<?php

declare(strict_types=1);

namespace App\Entity\Shipping;

use Doctrine\ORM\Mapping as ORM;
use Sylius\Component\Core\Model\ShippingMethod as BaseShippingMethod;
use Sylius\Component\Core\Model\ShippingMethodInterface;
use Sylius\Component\Shipping\Model\ShippingMethodTranslationInterface;

/**
 * @ORM\Entity()
 * @ORM\Table(name="sylius_shipping_method")
 */
class ShippingMethod extends BaseShippingMethod implements ShippingMethodInterface
{
    /** @ORM\Column(type="string",nullable=true) */
    private $estimatedDeliveryTime;

    public function getEstimatedDeliveryTime(): ?string
    {
        return $this->estimatedDeliveryTime;
    }

    public function setEstimatedDeliveryTime(?string $estimatedDeliveryTime): void
    {
        $this->estimatedDeliveryTime = $estimatedDeliveryTime;
    }

    protected function createTranslation(): ShippingMethodTranslationInterface
    {
        return new ShippingMethodTranslation();
    }
}

Note

Remember to set the translation class properly, just like above in the createTranslation() method.

2. After that you’ll need to check the model’s class in the config/packages/_sylius.yaml.

Under the sylius_* where * is the name of the bundle of the model you are customizing, in our case it will be the SyliusShippingBundle -> sylius_shipping.

That in Sylius-Standard configuration is overridden already, but you may check if it is correctly overridden.

sylius_shipping:
    resources:
        shipping_method:
            classes:
                model: App\Entity\Shipping\ShippingMethod

Configuration sylius_shipping: is provided by default in the sylius-standard

3. Update the database. There are two ways to do it.

via direct database schema update:

php bin/console doctrine:schema:update --force

via migrations:

Which we strongly recommend over updating the schema.

php bin/console doctrine:migrations:diff
php bin/console doctrine:migrations:migrate

Tip

Read more about the database modifications and migrations in the Symfony documentation here.

4. Additionally if you need to add the estimatedDeliveryTime to any of your shipping methods in the admin panel, you’ll need to update its form type. Check how to do it here.

Warning

If you want the new field of your entity to be translatable, you need to extend the Translation class of your entity. In case of the ShippingMethod it would be the Sylius\Component\Shipping\Model\ShippingMethodTranslation. Also the form on which you will add the new field should be the TranslationType.

How to customize translatable fields of a translatable Model?¶

Tip

You can browse the full implementation of this example on this GitHub Pull Request.

Suppose you want to add a translatable property to a translatable entity, for example to the Shipping Method. Let’s assume that you would like the Shipping method to include a message with the delivery conditions. Let’s save it on the deliveryConditions field.

Just like for regular models you can also check the class of translatable models like that:

php bin/console debug:container --parameter=sylius.model.shipping_method_translation.class

1. In order to add a translatable property to your entity, start from defining it on the class AppEntityShippingShippingMethodTranslation is already there in the right place.

Apply the following changes to the src/Entity/Shipping/ShippingMethodTranslation.php file existing in Sylius-Standard.

<?php

declare(strict_types=1);

namespace App\Entity\Shipping;

use Doctrine\ORM\Mapping as ORM;
use Sylius\Component\Shipping\Model\ShippingMethodTranslation as BaseShippingMethodTranslation;
use Sylius\Component\Shipping\Model\ShippingMethodTranslationInterface;

/**
 * @ORM\Entity()
 * @ORM\Table(name="sylius_shipping_method_translation")
 */
class ShippingMethodTranslation extends BaseShippingMethodTranslation implements ShippingMethodTranslationInterface
{
    /** @ORM\Column(type="string", nullable=true) */
    private $deliveryConditions;

    public function getDeliveryConditions(): ?string
    {
        return $this->deliveryConditions;
    }

    public function setDeliveryConditions(?string $deliveryConditions): void
    {
        $this->deliveryConditions = $deliveryConditions;
    }
}

2. Implement the getter and setter methods of the interface on the App\Entity\Shipping\ShippingMethod class.

<?php

declare(strict_types=1);

namespace App\Entity\Shipping;

use Doctrine\ORM\Mapping as ORM;
use Sylius\Component\Core\Model\ShippingMethod as BaseShippingMethod;
use Sylius\Component\Core\Model\ShippingMethodInterface;
use Sylius\Component\Shipping\Model\ShippingMethodTranslationInterface;

/**
 * @ORM\Entity()
 * @ORM\Table(name="sylius_shipping_method")
 */
class ShippingMethod extends BaseShippingMethod implements ShippingMethodInterface
{
    public function getDeliveryConditions(): ?string
    {
        return $this->getTranslation()->getDeliveryConditions();
    }

    public function setDeliveryConditions(?string $deliveryConditions): void
    {
        $this->getTranslation()->setDeliveryConditions($deliveryConditions);
    }

    protected function createTranslation(): ShippingMethodTranslationInterface
    {
        return new ShippingMethodTranslation();
    }
}

Note

Remember that if the original entity is not translatable you will need to initialize the translations collection in the constructor, and use the TranslatableTrait. Take a careful look at the Sylius translatable entities.

3. After that you’ll need to override the model’s class in the config/packages/_sylius.yaml.

Under the sylius_* where * is the name of the bundle of the model you are customizing, in our case it will be the SyliusShippingBundle -> sylius_shipping.

sylius_shipping:
    resources:
        shipping_method:
            classes:
                model: App\Entity\Shipping\ShippingMethod
            translation:
                classes:
                    model: App\Entity\Shipping\ShippingMethodTranslation

Configuration sylius_addressing: is provided by default in the sylius-standard

4. Update the database. There are two ways to do it.

via direct database schema update:

php bin/console doctrine:schema:update --force

via migrations:

Which we strongly recommend over updating the schema.

php bin/console doctrine:migrations:diff
php bin/console doctrine:migrations:migrate

Tip

Read more about the database modifications and migrations in the Symfony documentation here.

5. If you need to add delivery conditions to your shipping methods in the admin panel, you’ll need to update its form type. Check how to do it here.

Good to know¶

See also

All the customizations can be done either in your application directly or in Plugins!

Customizing Forms¶

The forms in Sylius are placed in the Sylius\Bundle\*BundleName*\Form\Type namespaces and the extensions will be placed in AppFormExtension.

Why would you customize a Form?¶

There are plenty of reasons to modify forms that have already been defined in Sylius. Your business needs may sometimes slightly differ from our internal assumptions.

You can:

add completely new fields,
modify existing fields, make them required, change their HTML class, change labels etc.,
remove fields that are not used.

How to customize a Form?¶

Tip

You can browse the full implementation of this example on this GitHub Pull Request.

If you want to modify the form for the Customer Profile in your system there are a few steps that you should take. Assuming that you would like to (for example):

Add a secondaryPhoneNumber field,
Remove the gender field,
Change the label for the lastName from sylius.form.customer.last_name to app.form.customer.surname

These will be the steps that you will have to take to achieve that:

1. If you are planning to add new fields remember that beforehand they need to be added on the model that the form type is based on.

In case of our example if you need to have the secondaryPhoneNumber on the model and the entity mapping for the Customer resource. To get to know how to prepare that go there.

2. Create a Form Extension.

Your form has to extend a proper base class. How can you check that?

For the CustomerProfileType run:

php bin/console debug:container sylius.form.type.customer_profile

As a result you will get the Sylius\Bundle\CustomerBundle\Form\Type\CustomerProfileType - this is the class that you need to be extending.

<?php

declare(strict_types=1);

namespace App\Form\Extension;

use Sylius\Bundle\CustomerBundle\Form\Type\CustomerProfileType;
use Symfony\Component\Form\AbstractTypeExtension;
use Symfony\Component\Form\Extension\Core\Type\TextType;
use Symfony\Component\Form\FormBuilderInterface;

final class CustomerProfileTypeExtension extends AbstractTypeExtension
{
    public function buildForm(FormBuilderInterface $builder, array $options): void
    {
        $builder
            // Adding new fields works just like in the parent form type.
            ->add('secondaryPhoneNumber', TextType::class, [
                'required' => false,
                'label' => 'app.form.customer.secondary_phone_number',
            ])
            // To remove a field from a form simply call ->remove(`fieldName`).
            ->remove('gender')
            // You can change the label by adding again the same field with a changed `label` parameter.
            ->add('lastName', TextType::class, [
                'label' => 'app.form.customer.surname',
            ]);
    }

    public static function getExtendedTypes(): iterable
    {
        return [CustomerProfileType::class];
    }
}

Note

Of course remember that you need to define new labels for your fields in the translations\messages.en.yaml for english contents of your messages.

3. After creating your class, register this extension as a service in the config/services.yaml:

Caution

Remember! Service registration is not needed if you have autoconfiguration enabled in your services container.

services:
    app.form.extension.type.customer_profile:
        class: App\Form\Extension\CustomerProfileTypeExtension
        tags:
            - { name: form.type_extension, extended_type: Sylius\Bundle\CustomerBundle\Form\Type\CustomerProfileType }

Note

Of course remember that you need to render the new fields you have created, and remove the rendering of the fields that you have removed in your views.

In our case you will need to copy the original template from vendor/sylius/sylius/src/Sylius/Bundle/ShopBundle/Resources/views/Account/profileUpdate.html.twig to templates/bundles/SyliusShopBundle/Account/ and add the fields inside the copy.

{{ form_row(form.phoneNumber) }}
{{ form_row(form.subscribedToNewsletter) }}

<!-- your fields -->
{{ form_row(form.birthday) }}
{{ form_row(form.secondaryPhoneNumber) }}

{{ sonata_block_render_event('sylius.shop.account.profile.update.form', {'customer': customer, 'form': form}) }}

Need more information?¶

Warning

Some of the forms already have extensions in Sylius. Learn more about Extensions here.

For instance the ProductVariant admin form is defined under Sylius/Bundle/ProductBundle/Form/Type/ProductVariantType.php and later extended in Sylius/Bundle/CoreBundle/Form/Extension/ProductVariantTypeExtension.php. If you again extend the base type form like this:

services:
    app.form.extension.type.product_variant:
        class: App\Form\Extension\ProductVariantTypeMyExtension
        tags:
            - { name: form.type_extension, extended_type: Sylius\Bundle\ProductBundle\Form\Type\ProductVariantType, priority: -5 }

your form extension will also be executed. Whether before or after the other extensions depends on priority tag set.

How to customize forms that are already extended in Core?¶

Tip

You can browse the full implementation of this example on this GitHub Pull Request.

Having a look at the extensions and possible additionally defined event handlers can also be useful when form elements are embedded dynamically, as is done in the ProductVariantTypeExtension by the CoreBundle:

<?php

// ...

final class ProductVariantTypeExtension extends AbstractTypeExtension
{
    public function buildForm(FormBuilderInterface $builder, array $options): void
    {
        // ...

        $builder->addEventListener(FormEvents::PRE_SET_DATA, function (FormEvent $event) {
            $productVariant = $event->getData();

            $event->getForm()->add('channelPricings', ChannelCollectionType::class, [
                'entry_type' => ChannelPricingType::class,
                'entry_options' => function (ChannelInterface $channel) use ($productVariant) {
                    return [
                        'channel' => $channel,
                        'product_variant' => $productVariant,
                        'required' => false,
                    ];
                },
                'label' => 'sylius.form.variant.price',
            ]);
        });
    }

    // ...

}

The channelPricings get added on FormEvents::PRE_SET_DATA, so when you wish to remove or alter this form definition, you will also have to set up an event listener and then remove the field:

<?php

//...

final class ProductVariantTypeMyExtension extends AbstractTypeExtension
{
    // ...

    public function buildForm(FormBuilderInterface $builder, array $options): void
    {
        //...

        $builder
            ->addEventListener(FormEvents::PRE_SET_DATA, function (FormEvent $event) {
                $event->getForm()->remove('channelPricings');
            })
            ->addEventSubscriber(new AddCodeFormSubscriber(NULL, ['label' => 'app.form.my_other_code_label']))
        ;

        // ...


    }
}

Adding constraints inside a form extension¶

Warning

When adding your constraints dynamically from inside a form extension, be aware to add the correct validation groups.

Although it is advised to follow the Validation Customization Guide, it might happen that you want to define the form constraints from inside the form extension. They will not be used unless the correct validation group(s) has been added. The example below shows how to add the default sylius group to a constraint.

Tip

You can browse the full implementation of this example on this GitHub Pull Request.

<?php

// ...

final class CustomerProfileTypeExtension extends AbstractTypeExtension
{
    // ...

    public function buildForm(FormBuilderInterface $builder, array $options): void
    {
        //...

        $builder
        // Adding new fields works just like in the parent form type.
        ->add('secondaryPhoneNumber', TextType::class, [
            'required' => false,
            'label' => 'app.form.customer.secondary_phone_number',
            'constraints' => [
                new Length([
                    'min' => 6,
                    'max' => 10,
                    'groups' => ['sylius'],
                ]),
            ],
        ]);

        // ...

    }

    // ...

}

Overriding forms completely¶

Tip

If you need to create a new form type on top of an existing one - create this new alternative form type and define getParent() to the old one. See details in the Symfony docs.

Good to know¶

See also

All the customizations can be done either in your application directly or in Plugins!

Customizing Repositories¶

Warning

In Sylius we are using both default Doctrine repositories and the custom ones. Often you will be needing to add your very own methods to them. You need to check before which repository is your resource using.

Why would you customize a Repository?¶

Different sets of different resources can be obtained in various scenarios in your application. You may need for instance:

finding Orders by a Customer and a chosen Product

finding Products by a Taxon

finding Comments by a Customer

How to customize a Repository?¶

Tip

You can browse the full implementation of this example on this GitHub Pull Request.

Let’s assume that you would want to find products that you are running out of in the inventory.

1. Create your own repository class under the App\Repository namespace. Remember that it has to extend a proper base class. How can you check that?

For the ProductRepository run:

php bin/console debug:container sylius.repository.product

As a result you will get the Sylius\Bundle\CoreBundle\Doctrine\ORM\ProductRepository - this is the class that you need to be extending. To make your class more reusable, you should create a new interface src/Repository/ProductRepositoryInterface.php which will extend Sylius\Component\Core\Repository\ProductRepositoryInterface

<?php

declare(strict_types=1);

namespace App\Repository;

use Sylius\Component\Core\Repository\ProductRepositoryInterface as BaseProductRepositoryInterface;

interface ProductRepositoryInterface extends BaseProductRepositoryInterface
{
    public function findAllByOnHand(int $limit): array;
}

<?php

namespace App\Repository;

use Sylius\Bundle\CoreBundle\Doctrine\ORM\ProductRepository as BaseProductRepository;

class ProductRepository extends BaseProductRepository
{
    public function findAllByOnHand(int $limit = 8): array
    {
        return $this->createQueryBuilder('o')
            ->addSelect('variant')
            ->addSelect('translation')
            ->leftJoin('o.variants', 'variant')
            ->leftJoin('o.translations', 'translation')
            ->addOrderBy('variant.onHand', 'ASC')
            ->setMaxResults($limit)
            ->getQuery()
            ->getResult()
        ;
    }
}

We are using the Query Builder in the Repositories. As we are selecting Products we need to have a join to translations, because they are a translatable resource. Without it in the query results we wouldn’t have a name to be displayed.

We are sorting the results by the count of how many products are still available on hand, which is saved on the onHand field on the specific variant of each product. Then we are limiting the query to 8 by default, to get only 8 products that are low in stock.

2. In order to use your repository you need to configure it in the config/packages/_sylius.yaml. As you can see in the _sylius.yaml you already have a basic configuration, now you just need to add your repository and override resourceRepository

sylius_product:
    resources:
        product:
            classes:
            #...
                repository: App\Repository\ProductRepository
            #...

3. After configuring the sylius.repository.product service has your findByOnHand() method available. You can now use your method in anywhere when you are operating on the Product repository. For example you can configure new route:

app_shop_partial_product_index_by_on_hand:
path: /partial/products/by-on-hand
methods: [GET]
defaults:
    _controller: sylius.controller.product:indexAction
    _sylius:
        template: '@SyliusShop/Product/_horizontalList.html.twig'
        repository:
            method: findAllByOnHand
            arguments: [4]
        criteria: false
    paginate: false
    limit: 100

What happens while overriding Repositories?¶

The parameter sylius.repository.product.class contains App\Repository\ProductRepository.
The repository service sylius.repository.product is using your new class.
Under the sylius.repository.product service you have got all methods from the base repository available plus the one you have added.

Good to know¶

See also

All the customizations can be done either in your application directly or in Plugins!

Customizing Factories¶

Warning

Some factories may already be decorated in the Sylius Core. You need to check before decorating which factory (Component or Core) is your resource using.

Why would you customize a Factory?¶

Differently configured versions of resources may be needed in various scenarios in your application. You may need for instance to:

create a Product with a Supplier (which is your own custom entity)

create a disabled Product (for further modifications)

create a ProductReview with predefined description

and many, many more.

How to customize a Factory?¶

Tip

You can browse the full implementation of this example on this GitHub Pull Request.

Let’s assume that you would want to have a possibility to create disabled products.

1. Create your own factory class in the App\Factory namespace. Remember that it has to implement a proper interface. How can you check that?

For the ProductFactory run:

php bin/console debug:container sylius.factory.product

As a result you will get the Sylius\Component\Product\Factory\ProductFactory - this is the class that you need to decorate. Take its interface (Sylius\Component\Product\Factory\ProductFactoryInterface) and implement it.

<?php

declare(strict_types=1);

namespace App\Factory;

use Sylius\Component\Product\Model\ProductInterface;
use Sylius\Component\Product\Factory\ProductFactoryInterface;

final class ProductFactory implements ProductFactoryInterface
{
    /** @var ProductFactoryInterface  */
    private $decoratedFactory;

    public function __construct(ProductFactoryInterface $factory)
    {
        $this->decoratedFactory = $factory;
    }

    public function createNew(): ProductInterface
    {
        return $this->decoratedFactory->createNew();
    }

    public function createWithVariant(): ProductInterface
    {
        return $this->decoratedFactory->createWithVariant();
    }

    public function createDisabled(): ProductInterface
    {
        /** @var ProductInterface $product */
        $product = $this->decoratedFactory->createWithVariant();

        $product->setEnabled(false);

        return $product;
    }
}

2. In order to decorate the base ProductFactory with your implementation you need to configure it as a decorating service in the config/services.yaml.

services:
    app.factory.product:
        class: App\Factory\ProductFactory
        decorates: sylius.factory.product
        arguments: ['@app.factory.product.inner']
        public: false

3. You can use the new method of the factory in routing.

After the sylius.factory.product has been decorated it has got the new createDisabled() method. To actually use it overwrite sylius_admin_product_create_simple route like below in config/routes.yaml:

# config/routes.yaml
sylius_admin_product_create_simple:
    path: /products/new/simple
    methods: [GET, POST]
    defaults:
        _controller: sylius.controller.product:createAction
        _sylius:
            section: admin
            factory:
                method: createDisabled # like here for example
            template: SyliusAdminBundle:Crud:create.html.twig
            redirect: sylius_admin_product_update
            vars:
                subheader: sylius.ui.manage_your_product_catalog
                templates:
                    form: SyliusAdminBundle:Product:_form.html.twig
                route:
                    name: sylius_admin_product_create_simple

Good to know¶

See also

All the customizations can be done either in your application directly or in Plugins!

Learn more¶

ResourceBundle documentation

Customizing Controllers¶

All Sylius resources use the Sylius\Bundle\ResourceBundle\Controller\ResourceController by default, but some of them have already been extended in Bundles. If you want to override a controller action, check which controller you should be extending.

Note

There are two types of controllers we can define in Sylius:

Resource Controllers - are based only on one Entity, so they return only the resources they have in their name. For instance a ProductController should return only products.

Standard Controllers - non-resource; these may use many entities at once, they are useful on more general pages. We are defining these controllers only if the actions we want cannot be done through yaml configuration - like sending emails.

Tip

You can browse the full implementation of these examples on this GitHub Pull Request.

Why would you customize a Controller?¶

To add your custom actions you need to override controllers. You may need to:

add a generic action that will render a list of recommended products with a product on its show page.
render a partial template that cannot be done via yaml resource action.

How to customize a Resource Controller?¶

Imagine that you would want to render a list of best selling products in a partial template that will be reusable anywhere. Assuming that you already have a method on the ProductRepository - you can see such an example here. Having this method you may be rendering its result in a new action of the ProductController using a partial template.

See example below:

1. Create a new Controller class under the App\Controller namespace.

Remember that it has to extend a proper base class. How can you check that?

For the ProductController run:

php bin/console debug:container sylius.controller.product

As a result you will get the Sylius\Bundle\ResourceBundle\Controller\ResourceController - this is the class that you need to extend.

Now you have to create the controller that will have a generic action that is basically the showAction from the ResourceController extended by getting a list of recommended products from your external api.

<?php

declare(strict_types=1);

namespace App\Controller;

use Sylius\Bundle\ResourceBundle\Controller\ResourceController;
use Sylius\Component\Resource\ResourceActions;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;

class ProductController extends ResourceController
{
    public function showAction(Request $request): Response
    {
        $configuration = $this->requestConfigurationFactory->create($this->metadata, $request);

        $this->isGrantedOr403($configuration, ResourceActions::SHOW);
        $product = $this->findOr404($configuration);

        // some custom provider service to retrieve recommended products
        $recommendationService = $this->get('app.provider.product');

        $recommendedProducts = $recommendationService->getRecommendedProducts($product);

        $this->eventDispatcher->dispatch(ResourceActions::SHOW, $configuration, $product);

        if ($configuration->isHtmlRequest()) {
            return $this->render($configuration->getTemplate(ResourceActions::SHOW . '.html'), [
                'configuration' => $configuration,
                'metadata' => $this->metadata,
                'resource' => $product,
                'recommendedProducts' => $recommendedProducts,
                $this->metadata->getName() => $product,
            ]);
        }

        return $this->createRestView($configuration, $product);
    }
}

2. In order to use your controller and its actions you need to configure it in the config/packages/_sylius.yaml.

sylius_product:
    resources:
        product:
            classes:
                controller: App\Controller\ProductController

3. Disable autowire for your controller in config/services.yaml

App\Controller\ProductController:
    autowire: false

Tip

Run php bin/console debug:container sylius.controller.product to make sure the class has changed to your implementation.

4. Finally you’ll need to add routes in the config/routes.yaml.

app_product_show_index:
    path: /product/show
    methods: [GET]
    defaults:
        _controller: sylius.controller.product::showAction

How to customize a Standard Controller?¶

Let’s assume that you would like to add some logic to the Homepage.

1. Create a new Controller class under the App\Controller\Shop namespace.

If you still need the methods of the original HomepageController, then copy its body to the new class.

<?php

declare(strict_types=1);

namespace App\Controller\Shop;

use Symfony\Component\HttpFoundation\Response;
use Twig\Environment;

final class HomepageController
{
    /** @var Environment */
    private $twig;

    public function __construct(Environment $twig)
    {
        $this->twig = $twig;
    }

    public function indexAction(): Response
    {
        return new Response($this->twig->render('@SyliusShop/Homepage/index.html.twig'));
    }

    public function customAction(): Response
    {
        return new Response($this->twig->render('custom.html.twig'));
    }
}

2. The next thing you have to do is to override the sylius.controller.shop.homepage service definition in the config/services.yaml.

# config/services.yaml
services:
    sylius.controller.shop.homepage:
        class: App\Controller\Shop\HomepageController
        autowire: true
        tags: ['controller.service_arguments']

Tip

Run php bin/console debug:container sylius.controller.shop.homepage to make sure the class has changed to your implementation.

3. Finally you’ll need to add routes in the config/routes.yaml.

app_shop_custom_action:
    path: /custom
    methods: [GET]
    defaults:
        _controller: sylius.controller.shop.homepage::customAction

From now on your customAction of the HomepageController will be available alongside the indexAction from the base class.

Good to know¶

See also

All the customizations can be done either in your application directly or in Plugins!

Customizing Validation¶

The default validation group for all resources is sylius, but you can configure your own validation.

How to customize validation?¶

Tip

You can browse the full implementation of these examples on this GitHub Pull Request.

Let’s take the example of changing the length of name for the Product entity - watch out the field name is hold on the ProductTranslation model.

In the sylius validation group the minimum length is equal to 2. What if you’d want to have at least 10 characters?

1. Create the config/validator/validation.yaml.

In this file you need to overwrite the whole validation of your field that you are willing to modify. Take this configuration from the src/Sylius/Bundle/ProductBundle/Resources/config/validation/ProductTranslation.xml - you can choose format xml or yaml.

Give it a new, custom validation group - [app_product].

Sylius\Component\Product\Model\ProductTranslation:
    properties:
        name:
            - NotBlank:
                message: sylius.product.name.not_blank
                groups: [app_product]
            - Length:
                min: 10
                minMessage: sylius.product.name.min_length
                max: 255
                maxMessage: sylius.product.name.max_length
                groups: [app_product]

Tip

When using custom validation messages see here how to add them.

2. Configure the new validation group in the config/services.yaml.

# config/services.yaml
parameters:
    sylius.form.type.product_translation.validation_groups: [app_product]
    sylius.form.type.product.validation_groups: [app_product] # the product class also needs to be aware of the translation's validation

Done. Now in all forms where the Product name is being used, your new validation group will be applied, not letting users add products with name shorter than 10 characters.

Tip

When you would like to use group sequence validation, like so. Be sure to use [Default] as validation group. Otherwise your getGroupSequence() method will not be called.

Good to know¶

See also

All the customizations can be done either in your application directly or in Plugins!

Customizing Menus¶

Adding new positions in your menu is done via events.

You have got the Sylius\Bundle\UiBundle\Menu\Event\MenuBuilderEvent with FactoryInterface and ItemInterface of KnpMenu, this lets you manipulate the whole menu.

You’ve got eight events that you should be subscribing to:

sylius.menu.shop.account # For the menu of the MyAccount section in shop
sylius.menu.admin.main # For the Admin Panel menu
sylius.menu.admin.customer.show # For the buttons menu on top of the show page of the Customer (/admin/customers/{id})
sylius.menu.admin.order.show # For the buttons menu on top of the show page of the Order (/admin/orders/{id})
sylius.menu.admin.product.form # For the tabular menu on the left hand side of the new/edit pages of the Product (/admin/products/new & /admin/products/{id}/edit)
sylius.menu.admin.product.update # For the buttons menu on top of the update page of the Product (/admin/products/{id}/edit)
sylius.menu.admin.product_variant.form # For the tabular menu on the left hand side of the new/edit pages of the ProductVariant (/admin/products/{productId}/variants/new & /admin/products/{productId}/variants/{id}/edit)
sylius.menu.admin.promotion.update # For the buttons menu on top of the update page of the Promotion (/admin/promotions/{id}/edit)

How to customize Admin Menu?¶

Tip

You can browse the full implementation of these examples on this GitHub Pull Request.

Tip

Admin Panel menu is the one in the left expandable sidebar on the /admin/ url.

1. In order to add items to the Admin menu in Sylius you have to create a App\Menu\AdminMenuListener class.

In the example below we are adding a one new item and sub-item to the Admin panel menu.

<?php

namespace App\Menu;

use Sylius\Bundle\UiBundle\Menu\Event\MenuBuilderEvent;

final class AdminMenuListener
{
    public function addAdminMenuItems(MenuBuilderEvent $event): void
    {
        $menu = $event->getMenu();

        $newSubmenu = $menu
            ->addChild('new')
            ->setLabel('Custom Admin Submenu')
        ;

        $newSubmenu
            ->addChild('new-subitem')
            ->setLabel('Custom Admin Menu Item')
        ;
    }
}

2. After creating your class with a proper method for the menu customizations you need, subscribe your listener to the sylius.menu.admin.main event in the config/services.yaml.

# config/services.yaml
services:
    app.listener.admin.menu_builder:
        class: App\Menu\AdminMenuListener
        tags:
            - { name: kernel.event_listener, event: sylius.menu.admin.main, method: addAdminMenuItems }

3. Result:

After these two steps your admin panel menu should look like that, the new items appear at the bottom:

How to customize Account Menu?¶

Tip

My Account panel menu is the one in the left sidebar on the /account/dashboard/ url.

1. In order to add items to the Account menu in Sylius you have to create a App\Menu\AccountMenuListener class.

In the example below we are adding a one new item to the menu in the My Account section of shop.

<?php

namespace App\Menu;

use Sylius\Bundle\UiBundle\Menu\Event\MenuBuilderEvent;

final class AccountMenuListener
{
    public function addAccountMenuItems(MenuBuilderEvent $event): void
    {
        $menu = $event->getMenu();

        $menu
            ->addChild('new', ['route' => 'sylius_shop_account_dashboard'])
            ->setLabel('Custom Account Menu Item')
            ->setLabelAttribute('icon', 'star')
        ;
    }
}

As you can see above the new item can be given a route, a label and an icon.

2. After creating your class with a proper method for the menu customizations you need, subscribe your listener to the sylius.menu.shop.account event in the config/services.yaml.

# config/services.yaml
services:
    app.listener.shop.menu_builder:
        class: App\Menu\AccountMenuListener
        tags:
            - { name: kernel.event_listener, event: sylius.menu.shop.account, method: addAccountMenuItems }

3. Result:

After these two steps your user account menu should look like that, the new item appears at the bottom:

How to customize Admin Customer Show Menu?¶

Tip

Admin customer menu is the set of buttons in the right top corner on the /admin/customers/{id} url.

1. In order to add buttons to the Admin Customer Show menu in Sylius you have to create a App\Menu\AdminCustomerShowMenuListener class.

Note

This menu is build from buttons. There are a few button types available: edit, show, delete, link (default), and transition (for state machines).

Buttons (except for the link and transition types) already have a defined color, icon and label. The link and transition types buttons can be customized with the setLabel('label'), setLabelAttribute('color', 'color') and setLabelAttribute('icon', 'icon') methods.

The delete button must have also the resource_id attribute set (for csrf token purposes).

In the example below, we are adding one new button to the Admin Customer Show Menu. It has the type set, even though the link type is default to make the example easily customizable.

<?php

namespace App\Menu;

use Sylius\Bundle\AdminBundle\Event\CustomerShowMenuBuilderEvent;

final class AdminCustomerShowMenuListener
{
    public function addAdminCustomerShowMenuItems(CustomerShowMenuBuilderEvent $event): void
    {
        $menu = $event->getMenu();
        $customer = $event->getCustomer();

        if (null !== $customer->getUser()) {
            $menu
                ->addChild('impersonate', [
                    'route' => 'sylius_admin_impersonate_user',
                    'routeParameters' => ['username' => $customer->getUser()->getEmailCanonical()]
                ])
                ->setAttribute('type', 'link')
                ->setLabel('Impersonate')
                ->setLabelAttribute('icon', 'unhide')
                ->setLabelAttribute('color', 'blue')
            ;
        }
    }
}

2. After creating your class with a proper method for the menu customizations you need, subscribe your listener to the sylius.menu.admin.customer.show event in the config/services.yaml.

# config/services.yaml
services:
    app.listener.admin.customer.show.menu_builder:
        class: App\Menu\AdminCustomerShowMenuListener
        tags:
            - { name: kernel.event_listener, event: sylius.menu.admin.customer.show, method: addAdminCustomerShowMenuItems }

After these two steps your admin panel customer menu should look like that, the new item appears at right corner:

How to customize Admin Order Show Menu?¶

Tip

Admin order show menu is the set of buttons in the right top corner on the /admin/orders/{id} url.

1. In order to add buttons to the Admin Order Show menu in Sylius you have to create a App\Menu\AdminOrderShowMenuListener class.

Note

This menu is build from buttons. There are a few button types available: edit, show, delete, link (default), and transition (for state machines).

Buttons (except for the link and transition types) already have a defined color, icon and label. The link and transition types buttons can be customized with the setLabel('label'), setLabelAttribute('color', 'color') and setLabelAttribute('icon', 'icon') methods.

The delete button must have also the resource_id attribute set (for csrf token purposes).

In the example below, we are adding one new button to the Admin Order Show Menu. It is a link type button, that will let the admin ship the order.

<?php

namespace App\Menu;

use Sylius\Bundle\AdminBundle\Event\OrderShowMenuBuilderEvent;
use Sylius\Component\Order\OrderTransitions;

final class AdminOrderShowMenuListener
{
    public function addAdminOrderShowMenuItems(OrderShowMenuBuilderEvent $event): void
    {
        $menu = $event->getMenu();
        $order = $event->getOrder();

        if (null !== $order->getId()) {
            $menu
                ->addChild('ship', [
                    'route' => 'sylius_admin_order_shipment_ship',
                    'routeParameters' => ['id' => $order->getId()]
                ])
                ->setAttribute('type', 'transition')
                ->setLabel('Ship')
                ->setLabelAttribute('icon', 'checkmark')
                ->setLabelAttribute('color', 'green')
            ;
        }
    }
}

2. After creating your class with a proper method for the menu customizations you need, subscribe your listener to the sylius.menu.admin.order.show event in the config/services.yaml.

# config/services.yaml
services:
    app.listener.admin.order.show.menu_builder:
        class: App\Menu\AdminOrderShowMenuListener
        tags:
            - { name: kernel.event_listener, event: sylius.menu.admin.order.show, method: addAdminOrderShowMenuItems }

After these two steps your admin panel order menu should look like that (the new item appears at right corner):

How to customize Admin Product Form Menu?¶

Tip

Admin product form menu is the set of tabs on your left hand side on the /admin/products/new and /admin/products/{id}/edit urls.

Warning

This part of the guide assumes you already know how to customize models and forms.

1. In order to add a new tab to the Admin Product Form menu in Sylius you have to create a App\Menu\AdminProductFormMenuListener class.

Note

This menu is build from tabs, each coupled with their own template containing the necessary part of the form.

So lets say you want to add the product’s manufacturer details to the tabs. Provided you have created a new template with all the required form fields and saved it etc. as templates\Admin\Product\Tab\_manufacturer.html.twig, we will use it in the example below.

<?php

namespace App\Menu;

use Sylius\Bundle\AdminBundle\Event\ProductMenuBuilderEvent;

final class AdminProductFormMenuListener
{
    public function addItems(ProductMenuBuilderEvent $event): void
    {
        $menu = $event->getMenu();

        $menu
            ->addChild('manufacturer')
            ->setAttribute('template', 'Admin/Product/Tab/_manufacturer.html.twig')
            ->setLabel('Manufacturer')
        ;
    }
}

2. After creating your class with a proper method for the menu customizations you need, subscribe your listener to the sylius.menu.admin.product.form event in the config/services.yaml.

# config/services.yaml
services:
    app.listener.admin.product.form.menu_builder:
        class: App\Menu\AdminProductFormMenuListener
        tags:
            - { name: kernel.event_listener, event: sylius.menu.admin.product.form, method: addItems }

After these two steps your admin panel product form menu should look like that (the new item appears at the bottom):

How to customize Admin Product Variant Form Menu?¶

Tip

Admin product variant form menu is the set of tabs on your left hand side on the /admin/product/{productId}/variants/new and /admin/product/{productId}/variants/{id}/edit urls.

Warning

This part of the guide assumes you already know how to customize models and forms.

1. In order to add a new tab to the Admin Product Variant Form menu in Sylius you have to create a App\Menu\AdminProductVariantFormMenuListener class.

Note

This menu is build from tabs, each coupled with their own template containing the necessary part of the form.

So lets say you want to add the product variant’s media to the tabs. Provided you have created a new template with the required form fields and saved it etc. as templates\Admin\ProductVariant\Tab\_media.html.twig, we will use it in the example below.

<?php

namespace App\Menu;

use Sylius\Bundle\AdminBundle\Event\ProductVariantMenuBuilderEvent;

final class AdminProductVariantFormMenuListener
{
    public function addItems(ProductVariantMenuBuilderEvent $event): void
    {
        $menu = $event->getMenu();

        $menu
            ->addChild('media')
            ->setAttribute('template', 'Admin/ProductVariant/Tab/_media.html.twig')
            ->setLabel('Media')
        ;
    }
}

2. After creating your class with a proper method for the menu customizations you need, subscribe your listener to the sylius.menu.admin.product_variant.form event in the config/services.yaml.

# config/services.yaml
services:
    app.listener.admin.product_variant.form.menu_builder:
        class: App\Menu\AdminProductVariantFormMenuListener
        tags:
            - { name: kernel.event_listener, event: sylius.menu.admin.product_variant.form, method: addItems }

After these two steps your admin panel variant menu should look like that (the new item appears at the bottom):

Good to know¶

See also

All the customizations can be done either in your application directly or in Plugins!

Customizing Templates¶

Note

There are two kinds of templates in Sylius. Shop and Admin ones, plus you can create your own to satisfy your needs.

Why would you customize a template?¶

The most important case for modifying the existing templates is of course integrating your own layout of the system. Sometimes even if you have decided to stay with the default layout provided by Sylius, you need to slightly modify it to meet your business requirements. You may just need to add your logo anywhere.

Methods of templates customizing¶

Warning

There are three ways of customizing templates of Sylius:

The first one is simple templates overriding inside of the templates/bundles directory of your project. Using this method you can completely change the content of templates.

The second method is templates customization via events. You are able to listen on these template events, and by that add your own blocks without copying and pasting the whole templates. This feature is really useful when creating Sylius Plugins.

The third method is using Sylius themes. Creating a Sylius theme requires a few more steps than basic template overriding, but allows you to have a different design on multiple channels of the same Sylius instance. Learn more about themes here.

Tip

You can browse the full implementation of these examples on this GitHub Pull Request.

How to customize templates by overriding?¶

Note

How do you know which template you should be overriding? Go to the page that you are going to modify, at the bottom in the Symfony toolbar click on the route, which will redirect you to the profiler. In the Request Attributes section under _sylius [ template => ...] you can check the path to the current template.

Shop templates: customizing Login Page template:

The default login template is: @SyliusShopBundle/login.html.twig. In order to override it you need to create your own: templates/bundles/SyliusShopBundle/login.html.twig.

Copy the contents of the original template to make your work easier. And then modify it to your needs.

{% extends '@SyliusShop/layout.html.twig' %}

{% import '@SyliusUi/Macro/messages.html.twig' as messages %}

{% block content %}
<div class="ui column stackable center page grid">
    {% if last_error %}
        {{ messages.error(last_error.messageKey|trans(last_error.messageData, 'security')) }}
    {% endif %}

    {# You can add a headline for instance to see if you are changing things in the correct place. #}
    <h1>
        This Is My Headline
    </h1>

    <div class="five wide column"></div>
    <form class="ui six wide column form segment" action="{{ path('sylius_shop_login_check') }}" method="post" novalidate>
        <div class="one field">
            {{ form_row(form._username, {'value': last_username|default('')}) }}
        </div>
        <div class="one field">
            {{ form_row(form._password) }}
        </div>
        <div class="one field">
            <button type="submit" class="ui fluid large primary submit button">{{ 'sylius.ui.login_button'|trans }}</button>
        </div>
    </form>
</div>
{% endblock %}

Done! If you do not see any changes on the /shop/login url, clear your cache:

php bin/console cache:clear

Admin templates: Customization of the Country form view.

The default template for the Country form is: SyliusAdminBundle:Country:_form.html.twig. In order to override it you need to create your own: templates/bundles/SyliusAdminBundle/Country/_form.html.twig.

Copy the contents of the original template to make your work easier. And then modify it to your needs.

<div class="ui segment">
    {{ form_errors(form) }}
    {{ form_row(form.code) }}
    {{ form_row(form.enabled) }}
</div>
<div class="ui segment">

    {# You can add a headline for instance to see if you are changing things in the correct place. #}
    <h1>My Custom Headline</h1>

    <h4 class="ui dividing header">{{ 'sylius.ui.provinces'|trans }}</h4>
    {{ form_row(form.provinces, {'label': false}) }}
</div>

Done! If you do not see any changes on the /admin/countries/new url, clear your cache:

php bin/console cache:clear

How to customize templates via events?¶

Sylius uses the Events mechanism provided by the SonataBlockBundle.

How to locate template events?¶

The events naming convention uses the routing to the place where we are adding it, but instead of _ we are using ., followed by a slot name (like sylius_admin_customer_show route results in the sylius.admin.customer.show.slot_name events). The slot name describes where exactly in the template’s structure should the event occur, it will be before or after certain elements.

Although when the resource name is not just one word (like product_variant) then the underscore stays in the event prefix string. Then sylius_admin_product_variant_create route will have the sylius.admin.product_variant.create.slot_name events.

Let’s see how the event is rendered in a default Sylius Admin template. This is the rendering of the event that occurs on the create action of Resources, at the bottom of the page (after the content of the create form):

{# First we are setting the event_prefix based on route as it was mentioned before #}
{% set event_prefix = metadata.applicationName ~ '.admin.' ~ metadata.name ~ '.create' %}

{# And then the slot name is appended to the event_prefix #}
{{ sonata_block_render_event(event_prefix ~ '.after_content', {'resource': resource}) }}

Note

Besides the events that are named based on routing, Sylius also has some other general events: those that will appear on every Sylius admin or shop. Examples: sylius.shop.layout.slot_name or sylius.admin.layout.slot_name. They are rendered in the layout.html.twig views for both Admin and Shop.

Tip

In order to find events in Sylius templates you can simply search for the sonata_block_render_event phrase in your project’s directory.

How to use template events for customizations?¶

When you have found an event in the place where you want to add some content, here’s what you have to do.

Let’s assume that you would like to add some content after the header in the Sylius shop views. You will need to look at the SyliusShopBundle/Resources/views/layout.html.twig template, which is the basic layout of Sylius shop, and then in it find the appropriate event.

For the space below the header it will be sylius.shop.layout.after_header.

Create a Twig template file that will contain what you want to add.

{# templates/block.html.twig #}

<h1> Test Block Title </h1>

And configure Sylius UI to display it for the chosen event:

# config/packages/sylius_ui.yaml

sylius_ui:
    events:
        sylius.shop.layout.after_header:
            blocks:
                my_block_name: 'block.html.twig'

That’s it. Your new block should appear in the view.

Tip

Learn more about adding custom Admin JS & CSS in the cookbook here.

How to use themes for customizations?¶

You can refer to the theme documentation available here: - Themes (The book) - SyliusThemeBundle (Bundle documentation)

Global Twig variables¶

Each of the Twig templates in Sylius is provided with the sylius variable, that comes from the ShopperContext.

The ShopperContext is composed of ChannelContext, CurrencyContext, LocaleContext and CustomerContext. Therefore it has access to the current channel, currency, locale and customer.

The variables available in Twig are:

Twig variable	ShopperContext method name
sylius.channel	getChannel()
sylius.currencyCode	getCurrencyCode()
sylius.localeCode	getLocaleCode()
sylius.customer	getCustomer()

How to use these Twig variables?¶

You can check for example what is the current channel by dumping the sylius.channel variable.

{{ dump(sylius.channel) }}

That’s it, this will dump the content of the current Channel object.

Good to know¶

See also

All the customizations can be done either in your application directly or in Plugins!

Customizing Translations¶

Note

We’ve adopted a convention of overriding translations in the translations directory.

Why would you customize a translation?¶

If you would like to change any of the translation keys defined in Sylius in any desired language.

For example:

change “Last name” into “Surname”
change “Add to cart” into “Buy”

There are many other places where you can customize the text content of pages.

How to customize a translation?¶

Tip

You can browse the full implementation of these examples on this GitHub Pull Request.

In order to customize a translation in your project:

1. If you don’t have it yet, create translations/messages.en.yaml for English translations.

Note

You can create different files for different locales (languages). For example messages.pl.yaml should hold only Polish translations, as they will be visible when the current locale is PL. Check the Locales docs for more information.

Tip

Don’t forget to clear the cache to see your new translations appear: php bin/console cache:clear.

2. In this file, configure the desired key and give it a translation.

If you would like to change the translation of “Email” into “Username” on the login form you have to override its translation key which is sylius.form.customer.email.

sylius:
    form:
        customer:
            email: Username

Before

After

Tip

How to check what the proper translation key is for your message: When you are on the page where you are trying to customize a translation, click the Translations icon in the Symfony Profiler. In this section you can see all messages with their associated keys on that page.

Good to know¶

See also

All the customizations can be done either in your application directly or in Plugins!

Customizing Flashes¶

Why would you customize a flash?¶

If you would like to change any of the flash messages defined in Sylius in any desired language.

For example:

change the content of a flash when you add resource in the admin
change the content of a flash when you register in the shop

and many other places where you can customize the text content of the default flashes.

How to customize a flash message?¶

Tip

You can browse the full implementation of these examples on this GitHub Pull Request.

In order to customize a resource flash in your project:

1. Create the translations\flashes.en.yaml for english contents of your flashes.

Note

You can create different files for different locales (languages). For example flashes.pl.yaml should hold only polish flashes, as they will be visible when the current locale is PL. Check Locales docs for more information.

2. In this file configure the desired flash key and give it a translation.

If you would like to change the flash message while updating a Taxon, you will need to configure the flash under the sylius.taxon.update key:

sylius:
    taxon:
        update: This category has been successfully edited.

Before

After

Good to know¶

See also

All the customizations can be done either in your application directly or in Plugins!

Customizing State Machines¶

Warning

Not familiar with the State Machine concept? Read the docs here!

Note

Customizing logic via State Machines vs. Events

The logic in which Sylius operates can be customized in two ways. First of them is using the state machines: what is really useful when you need to modify business logic for instance modify the flow of the checkout, and the second is listening on the kernel events related to the entities, which is helpful for modifying the HTTP responses visible directly to the user, like displaying notifications, sending emails.

How to customize a State Machine?¶

Tip

You can browse the full implementation of these examples on this GitHub Pull Request.

How to add a new state?¶

Let’s assume that you would like to add a new state to the Order state machine. You will need to add these few lines to the config/packages/_sylius.yaml:

# config/packages/_sylius.yaml
winzou_state_machine:
    sylius_order:
        states:
            new_custom_state: ~ # here name your state as you wish

After that your new step will be available alongside other steps that already were defined in that state machine.

Tip

Run php bin/console debug:winzou:state-machine sylius_order to check if the state machine has changed to your implementation.

How to add a new transition?¶

Let’s assume that you would like to add a new transition to the Order state machine, that will allow moving from the cancelled state backwards to new. Let’s call it “restoring”.

You will need to add these few lines to the config/packages/_sylius.yaml:

# config/packages/_sylius.yaml
winzou_state_machine:
    sylius_order:
        transitions:
            restore:
                from: [cancelled]
                to: new

After that your new transition will be available alongside other transitions that already were defined in that state machine.

Tip

Run php bin/console debug:winzou:state-machine sylius_order to check if the state machine has changed to your implementation.

How to remove a state and its transitions?¶

Warning

If you are willing to remove a state or a transition you have to override the whole states/transitions section of the state machine you are willing to modify. See how we do it in the customization of the Checkout process.

How to add a new callback?¶

Let’s assume that you would like to add a new callback to the Product Review state machine, that will do something on an already defined transition.

You will need to add these few lines to the config/packages/_sylius.yaml:

# config/packages/_sylius.yaml
winzou_state_machine:
    sylius_product_review:
        callbacks:
            after:
                sylius_update_rating:
                    # here you are choosing the transition on which the action should take place - we are using the one we have created before
                    on: ["accept"]
                    # use service and its method here
                    do: ["@App\\ProductReview\\Mailer\\ConfirmationMailer", "sendEmail"]
                    # this will be the object of an Order here
                    args: ["object"]

Tip

If you want to see the implementation of ConfirmationMailer check it on this GitHub Pull Request.

After that your new callback will be available alongside other callbacks that already were defined in that state machine and will be called on the desired transition.

How to modify a callback?¶

If you would like to modify an existent callback of for example the state machine of ProductReviews, so that it does not count the average rating but does something else - you need to add these few lines to the config/packages/_sylius.yaml:

# config/packages/_sylius.yaml
winzou_state_machine:
    sylius_review:
        callbacks:
            after:
                update_price:
                    on: "accept"
                    # here you can change the service and its method that is called for your own service
                    do: ["@sylius.review.updater.your_service", update]
                    args: ["object"]

How to disable a callback?¶

If you would like to turn off a callback of a state machine you need to set its disabled option to true. On the example of the state machine of ProductReview, we can turn off the update_price callback:

# config/packages/_sylius.yaml
winzou_state_machine:
    sylius_review:
        callbacks:
            after:
                update_price:
                    disabled: true

Good to know¶

See also

All the customizations can be done either in your application directly or in Plugins!

Learn more¶

Customizing Grids¶

Note

We assume that you are familiar with grids. If not check the documentation of the GridBundle first.

Tip

You can browse the full implementation of these examples on this GitHub Pull Request.

Why would you customize grids?¶

When you would like to change how the index view of an entity looks like in the administration panel, then you have to override its grid.

remove a field from a grid
change a field of a grid
reorder fields
override an entire grid

How to customize grids?¶

Tip

One way to change anything in any grid in Sylius is to modify a special file in the config/packages/ directory: config/packages/_sylius.yaml.

How to customize fields of a grid?¶

How to remove a field from a grid?¶

If you would like to remove a field from an existing Sylius grid, you will need to disable it in the config/packages/_sylius.yaml.

Let’s imagine that we would like to hide the title of product review field on the sylius_admin_product_review grid.

# config/packages/_sylius.yaml
sylius_grid:
    grids:
        sylius_admin_product_review:
            fields:
                title:
                    enabled: false

That’s all. Now the title field will be disabled (invisible).

How to modify a field of a grid?¶

If you would like to modify for instance a label of any field from a grid, that’s what you need to do:

# config/packages/_sylius.yaml
sylius_grid:
    grids:
        sylius_admin_product_review:
            fields:
                date:
                    label: "When was it added?"

Good practices is translate labels, look here. how to do that

How to customize filters of a grid?¶

How to remove a filter from a grid?¶

If you would like to remove a filter from an existing Sylius grid, you will need to disable it in the config/packages/_sylius.yaml.

Let’s imagine that we would like to hide the titles filter of product reviews on the sylius_admin_product_review grid.

# config/packages/_sylius.yaml
sylius_grid:
    grids:
        sylius_admin_product_review:
            filters:
                title:
                    enabled: false

That’s all. Now the title filter will be disabled.

How to customize actions of a grid?¶

How to remove an action from a grid?¶

If you would like to disable some actions in any grid, you just need to set its enabled option to false like below:

# config/packages/_sylius.yaml
sylius_grid:
    grids:
        sylius_admin_product_review:
            actions:
                item:
                    delete:
                        type: delete
                        enabled: false

How to modify an action of a grid?¶

If you would like to change the link to which an action button is redirecting, this is what you have to do:

Warning

The show button does not exist in the sylius_admin_product grid by default. It is assumed that you already have it customized, and your grid has the show action.

# config/packages/_sylius.yaml
sylius_grid:
    grids:
        sylius_admin_product:
            actions:
                item:
                    show:
                        type: show
                        label: Show in the shop
                        options:
                            link:
                                route: sylius_shop_product_show
                                parameters:
                                    slug: resource.slug

The above grid modification will change the redirect of the show action to redirect to the shop, instead of admin show. Also the label was changed here.

How to modify positions of fields, filters and actions in a grid?¶

For fields, filters and actions it is possible to easily change the order in which they are displayed in the grid.

See an example of fields order modification on the sylius_admin_product_review grid below:

# config/packages/_sylius.yaml
sylius_grid:
    grids:
        sylius_admin_product_review:
            fields:
                date:
                    position: 5
                title:
                    position: 6
                rating:
                    position: 3
                status:
                    position: 1
                reviewSubject:
                    position: 2
                author:
                    position: 4

Customizing grids by events¶

There is also another way to customize grids: via events. Every grid configuration dispatches an event when its definition is being converted.

For example, sylius_admin_product grid dispatches such an event:

sylius.grid.admin_product # For the grid of products in admin

To show you an example of a grid customization using events, we will modify fields from a grid using that method. Here are the steps, that you need to take:

1. In order to modify fields from the product grid in Sylius you have to create a App\Grid\AdminProductsGridListener class.

In the example below we are removing the image field and adding the code field to the sylius_admin_product grid.

<?php

namespace App\Grid;

use Sylius\Component\Grid\Event\GridDefinitionConverterEvent;
use Sylius\Component\Grid\Definition\Field;

final class AdminProductsGridListener
{
    public function editFields(GridDefinitionConverterEvent $event): void
    {
        $grid = $event->getGrid();

        // Remove
        $grid->removeField('image');

        // Add
        $codeField = Field::fromNameAndType('code', 'string');
        $codeField->setLabel('Code');
        // ...
        $grid->addField($codeField);
    }
}

2. After creating your class with a proper method for the grid customizations you need, subscribe your listener to the sylius.grid.admin_product event in the config/services.yaml.

# config/services.yaml
services:
    App\Grid\AdminProductsGridListener:
        tags:
            - { name: kernel.event_listener, event: sylius.grid.admin_product, method: editFields }

3. Result:

After these two steps your admin product grid should not have the image field.

Good to know¶

See also

All the customizations can be done either in your application directly or in Plugins!

Changes related to upgrade to GridBundle 1.10¶

Since the SyliusGridBundle v1.10, all grids has options fetch_join_collection and use_output_walkers enabled by default. According to our research it may fix a lot of pagination issues and improve big-database performance (1M+ rows) up to 70%, but with the price of more queries required to be performed. If this trade-off is not worth it for you, you may disable it by using the following configuration snippet:

# config/packages/_sylius.yaml
sylius_grid:
    grids:
        sylius_admin_address_log_entry:
            driver:
                name: doctrine/orm
                options:
                    pagination:
                        fetch_join_collection: false
                        use_output_walkers: false
        sylius_admin_admin_user:
            driver:
                name: doctrine/orm
                options:
                    pagination:
                        fetch_join_collection: false
                        use_output_walkers: false
        sylius_admin_channel:
            driver:
                name: doctrine/orm
                options:
                    pagination:
                        fetch_join_collection: false
                        use_output_walkers: false
        sylius_admin_country:
            driver:
                name: doctrine/orm
                options:
                    pagination:
                        fetch_join_collection: false
                        use_output_walkers: false
        sylius_admin_currency:
            driver:
                name: doctrine/orm
                options:
                    pagination:
                        fetch_join_collection: false
                        use_output_walkers: false
        sylius_admin_customer:
            driver:
                name: doctrine/orm
                options:
                    pagination:
                        fetch_join_collection: false
                        use_output_walkers: false
        sylius_admin_customer_group:
            driver:
                name: doctrine/orm
                options:
                    pagination:
                        fetch_join_collection: false
                        use_output_walkers: false
        sylius_admin_customer_order:
            extends: sylius_admin_order
            driver:
                options:
                    pagination:
                        fetch_join_collection: false
                        use_output_walkers: false
        sylius_admin_exchange_rate:
            driver:
                name: doctrine/orm
                options:
                    pagination:
                        fetch_join_collection: false
                        use_output_walkers: false
        sylius_admin_inventory:
            driver:
                name: doctrine/orm
                options:
                    pagination:
                        fetch_join_collection: false
                        use_output_walkers: false
        sylius_admin_locale:
            driver:
                name: doctrine/orm
                options:
                    pagination:
                        fetch_join_collection: false
                        use_output_walkers: false
        sylius_admin_order:
            driver:
                name: doctrine/orm
                options:
                    pagination:
                        fetch_join_collection: false
                        use_output_walkers: false
        sylius_admin_payment:
            driver:
                name: doctrine/orm
                options:
                    pagination:
                        fetch_join_collection: false
                        use_output_walkers: false
        sylius_admin_payment_method:
            driver:
                name: doctrine/orm
                options:
                    pagination:
                        fetch_join_collection: false
                        use_output_walkers: false
        sylius_admin_product:
            driver:
                name: doctrine/orm
                options:
                    pagination:
                        fetch_join_collection: false
                        use_output_walkers: false
        sylius_admin_product_association_type:
            driver:
                name: doctrine/orm
                options:
                    pagination:
                        fetch_join_collection: false
                        use_output_walkers: false
        sylius_admin_product_attribute:
            driver:
                name: doctrine/orm
                options:
                    pagination:
                        fetch_join_collection: false
                        use_output_walkers: false
        sylius_admin_product_option:
            driver:
                name: doctrine/orm
                options:
                    pagination:
                        fetch_join_collection: false
                        use_output_walkers: false
        sylius_admin_product_review:
            driver:
                name: doctrine/orm
                options:
                    pagination:
                        fetch_join_collection: false
                        use_output_walkers: false
        sylius_admin_product_variant:
            driver:
                name: doctrine/orm
                options:
                    pagination:
                        fetch_join_collection: false
                        use_output_walkers: false
        sylius_admin_promotion:
            driver:
                name: doctrine/orm
                options:
                    pagination:
                        fetch_join_collection: false
                        use_output_walkers: false
        sylius_admin_promotion_coupon:
            driver:
                name: doctrine/orm
                options:
                    pagination:
                        fetch_join_collection: false
                        use_output_walkers: false
        sylius_admin_shipment:
            driver:
                name: doctrine/orm
                options:
                    pagination:
                        fetch_join_collection: false
                        use_output_walkers: false
        sylius_admin_shipping_category:
            driver:
                name: doctrine/orm
                options:
                    pagination:
                        fetch_join_collection: false
                        use_output_walkers: false
        sylius_admin_shipping_method:
            driver:
                name: doctrine/orm
                options:
                    pagination:
                        fetch_join_collection: false
                        use_output_walkers: false
        sylius_admin_tax_category:
            driver:
                name: doctrine/orm
                options:
                    pagination:
                        fetch_join_collection: false
                        use_output_walkers: false
        sylius_admin_tax_rate:
            driver:
                name: doctrine/orm
                options:
                    pagination:
                        fetch_join_collection: false
                        use_output_walkers: false
        sylius_admin_taxon:
            driver:
                name: doctrine/orm
                options:
                    pagination:
                        fetch_join_collection: false
                        use_output_walkers: false
        sylius_admin_zone:
            driver:
                name: doctrine/orm
                options:
                    pagination:
                        fetch_join_collection: false
                        use_output_walkers: false
        sylius_shop_account_order:
            driver:
                name: doctrine/orm
                options:
                    pagination:
                        fetch_join_collection: false
                        use_output_walkers: false
        sylius_shop_product:
            driver:
                name: doctrine/orm
                options:
                    pagination:
                        fetch_join_collection: false
                        use_output_walkers: false

Learn more¶

GridBundle documentation

Customizing Fixtures¶

What are fixtures?¶

Fixtures are just plain old PHP objects, that change system state during their execution - they can either persist entities in the database, upload files, dispatch events or do anything you think is needed.

sylius_fixtures:
    suites:
        my_suite_name:
            fixtures:
                my_fixture: # Fixture name as a key
                    priority: 0 # The higher priority is, the sooner the fixture will be executed
                    options: ~ # Fixture options

They implement the Sylius\Bundle\FixturesBundle\Fixture\FixtureInterface and need to be registered under the sylius_fixtures.fixture tag in order to be used in suite configuration.

Note

The former interface extends the ConfigurationInterface, which is widely known from Configuration classes placed under DependencyInjection directory in Symfony bundles.

Why would you customize fixtures?¶

There are two main use cases for customizing fixture suites, in each of them you can adapt the data of your shop to be realistic, the default fixtures suite of Sylius is selling clothes, if you are selling food you’d probably need your own fixtures to show that:

preparing test data for the development purposes like demo applications prepared for QA

preparing the shop configuration for the production instance

How to modify the existing Sylius fixtures?¶

In Sylius, fixtures are configured in src/Sylius/Bundle/CoreBundle/Resources/config/app/fixtures.yml. It includes the default suite that is partially-configured. If you are planning to modify the default fixtures applied by the sylius:fixtures:load command, modify the config\packages\sylius_fixtures.yaml file.

Modifying the shop configuration (channels, currencies, payment and shipping methods)¶

sylius_fixtures:
    suites:
        default: # this key is always called whenever the sylius:fixtures:load command is called, below we are extending it with new fixtures
            fixtures:
                currency:
                    options:
                        currencies: ['PLN','HUF']
                channel:
                    options:
                        custom:
                            pl_web_store: # creating new channel
                                name: "PL Web Store"
                                code: "PL_WEB"
                                locales:
                                    - "%locale%"
                                currencies:
                                    - "PLN"
                                enabled: true
                                hostname: "localhost"
                            hun_web_store:
                                name: "Hun Web Store"
                                code: "HUN_WEB"
                                locales:
                                    - "%locale%"
                                currencies:
                                    - "HUF"
                                enabled: true
                                hostname: "localhost"
                shipping_method:
                    options:
                        custom:
                            ups_eu: # creating a new shipping_method and adding channel to it
                                code: "ups_eu"
                                name: "UPS_eu"
                                enabled: true
                                channels:
                                    - "PL_WEB"
                                    - "HUN_WEB"
                payment_method:
                    options:
                        custom:
                            cash_on_delivery_pl:
                                code: "cash_on_delivery_eu"
                                name: "Cash on delivery_eu"
                                channels:
                                    - "PL_WEB"
                            bank_transfer:
                                code: "bank_transfer_eu"
                                name: "Bank transfer_eu"
                                channels:
                                    - "PL_WEB"
                                    - "HUN_WEB"
                                enabled: true

It is more complicated to create fixtures for products, because they have more dependencies (to Variants, Options etc.). In order to prepare a Product you have to create not only the product itself but other related entities via their own factories. Sylius delivers four ready implementations of Product fixtures, that have their relevant options (like sizes for T-shirts):

BookProductFixture
MugProductFixture
StickerProductFixture
TshirtProductFixture

You can modify their YAML fixture configs, but only within the capabilities delivered by those fixtures classes.

How to customize fixtures for customized models?¶

Tip

The following example is based on other example of extending an entity with a new field. You can browse the full implementation of this example on this GitHub Pull Request.

Let’s suppose you have extended App\Entity\Shipping\ShippingMethod with a new field deliveryConditions, just like in the example mentioned above.

1. To cover that in fixtures, you will need to override the ShippingMethodExampleFactory and add this field:

<?php

// src/Fixture/Factory/ShippingMethodExampleFactory.php

namespace App\Fixture\Factory;

// ...
use Sylius\Bundle\CoreBundle\Fixture\Factory\ShippingMethodExampleFactory as BaseShippingMethodExampleFactory;

final class ShippingMethodExampleFactory extends BaseShippingMethodExampleFactory
{
    //...

    public function create(array $options = []): ShippingMethodInterface
    {
        /** @var ShippingMethod $shippingMethod */
        $shippingMethod = parent::create($options);

        // Protect object if part of our objects don't have new field
        if (!isset($options['deliveryConditions'])) {
            return $shippingMethod;
        }

        foreach ($this->getLocales() as $localeCode) {
            $shippingMethod->setCurrentLocale($localeCode);
            $shippingMethod->setFallbackLocale($localeCode);

            $shippingMethod->setDeliveryConditions($options['deliveryConditions']);
        }

        return $shippingMethod;
    }

    protected function configureOptions(OptionsResolver $resolver): void
    {
        parent::configureOptions($resolver);

        $resolver
            ->setDefault('deliveryConditions', 'some_default_value')
            ->setAllowedTypes('deliveryConditions', ['null', 'string'])
        ;
    }

    private function getLocales(): iterable
    {
        /** @var LocaleInterface[] $locales */
        $locales = $this->localeRepository->findAll();
        foreach ($locales as $locale) {
            yield $locale->getCode();
        }
    }
}

2. Extend the Sylius\Bundle\CoreBundle\Fixture\ShippingMethodFixture in App\Entity\Fixture\ShippingMethodFixture:

<?php

// src/Fixture/ShippingMethodFixture.php

namespace App\Fixture;

use Sylius\Bundle\CoreBundle\Fixture\ShippingMethodFixture as BaseShippingMethodFixture;
use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;

final class ShippingMethodFixture extends BaseShippingMethodFixture
{
    protected function configureResourceNode(ArrayNodeDefinition $resourceNode): void
    {
        parent::configureResourceNode($resourceNode);

        $resourceNode
            ->children()
                ->scalarNode('deliveryConditions')->end()
        ;
    }
}

3. Configure the services in the config/services.yaml file:

sylius.fixture.example_factory.shipping_method:
    class: App\Fixture\Factory\ShippingMethodExampleFactory
    arguments:
        - "@sylius.factory.shipping_method"
        - "@sylius.repository.zone"
        - "@sylius.repository.shipping_category"
        - "@sylius.repository.locale"
        - "@sylius.repository.channel"
        - "@sylius.repository.tax_category"
    public: true

sylius.fixture.shipping_method:
    class: App\Fixture\ShippingMethodFixture
    arguments:
        - "@sylius.manager.shipping_method"
        - "@sylius.fixture.example_factory.shipping_method"
    tags:
        - { name: sylius_fixtures.fixture }

Tip

When creating fixtures services manually, remember to turn off autowiring for them:

App\:
    resource: '../src/*'
    exclude: '../src/{Entity,Fixture,Migrations,Tests,Kernel.php}'

If you leave autowiring on, errors like Fixture with name “your_custom_fixture” is already registered. will most probably appear. Your fixture service will register twice (as app.fixture.bla by you and as AppFixtureBlaFixture by DI autoconfigure).

4. Add new Shipping Methods with delivery conditions in config/packages/fixtures.yaml:

sylius_fixtures:
    suites:
        default:
            fixtures:
                # ...
                shipping_method: # our new configuration with the new field
                    options:
                        custom:
                        geis:
                            code: "geis"
                            name: "Geis"
                            enabled: true
                            channels:
                                - "PL_WEB"
                            deliveryConditions: "3-5 days"

Learn more¶

Customizing Fixture Suites¶

What are fixture suites?¶

Suites are predefined groups of fixtures that can be run together. For example, they can be full shop configurations for manual tests purposes.

Why would you customize fixture suites?¶

tailoring the default Sylius fixture suite to your needs (removing Orders for example)

creating your own fixture suite

How to use suites?¶

Complete list of suites can be shown with the bin/console sylius:fixtures:list command. The default suite is loaded if bin/console sylius:fixtures:load command is executed without any additional argument. If you are creating a new suite you must use this command providing the name of your suite as an argument: bin/console sylius:fixtures:load your_custom_suite.

How to create custom fixture suites?¶

Tip

You can browse the full implementation of this example on this GitHub Pull Request.

Tip

If you want to create your fixtures with different locale than en_US you must change the locale parameter in config/services.yaml.

parameters:
    locale: pl_PL

1. Create the config/packages/sylius_fixtures.yaml file and add the following code there:

sylius_fixtures:
    suites:
        poland: # custom suite's name
            fixtures:
                currency:
                    options:
                        currencies: ['PLN'] # add desired currencies as an array

                geographical: # Countries, provinces and zones available in your store
                    options:
                        countries:
                            - "PL"
                        zones:
                            PL:
                                name: "Poland"
                                countries:
                                    - "PL"

                channel:
                    options:
                        custom:
                            pl_web_store:
                                name: "PL Web Store"
                                code: "PL_WEB"
                                locales: # choose the locale for this channel
                                    - "%locale%"
                                currencies: # choose currencies for this channel
                                    - "PLN"
                                enabled: true
                                hostname: "localhost"

                shipping_method: # create shipping methods and choose channels in which it is available
                    options:
                        custom:
                            inpost:
                                code: "inpost"
                                name: "InPost"
                                channels:
                                    - "PL_WEB"
                                zone: "PL"

2. Load your custom suite with bin/console sylius:fixtures:load poland command.

Tip

By default, a new fixture suite will not purge your database. If you want to run it always on a clear database, add the orm_purger listener under your custom suite name:

sylius_fixtures:
    suites:
        poland:
            listeners:
                orm_purger: ~

Learn more¶

Customizing API¶

We are using the API Platform to create all endpoints in Sylius API. API Platform allows configuring an endpoint by yaml and xml files or by annotations. In this guide, you will learn how to customize Sylius API endpoints using xml configuration.

Introduction¶

How to prepare project for customization?¶

If your project was created before v1.10, make sure your API Platform config follows the one below:

# config/packages/api_platform.yaml
api_platform:
    mapping:
        paths:
            - '%kernel.project_dir%/vendor/sylius/sylius/src/Sylius/Bundle/ApiBundle/Resources/config/api_resources'
            - '%kernel.project_dir%/config/api_platform'
            - '%kernel.project_dir%/src/Entity'
    patch_formats:
        json: ['application/merge-patch+json']
    swagger:
        versions: [3]

Also, if you’re planning to modify serialization add this code to framework config:

# config/packages/framework.yaml
#...
serializer:
    mapping:
        paths: [ '%kernel.project_dir%/config/serialization' ]

How to add an additional endpoint?¶

Let’s assume that you want to add a new endpoint to the Order resource that will be dispatching a command. If you want to customize any API resource, you need to copy the entire configuration of this resource from %kernel.project_dir%/vendor/sylius/sylius/src/Sylius/Bundle/ApiBundle/Resources/config/api_resources/ to %kernel.project_dir%/config/api_platform. Add the following configuration in the config copied to config/api_platform/Order.xml:

<collectionOperations>
    <collectionOperation name="custom_operation">
        <attribute name="method">POST</attribute>
        <attribute name="path">/shop/orders/custom-operation</attribute>
        <attribute name="messenger">input</attribute>
        <attribute name="input">App\Command\CustomCommand</attribute>
    </collectionOperation>
</collectionOperations>

And that’s all, now you have a new endpoint with your custom logic.

Tip

Read more about API Platform endpoint configuration here

How to remove an endpoint?¶

Let’s assume that your shop is offering only digital products. Therefore, while checking out, your customers do not need to choose a shipping method for their orders.

Thus you will need to modify the configuration file of the Order resource and remove the shipping method choosing endpoint from it. To remove the endpoint you only need to delete the unnecessary configuration from your config/api_platform/Order.xml which is a copied configuration file, that overwrites the one from Sylius.

<!-- delete this configuration -->
<itemOperation name="shop_select_shipping_method">
    <!-- ... -->
</itemOperation>

How to rename an endpoint’s path?¶

If you want to change an endpoint’s path, you just need to change the path attribute in your config:

<itemOperations>
        <itemOperation name="admin_get">
            <attribute name="method">GET</attribute>
            <attribute name="path">/admin/orders/renamed-path/{id}</attribute>
        </itemOperation>
</itemOperations>

How to modify the endpoints prefixes?¶

Let’s assume that you want to have your own prefixes on paths (for example to be more consistent with the rest of your application). As the first step you need to change the paths or route_prefix attribute in all needed resources. The next step is to modify the security configuration in config/packages/security.yaml, you need to overwrite the parameter:

parameters:
    sylius.security.new_api_shop_route: "%sylius.security.new_api_route%/retail"

Warning

Changing prefix without security configuration update can expose confidential data (like customers addresses).

After these two steps you can start to use endpoints with new prefixes.

How to customize serialization?¶

Let’s say that you want to change the serialized fields in your responses. For an example we will use Product resource and customize its fields.

Adding a field to response¶

Let’s say that you want to serialize the existing field named averageRating to Product in the admin response so the administrator would be able to check what is the average rating of product.

First let’s create serialization configuration file named Product.xml in config/serialization/Product.xml and add serialization group that is used by endpoint we want to modify, in this case the new group is called admin:product:read:

<?xml version="1.0" ?>

<serializer xmlns="http://symfony.com/schema/dic/serializer-mapping"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
            xsi:schemaLocation="http://symfony.com/schema/dic/serializer-mapping https://symfony.com/schema/dic/serializer-mapping/serializer-mapping-1.0.xsd"
>
    <class name="Sylius\Component\Core\Model\Product">
        <attribute name="averageRating">
            <group>admin:product:read</group>
            <group>shop:product:read</group>
        </attribute>
    </class>
</serializer>

Tip

You can create your own serialization group for every endpoint or use the one out of the box. If you don’t know the name of group for endpoint you want to modify, you can find it by searching for your class configuration file in %kernel.project_dir%/vendor/sylius/sylius/src/Sylius/Bundle/ApiBundle/Resources/config/api_resources` and look for path that you want to modify.

Tip

The serialization groups from Sylius look this way to reflect: user context, resource name and type of operation.

After this change your response should be extended with new field:

{
    //...
    "id": 123,
    "code": "product_code",
    "variants": [
        "/api/v2/shop/product-variants/product-variant-0",
    ],
    "averageRating": 3,
    //...
}

Tip

Read more about API Platform serialization groups

We were able to add a field that exists in Product class, but what if you want to extend it with custom fields? Let’s customize response now with your custom fields serialized in response.

Adding a custom field to response¶

Let’s say that you want to add a new field named additionalText to Customer. First we need to create a new serializer that will support this resource. Let’s name it CustomerNormalizer:

<?php

declare(strict_types=1);

namespace App\Serializer;

use Sylius\Component\Core\Model\CustomerInterface;
use Symfony\Component\Serializer\Normalizer\ContextAwareNormalizerInterface;
use Symfony\Component\Serializer\Normalizer\NormalizerAwareInterface;
use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
use Webmozart\Assert\Assert;

final class CustomerNormalizer implements ContextAwareNormalizerInterface, NormalizerAwareInterface
{
    private NormalizerInterface $normalizer;

    public function __construct(NormalizerInterface $normalizer)
    {
        $this->normalizer = $normalizer;
    }

    private const ALREADY_CALLED = 'customer_normalizer_already_called';

    public function normalize($object, $format = null, array $context = [])
    {
        Assert::isInstanceOf($object, CustomerInterface::class);
        Assert::keyNotExists($context, self::ALREADY_CALLED);

        $context[self::ALREADY_CALLED] = true;

        $data = $this->normalizer->normalize($object, $format, $context);

        return $data;
    }

    public function supportsNormalization($data, $format = null, $context = []): bool
    {
        if (isset($context[self::ALREADY_CALLED])) {
            return false;
        }

        return $data instanceof CustomerInterface;
    }
}

And now let’s declare its service in config files:

# config/services.yaml
App\Serializer\CustomerNormalizer:
    arguments:
        - '@api_platform.serializer.normalizer.item'
    tags:
        - { name: 'serializer.normalizer', priority: 100 }

Then we can add the new field:

//...
$data = $this->normalizer->normalize($object, $format, $context);

$data['additionalText'] = 'your custom text or logic that will be added to this field.';

return $data;
//...

Now your response should be extended with the new field:

{
    //...
    "id": 123,
    "email": "sylius@example.com",
    "firstName": "sylius",
    "additionalText": "my additional field with text",
    //...
}

But let’s consider another case where the Normalizer exists for a given Resource. Here we will also add a new field named additionalText but this time to Product. First, we need to create a serializer that will support our Product resource but in this case, we have a ProductNormalizer provided by Sylius. Unfortunately, we cannot use more than one normalizer per resource, hence we will override the existing one.

Let’s then copy the code of ProductNormalizer from vendor/sylius/sylius/src/Sylius/Bundle/ApiBundle/Serializer/ProductNormalizer.php :

<?php

declare(strict_types=1);

namespace App\Serializer;

use Sylius\Component\Core\Model\ProductInterface;
use Sylius\Component\Product\Resolver\ProductVariantResolverInterface;
use Symfony\Component\Serializer\Normalizer\ContextAwareNormalizerInterface;
use Symfony\Component\Serializer\Normalizer\NormalizerAwareInterface;
use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
use Webmozart\Assert\Assert;

final class ProductNormalizer implements ContextAwareNormalizerInterface, NormalizerAwareInterface
{
    private NormalizerInterface $normalizer;

    private ProductVariantResolverInterface $productVariantResolver;

    public function __construct(
        NormalizerInterface $normalizer,
        ProductVariantResolverInterface $productVariantResolver
    ) {
        $this->normalizer = $normalizer;
        $this->productVariantResolver = $productVariantResolver;
    }

    private const ALREADY_CALLED = 'product_normalizer_already_called';

    public function normalize($object, $format = null, array $context = [])
    {
        Assert::isInstanceOf($object, ProductInterface::class);
        Assert::keyNotExists($context, self::ALREADY_CALLED);

        $context[self::ALREADY_CALLED] = true;

        $data = $this->normalizer->normalize($object, $format, $context);
        $variant = $this->productVariantResolver->getVariant($object);
        $data['defaultVariant'] = $variant === null ? null : $this->iriConverter->getIriFromItem($variant);

        return $data;
    }

    public function supportsNormalization($data, $format = null, $context = []): bool
    {
        if (isset($context[self::ALREADY_CALLED])) {
            return false;
        }

        return $data instanceof ProductInterface;
    }
}

And now let’s declare its service in config files:

# config/services.yaml
App\Serializer\ProductNormalizer:
    arguments:
        - '@api_platform.serializer.normalizer.item'
        - '@sylius.product_variant_resolver.default'
    tags:
        - { name: 'serializer.normalizer', priority: 100 }

Warning

As we can use only one Normalizer per resource we need to set priority for it, higher then the priority of the Sylius one. You can find the priority value of the Sylius Normalizer in src/Sylius/Bundle/ApiBundle/Resources/config/services/serializers.xml

Then we can add the new field:

//...
$data = $this->normalizer->normalize($object, $format, $context);

$data['additionalText'] = 'your custom text or logic that will be added to this field.';

return $data;
//...

And your response should be extended with the new field:

{
    //...
    "id": 123,
    "code": "product_code",
    "variants": [
        "/api/v2/shop/product-variants/product-variant-0",
    ],
    "additionalText": "my additional field with text",
    //...
}

Removing a field from a response¶

Let’s say that for some reason you want to remove a field from serialization. One possible solution could be that you use serialization groups. Those will limit the fields from your resource, according to serialization groups that you will choose.

Tip

Read more about API Platform serialization groups

Let’s assume that Product resource returns such a response:

{
    //...
    "id": 123,
    "code": "product_code",
    "variants": [
        "/api/v2/shop/product-variants/product-variant-0",
    ],
    "translations": {
        "en_US": {
          "@id": "/api/v2/shop/product-translations/123",
          "@type": "ProductTranslation",
          "id": 123,
          "name": "product name",
          "slug": "product-name"
    }
}

Then let’s say you want to remove translations.

Utilising serialization groups to remove fields might be quite tricky as Symfony combines all of the serialization files into one. The easiest solution to remove the field is to create a new serialization group, use it for the fields you want to have, and declare this group in the endpoint.

First, let’s add the config/api_platform/Product.xml configuration file. See How to add and remove endpoint for more information. Then let’s modify the endpoint. For this example, we will use GET item in the shop, but you can also create some custom endpoint:

<!--...-->
<itemOperation name="shop_get">
    <attribute name="method">GET</attribute>
    <attribute name="path">/shop/products/{code}</attribute>
    <attribute name="openapi_context">
        <attribute name="summary">Use code to retrieve a product resource.</attribute>
    </attribute>
    <attribute name="normalization_context">
        <attribute name="groups">shop:product:read</attribute>
    </attribute>
</itemOperation>
<!--...-->

then let’s change the serialization group in normalization_context attribute to shop:product:custom_read:

<!--...-->
<attribute name="normalization_context">
    <attribute name="groups">shop:product:custom_read</attribute>
</attribute>
<!--...-->

Now we can define all the fields we want to expose in the config/serialization/Product.xml:

<!--...-->
<attribute name="updatedAt">
    <group>shop:product:custom_read</group>
</attribute>
<!-- here `translation` attribute would be declared -->
<attribute name="mainTaxon">
    <group>shop:product:custom_read</group>
</attribute>
<!--...-->

Note

In xml example the translations is not declared with <group>shop:product:custom_read</group> group, so endpoint won’t return this value. The rest of the fields that we want to show have the new serialization group declared.

In cases, where you would like to remove small amount of fields, the serializer would be a way to go. First step is to create a class as in Adding a custom field to response and register its service.

Then modify it’s logic with this code:

//...
$data = $this->normalizer->normalize($object, $format, $context);

unset($data['translations']); // removes `translations` from response

return $data;
//...

Now your response fields should look like this:

{
    //...
    "id": 123,
    "code": "product_code",
    "variants": [
        "/api/v2/shop/product-variants/product-variant-0",
    ],
    // the translations which were here are now removed
}

Renaming a field of a response¶

Changing the name of response fields is very simple. In this example let’s modify the options name to optionValues, that’s how response looks like now:

{
    //...
    "id": 123,
    "code": "product_code",
    "product": "/api/v2/shop/products/product_code",
    "options": [
        "/api/v2/shop/product-option-values/product_size_s"
    ],
    //...
}

The simplest method to achieve this is to modify the serialization configuration file that we’ve already created. Let’s add to the config/serialization/Product.xml file config for options with a serialized-name attribute description:

<!--...-->
<attribute name="options">
    <group>admin:product:read</group>
    <group>shop:product:read</group>
</attribute>
<!--...-->

And just add a serialized-name into the attribute description with a new name:

<!--...-->
<attribute name="options" serialized-name="optionValues">
    <group>admin:product:read</group>
    <group>shop:product:read</group>
</attribute>
<!--...-->

You can also achieve this by utilising serializer class. In this example we will modify it, so the name of field would be changed. Just add some custom logic:

//...
$data = $this->normalizer->normalize($object, $format, $context);

$data['optionValues'] = $data['options']; // this will change the name of your field
unset($data['options']); // optionally you can also remove old `options` field

return $data;
//...

And here we go, now your response should look like this:

{
    //...
    "id": 123,
    "code": "product_code",
    "product": "/api/v2/shop/products/product_code",
    "optionValues": [
        "/api/v2/shop/product-option-values/product_size_s"
    ],
    //...
}

Learn more¶

API Platform serialization

Tips & Tricks¶

How to get Sylius Resource configuration from the container?¶

There are some exceptions to the instructions of customizing models. In most cases the instructions will get you exactly where you need to be, but when for example attempting to customize the ShopUser model, you will see an error:

In ArrayNode.php line 331:

Unrecognized option "classes" under "sylius_user.resources.user". Available option is "user".

In this case, when customizing the ShopUser model and using the following resource configuration:

sylius_user:
    resources:
        user:
            classes:
                model: App\Entity\ShopUser

The error is displayed because the user entity is extended multiple times in the user bundle. To find out the correct configuration, please run the following command:

bin/console debug:config SyliusUserBundle

The output of that command should look similar to:

Current configuration for "SyliusUserBundle"
============================================

sylius_user:
    driver: doctrine/orm
    resources:
        admin:
            user:
                classes:
                    model: Sylius\Component\Core\Model\AdminUser
                    repository: Sylius\Bundle\UserBundle\Doctrine\ORM\UserRepository
                    form: Sylius\Bundle\CoreBundle\Form\Type\User\AdminUserType
                    interface: Sylius\Component\User\Model\UserInterface
                    controller: Sylius\Bundle\UserBundle\Controller\UserController
                    factory: Sylius\Component\Resource\Factory\Factory
                    ...
        shop:
            user:
                classes:
                    model: Sylius\Component\Core\Model\ShopUser
                    repository: Sylius\Bundle\CoreBundle\Doctrine\ORM\UserRepository
                    form: Sylius\Bundle\CoreBundle\Form\Type\User\ShopUserType
                    interface: Sylius\Component\User\Model\UserInterface
                    controller: Sylius\Bundle\UserBundle\Controller\UserController
                    factory: Sylius\Component\Resource\Factory\Factory
                    ...
        oauth:
            user:
                classes:
                    model: Sylius\Component\User\Model\UserOAuth
                    interface: Sylius\Component\User\Model\UserOAuthInterface
                    controller: Sylius\Bundle\ResourceBundle\Controller\ResourceController
                    factory: Sylius\Component\Resource\Factory\Factory
                    ...

As you can see there is an extra layer in the configuration here. Since in this example we’re attempting to customize the ShopUser entity, we need to use the following configuration in config/packages/_sylius.yaml:

sylius_user:
    resources:
        shop:
            user:
                classes:
                    model: App\Entity\ShopUser

This is how you should always be able to find out the correct configuration.

Good to know¶

See also

All the customizations can be done either in your application directly or in Plugins!

The Cookbook¶

The Cookbook is a collection of specific solutions for specific needs.

The Cookbook¶

The Sylius Cookbook is a collection of solution articles helping you with some specific, narrow problems.

Entities¶

How to add a custom model?¶

In some cases you may be needing to add new models to your application in order to cover unique business needs. The process of extending Sylius with new entities is simple and intuitive.

As an example we will take a Supplier entity, which may be really useful for shop maintenance.

1. Define your needs¶

A Supplier needs three essential fields: name, description and enabled flag.

2. Generate the entity¶

Symfony, the framework Sylius uses, provides the SymfonyMakerBundle that simplifies the process of adding a model.

Warning

Remember to have the SymfonyMakerBundle imported in the AppKernel, as it is not there by default.

You need to use such a command in your project directory.

With the Maker Bundle

php bin/console make:entity

The generator will ask you for the entity name and fields. See how it should look like to match our assumptions.

Note

You can encounter error when generating entity with Maker Bundle, this can be fixed with Maker bundle force annotation fix

3. Update the database using migrations¶

Assuming that your database was up-to-date before adding the new entity, run:

php bin/console doctrine:migrations:diff

This will generate a new migration file which adds the Supplier entity to your database. Then update the database using the generated migration:

php bin/console doctrine:migrations:migrate

4. Add ResourceInterface to your model class¶

Go to the generated class file and make it implement the ResourceInterface:

<?php

namespace App\Entity;

use Sylius\Component\Resource\Model\ResourceInterface;

class Supplier implements ResourceInterface
{
    // ...
}

5. Change repository to extend EntityRepository¶

Go to generated repository and make it extend EntityRepository and remove __construct:

<?php

namespace App\Repository\Supply;

use App\Entity\Supply\Supplier;
use Doctrine\Persistence\ManagerRegistry;
use Sylius\Bundle\ResourceBundle\Doctrine\ORM\EntityRepository;

class SupplierRepository extends EntityRepository
{
    // ...
}

6. Register your entity as a Sylius resource¶

If you don’t have it yet, create a file config/packages/sylius_resource.yaml.

# config/packages/sylius_resource.yaml
sylius_resource:
    resources:
        app.supplier:
            driver: doctrine/orm # You can use also different driver here
            classes:
                model: App\Entity\Supplier
                repository: App\Repository\SupplierRepository

To check if the process was run correctly run such a command:

php bin/console debug:container | grep supplier

The output should be:

7. Define grid structure for the new entity¶

To have templates for your Entity administration out of the box you can use Grids. Here you can see how to configure a grid for the Supplier entity.

# config/packages/_sylius.yaml
sylius_grid:
    grids:
        app_admin_supplier:
            driver:
                name: doctrine/orm
                options:
                    class: App\Entity\Supplier
            fields:
                name:
                    type: string
                    label: sylius.ui.name
                description:
                    type: string
                    label: sylius.ui.description
                enabled:
                    type: twig
                    label: sylius.ui.enabled
                    options:
                        template: "@SyliusUi/Grid/Field/enabled.html.twig"
            actions:
                main:
                    create:
                        type: create
                item:
                    update:
                        type: update
                    delete:
                        type: delete

8. Define routing for entity administration¶

Having a grid prepared we can configure routing for the entity administration:

# config/routes.yaml
app_admin_supplier:
    resource: |
        alias: app.supplier
        section: admin
        templates: "@SyliusAdmin\\Crud"
        redirect: update
        grid: app_admin_supplier
        vars:
            all:
                subheader: app.ui.supplier
            index:
                icon: 'file image outline'
    type: sylius.resource
    prefix: /admin

10. Check the admin panel for your changes¶

Tip

To see what you can do with your new entity access the http://localhost:8000/admin/suppliers/ url.

Learn more¶

How to add a custom model accessible for respective channel administrators?¶

Given that you are using Sylius Plus, the licensed edition of Sylius, you may have the Administrators per Channel defined in your application. Thus when you add a new, channel-based entity to it, you will need to enable this entity to be viewed only by the relevant channel admins.

1. Define your custom model, our example will be the Supplier entity¶

In order to prepare a simple Entity follow this guide.

Remember to then add your entity to the admin menu. Adding a new entity to the admin menu is described in the section How to customize Admin Menu of this guide.

Having your Supplier entity created, add a channel field with relation to the Channel entity:

/**
 * @var ChannelInterface
 * @ORM\ManyToOne(targetEntity="Sylius\Plus\Entity\ChannelInterface")
 * @ORM\JoinColumn(name="channel_id", referencedColumnName="id", nullable=true)
 */
protected $channel;

public function getChannel(): ?ChannelInterface
{
    return $this->channel;
}

public function setChannel(?ChannelInterface $channel): void
{
    $this->channel = $channel;
}

Assuming that your database was up-to-date before these changes, create a proper migration and use it:

php bin/console doctrine:migrations:diff
php bin/console doctrine:migrations:migrate

Next, create a form type for your entity:

<?php

declare(strict_types=1);

namespace App\Form\Type;

use Sylius\Bundle\ChannelBundle\Form\Type\ChannelChoiceType;
use Sylius\Bundle\ResourceBundle\Form\Type\AbstractResourceType;
use Sylius\Plus\ChannelAdmin\Application\Provider\AvailableChannelsForAdminProviderInterface;
use Symfony\Component\Form\Extension\Core\Type\TextType;
use Symfony\Component\Form\FormBuilderInterface;

final class SupplierType extends AbstractResourceType
{
    /** @var AvailableChannelsForAdminProviderInterface */
    private $availableChannelsForAdminProvider;

    public function __construct(
        string $dataClass,
        array $validationGroups,
        AvailableChannelsForAdminProviderInterface $availableChannelsForAdminProvider
    ) {
        parent::__construct($dataClass, $validationGroups);

        $this->availableChannelsForAdminProvider = $availableChannelsForAdminProvider;
    }

    public function buildForm(FormBuilderInterface $builder, array $options)
    {
        $builder
            ->add('name', TextType::class, [
                'label' => 'Name'
            ])
            ->add('channel', ChannelChoiceType::class, [
                'choices' => $this->availableChannelsForAdminProvider->getChannels(),
                'label' => 'sylius.ui.channel',
            ])
        ;
    }

    public function getBlockPrefix(): string
    {
        return 'supplier';
    }
}

# config/services.yaml
App\Form\Type\SupplierType:
    arguments:
        - 'App\Entity\Supplier'
        - 'sylius'
        - '@Sylius\Plus\ChannelAdmin\Application\Provider\AvailableChannelsForAdminProviderInterface'
    tags: ['form.type']

The Sylius\Plus\ChannelAdmin\Application\Provider\AvailableChannelsForAdminProviderInterface service allows getting a list of proper channels for the currently logged in admin user.

Remember to register App\Form\SupplierType for resource:

sylius_resource:
    resources:
        app.supplier:
            driver: doctrine/orm
            classes:
                model: App\Entity\Supplier
   +            form: App\Form\Type\SupplierType

2. Restrict access to the entity for the respective channel administrator:¶

Note

More information about using administrator roles (ACL/RBAC) can be found here.

Add supplier to restricted resources:

sylius_plus:
    channel_admin:
        restricted_resources:
            supplier: ~

Create App\Checker\SupplierResourceChannelChecker and tag this service with sylius_plus.channel_admin.resource_channel_checker:

Tip

If the created entity implements the Sylius\Component\Channel\Model\ChannelAwareInterface interface, everything will work without having to do this step and create SupplierResourceChannelChecker.

<?php

declare(strict_types=1);

namespace App\Checker;

use App\Entity\Supplier;
use Sylius\Plus\ChannelAdmin\Application\Checker\ResourceChannelCheckerInterface;
use Sylius\Plus\Entity\ChannelInterface;

final class SupplierResourceChannelChecker implements ResourceChannelCheckerInterface
{
    public function isFromChannel(object $resource, ChannelInterface $channel): bool
    {
        if ($resource instanceof Supplier && in_array($resource->getChannel(), [$channel, null], true)) {
            return true;
        }

        return false;
    }
}

# config/services.yaml
App\Checker\SupplierResourceChannelChecker:
    tags:
        - { name: sylius_plus.channel_admin.resource_channel_checker }

After that, access to the resource should work properly with all restrictions.

Next add RestrictingSupplierListQueryBuilder:

<?php

declare(strict_types=1);

namespace App\Doctrine\ORM;

use Doctrine\ORM\QueryBuilder;
use Sylius\Bundle\ResourceBundle\Doctrine\ORM\EntityRepository;
use Sylius\Component\Core\Model\ChannelInterface;
use Sylius\Plus\ChannelAdmin\Application\Provider\AdminChannelProviderInterface;

final class RestrictingSupplierListQueryBuilder
{
    /** @var AdminChannelProviderInterface */
    private $adminChannelProvider;

    /** @var EntityRepository */
    private $supplierRepository;

    public function __construct(
        AdminChannelProviderInterface $adminChannelProvider,
        EntityRepository $supplierRepository
    ) {
        $this->adminChannelProvider = $adminChannelProvider;
        $this->supplierRepository = $supplierRepository;
    }

    public function create(): QueryBuilder
    {
        $listQueryBuilder = $this->supplierRepository->createQueryBuilder('o');

        /** @var ChannelInterface|null $channel */
        $channel = $this->adminChannelProvider->getChannel();
        if ($channel === null) {
            return $listQueryBuilder;
        }

        return $listQueryBuilder
            ->andWhere('o.channel = :channel')
            ->setParameter('channel', $channel)
        ;
    }
}

# config/services.yaml
App\Doctrine\ORM\RestrictingSupplierListQueryBuilder:
    public: true
    class: App\Doctrine\ORM\RestrictingSupplierListQueryBuilder
    arguments: ['@Sylius\Plus\ChannelAdmin\Application\Provider\AdminChannelProviderInterface', '@app.repository.supplier']

Add method to the Suppliers grid:

  sylius_grid:
      grids:
          app_admin_supplier:
              driver:
                  name: doctrine/orm
                  options:
                      class: App\Entity\Supplier
+                     repository:
+                         method: [expr:service('App\\Doctrine\\ORM\\RestrictingSupplierListQueryBuilder'), create]

Well done! That’s it, now you have a Supplier entity, that is accessible within the Sylius Plus Administrators per Channel feature!

How to add a custom translatable model?¶

In this guide we will create a new translatable model in our system, which is quite similar to adding a simple model, although it requires some additional steps.

As an example we will take a translatable Supplier entity, which may be really useful for shop maintenance.

1. Define your needs¶

A Supplier needs three essential fields: name, description and enabled flag. The name and description fields need to be translatable.

2. Generate the SupplierTranslation entity¶

Symfony, the framework Sylius uses, provides the SensioGeneratorBundle, that simplifies the process of adding a model.

Warning

Remember to have the SensioGeneratorBundle imported in the AppKernel, as it is not there by default.

You need to use such a command in your project directory.

php bin/console generate:doctrine:entity

The generator will ask you for the entity name and fields. See how it should look like to match our assumptions.

_images/generating_translation_entity.png

As you can see we have provided only the desired translatable fields.

Below the final SupplierTranslation class is presented, it implements the ResourceInterface.

<?php

namespace App\Entity;

use Sylius\Component\Resource\Model\AbstractTranslation;
use Sylius\Component\Resource\Model\ResourceInterface;

class SupplierTranslation extends AbstractTranslation implements ResourceInterface
{
    /**
     * @var int
     */
    private $id;

    /**
     * @var string
     */
    private $name;

    /**
     * @var string
     */
    private $description;

    /**
     * @return int
     */
    public function getId()
    {
        return $this->id;
    }

    /**
     * @param string $name
     */
    public function setName($name)
    {
        $this->name = $name;
    }

    /**
     * @return string
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * @param string $description
     */
    public function setDescription($description)
    {
        $this->description = $description;
    }

    /**
     * @return string
     */
    public function getDescription()
    {
        return $this->description;
    }
}

3. Generate the Supplier entity¶

While generating the entity, similarly to the way the translation was generated, we are providing only non-translatable fields. In our case only the enabled field.

Having the stubs generated, we need to extend our class with a connection to SupplierTranslation.

implement the ResourceInterface,
implement the TranslatableInterface,
use the TranslatableTrait,
initialize the translations collection in the constructor,
add the createTranslation() method,
implement getters and setters for the properties that are held on the translation model.

As a result you should get such a Supplier class:

<?php

namespace App\Entity;

use Sylius\Component\Resource\Model\ResourceInterface;
use Sylius\Component\Resource\Model\TranslatableInterface;
use Sylius\Component\Resource\Model\TranslatableTrait;

class Supplier implements ResourceInterface, TranslatableInterface
{
    use TranslatableTrait {
        __construct as private initializeTranslationsCollection;
    }

    public function __construct()
    {
        $this->initializeTranslationsCollection();
    }

    /**
     * @var int
     */
    private $id;

    /**
     * @var bool
     */
    private $enabled;

    /**
     * @return int
     */
    public function getId()
    {
        return $this->id;
    }

    /**
     * @param string $name
     */
    public function setName($name)
    {
        $this->getTranslation()->setName($name);
    }

    /**
     * @return string
     */
    public function getName()
    {
        return $this->getTranslation()->getName();
    }

    /**
     * @param string $description
     */
    public function setDescription($description)
    {
        $this->getTranslation()->setDescription($description);
    }

    /**
     * @return string
     */
    public function getDescription()
    {
        return $this->getTranslation()->getDescription();
    }

    /**
     * @param boolean $enabled
     */
    public function setEnabled($enabled)
    {
        $this->enabled = $enabled;
    }

    /**
     * @return bool
     */
    public function getEnabled()
    {
        return $this->enabled;
    }

    /**
     * {@inheritdoc}
     */
    protected function createTranslation()
    {
        return new SupplierTranslation();
    }
}

4. Register your entity together with translation as a Sylius resource¶

If you don’t have it yet, create a file config/packages/sylius_resource.yaml.

# config/packages/sylius_resource.yaml
sylius_resource:
    resources:
        app.supplier:
            driver: doctrine/orm # You can use also different driver here
            classes:
                model: App\Entity\Supplier
            translation:
                classes:
                    model: App\Entity\SupplierTranslation

To check if the process was run correctly run such a command:

php bin/console debug:container | grep supplier

The output should be:

_images/container_debug_supplier_translation.png

5. Update the database using migrations¶

Assuming that your database was up-to-date before adding the new entity, run:

php bin/console doctrine:migrations:diff

This will generate a new migration file which adds the Supplier entity to your database. Then update the database using the generated migration:

php bin/console doctrine:migrations:migrate

6. Prepare new forms for your entity, that will be aware of its translation¶

You will need both SupplierType and SupplierTranslationType.

Let’s start with the translation type, as it will be included into the entity type.

<?php

namespace App\Form\Type;

use Sylius\Bundle\ResourceBundle\Form\Type\AbstractResourceType;
use Symfony\Component\Form\Extension\Core\Type\TextareaType;
use Symfony\Component\Form\Extension\Core\Type\TextType;
use Symfony\Component\Form\FormBuilderInterface;

class SupplierTranslationType extends AbstractResourceType
{
    /**
     * {@inheritdoc}
     */
    public function buildForm(FormBuilderInterface $builder, array $options)
    {
        $builder
            ->add('name', TextType::class)
            ->add('description', TextareaType::class, [
                'required' => false,
            ])
        ;
    }

    /**
     * {@inheritdoc}
     */
    public function getBlockPrefix()
    {
        return 'app_supplier_translation';
    }
}

On the SupplierTranslationType we need to define only the translatable fields.

Then let’s prepare the entity type, that will include the translation type.

<?php

namespace App\Form\Type;

use Sylius\Bundle\ResourceBundle\Form\Type\AbstractResourceType;
use Sylius\Bundle\ResourceBundle\Form\Type\ResourceTranslationsType;
use Sylius\Component\Resource\Translation\Provider\TranslationLocaleProviderInterface;
use Symfony\Component\Form\Extension\Core\Type\CheckboxType;
use Symfony\Component\Form\Extension\Core\Type\TextareaType;
use Symfony\Component\Form\Extension\Core\Type\TextType;
use Symfony\Component\Form\FormBuilderInterface;

class SupplierType extends AbstractResourceType
{
    /**
     * {@inheritdoc}
     */
    public function buildForm(FormBuilderInterface $builder, array $options)
    {
        $builder
            ->add('translations', ResourceTranslationsType::class, [
                'entry_type' => SupplierTranslationType::class,
            ])
            ->add('enabled', CheckboxType::class, [
                'required' => false,
            ])
        ;
    }

    /**
     * {@inheritdoc}
     */
    public function getBlockPrefix()
    {
        return 'app_supplier';
    }
}

7. Register the new forms as services¶

Before the newly created forms will be ready to use them, they need to be registered as services:

# config/services.yaml
services:
    app.supplier.form.type:
        class: App\Form\Type\SupplierType
        tags:
            - { name: form.type }
        arguments: ['%app.model.supplier.class%', ['sylius']]
    app.supplier_translation.form.type:
        class: App\Form\Type\SupplierTranslationType
        tags:
            - { name: form.type }
        arguments: ['%app.model.supplier_translation.class%', ['sylius']]

8. Register the forms as resource forms of the Supplier entity¶

Extend the resource configuration of the app.supplier with forms:

# config/resources.yaml
sylius_resource:
    resources:
        app.supplier:
            driver: doctrine/orm # You can use also different driver here
            classes:
                model: App\Entity\Supplier
                form: App\Form\Type\SupplierType
            translation:
                classes:
                    model: App\Entity\SupplierTranslation
                    form: App\Form\Type\SupplierTranslationType

9. Define grid structure for the new entity¶

To have templates for your Entity administration out of the box you can use Grids. Here you can see how to configure a grid for the Supplier entity.

# config/packages/_sylius.yaml
sylius_grid:
    grids:
        app_admin_supplier:
            driver:
                name: doctrine/orm
                options:
                    class: App\Entity\Supplier
            fields:
                name:
                    type: string
                    label: sylius.ui.name
                    sortable: translation.name
                enabled:
                    type: twig
                    label: sylius.ui.enabled
                    options:
                        template: "@SyliusUi/Grid/Field/enabled.html.twig"
            actions:
                main:
                    create:
                        type: create
                item:
                    update:
                        type: update
                    delete:
                        type: delete

10. Create template¶

# App/Resources/views/Supplier/_form.html.twig
{% from '@SyliusAdmin/Macro/translationForm.html.twig' import translationForm %}

{{ form_errors(form) }}
{{ translationForm(form.translations) }}
{{ form_row(form.enabled) }}

11. Define routing for entity administration¶

Having a grid prepared we can configure routing for the entity administration:

# config/routes.yaml
app_admin_supplier:
    resource: |
        alias: app.supplier
        section: admin
        templates: "@SyliusAdmin\\Crud"
        redirect: update
        grid: app_admin_supplier
        vars:
            all:
                subheader: app.ui.supplier
                templates:
                    form: App:Supplier:_form.html.twig
            index:
                icon: 'file image outline'
    type: sylius.resource
    prefix: admin

13. Check the admin panel for your changes¶

Tip

To see what you can do with your new entity access the http://localhost:8000/admin/suppliers/ url.

Learn more¶

Shop¶

How to customize Sylius Checkout?¶

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!

Why would you override the Checkout process?¶

This is a common problem for many Sylius users. Sometimes the checkout process we have designed is not suitable for your custom business needs. Therefore you need to learn how to modify it, when you will need to for example:

remove shipping step - when you do not ship the products you sell,
change the order of checkout steps,
merge shipping and addressing step into one common step,
or even make the whole checkout a one page process.

See how to do these things below:

How to remove a step from checkout?¶

Let’s imagine that you are trying to create a shop that does not need shipping - it sells downloadable files only.

To meet your needs you will need to adjust checkout process. What do you have to do then? See below:

Overwrite the state machine of Checkout¶

Open the CoreBundle/Resources/config/app/state_machine/sylius_order_checkout.yml and place its content in the src/Resources/SyliusCoreBundle/config/app/state_machine/sylius_order_checkout.yml which is a standard procedure of overriding configs in Symfony. Remove the shipping_selected and shipping_skipped states, select_shipping and skip_shipping transitions. Remove the select_shipping and skip_shipping transition from the sylius_process_cart callback.

# app/Resources/SyliusCoreBundle/config/app/state_machine/sylius_order_checkout.yml
winzou_state_machine:
    sylius_order_checkout:
        class: "%sylius.model.order.class%"
        property_path: checkoutState
        graph: sylius_order_checkout
        state_machine_class: "%sylius.state_machine.class%"
        states:
            cart: ~
            addressed: ~
            payment_skipped: ~
            payment_selected: ~
            completed: ~
        transitions:
            address:
                from: [cart, addressed, payment_selected, payment_skipped]
                to: addressed
            skip_payment:
                from: [addressed]
                to: payment_skipped
            select_payment:
                from: [addressed, payment_selected]
                to: payment_selected
            complete:
                from: [payment_selected, payment_skipped]
                to: completed
        callbacks:
            after:
                sylius_process_cart:
                    on: ["address", "select_payment"]
                    do: ["@sylius.order_processing.order_processor", "process"]
                    args: ["object"]
                sylius_create_order:
                    on: ["complete"]
                    do: ["@sm.callback.cascade_transition", "apply"]
                    args: ["object", "event", "'create'", "'sylius_order'"]
                sylius_save_checkout_completion_date:
                    on: ["complete"]
                    do: ["object", "completeCheckout"]
                    args: ["object"]
                sylius_skip_shipping:
                    on: ["address"]
                    do: ["@sylius.state_resolver.order_checkout", "resolve"]
                    args: ["object"]
                    priority: 1
                sylius_skip_payment:
                    on: ["address"]
                    do: ["@sylius.state_resolver.order_checkout", "resolve"]
                    args: ["object"]
                    priority: 1

Tip

To check if your new state machine configuration is overriding the old one run: php bin/console debug:winzou:state-machine and check the configuration of sylius_order_checkout.

Adjust Checkout Resolver¶

The next step of customizing Checkout is to adjust the Checkout Resolver to match the changes you have made in the state machine.

# config/packages/sylius_shop.yaml
sylius_shop:
    checkout_resolver:
        pattern: /checkout/.+
        route_map:
            cart:
                route: sylius_shop_checkout_address
            addressed:
                route: sylius_shop_checkout_select_payment
            payment_selected:
                route: sylius_shop_checkout_complete
            payment_skipped:
                route: sylius_shop_checkout_complete

Adjust Checkout Templates¶

After you have got the resolver adjusted, modify the templates for checkout. You have to remove shipping from steps and disable the hardcoded ability to go back to the shipping step and the number of steps being displayed in the checkout navigation. You will achieve that by overriding two files:

{# templates/SyliusShopBundle/Checkout/_steps.html.twig #}
{% if active is not defined or active == 'address' %}
    {% set steps = {'address': 'active', 'select_payment': 'disabled', 'complete': 'disabled'} %}
{% elseif active == 'select_payment' %}
    {% set steps = {'address': 'completed', 'select_payment': 'active', 'complete': 'disabled'} %}
{% else %}
    {% set steps = {'address': 'completed', 'select_payment': 'completed', 'complete': 'active'} %}
{% endif %}

{% set order_requires_payment = sylius_is_payment_required(order) %}

{% set steps_count = 'three' %}
{% if not order_requires_payment %}
    {% set steps_count = 'two' %}
{% endif %}

<div class="ui {{ steps_count }} steps">
    <a class="{{ steps['address'] }} step" href="{{ path('sylius_shop_checkout_address') }}">
        <i class="map icon"></i>
        <div class="content">
            <div class="title">{{ 'sylius.ui.address'|trans }}</div>
            <div class="description">{{ 'sylius.ui.fill_in_your_billing_and_shipping_addresses'|trans }}</div>
        </div>
    </a>
    {% if order_requires_payment %}
    <a class="{{ steps['select_payment'] }} step" href="{{ path('sylius_shop_checkout_select_payment') }}">
        <i class="payment icon"></i>
        <div class="content">
            <div class="title">{{ 'sylius.ui.payment'|trans }}</div>
            <div class="description">{{ 'sylius.ui.choose_how_you_will_pay'|trans }}</div>
        </div>
    </a>
    {% endif %}
    <div class="{{ steps['complete'] }} step" href="{{ path('sylius_shop_checkout_complete') }}">
        <i class="checkered flag icon"></i>
        <div class="content">
            <div class="title">{{ 'sylius.ui.complete'|trans }}</div>
            <div class="description">{{ 'sylius.ui.review_and_confirm_your_order'|trans }}</div>
        </div>
    </div>
</div>

{# templates/SyliusShopBundle/Checkout/SelectPayment/_navigation.html.twig #}
{% set enabled = order.payments|length %}

<div class="ui two column grid">
    <div class="column">
        <a href="{{ path('sylius_shop_checkout_address') }}" class="ui large icon labeled button"><i class="arrow left icon"></i> {{ 'sylius.ui.change_address'|trans }}</a>
    </div>
    <div class="right aligned column">
        <button type="submit" id="next-step" class="ui large primary icon labeled{% if not enabled %} disabled{% endif %} button">
            <i class="arrow right icon"></i>
            {{ 'sylius.ui.next'|trans }}
        </button>
    </div>
</div>

Overwrite routing for Checkout¶

Unfortunately there is no better way - you have to overwrite the whole routing for Checkout. To do that copy the content of ShopBundle/Resources/config/routing/checkout.yml to the app/Resources/SyliusShopBundle/config/routing/checkout.yml file. Remove routing of sylius_shop_checkout_select_shipping. The rest should remain the same.

# app/Resources/SyliusShopBundle/config/routing/checkout.yml
sylius_shop_checkout_start:
    path: /
    methods: [GET]
    defaults:
        _controller: Symfony\Bundle\FrameworkBundle\Controller\RedirectController:redirectAction
        route: sylius_shop_checkout_address

sylius_shop_checkout_address:
    path: /address
    methods: [GET, PUT]
    defaults:
        _controller: sylius.controller.order:updateAction
        _sylius:
            event: address
            flash: false
            template: SyliusShopBundle:Checkout:address.html.twig
            form:
                type: Sylius\Bundle\CoreBundle\Form\Type\Checkout\AddressType
                options:
                    customer: expr:service('sylius.context.customer').getCustomer()
            repository:
                method: find
                arguments:
                    - "expr:service('sylius.context.cart').getCart()"
            state_machine:
                graph: sylius_order_checkout
                transition: address

sylius_shop_checkout_select_payment:
    path: /select-payment
    methods: [GET, PUT]
    defaults:
        _controller: sylius.controller.order:updateAction
        _sylius:
            event: payment
            flash: false
            template: SyliusShopBundle:Checkout:selectPayment.html.twig
            form: Sylius\Bundle\CoreBundle\Form\Type\Checkout\SelectPaymentType
            repository:
                method: find
                arguments:
                    - "expr:service('sylius.context.cart').getCart()"
            state_machine:
                graph: sylius_order_checkout
                transition: select_payment

sylius_shop_checkout_complete:
    path: /complete
    methods: [GET, PUT]
    defaults:
        _controller: sylius.controller.order:updateAction
        _sylius:
            event: complete
            flash: false
            template: SyliusShopBundle:Checkout:complete.html.twig
            repository:
                method: find
                arguments:
                    - "expr:service('sylius.context.cart').getCart()"
            state_machine:
                graph: sylius_order_checkout
                transition: complete
            redirect:
                route: sylius_shop_order_pay
                parameters:
                    tokenValue: resource.tokenValue
            form:
                type: Sylius\Bundle\CoreBundle\Form\Type\Checkout\CompleteType
                options:
                    validation_groups: 'sylius_checkout_complete'

Tip

If you do not see any changes run php bin/console cache:clear.

Learn more¶

How to change a redirect after the add to cart action?¶

Currently Sylius by default is using route definition and sylius-add-to-cart.js script to handle redirect after successful add to cart action.

sylius_shop_partial_cart_add_item:
    path: /add-item
    methods: [GET]
    defaults:
        _controller: sylius.controller.order_item:addAction
        _sylius:
            template: $template
            factory:
                method: createForProduct
                arguments: [expr:service('sylius.repository.product').find($productId)]
            form:
                type: Sylius\Bundle\CoreBundle\Form\Type\Order\AddToCartType
                options:
                    product: expr:service('sylius.repository.product').find($productId)
            redirect:
                route: sylius_shop_cart_summary
                parameters: {}

$.fn.extend({
    addToCart: function () {
        var element = $(this);
        var href = $(element).attr('action');
        var redirectUrl = $(element).data('redirect');
        var validationElement = $('#sylius-cart-validation-error');

        $(element).api({
            method: 'POST',
            on: 'submit',
            cache: false,
            url: href,
            beforeSend: function (settings) {
                settings.data = $(this).serialize();

                return settings;
            },
            onSuccess: function (response) {
                validationElement.addClass('hidden');
                window.location.replace(redirectUrl);
            },
            onFailure: function (response) {
                validationElement.removeClass('hidden');
                var validationMessage = '';

                $.each(response.errors.errors, function (key, message) {
                    validationMessage += message;
                });
                validationElement.html(validationMessage);
                $(element).removeClass('loading');
            },
        });
    }
});

If you want to have custom logic after cart add action you can use ResourceControllerEvent to set your custom response.

Let’s assume that you would like such a feature in your system:

<?php

final class ChangeRedirectAfterAddingToCartListener
{
    /**
     * @var RouterInterface
     */
    private $router;

    /**
     * @param RouterInterface $router
     */
    public function __construct(RouterInterface $router)
    {
        $this->router = $router;
    }

    /**
     * @param ResourceControllerEvent $event
     */
    public function onSuccessfulAddToCart(ResourceControllerEvent $event)
    {
        if (!$event->getSubject() instanceof OrderItemInterface) {
            throw new \LogicException(
                sprintf('This listener operates only on order item, got "%s"', get_class($event->getSubject()))
            );
        }

        $newUrl = $this->router->generate('your_new_route_name', []);

        $event->setResponse(new RedirectResponse($newUrl));
    }
}

<service id="sylius.listener.change_redirect_after_adding_to_cart" class="Sylius\Bundle\ShopBundle\EventListener\ChangeRedirectAfterAddingToCartListener">
    <argument type="service" id="router" />
    <tag name="kernel.event_listener" event="sylius.order_item.post_add" method="onSuccessfulAddToCart" />
</service>

Next thing to do is handling it by your frontend application.

How to disable guest checkout?¶

Sometimes, depending on your use case, you may want to resign from the guest checkout feature provided by Sylius.

In order to require users to have an account and be logged in before they can make an order in your shop, you have to turn on the firewalls on the /checkout urls.

To achieve that simple add this path to access_control in the security.yaml file.

# config/packages/security.yaml
security:
    access_control:
        - { path: "%sylius.security.shop_regex%/checkout", role: ROLE_USER }

That will do the trick. Now, when a guest user tries to click the checkout button in the cart, they will be redirected to the login/registration page, where after they sign in/sign up they will be redirected to the checkout addressing step.

Learn more¶

Sylius Checkout

How to disable localised URLs?¶

URLs in Sylius are localised, this means they contain the /locale prefix with the current locale. For example when the English (United States) locale is currently chosen in the channel, the URL of homepage will look like that localhost:8000/en_US/.

If you do not need localised URLs, this guide will help you to disable this feature.

1. Customise the application routing in the config/routes/sylius_shop.yaml.

Replace:

# config/routes/sylius_shop.yaml

sylius_shop:
    resource: "@SyliusShopBundle/Resources/config/routing.yml"
    prefix: /{_locale}
    requirements:
        _locale: ^[A-Za-z]{2,4}(_([A-Za-z]{4}|[0-9]{3}))?(_([A-Za-z]{2}|[0-9]{3}))?$

sylius_shop_payum:
    resource: "@SyliusShopBundle/Resources/config/routing/payum.yml"

sylius_shop_default_locale:
    path: /
    methods: [GET]
    defaults:
        _controller: sylius.controller.shop.locale_switch:switchAction

With:

# config/routes/sylius_shop.yaml
sylius_shop:
    resource: "@SyliusShopBundle/Resources/config/routing.yml"

sylius_shop_payum:
    resource: "@SyliusShopBundle/Resources/config/routing/payum.yml"

2. Customise SyliusShopBundle to use storage-based locale switching in the config/packages/_sylius.yaml.

Replace :

# config/packages/_sylius.yaml

sylius_shop:
    product_grid:
        include_all_descendants: true

With:

# config/packages/_sylius.yaml

sylius_shop:
    product_grid:
        include_all_descendants: true
    locale_switcher: storage

How to render a menu of taxons (categories) in a view?¶

The way of rendering a menu of taxons is a supereasy reusable action, that you can adapt into any place you need.

How does it look like?¶

That’s a menu that you will find on the default Sylius homepage:

How to do it?¶

You can render such a menu wherever you have access to a category variable in the view, but also anywhere else.

The findChildren method of TaxonRepository takes a parentCode and nullable locale.

If locale parameter is not null the method returns also taxon’s translation based on given locale.

To render a simple menu of categories in any twig template use:

{{ render(url('sylius_shop_partial_taxon_index_by_code', {'code': 'category', 'template': '@SyliusShop/Taxon/_horizontalMenu.html.twig'})) }}

You can of course customize the template or enclose the menu into html to make it look better.

That’s all. Done!

Learn more¶

The Customization Guide

How to embed a list of products into a view?¶

Let’s imagine that you would like to render a list of 5 latest products by a chosen taxon. Such an action can take place on the category page. Here are the steps that you will need to take:

Create a new method for the product repository¶

To cover the usecase we have imagined we will need a new method on the product repository: findLatestByChannelAndTaxonCode().

Tip

First learn how to customize repositories in the customization docs here.

The new repository method will take a channel object (retrieved from channel context), a taxon code and the count of items that you want to find.

Your extending repository class should look like that:

<?php

namespace App\Repository;

use Sylius\Bundle\CoreBundle\Doctrine\ORM\ProductRepository as BaseProductRepository;
use Sylius\Component\Core\Model\ChannelInterface;

class ProductRepository extends BaseProductRepository
{
    /**
     * {@inheritdoc}
     */
    public function findLatestByChannelAndTaxonCode(ChannelInterface $channel, $code, $count)
        {
            return $this->createQueryBuilder('o')
                ->innerJoin('o.channels', 'channel')
                ->andWhere('o.enabled = :enabled')
                ->andWhere('channel = :channel')
                ->innerJoin('o.productTaxons', 'productTaxons')
                ->addOrderBy('productTaxons.position', 'asc')
                ->innerJoin('productTaxons.taxon', 'taxon')
                ->andWhere('taxon.code = :code')
                ->setParameter('code', $code)
                ->setParameter('channel', $channel)
                ->setParameter('enabled', true)
                ->setMaxResults($count)
                ->getQuery()
                ->getResult();
        }
}

And should be registered in the config/packages/sylius_product.yaml just like that:

sylius_product:
    resources:
        product:
            classes:
                repository: App\Repository\ProductRepository

Configure routing for the action of products rendering¶

To be able to render a partial with the retrieved products configure routing for it in the config/routes.yaml:

# config/routes.yaml
app_shop_partial_product_index_latest_by_taxon_code:
    path: /latest/{code}/{count} # configure a new path that has all the needed variables
    methods: [GET]
    defaults:
        _controller: sylius.controller.product:indexAction # you make a call on the Product Controller's index action
        _sylius:
            template: $template
            repository:
                method: findLatestByChannelAndTaxonCode # here use the new repository method
                arguments:
                    - "expr:service('sylius.context.channel').getChannel()"
                    - $code
                    - $count

Render the result of your new path in a template¶

Having a new path, you can call it in a twig template that has acces to a taxon. Remember that you need to have your taxon as a variable available there. Render the list using a simple built-in template to try it out.

{{ render(url('app_shop_partial_product_index_latest_by_taxon_code', {'code': taxon.code, 'count': 5, 'template': '@SyliusShop/Product/_horizontalList.html.twig'})) }}

Done. In the taxon view where you have rendered the new url you will see a simple list of 5 products from this taxon, ordered by position.

Learn more¶

The Customization Guide

How to add Facebook login?¶

For integrating social login functionalities Sylius uses the HWIOAuthBundle. Here you will find the tutorial for integrating Facebook login into Sylius:

Set up the HWIOAuthBundle¶

Add HWIOAuthBundle to your project:

composer require hwi/oauth-bundle php-http/httplug-bundle

php-http/httplug-bundle is optional, require this dependency if you don’t want to provide your own services. For more information, please visit Setting up HWIOAuthBundle.

Enable the bundle:

// config/bundles.php

return [
    // ...
    Http\HttplugBundle\HttplugBundle::class => ['all' => true], // If you require the php-http/httplug-bundle package.
    HWI\Bundle\OAuthBundle\HWIOAuthBundle::class => ['all' => true],
];

Import the routing:

# config/routes.yaml
hwi_oauth_redirect:
    resource: "@HWIOAuthBundle/Resources/config/routing/redirect.xml"
    prefix: /connect

hwi_oauth_connect:
    resource: "@HWIOAuthBundle/Resources/config/routing/connect.xml"
    prefix: /connect

hwi_oauth_login:
    resource: "@HWIOAuthBundle/Resources/config/routing/login.xml"
    prefix: /login

facebook:
    path: /login/check-facebook

Configure the connection to Facebook¶

Note

To properly connect to Facebook you will need a Facebook developer account. Having an account create a new app for your website. In your app dashboard you will have the client_id (App ID) and the client_secret (App Secret), which are needed for the configuration.

# config/packages/hwi_oauth.yaml
hwi_oauth:
    firewall_names: [shop]
    resource_owners:
        facebook:
            type: facebook
            client_id: <client_id>
            client_secret: <client_secret>
            scope: "email"

Sylius uses email as the username, that’s why we choose emails as scope for this connection.

Tip

If you cannot connect to your localhost with the Facebook app, configure its settings in such a way:

App Domain: localhost
Click +Add Platform and choose “Website” type.
Provide the Site URL of the platform - your local server on which you run Sylius: http://localhost:8000

Alternatively, you could temporarily expose your localhost to be publicly accessible, using a tool like ngrok. Facebook app configuration would be similar to:

App Domain: abcde12345.ngrok.io
Site URL http://abcde12345.ngrok.io

Configure the security layer¶

As Sylius already has a service that implements the OAuthAwareUserProviderInterface - sylius.oauth.user_provider - we can only configure the oauth firewall. Under the security: firewalls: shop: keys in the security.yaml configure like below:

# config/packages/security.yaml
security:
    firewalls:
        shop:
            oauth:
                resource_owners:
                    facebook: "/login/check-facebook"
                login_path: sylius_shop_login
                use_forward: false
                failure_path: sylius_shop_login

                oauth_user_provider:
                    service: sylius.oauth.user_provider
            anonymous: true

Add facebook login button¶

You can for instance override the login template (SyliusShopBundle/Resources/views/login.html.twig) in the templates/SyliusShopBundle/login.html.twig and add these lines to be able to login via Facebook.

<a href="{{ path('hwi_oauth_service_redirect', {'service': 'facebook' }) }}">
    <span>Login with Facebook</span>
</a>

Done!

Learn more¶

HWIOAuthBundle documentation

How to manage content in Sylius?¶

Why do you need content management system?¶

Content management is one of the most important business aspects of modern eCommerce apps. Providing store updates like new blog pages, banners and promotion images is responsible for building the conversion rate either for new and existing clients.

Content management in Sylius¶

Sylius standard app does not come with a content management system. Our community has taken care of it. As Sylius does have a convenient dev oriented plugin environment, the developers from BitBag decided to develop their flexible CMS module. You can find it here.

Tip

The whole plugin has its own demo page with specific use cases. You can access the admin panel with login: sylius, password: sylius credentials.

Inside the plugin, you will find:

HTML, image and text blocks you can place in each Twig template
Page resources
Sections which you can use to create a blog, customer information, etc.
FAQ module

A very handy feature of this plugin is that you can customize it for your specific needs like you do with each Sylius model.

Installation & usage¶

Find out more about how to install the plugin on GitHub in the README file.

Learn more¶

Payments¶

How to configure PayPal Express Checkout?¶

Warning

PayPal Express Checkout integration is deprecated. Take a look at the PayPal Commerce Platform integration, which is now the default PayPal-related gateway for Sylius.

One of the most frequently used payment methods in e-commerce is PayPal. Its configuration in Sylius is really simple.

Add a payment method with the Paypal Express gateway in the Admin Panel¶

Note

To test this configuration properly you will need a developer account on Paypal.

Create a new payment method choosing Paypal Express Checkout gateway from the gateways choice dropdown and enable it for chosen channels.

Go to the http://localhost:8000/admin/payment-methods/new/paypal_express_checkout url.

Fill in the Paypal configuration form with your developer account data (username, password and signature).
Save the new payment method.

Choosing Paypal Express method in Checkout¶

From now on Paypal Express will be available in Checkout in the channel you have created it for.

Done!

Learn more¶

Warning

On September 14, 2019 the Strong Customer Authentication (SCA) requirement has been introduced. The implementation provided by Sylius Core was not SCA Ready and has been deprecated. Please have a look at the official documentation of Stripe regarding this topic.

How to configure Stripe Credit Card payment?¶

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!

One of very important payment methods in e-commerce are credit cards. Payments via credit card are in Sylius supported by Stripe.

Install Stripe¶

Stripe is not available by default in Sylius, to have it you need to add its package via composer.

php composer require stripe/stripe-php:~4.1

Add a payment method with the Stripe gateway in the Admin Panel¶

Note

To test this configuration properly you will need a developer account on Stripe.

Create a new payment method, choosing the Stripe Credit Card gateway from the gateways choice dropdown and enable it for chosen channels.

Go to the http://localhost:8000/admin/payment-methods/new/stripe_checkout url.

Fill in the Stripe configuration form with your developer account data (publishable_key and secret_key).
Save the new payment method.

Tip

If your are not sure how to do it check how we do it for Paypal in this cookbook.

Warning

When your project is behind a loadbalancer and uses https you probably need to configure trusted proxies. Otherwise the payment will not succeed and the user will endlessly loopback to the payment page without any notice.

Choosing Stripe Credit Card method in Checkout¶

From now on Stripe Credit Card will be available in Checkout in the channel you have added it to.

Done!

Learn more¶

How to encrypt gateway config stored in the database?¶

1. Add defuse/php-encryption to your project .. code-block:

composer require defuse/php-encryption

2. Generate your Defuse Secret Key by executing the following script:

<?php

use Defuse\Crypto\Key;

require_once 'vendor/autoload.php';

var_dump(Key::createNewRandomKey()->saveToAsciiSafeString());

3. Store your generated key in a environmental variable in .env.

# .env
DEFUSE_SECRET: "YOUR_GENERATED_KEY"

4. Add the following code to the application configuration in the config/packages/payum.yaml.

# config/packages/payum.yaml

payum:
    dynamic_gateways:
        encryption:
            defuse_secret_key: "%env(DEFUSE_SECRET)%"

5. Existing gateway configs will be automatically encrypted when updated. New gateway configs will be encrypted by default.

How to authorize a payment before capturing.¶

Sometimes, due to legal constraint in some countries, you’ll want to only authorize a payment and capture it later.

Authorizing payments¶

Sylius supports the use of Payums payment authorization <https://github.com/Payum/Payum/blob/master/docs/symfony/authorize.md>_ Not all payment gateways support this and it is up to the payment plugin to make use of this functionality.

To use authorize status for your payments, your plugin must set a flag in it’s GatewayConfig called use_authorize. This is easily done with a hidden input field.

class MyGatewayGatewayConfigurationType extends AbstractType
{
    /**
     * {@inheritdoc}
     */
    public function buildForm(FormBuilderInterface $builder, array $options): void
    {
        $builder
            // Add other config fields for your gateway here.

            // Enable the use of authorize. This can also be a normal select field if the gateway supports both.
            ->add('use_authorize', HiddenType::class, [
                'data' => 1,
            ])
        ;
    }
}

Capture payment after authorizing¶

As an admin, you can mark the payment as captured from the order view page or through the Payments API. Capturing the payment in the gateway is up to the plugin, which can hook into the state machine or events.

Note

For an example of how this can be implemented see the QuickPay gateway plugin.

How to integrate a Payment Gateway as a Plugin?¶

Among all possible customizations, new gateway provider is one of the most common choices. Payment processing complexity, regional limits and the amount of potential payment providers makes it hard for Sylius core to keep up with all possible cases. A custom payment gateway is sometimes the only choice.

In the following example, a new gateway will be configured, which will send payment details to external API.

1. Set up a new plugin using the PluginSkeleton.

composer create-project sylius/plugin-skeleton ProjectName

2. The first step in the newly created repository would be to create a new Gateway Factory.

Prepare a gateway factory class in src/Payum/SyliusPaymentGatewayFactory.php:

// src/Payum/SyliusPaymentGatewayFactory.php

<?php

declare(strict_types=1);

namespace Acme\SyliusExamplePlugin\Payum;

use Payum\Core\Bridge\Spl\ArrayObject;
use Payum\Core\GatewayFactory;

final class SyliusPaymentGatewayFactory extends GatewayFactory
{
    protected function populateConfig(ArrayObject $config): void
    {
        $config->defaults([
            'payum.factory_name' => 'sylius_payment',
            'payum.factory_title' => 'Sylius Payment',
        ]);
    }
}

And at the end of src/Resources/config/services.xml or src/Resources/config/services.yaml add such a configuration for your gateway:

<!-- src/Resources/config/services.xml -->

<service id="app.sylius_payment" class="Payum\Core\Bridge\Symfony\Builder\GatewayFactoryBuilder">
    <argument>Acme\SyliusExamplePlugin\Payum\SyliusPaymentGatewayFactory</argument>
    <tag name="payum.gateway_factory_builder" factory="sylius_payment" />
</service>

# src/Resources/config/services.yaml

app.sylius_payment:
    class: Payum\Core\Bridge\Symfony\Builder\GatewayFactoryBuilder
    arguments: [ Acme\SyliusExamplePlugin\Payum\SyliusPaymentGatewayFactory ]
    tags:
      - { name: payum.gateway_factory_builder, factory: sylius_payment }

3. Next, one should create a configuration form, where authorization (or some additional information, like sandbox mode) can be specified.

Create the configuration type in src/Form/Type/SyliusGatewayConfigurationType.php:

// src/Form/Type/SyliusGatewayConfigurationType.php

<?php

declare(strict_types=1);

namespace Acme\SyliusExamplePlugin\Form\Type;

use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\Extension\Core\Type\TextType;
use Symfony\Component\Form\FormBuilderInterface;

final class SyliusGatewayConfigurationType extends AbstractType
{
    public function buildForm(FormBuilderInterface $builder, array $options): void
    {
        $builder->add('api_key', TextType::class);
    }
}

And add its configuration to src/Resources/config/services.xml or src/Resources/config/services.yaml:

<!-- src/Resources/config/services.xml -->

<service id="Acme\SyliusExamplePlugin\Form\Type\SyliusGatewayConfigurationType">
    <tag name="sylius.gateway_configuration_type" type="sylius_payment" label="Sylius Payment" />
    <tag name="form.type" />
</service>

# src/Resources/config/services.yaml

Acme\SyliusExamplePlugin\Form\Type\SyliusGatewayConfigurationType:
    tags:
      - { name: sylius.gateway_configuration_type, type: sylius_payment, label: 'Sylius Payment' }
      - { name: form.type }

4. To introduce support for new configuration fields, we need to create a value object which will be passed to action, so we can use an API Key provided in form.

Create a new ValueObject in src/Payum/SyliusApi.php:

// src/Payum/SyliusApi.php

<?php

declare(strict_types=1);

namespace Acme\SyliusExamplePlugin\Payum;

final class SyliusApi
{
    /** @var string */
    private $apiKey;

    public function __construct(string $apiKey)
    {
        $this->apiKey = $apiKey;
    }

    public function getApiKey(): string
    {
        return $this->apiKey;
    }
}

In src/Payum/SyliusPaymentGatewayFactory.php we need to add support for newly created SyliusApi VO by adding $config['payum.api'] = function (ArrayObject $config) { return new SyliusApi($config['api_key']); }; at the end of populateConfig method. Adjusted SyliusPaymentGatewayFactory class should look like this:

// src/Payum/SyliusPaymentGatewayFactory.php

<?php

declare(strict_types=1);

namespace Acme\SyliusExamplePlugin\Payum;

use Payum\Core\Bridge\Spl\ArrayObject;
use Payum\Core\GatewayFactory;

final class SyliusPaymentGatewayFactory extends GatewayFactory
{
    protected function populateConfig(ArrayObject $config): void
    {
        $config->defaults([
            'payum.factory_name' => 'sylius_payment',
            'payum.factory_title' => 'Sylius Payment',
        ]);

        $config['payum.api'] = function (ArrayObject $config) {
            return new SyliusApi($config['api_key']);
        };
    }
}

From now on, your new Payment Gateway should be available in the admin panel.

_images/new_gateway_configuration_type.png

5. Configure new payment method in the admin panel

6. Configure required actions

We will create two actions: CaptureAction and StatusAction. The first one will be responsible for sending data to an external system:

payment amount

currency

API key configured in the previously created form

while the second one will translate HTTP codes of the Response to a proper state of payment.

6.1. Create StatusAction and add it to the SyliusPaymentGatewayFactory

In a gateway factory class in src/Payum/SyliusPaymentGatewayFactory.php we need to add 'payum.action.status' => new StatusAction(), to config defaults. Adjusted SyliusPaymentGatewayFactory class should look like this:

// src/Payum/SyliusPaymentGatewayFactory.php

<?php

declare(strict_types=1);

namespace Acme\SyliusExamplePlugin\Payum;

use Acme\SyliusExamplePlugin\Payum\Action\StatusAction;
use Payum\Core\Bridge\Spl\ArrayObject;
use Payum\Core\GatewayFactory;

final class SyliusPaymentGatewayFactory extends GatewayFactory
{
    protected function populateConfig(ArrayObject $config): void
    {
        $config->defaults([
            'payum.factory_name' => 'sylius_payment',
            'payum.factory_title' => 'Sylius Payment',
            'payum.action.status' => new StatusAction(),
        ]);

        $config['payum.api'] = function (ArrayObject $config) {
            return new SyliusApi($config['api_key']);
        };
    }
}

Now we need to create a StatusAction in src/Payum/Action/StatusAction.php:

// src/Payum/Action/StatusAction.php

<?php

declare(strict_types=1);

namespace Acme\SyliusExamplePlugin\Payum\Action;

use Payum\Core\Action\ActionInterface;
use Payum\Core\Exception\RequestNotSupportedException;
use Payum\Core\Request\GetStatusInterface;
use Sylius\Component\Core\Model\PaymentInterface as SyliusPaymentInterface;

final class StatusAction implements ActionInterface
{
    public function execute($request): void
    {
        RequestNotSupportedException::assertSupports($this, $request);

        /** @var SyliusPaymentInterface $payment */
        $payment = $request->getFirstModel();

        $details = $payment->getDetails();

        if (200 === $details['status']) {
            $request->markCaptured();

            return;
        }

        if (400 === $details['status']) {
            $request->markFailed();

            return;
        }
    }

    public function supports($request): bool
    {
        return
            $request instanceof GetStatusInterface &&
            $request->getFirstModel() instanceof SyliusPaymentInterface
        ;
    }
}

StatusAction will update the state of payment based on details provided by CaptureAction. Based on the value of the status code of the HTTP request, the payment status will be adjusted as follows:

HTTP 400 (Bad request) - payment has failed

HTTP 200 (OK) - payment succeeded

6.2. Create a service for handling the CaptureAction

Warning

An external request interceptor was used for training purposes. Please, visit Beeceptor. and supply sylius-payment as an endpoint name. If the service is not working, you can use Post Test Server V2. as well, but remember about adjusting the https://sylius-payment.free.beeceptor.com path.

This time we will start with creating a CaptureAction in src/Payum/Action/CaptureAction.php:

// src/Payum/Action/CaptureAction.php

<?php

declare(strict_types=1);

namespace Acme\SyliusExamplePlugin\Payum\Action;

use Acme\SyliusExamplePlugin\Payum\SyliusApi;
use GuzzleHttp\Client;
use GuzzleHttp\Exception\RequestException;
use Payum\Core\Action\ActionInterface;
use Payum\Core\ApiAwareInterface;
use Payum\Core\Exception\RequestNotSupportedException;
use Payum\Core\Exception\UnsupportedApiException;
use Sylius\Component\Core\Model\PaymentInterface as SyliusPaymentInterface;
use Payum\Core\Request\Capture;

final class CaptureAction implements ActionInterface, ApiAwareInterface
{
    /** @var Client */
    private $client;
    /** @var SyliusApi */
    private $api;

    public function __construct(Client $client)
    {
        $this->client = $client;
    }

    public function execute($request): void
    {
        RequestNotSupportedException::assertSupports($this, $request);

        /** @var SyliusPaymentInterface $payment */
        $payment = $request->getModel();

        try {
            $response = $this->client->request('POST', 'https://sylius-payment.free.beeceptor.com', [
                'body' => json_encode([
                    'price' => $payment->getAmount(),
                    'currency' => $payment->getCurrencyCode(),
                    'api_key' => $this->api->getApiKey(),
                ]),
            ]);
        } catch (RequestException $exception) {
            $response = $exception->getResponse();
        } finally {
            $payment->setDetails(['status' => $response->getStatusCode()]);
        }
    }

    public function supports($request): bool
    {
        return
            $request instanceof Capture &&
            $request->getModel() instanceof SyliusPaymentInterface
        ;
    }

    public function setApi($api): void
    {
        if (!$api instanceof SyliusApi) {
            throw new UnsupportedApiException('Not supported. Expected an instance of ' . SyliusApi::class);
        }

        $this->api = $api;
    }
}

And at the end of src/Resources/config/services.xml or src/Resources/config/services.yaml` add such a configuration for your capture action:

<!-- src/Resources/config/services.xml -->

<service id="Acme\SyliusExamplePlugin\Payum\Action\CaptureAction" public=true>
    <argument type="service" id="sylius.http_client" />
    <tag name="payum.action" factory="sylius_payment" alias="payum.action.capture" />
</service>

# src/Resources/config/services.yaml

Acme\SyliusExamplePlugin\Payum\Action\CaptureAction:
    arguments:
        - '@sylius.http_client'
    tags:
        - { name: payum.action, factory: sylius_payment, alias: payum.action.capture }

Your shop is ready to handle the first checkout with your newly created gateway!

Tip

On both previously mentioned interceptors, you may configure a status code of the response. Check the behavior of Sylius for 400 status code (HTTP Bad Request) as well!

Learn more¶

How to customize a Credit Memo?¶

Customizing a downloadable credit memo is a really common task, which leverages the extendability of traditional Symfony applications. This cookbook includes four exemplary customizations with a varying degree of difficulty and impact.

Customizing Credit Memo’s template¶

The first exemplary customization is to change background color of the heading of line items table.

1. Copy vendor/sylius/refund-plugin/src/Resources/views/Download/creditMemo.html.twig into templates/bundles/SyliusRefundPlugin/Download/creditMemo.html.twig.

2. Change CSS styling included in the template:

<style>
    /* ... */
    .credit-memo table tr.heading td { background: #0d71bb; border-bottom: 1px solid #ddd; font-weight: bold; }
    /* ... */
</style>

How to change the logo in the Credit Memo?¶

Credit Memo’s logo is by default displayed as Sylius logo. Changing it is done by modifying the SYLIUS_REFUND_LOGO_FILE environment variable. You can achieve that by updating it’s path in your .env file like in example below:

SYLIUS_REFUND_LOGO_FILE=%kernel.project_dir%/public/assets/custom-logo.png

Make sure to clear the cache each time the configuration is changed.

How to add more graphics to the Credit Memo?¶

In case you would like to add an extra graphic to your Credit Memo twig template, it is super important to provide access to this file. Let’s say you would like to add second image to the Credit Memo. You may face the problem that wkhtmltopdf from version 0.12.6 disables access to the local files by default. Fortunately, there are two options to deal with it:

Update the config/packages/knp_snappy.yaml file by adding access to local files globally:

knp_snappy:
    pdf:
        options:
            enable-local-file-access: true

Specify the exact list of accessible files. As you may have noticed, the logo displays correctly even though local file access is not enabled. This is because we handle it by specifying the exact list of allowed files. The list can be replaced with the sylius_refund.pdf_generator.allowed_files parameter in the config/packages/_sylius.yaml:
sylius_refund: pdf_generator: allowed_files: - '%env(default:default_logo_file:resolve:SYLIUS_REFUND_LOGO_FILE)%' - 'path/image.png' - 'directory/with/allowed/files'

Displaying additional Customer’s data on Credit Memo¶

There might be some cases in which you want to get access to order or customer data. You can access these through creditMemo.order or creditMemo.order.customer respectively.

1. Copy vendor/sylius/refund-plugin/src/Resources/views/Download/creditMemo.html.twig into templates/bundles/SyliusRefundPlugin/Download/creditMemo.html.twig.

2. Customize buyer’s data included in the template:

<td>
    {{ 'sylius_refund.ui.buyer'|trans([], 'messages', creditMemo.localeCode) }}<br/>
    <strong>{{ from.fullName }} </strong><br/>
    <!-- ... -->
    {{ creditMemo.order.customer.phoneNumber }}<br/>
    <!-- ... -->
</td>

Displaying additional line item data (such as gross unit price) on Credit Memo¶

By default, a credit memo does not include unit gross price in the line items table - however, it is provided within line items data included with credit memo.

1. Copy vendor/sylius/refund-plugin/src/Resources/views/Download/creditMemo.html.twig into templates/bundles/SyliusRefundPlugin/Download/creditMemo.html.twig.

2. Customize products table data by adding one column in the template:

<tr class="heading">
    <!-- ... -->
    <td>{{ 'sylius_refund.ui.unit_net_price'|trans([], 'messages', creditMemo.localeCode) }}</td>
    <td>{{ 'app.ui.unit_gross_price'|trans([], 'messages', creditMemo.localeCode) }}</td>
    <td>{{ 'sylius_refund.ui.net_value'|trans([], 'messages', creditMemo.localeCode) }}</td>
    <!-- ... -->
</tr>

{% for item in creditMemo.lineItems %}
    <tr class="item">
        <!-- ... -->
        <td>{{ '%0.2f'|format(item.unitNetPrice/100) }}</td>
        <td>{{ '%0.2f'|format(item.unitGrossPrice/100) }}</td>
        <td>{{ '%0.2f'|format(item.netValue/100) }}</td>
        <!-- ... -->
    </tr>
{% endfor %}

3. Add missing translations for newly added string in translations/messages.en.yml:

app:
    ui:
        unit_gross_price: Unit gross price

Displaying additional elements on Credit Memo¶

Warning

This section applies only for RefundPlugin in version v1.0.0-RC.10 or above.

There might be a case when you want to extend the credit memo with additional field.

1. Copy vendor/sylius/refund-plugin/src/Resources/views/Download/creditMemo.html.twig into templates/bundles/SyliusRefundPlugin/Download/creditMemo.html.twig.

2. Customize credit memo template to include the reason:

<div class="credit-memo">
    Reason: {{ creditMemo.reason }}

    <!-- ... -->
</div>

3. Override the default credit memo model in src/Entity/Refund/CreditMemo.php:

<?php

declare(strict_types=1);

namespace App\Entity\Refund;

use Doctrine\ORM\Mapping as ORM;
use Sylius\RefundPlugin\Entity\CreditMemo as BaseCreditMemo;

/**
 * @ORM\Entity
 * @ORM\Table(name="sylius_refund_credit_memo")
 */
class CreditMemo extends BaseCreditMemo
{
    /**
     * @ORM\Column
     *
     * @var string|null
     */
    private $reason;

    public function getReason(): ?string
    {
        return $this->reason;
    }

    public function setReason(?string $reason): void
    {
        $this->reason = $reason;
    }
}

4. Configure ResourceBundle to use overridden model in config/packages/sylius_refund.yaml:

sylius_resource:
    resources:
        sylius_refund.credit_memo:
            classes:
                model: App\Entity\Refund\CreditMemo

5. Assuming that your database was up-to-date before these changes, create a proper migration and use it:

php bin/console doctrine:migrations:diff
php bin/console doctrine:migrations:migrate

6. Decorate credit memo generator to set the reason while generating the invoice. Create a class in src/Refund/CreditMemoGenerator.php:

<?php

declare(strict_types=1);

namespace App\Refund;

use App\Entity\Refund\CreditMemo;
use Sylius\Component\Core\Model\OrderInterface;
use Sylius\RefundPlugin\Entity\CreditMemoInterface;
use Sylius\RefundPlugin\Generator\CreditMemoGeneratorInterface;

final class CreditMemoGenerator implements CreditMemoGeneratorInterface
{
    /** @var CreditMemoGeneratorInterface */
    private $creditMemoGenerator;

    public function __construct(CreditMemoGeneratorInterface $creditMemoGenerator)
    {
        $this->creditMemoGenerator = $creditMemoGenerator;
    }

    public function generate(OrderInterface $order, int $total, array $units, array $shipments, string $comment): CreditMemoInterface
    {
        /** @var CreditMemo $creditMemo */
        $creditMemo = $this->creditMemoGenerator->generate($order, $total, $units, $shipments, $comment);
        $creditMemo->setReason('Charged too much');

        return $creditMemo;
    }
}

7. And then configure Symfony’s dependency injection to use that class in config/services.yaml:

services:
    # ...

    App\Refund\CreditMemoGenerator:
        decorates: 'Sylius\RefundPlugin\Generator\CreditMemoGenerator'
        arguments:
            - '@App\Refund\CreditMemoGenerator.inner'

Displaying additional elements on Credit Memo by embedding a controller¶

There might be times when you want to calculate some extra data on-the-fly or get some which are not connected on entity level with credit memo.

1. Copy vendor/sylius/refund-plugin/src/Resources/views/Download/creditMemo.html.twig into templates/bundles/SyliusRefundPlugin/Download/creditMemo.html.twig.

2. Embed a controller in the credit memo template:

<div class="credit-memo">
    Some unique data: {{ render(controller('App\\Controller\\FooController::extraData', { 'creditMemo': creditMemo })) }}

    <!-- ... -->
</div>

3. Create the referenced controller in a file called src/Controller/FooController.php:

<?php

declare(strict_types=1);

namespace App\Controller;

use Sylius\RefundPlugin\Entity\CreditMemoInterface;
use Symfony\Component\HttpFoundation\Response;
use Twig\Environment;

final class FooController
{
    /** @var Environment */
    private $twig;

    public function __construct(Environment $twig)
    {
        $this->twig = $twig;
    }

    public function extraData(CreditMemoInterface $creditMemo): Response
    {
        return new Response($this->twig->render('CreditMemo/extraData.html.twig', [
            'creditMemo' => $creditMemo,
            // Customise it to your needs, this one makes no sense
            'extraData' => $creditMemo->getNetValueTotal() * random_int(0, 42),
        ]));
    }
}

4. Created the template referenced in the controller in a file called templates/CreditMemo/extraData.html.twig:

<strong>{{ extraData }}</strong>

How to have the Credit Memos created after the Refund Payments?¶

Note

This cookbook requires having the Refund Plugin installed in your application.

Tip

Read about the features of Refund Plugin in the documentation here.

By default the refund payments are created right after the credit memos have been created. Although one may need to change it due to business requirements.

Let’s see how to achieve this!

Credit Memos created after the Refund Payments¶

All you need to do is to override the priority in service declaration in the config file. Give the CreditMemoProcessManager, which is responsible for the Credit Memo generation, the lowest possible priority (0). The priorites of services are interpreted in the descending order, thus this change will make it run after the service responsible for Refund Payments.

# config/services.yaml
services:
    Sylius\RefundPlugin\ProcessManager\CreditMemoProcessManager:
        arguments: ['@sylius.command_bus']
        tags:
            - { name: sylius_refund.units_refunded.process_step, priority: 0 }

You can also achieve it the other way round, by giving the service responsible for Payments - RefundPaymentProcessManager - the highest priority, let it be 200.

# config/services.yaml
services:
    Sylius\RefundPlugin\ProcessManager\RefundPaymentProcessManager:
        arguments:
            - '@Sylius\RefundPlugin\StateResolver\OrderFullyRefundedStateResolverInterface'
            - '@Sylius\RefundPlugin\Provider\RelatedPaymentIdProviderInterface'
            - '@Sylius\RefundPlugin\Factory\RefundPaymentFactoryInterface'
            - '@doctrine.orm.default_entity_manager'
            - '@sylius.event_bus'
        tags:
            - { name: sylius_refund.units_refunded.process_step, priority: 200 }

The process managers will work according to the new priorities (descending), and as a result, all Refund Payments will be created before their Credit Memos.

Tip

You can find the default config of all the services run in the the refund process in %kernel.project_dir%/vendor/sylius/refund-plugin/src/Resources/config/services/event_bus.xml tagged as sylius_refund.units_refunded.process_step

Learn more¶

The refund process - details

How to customize the refund form?¶

Note

This cookbook describes customization of a feature available only with Sylius/RefundPlugin installed.

A refund form is the form in which, as an Administrator, you can specify the exact amounts of money that will be refunded to a Customer.

Why would you customize the refund form?¶

Refund Plugin provides a generic solution for refunding orders, it is enough for a basic refund but many shops need more custom functionalities. For example, one may need to add refund payments scheduling, as they may be paid once a month.

How to add a field to the refund form?¶

The refund form is a form used to create the Refund Payment, thus in order to add a field to this form, you need to first add it to the Refund Payment’s model.

Refunds are processed with such a flow: command -> handler -> event -> listener, and this flow we will also need to customize in order to process the data from the new field.

In this customization, we will be extending the refund form with a scheduledAt field, which might be used then for scheduling the payments in the payment gateway.

1. Add the custom field to the Refund Payment:

Extended refund payment should look like this:

<?php

declare(strict_types=1);

namespace App\Entity\Refund;

use Doctrine\ORM\Mapping as ORM;
use Sylius\RefundPlugin\Entity\RefundPayment as BaseRefundPayment;

/**
 * @ORM\Entity
 * @ORM\Table(name="sylius_refund_refund_payment")
 */
class RefundPayment extends BaseRefundPayment implements RefundPaymentInterface
{
    /**
     * @var \DateTimeInterface|null
     *
     * @ORM\Column(type="datetime", nullable="true", name="scheduled_at")
     */
    protected $scheduledAt;

    public function getScheduledAt(): ?\DateTimeInterface
    {
        return $this->scheduledAt;
    }

    public function setScheduledAt(\DateTimeInterface $scheduledAt): void
    {
        $this->scheduledAt = $scheduledAt;
    }
}

It should implement a new interface:

<?php

declare(strict_types=1);

namespace App\Entity\Refund;

use Sylius\RefundPlugin\Entity\RefundPaymentInterface as BaseRefundPaymentInterface;

interface RefundPaymentInterface extends BaseRefundPaymentInterface
{
    public function getScheduledAt(): ?\DateTimeInterface;

    public function setScheduledAt(\DateTimeInterface $date): void;
}

Remember to update resource configuration:

# config/packages/sylius_refund.yaml
sylius_resource:
    resources:
        sylius_refund.refund_payment:
            classes:
                model: App\Entity\Refund\RefundPayment
                interface: App\Entity\Refund\RefundPaymentInterface

And update the database:

php bin/console doctrine:migrations:diff
php bin/console doctrine:migrations:migrate

2. Modify the refund form:

Once we have the new field on the Refund Payment, we will need to display its input on the refund form. We need to overwrite the template orderRefunds.html.twig from Refund Plugin. To achieve that copy the entire orderRefunds.html.twig to templates/bundles/SyliusRefundPlugin/orderRefunds.html.twig:

mkdir templates/bundles/SyliusRefundPlugin
cp vendor/sylius/refund-plugin/src/Resources/views/orderRefunds.html.twig templates/bundles/SyliusRefundPlugin

Then add:

<div class="field">
    <label for="scheduled-at">Scheduled at</label>
    <input type="date" name="sylius_scheduled_at" id="scheduled-at" />
</div>

3. Adjust the ``RefundUnits`` command:

We want the refund payments to be created with our extra scheduledAt date, therefore we need to provide this data in command, We will extend the RefundUnits command from Refund Plugin and add the new value:

<?php

declare(strict_types=1);

namespace App\Command;

use Sylius\RefundPlugin\Command\RefundUnits as BaseRefundUnits;

final class RefundUnits extends BaseRefundUnits
{
    /** @var \DateTimeInterface|null */
    private $scheduledAt;

    public function __construct(
        string $orderNumber,
        array $units,
        array $shipments,
        int $paymentMethodId,
        string $comment,
        ?\DateTimeInterface $scheduledAt
    ) {
        parent::__construct($orderNumber, $units, $shipments, $paymentMethodId, $comment);

        $this->scheduledAt = $scheduledAt;
    }

    public function getScheduledAt(): ?\DateTimeInterface
    {
        return $this->scheduledAt;
    }

    public function setScheduledAt(?\DateTimeInterface $scheduledAt): void
    {
        $this->scheduledAt = $scheduledAt;
    }
}

4. Update the ``RefundUnitsCommandCreator``:

The controller related to the refund form dispatches the RefundUnits command, and there is a service that creates a command from request, so we need to overwrite the Sylius\RefundPlugin\Creator\RefundUnitsCommandCreator:

<?php

declare(strict_types=1);

namespace App\Creator;

use App\Command\RefundUnits;
use Sylius\RefundPlugin\Command\RefundUnits as BaseRefundUnits;
use Sylius\RefundPlugin\Converter\RefundUnitsConverterInterface;
use Sylius\RefundPlugin\Creator\RefundUnitsCommandCreatorInterface;
use Sylius\RefundPlugin\Exception\InvalidRefundAmount;
use Sylius\RefundPlugin\Model\OrderItemUnitRefund;
use Sylius\RefundPlugin\Model\RefundType;
use Sylius\RefundPlugin\Model\ShipmentRefund;
use Symfony\Component\HttpFoundation\Request;
use Webmozart\Assert\Assert;

final class RefundUnitsCommandCreator implements RefundUnitsCommandCreatorInterface
{
    /** @var RefundUnitsConverterInterface */
    private $refundUnitsConverter;

    public function __construct(RefundUnitsConverterInterface $refundUnitsConverter)
    {
        $this->refundUnitsConverter = $refundUnitsConverter;
    }

    public function fromRequest(Request $request): BaseRefundUnits
    {
        Assert::true($request->attributes->has('orderNumber'), 'Refunded order number not provided');

        $units = $this->refundUnitsConverter->convert(
            $request->request->has('sylius_refund_units') ? $request->request->all()['sylius_refund_units'] : [],
            RefundType::orderItemUnit(),
            OrderItemUnitRefund::class
        );

        $shipments = $this->refundUnitsConverter->convert(
            $request->request->has('sylius_refund_shipments') ? $request->request->all()['sylius_refund_shipments'] : [],
            RefundType::shipment(),
            ShipmentRefund::class
        );

        if (count($units) === 0 && count($shipments) === 0) {
            throw InvalidRefundAmount::withValidationConstraint('sylius_refund.at_least_one_unit_should_be_selected_to_refund');
        }

        /** @var string $comment */
        $comment = $request->request->get('sylius_refund_comment', '');

        // here we need to return the new RefundUnits command, with new data
        return new RefundUnits(
            $request->attributes->get('orderNumber'),
            $units,
            $shipments,
            (int) $request->request->get('sylius_refund_payment_method'),
            $comment,
            new \DateTime($request->request->get('sylius_scheduled_at'))
        );
    }
}

And register the new service:

# config/services.yaml
Sylius\RefundPlugin\Creator\RefundUnitsCommandCreatorInterface:
    class: App\Creator\RefundUnitsCommandCreator
    arguments:
        - '@Sylius\RefundPlugin\Converter\RefundUnitsConverterInterface'

5. Modify the ``RefundUnitsHandler``:

Now, when we have a new command, we also need to overwrite the related command handler:

<?php

declare(strict_types=1);

namespace App\CommandHandler;

use Sylius\Component\Core\Model\OrderInterface;
use Sylius\Component\Core\Repository\OrderRepositoryInterface;
use App\Command\RefundUnits;
use App\Event\UnitsRefunded;
use Sylius\RefundPlugin\Refunder\RefunderInterface;
use Sylius\RefundPlugin\Validator\RefundUnitsCommandValidatorInterface;
use Symfony\Component\Messenger\MessageBusInterface;
use Webmozart\Assert\Assert;

final class RefundUnitsHandler
{
    /** @var RefunderInterface */
    private $orderUnitsRefunder;

    /** @var RefunderInterface */
    private $orderShipmentsRefunder;

    /** @var MessageBusInterface */
    private $eventBus;

    /** @var OrderRepositoryInterface */
    private $orderRepository;

    /** @var RefundUnitsCommandValidatorInterface */
    private $refundUnitsCommandValidator;

    public function __construct(
        RefunderInterface $orderUnitsRefunder,
        RefunderInterface $orderShipmentsRefunder,
        MessageBusInterface $eventBus,
        OrderRepositoryInterface $orderRepository,
        RefundUnitsCommandValidatorInterface $refundUnitsCommandValidator
    ) {
        $this->orderUnitsRefunder = $orderUnitsRefunder;
        $this->orderShipmentsRefunder = $orderShipmentsRefunder;
        $this->eventBus = $eventBus;
        $this->orderRepository = $orderRepository;
        $this->refundUnitsCommandValidator = $refundUnitsCommandValidator;
    }

    public function __invoke(RefundUnits $command): void
    {
        $this->refundUnitsCommandValidator->validate($command);

        $orderNumber = $command->orderNumber();

        /** @var OrderInterface $order */
        $order = $this->orderRepository->findOneByNumber($orderNumber);

        $refundedTotal = 0;
        $refundedTotal += $this->orderUnitsRefunder->refundFromOrder($command->units(), $orderNumber);
        $refundedTotal += $this->orderShipmentsRefunder->refundFromOrder($command->shipments(), $orderNumber);

        /** @var string|null $currencyCode */
        $currencyCode = $order->getCurrencyCode();
        Assert::notNull($currencyCode);

        $this->eventBus->dispatch(new UnitsRefunded(
            $orderNumber,
            $command->units(),
            $command->shipments(),
            $command->paymentMethodId(),
            $refundedTotal,
            $currencyCode,
            $command->comment(),
            $command->getScheduledAt()
        ));
    }
}

And register it:

# config/services.yaml
Sylius\RefundPlugin\CommandHandler\RefundUnitsHandler:
    class: App\CommandHandler\RefundUnitsHandler
    arguments:
        - '@Sylius\RefundPlugin\Refunder\OrderItemUnitsRefunder'
        - '@Sylius\RefundPlugin\Refunder\OrderShipmentsRefunder'
        - '@sylius.event_bus'
        - '@sylius.repository.order'
        - '@Sylius\RefundPlugin\Validator\RefundUnitsCommandValidatorInterface'
    tags:
        - { name: messenger.message_handler, bus: sylius.command_bus }

6. Modify the ``UnitsReturned`` event:

In previous command handler we are dispatching a new event so now we need to create this event and related event handler:

event:

<?php

declare(strict_types=1);

namespace App\Event;

use Sylius\RefundPlugin\Event\UnitsRefunded as BaseUnitsRefunded;

final class UnitsRefunded extends BaseUnitsRefunded
{
    /** @var \DateTimeInterface */
    protected $scheduledAt;

    public function __construct(
        string $orderNumber,
        array $units,
        array $shipments,
        int $paymentMethodId,
        int $amount,
        string $currencyCode,
        string $comment,
        \DateTime $scheduledAt
    ) {
        parent::__construct($orderNumber, $units, $shipments, $paymentMethodId, $amount, $currencyCode, $comment);

        $this->scheduledAt = $scheduledAt;
    }

    public function getScheduledAt(): \DateTimeInterface
    {
        return $this->scheduledAt;
    }
}

And process manager to handle the new event:

<?php

declare(strict_types=1);

namespace App\ProcessManager;

use App\Entity\Refund\RefundPaymentInterface as AppRefundPaymentInterface;
use Doctrine\ORM\EntityManagerInterface;
use Sylius\Component\Core\Model\OrderInterface;
use Sylius\Component\Core\Model\PaymentMethodInterface;
use Sylius\Component\Core\Repository\OrderRepositoryInterface;
use Sylius\Component\Core\Repository\PaymentMethodRepositoryInterface;
use Sylius\RefundPlugin\Entity\RefundPaymentInterface;
use Sylius\RefundPlugin\Event\RefundPaymentGenerated;
use Sylius\RefundPlugin\Event\UnitsRefunded;
use Sylius\RefundPlugin\Factory\RefundPaymentFactoryInterface;
use Sylius\RefundPlugin\ProcessManager\UnitsRefundedProcessStepInterface;
use Sylius\RefundPlugin\Provider\RelatedPaymentIdProviderInterface;
use Sylius\RefundPlugin\StateResolver\OrderFullyRefundedStateResolverInterface;
use Symfony\Component\Messenger\MessageBusInterface;
use Webmozart\Assert\Assert;

final class RefundPaymentProcessManager implements UnitsRefundedProcessStepInterface
{
    /** @var OrderFullyRefundedStateResolverInterface */
    private $orderFullyRefundedStateResolver;

    /** @var RelatedPaymentIdProviderInterface */
    private $relatedPaymentIdProvider;

    /** @var RefundPaymentFactoryInterface */
    private $refundPaymentFactory;

    /** @var OrderRepositoryInterface */
    private $orderRepository;

    /** @var PaymentMethodRepositoryInterface */
    private $paymentMethodRepository;

    /** @var EntityManagerInterface */
    private $entityManager;

    /** @var MessageBusInterface */
    private $eventBus;

    public function __construct(
        OrderFullyRefundedStateResolverInterface $orderFullyRefundedStateResolver,
        RelatedPaymentIdProviderInterface $relatedPaymentIdProvider,
        RefundPaymentFactoryInterface $refundPaymentFactory,
        OrderRepositoryInterface $orderRepository,
        PaymentMethodRepositoryInterface $paymentMethodRepository,
        EntityManagerInterface $entityManager,
        MessageBusInterface $eventBus
    ) {
        $this->orderFullyRefundedStateResolver = $orderFullyRefundedStateResolver;
        $this->relatedPaymentIdProvider = $relatedPaymentIdProvider;
        $this->refundPaymentFactory = $refundPaymentFactory;
        $this->orderRepository = $orderRepository;
        $this->paymentMethodRepository = $paymentMethodRepository;
        $this->entityManager = $entityManager;
        $this->eventBus = $eventBus;
    }

    public function next(UnitsRefunded $unitsRefunded): void
    {
        /** @var OrderInterface|null $order */
        $order = $this->orderRepository->findOneByNumber($unitsRefunded->orderNumber());
        Assert::notNull($order);

        /** @var PaymentMethodInterface|null $paymentMethod */
        $paymentMethod = $this->paymentMethodRepository->find($unitsRefunded->paymentMethodId());
        Assert::notNull($paymentMethod);

        /** @var AppRefundPaymentInterface $refundPayment */
        $refundPayment = $this->refundPaymentFactory->createWithData(
            $order,
            $unitsRefunded->amount(),
            $unitsRefunded->currencyCode(),
            RefundPaymentInterface::STATE_NEW,
            $paymentMethod
        );
        $refundPayment->setScheduledAt($unitsRefunded->getScheduledAt());

        $this->entityManager->persist($refundPayment);
        $this->entityManager->flush();

        $this->eventBus->dispatch(new RefundPaymentGenerated(
            $refundPayment->getId(),
            $unitsRefunded->orderNumber(),
            $unitsRefunded->amount(),
            $unitsRefunded->currencyCode(),
            $unitsRefunded->paymentMethodId(),
            $this->relatedPaymentIdProvider->getForRefundPayment($refundPayment)
        ));

        $this->orderFullyRefundedStateResolver->resolve($unitsRefunded->orderNumber());
    }
}

And register it:

Sylius\RefundPlugin\ProcessManager\RefundPaymentProcessManager:
    class: App\ProcessManager\RefundPaymentProcessManager
    arguments:
        - '@Sylius\RefundPlugin\StateResolver\OrderFullyRefundedStateResolverInterface'
        - '@Sylius\RefundPlugin\Provider\RelatedPaymentIdProviderInterface'
        - '@sylius_refund.factory.refund_payment'
        - '@sylius.repository.order'
        - '@sylius.repository.payment_method'
        - '@doctrine.orm.default_entity_manager'
        - '@sylius.event_bus'
    tags:
        - {name: sylius_refund.units_refunded.process_step, priority: 50}

7. Display the new field on the refund payment:

And as the last step, we need to overwrite the template _refundPayments.html.twig from Refund Plugin. Copy the entire _refundPayments.html.twig to templates/bundles/SyliusRefundPlugin/Order/Admin/_refundPayments.html.twig:

mkdir -p templates/bundles/SyliusRefundPlugin/Order/Admin
cp vendor/sylius/refund-plugin/src/Resources/views/Order/Admin/_refundPayments.html.twig templates/bundles/SyliusRefundPlugin/Order/Admin/

And replace header with:

<div class="header">
    {{ refund_payment.paymentMethod  }} {%  if refund_payment.scheduledAt is not null %} (Payment should be made in {{ refund_payment.scheduledAt|date('Y-M-d') }}) {% endif %}
</div>

And that’s it, we have a new field on Refund Payment with a “scheduled at” date (when admin/payment gateway should make the payment), in your application, you probably will add crone to automatize it.

How to add another type of refund?¶

Note

This cookbook describes customization of a feature available only with Sylius/RefundPlugin installed.

Why would you add type of refund?¶

Refund Plugin provides a generic solution for refunding orders, it is enough for a basic refund but many shops need more custom functionalities. For example, one may need to add loyalty points as a different refund type than order item unit and shipment.

How to implement a new type of refund?¶

In the current implementation, there are 2 basic types that are defined in RefundPlugin:

order item unit

shipment

If you would like to add another one, e.g. loyalty, which might be used then to refund the loyalty points. You need to first add it to the RefundType enum.

1. Add the new type to the RefundType and RefundTypeInterface:

Extended RefundTypeInterface should look like this:

<?php

declare(strict_types=1);

namespace App\Model\Refund;

interface RefundTypeInterface
{
    public const LOYALTY = 'loyalty';

    public static function loyalty(): self;
}

And extended RefundType should look like:

<?php

declare(strict_types=1);

namespace App\Model\Refund;

use Sylius\RefundPlugin\Model\RefundType as BaseRefundType;

final class RefundType extends BaseRefundType implements RefundTypeInterface
{
    public static function loyalty(): self
    {
        return new self(self::LOYALTY);
    }
}

You need also to set the parameter with new RefundType in your configuration file:

# config/packages/sylius_refund.yaml
parameters:
    sylius_refund.refund_type: App\Model\Refund\RefundType

2. Overwrite RefundEnumType to use your extended RefundType:

Extended RefundEnumType should look like this:

<?php

declare(strict_types=1);

namespace App\Entity\Refund\Type;

use App\Model\Refund\RefundType;
use Sylius\RefundPlugin\Entity\Type\RefundEnumType as BaseRefundEnumType;
use Sylius\RefundPlugin\Model\RefundTypeInterface;

final class RefundEnumType extends BaseRefundEnumType
{
    protected function createType($value): RefundTypeInterface
    {
        return new RefundType($value);
    }
}

And set the parameter with new RefundEnumType in your configuration file:

# config/packages/sylius_refund.yaml
parameters:
    sylius_refund.refund_enum_type: App\Entity\Refund\Type\RefundEnumType

3. Modify the refund flow:

Once we have the new type of refund added, we will need to use it and display its input on the refund form. You can achieve this by using Cookbook - How to customize the refund form? and add in handler your custom logic for refunding e.g. loyalty points.

How to customize the order invoice?¶

Note

This cookbook describes customization of a feature available only with Sylius/InvoicingPlugin installed.

The invoicing plugin lets you generate invoice on admin panel and download PDF with it. This plugin also sends an email with this invoice as well as let the administrator to delegate an email resend.

Why would you customize the invoice?¶

Invoicing Plugin provides a generic solution for generating invoices for orders, it is enough for a basic invoicing functionality but many shops need this feature customized for its needs. For example, one may need to change the look of it, or add some more data.

Getting started¶

Before you start make sure that you have:

Sylius/InvoicingPlugin installed.
Wkhtmltopdf package installed, because most of pdf generation is done with it.

How to change the logo in the Invoice?¶

In order to change the logo on the invoice, set up the SYLIUS_INVOICING_LOGO_FILE environment variable.

Example custom configuration:

SYLIUS_INVOICING_LOGO_FILE=%kernel.project_dir%/public/assets/custom-logo.png

Make sure to clear the cache each time the configuration is changed.

How to add more graphics to the Invoice?¶

In case you would like to add an extra graphic to your Invoice twig template, it is super important to provide access to this file. Let’s say you would like to add second image to the Invoice. You may face the problem that wkhtmltopdf from version 0.12.6 disables access to the local files by default. Fortunately, there are two options to deal with it:

Update the config/packages/knp_snappy.yaml file by adding access to local files globally:

knp_snappy:
    pdf:
        options:
            enable-local-file-access: true

Specify the exact list of accessible files. As you may have noticed, the logo displays correctly even though local file access is not enabled. This is because we handle it by specifying the exact list of allowed files. The list can be replaced with the sylius_refund.pdf_generator.allowed_files parameter in the config/packages/_sylius.yaml:
sylius_invoicing: pdf_generator: allowed_files: - '%env(default:default_logo_file:resolve:SYLIUS_INVOICING_LOGO_FILE)%' - 'path/image.png' - 'directory/with/allowed/files'

How to customize the invoice appearance?¶

There might be need to change how the invoices look like, f.e. there might be different logo dimension, some colours changed on the tables, or maybe the order of fields might be changed.

First let’s prepare the HTML’s so we can modify them. This command will copy only the PDF template:

mkdir templates/bundles/SyliusInvoicingPlugin/Invoice/Download
cp vendor/sylius/invoicing-plugin/src/Resources/views/Invoice/Download/pdf.html.twig templates/bundles/SyliusInvoicingPlugin/Download

But you can also copy all of the templates with:

mkdir templates/bundles/SyliusInvoicingPlugin
cp -r vendor/sylius/invoicing-plugin/src/Resources/views/Invoice templates/bundles/SyliusInvoicingPlugin/

In directory templates/bundles/SyliusInvoicingPlugin/Invoice you can find now few files.

Let’s modify the generated PDF. In this case we will modify the file from Download/pdf.html.twig. This is how the default PDF looks like (don’t worry this is not a real address of Myrna, or is it?):

Now with some magic of HTML and CSS we can modify this template, as an example we can change the color of background to red by changing

<!--...-->
<div class="invoice-box" style="background-color: red">
<!--...-->

and after this change we are graced with this masterpiece:

Warning

Every PDF that you generate is stored and then extracted so it won’t be created again. If you want to see the changes go to private/invoices and remove the generated PDF. You should see the changes of your file when you generate it again.

Note

You can also modify the view on administrator page by changing code inside show.html.twig and related templates

Note

You can learn more about customizing templates at Customization Guide

How to add additional fields to invoice?¶

Let’s say that you need (or not) some more fields. In this example we will add the customer phone number. Because we are basing upon the existing field, there should be no problem adding it to document - just place a line into Download/pdf.html.twig file. The Phone Number field is quite nested so you need to add invoice.order.customer.phoneNumber to retrieve it:

<!--...-->
    {{ invoice.billingData.city }}<br/>
    {{ invoice.order.customer.phoneNumber }}<br/>
    {{ invoice.billingData.countryCode}}
<!--...-->

And as a result we can see that phone number has been added just after the city:

Note

You can also create some validation (for example if customer has no phone number) so the field won’t be shown. If you want to learn more about twig - visit twig.

How to change the appearance of invoice tables?¶

By default on lower right corner of invoice we are displaying total of ordered items and shipment. Lets create now a new row where we will show Products total where only price for products will be shown.

First let’s add the new table row between other totals in pdf.html.twig

<!--...-->
    <tr class="totals">
        <!--tr body-->
    </tr>

    <tr class="totals">
        <td colspan="5"></td>
        <td colspan="2" >{{ 'sylius_invoicing_plugin.ui.products_total'|trans([], 'messages', invoice.localeCode) }}:</td>
        <td>{{ '%0.2f'|format(invoice.order.itemsTotal/100) }}</td>
        <td>{{ invoice.currencyCode }}</td>
    </tr>

    <tr class="totals bold">
<!--...-->

And now add the translation by creating file translations/messages.en.yaml and adding:

sylius_invoicing_plugin:
    ui:
        products_total: 'Products total'

after this changes your PDF’s total table should look like this:

How to extend Invoice with custom logic?¶

With default behavior and some simple customization it should be quite simple to achieve the Invoice you are looking for. But life is not so straightforward as we all would like, and you are in need to create some custom logic for your needs. Scary process isn’t it? Well not exactly, let’s create some custom logic for your invoice in this step.

First we need a class with our logic that will extend current Invoice:

<?php

declare(strict_types=1);

namespace App\Entity\Invoice;

use Doctrine\ORM\Mapping as ORM;
use Sylius\InvoicingPlugin\Entity\Invoice as BaseInvoice;

/**
 * @ORM\Entity
 * @ORM\Table(name="sylius_invoicing_plugin_invoice")
 */
class Invoice extends BaseInvoice implements InvoiceInterface
{
    public function customFunction(): mixed
    {
        /** your custom logic */
    }
}

And if there is a need you can also create an interface that will extend the base one:

<?php

declare(strict_types=1);

namespace App\Entity\Invoice;

use Sylius\InvoicingPlugin\Entity\InvoiceInterface as BaseInvoiceInterface;

interface InvoiceInterface extends BaseInvoiceInterface
{
    public function customFunction(): mixed;
}

Now let’s add those classes to the configuration:

# config/packages/_sylius.yaml
sylius_invoicing:
resources:
    invoice:
        classes:
            model: App\Entity\Invoice\Invoice
            interface: App\Entity\Invoice\InvoiceInterface

Note

Don’t forget to update your database if you are changing/adding fields.

Now you can show a new invoice table on PDF with some changes just like in chapters before.

How to have the Invoice generated after the payment is paid?¶

Note

This cookbook describes customization of a feature available only with Sylius/InvoicingPlugin installed.

The invoicing plugin lets you generate and download PDF invoices regarding orders. In its default behavior the invoice is generated right after the customer creates and places the order. In this cookbook, we will describe how to change this behavior, so the invoice will be created right after the order would be paid.

Why would you customize the invoice generation?¶

In the default case the order items should not be changed after completing order. But let’s say that your shop is customized with some logic which is not out of the box. Maybe one of these changes will let you change the order after it is placed? In this case, it would be better to have an invoice generated after a particular step (in the case of this cookbook - after the order is paid).

Getting started¶

Before you start, make sure that you have:

Sylius/InvoicingPlugin installed.
Wkhtmltopdf package installed, because most of pdf generation is done with it.

How to customize the invoice generation?¶

The concept is quite straightforward and it is based on Symfony events and event listeners. We need to create 3 classes and declare them in config files. Let’s start first with EventListeners that will override the default ones:

1. The OrderPaymentPaidListener will create an invoice and check if it does not exist:

<?php

declare(strict_types=1);

namespace App\EventListener;

use Sylius\InvoicingPlugin\Command\SendInvoiceEmail;
use Sylius\InvoicingPlugin\Creator\InvoiceCreatorInterface;
use Sylius\InvoicingPlugin\Event\OrderPaymentPaid;
use Sylius\InvoicingPlugin\Exception\InvoiceAlreadyGenerated;
use Symfony\Component\Messenger\MessageBusInterface;

final class OrderPaymentPaidListener
{
    /** @var InvoiceCreatorInterface */
    private $invoiceCreator;

    /** @var MessageBusInterface */
    private $commandBus;

    public function __construct(InvoiceCreatorInterface $invoiceCreator, MessageBusInterface $commandBus)
    {
        $this->invoiceCreator = $invoiceCreator;
        $this->commandBus = $commandBus;
    }

    public function __invoke(OrderPaymentPaid $event): void
    {
        try {
            $this->invoiceCreator->__invoke($event->orderNumber(), $event->date());
        } catch (InvoiceAlreadyGenerated $exception) {
        }

        $this->commandBus->dispatch(new SendInvoiceEmail($event->orderNumber()));
    }
}

2. The NoInvoiceOnOrderPlacedListener will not do anything (what a lazy boy), but as we are changing the behavior, it still has very important role:

<?php

declare(strict_types=1);

namespace App\EventListener;

use Sylius\InvoicingPlugin\Event\OrderPlaced;

final class NoInvoiceOnOrderPlacedListener
{
    public function __invoke(OrderPlaced $event): void
    {
        // intentionally left blank
    }
}

3. Last but not least OrderPaymentPaidProducer which will dispatch an event at a correct moment:

<?php

declare(strict_types=1);

namespace App\Producer;

use Sylius\Component\Core\Model\OrderInterface;
use Sylius\Component\Core\Model\PaymentInterface;
use Sylius\InvoicingPlugin\DateTimeProvider;
use Sylius\InvoicingPlugin\Event\OrderPaymentPaid;
use Symfony\Component\Messenger\MessageBusInterface;

final class OrderPaymentPaidProducer
{
    /** @var MessageBusInterface */
    private $eventBus;

    /** @var DateTimeProvider */
    private $dateTimeProvider;

    public function __construct(
        MessageBusInterface $eventBus,
        DateTimeProvider $dateTimeProvider
    ) {
        $this->eventBus = $eventBus;
        $this->dateTimeProvider = $dateTimeProvider;
    }

    public function __invoke(PaymentInterface $payment): void
    {
        /** @var OrderInterface|null $order */
        $order = $payment->getOrder();
        if ($order === null) {
            return;
        }

        /** @var string $number */
        $number = $order->getNumber();
        $this->eventBus->dispatch(new OrderPaymentPaid($number, $this->dateTimeProvider->__invoke()));
    }
}

4. Last thing that we need to do is to register new services in a container:

# config/services.yaml
services:
    sylius_invoicing_plugin.listener.order_payment_paid:
    class: App\EventListener\OrderPaymentPaidListener
    arguments:
        - '@sylius_invoicing_plugin.creator.invoice'
        - '@sylius.command_bus'
    tags:
        - { name: messenger.message_handler }

sylius_invoicing_plugin.event_listener.order_placed:
    class: App\EventListener\NoInvoiceOnOrderPlacedListener
    tags:
        - { name: messenger.message_handler }

sylius_invoicing_plugin.event_producer.order_payment_paid:
    class: App\Producer\OrderPaymentPaidProducer
    arguments:
        - '@sylius.event_bus'
        - '@sylius_invoicing_plugin.date_time_provider'
    public: true

After these changes, the invoice will be generated after the order is paid, not just after it is placed.

Emails¶

How to send a custom e-mail?¶

Note

This cookbook is suitable for a clean sylius-standard installation. For more general tips, while using SyliusMailerBundle go to Sending configurable e-mails in Symfony Blogpost.

Currently Sylius is sending e-mails only in a few “must-have” cases - see E-mails documentation. Of course these cases may not be sufficient for your business needs. If so, you will need to create your own custom e-mails inside the system.

On a basic example we will now teach how to do it.

Let’s assume that you would like such a feature in your system:

Feature: Sending a notification email to the administrator when a product is out of stock
    In order to be aware which products become out of stock
    As an Administrator
    I want to be notified via email when products become out of stock

To achieve that you will need to:

1. Create a new e-mail that will be sent:¶

prepare a template for your email in the templates/Email.

{# templates/Email/out_of_stock.html.twig #}
{% block subject %}
    One of your products has become out of stock.
{% endblock %}

{% block body %}
    {% autoescape %}
        The {{ variant.name }} variant is out of stock!
    {% endautoescape %}
{% endblock %}

configure the email under sylius_mailer: in the config/packages/sylius_mailer.yaml.

# config/packages/sylius_mailer.yaml
sylius_mailer:
    sender:
        name: Example.com
        address: no-reply@example.com
    emails:
        out_of_stock:
            subject: "A product has become out of stock!"
            template: "Email/out_of_stock.html.twig"

2. Create an Email Manager class:¶

It will need the EmailSender, the AvailabilityChecker and the AdminUser Repository.
It will operate on the Order where it needs to check each OrderItem, get their ProductVariants and check if they are available.

<?php

namespace App\EmailManager;

use Sylius\Component\Core\Model\OrderInterface;
use Sylius\Component\Inventory\Checker\AvailabilityCheckerInterface;
use Sylius\Component\Mailer\Sender\SenderInterface;
use Sylius\Component\Resource\Repository\RepositoryInterface;

final class OutOfStockEmailManager
{
    /** @var SenderInterface */
    private $emailSender;

    /** @var AvailabilityCheckerInterface */
    private $availabilityChecker;

    /** @var RepositoryInterface $adminUserRepository */
    private $adminUserRepository;

    public function __construct(
        SenderInterface $emailSender,
        AvailabilityCheckerInterface $availabilityChecker,
        RepositoryInterface $adminUserRepository
    ) {
        $this->emailSender = $emailSender;
        $this->availabilityChecker = $availabilityChecker;
        $this->adminUserRepository = $adminUserRepository;
    }

    public function sendOutOfStockEmail(OrderInterface $order): void
    {
        // get all admins, but remember to put them into an array
        $admins = $this->adminUserRepository->findAll()->toArray();

        foreach ($order->getItems() as $item) {
            $variant = $item->getVariant();

            $stockIsSufficient = $this->availabilityChecker->isStockSufficient($variant, 1);

            if ($stockIsSufficient) {
                continue;
            }

            foreach ($admins as $admin) {
                $this->emailSender->send('out_of_stock', [$admin->getEmail()], ['variant' => $variant]);
            }
        }
    }
}

3. Register the manager as a service:¶

# config/packages/_sylius.yaml
services:
    App\EmailManager\OutOfStockEmailManager:
        arguments: ['@sylius.email_sender', '@sylius.availability_checker', '@sylius.repository.admin_user']

4. Customize the state machine callback of Order’s Payment:¶

# config/packages/_sylius.yaml
winzou_state_machine:
    sylius_order_payment:
        callbacks:
            after:
                app_out_of_stock_email:
                    on: ["pay"]
                    do: ["@app.email_manager.out_of_stock", "sendOutOfStockEmail"]
                    args: ["object"]

Done!

Learn More¶

How to customize email templates per channel?¶

Note

This cookbook is suitable for a clean sylius-standard installation. For more general tips, while using SyliusMailerBundle go to Sending configurable e-mails in Symfony Blogpost.

It is a common use-case to customize email templates depending on a channel in which an action was performed.

Pick a template to customize

You can find the list of all email templates and their data on emails documentation page. Then, override that template following our template customization guide.

In this cookbook, let’s assume that we want to customize the order confirmation email located at @SyliusShopBundle/Email/orderConfirmation.html.twig. This requires creating a new template in templates/bundles/SyliusShopBundle/Email/orderConfirmation.html.twig.

Add an if statement for simple customizations

The simplest customization might be done with an if statement in the template.

<!-- templates/bundles/SyliusShopBundle/Email/orderConfirmation.html.twig -->

{% block subject %}Topic{% endblock %}

{% block body %}{% autoescape %}
    {% if channel.code is same as ('TOY_STORE') %}
        Thanks for buying one of our toys!
    {% else %}
        Thanks for buying!
    {% endif %}

    Your order no. {{ order.number }} has been successfully placed.
{% endautoescape %}{% endblock %}

Extract templates for more flexibility (optional)

If you require more flexibility, you can extract templates to standalone files.

<!-- templates/bundles/SyliusShopBundle/Email/orderConfirmation.html.twig -->

{% block subject %}Topic{% endblock %}

{% block body %}{% autoescape %}
    {% include ['/Email/OrderConfirmation/' ~ sylius.channel.code ~ '.html.twig', '/Email/OrderConfirmation/_default.html.twig'] %}
{% endautoescape %}{% endblock %}

The code snippet above will first try to load email body template based on channel code and will fall back to default template if not found.

It is required now to create the default template in templates/Email/OrderConfirmation/_default.html.twig (this path is the one defined above).

<!-- templates/Email/OrderConfirmation/_default.html.twig -->

Your order no. {{ order.number }} has been successfully placed.

And also the one specific for TOY_STORE channel in templates/Email/OrderConfirmation/TOY_STORE.html.twig:

<!-- templates/Email/OrderConfirmation/TOY_STORE.html.twig -->

Thanks for buying one of our toys!

Your order with number {{ order.number }} is currently being processed.

This way allows to keep independent templates with email contents based on the channel.

How to disable the order confirmation email?¶

In some usecases you may be wondering if it is possible to completely turn off the order confirmation email after the order complete.

This is a complicated situation, because we need to be precise what is our expected result:

to disable that email in the system completely,
to send a different email on the complete action of an order instead of the order confirmation email,

Below a few ways to disable that email are presented:

Disabling the email in the configuration¶

There is a pretty straightforward way to disable an e-mail using just a few lines of yaml:

# config/packages/sylius_mailer.yaml
sylius_mailer:
    emails:
        order_confirmation:
            enabled: false

That’s all. With that configuration the order confirmation email will not be sent.

Disabling the listener responsible for that action¶

To easily turn off the sending of the order confirmation email you will need to disable the OrderCompleteListener service. This can be done via a CompilerPass.

<?php

namespace App\DependencyInjection\Compiler;

use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
use Symfony\Component\DependencyInjection\ContainerBuilder;

final class MailPass implements CompilerPassInterface
{
    public function process(ContainerBuilder $container): void
    {
        $container->removeDefinition('sylius.listener.order_complete');
    }
}

The above compiler pass needs to be added to your kernel in the src/Kernel.php file:

<?php

namespace App;

use App\DependencyInjection\Compiler\MailPass;
// ...

final class Kernel extends BaseKernel
{
    // ...

    public function build(ContainerBuilder $container): void
    {
        parent::build($container);

        $container->addCompilerPass(new MailPass());
    }
}

That’s it, we have removed the definition of the listener that is responsible for sending the order confirmation email.

Learn more¶

Compiler passes in the Symfony documentation

How to configure mailer?¶

There are many services used for sending transactional emails in web applications. You can find for instance Mailjet, Mandrill or SendGrid among them.

In Sylius emails are configured the Symfony way, so you can get inspired by the Symfony guides to those mailing services.

Basically to start sending emails via a mailing service you will need to:

Create an account on a mailing service.
In the your .env file modify variable MAILER_URL

MAILER_URL=gmail://username:password@localhost

Emails delivery is disable for test, dev and stage environments by default. The prod environment has delivery turned on by default, so there is nothing to worry about if you did not change anything about it.

That’s pretty much all! All the other issues are dependent on the service you are using.

Warning

Remember that the parameters like username or password must not be committed publicly to your repository. Save them as environment variables on your server.

Learn More¶

Promotions¶

How to add a custom promotion rule?¶

Adding new, custom rules to your shop is a common usecase. You can imagine for instance, that you have some customers in your shop that you distinguish as premium. And for these premium customers you would like to give special promotions. For that you will need a new PromotionRule that will check if the customer is premium or not.

Create a new promotion rule¶

The new Rule needs a RuleChecker class:

<?php

namespace App\Promotion\Checker\Rule;

use Sylius\Component\Promotion\Checker\Rule\RuleCheckerInterface;
use Sylius\Component\Promotion\Model\PromotionSubjectInterface;

class PremiumCustomerRuleChecker implements RuleCheckerInterface
{
    const TYPE = 'premium_customer';

    /**
     * {@inheritdoc}
     */
    public function isEligible(PromotionSubjectInterface $subject, array $configuration): bool
    {
        return $subject->getCustomer()->isPremium();
    }
}

Prepare a configuration form type for your new rule¶

To be able to configure a promotion with your new rule you will need a form type for the admin panel.

Create the configuration form type class:

<?php

namespace App\Form\Type\Rule;

use Symfony\Component\Form\AbstractType;

class PremiumCustomerConfigurationType extends AbstractType
{
    /**
     * {@inheritdoc}
     */
    public function getBlockPrefix()
    {
        return 'app_promotion_rule_premium_customer_configuration';
    }
}

And configure it in the config/services.yaml:

# config/services.yaml
app.form.type.promotion_rule.premium_customer_configuration:
    class: App\Form\Type\Rule\PremiumCustomerConfigurationType
    tags:
        - { name: form.type }

Register the new rule checker as a service in the config/services.yaml:

# config/services.yaml
services:
    app.promotion_rule_checker.premium_customer:
        class: App\Promotion\Checker\Rule\PremiumCustomerRuleChecker
        tags:
            - { name: sylius.promotion_rule_checker, type: premium_customer, form_type: App\Form\Type\Rule\PremiumCustomerConfigurationType, label: Premium customer }

That’s all. You will now be able to choose the new rule while creating a new promotion.

Tip

Depending on the type of rule that you would like to configure you may need to configure its form fields. See how we do it here for example.

Learn more¶

How to add a custom promotion action?¶

Let’s assume that you would like to have a promotion that gives 100% discount on the cheapest item in the cart.

See what steps need to be taken to achieve that:

Create a new promotion action¶

You will need a new class CheapestProductDiscountPromotionActionCommand.

It will give a discount equal to the unit price of the cheapest item. That’s why it needs to have the Proportional Distributor and the Adjustments Applicator. The execute method applies the discount and distributes it properly on the totals. This class needs also a isConfigurationValid() method which was omitted in the snippet below.

<?php

namespace App\Promotion\Action;

use Sylius\Component\Core\Promotion\Action\DiscountPromotionActionCommand;

class CheapestProductDiscountPromotionActionCommand extends DiscountPromotionActionCommand
{
    const TYPE = 'cheapest_item_discount';

    /**
     * @var ProportionalIntegerDistributorInterface
     */
    private $proportionalDistributor;

    /**
     * @var UnitsPromotionAdjustmentsApplicatorInterface
     */
    private $unitsPromotionAdjustmentsApplicator;

    /**
     * @param ProportionalIntegerDistributorInterface $proportionalIntegerDistributor
     * @param UnitsPromotionAdjustmentsApplicatorInterface $unitsPromotionAdjustmentsApplicator
     */
    public function __construct(
        ProportionalIntegerDistributorInterface $proportionalIntegerDistributor,
        UnitsPromotionAdjustmentsApplicatorInterface $unitsPromotionAdjustmentsApplicator
    ) {
        $this->proportionalDistributor = $proportionalIntegerDistributor;
        $this->unitsPromotionAdjustmentsApplicator = $unitsPromotionAdjustmentsApplicator;
    }

    /**
     * {@inheritdoc}
     */
    public function execute(PromotionSubjectInterface $subject, array $configuration, PromotionInterface $promotion)
    {
        if (!$subject instanceof OrderInterface) {
            throw new UnexpectedTypeException($subject, OrderInterface::class);
        }

        $items = $subject->getItems();

        $cheapestItem = $items->first();

        $itemsTotals = [];

        foreach ($items as $item) {
            $itemsTotals[] = $item->getTotal();

            $cheapestItem = ($item->getVariant()->getPrice() < $cheapestItem->getVariant()->getPrice()) ? $item : $cheapestItem;
        }

        $splitPromotion = $this->proportionalDistributor->distribute($itemsTotals, -1 * $cheapestItem->getVariant()->getPrice());
        $this->unitsPromotionAdjustmentsApplicator->apply($subject, $promotion, $splitPromotion);
    }

    /**
     * {@inheritdoc}
     */
    public function getConfigurationFormType()
    {
        return CheapestProductDiscountConfigurationType::class;
    }
}

Prepare a configuration form type for the admin panel¶

The new action needs a form type to be available in the admin panel, while creating a new promotion.

<?php

namespace App\Form\Type\Action;

use Symfony\Component\Form\AbstractType;

class CheapestProductDiscountConfigurationType extends AbstractType
{
    /**
     * {@inheritdoc}
     */
    public function getBlockPrefix()
    {
        return 'app_promotion_action_cheapest_product_discount_configuration';
    }
}

Register the action as a service¶

In the config/services.yaml configure:

# config/services.yaml
app.promotion_action.cheapest_product_discount:
    class: App\Promotion\Action\CheapestProductDiscountPromotionActionCommand
    arguments: ['@sylius.proportional_integer_distributor', '@sylius.promotion.units_promotion_adjustments_applicator']
    tags:
        - { name: sylius.promotion_action, type: cheapest_product_discount, form_type: App\Form\Type\Action\CheapestProductDiscountConfigurationType, label: Cheapest product discount }

Register the form type as a service¶

In the config/services.yaml configure:

# config/services.yaml
app.form.type.promotion_action.cheapest_product_discount_configuration:
    class: App\Form\Type\Action\CheapestProductDiscountConfigurationType
    tags:
        - { name: form.type }

Create a new promotion with your action¶

Go to the admin panel of your system. On the /admin/promotions/new url you can create a new promotion.

In its configuration you can choose your new “Cheapest product discount” action.

That’s all. Done!

Learn more¶

Inventory¶

How to create a custom inventory sources filter?¶

In this guide, we will create a new inventory source filter with the lowest priority, that provides inventory source with the lowest stock.

1. Implement LeastItemsInventorySourcesFilter¶

First of all, the inventory sources filter has to implement the Sylius\Plus\Inventory\Application\Filter\InventorySourcesFilterInterface.

Then implement the behaviour inside of the filter method of your service:

<?php

declare(strict_types=1);

namespace App\Inventory\Filter;

use Sylius\Plus\Entity\ProductVariantInterface;
use Sylius\Plus\Inventory\Application\Filter\InventorySourcesFilterInterface;
use Sylius\Plus\Inventory\Domain\Model\InventorySourceInterface;
use Sylius\Plus\Inventory\Domain\Model\VariantsQuantityMapInterface;

final class LeastItemsInventorySourcesFilter implements InventorySourcesFilterInterface
{
    public function filter(array $inventorySources, VariantsQuantityMapInterface $variantsQuantityMap): array
    {
        $inventorySourcesItems = [];

        /** @var InventorySourceInterface $inventorySource */
        foreach ($inventorySources as $inventorySource) {
            $inventorySourcesItems[$inventorySource->getCode()] = 0;

            foreach ($variantsQuantityMap->iterate() as $variantData) {
                /** @var ProductVariantInterface $variant */
                $variant = $variantData['variant'];

                if (!$variant->isTracked()) {
                    continue;
                }

                $stock = $variant->getInventorySourceStockForInventorySource($inventorySource);

                $inventorySourcesItems[$inventorySource->getCode()] += $stock->getAvailable();
            }
        }

        return [$this->getInventorySourceByCode(
            $inventorySources,
            array_search(min($inventorySourcesItems), $inventorySourcesItems)
        )];
    }

    private function getInventorySourceByCode(array $inventorySources, string $code): ?InventorySourceInterface
    {
        /** @var InventorySourceInterface $inventorySource */
        foreach ($inventorySources as $inventorySource) {
            if ($inventorySource->getCode() === $code) {
                return $inventorySource;
            }
        }

        return null;
    }
}

2. Register the custom filter with defined priority¶

Your filtering service has to be registered in the config/services.yaml file with sylius_plus.inventory.inventory_sources_filter tag and priority attribute set, as we can see below:

services:
    App\Inventory\Filter\LeastItemsInventorySourcesFilter:
        tags:
            - { name: 'sylius_plus.inventory.inventory_sources_filter', priority: -10 }

After registering the filter, with such a priority, it will be invoked as the last one, after the default filters provided in Sylius Plus.

That’s all you have to do to customize the inventory sources resolving strategy in your application.

Learn more¶

How to create a custom inventory sources filter?

Shipping methods¶

How to add a custom shipping method rule?¶

Shipping method rules are used to show shipping methods if certain criteria are fulfilled.

Say you have a requirement for one of your shipping methods that the volume of the shipment may not exceed 1 cubic meter (i.e. 1 m x 1 m 1 m). To model this requirement you can use a shipping method rule.

Create a new shipping method rule¶

The new rule needs a RuleChecker class:

<?php

namespace App\Shipping\Checker\Rule;

use Sylius\Component\Shipping\Model\ShippingSubjectInterface;

final class TotalVolumeLessThanOrEqualRuleChecker implements RuleCheckerInterface
{
    public const TYPE = 'total_volume_less_than_or_equal';

    public function isEligible(ShippingSubjectInterface $shippingSubject, array $configuration): bool
    {
        return $shippingSubject->getShippingVolume() <= $configuration['volume'];
    }
}

Prepare a configuration form type for your new rule¶

To be able to configure a shipping method with your new rule you will need a form type for the admin panel.

Create the configuration form type class:

<?php

namespace App\Form\Type\Rule;

use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\Extension\Core\Type\NumberType;
use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\Validator\Constraints\GreaterThan;
use Symfony\Component\Validator\Constraints\NotBlank;
use Symfony\Component\Validator\Constraints\Type;

class TotalVolumeLessThanOrEqualConfigurationType extends AbstractType
{
    public function buildForm(FormBuilderInterface $builder, array $options): void
    {
        $builder->add('volume', NumberType::class, [
            'label' => 'app.form.total_volume_less_than_or_equal_configuration.volume',
            'constraints' => [
                new NotBlank(['groups' => ['sylius']]),
                new Type(['type' => 'numeric', 'groups' => ['sylius']]),
                new GreaterThan(['value' => 0, 'groups' => ['sylius']])
            ],
        ]);
    }

    public function getBlockPrefix()
    {
        return 'app_shipping_method_rule_total_volume_less_than_or_equal_configuration';
    }
}

Register the new rule checker as a service in the config/services.yaml:

# config/services.yml
app.shipping_method_rule_checker.total_volume_less_than_or_equal:
    class: App\Shipping\Checker\Rule\TotalVolumeLessThanOrEqualRuleChecker
    tags:
        - { name: sylius.shipping_method_rule_checker, type: total_volume_less_than_or_equal, form_type: App\Form\Type\Rule\TotalVolumeLessThanOrEqualConfigurationType, label: app.form.shipping_method_rule.total_volume_less_than_or_equal }

That’s all. You will now be able to choose the new rule while creating a new shipping method.

How to add a custom shipping method rule?

Images¶

How to resize images?¶

In Sylius we are using the LiipImagineBundle for handling images.

Tip

You will find a reference to the types of filters in the LiipImagineBundle in their documentation.

There are three places in the Sylius platform where the configuration for images can be found:

These configs provide you with a set of filters for resizing images to thumbnails.

`sylius_admin_product_original`	size: original
`sylius_admin_admin_user_avatar_thumbnail`	size: [50, 50]
`sylius_admin_product_large_thumbnail`	size: [550, 412]
`sylius_admin_product_small_thumbnail`	size: [150, 112]
`sylius_admin_product_tiny_thumbnail`	size: [64, 64]
`sylius_admin_product_thumbnail`	size: [50, 50]
`sylius_shop_product_original`	size: original
`sylius_shop_product_tiny_thumbnail`	size: [64, 64]
`sylius_shop_product_small_thumbnail`	size: [150, 112]
`sylius_shop_product_thumbnail`	size: [260, 260]
`sylius_shop_product_large_thumbnail`	size: [550, 412]
`sylius_small`	size: [120, 90]
`sylius_medium`	size: [240, 180]
`sylius_large`	size: [640, 480]

How to resize images with filters?¶

Knowing that you have filters out of the box you need to also know how to use them with images in Twig templates.

The imagine_filter('name') is a twig filter. This is how you would get an image path for on object item with a thumbnail applied:

<img src="{{ object.path|imagine_filter('sylius_small') }}" />

Note

Sylius stores images on entities by saving a path to the file in the database. The imagine_filter root path is /public/media/image.

How to add custom image resizing filters?¶

If the filters we have in Sylius by default are not suitable for your needs, you can easily add your own.

All you need to do is to configure new filter in the config/packages/liip_imagine.yaml file. For example you can create a filter for advertisement banners:

# config/packages/liip_imagine.yaml
liip_imagine:
    filter_sets:
        advert_banner:
            filters:
                thumbnail: { size: [800, 200], mode: inset }

How to use your new filter in Twig?

<img src="{{ banner.path|imagine_filter('advert_banner') }}" />

Learn more¶

The LiipImagineBundle documentation

How to add images to an entity?¶

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!

Extending entities with an images field is quite a popular use case. In this cookbook we will present how to add image to the Shipping Method entity.

Instructions:¶

1. Extend the ShippingMethod class with the ImagesAwareInterface¶

In order to override the ShippingMethod that lives inside of the SyliusCoreBundle, you have to create your own ShippingMethod class that will extend it:

<?php

declare(strict_types=1);

namespace App\Entity;

use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Collection;
use Sylius\Component\Core\Model\ImagesAwareInterface;
use Sylius\Component\Core\Model\ImageInterface;
use Sylius\Component\Core\Model\ShippingMethod as BaseShippingMethod;

class ShippingMethod extends BaseShippingMethod implements ImagesAwareInterface
{
    /**
     * @var Collection|ImageInterface[]
     */
    protected $images;

    public function __construct()
    {
        parent::__construct();

        $this->images = new ArrayCollection();
    }

    /**
     * {@inheritdoc}
     */
    public function getImages(): Collection
    {
        return $this->images;
    }

    /**
     * {@inheritdoc}
     */
    public function getImagesByType(string $type): Collection
    {
        return $this->images->filter(function (ImageInterface $image) use ($type) {
            return $type === $image->getType();
        });
    }

    /**
     * {@inheritdoc}
     */
    public function hasImages(): bool
    {
        return !$this->images->isEmpty();
    }

    /**
     * {@inheritdoc}
     */
    public function hasImage(ImageInterface $image): bool
    {
        return $this->images->contains($image);
    }

    /**
     * {@inheritdoc}
     */
    public function addImage(ImageInterface $image): void
    {
        $image->setOwner($this);
        $this->images->add($image);
    }

    /**
     * {@inheritdoc}
     */
    public function removeImage(ImageInterface $image): void
    {
        if ($this->hasImage($image)) {
            $image->setOwner(null);
            $this->images->removeElement($image);
        }
    }
}

Tip

Read more about customizing models in the docs here.

2. Register your extended ShippingMethod as a resource’s model class¶

With such a configuration you will register your ShippingMethod class in order to override the default one:

# config/packages/sylius_shipping.yaml
sylius_shipping:
    resources:
        shipping_method:
            classes:
                model: App\Entity\ShippingMethod

3. Create the ShippingMethodImage class¶

In the App\Entity namespace place the ShippingMethodImage class which should look like this:

<?php

declare(strict_types=1);

namespace App\Entity;

use Sylius\Component\Core\Model\Image;

class ShippingMethodImage extends Image
{
}

4. Add the mapping file for the ShippingMethodImage¶

Your new entity will be saved in the database, therefore it needs a mapping file, where you will set the ShippingMethod as the owner of the ShippingMethodImage.

# App/Resources/config/doctrine/ShippingMethodImage.orm.yml
App\Entity\ShippingMethodImage:
    type: entity
    table: app_shipping_method_image
    manyToOne:
        owner:
            targetEntity: App\Entity\ShippingMethod
            inversedBy: images
            joinColumn:
                name: owner_id
                referencedColumnName: id
                nullable: false
                onDelete: CASCADE

5. Modify the ShippingMethod’s mapping file¶

The newly added images field has to be added to the mapping, with a relation to the ShippingMethodImage:

# App/Resources/config/doctrine/ShippingMethod.orm.yml
App\Entity\ShippingMethod:
    type: entity
    table: sylius_shipping_method
    oneToMany:
        images:
            targetEntity: App\Entity\ShippingMethodImage
            mappedBy: owner
            orphanRemoval: true
            cascade:
                - all

6. Register the ShippingMethodImage as a resource¶

The ShippingMethodImage class needs to be registered as a Sylius resource:

# app/config/config.yml
sylius_resource:
    resources:
        app.shipping_method_image:
            classes:
                model: App\Entity\ShippingMethodImage

7. Create the ShippingMethodImageType class¶

This is how the class for ShippingMethodImageType should look like. Place it in the App\Form\Type\ directory.

<?php

declare(strict_types=1);

namespace App\Form\Type;

use Sylius\Bundle\CoreBundle\Form\Type\ImageType;

final class ShippingMethodImageType extends ImageType
{
    /**
     * {@inheritdoc}
     */
    public function getBlockPrefix(): string
    {
        return 'app_shipping_method_image';
    }
}

8. Register the ShippingMethodImageType as a service¶

After creating the form type class, you need to register it as a form.type service like below:

# services.yml
services:
    app.form.type.shipping_method_image:
        class: App\Form\Type\ShippingMethodImageType
        tags:
            - { name: form.type }
        arguments: ['%app.model.shipping_method_image.class%']

9. Add the ShippingMethodImageType to the resource form configuration¶

What is more the new form type needs to be configured as the resource form of the ShippingMethodImage:

# app/config/config.yml
sylius_resource:
    resources:
        app.shipping_method_image:
            classes:
                form: App\Form\Type\ShippingMethodImageType

10. Extend the ShippingMethodType with the images field¶

Tip

Create the form extension class for the Sylius\Bundle\ShippingBundle\Form\Type\ShippingMethodType:

It needs to have the images field as a CollectionType.

<?php

declare(strict_types=1);

namespace App\Form\Extension;

use App\Form\Type\ShippingMethodImageType;
use Sylius\Bundle\ShippingBundle\Form\Type\ShippingMethodType;
use Symfony\Component\Form\AbstractTypeExtension;
use Symfony\Component\Form\Extension\Core\Type\CollectionType;
use Symfony\Component\Form\FormBuilderInterface;

final class ShippingMethodTypeExtension extends AbstractTypeExtension
{
    /**
     * {@inheritdoc}
     */
    public function buildForm(FormBuilderInterface $builder, array $options): void
    {
        $builder->add('images', CollectionType::class, [
            'entry_type' => ShippingMethodImageType::class,
            'allow_add' => true,
            'allow_delete' => true,
            'by_reference' => false,
            'label' => 'sylius.form.shipping_method.images',
        ]);
    }

    /**
     * {@inheritdoc}
     */
    public function getExtendedType(): string
    {
        return ShippingMethodType::class;
    }
}

Tip

In case you need only a single image upload, this can be done in 2 very easy steps.

First, in the code for the form provided above set allow_add and allow_delete to false

Second, in the __construct method of the ShippingMethod entity you defined earlier add the following:

public function __construct()
{
    parent::__construct();
    $this->images = new ArrayCollection();
    $this->addImage(new ShippingMethodImage());
}

Register the form extension as a service:

# services.yml
services:
    app.form.extension.type.shipping_method:
        class: App\Form\Extension\ShippingMethodTypeExtension
        tags:
            - { name: form.type_extension, extended_type: Sylius\Bundle\ShippingBundle\Form\Type\ShippingMethodType }

11. Declare the ImagesUploadListener service¶

In order to handle the image upload you need to attach the ImagesUploadListener to the ShippingMethod entity events:

# services.yml
services:
    app.listener.images_upload:
        class: Sylius\Bundle\CoreBundle\EventListener\ImagesUploadListener
        parent: sylius.listener.images_upload
        autowire: true
        autoconfigure: false
        public: false
        tags:
            - { name: kernel.event_listener, event: sylius.shipping_method.pre_create, method: uploadImages }
            - { name: kernel.event_listener, event: sylius.shipping_method.pre_update, method: uploadImages }

12. Render the images field in the form view¶

In order to achieve that you will need to customize the form view from the SyliusAdminBundle/views/ShippingMethod/_form.html.twig file.

Copy and paste its contents into your own app/Resources/SyliusAdminBundle/views/ShippingMethod/_form.html.twig file, and render the {{ form_row(form.images) }} field.

{# app/Resources/SyliusAdminBundle/views/ShippingMethod/_form.html.twig #}

{% from '@SyliusAdmin/Macro/translationForm.html.twig' import translationForm %}

<div class="ui two column stackable grid">
    <div class="column">
        <div class="ui segment">
            {{ form_errors(form) }}
            <div class="three fields">
                {{ form_row(form.code) }}
                {{ form_row(form.zone) }}
                {{ form_row(form.position) }}
            </div>
            {{ form_row(form.enabled) }}
            <h4 class="ui dividing header">{{ 'sylius.ui.availability'|trans }}</h4>
            {{ form_row(form.channels) }}
            <h4 class="ui dividing header">{{ 'sylius.ui.category_requirements'|trans }}</h4>
            {{ form_row(form.category) }}
            {% for categoryRequirementChoiceForm in form.categoryRequirement %}
                {{ form_row(categoryRequirementChoiceForm) }}
            {% endfor %}
            <h4 class="ui dividing header">{{ 'sylius.ui.taxes'|trans }}</h4>
            {{ form_row(form.taxCategory) }}
            <h4 class="ui dividing header">{{ 'sylius.ui.shipping_charges'|trans }}</h4>
            {{ form_row(form.calculator) }}
            {% for name, calculatorConfigurationPrototype in form.vars.prototypes %}
                <div id="{{ form.calculator.vars.id }}_{{ name }}" data-container=".configuration"
                     data-prototype="{{ form_widget(calculatorConfigurationPrototype)|e }}">
                </div>
            {% endfor %}

            {# Here you go! #}
            {{ form_row(form.images) }}

            <div class="ui segment configuration">
                {% if form.configuration is defined %}
                    {% for field in form.configuration %}
                        {{ form_row(field) }}
                    {% endfor %}
                {% endif %}
            </div>
        </div>
    </div>
    <div class="column">
        {{ translationForm(form.translations) }}
    </div>
</div>

Tip

Learn more about customizing templates here.

13. Validation¶

Your form so far is working fine, but don’t forget about validation. The easiest way is using validation config files under the App/Resources/config/validation folder.

This could look like this e.g.:

# src\Resources\config\validation\ShippingMethodImage.yml
App\Entity\ShippingMethodImage:
  properties:
    file:
      - Image:
          groups: [sylius]
          maxHeight: 1000
          maxSize: 10240000
          maxWidth: 1000
          mimeTypes:
            - "image/png"
            - "image/jpg"
            - "image/jpeg"
            - "image/gif"
          mimeTypesMessage: 'This file format is not allowed. Please use PNG, JPG or GIF files.'
          minHeight: 200
          minWidth: 200

This defines the validation constraints for each image entity. Now connecting the validation of the ShippingMethod to the validation of each single Image Entity is left:

# src\Resources\config\validation\ShippingMethod.yml
App\Entity\ShippingMethod:
  properties:
    ...
    images:
      - Valid: ~

Learn more¶

How to store images on AWS-S3 automatically?¶

Instructions:¶

First you need to ensure that the official AWS-S3 SDK for PHP is installed:

composer require aws/aws-sdk-php

1. Configure Knp-Gaufrette¶

Place this file under config/packages/knp_gaufrette.yaml:

# config/packages/knp_gaufrette.yaml
knp_gaufrette:
    adapters:
        sylius_image:
            aws_s3:
                service_id: Aws\S3\S3Client
                bucket_name: "%aws.s3.bucket%"
                detect_content_type: true
                options:
                    directory: "media/image"
                    acl: "public-read"
    stream_wrapper: ~

2. Configure Liip-Imagine:¶

Add this file under config/packages/liip_imagine.yaml in order to make Liip-Imagine aware of AWS S3 storage:

# config/packages/liip_imagine.yaml
liip_imagine:
    loaders:
        aws_s3:
            stream:
                wrapper: gaufrette://sylius_image/
    resolvers:
        aws_s3:
            aws_s3:
                client_config:
                    credentials:
                        key:    "%aws.s3.key%"
                        secret: "%aws.s3.secret%"
                    region: "%aws.s3.region%"
                    version: "%aws.s3.version%"
                bucket: "%aws.s3.bucket%"
                get_options:
                    Scheme: https
                put_options:
                    CacheControl: "max-age=86400"
                cache_prefix: media/cache
    data_loader: aws_s3
    cache: aws_s3

Deployment¶

How to deploy Sylius to SymfonyCloud?¶

Tip

Start with reading SymfonyCloud documentation.

The process of deploying Sylius to SymfonyCloud is eased by the tools provided by SymfonyCloud for Symfony projects. In this guide you will find sufficient instructions to have your application up and running on SymfonyCloud.

1. Create a new Sylius application¶

This whole section can be skipped if you already have a working project.

To begin creating your new project, run this command:

$ composer create-project sylius/sylius-standard acme

This will create a new Symfony project in the acme directory. Next, move to the project directory, initialize the git repository and create your first commit:

$ cd acme
$ git init
$ git add .
$ git commit -m "Initial commit"

2. Install the SymfonyCloud client¶

Download the CLI tool from symfony.com
Login using symfony login

3. Make the store ready to deploy¶

Initialize a default configuration for SymfonyCloud:

$ symfony project:init

Customize the .symfony/services.yaml file:

db:
    type: mysql:10.2
    disk: 1024

Customize the .symfony.cloud.yaml file:

name: app
type: php:7.3
build:
    flavor: none

runtime:
    extensions: []


relationships:
    database: "db:mysql"

web:
    locations:
        "/":
            root: "public"
            expires: -1
            passthru: "/index.php"
        "/assets/shop":
            expires: 2w
            passthru: false
            allow: false
            rules:
                # Only allow static files from the assets directories.
                '\.(css|js|jpe?g|png|gif|svgz?|ico|bmp|tiff?|wbmp|ico|jng|bmp|html|pdf|otf|woff2|woff|eot|ttf|jar|swf|ogx|avi|wmv|asf|asx|mng|flv|webm|mov|ogv|mpe|mpe?g|mp4|3gpp|weba|ra|m4a|mp3|mp2|mpe?ga|midi?)$':
                    allow: true
        "/media/image":
            expires: 2w
            passthru: false
            allow: false
            rules:
                # Only allow static files from the assets directories.
                '\.(jpe?g|png|gif|svgz?)$':
                    allow: true
        "/media/cache":
            expires: 2w
            passthru: false
            allow: false
            rules:
                # Only allow static files from the assets directories.
                '\.(jpe?g|png|gif|svgz?)$':
                    allow: true
        "/media/cache/resolve":
            passthru: "/index.php"
            scripts: false
            expires: -1
            allow: true

disk: 1024

mounts:
    "/var": { source: local, source_path: var }
    "/public/uploads": { source: local, source_path: uploads }
    "/public/media": { source: local, source_path: media }

hooks:
    build: |
        set -x -e

        curl -s https://get.symfony.com/cloud/configurator | (>&2 bash)
        (>&2 symfony-build)
        (>&2 symfony console sylius:install:check-requirements)
        (>&2
            # Setup everything to use the Node installation
            unset NPM_CONFIG_PREFIX
            export NVM_DIR=${SYMFONY_APP_DIR}/.nvm GULP_ENV=prod
            set +x && . "${NVM_DIR}/nvm.sh" use --lts && set -x
            # Starting from here, everything is setup to use the same Node
            yarn build
        )

    deploy: |
        set -x -e

        mkdir -p public/media/image var/log
        (>&2 symfony-deploy)

4. Commit the configuration¶

$ git add php.ini .symfony .symfony.cloud.yaml && git commit -m "SymfonyCloud configuration"

5. Deploy the store to SymfonyCloud¶

The first deploy will take care of creating a new SymfonyCloud project for you.

$ symfony deploy

The output of this command shows you on which URL your online store can be accessed. Alternatively, you can also use symfony open:remote to open your store in your browser.

Hint

SymfonyCloud offers a 7 days trial, which you can use for testing your store deployment.

6. Finish Sylius installation¶

Finish the Sylius installation by running:

$ symfony ssh bin/console sylius:install

Tip

You can load the predefined set of Sylius fixtures to try your new store:

$ symfony ssh bin/console sylius:fixtures:load

7. Dive deeper¶

Add default Sylius cronjobs:¶

Add the example below to your .symfony.cloud.yaml file. This runs these cronjobs every 6 hours.

crons:
    cleanup_cart:
        spec: '0 */6 * * *'
        cmd: croncape /usr/bin/flock -n /tmp/lock.app.cleanup_cart symfony console sylius:remove-expired-carts --verbose
    cleanup_order:
        spec: '0 */6 * * *'
        cmd: croncape /usr/bin/flock -n /tmp/lock.app.cleanup_order symfony console sylius:cancel-unpaid-orders --verbose

Additional tips:¶

SymfonyCloud can serve gzipped versions of your static assets. Make sure to save your assets in the same folder, but with a .gz suffix. The gulp-gzip node package comes very helpful integrating saving of .gz versions of your assets.

Learn more¶

SymfonyCloud documentation: Getting started
SymfonyCloud documentation: Moving to production
Installation Guide

How to deploy Sylius to Platform.sh?¶

Tip

Start with reading Platform.sh documentation. Also Symfony provides a guide on deploying projects to Platform.sh.

The process of deploying Sylius to Platform.sh is based on the guidelines prepared for Symfony projects in general. In this guide you will find sufficient instructions to have your application up and running on Platform.sh.

1. Prepare a Platform.sh project¶

Create an account on Platform.sh.
Create a new project, name it (MyFirstShop for example) and select the Blank project template.

Hint

Platform.sh offers a trial month, which you can use for testing your store deployment. If you would be asked to provide your credit card data nevertheless, use this link to create your new project.

Install the Symfony-Platform.sh bridge in your application with composer require platformsh/symfonyflex-bridge.

2. Make the application ready to deploy¶

Create the .platform/routes.yaml file, which describes how an incoming URL is going to be processed by the server.

"https://{default}/":
    type: upstream
    upstream: "app:http"

"https://www.{default}/":
    type: redirect
    to: "https://{default}/"

Create the .platform/services.yaml file.

db:
    type: mysql:10.2
    disk: 2048

Create the .platform.app.yaml file, which is the main server application configuration file (and the longest one 😉).

name: app
type: php:7.3
build:
    flavor: composer

variables:
    env:
        # Tell Symfony to always install in production-mode.
        APP_ENV: 'prod'
        APP_DEBUG: 0

# The hooks that will be performed when the package is deployed.
hooks:
    build: |
        set -e
        yarn install
        GULP_ENV=prod yarn build
    deploy: |
        set -e
        rm -rf var/cache/*
        mkdir -p public/media/image
        bin/console sylius:install -n
        bin/console sylius:fixtures:load -n
        bin/console assets:install --symlink --relative public
        bin/console cache:clear

# The relationships of the application with services or other applications.
# The left-hand side is the name of the relationship as it will be exposed
# to the application in the PLATFORM_RELATIONSHIPS variable. The right-hand
# side is in the form `<service name>:<endpoint name>`.
relationships:
    # NOTE: this will install mariadb because platform.sh uses it instead of mysql.
    database: "db:mysql"

dependencies:
    nodejs:
        yarn: "*"
        gulp-cli: "*"

# The size of the persistent disk of the application (in MB).
disk: 2048

# The mounts that will be performed when the package is deployed.
mounts:
    "/var/cache": "shared:files/cache"
    "/var/log": "shared:files/log"
    "/var/sessions": "shared:files/sessions"
    "/public/uploads": "shared:files/uploads"
    "/public/media": "shared:files/media"

# The configuration of app when it is exposed to the web.
web:
    locations:
        "/":
            # The public directory of the app, relative to its root.
            root: "public"
            # The front-controller script to send non-static requests to.
            passthru: "/index.php"
            allow: true
            expires: -1
            scripts: true
        '/assets/shop':
            expires: 2w
            passthru: true
            allow: false
            rules:
                # Only allow static files from the assets directories.
                '\.(css|js|jpe?g|png|gif|svgz?|ico|bmp|tiff?|wbmp|ico|jng|bmp|html|pdf|otf|woff2|woff|eot|ttf|jar|swf|ogx|avi|wmv|asf|asx|mng|flv|webm|mov|ogv|mpe|mpe?g|mp4|3gpp|weba|ra|m4a|mp3|mp2|mpe?ga|midi?)$':
                    allow: true
        '/media/image':
            expires: 2w
            passthru: true
            allow: false
            rules:
                # Only allow static files from the assets directories.
                '\.(jpe?g|png|gif|svgz?)$':
                    allow: true
        '/media/cache/resolve':
            passthru: "/index.php"
            expires: -1
            allow: true
            scripts: true
        '/media/cache':
            expires: 2w
            passthru: true
            allow: false
            rules:
                # Only allow static files from the assets directories.
                '\.(jpe?g|png|gif|svgz?)$':
                    allow: true

Warning

It is important to place the newly created file after importing regular parameters.yml file. Otherwise your database connection will not work. Also this will be the file where you should set your required parameters. Its value will be fetched from environmental variables.

The application secret is used in several places in Sylius and Symfony. Platform.sh allows you to deploy an environment for each branch you have, and therefore it makes sense to have a secret automatically generated by the Platform.sh system. The last 3 lines in the sample above will use the Platform.sh-provided random value as the application secret.

3. Add Platform.sh as a remote to your repository¶

Use the below command to add your Platform.sh project as the platform remote:

git remote add platform [PROJECT-ID]@git.[CLUSTER].platform.sh:[PROJECT-ID].git

The PROJECT-ID is the unique identifier of your project, and CLUSTER can be eu or us - depending on where are you deploying your project.

4. Commit the configuration¶

git add . && git commit -m "Platform.sh configuration"

5. Push your project to the Platform.sh remote repository¶

git push platform master

The output of this command shows you on which URL your online store can be accessed.

6. Connect to the project via SSH and install Sylius¶

The SSH command can be found in your project data on Platform.sh. Alternatively use the Platform CLI tool.

When you get connected please run:

php bin/console sylius:install --env prod

Warning

By default platform.sh creates only one instance of the database with the main name. Platform.sh works with the concept of an environment per branch if activated. The idea is to mimic production settings per each branch.

How to deploy Sylius Plus to Platform.sh?¶

Sylius Plus is installed to Sylius like a plugin, but it needs some changes to the Platform.sh configuration presented above to deploy it properly. First of all, make sure you have your project configured following the Sylius Plus installation guide. After that, you should modify your .platform.app.yaml. Configuration from step 2 should be extended by the following lines.

# ...

hooks:
    build: |
        set -e
        yarn install --ignore-engines # without this flag you will get error related with node version conflict
        GULP_ENV=prod yarn build
        wkhtmltopdf -V # Sylius Plus is installed with InvoicingPlugin, so we need wkhtmltopdf to generate PDF

    deploy: |
        set -e
        rm -rf var/cache/*
        mkdir -p public/media/image
        bin/console sylius:install -n
        bin/console sylius:fixtures:load plus -n # Updating fixtures with new Sylius Plus features
        bin/console assets:install --symlink --relative public
        bin/console cache:clear

dependencies:
    nodejs:
        yarn: "*"
        gulp-cli: "*"
    ruby:
        "wkhtmltopdf-binary": "0.12.5.1" # adding wkhtmltopdf as a one of dependencies

# ...

In order to use the wkhtmltopdf (needed for Invoicing and Refunds) on server properly, you also need to add it to the config\packages'knp_snappy.yaml:

knp_snappy:
pdf:
    enabled:    true
    binary:     wkhtmltopdf # for local purpose was '%env(WKHTMLTOPDF_PATH)%'
    options:    []
image:
    enabled:    true
    binary:     wkhtmltoimage # for local purpose was '%env(WKHTMLTOIMAGE_PATH)%'
    options:    []

Sylius Plus is on Private Packagist, so when you want to download it on server, you need add authentication token before deployment. You can do it by UI on your project page on platform.sh or if you have platform.sh CLI you can add authentication_token:

platform variable:create --level project --name env:COMPOSER_AUTH \
--json true --visible-runtime false --sensitive true --visible-build true
--value '{"http-basic": {"sylius.repo.packagist.com": {"username": "token", "password": "YOUR_AUTHENTICATION_TOKEN"}}}'

All the other steps from the Sylius deployment on Platform.sh remain unchanged.

7. Dive deeper¶

Add default Sylius cronjobs:¶

Add the example below to your .platform.app.yaml file. This runs these cronjobs every 6 hours.

crons:
    cleanup_cart:
        spec: '0 */6 * * *'
        cmd: '/usr/bin/flock -n /tmp/lock.app.cleanup_cart bin/console sylius:remove-expired-carts --env=prod --verbose'
    cleanup_order:
        spec: '0 */6 * * *'
        cmd: '/usr/bin/flock -n /tmp/lock.app.cleanup_order bin/console sylius:cancel-unpaid-orders --env=prod --verbose'

Additional tips:¶

Platform.sh can serve gzipped versions of your static assets. Make sure to save your assets in the same folder, but with a .gz suffix. The gulp-gzip node package comes very helpful integrating saving of .gz versions of your assets.
Platform.sh comes with a New Relic integration.
Platform.sh comes with a Blackfire.io integration

Learn more¶

Platform.sh documentation: Configuring Symfony projects for Platform.sh
Symfony documentation: Deploying Symfony to Platform.sh
Installation Guide

How to deploy Sylius to Cloudways PHP Hosting?¶

Cloudways is a managed hosting platform for custom PHP apps and PHP frameworks such as Symfony, Laravel, Codeigniter, Yii, CakePHP and many more. You can launch the servers on any of the five providers including DigitalOcean, Vultr, AWS, GCE and KYUP containers.

The deployment process of Sylius on Cloudways is pretty much straightforward and easy.

Now to install Sylius you need to go through series of few steps:

1. Launch Server with Custom PHP App¶

You should signup at Cloudways to buy the PHP servers from the above mentioned providers. Simply go to the pricing page and choose your required plan. You then need to go through the verification process. Once it done login to platform and launch your first Custom PHP application. You can follow the Gif too.

Now let’s start the process of installing Sylius on Cloudways.

2. Install the latest version of Sylius via SSH¶

Open the SSH terminal from the Server Management tab. You can also use PuTTY for this purpose. Find the SSH credentials under the Master Credentials heading and login to the SSH terminal:

After the login, move to the application folder using the cd command and run the following command to start installing Sylius:

composer create-project sylius/sylius-standard myshop

The command will start installing the long list of dependencies for Sylius. Once the installation finishes, Sylius will ask for the database credentials. You can find the database username and password in the Application Access Details.

Enter the database details in the SSH terminal:

Keep the rest of the values to default so that the config file will have the defaults Sylius settings. If the need arises, you can obviously change these settings later.

3. Install Node Dependencies¶

Sylius requires several Node packages, which also needs to be installed and updated before setting up the shop. In addition, I also need to start and setup Gulp.

Now move to the myshop folder by using cd myshop and run the following command yarn install. Once the command finishes, run the next command, yarn build.

4. Install Sylius for the production environment¶

Now run the following command:

bin/console sylius:install -e prod

5. Update The Webroot of the Application¶

Finally, the last step is to update the webroot of the application in the Platform. Move to the Application Settings tab and update it.

Now open the application URL as shown in the Access Details tab.

Learn more¶

Cloudways PHP Hosting documentation: How to host PHP applications on DigitalOcean via Cloudways
PHP FAQs And Features: Know more about PHP Hosting
What You As A User Can Do With Cloudways PHP Stack

How to prepare simple CRON jobs?¶

What are CRON jobs?¶

This is what we call scheduling repetitive task on the server. In web applications this will be mainly repetitively running specific commands.

CRON jobs in Sylius¶

Sylius has two vital, predefined commands designed to be run as cron jobs on your server.

sylius:remove-expired-carts - to remove carts that have expired after desired time
sylius:cancel-unpaid-orders - to cancel orders that are still unpaid after desired time

How to configure a CRON job ?¶

Tip

Learn more here: Cron and Crontab usage and examples.

How to deploy Sylius to Artifakt.com¶

1. What is Artifakt?¶

Artifakt is an all-in-one platform helping enterprises and developers fast-track deployments, manage and run complex web applications on enterprise-grade cloud infrastructures on a global scale.

2. How does Artifakt work?¶

Artifakt provides a service based on Cloud technologies to help build, deploy, monitor, secure, and manage the scalability of your applications.

3. Create an Artifakt project¶

To get off to a good start with Artifakt, you first need to create a project.

Click Create Project in the left menu and follow the steps to create your first project. The project code must be unique within the workspace, you can refer to projects for more information.

In the second step, select the Sylius runtime and version that corresponds to the application you want to deploy. Also, choose the region where your application and data will be deployed. When you create a project, you can use the default Artifakt code base for the chosen Sylius runtime, or you can link your own Git repository. If you wish to use the Artifakt default code base, simply click “Skip, and Create Project”. Otherwise, you can choose the location of your repository and choose your preferred repository and default branch. If you did not link your Git repository during the project creation, you can do so afterwards by going to Project → Settings → Environments and clicking Link to a different repository so that you can then create environments using your application’s source code.

Hint

If you don’t have an account on Artifakt.com, you should request a demo or contact support first.

4. Create an environment¶

Once the project is created, you can create your first environment. To do so, go to your project and click on New Environment. When creating an environment, you must define a name, the Git branch to deploy, the type of platform to use, and the criticality (environments can be either critical or noncritical).

If you set up your Git repository at the project level, the branches associated with your repository are automatically retrieved and available in the drop-down list.

5. Building the environment¶

Once your environment has been created, you can now launch its construction by clicking on Build in the drop-down menu. You will then be redirected to the Overview page of the environment, from where you can follow the creation and start up of each service of the platform, in real time.

Once the environment is deployed and available online, a domain name generated by Artifakt will be displayed in the list of project environments and on the environment home page.

An Artifakt page will indicate that your environment’s infrastructure has been created. You will then have to deploy your application source code when you are ready.

Bravo! 🥳 💯 Your application is online thanks to Artifakt!

Configuration¶

How to disable default shop, admin or API of Sylius?¶

When you are using Sylius as a whole you may be needing to remove some of its parts. It is possible to remove for example Sylius shop to have only administration panel and API. Or the other way, remove API if you do not need it.

Therefore you have this guide that will help you when wanting to disable shop, admin or API of Sylius.

How to disable Sylius shop?¶

1. Remove SyliusShopBundle from config/bundles.php.

// # config/bundles.php

return [
    //...

    // Sylius\Bundle\ShopBundle\SyliusShopBundle::class => ['all' => true], // - remove or leave this line commented

    //...
];

2. Remove SyliusShopBundle’s configs from config/packages/_sylius.yaml.

Here you’ve got the lines that should disappear from this file:

imports:
#    - { resource: "@SyliusShopBundle/Resources/config/app/config.yml" } # remove or leave this line commented

#...

#sylius_shop:
#    product_grid:
#        include_all_descendants: true

3. Remove SyliusShopBundle routing configuration file config/routes/sylius_shop.yaml.

4. Remove security configuration from config/packages/security.yaml.

The part that has to be removed from this file is shown below:

parameters:
    # sylius.security.shop_regex: "^/(?!admin|api/.*|api$)[^/]++"

security:
    firewalls:
# Delete or leave this part commented
#        shop:
#            switch_user: { role: ROLE_ALLOWED_TO_SWITCH }
#            context: shop
#            pattern: "%sylius.security.shop_regex%"
#            form_login:
#                success_handler: sylius.authentication.success_handler
#                failure_handler: sylius.authentication.failure_handler
#                provider: sylius_shop_user_provider
#                login_path: sylius_shop_login
#                check_path: sylius_shop_login_check
#                failure_path: sylius_shop_login
#                default_target_path: sylius_shop_homepage
#                use_forward: false
#                use_referer: true
#                csrf_token_generator: security.csrf.token_manager
#                csrf_parameter: _csrf_shop_security_token
#                csrf_token_id: shop_authenticate
#            remember_me:
#                secret: "%secret%"
#                name: APP_SHOP_REMEMBER_ME
#                lifetime: 31536000
#                remember_me_parameter: _remember_me
#            logout:
#                path: sylius_shop_logout
#                target: sylius_shop_login
#                invalidate_session: false
#                success_handler: sylius.handler.shop_user_logout
#            anonymous: true

access_control:
#    - { path: "%sylius.security.shop_regex%/_partial", role: IS_AUTHENTICATED_ANONYMOUSLY, ips: [127.0.0.1, ::1] }
#    - { path: "%sylius.security.shop_regex%/_partial", role: ROLE_NO_ACCESS }

#    - { path: "%sylius.security.shop_regex%/login", role: IS_AUTHENTICATED_ANONYMOUSLY }

#    - { path: "%sylius.security.shop_regex%/register", role: IS_AUTHENTICATED_ANONYMOUSLY }
#    - { path: "%sylius.security.shop_regex%/verify", role: IS_AUTHENTICATED_ANONYMOUSLY }

#    - { path: "%sylius.security.shop_regex%/account", role: ROLE_USER }
#    - { path: "%sylius.security.shop_regex%/seller/register", role: ROLE_USER }

Done! There is no shop in Sylius now, just admin and API.

How to disable Sylius Admin?¶

1. Remove SyliusAdminBundle from config/bundles.php.

// # config/bundles.php

return [
    //...

    // Sylius\Bundle\AdminBundle\SyliusAdminBundle::class => ['all' => true], // - remove or leave this line commented

    //...
];

2. Remove SyliusAdminBundle’s config import from config/packages/_sylius.yaml.

Here you’ve got the line that should disappear from imports:

imports:
#    - { resource: "@SyliusAdminBundle/Resources/config/app/config.yml" } # remove or leave this line commented

3. Remove SyliusAdminBundle routing configuration from config/routes/sylius_admin.yaml.

4. Remove security configuration from config/packages/security.yaml.

The part that has to be removed from this file is shown below:

parameters:
# Delete or leave this part commented
#    sylius.security.admin_regex: "^/admin"
    sylius.security.shop_regex: "^/(?!api/.*|api$)[^/]++" # Remove `admin|` from the pattern

security:
    firewalls:
# Delete or leave this part commented
#        admin:
#            switch_user: true
#            context: admin
#            pattern: "%sylius.security.admin_regex%"
#            form_login:
#                provider: sylius_admin_user_provider
#                login_path: sylius_admin_login
#                check_path: sylius_admin_login_check
#                failure_path: sylius_admin_login
#                default_target_path: sylius_admin_dashboard
#                use_forward: false
#                use_referer: true
#                csrf_token_generator: security.csrf.token_manager
#                csrf_parameter: _csrf_admin_security_token
#                csrf_token_id: admin_authenticate
#            remember_me:
#                secret: "%secret%"
#                path: /admin
#                name: APP_ADMIN_REMEMBER_ME
#                lifetime: 31536000
#                remember_me_parameter: _remember_me
#            logout:
#                path: sylius_admin_logout
#                target: sylius_admin_login
#            anonymous: true

access_control:
# Delete or leave this part commented
#    - { path: "%sylius.security.admin_regex%/_partial", role: IS_AUTHENTICATED_ANONYMOUSLY, ips: [127.0.0.1, ::1] }
#    - { path: "%sylius.security.admin_regex%/_partial", role: ROLE_NO_ACCESS }

#    - { path: "%sylius.security.admin_regex%/login", role: IS_AUTHENTICATED_ANONYMOUSLY }

#    - { path: "%sylius.security.admin_regex%", role: ROLE_ADMINISTRATION_ACCESS }

Done! There is no admin in Sylius now, just api and shop.

How to disable Sylius API?¶

1. Remove SyliusAdminApiBundle & FOSOAuthServerBundle from config/bundles.php.

// # config/bundles.php

return [
    //...

    // FOS\OAuthServerBundle\FOSOAuthServerBundle::class => ['all' => true],
    // Sylius\Bundle\AdminApiBundle\SyliusAdminApiBundle::class => ['all' => true], // - remove or leave this line commented

    //...
];

2. Remove SyliusAdminApiBundle’s config import from config/packages/_sylius.yaml.

Here you’ve got the line that should disappear from imports:

imports:
#    - { resource: "@SyliusAdminApiBundle/Resources/config/app/config.yml" } # remove or leave this line commented

3. Remove SyliusAdminApiBundle routing configuration from config/routes/sylius_admin_api.yaml.

4. Remove security configuration from config/packages/security.yaml.

The part that has to be removed from this file is shown below:

parameters:
# Delete or leave this part commented
#   sylius.security.api_regex: "^/api"
    sylius.security.shop_regex: "^/(?!admin$)[^/]++" # Remove `|api/.*|api` from the pattern

security:
    firewalls:
# Delete or leave this part commented
#        oauth_token:
#            pattern: "%sylius.security.api_regex%/oauth/v2/token"
#            security: false
#        api:
#           pattern:    "%sylius.security.api_regex%/.*"
#           fos_oauth:  true
#           stateless:  true
#           anonymous:  true

access_control:
# Delete or leave this part commented
#    - { path: "%sylius.security.api_regex%/login", role: IS_AUTHENTICATED_ANONYMOUSLY }

#    - { path: "%sylius.security.api_regex%/.*", role: ROLE_API_ACCESS }

5. Remove fos_rest config from config/packages/fos_rest.yaml.

fos_rest:
    format_listener:
        rules:
        #    - { path: '^/api', priorities: ['json', 'xml'], fallback_format: json, prefer_extension: true } # remove or leave this line commented

Done! There is no API in Sylius now, just admin and shop.

Learn more¶

Architecture: Division into Core, Shop, Admin and API

How to use installer commands?¶

Sylius platform ships with the sylius:install command, which takes care of creating the database, schema, dumping the assets and basic store configuration.

This command actually uses several other commands behind the scenes and each of those is available for you:

Checking system requirements¶

You can quickly check all your system requirements and possible recommendations by calling the following command:

php bin/console sylius:install:check-requirements

Database configuration¶

Sylius can create or even reset the database/schema for you, simply call:

php bin/console sylius:install:database

The command will check if your database schema exists. If yes, you may decide to recreate it from scratch, otherwise Sylius will take care of this automatically. It also allows you to load sample data.

Loading sample data¶

You can load sample data by calling the following command:

php bin/console sylius:install:sample-data

Basic store configuration¶

To configure your store, use this command and answer all questions:

php bin/console sylius:install:setup

Installing assets¶

You can reinstall all web assets by simply calling:

php bin/console sylius:install:assets

How to load custom fixtures suite?¶

If you have your custom fixtures suite, you can load it during install by providing at fixture-suite parameter:

php bin/console sylius:install --fixture-suite=your_custom_fixtures_suite

Same option also available at sylius:install:database, sylius:install:sample-data commands.

How to disable admin version notifications?¶

By default Sylius sends checks from the admin whether you are running the latest version. In case you are not running the latest version, a notification will be shown in the admin panel (top right).

This guide will instruct you how to disable this check & notification.

How to disable notifications?¶

Add the following configuration to config/packages/sylius_admin.yaml.

sylius_admin:
    notifications:
        enabled: false

How to customize Admin routes prefix?¶

By default, Sylius administration routes are prefixed with /admin.

You can use the parameter sylius_admin.path_name to retrieve the admin routes prefix.

In order to change to administration panel route prefix you need to modify the SYLIUS_ADMIN_ROUTING_PATH_NAME environment variable.

Warning

If you used the /admin prefix in some admin URLs in your custom code you need to replace the /admin by /%sylius_admin.path_prefix%.

Frontend¶

How to customize Admin JS & CSS?¶

It is sometimes required to add your own JSS and CSS files for Sylius Admin. Achieving that is really straightforward.

We will now teach you how to do it!

How to add custom JS to Admin?¶

1. Prepare your own JS file:

As an example we will use a popup window script, it is easy for manual testing.

// public/assets/admin/js/custom.js
window.confirm("Your custom JS was loaded correctly!");

2. Prepare a file with your JS include, you can use the include template from SyliusUiBundle:

{# src/Resources/views/Admin/_javascripts.html.twig #}
{% include 'SyliusUiBundle::_javascripts.html.twig' with {'path': 'assets/admin/js/custom.js'} %}

3. Use the Sonata block event to insert your javascripts:

Tip

Learn more about customizing templates via events in the customization guide here.

# config/services.yaml
services:
    app.block_event_listener.admin.layout.javascripts:
        class: Sylius\Bundle\UiBundle\Block\BlockEventListener
        arguments:
            - '@@App/Admin/_javascripts.html.twig'
        tags:
            - { name: kernel.event_listener, event: sonata.block.event.sylius.admin.layout.javascripts, method: onBlockEvent }

4. Additionally, to make sure everything is loaded run gulp:

yarn build

5. Go to Sylius Admin and check the results!

How to add custom CSS to Admin?¶

1. Prepare your own CSS file:

As an example we will change the sidebar menu background color, what is clearly visible at first sight.

// public/assets/admin/css/custom.css
#sidebar {
    background-color: #1abb9c;
}

2. Prepare a file with your CSS include, you can use the include template from SyliusUiBundle:

{# src/Resources/views/Admin/_stylesheets.html.twig #}
{% include 'SyliusUiBundle::_stylesheets.html.twig' with {'path': 'assets/admin/css/custom.css'} %}

3. Use the Sonata block event to insert your stylesheets:

Tip

Learn more about customizing templates via events in the customization guide here.

# config/services.yaml
services:
    app.block_event_listener.admin.layout.stylesheets:
        class: Sylius\Bundle\UiBundle\Block\BlockEventListener
        arguments:
            - '@@App/Admin/_stylesheets.html.twig'
        tags:
            - { name: kernel.event_listener, event: sonata.block.event.sylius.admin.layout.stylesheets, method: onBlockEvent }

4. Additionally, to make sure everything is loaded run gulp:

yarn build

5. Go to Sylius Admin and check the results!

Learn more¶

Templates customizing

How to add Google Analytics script to shop?¶

All shops tend to observe traffic on their websites, the most popular tool for that is Google Analytics. In Sylius we have two ways to enable it:

If you have the Sylius layout overridden completely then:

paste the script directly into head section of the layout

or if you are just customizing the Sylius layout, and you will be updating to future versions then:

add the script via Sonata events

Adding Google Analytics by pasting the script directly into the layout template.¶

If you want to add Google Analytics by this way, you need to override the layout.html.twig in templates/bundles/SyliusShopBundle/layout.html.twig.

{# templates/bundles/SyliusShopBundle/layout.html.twig #}

{# rest of layout.html.twig code #}

{% block metatags %}
{% endblock %}

{% block google_script %}
    <!-- Google Analytics -->
    <script>
        (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
        (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
        m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
        })(window,document,'script','https://www.google-analytics.com/analytics.js','ga');

        ga('create', 'UA-XXXXX-Y', 'auto');
        ga('send', 'pageview');
    </script>
    <!-- End Google Analytics -->
{% endblock %}

{% block stylesheets %}
{% endblock %}

{# rest of layout.html.twig code #}

Adding Google Analytics script with Sonata events.¶

If you want to add Google Analytics by sonata event you need to add a new file, create the file googleScript.html.twig in /templates/layout.html.twig.

{# templates/googleScript.html.twig#}

<!-- Google Analytics -->
<script>
    (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
    (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
    m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
    })(window,document,'script','https://www.google-analytics.com/analytics.js','ga');

    ga('create', 'UA-XXXXX-Y', 'auto');
    ga('send', 'pageview');
</script>
<!-- End Google Analytics -->

Now, we need to configure a new service.

# config/packages/_sylius.yaml
app.block_event_listener.layout.after_stylesheets:
    class: Sylius\Bundle\UiBundle\Block\BlockEventListener
    arguments:
        - 'googleScript.html.twig'
    tags:
        - { name: kernel.event_listener, event: sonata.block.event.sylius.shop.layout.stylesheets, method: onBlockEvent }

Learn more¶

Google Analytics Documentation

Using Webpack Encore in Sylius¶

This is a simple guide on how to start using webpack in Sylius apps. Webpack finally lets us easily customize Sylius assets.

1. Install webpack-encore-bundle:

composer require symfony/webpack-encore-bundle

2. Edit the config/packages/assets.yaml file:

framework:
    assets:
        packages:
            shop:
                json_manifest_path: '%kernel.project_dir%/public/build/shop/manifest.json'
            admin:
                json_manifest_path: '%kernel.project_dir%/public/build/admin/manifest.json'

3. Edit the config/packages/webpack_encore.yaml file:

webpack_encore:
    output_path: '%kernel.project_dir%/public/build/default'
    builds:
        shop: '%kernel.project_dir%/public/build/shop'
        admin: '%kernel.project_dir%/public/build/admin'

4. Overwrite template files and add new assets paths for admin and shop:

// templates/bundles/SyliusAdminBundle/_scripts.html.twig
{{ encore_entry_script_tags('admin-entry', null, 'admin') }}

// templates/bundles/SyliusAdminBundle/_styles.html.twig
{{ encore_entry_link_tags('admin-entry', null, 'admin') }}

// templates/bundles/SyliusAdminBundle/Layout/_logo.html.twig
<a class="item" href="{{ path('sylius_admin_dashboard') }}" style="padding: 13px 0;">
    <div style="max-width: 90px; margin: 0 auto;">
        <img src="{{ asset('build/admin/images/admin-logo.svg', 'admin') }}" class="ui fluid image">
    </div>
</a>
// templates/bundles/SyliusAdminBundle/Security/_content.html.twig
{% include '@SyliusUi/Security/_login.html.twig'
    with {
        'action': path('sylius_admin_login_check'),
        'paths': {'logo': asset('build/admin/images/logo.png', 'admin')}
    }
%}

// templates/bundles/SyliusShopBundle/_scripts.html.twig
{{ encore_entry_script_tags('shop-entry', null, 'shop') }}

// templates/bundles/SyliusShopBundle/_styles.html.twig
{{ encore_entry_link_tags('shop-entry', null, 'shop') }}

// templates/bundles/SyliusShopBundle/Layout/Header/_logo.html.twig
<div class="column">
    <a href="{{ path('sylius_shop_homepage') }}">
        <img src="{{ asset('build/shop/images/logo.png', 'shop') }}" alt="Sylius logo" class="ui small image" />
    </a>
</div>

Warning

The paths should be changed for each asset you use.

5. To build the assets, run:

yarn encore dev
# or
yarn encore production
# or
yarn encore dev-server

Tip

When compiling assets, errors may appear (they don’t break the build), due to different babel configuration for gulp and webpack. Once you decide to use the webpack you can delete the gulpfile.babel.js and .babelrc from the root directory - then the errors will stop appearing.

Learn more¶

Webpack Encore Documentation

Taxation¶

How to configure tax rates to be based on shipping address?¶

The default configuration of Sylius tax calculation is based on billing address but there are situations where we would like to use a shipping address to be used in this process. This may be useful to anyone who uses Sylius in European Union as from 1st July 2021 the new taxation rules will be applied.

Note

You can learn more about new EU taxation rules here.

To change the way how the taxes are calculated; by billing or by shipping address, you need to override the service called OrderTaxesProcessor.php from Sylius/Component/Core/OrderProcessing.

First let’s copy code from original Processor to our service from %kernel.project_dir%/vendor/sylius/sylius/src/Sylius/Component/Core/OrderProcessing/OrderTaxesProcessor.php to src/OrderProcessing/OrderTaxesProcessor.php

Then register our new service:

# app/config/services.yaml
App\OrderProcessing\OrderTaxesProcessor:
    arguments:
        - '@sylius.provider.channel_based_default_zone_provider'
        - '@sylius.zone_matcher'
        - '@sylius.registry.tax_calculation_strategy'
    tags:
        - { name: sylius.order_processor, priority: 10 }

Now we need to change the method getTaxZone to be using the shipping address:

//...
private function getTaxZone(OrderInterface $order): ?ZoneInterface
{
    $shippingAddress = $order->getShippingAddress();
    $zone = null;

    if (null !== $shippingAddress) {
        $zone = $this->zoneMatcher->match($shippingAddress, Scope::TAX);
    }

    return $zone ?: $this->defaultTaxZoneProvider->getZone($order);
}
//...

And with this change, the way how taxes are calculated will be based on shipping address.

How to configure tax rates to be based on shipping address?

API¶

How to add product variants by options to the cart in Sylius API?¶

In order to add a product variant to the cart in the Sylius API, you need to fill the “add to cart” request’s body with productCode and productVariantCode You can find this data in the body of the response which is received after the request below is sent.

curl -X GET "https://master.demo.sylius.com/api/v2/shop/products?page=1&itemsPerPage=30" -H  "accept: application/ld+json"

But the most common case is choosing a product variant by its product options. So below you can find all requests needed to get the product variant of a product with chosen product options values. In this example, we will be adding an “S” (in size) and “petite” (in height) “Beige strappy summer dress” to the cart.

Firstly you need to get details of the “Beige strappy summer dress” product by its code:

curl -X GET "https://master.demo.sylius.com/api/v2/shop/products/Beige_strappy_summer_dress" -H  "accept: application/ld+json"

In the response you will see that this product has 2 product options:

{
    "options": [
        "/api/v2/shop/product-options/dress_size",
        "/api/v2/shop/product-options/dress_height"
    ]
}

With this data you can check all the available product option values for each product option:

curl -X GET "https://master.demo.sylius.com/api/v2/shop/product-options/dress_size" -H  "accept: application/ld+json"

The response with all the available option values would contain:

{
    "values": [
        "/api/v2/shop/product-option-values/dress_s",
        "/api/v2/shop/product-option-values/dress_m",
        "/api/v2/shop/product-option-values/dress_l",
        "/api/v2/shop/product-option-values/dress_xl",
        "/api/v2/shop/product-option-values/dress_xxl"
    ]
}

In the same way, you can check values for the other option - dress_height.

Now, with all necessary data, you can find the “Beige strappy summer dress” product’s “small” and “petite” variant You need to call a GET on the product variants collection with parameters: productName and with the chosen option values:

curl -X GET "https://master.demo.sylius.com/api/v2/shop/product-variants?product=/api/v2/shop/products/Beige_strappy_summer_dress&optionValues[]=/api/v2/shop/product-option-values/dress_height_petite&optionValues[]=/api/v2/shop/product-option-values/dress_s" -H "accept: application/ld+json"

In the response you should get a collection with only one item:

{
    "hydra:member": [
        {
          "id": 579960,
          "code": "Beige_strappy_summer_dress-variant-0",
          "product": "/api/v2/shop/products/Beige_strappy_summer_dress",
          "optionValues": [
            "/api/v2/shop/product-option-values/dress_s",
            "/api/v2/shop/product-option-values/dress_height_petite"
          ],
          "translations": {
            "en_US": {
              "@id": "/api/v2/shop/product-variant-translation/579960",
              "@type": "ProductVariantTranslation",
              "id": 579960,
              "name": "S Petite",
              "locale": "en_US"
            }
          },
          "price": 7693
        }
    ]
}

Warning

When you search by only some of the product’s option values in the response you may get a collection with more than one object.

And with this information, you can add the chosen product variant to the cart:

curl -X PATCH "https://master.demo.sylius.com/api/v2/shop/orders/ORDER_TOKEN/items" -H  "accept: application/ld+json" -H  "Content-Type: application/merge-patch+json"

with body:

{
    "productCode": "Beige_strappy_summer_dress",
    "productVariantCode": "Beige_strappy_summer_dress-variant-0",
    "quantity": 1
}

How to add product variants by options to the cart in Sylius API?

The BDD Guide¶

In the BDD Guide you will learn how to write clean and reusable features, contexts and pages using Behat.

The BDD Guide¶

Behaviour driven development is an approach to software development process that provides software development and management teams with shared tools and a shared process to collaborate on software development. The awesome part of BDD is its ubiquitous language, which is used to describe the software in English-like sentences of domain specific language.

The application’s behaviour is described by scenarios, and those scenarios are turned into automated test suites with tools such as Behat.

Sylius behaviours are fully covered with Behat scenarios. There are more than 1200 scenarios in the Sylius suite, and if you want to understand some aspects of Sylius better, or are wondering how to configure something, we strongly recommend reading them. They can be found in the features/ directory of the Sylius/Sylius repository.

We use FriendsOfBehat/SymfonyExtension to integrate Behat with Symfony.

Basic Usage¶

The best way of understanding how things work in detail is showing and analyzing examples, that is why this section gathers all the knowledge from the previous chapters. Let’s assume that we are going to implement the functionality of managing countries in our system. Now let us show you the flow.

Describing features¶

Let’s start with writing our feature file, which will contain answers to the most important questions: Why (benefit, business value), who (actor using the feature) and what (the feature itself). It should also include scenarios, which serve as examples of how things supposed to work. Let’s have a look at the features/addressing/managing_countries/adding_country.feature file.

# features/addressing/managing_countries/adding_country.feature

@managing_countries
Feature: Adding a new country
    In order to sell my goods to different countries
    As an Administrator
    I want to add a new country to the store

    Background:
        Given I am logged in as an administrator

    @ui
    Scenario: Adding country
        When I want to add a new country
        And I choose "United States"
        And I add it
        Then I should be notified that it has been successfully created
        And the country "United States" should appear in the store

Pay attention to the form of these sentences. From the developer point of view they are hiding the details of the feature’s implementation. Instead of describing “When I click on the select box And I choose United States from the dropdown Then I should see the United States country in the table” - we are using sentences that are less connected with the implementation, but more focused on the effects of our actions. A side effect of such approach is that it results in steps being really generic, therefore if we want to add another way of testing this feature for instance in the domain or api context, it will be extremely easy to apply. We just need to add a different tag (in this case “@domain”) and of course implement the proper steps in the domain context of our system. To be more descriptive let’s imagine that we want to check if a country is added properly in two ways. First we are checking if the adding works via frontend, so we are implementing steps that are clicking, opening pages, filling fields on forms and similar, but also we want to check this action regardlessly of the frontend, for that we need the domain, which allows us to perform actions only on objects.

Choosing a correct suite¶

After we are done with a feature file, we have to create a new suite for it. At the beginning we have decided that it will be a frontend/user interface feature:

# src/Sylius/Behat/Resources/config/suites/ui/addressing/managing_countries.yml

default:
    suites:
        ui_managing_countries:
            contexts:
                # This service is responsible for clearing database before each scenario,
                # so that only data from the current and its background is available.
                - sylius.behat.context.hook.doctrine_orm

                # The transformer contexts services are responsible for all the transformations of data in steps:
                # For instance "And the country "France" should appear in the store" transforms "(the country "France")" to a proper Country object, which is from now on available in the scope of the step.
                - sylius.behat.context.transform.country
                - sylius.behat.context.transform.shared_storage

                # The setup contexts here are preparing the background, adding available countries and users or administrators.
                # These contexts have steps like "I am logged in as an administrator" already implemented.
                - sylius.behat.context.setup.geographical
                - sylius.behat.context.setup.security

                # Lights, Camera, Action!
                # Those contexts are essential here we are placing all action steps like "When I choose "France" and I add it Then I should ne notified that...".
                - sylius.behat.context.ui.admin.managing_countries
                - sylius.behat.context.ui.admin.notification

            filters:
                tags: "@managing_countries && @ui"

A very important thing that is done here is the configuration of tags, from now on Behat will be searching for all your features tagged with @managing_countries and your scenarios tagged with @ui. Second thing is contexts in this section we will be placing all our services with step implementation.

We have mentioned with the generic steps we can easily switch our testing context to @domain. Have a look how it looks:

# src/Sylius/Behat/Resources/config/suites/domain/addressing/managing_countries.yml

default:
    suites:
        domain_managing_countries:
            contexts_services:
                - sylius.behat.context.hook.doctrine_orm

                - sylius.behat.context.transform.country
                - sylius.behat.context.transform.shared_storage

                - sylius.behat.context.setup.geographical
                - sylius.behat.context.setup.security

                # Domain step implementation.
                - sylius.behat.context.domain.admin.managing_countries

            filters:
                tags: "@managing_countries && @domain"

We are almost finished with the suite configuration.

Registering Pages¶

The page object approach allows us to hide all the detailed interaction with ui (html, javascript, css) inside.

We have three kinds of pages:

Page - First layer of our pages it knows how to interact with DOM objects. It has a method getUrl(array $urlParameters) where you can define a raw url to open it.
SymfonyPage - This page extends the Page. It has a router injected so that the getUrl() method generates a url from the route name which it gets from the getRouteName() method.
Base Crud Pages (IndexPage, CreatePage, UpdatePage) - These pages extend SymfonyPage and they are specific to the Sylius resources. They have a resource name injected and therefore they know about the route name.

There are two ways to manipulate UI - by using ->getDocument() or ->getElement('your_element'). First method will return a DocumentElement which represents an html structure of the currently opened page, second one is a bit more tricky because it uses the ->getDefinedElements() method and it will return a NodeElement which represents only the restricted html structure.

Usage example of getElement('your_element') and getDefinedElements() methods.

final class CreatePage extends SymfonyPage implements CreatePageInterface
{
    // This method returns a simple associative array, where the key is the name of your element and the value is its locator.
    protected function getDefinedElements(): array
    {
        return array_merge(parent::getDefinedElements(), [
            'provinces' => '#sylius_country_provinces',
        ]);
    }

    // By default it will assume that your locator is css.
    protected function getDefinedElements(): array
    {
        return array_merge(parent::getDefinedElements(), [
            'provinces_css' => '.provinces',
            'provinces_xpath' => ['xpath' => '//*[contains(@class, "provinces")]'], // Now your value is an array where key is your locator type.
        ]);
    }

    // Like that you can easily manipulate your page elements.
    public function addProvince(ProvinceInterface $province): void
    {
        $provinceSelectBox = $this->getElement('provinces');

        $provinceSelectBox->selectOption($province->getName());
    }
}

Let’s get back to our main example and analyze our scenario. We have steps like:

When I choose "France"
And I add it
Then I should be notified that it has been successfully created
And the country "France" should appear in the store

namespace Sylius\Behat\Page\Admin\Country;

use Sylius\Behat\Page\Admin\Crud\CreatePage as BaseCreatePage;

final class CreatePage extends BaseCreatePage implements CreatePageInterface
{
    public function chooseName(string $name): void
    {
        $this->getDocument()->selectFieldOption('Name', $name);
    }

    public function create(): void
    {
        $this->getDocument()->pressButton('Create');
    }
}

namespace Sylius\Behat\Page\Admin\Country;

use Sylius\Behat\Page\Admin\Crud\IndexPage as BaseIndexPage;

final class IndexPage extends BaseIndexPage implements IndexPageInterface
{
    public function isSingleResourceOnPage(array $parameters): bool
    {
        try {
            // Table accessor is a helper service which is responsible for all html table operations.
            $rows = $this->tableAccessor->getRowsWithFields($this->getElement('table'), $parameters);

            return 1 === count($rows);
        } catch (ElementNotFoundException $exception) {
            // Table accessor throws this exception when cannot find table element on page.
            return false;
        }
    }
}

There is one small gap in this concept - PageObjects is not a concrete instance of the currently opened page, they only mimic its behaviour (dummy pages). This gap will be more understandable on the below code example.

// Of course this is only to illustrate this gap.

class HomePage
{
    // In this context on home page sidebar you have for example weather information in selected countries.
    public function readWeather()
    {
        return $this->getElement('sidebar')->getText();
    }

    protected function getDefinedElements(): array
    {
        return ['sidebar' => ['css' => '.sidebar']];
    }

    protected function getUrl(): string
    {
        return 'http://your_domain.com';
    }
}

class LeagueIndexPage
{
    // In this context you have for example football match results.
    public function readMatchResults(): void
    {
        return $this->getElement('sidebar')->getText();
    }

    protected function getDefinedElements(): array
    {
        return ['sidebar' => ['css' => '.sidebar']];
    }

    protected function getUrl(): string
    {
        return 'http://your_domain.com/leagues/';
    }
}

final class GapContext implements Context
{
    private $homePage;
    private $leagueIndexPage;

    /**
     * @Given I want to be on Homepage
     */
    public function iWantToBeOnHomePage(): void// After this method call we will be on "http://your_domain.com".
    {
        $this->homePage->open(); //When we add @javascript tag we can actually see this thanks to selenium.
    }

    /**
     * @Then I want to see the sidebar and get information about the weather in France
     */
    public function iWantToReadSideBarOnHomePage($someInformation): void // Still "http://your_domain.com".
    {
        $someInformation === $this->leagueIndexPage->readMatchResults(); // This returns true, but wait a second we are on home page (dummy pages).

        $someInformation === $this->homePage->readWeather(); // This also returns true.
    }
}

Registering contexts¶

As it was shown in the previous section we have registered a lot of contexts, so we will show you only some of the steps implementation.

Given I want to add a new country
And I choose "United States"
And I add it
Then I should be notified that it has been successfully created
And the country "United States" should appear in the store

Let’s start with essential one ManagingCountriesContext

Ui contexts¶

namespace Sylius\Behat\Context\Ui\Admin;

final class ManagingCountriesContext implements Context
{
    /** @var IndexPageInterface */
    private $indexPage;

    /** @var CreatePageInterface */
    private $createPage;

    /** @var UpdatePageInterface */
    private $updatePage;

    public function __construct(
        IndexPageInterface $indexPage,
        CreatePageInterface $createPage,
        UpdatePageInterface $updatePage
    ) {
        $this->indexPage = $indexPage;
        $this->createPage = $createPage;
        $this->updatePage = $updatePage;
    }

    /**
     * @Given I want to add a new country
     */
    public function iWantToAddNewCountry(): void
    {
        $this->createPage->open(); // This method will send request.
    }

    /**
     * @When I choose :countryName
     */
    public function iChoose(string $countryName): void
    {
        $this->createPage->chooseName($countryName);
        // Great benefit of using page objects is that we hide html manipulation behind a interfaces so we can inject different CreatePage which implements CreatePageInterface
        // And have different html elements which allows for example chooseName($countryName).
    }

    /**
     * @When I add it
     */
    public function iAddIt(): void
    {
        $this->createPage->create();
    }

    /**
     * @Then /^the (country "([^"]+)") should appear in the store$/
     */
    public function countryShouldAppearInTheStore(CountryInterface $country): void // This step use Country transformer to get Country object.
    {
        $this->indexPage->open();

        //Webmozart assert library.
        Assert::true(
            $this->indexPage->isSingleResourceOnPage(['code' => $country->getCode()]),
            sprintf('Country %s should exist but it does not', $country->getCode())
        );
    }
}

namespace Sylius\Behat\Context\Ui\Admin;

final class NotificationContext implements Context
{
    /**
     * This is a helper service which give access to proper notification elements.
     *
     * @var NotificationCheckerInterface
     */
    private $notificationChecker;

    public function __construct(NotificationCheckerInterface $notificationChecker)
    {
        $this->notificationChecker = $notificationChecker;
    }

    /**
     * @Then I should be notified that it has been successfully created
     */
    public function iShouldBeNotifiedItHasBeenSuccessfullyCreated(): void
    {
        $this->notificationChecker->checkNotification('has been successfully created.', NotificationType::success());
    }
}

Transformer contexts¶

namespace Sylius\Behat\Context\Transform;

final class CountryContext implements Context
{
    /** @var CountryNameConverterInterface */
    private $countryNameConverter;

    /** @var RepositoryInterface */
    private $countryRepository;

    public function __construct(
        CountryNameConverterInterface $countryNameConverter,
        RepositoryInterface $countryRepository
    ) {
        $this->countryNameConverter = $countryNameConverter;
        $this->countryRepository = $countryRepository;
    }

    /**
     * @Transform /^country "([^"]+)"$/
     * @Transform /^"([^"]+)" country$/
     */
    public function getCountryByName(string $countryName): CountryInterface // Thanks to this method we got in our ManagingCountries an Country object.
    {
        $countryCode = $this->countryNameConverter->convertToCode($countryName);
        $country = $this->countryRepository->findOneBy(['code' => $countryCode]);

        Assert::notNull(
            $country,
            'Country with name %s does not exist'
        );

        return $country;
    }
}

namespace Sylius\Behat\Context\Ui\Admin;

use Sylius\Behat\Page\Admin\Country\UpdatePageInterface;

final class ManagingCountriesContext implements Context
{
    /** @var UpdatePageInterface */
    private $updatePage;

    public function __construct(UpdatePageInterface $updatePage)
    {
        $this->updatePage = $updatePage;
    }

    /**
     * @Given /^I want to create a new province in (country "[^"]+")$/
     */
    public function iWantToCreateANewProvinceInCountry(CountryInterface $country): void
    {
        $this->updatePage->open(['id' => $country->getId()]);

        $this->updatePage->clickAddProvinceButton();
    }
}

namespace Sylius\Behat\Context\Transform;

final class ShippingMethodContext implements Context
{
    /** @var ShippingMethodRepositoryInterface */
    private $shippingMethodRepository;

    public function __construct(ShippingMethodRepositoryInterface $shippingMethodRepository)
    {
        $this->shippingMethodRepository = $shippingMethodRepository;
    }

    /**
     * @Transform :shippingMethod
     */
    public function getShippingMethodByName(string $shippingMethodName): void
    {
        $shippingMethod = $this->shippingMethodRepository->findOneByName($shippingMethodName);
        if (null === $shippingMethod) {
            throw new \Exception('Shipping method with name "'.$shippingMethodName.'" does not exist');
        }

        return $shippingMethod;
    }
}

namespace Sylius\Behat\Context\Ui\Admin;

use Sylius\Behat\Page\Admin\ShippingMethod\UpdatePageInterface;

final class ShippingMethodContext implements Context
{
    /** @var UpdatePageInterface */
    private $updatePage;

    public function __construct(UpdatePageInterface $updatePage)
    {
        $this->updatePage = $updatePage;
    }

    /**
     * @Given I want to modify a shipping method :shippingMethod
     */
    public function iWantToModifyAShippingMethod(ShippingMethodInterface $shippingMethod): void
    {
        $this->updatePage->open(['id' => $shippingMethod->getId()]);
    }
}

Warning

Contexts should have single responsibility and this segregation (Setup, Transformer, Ui, etc…) is not accidental. We shouldn’t create objects in transformer contexts.

Setup contexts¶

For setup context we need different scenario with more background steps and all preparing scene steps. Editing scenario will be great for this example:

Given the store has disabled country "France"
And I want to edit this country
When I enable it
And I save my changes
Then I should be notified that it has been successfully edited
And this country should be enabled

namespace Sylius\Behat\Context\Setup;

final class GeographicalContext implements Context
{
    /** @var SharedStorageInterface */
    private $sharedStorage;

    /** @var FactoryInterface */
    private $countryFactory;

    /** @var RepositoryInterface */
    private $countryRepository;

    /** @var CountryNameConverterInterface */
    private $countryNameConverter;

    public function __construct(
        SharedStorageInterface $sharedStorage,
        FactoryInterface $countryFactory,
        RepositoryInterface $countryRepository,
        CountryNameConverterInterface $countryNameConverter
    ) {
        $this->sharedStorage = $sharedStorage;
        $this->countryFactory = $countryFactory;
        $this->countryRepository = $countryRepository;
        $this->countryNameConverter = $countryNameConverter;
    }

    /**
     * @Given /^the store has disabled country "([^"]*)"$/
     */
    public function theStoreHasDisabledCountry(string $countryName): void // This method save country in data base.
    {
        $country = $this->createCountryNamed(trim($countryName));
        $country->disable();

        $this->sharedStorage->set('country', $country);
        // Shared storage is an helper service for transferring objects between steps.
        // There is also SharedStorageContext which use this helper service to transform sentences like "(this country), (it), (its), (theirs)" into Country Object.

        $this->countryRepository->add($country);
    }

    private function createCountryNamed(string $name): CountryInterface
    {
        /** @var CountryInterface $country */
        $country = $this->countryFactory->createNew();
        $country->setCode($this->countryNameConverter->convertToCode($name));

        return $country;
    }
}

How to add a new context?¶

To add a new context to Behat container it is needed to add a service in to one of a following files cli.xml/domain.xml/hook.xml/setup.xml/transform.xml/ui.xml in src/Sylius/Behat/Resources/config/services/contexts/ folder:

<service id="sylius.behat.context.CONTEXT_CATEGORY.CONTEXT_NAME"
         class="%sylius.behat.context.CONTEXT_CATEGORY.CONTEXT_NAME.class%"
         public="true" />

Then you can use it in your suite configuration:

default:
    suites:
        SUITE_NAME:
            contexts:
                - "sylius.behat.context.CONTEXT_CATEGORY.CONTEXT_NAME"

            filters:
                tags: "@SUITE_TAG"

Note

The context categories are usually one of hook, setup, ui and domain and, as you can guess, they are corresponded to files name mentioned above.

How to add a new page object?¶

Sylius uses a solution inspired by SensioLabs/PageObjectExtension, which provides an infrastructure to create pages that encapsulates all the user interface manipulation in page objects.

To create a new page object it is needed to add a service in Behat container in etc/behat/services/pages.xml file:

<service id="sylius.behat.page.PAGE_NAME" class="%sylius.behat.page.PAGE_NAME.class%" parent="sylius.behat.symfony_page" public="false" />

Note

There are some boilerplates for common pages, which you may use. The available parents are sylius.behat.page (FriendsOfBehat\PageObjectExtension\Page\Page) and sylius.behat.symfony_page (FriendsOfBehat\PageObjectExtension\Page\SymfonyPage). It is not required for a page to extend any class as pages are POPOs (Plain Old PHP Objects).

Then you will need to add that service as a regular argument in context service.

The simplest Symfony-based page looks like:

use FriendsOfBehat\PageObjectExtension\Page\SymfonyPage;

class LoginPage extends SymfonyPage
{
    public function getRouteName(): string
    {
        return 'sylius_user_security_login';
    }
}

How to define a new suite?¶

To define a new suite it is needed to create a suite configuration file in a one of cli/domain/ui directory inside src/Sylius/Behat/Resources/config/suites. Then register that file in src/Sylius/Behat/Resources/config/suites.yml.

How to use transformers?¶

Behat provides many awesome features, and one of them is definitely transformers. They can be used to transform (usually widely used) parts of steps and return some values from them, to prevent unnecessary duplication in many steps’ definitions.

Basic transformer¶

Example is always the best way to clarify, so let’s look at this:

/**
 * @Transform /^"([^"]+)" shipping method$/
 * @Transform /^shipping method "([^"]+)"$/
 * @Transform :shippingMethod
 */
public function getShippingMethodByName(string $shippingMethodName): ShippingMethodInterface
{
    $shippingMethod = $this->shippingMethodRepository->findOneByName($shippingMethodName);

    Assert::notNull(
        $shippingMethod,
        sprintf('Shipping method with name "%s" does not exist', $shippingMethodName)
    );

    return $shippingMethod;
}

This transformer is used to return ShippingMethod object from proper repository using it’s name. It also throws exception if such a method does not exist. It can be used in plenty of steps, that have shipping method name in it.

Note

In the example above a Webmozart assertion library was used, to assert a value and throw an exception if needed.

But how to use it? It is as simple as that:

/**
 * @Given /^(shipping method "[^"]+") belongs to ("[^"]+" tax category)$/
 */
public function shippingMethodBelongsToTaxCategory(
    ShippingMethodInterface $shippingMethod,
    TaxCategoryInterface $taxCategory
): void {
    // some logic here
}

If part of step matches transformer definition, it should be surrounded by parenthesis to be handled as whole expression. That’s it! As it is shown in the example, many transformers can be used in the same step definition. Is it all? No! The following example will also work like charm:

/**
 * @When I delete shipping method :shippingMethod
 * @When I try to delete shipping method :shippingMethod
 */
public function iDeleteShippingMethod(ShippingMethodInterface $shippingMethod): void
{
    // some logic here
}

It is worth to mention, that in such a case, transformer would be matched depending on a name after ‘:’ sign. So many transformers could be used when using this signature also. This style gives an opportunity to write simple steps with transformers, without any regex, which would boost context readability.

Note

Transformer definition does not have to be implemented in the same context, where it is used. It allows to share them between many different contexts.

Transformers implemented in Sylius¶

Specified¶

There are plenty of transformers already implemented in Sylius. Most of them return specific resources from their repository, for example:

tax category "Fruits" -> find tax category in their repository with name “Fruits”
"Chinese banana" variant of product "Banana" -> find variant of specific product

etc. You’re free to use them in your own behat scenarios.

Note

All transformers definitions are currently kept in Sylius\Behat\Context\Transform namespace.

Warning

Remember to include contexts with transformers in custom suite to be able to use them!

Generic¶

Moreover, there are also some more generic transformers, that could be useful in many different cases. They are now placed in two contexts: LexicalContext and SharedStorageContext. Why are they so awesome? Let’s describe them one by one:

LexicalContext

@Transform /^"(?:€|£|\$)((?:\d+\.)?\d+)"$/ -> tricky transformer used to parse price string with currency into integer (used to represent price in Sylius). It is used in steps like this promotion gives "€30.00" fixed discount to every order
@Transform /^"((?:\d+\.)?\d+)%"$/ -> similar one, transforming percentage string into float (example: this promotion gives "10%" percentage discount to every order)

SharedStorageContext

Note

SharedStorage is kind of container used to keep objects, which can be shared between steps. It can be used, for example, to keep newly created promotion, to use its name in checking existence step.

@Transform /^(it|its|theirs)$/ -> amazingly useful transformer, that returns last resource saved in SharedStorage. It allows to simplify many steps used after creation/update (and so on) actions. Example: instead of writing When I create "Wade Wilson" customer/Then customer "Wade Wilson" should be registered just write When I create "Wade Wilson" customer/Then it should be registered
@Transform /^(?:this|that|the) ([^"]+)$/ -> similar to previous one, but returns resource saved with specific key, for example this promotion will return resource saved with promotion key in SharedStorage

Components & Bundles¶

Documentation of all Sylius components and bundles useful when using them standalone.

Components & Bundles¶

Sylius Bundles Documentation¶

SyliusAddressingBundle¶

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!

This bundle integrates the Addressing into Symfony and Doctrine.

With minimal configuration you can introduce addresses, countries, provinces and zones management into your project. It’s fully customizable, but the default setup should be optimal for most use cases.

It also contains zone matching mechanisms, which allow you to match customer addresses to appropriate tax/shipping (or any other) zones. There are several models inside the bundle, Address, Country, Province, Zone and ZoneMember.

There is also a ZoneMatcher service. You’ll get familiar with it in later parts of this documentation.

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, a dependency manager for PHP. Use following command to add the bundle to your composer.json and download package.

If you have Composer installed globally.

composer require sylius/addressing-bundle

Otherwise you have to download .phar file.

curl -sS https://getcomposer.org/installer | php
php composer.phar require sylius/addressing-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.

<?php

// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        new winzou\Bundle\StateMachineBundle\winzouStateMachineBundle(),
        new FOS\RestBundle\FOSRestBundle(),
        new JMS\SerializerBundle\JMSSerializerBundle(),
        new Stof\DoctrineExtensionsBundle\StofDoctrineExtensionsBundle(),
        new BabDev\PagerfantaBundle\BabDevPagerfantaBundle(),

        new Sylius\Bundle\AddressingBundle\SyliusAddressingBundle(),
        new Sylius\Bundle\ResourceBundle\SyliusResourceBundle(),

        // Other bundles...
        new Doctrine\Bundle\DoctrineBundle\DoctrineBundle(),
    );
}

Updating database schema¶

Run the following command.

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.

ZoneMatcher¶

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!

This bundle exposes the ZoneMatcher as sylius.zone_matcher service.

<?php

$zoneMatcher = $this->get('sylius.zone_matcher');

$zone = $zoneMatcher->match($user->getBillingAddress());

Forms¶

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!

The bundle ships with a set of useful form types for all models. You can use the defaults or override them with your own types.

Address form¶

The address form type is named sylius_address and you can create it whenever you need, using the form factory.

<?php

// src/Acme/ShopBundle/Controller/AddressController.php

namespace Acme\ShopBundle\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Symfony\Component\HttpFoundation\Request;

class DemoController extends Controller
{
    public function fooAction(Request $request)
    {
        $form = $this->get('form.factory')->create('sylius_address');
    }
}

You can also embed it into another form.

<?php

// src/Acme/ShopBundle/Form/Type/OrderType.php

namespace Acme\ShopBundle\Form\Type;

use Sylius\Bundle\OrderBundle\Form\Type\OrderType as BaseOrderType;
use Symfony\Component\Form\FormBuilderInterface;

class OrderType extends BaseOrderType
{
    public function buildForm(FormBuilderInterface $builder, array $options)
    {
        parent::buildForm($builder, $options);

        $builder
            ->add('billingAddress', 'sylius_address')
            ->add('shippingAddress', 'sylius_address')
        ;
    }
}

Summary¶

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!

Configuration Reference¶

sylius_addressing:
    # The driver used for persistence layer.
    driver: ~
    resources:
        address:
            classes:
                model: Sylius\Component\Addressing\Model\Address
                interface: Sylius\Component\Addressing\Model\AddressInterface
                controller: Sylius\Bundle\ResourceBundle\Controller\ResourceController
                repository: ~
                factory: Sylius\Component\Resource\Factory\Factory
                form: Sylius\Bundle\AddressingBundle\Form\Type\AddressType
        country:
            classes:
                model: Sylius\Component\Addressing\Model\Country
                interface: Sylius\Component\Addressing\Model\CountryInterface
                controller: Sylius\Bundle\ResourceBundle\Controller\ResourceController
                repository: ~
                factory: Sylius\Component\Resource\Factory\Factory
                form: Sylius\Bundle\AddressingBundle\Form\Type\CountryType
        province:
            classes:
                model: Sylius\Component\Addressing\Model\Province
                interface: Sylius\Component\Addressing\Model\ProvinceInterface
                controller: Sylius\Bundle\AddressingBundle\Controller\ProvinceController
                repository: ~
                factory: Sylius\Component\Resource\Factory\Factory
                form: Sylius\Bundle\AddressingBundle\Form\Type\ProvinceType
        zone:
            classes:
                model: Sylius\Component\Addressing\Model\Zone
                interface: Sylius\Component\Addressing\Model\ZoneInterface
                controller: Sylius\Bundle\ResourceBundle\Controller\ResourceController
                repository: ~
                factory: Sylius\Component\Resource\Factory\Factory
                form: Sylius\Bundle\AddressingBundle\Form\Type\ZoneType
        zone_member:
            classes:
                model: Sylius\Component\Addressing\Model\ZoneMember
                interface: Sylius\Component\Addressing\Model\ZoneMemberInterface
                controller: Sylius\Bundle\ResourceBundle\Controller\ResourceController
                repository: ~
                factory: Sylius\Component\Resource\Factory\Factory
                form: Sylius\Bundle\AddressingBundle\Form\Type\ZoneMemberType

Bug tracking¶

This bundle uses GitHub issues. If you have found bug, please create an issue.

Learn more¶

Addresses in the Sylius platform - concept documentation

SyliusAttributeBundle¶

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!

This bundle provides easy integration of the Sylius Attribute component with any Symfony full-stack application.

Sylius uses this bundle internally for its product catalog to manage the different attributes that are specific to each product.

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, 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.

composer require sylius/attribute-bundle

Otherwise you have to download .phar file.

curl -sS https://getcomposer.org/installer | php
php composer.phar require sylius/attribute-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.

<?php

// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        new winzou\Bundle\StateMachineBundle\winzouStateMachineBundle(),
        new FOS\RestBundle\FOSRestBundle(),
        new JMS\SerializerBundle\JMSSerializerBundle(),
        new Stof\DoctrineExtensionsBundle\StofDoctrineExtensionsBundle(),
        new BabDev\PagerfantaBundle\BabDevPagerfantaBundle(),
        new Sylius\Bundle\AttributeBundle\SyliusAttributeBundle(),
        new Sylius\Bundle\ResourceBundle\SyliusResourceBundle(),

        // Other bundles...
        new Doctrine\Bundle\DoctrineBundle\DoctrineBundle(),
    );
}

Container configuration¶

Put this configuration inside your app/config/config.yml.

sylius_attribute:
    driver: doctrine/orm # Configure the doctrine orm driver used in the documentation.

And configure doctrine extensions which are used by the bundle.

stof_doctrine_extensions:
    orm:
        default:
            timestampable: true

Updating database schema¶

Run the following command.

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.

Configuration reference¶

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!

sylius_attribute:
      driver: ~ # The driver used for persistence layer. Currently only `doctrine/orm` is supported.
      resources:
          # `subject_name` can be any name, for example `product`, `ad`, or `blog_post`
          subject_name:
              subject: ~ # Required: The subject class implementing `AttributeSubjectInterface`.
              attribute:
                  classes:
                      model:      Sylius\Component\Attribute\Model\Attribute
                      interface:  Sylius\Component\Attribute\Model\AttributeInterface
                      repository: Sylius\Bundle\TranslationBundle\Doctrine\ORM\TranslatableResourceRepository
                      controller: Sylius\Bundle\ResourceBundle\Controller\ResourceController
                      factory:    Sylius\Component\Resource\Factory\Factory
                      form: Sylius\Bundle\AttributeBundle\Form\Type\AttributeType
                  translation:
                      classes:
                          model:      Sylius\Component\Attribute\Model\AttributeTranslation
                          interface:  Sylius\Component\Attribute\Model\AttributeTranslationInterface
                          controller: Sylius\Bundle\ResourceBundle\Controller\ResourceController
                          repository: ~ # Required: The repository class for the attribute translation.
                          factory:    Sylius\Component\Resource\Factory\Factory
                          form: Sylius\Bundle\AttributeBundle\Form\Type\AttributeTranslationType
              attribute_value:
                  classes:
                      model:      ~ # Required: The model of the attribute value
                      interface:  ~ # Required: The interface of the attribute value
                      controller: Sylius\Bundle\ResourceBundle\Controller\ResourceController
                      repository: ~ # Required: The repository class for the attribute value.
                      factory:    Sylius\Component\Resource\Factory\Factory
                      form: Sylius\Bundle\AttributeBundle\Form\Type\AttributeValueType

Learn more¶

Attributes in the Sylius platform - concept documentation

SyliusCustomerBundle¶

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!

A solution for customer management system inside of a Symfony application.

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, 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.

composer require sylius/customer-bundle

Otherwise you have to download .phar file.

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.

<?php

// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        new FOS\RestBundle\FOSRestBundle(),
        new JMS\SerializerBundle\JMSSerializerBundle(),
        new Stof\DoctrineExtensionsBundle\StofDoctrineExtensionsBundle(),
        new BabDev\PagerfantaBundle\BabDevPagerfantaBundle(),
        new Bazinga\Bundle\HateoasBundle\BazingaHateoasBundle(),
        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.

# app/config/config.yml
stof_doctrine_extensions:
    orm:
        default:
            timestampable: true

Updating database schema¶

Run the following command.

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.

Summary¶

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!

Configuration reference¶

sylius_customer:
    driver: doctrine/orm
    resources:
        customer:
            classes:
                model: Sylius\Component\Core\Model\Customer
                repository: Sylius\Bundle\CoreBundle\Doctrine\ORM\CustomerRepository
                form:
                    default: Sylius\Bundle\CoreBundle\Form\Type\Customer\CustomerType
                    profile: Sylius\Bundle\CustomerBundle\Form\Type\CustomerProfileType
                    choice: Sylius\Bundle\ResourceBundle\Form\Type\ResourceChoiceType
                interface: Sylius\Component\Customer\Model\CustomerInterface
                controller: Sylius\Bundle\ResourceBundle\Controller\ResourceController
                factory: Sylius\Component\Resource\Factory\Factory
        customer_group:
            classes:
                model: Sylius\Component\Customer\Model\CustomerGroup
                interface: Sylius\Component\Customer\Model\CustomerGroupInterface
                controller: Sylius\Bundle\ResourceBundle\Controller\ResourceController
                factory: Sylius\Component\Resource\Factory\Factory
                form: Sylius\Bundle\CustomerBundle\Form\Type\CustomerGroupType

Bug tracking¶

This bundle uses GitHub issues. If you have found bug, please create an issue.

Learn more¶

Customers in the Sylius platform - concept documentation

SyliusInventoryBundle¶

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!

Flexible inventory management for Symfony applications.

With minimal configuration you can implement inventory tracking in your project.

It’s fully customizable, but the default setup should be optimal for most use cases.

There is StockableInterface and InventoryUnit model inside the bundle.

There are services AvailabilityChecker, InventoryOperator and InventoryChangeListener.

You’ll get familiar with them in later parts of this documentation.

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, a dependency manager for PHP. Use the following command to add the bundle to your composer.json and download package.

If you have Composer installed globally.

composer require sylius/inventory-bundle

Otherwise you have to download .phar file.

curl -sS https://getcomposer.org/installer | php
php composer.phar require sylius/inventory-bundle

Adding required bundles to the kernel¶

First, 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 the kernel. Don’t worry, everything was automatically installed via Composer.

<?php

// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
        new FOS\RestBundle\FOSRestBundle(),
        new Sylius\Bundle\ResourceBundle\SyliusResourceBundle(),
        new Sylius\Bundle\InventoryBundle\SyliusInventoryBundle(),
    );
}

Creating your entities¶

Let’s assume we want to implement a book store application and track the books inventory.

You have to create a Book and an InventoryUnit entity, living inside your application code. We think that keeping the app-specific bundle structure simple is a good practice, so let’s assume you have your App registered under App\Bundle\AppBundle namespace.

We will create Book entity.

<?php

// src/Entity/Book.php
namespace App\Entity;

use Sylius\Component\Inventory\Model\StockableInterface;
use Doctrine\ORM\Mapping as ORM;

/**
 * @ORM\Entity
 * @ORM\Table(name="app_book")
 */
class Book implements StockableInterface
{
    /**
     * @ORM\Id
     * @ORM\Column(type="integer")
     * @ORM\GeneratedValue(strategy="AUTO")
     */
    protected $id;

    /**
     * @ORM\Column(type="string")
     */
    protected $isbn;

    /**
     * @ORM\Column(type="string")
     */
    protected $title;

    /**
     * @ORM\Column(type="integer")
     */
    protected $onHand;

    public function __construct()
    {
        $this->onHand = 1;
    }

    public function getId()
    {
        return $this->id;
    }

    public function getIsbn()
    {
        return $this->isbn;
    }

    public function setIsbn($isbn)
    {
        $this->isbn = $isbn;
    }

    public function getSku()
    {
        return $this->getIsbn();
    }

    public function getTitle()
    {
        return $this->title;
    }

    public function setTitle($title)
    {
        $this->title = $title;
    }

    public function getInventoryName()
    {
        return $this->getTitle();
    }

    public function isInStock()
    {
        return 0 < $this->onHand;
    }

    public function getOnHand()
    {
        return $this->onHand;
    }

    public function setOnHand($onHand)
    {
        $this->onHand = $onHand;
    }
}

Note

This example shows the full power of StockableInterface.

In order to track the books inventory our Book entity must implement StockableInterface. Note that we added ->getSku() method which is alias to ->getIsbn(), this is the power of the interface, we now have full control over the entity mapping. In the same way ->getInventoryName() exposes the book title as the displayed name for our stockable entity.

The next step requires the creating of the InventoryUnit entity, let’s do this now.

<?php

// src/Entity/InventoryUnit.php
namespace App\Entity;

use Sylius\Component\Inventory\Model\InventoryUnit as BaseInventoryUnit;
use Doctrine\ORM\Mapping as ORM;

/**
 * @ORM\Entity
 * @ORM\Table(name="app_inventory_unit")
 */
class InventoryUnit extends BaseInventoryUnit
{
    /**
     * @ORM\Id
     * @ORM\Column(type="integer")
     * @ORM\GeneratedValue(strategy="AUTO")
     */
    protected $id;
}

Note that we are using base model from Sylius component, which means inheriting some functionality inventory component provides. InventoryUnit holds the reference to stockable object, which is Book in our case. So, if we use the InventoryOperator to create inventory units, they will reference the given book entity.

Container configuration¶

Put this configuration inside your app/config/config.yml.

sylius_inventory:
    driver: doctrine/orm
    resources:
        inventory_unit:
            classes:
                model: App\Entity\InventoryUnit

Updating database schema¶

Remember to update your database schema.

For “doctrine/orm” driver run the following command.

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.

Models¶

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!

Here is a quick reference for the default models.

InventoryUnit¶

Each unit holds a reference to a stockable object and its state, which can be sold or returned. It also provides some handy shortcut methods like isSold.

Stockable¶

In order to be able to track stock levels in your application, you must implement StockableInterface or use the Stockable model. It uses the SKU to identify stockable and need to provide display name. It can get/set current stock level with getOnHand and setOnHand methods.

Using the services¶

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!

When using the bundle, you have access to several handy services.

AvailabilityChecker¶

The name speaks for itself, this service checks availability for given stockable object. AvailabilityChecker relies on the current stock level.

There are two methods for checking availability. ->isStockAvailable() just checks whether stockable object is available in stock and doesn’t care about quantity. ->isStockSufficient() checks if there is enough units in the stock for given quantity.

InventoryOperator¶

Inventory operator is the heart of this bundle. It can be used to manage stock levels and inventory units. Creating/destroying inventory units with a given state is also the operators job.

Twig Extension¶

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!

There are two handy twig functions bundled in: sylius_inventory_is_available and sylius_inventory_is_sufficient.

They are simple proxies to the availability checker, and can be used to show if the stockable object is available/sufficient.

Here is a simple example, note that product variable has to be an instance of StockableInterface.

{% if not sylius_inventory_is_available(product) %}
    <span class="label label-important">out of stock</span>
{% endif %}

Summary¶

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!

Configuration reference¶

sylius_inventory:
    # The driver used for persistence layer.
    driver: ~
    # Enable or disbale tracking inventory
    track_inventory: true
    # The availability checker service id.
    checker: sylius.availability_checker.default
    # The inventory operator service id.
    operator: sylius.inventory_operator.default
    # Array of events for InventoryChangeListener
    events: ~
    resources:
        inventory_unit:
            classes:
                model:      Sylius\Component\Inventory\Model\InventoryUnit
                interface:  Sylius\Component\Inventory\Model\InventoryUnitInterface
                controller: Sylius\Bundle\InventoryBundle\Controller\InventoryUnitController
                repository: ~ # You can override the repository class here.
                factory:    Sylius\Component\Resource\Factory\Factory
        stockable:
            classes:
                model: ~ # The stockable model class.
                controller: Sylius\Bundle\ResourceBundle\Controller\ResourceController

Bug tracking¶

This bundle uses GitHub issues. If you have found bug, please create an issue.

Learn more¶

Inventory in the Sylius platform - concept documentation

SyliusOrderBundle¶

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!

This bundle is a foundation for sales order handling for Symfony projects. It allows you to use any model as the merchandise.

It also includes a super flexible adjustments feature, which serves as a basis for any taxation, shipping charges or discounts system.

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, a dependency manager for PHP. Use the following command to add the bundle to your composer.json and download package.

If you have Composer installed globally.

composer require sylius/order-bundle

Otherwise you have to download .phar file.

curl -sS https://getcomposer.org/installer | php
php composer.phar require sylius/order-bundle

Adding required bundles to the kernel¶

First, 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 the kernel. Don’t worry, everything was automatically installed via Composer.

<?php
// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        new winzou\Bundle\StateMachineBundle\winzouStateMachineBundle(),
        new FOS\RestBundle\FOSRestBundle(),
        new JMS\SerializerBundle\JMSSerializerBundle(),
        new Stof\DoctrineExtensionsBundle\StofDoctrineExtensionsBundle(),
        new BabDev\PagerfantaBundle\BabDevPagerfantaBundle(),

        new Sylius\Bundle\ResourceBundle\SyliusResourceBundle(),
        new Sylius\Bundle\MoneyBundle\SyliusMoneyBundle(),
        new Sylius\Bundle\OrderBundle\SyliusOrderBundle(),

        // Other bundles...
        new Doctrine\Bundle\DoctrineBundle\DoctrineBundle(),
    );
}

Updating database schema¶

Remember to update your database schema.

For “doctrine/orm” driver run the following command.

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.

The Order, OrderItem and OrderItemUnit¶

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!

Here is a quick reference of what the default models can do for you.

Order basics¶

Each order has 2 main identifiers, an ID and a human-friendly number. You can access those by calling ->getId() and ->getNumber() respectively. The number is mutable, so you can change it by calling ->setNumber('E001') on the order instance.

<?php

$order->getId();
$order->getNumber();

$order->setNumber('E001');

Order totals¶

Note

All money amounts in Sylius are represented as “cents” - integers.

An order has 3 basic totals, which are all persisted together with the order.

The first total is the items total, it is calculated as the sum of all item totals (including theirs adjustments).

The second total is the adjustments total, you can read more about this in next chapter.

<?php

echo $order->getItemsTotal(); // 1900.
echo $order->getAdjustmentsTotal(); // -250.

$order->calculateTotal();
echo $order->getTotal(); // 1650.

The main order total is a sum of the previously mentioned values. You can access the order total value using the ->getTotal() method.

Note

It’s not needed to call calculateTotal() method, as both itemsTotal and adjustmentsTotal are automatically updated after each operation that can influence their values.

Items management¶

The collection of items (Implementing the Doctrine\Common\Collections\Collection interface) can be obtained using the ->getItems(). To add or remove items, you can simply use the addItem and removeItem methods.

<?php

// $item1 and $item2 are instances of OrderItemInterface.
$order
    ->addItem($item)
    ->removeItem($item2)
;

OrderItem basics¶

An order item model has only the id as identifier, also it has the order to which it belongs, accessible via ->getOrder() method.

The sellable object can be retrieved and set, using the following setter and getter - ->getProduct() & ->setVariant(ProductVariantInterface $variant).

<?php

$item->setVariant($book);

Note

In most cases you’ll use the OrderBuilder service to create your orders.

Just like for the order, the total is available via the same method, but the unit price is accessible using the ->getUnitPrice() Each item also can calculate its total, using the quantity (->getQuantity()) and the unit price.

Warning

Concept of OrderItemUnit allows better management of OrderItem’s quantity. Because of that, it’s needed to use OrderItemQuantityModifier to handle quantity modification properly.

<?php

$item = $itemRepository->createNew();
$item->setVariant($book);
$item->setUnitPrice(2000);

$orderItemQuantityModifier->modify($item, 4); //modifies item's quantity to 4

echo $item->getTotal(); // 8000.

An OrderItem can also hold adjustments.

Units management¶

Each element from units collection in OrderItem represents single, separate unit from order. It’s total is sum of its item unit price and totals’ of each adjustments. Unit’s can be added and removed using addUnit and removeUnit methods from OrderItem, but it’s highly recommended to use OrderItemQuantityModifier.

The Adjustments¶

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!

Adjustments are based on simple but powerful idea inspired by Spree adjustments. They serve as foundation for any tax, shipping and discounts systems.

Adjustment model¶

Note

To be written. Learn more in the Book.

Using the services¶

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!

When using the bundle, you have access to several handy services. You can use them to retrieve and persist orders.

Managers and Repositories¶

Note

Sylius uses Doctrine\Common\Persistence interfaces.

You have access to following services which are used to manage and retrieve resources.

This set of default services is shared across almost all Sylius bundles, but this is just a convention. You’re interacting with them like you usually do with own entities in your project.

<?php

// ObjectManager which is capable of managing the resources.
// For *doctrine/orm* driver it will be EntityManager.
$this->get('sylius.manager.order');
$this->get('sylius.manager.order_item');
$this->get('sylius.manager.order_item_unit');
$this->get('sylius.manager.adjustment');

// ObjectRepository for the Order resource, it extends the base EntityRepository.
// You can use it like usual entity repository in project.
$this->get('sylius.repository.order');
$this->get('sylius.repository.order_item');
$this->get('sylius.repository.order_item_unit');
$this->get('sylius.repository.adjustment');

// Those repositories have some handy default methods, for example...
$item = $itemRepository->createNew();
$orderRepository->find(4);
$paginator = $orderRepository->createPaginator(array('confirmed' => false)); // Get Pagerfanta instance for all unconfirmed orders.

OrderItemQuantityModifier¶

OrderItemQuantityModifier should be used to modify OrderItem quantity, because of whole background units’ logic, that needs to be done. This service handles this task, adding and removing proper amounts of units to OrderItem.

<?php

$orderItemFactory = $this->get('sylius.factory.order_item');
$orderItemQuantityModifier = $this->get('sylius.order_item_quantity_modifier');

$orderItem = $orderItemFactory->createNew();
$orderItem->getQuantity(); // default quantity of order item is 0

$orderItem->setUnitPrice(1000);

$orderItemQuantityModifier->modify($orderItem, 4);

$orderItem->getQuantity(); // after using modifier, quantity is as expected
$orderItem->getTotal();    // item's total is sum of all units' total (units have been created by modifier)

$orderItemQuantityModifier->modify($orderItem, 2);

// OrderItemQuantityModifier can also reduce item's quantity and remove unnecessary units

$orderItem->getQuantity(); // 2
$orderItem->getTotal();    // 2000

Summary¶

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!

Configuration reference¶

sylius_order:
    driver: doctrine/orm
    resources:
        order:
            classes:
                model: Sylius\Component\Core\Model\Order
                controller: Sylius\Bundle\CoreBundle\Controller\OrderController
                repository: Sylius\Bundle\CoreBundle\Doctrine\ORM\OrderRepository
                form: Sylius\Bundle\CoreBundle\Form\Type\Order\OrderType
                interface: Sylius\Component\Order\Model\OrderInterface
                factory: Sylius\Component\Resource\Factory\Factory
        order_item:
            classes:
                model: Sylius\Component\Core\Model\OrderItem
                form: Sylius\Bundle\CoreBundle\Form\Type\Order\OrderItemType
                interface: Sylius\Component\Order\Model\OrderItemInterface
                controller: Sylius\Bundle\OrderBundle\Controller\OrderItemController
                factory: Sylius\Component\Resource\Factory\Factory
        order_item_unit:
            classes:
                model: Sylius\Component\Core\Model\OrderItemUnit
                interface: Sylius\Component\Order\Model\OrderItemUnitInterface
                controller: Sylius\Bundle\ResourceBundle\Controller\ResourceController
                factory: Sylius\Component\Order\Factory\OrderItemUnitFactory
        adjustment:
            classes:
                model: Sylius\Component\Order\Model\Adjustment
                interface: Sylius\Component\Order\Model\AdjustmentInterface
                controller: Sylius\Bundle\ResourceBundle\Controller\ResourceController
                factory: Sylius\Component\Resource\Factory\Factory
        order_sequence:
            classes:
                model: Sylius\Component\Order\Model\OrderSequence
                interface: Sylius\Component\Order\Model\OrderSequenceInterface
                factory: Sylius\Component\Resource\Factory\Factory
    expiration:
        cart: '2 days'
        order: '5 days'

Bug tracking¶

This bundle uses GitHub issues. If you have found bug, please create an issue.

Processors¶

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!

Order processors are responsible of manipulating the orders to apply different predefined adjustments or other modifications based on order state.

Registering custom processors¶

Once you have your own OrderProcessorInterface implementation, if services autowiring and auto-configuration are not enabled, you need to register it as a service.

<?xml version="1.0" encoding="UTF-8"?>

<container xmlns="http://symfony.com/schema/dic/services"
           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
           xsi:schemaLocation="http://symfony.com/schema/dic/services
                               http://symfony.com/schema/dic/services/services-1.0.xsd">

    <services>
        <service id="app.order_processor.custom" class="App\OrderProcessor\CustomOrderProcessor">
            <tag name="sylius.order_processor" priority="0" />
        </service>
    </services>
</container>

Note

You can add your own processor to the CompositeOrderProcessor using sylius.order_processor

Using CompositeOrderProcessor¶

All processor services containing sylius.order_processor tag can be launched as follows:

In a controller:

<?php

// Fetch order from DB
$order = $this->container->get('sylius.repository.order')->find('$id');

// Get the processor from the container or inject the service
$orderProcessor = $this->container->get('sylius.order_processing.order_processor');

$orderProcessor->process($order);

Note

The CompositeOrderProcessor is named as ` sylius.order_processing.order_processor` in the container and contains all services tagged as sylius.order_processor

Learn more¶

Carts & Orders in the Sylius platform - concept documentation

SyliusProductBundle¶

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!

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, 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.

composer require sylius/product-bundle

Otherwise you have to download .phar file.

curl -sS https://getcomposer.org/installer | php
php composer.phar require sylius/product-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.

<?php

// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        new FOS\RestBundle\FOSRestBundle(),
        new JMS\SerializerBundle\JMSSerializerBundle(),
        new Stof\DoctrineExtensionsBundle\StofDoctrineExtensionsBundle(),
        new BabDev\PagerfantaBundle\BabDevPagerfantaBundle(),
        new winzou\Bundle\StateMachineBundle\winzouStateMachineBundle(),
        new Sylius\Bundle\ProductBundle\SyliusProductBundle(),
        new Sylius\Bundle\AttributeBundle\SyliusAttributeBundle(),
        new Sylius\Bundle\ResourceBundle\SyliusResourceBundle(),
        new Sylius\Bundle\LocaleBundle\SyliusLocaleBundle(),

        // Other bundles...
        new Doctrine\Bundle\DoctrineBundle\DoctrineBundle(),
    );
}

Container configuration¶

Put this configuration inside your app/config/config.yml.

stof_doctrine_extensions:
    orm:
        default:
            sluggable: true
            timestampable: true

Updating database schema¶

Run the following command.

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.

The Product¶

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!

Retrieving products¶

Retrieving a product from the database should always happen via repository, which always implements Sylius\Bundle\ResourceBundle\Model\RepositoryInterface. If you are using Doctrine, you’re already familiar with this concept, as it extends the native Doctrine ObjectRepository interface.

Your product repository is always accessible via the sylius.repository.product service.

<?php

public function myAction(Request $request)
{
    $repository = $this->container->get('sylius.repository.product');
}

Retrieving products is simple as calling proper methods on the repository.

<?php

public function myAction(Request $request)
{
    $repository = $this->container->get('sylius.repository.product');

    $product = $repository->find(4); // Get product with id 4, returns null if not found.
    $product = $repository->findOneBy(array('slug' => 'my-super-product')); // Get one product by defined criteria.

    $products = $repository->findAll(); // Load all the products!
    $products = $repository->findBy(array('special' => true)); // Find products matching some custom criteria.
}

Product repository also supports paginating products. To create a Pagerfanta instance use the createPaginator method.

<?php

public function myAction(Request $request)
{
    $repository = $this->container->get('sylius.repository.product');

    $products = $repository->createPaginator();
    $products->setMaxPerPage(3);
    $products->setCurrentPage($request->query->get('page', 1));

   // Now you can return products to the template and iterate over it to get products from the current page.
}

The paginator also can be created for specific criteria and with desired sorting.

<?php

public function myAction(Request $request)
{
    $repository = $this->container->get('sylius.repository.product');

    $products = $repository->createPaginator(array('foo' => true), array('createdAt' => 'desc'));
    $products->setMaxPerPage(3);
    $products->setCurrentPage($request->query->get('page', 1));
}

Creating new product object¶

To create new product instance, you can simply call createNew() method on the factory.

<?php

public function myAction(Request $request)
{
    $factory = $this->container->get('sylius.factory.product');
    $product = $factory->createNew();
}

Note

Creating a product via this factory method makes the code more testable, and allows you to change the product class easily.

Saving & removing product¶

To save or remove a product, you can use any ObjectManager which manages Product. You can always access it via alias sylius.manager.product. But it’s also perfectly fine if you use doctrine.orm.entity_manager or other appropriate manager service.

<?php

public function myAction(Request $request)
{
    $factory = $this->container->get('sylius.factory.product');
    $manager = $this->container->get('sylius.manager.product'); // Alias for appropriate doctrine manager service.

    $product = $factory->createNew();

    $product
        ->setName('Foo')
        ->setDescription('Nice product')
    ;

    $manager->persist($product);
    $manager->flush(); // Save changes in database.
}

To remove a product, you also use the manager.

<?php

public function myAction(Request $request)
{
    $repository = $this->container->get('sylius.repository.product');
    $manager = $this->container->get('sylius.manager.product');

    $product = $repository->find(1);

    $manager->remove($product);
    $manager->flush(); // Save changes in database.
}

Properties¶

A product can also have a set of defined Properties (Attributes), you’ll learn about them in next chapter of this documentation.

Forms¶

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!

The bundle ships with a set of useful form types for all models. You can use the defaults or override them with your own forms.

Product form¶

The product form type is named sylius_product and you can create it whenever you need, using the form factory.

<?php

// src/Acme/ShopBundle/Controller/ProductController.php

namespace Acme\ShopBundle\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Symfony\Component\HttpFoundation\Request;

class DemoController extends Controller
{
    public function fooAction(Request $request)
    {
        $form = $this->get('form.factory')->create('sylius_product');
    }
}

The default product form consists of following fields.

Field	Type
name	text
description	textarea
metaDescription	text
metaKeywords	text

You can render each of these using the usual Symfony way {{ form_row(form.description) }}.

Summary¶

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!

Configuration reference¶

sylius_product:
    driver: doctrine/orm
    resources:
        product:
            classes:
                model: Sylius\Component\Core\Model\Product
                repository: Sylius\Bundle\CoreBundle\Doctrine\ORM\ProductRepository
                form: Sylius\Bundle\CoreBundle\Form\Type\Product\ProductType
                interface: Sylius\Component\Product\Model\ProductInterface
                controller: Sylius\Bundle\ResourceBundle\Controller\ResourceController
                factory: Sylius\Component\Product\Factory\ProductFactory
            translation:
                classes:
                    model: Sylius\Component\Core\Model\ProductTranslation
                    form: Sylius\Bundle\CoreBundle\Form\Type\Product\ProductTranslationType
                    interface: Sylius\Component\Product\Model\ProductTranslationInterface
                    controller: Sylius\Bundle\ResourceBundle\Controller\ResourceController
                    factory: Sylius\Component\Resource\Factory\Factory
        product_variant:
            classes:
                model: Sylius\Component\Core\Model\ProductVariant
                repository: Sylius\Bundle\ProductBundle\Doctrine\ORM\ProductVariantRepository
                form: Sylius\Bundle\CoreBundle\Form\Type\Product\ProductVariantType
                interface: Sylius\Component\Product\Model\ProductVariantInterface
                controller: Sylius\Bundle\ResourceBundle\Controller\ResourceController
                factory: Sylius\Component\Product\Factory\ProductVariantFactory
        product_option:
            classes:
                repository: Sylius\Bundle\ProductBundle\Doctrine\ORM\ProductOptionRepository
                model: Sylius\Component\Product\Model\ProductOption
                interface: Sylius\Component\Product\Model\ProductOptionInterface
                controller: Sylius\Bundle\ResourceBundle\Controller\ResourceController
                factory: Sylius\Component\Resource\Factory\TranslatableFactory
                form: Sylius\Bundle\ProductBundle\Form\Type\ProductOptionType
            translation:
                classes:
                    model: Sylius\Component\Product\Model\ProductOptionTranslation
                    interface: Sylius\Component\Product\Model\ProductOptionTranslationInterface
                    controller: Sylius\Bundle\ResourceBundle\Controller\ResourceController
                    factory: Sylius\Component\Resource\Factory\Factory
                    form: Sylius\Bundle\ProductBundle\Form\Type\ProductOptionTranslationType
        product_option_value:
            classes:
                model: Sylius\Component\Product\Model\ProductOptionValue
                interface: Sylius\Component\Product\Model\ProductOptionValueInterface
                controller: Sylius\Bundle\ResourceBundle\Controller\ResourceController
                factory: Sylius\Component\Resource\Factory\TranslatableFactory
                form: Sylius\Bundle\ProductBundle\Form\Type\ProductOptionValueType
            translation:
                classes:
                    model: Sylius\Component\Product\Model\ProductOptionValueTranslation
                    interface: Sylius\Component\Product\Model\ProductOptionValueTranslationInterface
                    controller: Sylius\Bundle\ResourceBundle\Controller\ResourceController
                    factory: Sylius\Component\Resource\Factory\Factory
                    form: Sylius\Bundle\ProductBundle\Form\Type\ProductOptionValueTranslationType
        product_association:
            classes:
                model: Sylius\Component\Product\Model\ProductAssociation
                interface: Sylius\Component\Product\Model\ProductAssociationInterface
                controller: Sylius\Bundle\ResourceBundle\Controller\ResourceController
                factory: Sylius\Component\Resource\Factory\Factory
                form: Sylius\Bundle\ProductBundle\Form\Type\ProductAssociationType
        product_association_type:
            classes:
                model: Sylius\Component\Product\Model\ProductAssociationType
                interface: Sylius\Component\Product\Model\ProductAssociationTypeInterface
                controller: Sylius\Bundle\ResourceBundle\Controller\ResourceController
                factory: Sylius\Component\Resource\Factory\Factory
                form: Sylius\Bundle\ProductBundle\Form\Type\ProductAssociationTypeType

Bug tracking¶

This bundle uses GitHub issues. If you have found bug, please create an issue.

Learn more¶

Products in the Sylius platform - concept documentation

SyliusPromotionBundle¶

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!

Promotions system for Symfony applications.

With minimal configuration you can introduce promotions and coupons into your project. The following types of promotions are available and totally mixable:

percentage discounts
fixed amount discounts
promotions limited by time
promotions limited by a maximum number of usages
promotions based on coupons

This means you can for instance create the following promotions :

20$ discount for New Year orders having more than 3 items
8% discount for Christmas orders over 100 EUR
first 3 orders have 100% discount
5% discount this week with the coupon code WEEK5
40€ discount with the code you have received by mail

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, 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.

composer require sylius/promotion-bundle

Otherwise you have to download .phar file.

curl -sS https://getcomposer.org/installer | php
php composer.phar require sylius/promotion-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.

<?php

// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        new FOS\RestBundle\FOSRestBundle(),
        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\PromotionBundle\SyliusPromotionBundle(),

        // Other bundles...
        new Doctrine\Bundle\DoctrineBundle\DoctrineBundle(),
    );
}

Promotion Subject configuration¶

Note

You need to have a class that is registered as a Sylius resource. It can be for example a CarRentalOrderClass.

Make your CarRentalOrder class implement the PromotionSubjectInterface.

Put its configuration inside your app/config/config.yml.

# app/config/config.yml
sylius_promotion:
    resources:
        promotion_subject:
            classes:
                model: App\Entity\CarRentalOrder

And configure doctrine extensions which are used by the bundle.

# app/config/config.yml
stof_doctrine_extensions:
    orm:
        default:
            timestampable: true

Congratulations! The bundle is now installed and ready to use.

Models¶

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!

All the models of this bundle are defined in Sylius\Component\Promotion\Model.

PromotionRule¶

A PromotionRule is used to check if your order is eligible to the promotion. A promotion can have none, one or several rules. SyliusPromotionBundle comes with 2 types of rules :

cart quantity rule : quantity of the order is checked

item total rule : the amount of the order is checked

A rule is configured via the configuration attribute which is an array serialized into database. For cart quantity rules, you have to configure the count key, whereas the amount key is used for item total rules. Configuration is always strict, which means, that if you set count to 4 for cart quantity rule, orders with equal or more than 4 quantity will be eligible.

PromotionAction¶

An PromotionAction defines the nature of the discount. Common actions are :

percentage discount
fixed amount discount

An action is configured via the configuration attribute which is an array serialized into database. For percentage discount actions, you have to configure the percentage key, whereas the amount key is used for fixed discount rules.

PromotionCoupon¶

A PromotionCoupon is a ticket having a code that can be exchanged for a financial discount. A promotion can have none, one or several coupons.

A coupon is considered as valid if the method isValid() returns true. This method checks the number of times this coupon can be used (attribute usageLimit), the number of times this has already been used (attribute used) and the coupon expiration date (attribute expiresAt). If usageLimit is not set, the coupon will be usable an unlimited times.

PromotionSubjectInterface¶

A PromotionSubjectInterface is the object you want to apply the promotion on. For instance, in Sylius Standard, a Sylius\Component\Core\Model\Order can be subject to promotions.

By implementing PromotionSubjectInterface, your object will have to define the following methods : - getPromotionSubjectItemTotal() should return the amount of your order - getPromotionSubjectItemCount() should return the number of items of your order - getPromotionCoupon() should return the coupon linked to your order. If you do not want to use coupon, simply return null.

Promotion¶

The Promotion is the main model of this bundle. A promotion has a name, a description and :

can have none, one or several rules
should have at least one action to be effective
can be based on coupons
can have a limited number of usages by using the attributes usageLimit and used. When used reaches usageLimit the promotion is no longer valid. If usageLimit is not set, the promotion will be usable an unlimited times.
can be limited by time by using the attributes startsAt and endsAt

How are rules checked?¶

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!

Everything related to this subject is located in Sylius\Component\Promotion\Checker.

Rule checkers¶

New rules can be created by implementing RuleCheckerInterface. This interface provides the method isEligible which aims to determine if the promotion subject respects the current rule or not.

I told you before that SyliusPromotionBundle ships with 2 types of rules : cart quantity rule and item total rule.

Cart quantity rule is defined via the service sylius.promotion_rule_checker.cart_quantity which uses the class CartQuantityRuleChecker. The method isEligible checks here if the promotion subject has the minimum quantity (method getPromotionSubjectItemCount() of PromotionSubjectInterface) required by the rule.

Item total rule is defined via the service sylius.promotion_rule_checker.item_total which uses the class ItemTotalRuleChecker. The method isEligible checks here if the promotion subject has the minimum amount (method getPromotionSubjectItemTotal() of PromotionSubjectInterface) required by the rule.

The promotion eligibility checker service¶

To be eligible to a promotion, a subject must :

respect all the rules related to the promotion
respect promotion dates if promotion is limited by time
respect promotions usages count if promotion has a limited number of usages
if a coupon is provided with this order, it must be valid and belong to this promotion

The service sylius.promotion_eligibility_checker checks all these constraints for you with the method isEligible() which returns true or false. This service uses the class CompositePromotionEligibilityChecker.

How actions are applied?¶

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!

Everything related to this subject is located in Sylius\Component\Promotion\Action.

Actions¶

Actions can be created by implementing PromotionActionCommandInterface. This interface provides the method execute which aim is to apply a promotion to its subject. It also provides the method getConfigurationFormType which has to return the form name related to this action.

Actions have to be defined as services and have to use the tag named sylius.promotion_action with the attributes type and label.

As SyliusPromotionBundle is totally independent, it does not provide actions out of the box.

Note

Sylius\Component\Core\Promotion\Action\FixedDiscountPromotionActionCommand from Sylius/Sylius-Standard is an example of action for a fixed amount discount. The related service is called sylius.promotion_action.fixed_discount.

Note

Sylius\Component\Core\Promotion\Action\PercentageDiscountPromotionActionCommand from Sylius/Sylius-Standard is an example of action for a discount based on percentage. The related service is called sylius.promotion_action.percentage_discount.

Learn more about actions in the promotions concept documentation and in the Cookbook.

Applying actions to promotions¶

We have seen above how actions can be created. Now let’s see how they are applied to their subject.

The PromotionApplicator is responsible of this via its method apply. This method will execute all the registered actions of a promotion on a subject.

How promotions are applied?¶

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!

By using the promotion eligibility checker and the promotion applicator checker services, the promotion processor applies all the possible promotions on a subject.

The promotion processor is defined via the service sylius.promotion_processor which uses the class Sylius\Component\Promotion\Processor\PromotionProcessor. Basically, it calls the method apply of the promotion applicator for all the active promotions that are eligible to the given subject.

Coupon based promotions¶

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!

Coupon based promotions require special needs that are covered by this documentation.

Coupon generator¶

SyliusPromotionBundle provides a way of generating coupons for a promotion : the coupon generator. Provided as a service sylius.promotion_coupon_generator via the class Sylius\Component\Promotion\Generator\PromotionCouponGenerator, its goal is to generate unique coupon codes.

PromotionCoupon controller¶

The Sylius\Bundle\PromotionBundle\Controller\PromotionCouponController provides a method for generating new coupons.

Summary¶

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!

sylius_promotion:
    driver: doctrine/orm
    resources:
        promotion_subject:
            classes:
                model: Sylius\Component\Core\Model\Order
        promotion:
            classes:
                model:      Sylius\Component\Promotion\Model\Promotion
                interface:  Sylius\Component\Promotion\Model\PromotionInterface
                controller: Sylius\Bundle\ResourceBundle\Controller\ResourceController
                repository: ~
                factory:    Sylius\Component\Resource\Factory\Factory
                form: Sylius\Bundle\PromotionBundle\Form\Type\PromotionType
        promotion_rule:
            classes:
                factory: Sylius\Component\Core\Factory\PromotionRuleFactory
                model: Sylius\Component\Promotion\Model\PromotionRule
                interface: Sylius\Component\Promotion\Model\PromotionRuleInterface
                controller: Sylius\Bundle\ResourceBundle\Controller\ResourceController
                repository: ~
                form: Sylius\Bundle\PromotionBundle\Form\Type\PromotionRuleType
        promotion_coupon:
            classes:
                model:      Sylius\Component\Promotion\Model\PromotionAction
                interface:  Sylius\Component\Promotion\Model\PromotionActionInterface
                controller: Sylius\Bundle\ResourceBundle\Controller\ResourceController
                repository: ~
                factory:    Sylius\Component\Resource\Factory\Factory
                form: Sylius\Bundle\PromotionBundle\Form\Type\PromotionActionType
        promotion_action:
            classes:
                model:      Sylius\Component\Promotion\Model\Coupon
                interface:  Sylius\Component\Promotion\Model\CouponInterface
                controller: Sylius\Bundle\PromotionBundle\Controller\PromotionCouponController
                repository: ~
                factory:    Sylius\Component\Resource\Factory\Factory
                form: Sylius\Bundle\PromotionBundle\Form\Type\PromotionActionType

Bug tracking¶

This bundle uses GitHub issues. If you have found bug, please create an issue.

Learn more¶

Promotions in the Sylius platform - concept documentation

SyliusShippingBundle¶

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!

SyliusShippingBundle is the shipment management component for Symfony e-commerce applications.

If you need to manage shipments, shipping methods and deal with complex cost calculation, this bundle can help you a lot!

Your products or whatever you need to deliver, can be categorized under unlimited set of categories. You can display appropriate shipping methods available to the user, based on object category, weight, dimensions and anything you can imagine.

Flexible shipping cost calculation system allows you to create your own calculator services.

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, a dependency manager for PHP. Use the following command to add the bundle to your composer.json and download package.

If you have Composer installed globally.

composer require sylius/shipping-bundle

Otherwise you have to download .phar file.

curl -sS https://getcomposer.org/installer | php
php composer.phar require sylius/shipping-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. Don’t worry, everything was automatically installed via Composer.

<?php

// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        new winzou\Bundle\StateMachineBundle\winzouStateMachineBundle(),
        new FOS\RestBundle\FOSRestBundle(),
        new JMS\SerializerBundle\JMSSerializerBundle(),
        new Stof\DoctrineExtensionsBundle\StofDoctrineExtensionsBundle(),
        new BabDev\PagerfantaBundle\BabDevPagerfantaBundle(),
        new Sylius\Bundle\ShippingBundle\SyliusShippingBundle(),
        new Sylius\Bundle\ResourceBundle\SyliusResourceBundle(),

        // Other bundles...
        new Doctrine\Bundle\DoctrineBundle\DoctrineBundle(),
    );
}

Container configuration¶

Put this configuration inside your app/config/config.yml.

sylius_shipping:
    driver: doctrine/orm # Configure the Doctrine ORM driver used in documentation.

Configure doctrine extensions which are used by this bundle.

stof_doctrine_extensions:
    orm:
        default:
            timestampable: true

Routing configuration¶

Add the following to your config/routes.yaml.

sylius_shipping:
    resource: "@SyliusShipping/Resources/config/routing.yml"

Updating database schema¶

Run the following command.

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.

The ShippableInterface¶

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!

In order to handle your merchandise through the Sylius shipping engine, your models need to implement ShippableInterface.

Implementing the interface¶

Let’s assume that you have a Book entity in your application.

First step is to implement the simple interface, which contains few simple methods.

namespace Acme\Bundle\ShopBundle\Entity;

use Sylius\Component\Shipping\Model\ShippableInterface;
use Sylius\Component\Shipping\Model\ShippingCategoryInterface;

class Book implements ShippableInterface
{
    private $shippingCategory;

    public function getShippingCategory()
    {
        return $this->shippingCategory;
    }

    public function setShippingCategory(ShippingCategoryInterface $shippingCategory) // This method is not required.
    {
        $this->shippingCategory = $shippingCategory;

        return $this;
    }

    public function getShippingWeight()
    {
        // return integer representing the object weight.
    }

    public function getShippingWidth()
    {
        // return integer representing the book width.
    }

    public function getShippingHeight()
    {
        // return integer representing the book height.
    }

    public function getShippingDepth()
    {
        // return integer representing the book depth.
    }
}

Second and last task is to define the relation inside Resources/config/doctrine/Book.orm.xml of your bundle.

<?xml version="1.0" encoding="UTF-8"?>

<doctrine-mapping xmlns="http://doctrine-project.org/schemas/orm/doctrine-mapping"
                  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                  xsi:schemaLocation="http://doctrine-project.org/schemas/orm/doctrine-mapping
                                      http://doctrine-project.org/schemas/orm/doctrine-mapping.xsd">

    <entity name="Acme\ShopBundle\Entity\Book" table="acme_book">
        <!-- your mappings... -->

        <many-to-one field="shippingCategory" target-entity="Sylius\Bundle\ShippingBundle\Model\ShippingCategoryInterface">
            <join-column name="shipping_category_id" referenced-column-name="id" nullable="false" />
        </many-to-one>
    </entity>

</doctrine-mapping>

Done! Now your Book model can be used in Sylius shippingation engine.

Forms¶

If you want to add a shipping category selection field to your model form, simply use the sylius_shipping_category_choice type.

namespace Acme\ShopBundle\Form\Type;

use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\Form\AbstractType;

class BookType extends AbstractType
{
    public function buildForm(FormBuilderInterface $builder, array $options)
    {
        $builder
            ->add('title', 'text')
            ->add('shippingCategory', 'sylius_shipping_category_choice')
        ;
    }
}

The ShippingSubjectInterface¶

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!

The find available shipping methods or calculate shipping cost you need to use object implementing ShippingSubjectInterface.

The default Shipment model is already implementing ShippingSubjectInterface.

Interface methods¶

The getShippingMethod returns a ShippingMethodInterface instance, representing the method.
The getShippingItemCount provides you with the count of items to ship.
The getShippingItemTotal returns the total value of shipment, if applicable. The default Shipment model returns 0.
The getShippingWeight returns the total shipment weight.
The getShippables returns a collection of unique ShippableInterface instances.

The Shipping Categories¶

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!

Every shippable object needs to have a shipping category assigned. The ShippingCategory model is extremely simple and described below.

Attribute	Description
id	Unique id of the shipping category
name	Name of the shipping category
description	Human friendly description of the classification
createdAt	Date when the category was created
updatedAt	Date of the last shipping category update

The Shipping Method¶

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!

ShippingMethod model represents the way that goods need to be shipped. An example of shipping method may be “DHL Express” or “FedEx World Shipping”.

Attribute	Description
id	Unique id of the shipping method
name	Name of the shipping method
category	Reference to ShippingCategory (optional)
categoryRequirement	Category requirement
calculator	Name of the cost calculator
configuration	Configuration for the calculator
createdAt	Date when the method was created
updatedAt	Date of the last shipping method update

Calculating shipping cost¶

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!

Calculating shipping cost is as simple as using the sylius.shipping_calculator service and calling calculate method on ShippingSubjectInterface.

Let’s calculate the cost of existing shipment.

public function myAction()
{
    $calculator = $this->get('sylius.shipping_calculator');
    $shipment = $this->get('sylius.repository.shipment')->find(5);

    echo $calculator->calculate($shipment); // Returns price in cents. (integer)
}

What has happened?

The delegating calculator gets the ShippingMethod from the ShippingSubjectInterface (Shipment).
Appropriate Calculator instance is loaded, based on the ShippingMethod.calculator parameter.
The calculate(ShippingSubjectInterface, array $configuration) is called, where configuration is taken from ShippingMethod.configuration attribute.

Default calculators¶

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!

Default calculators can be sufficient solution for many use cases.

Flat rate¶

The flat_rate calculator, charges concrete amount per shipment.

Per item rate¶

The per_item_rate calculator, charges concrete amount per shipment item.

More calculators¶

Depending on community contributions and Sylius resources, more default calculators can be implemented, for example weight_range_rate.

Custom calculators¶

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!

Sylius ships with several default calculators, but you can easily register your own.

Simple calculators¶

All shipping cost calculators implement CalculatorInterface. In our example we’ll create a calculator which calls an external API to obtain the shipping cost.

<?php
# src/Shipping/Calculator/DHLCalculator.php

declare(strict_types=1);

namespace App\Shipping\Calculator;

use Sylius\Component\Shipping\Calculator\CalculatorInterface;
use Sylius\Component\Shipping\Model\ShipmentInterface;

final class DHLCalculator implements CalculatorInterface
{
    /**
     * @var DHLService
     */
    private $dhlService;

    /**
     * @param DHLService $dhlService
     */
    public function __construct(DHLService $dhlService)
    {
        $this->dhlService = $dhlService;
    }

    /**
     * {@inheritdoc}
     */
    public function calculate(ShipmentInterface $subject, array $configuration): int
    {
        return $this->dhlService->getShippingCostForWeight($subject->getShippingWeight());
    }

    /**
     * {@inheritdoc}
     */
    public function getType(): string
    {
        return 'dhl';
    }
}

Now, you need to register your new service in container and tag it with sylius.shipping_calculator.

services:
    app.shipping_calculator.dhl:
        class: App\Shipping\Calculator\DHLCalculator
        arguments: ['@app.dhl_service']
        tags:
            - { name: sylius.shipping_calculator, calculator: dhl, label: "DHL" }

That would be all. This new option (“DHL”) will appear on the ShippingMethod creation form, in the “calculator” field.

Configurable calculators¶

You can also create configurable calculators, meaning that you can have several ShippingMethod’s using same type of calculator, with different settings.

Let’s modify the DHLCalculator, so that it charges 0 if shipping more than X items. First step is to create a form type which will be displayed if our calculator is selected.

<?php
# src/Form/Type/Shipping/Calculator/DHLConfigurationType.php

declare(strict_types=1);

namespace App\Form\Type\Shipping\Calculator;

use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\Extension\Core\Type\IntegerType;
use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\OptionsResolver\OptionsResolver;
use Symfony\Component\Validator\Constraints\NotBlank;
use Symfony\Component\Validator\Constraints\Type;

final class DHLConfigurationType extends AbstractType
{
    /**
     * {@inheritdoc}
     */
    public function buildForm(FormBuilderInterface $builder, array $options): void
    {
        $builder
            ->add('limit', IntegerType::class, [
                'label' => 'Free shipping above total items',
                'constraints' => [
                    new NotBlank(),
                    new Type(['type' => 'integer']),
                ]
            ])
        ;
    }

    /**
     * {@inheritdoc}
     */
    public function configureOptions(OptionsResolver $resolver): void
    {
        $resolver
            ->setDefaults([
                'data_class' => null,
                'limit' => 10,
            ])
            ->setAllowedTypes('limit', 'integer')
        ;
    }

    /**
     * {@inheritdoc}
     */
    public function getBlockPrefix(): string
    {
        return 'app_shipping_calculator_dhl';
    }
}

We also need to register the form type in the container and set this form type in the definition of the calculator.

services:
    app.shipping_calculator.dhl:
        class: App\Shipping\Calculator\DHLCalculator
        arguments: ['@app.dhl_service']
        tags:
            - { name: sylius.shipping_calculator, calculator: dhl, form_type: App\Form\Type\Shipping\Calculator\DHLConfigurationType, label: "DHL" }

    app.form.type.shipping_calculator.dhl:
        class: App\Form\Type\Shipping\Calculator\DHLConfigurationType
        tags:
            - { name: form.type }

Perfect, now we’re able to use the configuration inside the calculate method.

<?php
# src/Shipping/Calculator/DHLCalculator.php

declare(strict_types=1);

namespace App\Shipping\Calculator;

use Sylius\Component\Shipping\Calculator\CalculatorInterface;
use Sylius\Component\Shipping\Model\ShipmentInterface;

final class DHLCalculator implements CalculatorInterface
{
    /**
     * @var DHLService
     */
    private $dhlService;

    /**
     * @param DHLService $dhlService
     */
    public function __construct(DHLService $dhlService)
    {
        $this->dhlService = $dhlService;
    }

    /**
     * {@inheritdoc}
     */
    public function calculate(ShipmentInterface $subject, array $configuration): int
    {
        if ($subject->getShippingUnitCount() > $configuration['limit']) {
            return 0;
        }

        return $this->dhlService->getShippingCostForWeight($subject->getShippingWeight());
    }

    /**
     * {@inheritdoc}
     */
    public function getType(): string
    {
        return 'dhl';
    }
}

Your new configurable calculator is ready to use. When you select the “DHL” calculator in ShippingMethod form, configuration fields will appear automatically.

Resolving available shipping methods¶

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!

In many use cases, you want to decide which shipping methods are available for user. Sylius has a dedicated service which serves this purpose.

ShippingMethodsResolver¶

This service also works with the ShippingSubjectInterface. To get all shipping methods which support given subject, simply call the getSupportedMethods function.

public function myAction()
{
    $resolver = $this->get('sylius.shipping_methods_resolver');
    $shipment = $this->get('sylius.repository.shipment')->find(5);

    foreach ($resolver->getSupportedMethods($shipment) as $method) {
        echo $method->getName();
    }
}

You can also pass the criteria array to initially filter the shipping methods pool.

public function myAction()
{
    $country = $this->getUser()->getCountry();
    $resolver = $this->get('sylius.shipping_methods_resolver');
    $shipment = $this->get('sylius.repository.shipment')->find(5);

    foreach ($resolver->getSupportedMethods($shipment, array('country' => $country)) as $method) {
        echo $method->getName();
    }
}

In forms¶

To display a select field with all the available methods for given subject, you can use the sylius_shipping_method_choice type. It supports two special options, required subject and optional criteria.

<?php

class ShippingController extends Controller
{
    public function selectMethodAction(Request $request)
    {
        $shipment = $this->get('sylius.repository.shipment')->find(5);

        $form = $this->get('form.factory')->create(ShippingMethodChoiceType::class, null, array('subject' => $shipment));
    }
}

This form type internally calls the ShippingMethodsResolver service and creates a list of available methods.

Shipping method requirements¶

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!

Sylius has a very flexible system for displaying only the right shipping methods to the user.

Shipping categories¶

Every ShippableInterface can hold a reference to ShippingCategory. The ShippingSubjectInterface (or ShipmentInterface) returns a collection of shippables.

ShippingMethod has an optional shipping category setting as well as categoryRequirement which has 3 options. If this setting is set to null, categories system is ignored.

“Match any” requirement¶

With this requirement, the shipping method will support any shipment (or shipping subject) which contains at least one shippable with the same category.

“Match all” requirement¶

All shippables have to reference the same category as the ShippingMethod.

“Match none” requirement¶

None of the shippables can have the same shipping category.

Summary¶

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!

Configuration Reference¶

sylius_shipping:
    # The driver used for persistence layer.
    driver: ~
    classes:
        shipment:
            classes:
                model:      Sylius\Component\Shipping\Model\Shipment
                interface:  Sylius\Component\Shipping\Model\ShipmentInterface
                controller: Sylius\Bundle\ResourceBundle\Controller\ResourceController
                repository: ~
                factory:    Sylius\Component\Resource\Factory\Factory
                form: Sylius\Bundle\ShippingBundle\Form\Type\ShipmentType
        shipment_item:
            classes:
                model:      Sylius\Component\Shipping\Model\ShipmentItem
                interface:  Sylius\Component\Shipping\Model\ShipmentItemInterface
                controller: Sylius\Bundle\ResourceBundle\Controller\ResourceController
                repository: ~
                factory:    Sylius\Component\Resource\Factory\Factory
                form: Sylius\Bundle\ShippingBundle\Form\Type\ShipmentItemType
        shipping_method:
            classes:
                model:      Sylius\Component\Shipping\Model\ShippingMethod
                interface:  Sylius\Component\Shipping\Model\ShippingMethodInterface
                controller: Sylius\Bundle\ResourceBundle\Controller\ResourceController
                repository: ~
                factory:    Sylius\Component\Resource\Factory\Factory
                form: Sylius\Bundle\ShippingBundle\Form\Type\ShippingMethodType
            translation:
                classes:
                    model:      Sylius\Component\Shipping\Model\ShippingMethodTranslation
                    interface:  Sylius\Component\Shipping\Model\ShippingMethodTranslationInterface
                    controller: Sylius\Bundle\ResourceBundle\Controller\ResourceController
                    repository: ~
                    factory:    Sylius\Component\Resource\Factory\Factory
                    form: Sylius\Bundle\ShippingBundle\Form\Type\ShippingMethodTranslationType
        shipping_category:
            classes:
                model:      Sylius\Component\Shipping\Model\ShippingCategory
                interface:  Sylius\Component\Shipping\Model\ShippingCategoryInterface
                controller: Sylius\Bundle\ResourceBundle\Controller\ResourceController
                repository: ~
                factory:    Sylius\Component\Resource\Factory\Factory
                form: Sylius\Bundle\ShippingBundle\Form\Type\ShippingCategoryType

Bug tracking¶

This bundle uses GitHub issues. If you have found bug, please create an issue.

Learn more¶

Shipments in the Sylius platform - concept documentation

SyliusTaxationBundle¶

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!

Calculating and applying taxes is a common task for most of ecommerce applications. SyliusTaxationBundle is a reusable taxation component for Symfony. You can integrate it into your existing application and enable the tax calculation logic for any model implementing the TaxableInterface.

It supports different tax categories and customizable tax calculators - you’re able to easily implement your own calculator services. The default implementation handles tax included in and excluded from the price.

As with any Sylius bundle, you can override all the models, controllers, repositories, forms and services.

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, a dependency manager for PHP. Use the following command to add the bundle to your composer.json and download package.

If you have Composer installed globally.

composer require sylius/taxation-bundle

Otherwise you have to download .phar file.

curl -sS https://getcomposer.org/installer | php
php composer.phar require sylius/taxation-bundle

Adding required bundles to the kernel¶

First, 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.

<?php

// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        new winzou\Bundle\StateMachineBundle\winzouStateMachineBundle(),
        new FOS\RestBundle\FOSRestBundle(),
        new JMS\SerializerBundle\JMSSerializerBundle(),
        new Stof\DoctrineExtensionsBundle\StofDoctrineExtensionsBundle(),
        new BabDev\PagerfantaBundle\BabDevPagerfantaBundle(),
        new Sylius\Bundle\TaxationBundle\SyliusTaxationBundle(),
        new Sylius\Bundle\ResourceBundle\SyliusResourceBundle(),

        // Other bundles...
        new Doctrine\Bundle\DoctrineBundle\DoctrineBundle(),
    );
}

Container configuration¶

Put this configuration inside your app/config/config.yml.

sylius_taxation:
    driver: doctrine/orm # Configure the Doctrine ORM driver used in documentation.

And configure doctrine extensions which are used by this bundle:

stof_doctrine_extensions:
    orm:
        default:
            timestampable: true

Updating database schema¶

Run the following command.

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.

The TaxableInterface¶

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!

In order to calculate the taxes for a model in your application, it needs to implement the TaxableInterface It is a very simple interface, with only one method - the getTaxCategory(), as every taxable has to belong to a specific tax category.

Implementing the interface¶

Let’s assume that you have a Server entity in your application. Every server has it’s price and other parameters, but you would like to calculate the tax included in price. You could calculate the math in a simple method, but it’s not enough when you have to handle multiple tax rates, categories and zones.

First step is to implement the simple interface.

namespace AcmeBundle\Entity;

use Sylius\Component\Taxation\Model\TaxCategoryInterface;
use Sylius\Component\Taxation\Model\TaxableInterface;

class Server implements TaxableInterface
{
    private $name;
    private $taxCategory;

    public function getName()
    {
        return $this->name;
    }

    public function setName($name)
    {
        $this->name = $name;
    }

    public function getTaxCategory()
    {
        return $this->taxCategory;
    }

    public function setTaxCategory(TaxCategoryInterface $taxCategory) // This method is not required.
    {
        $this->taxCategory = $taxCategory;
    }
}

Second and last task is to define the relation inside Resources/config/doctrine/Server.orm.xml of your bundle.

<?xml version="1.0" encoding="UTF-8"?>

<doctrine-mapping xmlns="http://doctrine-project.org/schemas/orm/doctrine-mapping"
                  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                  xsi:schemaLocation="http://doctrine-project.org/schemas/orm/doctrine-mapping
                                      http://doctrine-project.org/schemas/orm/doctrine-mapping.xsd">

    <entity name="AcmeBundle\Entity\Server" table="acme_server">
        <!-- your mappings... -->

        <many-to-one field="taxCategory" target-entity="Sylius\Component\Taxation\Model\TaxCategoryInterface">
            <join-column name="tax_category_id" referenced-column-name="id" nullable="false" />
        </many-to-one>
    </entity>

</doctrine-mapping>

Done! Now your Server model can be used in Sylius taxation engine.

Forms¶

If you want to add a tax category selection field to your model form, simply use the sylius_tax_category_choice type.

namespace AcmeBundle\Form\Type;

use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\Form\AbstractType;

class ServerType extends AbstractType
{
    public function buildForm(FormBuilderInterface $builder, array $options)
    {
        $builder
            ->add('name', 'text')
            ->add('taxCategory', 'sylius_tax_category_choice')
        ;
    }

    public function getName()
    {
        return 'acme_server';
    }
}

Configuring taxation¶

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!

To start calculating taxes, we need to configure the system. In most cases, the configuration process is done via web interface, but you can also do it programatically.

Creating the tax categories¶

First step is to create a new tax category.

<?php

public function configureAction()
{
    $taxCategoryFactory = $this->container->get('sylius.factory.tax_category');
    $taxCategoryManager = $this->container->get('sylius.manager.tax_category');

    $clothingTaxCategory = $taxCategoryFactory->createNew();
    $clothingTaxCategory->setName('Clothing');
    $clothingTaxCategory->setDescription('T-Shirts and this kind of stuff.');

    $foodTaxCategory = $taxCategoryFactory->createNew();
    $foodTaxCategory->setName('Food');
    $foodTaxCategory->setDescription('Yummy!');

    $taxCategoryManager->persist($clothingTaxCategory);
    $taxCategoryManager->persist($foodTaxCategory);

    $taxCategoryManager->flush();
}

Categorizing the taxables¶

Second thing to do is to classify the taxables, in our example we’ll get two products and assign the proper categories to them.

<?php

public function configureAction()
{
    $tshirtProduct = // ...
    $bananaProduct = // ... Some logic behind loading entities.

    $taxCategoryRepository = $this->container->get('sylius.repository.tax_category');

    $clothingTaxCategory = $taxCategoryRepository->findOneBy(['name' => 'Clothing']);
    $foodTaxCategory = $taxCategoryRepository->findOneBy(['name' => 'Food']);

    $tshirtProduct->setTaxCategory($clothingTaxCategory);
    $bananaProduct->setTaxCategory($foodTaxCategory);

    // Save the product entities.
}

Configuring the tax rates¶

Finally, you have to create appropriate tax rates for each of categories.

<?php

public function configureAction()
{
    $taxCategoryRepository = $this->container->get('sylius.repository.tax_category');

    $clothingTaxCategory = $taxCategoryRepository->findOneBy(['name' => 'Clothing']);
    $foodTaxCategory = $taxCategoryRepository->findOneBy(['name' => 'Food']);

    $taxRateFactory = $this->container->get('sylius.factory.tax_rate');
    $taxRateManager = $this->container->get('sylius.repository.tax_rate');

    $clothingTaxRate = $taxRateFactory->createNew();
    $clothingTaxRate->setCategory($clothingTaxCategory);
    $clothingTaxRate->setName('Clothing Tax');
    $clothingTaxRate->setCode('CT');
    $clothingTaxRate->setAmount(0.08);
    $clothingTaxRate->setCalculator('default');

    $foodTaxRate = $taxRateFactory->createNew();
    $foodTaxRate->setCategory($foodTaxCategory);
    $foodTaxRate->setName('Food');
    $foodTaxRate->setCode('F');
    $foodTaxRate->setAmount(0.12);
    $foodTaxRate->setCalculator('default');

    $taxRateManager->persist($clothingTaxRate);
    $taxRateManager->persist($foodTaxRate);

    $taxRateManager->flush();
}

Done! See the “Calculating Taxes” chapter to see how to apply these rates.

Calculating taxes¶

Warning

When using the CoreBundle (i.e: full stack Sylius framework), the taxes are already calculated at each cart change. It is implemented by the TaxationProcessor class, which is called by the OrderTaxationListener.

In order to calculate tax amount for given taxable, we need to find out the applicable tax rate. The tax rate resolver service is available under sylius.tax_rate_resolver id, while the delegating tax calculator is accessible via sylius.tax_calculator name.

Resolving rate and using calculator¶

<?php

namespace Acme\ShopBundle\Taxation;

use Acme\ShopBundle\Entity\Order\Order;
use Sylius\Component\Taxation\Calculator\CalculatorInterface;
use Sylius\Component\Taxation\Resolver\TaxRateResolverInterface;

class TaxApplicator
{
    private $calculator;
    private $taxRateResolver;

    public function __construct(
        CalculatorInterface $calculator,
        TaxRateResolverInterface $taxRateResolver
    )
    {
        $this->calculator = $calculator;
        $this->taxRateResolver = $taxRateResolver;

    }

    public function applyTaxes(Order $order)
    {
        $tax = 0;

        foreach ($order->getItems() as $item) {
            $taxable = $item->getVariant();
            $rate = $this->taxRateResolver->resolve($taxable);

            if (null === $rate) {
                continue; // Skip this item, there is no matching tax rate.
            }

            $tax += $this->calculator->calculate($item->getTotal(), $rate);
        }

        $order->setTaxTotal($tax); // Set the calculated taxes.
    }
}

Using custom tax calculators¶

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!

Every TaxRate model holds a calculator variable with the name of the tax calculation service, used to compute the tax amount. While the default calculator should fit for most common use cases, you’re free to define your own implementation.

Creating the calculator¶

All tax calculators implement the CalculatorInterface. In our example we’ll create a simple fee calculator. First, you need to create a new class.

<?php
# src/Taxation/Calculator/FeeCalculator.php

declare(strict_types=1);

namespace App\Taxation\Calculator;

use Sylius\Component\Taxation\Calculator\CalculatorInterface;
use Sylius\Component\Taxation\Model\TaxRateInterface;

final class FeeCalculator implements CalculatorInterface
{
    /**
     * {@inheritdoc}
     */
    public function calculate(float $base, TaxRateInterface $rate): float
    {
        return $base * ($rate->getAmount() + 0.15 * 0.30);
    }
}

Now, you need to register your new service in container and tag it with sylius.tax_calculator.

services:
    app.tax_calculator.fee:
        class: App\Taxation\Calculator\FeeCalculator
        tags:
            - { name: sylius.tax_calculator, calculator: fee, label: "Fee" }

That would be all. This new option (“Fee”) will appear on the TaxRate creation form, in the “calculator” field.

Summary¶

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!

Configuration Reference¶

sylius_taxation:
    # The driver used for persistence layer.
    driver: ~
    resources:
        tax_category:
            classes:
                model:      Sylius\Component\Taxation\Model\TaxCategory
                interface:  Sylius\Component\Taxation\Model\TaxCategoryInterface
                controller: Sylius\Bundle\ResourceBundle\Controller\ResourceController
                repository: ~
                factory:    Sylius\Component\Resource\Factory\Factory
                form:       Sylius\Bundle\TaxationBundle\Form\Type\TaxCategoryType
        tax_rate:
            classes:
                model:      Sylius\Component\Taxation\Model\TaxRate
                interface:  Sylius\Component\Taxation\Model\TaxRateInterface
                controller: Sylius\Bundle\ResourceBundle\Controller\ResourceController
                repository: ~
                factory:    Sylius\Component\Resource\Factory\Factory
                form:       Sylius\Bundle\TaxationBundle\Form\Type\TaxRateType

Bug tracking¶

This bundle uses GitHub issues. If you have found bug, please create an issue.

Learn more¶

Taxation in the Sylius platform - concept documentation

SyliusTaxonomyBundle¶

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!

Flexible categorization system for Symfony applications.

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, 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.

composer require sylius/taxonomy-bundle

Otherwise you have to download .phar file.

curl -sS https://getcomposer.org/installer | php
php composer.phar require sylius/taxonomy-bundle

Note

This version is compatible only with Symfony 2.3 or newer. Please see the CHANGELOG file in the repository, to find version to use with older vendors.

Adding required bundles to the kernel¶

First, 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 the kernel. Don’t worry, everything was automatically installed via Composer.

<?php

// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        new winzou\Bundle\StateMachineBundle\winzouStateMachineBundle(),
        new FOS\RestBundle\FOSRestBundle(),
        new JMS\SerializerBundle\JMSSerializerBundle(),
        new Stof\DoctrineExtensionsBundle\StofDoctrineExtensionsBundle(),
        new BabDev\PagerfantaBundle\BabDevPagerfantaBundle(),
        new Sylius\Bundle\TaxonomyBundle\SyliusTaxonomyBundle(),
        new Sylius\Bundle\ResourceBundle\SyliusResourceBundle(),

        // Other bundles...
        new Doctrine\Bundle\DoctrineBundle\DoctrineBundle(),
    );
}

Container configuration¶

Configure doctrine extensions which are used in the taxonomy bundle:

stof_doctrine_extensions:
    orm:
        default:
            tree: true
            sluggable: true
            sortable: true

Updating database schema¶

Run the following command.

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.

Taxons¶

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!

Taxons¶

Retrieving taxons from database should always happen via repository, which implements Sylius\Bundle\ResourceBundle\Model\RepositoryInterface. If you are using Doctrine, you’re already familiar with this concept, as it extends the native Doctrine ObjectRepository interface.

Your taxon repository is always accessible via sylius.repository.taxon service.

Taxon contains methods which allow you to retrieve the child taxons. Let’s look at our example tree.

| Categories
|--  T-Shirts
|    |-- Men
|    `-- Women
|--  Stickers
|--  Mugs
`--  Books

To get a collection of child taxons under taxon, use the findChildren method.

<?php

class MyActionController
{
    public function myAction(Request $request)
    {
        // Find the parent taxon
        $taxonRepository = $this->container->get('sylius.repository.taxon');
        $taxon = $taxonRepository->findOneByName('Categories');

        $taxonRepository = $this->container->get('sylius.repository.taxon');
        $taxons = $taxonRepository->findChildren($taxon);
    }
}

$taxons variable will now contain a list (ArrayCollection) of taxons in following order: T-Shirts, Men, Women, Stickers, Mugs, Books.

Categorization¶

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!

In this example, we will use taxonomies to categorize products and build a nice catalog.

We think that keeping the app-specific bundle structure simple is a good practice, so let’s assume you have your ShopBundle registered under Acme\ShopBundle namespace.

<?php

// src/Acme/ShopBundle/Entity/Product.php
namespace Acme\ShopBundle\Entity;

use Doctrine\ORM\Mapping as ORM;
use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Collection;

class Product
{
    protected $taxons;

    public function __construct()
    {
        $this->taxons = new ArrayCollection();
    }

    public function getTaxons()
    {
        return $this->taxons;
    }

    public function setTaxons(Collection $taxons)
    {
        $this->taxons = $taxons;
    }
}

You also need to define the doctrine mapping with a many-to-many relation between Product and Taxons. Your product entity mapping should live inside Resources/config/doctrine/Product.orm.xml of your bundle.

<?xml version="1.0" encoding="UTF-8"?>

<doctrine-mapping xmlns="http://doctrine-project.org/schemas/orm/doctrine-mapping"
                  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                  xsi:schemaLocation="http://doctrine-project.org/schemas/orm/doctrine-mapping
                                      http://doctrine-project.org/schemas/orm/doctrine-mapping.xsd">

    <entity name="Acme\ShopBundle\Entity\Product" table="sylius_product">
        <id name="id" column="id" type="integer">
            <generator strategy="AUTO" />
        </id>

        <!-- Your other mappings. -->

        <many-to-many field="taxons" target-entity="Sylius\Component\Taxonomy\Model\TaxonInterface">
            <join-table name="sylius_product_taxon">
                <join-columns>
                    <join-column name="product_id" referenced-column-name="id" nullable="false" />
                </join-columns>
                <inverse-join-columns>
                    <join-column name="taxon_id" referenced-column-name="id" nullable="false" />
                </inverse-join-columns>
            </join-table>
        </many-to-many>
    </entity>

</doctrine-mapping>

Product is just an example where we have many to many relationship with taxons, which will make it possible to categorize products and list them by taxon later.

You can classify any other model in your application the same way.

Creating your forms¶

To be able to apply taxonomies on your products, or whatever you are categorizing or tagging, it is handy to use sylius_taxon_choice form type:

<?php

// src/Acme/ShopBundle/Form/ProductType.php
namespace Acme\ShopBundle\Form;

use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\OptionsResolver\OptionsResolver;

class ProductType extends AbstractType
{
    public function buildForm(FormBuilderInterface $builder, array $options)
    {
        $builder->add('taxons', 'sylius_taxon_choice');
    }

    public function configureOptions(OptionsResolver $resolver)
    {
        $resolver
            ->setDefaults(array(
                'data_class' => 'Acme\ShopBundle\Entity\Product'
            ))
        ;
    }
}

This sylius_taxon_choice type will add a select input field for each taxonomy, with select option for each taxon.

Summary¶

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!

Configuration Reference¶

sylius_taxonomy:
    # The driver used for persistence layer.
    driver: ~
    resources:
        taxon:
            classes:
                model:      Sylius\Component\Taxonomy\Model\Taxon
                interface:  Sylius\Component\Taxonomy\Model\TaxonInterface
                controller: Sylius\Bundle\ResourceBundle\Controller\ResourceController
                repository: ~
                factory:    Sylius\Component\Resource\Factory\TranslatableFactory
                form: Sylius\Bundle\TaxonomyBundle\Form\Type\TaxonType
            translation:
                classes:
                    model:      Sylius\Component\Taxonomy\Model\TaxonTranslation
                    interface:  Sylius\Component\Taxonomy\Model\TaxonTranslationInterface
                    controller: Sylius\Bundle\ResourceBundle\Controller\ResourceController
                    repository: ~
                    factory:    Sylius\Component\Resource\Factory\Factory
                    form: Sylius\Bundle\TaxonomyBundle\Form\Type\TaxonTranslationType

Bug tracking¶

This bundle uses GitHub issues. If you have found bug, please create an issue.

Learn more¶

Taxons in the Sylius platform - concept documentation

SyliusUserBundle¶

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!

A solution for user management system inside of a Symfony application.

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, 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.

composer require sylius/user-bundle

Otherwise you have to download .phar file.

curl -sS https://getcomposer.org/installer | php
php composer.phar require sylius/user-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.

<?php

// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        new FOS\RestBundle\FOSRestBundle(),
        new JMS\SerializerBundle\JMSSerializerBundle(),
        new Stof\DoctrineExtensionsBundle\StofDoctrineExtensionsBundle(),
        new BabDev\PagerfantaBundle\BabDevPagerfantaBundle(),
        new Bazinga\Bundle\HateoasBundle\BazingaHateoasBundle(),
        new winzou\Bundle\StateMachineBundle\winzouStateMachineBundle(),
        new Sylius\Bundle\ResourceBundle\SyliusResourceBundle(),
        new Sylius\Bundle\MailerBundle\SyliusMailerBundle(),
        new Sylius\Bundle\UserBundle\SyliusUserBundle(),

        // Other bundles...
        new Doctrine\Bundle\DoctrineBundle\DoctrineBundle(),
    );
}

Configure Doctrine extensions¶

Configure doctrine extensions which are used by the bundle.

# app/config/config.yml
stof_doctrine_extensions:
    orm:
        default:
            timestampable: true

Updating database schema¶

Run the following command.

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.

Summary¶

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!

Configuration reference¶

sylius_user:
    driver: doctrine/orm
    resources:
        admin:
            user:
                classes:
                    model: Sylius\Component\Core\Model\AdminUser
                    repository: Sylius\Bundle\UserBundle\Doctrine\ORM\UserRepository
                    form: Sylius\Bundle\CoreBundle\Form\Type\User\AdminUserType
                    interface: Sylius\Component\User\Model\UserInterface
                    controller: Sylius\Bundle\UserBundle\Controller\UserController
                    factory: Sylius\Component\Resource\Factory\Factory
                templates: 'SyliusUserBundle:User'
                resetting:
                    token:
                        ttl: P1D
                        length: 16
                        field_name: passwordResetToken
                    pin:
                        length: 4
                        field_name: passwordResetToken
                verification:
                    token:
                        length: 16
                        field_name: emailVerificationToken
        shop:
            user:
                classes:
                    model: Sylius\Component\Core\Model\ShopUser
                    repository: Sylius\Bundle\CoreBundle\Doctrine\ORM\UserRepository
                    form: Sylius\Bundle\CoreBundle\Form\Type\User\ShopUserType
                    interface: Sylius\Component\User\Model\UserInterface
                    controller: Sylius\Bundle\UserBundle\Controller\UserController
                    factory: Sylius\Component\Resource\Factory\Factory
                templates: 'SyliusUserBundle:User'
                resetting:
                    token:
                        ttl: P1D
                        length: 16
                        field_name: passwordResetToken
                    pin:
                        length: 4
                        field_name: passwordResetToken
                verification:
                    token:
                        length: 16
                        field_name: emailVerificationToken
        oauth:
            user:
                classes:
                    model: Sylius\Component\User\Model\UserOAuth
                    interface: Sylius\Component\User\Model\UserOAuthInterface
                    controller: Sylius\Bundle\ResourceBundle\Controller\ResourceController
                    factory: Sylius\Component\Resource\Factory\Factory
                    form: Sylius\Bundle\UserBundle\Form\Type\UserType
                templates: 'SyliusUserBundle:User'
                resetting:
                    token:
                        ttl: P1D
                        length: 16
                        field_name: passwordResetToken
                    pin:
                        length: 4
                        field_name: passwordResetToken
                verification:
                    token:
                        length: 16
                        field_name: emailVerificationToken

Bug tracking¶

This bundle uses GitHub issues. If you have found bug, please create an issue.

Learn more¶

Users & Customers in the Sylius platform - concept documentation

Sylius Components Documentation¶

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 provide a set of well-tested and decoupled PHP libraries.

The components are the foundation of the Sylius platform, but they can also be used standalone with any PHP application even if you use a framework different than Symfony.

These packages solve common E-Commerce and web application problems. Have a look around this documentation to see if you will find them useful!

We recommend checking out Components General Guide, which will get you started in minutes.

Components General Guide¶

All Sylius components have very similar structure and this guide will introduce you these conventions.

Through this documentation, you will learn how to install and use them in any PHP application.

How to Install and Use the Sylius Components¶

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 Taxation, though this applies to using any component.

Using the Taxation Component¶

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

mkdir project/
cd project/

2. Open a terminal and use Composer to grab the library.

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 sylius/taxation.

composer require sylius/taxation

The name sylius/taxation is written at the top of the documentation for whatever component you want.

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. Open your favorite code editor and start coding:

<?php

// Sample script.php file.

require_once __DIR__.'/vendor/autoload.php';

use Sylius\Component\Taxation\Calculator\DefaultCalculator;
use Sylius\Component\Taxation\Model\TaxRate;

$calculator = new DefaultCalculator();

$taxRate = new TaxRate();
$taxRate->setAmount(0.23);

$taxAmount = $calculator->calculate(100, $taxRate);

echo $taxAmount; // Outputs "23".

You can open the “script.php” file in browser or run it via console:

php script.php

Using all of the Components¶

If you want to use all of the Sylius Components, then instead of adding them one by one, you can include the sylius/sylius package:

composer require sylius/sylius

Now what?¶

Check out What is a Resource?, which will give you basic understanding about how all Sylius components look and work like.

Enjoy!

What is a Resource?¶

We refer to data models as “Resources”. In the simplest words, some examples that you will find in Sylius:

Product
TaxRate
Order
OrderItem
ShippingMethod
PaymentMethod

As you can already guess, there are many more Resources in Sylius. It is a really simple but powerful concept that allows us to create a nice abstraction to handle all the complex logic of E-Commerce. When using Components, you will have access to the resources provided by them out-of-the-box.

What is more, you will be able to create your own, custom Resources and benefit from all features provided by Sylius.

Now what?¶

Learn how we handle Creating Resources via Factory pattern.

Creating Resources¶

Every resource provided by a Sylius component should be created via a factory.

Some resources use the default resource class while some use custom implementations to provide extra functionality.

Using Factory To Create New Resource¶

To create new resources you should use the default factory implementation.

<?php

use Sylius\Component\Product\Model\Product;
use Sylius\Component\Resource\Factory\Factory;

$factory = new Factory(Product::class);

$product = $factory->createNew();

That’s it! The $product variable will hold a clean instance of the Product model.

Why Even Bother?¶

“Hey! This is same as $product = new Product();!”

Yes, and no. Every Factory implements FactoryInterface and this allows you to abstract the way that resources are created. It also makes testing much simpler because you can mock the Factory and use it as a test double in your service.

What is more, thanks to usage of Factory pattern, Sylius is able to easily swap the default Product (or any other resource) model with your custom implementation, without changing code.

Note

For more detailed information go to Sylius API Factory.

Caution

In a concrete Component’s documentation we will use new keyword to create resources - just to keep things simpler to read.

Addressing¶

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!

Sylius Addressing component for PHP E-Commerce applications which provides you with basic Address, Country, Province and Zone models.

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!

You can install the component in 2 different ways:

Install it via Composer (sylius/addressing on Packagist);
Use the official Git repository (https://github.com/Sylius/Addressing).

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 Sylius component.

Basic Usage¶

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!

ZoneMatcher¶

Zones are not very useful by themselves, but they can take part in e.g. a complex taxation/shipping system. This service is capable of getting a Zone specific for given Address.

It uses a collaborator implementing Doctrine’s ObjectRepository interface to obtain all available zones, compare them with given Address and return best fitted Zone.

First lets make some preparations.

<?php

use Sylius\Component\Addressing\Model\Address;
use Sylius\Component\Addressing\Model\Zone;
use Sylius\Component\Addressing\Model\ZoneInterface;
use Sylius\Component\Addressing\Model\ZoneMember;
use Sylius\Component\Resource\Repository\InMemoryRepository;

$zoneRepository = new InMemoryRepository(ZoneInterface::class);
$zone = new Zone();
$zoneMember = new ZoneMember();

$address = new Address();
$address->setCountry('US');

$zoneMember->setCode('US');
$zoneMember->setBelongsTo($zone);

$zone->addMember($zoneMember);

$zoneRepository->add($zone);

Now that we have all the needed parts lets match something.

<?php

use Sylius\Component\Addressing\Matcher\ZoneMatcher;

$zoneMatcher = new ZoneMatcher($zoneRepository);

$zoneMatcher->match($address); // returns the best matching zone
                               // for the address given, in this case $zone

ZoneMatcher can also return all zones containing given Address.

<?php

$zoneMatcher->matchAll($address); // returns all zones containing given $address

To be more specific you can provide a scope which will narrow the search only to zones with same corresponding property.

<?php

$zone->setScope('earth');

$zoneMatcher->match($address, 'earth'); // returns $zone
$zoneMatcher->matchAll($address, 'mars'); // returns null as there is no
                                          // zone with 'mars' scope

Note

This service implements the ZoneMatcherInterface.

Caution

Throws \InvalidArgumentException.

Models¶

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!

Address¶

The customer’s address is represented by an Address model. It should contain all data concerning customer’s address and as default has the following properties:

Property	Description
id	Unique id of the address
firstName	Customer’s first name
lastName	Customer’s last name
phoneNumber	Customer’s phone number
company	Company name
country	Country’s ISO code
province	Province’s code
street	Address’ street
city	Address’ city
postcode	Address’ postcode
createdAt	Date when address was created
updatedAt	Date of last address’ update

Note

This model implements the AddressInterface.

For more detailed information go to Sylius API Address.

Country¶

The geographical area of a country is represented by a Country model. It should contain all data concerning a country and as default has the following properties:

Property	Description
id	Unique id of the country
code	Country’s ISO code
provinces	Collection of Province objects
enabled	Indicates whether country is enabled

Note

This model implements the CountryInterface and CodeAwareInterface.

For more detailed information go to Sylius API Country.

Province¶

Smaller area inside a country is represented by a Province model. You can use it to manage provinces or states and assign it to an address as well. It should contain all data concerning a province and as default has the following properties:

Property	Description
id	Unique id of the province
code	Unique code of the province
name	Province’s name
country	The Country this province is assigned to

Note

This model implements the ProvinceInterface and CodeAwareInterface.

For more detailed information go to Sylius API Province.

Zone¶

The geographical area is represented by a Zone model. It should contain all data concerning a zone and as default has the following properties:

Property	Description
id	Unique id of the zone
code	Unique code of the zone
name	Zone’s name
type	Zone’s type
scope	Zone’s scope
members	All of the ZoneMember objects assigned to this zone

Note

This model implements the ZoneInterface and CodeAwareInterface.

For more detailed information go to Sylius API Zone.

ZoneMember¶

In order to add a specific location to a Zone, an instance of ZoneMember must be created with that location’s code. On default this model has the following properties:

Property	Description
id	Unique id of the zone member
code	Unique code of affiliated member i.e. country’s code
belongsTo	The Zone this member is assigned to

Note

This model implements ZoneMemberInterface and CodeAwareInterface.

For more detailed information go to Sylius API ZoneMember.

Interfaces¶

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!

Model Interfaces¶

AddressInterface¶

This interface should be implemented by models representing the customer’s address.

Note

This interface extends TimestampableInterface.

For more detailed information go to Sylius API AddressInterface.

CountryInterface¶

This interfaces should be implemented by models representing a country.

Note

This interface extends ToggleableInterface.

For more detailed information go to Sylius API CountryInterface.

ProvinceInterface¶

This interface should be implemented by models representing a part of a country.

Note

For more detailed information go to Sylius API ProvinceInterface.

ZoneInterface¶

This interface should be implemented by models representing a single zone.

It also holds all the Zone Types.

Note

For more detailed information go to Sylius API ZoneInterface.

ZoneMemberInterface¶

This interface should be implemented by models that represent an area a specific zone contains, e.g. all countries in the European Union.

Note

For more detailed information go to Sylius API ZoneMemberInterface.

Service Interfaces¶

RestrictedZoneCheckerInterface¶

A service implementing this interface should be able to check if given Address is in a restricted zone.

Note

For more detailed information go to Sylius API RestrictedZoneCheckerInterface.

ZoneMatcherInterface¶

This interface should be implemented by a service responsible of finding the best matching zone, and all zones containing the provided Address.

Note

For more detailed information go to Sylius API ZoneMatcherInterface.

Zone Types¶

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!

There are three zone types available by default:

Related constant	Type
TYPE_COUNTRY	country
TYPE_PROVINCE	province
TYPE_ZONE	zone

Note

All of the above types are constant fields in the ZoneInterface.

Learn more¶

Addresses in the Sylius platform - concept documentation

Attribute¶

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!

Handling of dynamic attributes on PHP models is a common task for most of modern business applications. Sylius component makes it easier to handle different types of attributes and attach them to any object by implementing a simple interface.

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!

You can install the component in 2 different ways:

Install it via Composer (sylius/attribute on Packagist).
Use the official Git repository (https://github.com/Sylius/Attribute).

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 Sylius component.

Basic Usage¶

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!

Creating an attributable class¶

In the following example you will see a minimalistic implementation of the AttributeSubjectInterface.

<?php

namespace App\Model;

use Sylius\Component\Attribute\Model\AttributeSubjectInterface;
use Sylius\Component\Attribute\Model\AttributeValueInterface;
use Doctrine\Common\Collections\Collection;

class Shirt implements AttributeSubjectInterface
{
    /**
     * @var AttributeValueInterface[]
     */
    private $attributes;

    /**
     * {@inheritdoc}
     */
    public function getAttributes()
    {
        return $this->attributes;
    }

    /**
     * {@inheritdoc}
     */
    public function setAttributes(Collection $attributes)
    {
        foreach ($attributes as $attribute) {
            $this->addAttribute($attribute);
        }
    }

    /**
     * {@inheritdoc}
     */
    public function addAttribute(AttributeValueInterface $attribute)
    {
        if (!$this->hasAttribute($attribute)) {
            $attribute->setSubject($this);
            $this->attributes[] = $attribute;
        }
    }

    /**
     * {@inheritdoc}
     */
    public function removeAttribute(AttributeValueInterface $attribute)
    {
        if ($this->hasAttribute($attribute)){
            $attribute->setSubject(null);
            $key = array_search($attribute, $this->attributes);
            unset($this->attributes[$key]);
        }
    }

    /**
     * {@inheritdoc}
     */
    public function hasAttribute(AttributeValueInterface $attribute)
    {
        return in_array($attribute, $this->attributes);
    }

    /**
     * {@inheritdoc}
     */
    public function hasAttributeByName($attributeName)
    {
        foreach ($this->attributes as $attribute) {
            if ($attribute->getName() === $attributeName) {
                return true;
            }
        }

        return false;
    }

    /**
     * {@inheritdoc}
     */
    public function getAttributeByName($attributeName)
    {
        foreach ($this->attributes as $attribute) {
            if ($attribute->getName() === $attributeName) {
                return $attribute;
            }
        }

        return null;
    }

    /**
     * {@inheritdoc}
     */
    public function hasAttributeByCodeAndLocale($attributeCode, $localeCode = null)
    {

    }

    /**
     * {@inheritdoc}
     */
    public function getAttributeByCodeAndLocale($attributeCode, $localeCode = null)
    {

    }
}

Note

An implementation similar to the one above has been done in the Product model.

Adding attributes to an object¶

Once we have our class we can characterize it with attributes.

<?php

use App\Model\Shirt;
use Sylius\Component\Attribute\Model\Attribute;
use Sylius\Component\Attribute\Model\AttributeValue;
use Sylius\Component\Attribute\AttributeType\TextAttributeType;
use Sylius\Component\Attribute\Model\AttributeValueInterface;

$attribute = new Attribute();
$attribute->setName('Size');
$attribute->setType(TextAttributeType::TYPE);
$attribute->setStorageType(AttributeValueInterface::STORAGE_TEXT);

$smallSize = new AttributeValue();
$mediumSize = new AttributeValue();

$smallSize->setAttribute($attribute);
$mediumSize->setAttribute($attribute);

$smallSize->setValue('S');
$mediumSize->setValue('M');

$shirt = new Shirt();

$shirt->addAttribute($smallSize);
$shirt->addAttribute($mediumSize);

Or you can just add all attributes needed using a class implementing Doctrine’s Collection interface, e.g. the ArrayCollection class.

Warning

Beware! It’s really important to set proper attribute storage type, which should reflect value type that is set in AttributeValue.

<?php

use Doctrine\Common\Collections\ArrayCollection;

$attributes = new ArrayCollection();

$attributes->add($smallSize);
$attributes->add($mediumSize);

$shirt->setAttributes($attributes);

Note

Notice that you don’t actually add an Attribute to the subject, instead you need to add every AttributeValue assigned to the attribute.

Accessing attributes¶

<?php

$shirt->getAttributes(); // returns an array containing all set attributes

$shirt->hasAttribute($smallSize); // returns true
$shirt->hasAttribute($hugeSize); // returns false

Accessing attributes by name¶

<?php

$shirt->hasAttributeByName('Size'); // returns true

$shirt->getAttributeByName('Size'); // returns $smallSize

Removing an attribute¶

<?php

$shirt->hasAttribute($smallSize); // returns true

$shirt->removeAttribute($smallSize);

$shirt->hasAttribute($smallSize); // now returns false

Models¶

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!

Attribute¶

Every attribute is represented by the Attribute model which by default has the following properties:

Property	Description
id	Unique id of the attribute
type	Attribute’s type (‘text’ by default)
name	Attribute’s name
configuration	Attribute’s configuration
validation	Attribute’s validation configuration
values	Collection of attribute values
storageType	Defines how attribute value should be stored in database
createdAt	Date when attribute was created
updatedAt	Date of last attribute update

Note

This model uses the TranslatableTrait and implements the AttributeInterface.

For more detailed information go to Sylius API Attribute.

Attention

Attribute’s type is an alias of AttributeType service.

AttributeValue¶

This model binds the subject and the attribute, it is used to store the value of the attribute for the subject. It has the following properties:

Property	Description
id	Unique id of the attribute value
subject	Reference to attribute’s subject
attribute	Reference to an attribute
value	Attribute’s value (not mapped)
text	Value of attribute stored as text
boolean	Value of attribute stored as boolean
integer	Value of attribute stored as integer
float	Value of attribute stored as float
datetime	Value of attribute stored as datetime
date	Value of attribute stored as date

Attention

Value property is used only as proxy, that stores data in proper field. It’s crucial to set attribute value in field, that is mapped as attribute’s storage type.

Note

This model implements the AttributeValueInterface.

For more detailed information go to Sylius API AttributeValue.

AttributeTranslation¶

The attribute’s name for different locales is represented by the AttributeTranslation model which has the following properties:

Property	Description
id	Unique id of the attribute translation
name	Attribute’s name for given locale

Note

This model extends the AbstractTranslation class and implements the AttributeTranslationInterface.

For more detailed information go to Sylius API AttributeTranslation.

Interfaces¶

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!

Model Interfaces¶

AttributeInterface¶

This interface should be implemented by models used for describing a product’s attribute.

Note

This interface extends the TimestampableInterface and the AttributeTranslationInterface.

For more detailed information go to Sylius API AttributeInterface.

AttributeValueInterface¶

This interface should be implemented by models used for binding an Attribute with a model implementing the AttributeSubjectInterface e.g. the Product.

Note

For more detailed information go to Sylius API AttributeValueInterface.

AttributeTranslationInterface¶

This interface should be implemented by models maintaining a single translation of an Attribute for specified locale.

Note

For more detailed information go to Sylius API AttributeTranslationInterface.

AttributeSubjectInterface¶

This interface should be implemented by models you want to characterize with various AttributeValue objects.

It will ask you to implement the management of AttributeValue models.

Note

For more detailed information go to Sylius API AttributeSubjectInterface.

AttributeTypeInterface¶

This interface should be implemented by models used for describing a product’s attribute type.

Learn more¶

Attributes in the Sylius platform - concept documentation

Channel¶

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!

Sale channels management implementation in PHP.

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!

You can install the component in 2 different ways:

Install it via Composer (sylius/channel on Packagist);
Use the official Git repository (https://github.com/Sylius/Channel).

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 Sylius component.

Models¶

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!

Channel¶

Sale channel is represented by a Channel model. It should have everything concerning channel’s data and as default has the following properties:

Property	Description
id	Unique id of the channel
code	Channel’s code
name	Channel’s name
description	Channel’s description
url	Channel’s URL
color	Channel’s color
enabled	Indicates whether channel is available
createdAt	Date of creation
updatedAt	Date of update

Note

This model implements ChannelInterface.

For more detailed information go to Sylius API Channel.

Interfaces¶

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!

Model Interfaces¶

ChannelInterface¶

This interface should be implemented by every custom sale channel model.

Note

This interface extends TimestampableInterface and CodeAwareInterface.

For more detailed information go to Sylius API ChannelInterface.

ChannelAwareInterface¶

This interface should be implemented by models associated with a specific sale channel.

Note

For more detailed information go to Sylius API ChannelAwareInterface.

ChannelsAwareInterface¶

This interface should be implemented by models associated with multiple channels.

Note

For more detailed information go to Sylius API ChannelsAwareInterface.

Service Interfaces¶

Learn more¶

Channels in the Sylius platform - concept documentation

Currency¶

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!

Managing different currencies, exchange rates and converting cash amounts for PHP applications.

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!

You can install the component in 2 different ways:

Install it via Composer (sylius/currency on Packagist);
Use the official Git repository (https://github.com/Sylius/Currency).

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 Sylius component.

Basic Usage¶

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!

Getting a Currency name¶

<?php

use Sylius\Component\Currency\Model\Currency;

$currency = new Currency();
$currency->setCode('USD');

$currency->getName(); // Returns 'US Dollar'.

The getName method uses Symfony’s Intl class to convert currency’s code into a human friendly form.

Note

The output of getName may vary as the name is generated accordingly to the set locale.

CurrencyConverter¶

The CurrencyConverter allows you to convert a value accordingly to the exchange rate of specified currency.

This behaviour is used just for displaying the approximate value in another currency than the base currency of the channel.

Note

This service implements the CurrencyConverterInterface.

For more detailed information go to Sylius API CurrencyConverter.

Caution

Throws UnavailableCurrencyException.

CurrencyProvider¶

The CurrencyProvider allows you to get all available currencies.

<?php

use Sylius\Component\Currency\Provider\CurrencyProvider;
use Sylius\Component\Resource\Repository\InMemoryRepository;

$currencyRepository = new InMemoryRepository();
$currencyProvider = new CurrencyProvider($currencyRepository);

$currencyProvider->getAvailableCurrencies(); // Returns an array of Currency objects.

The getAvailableCurrencies method retrieves all currencies which enabled property is set to true and have been inserted in the given repository.

Note

This service implements the CurrencyProviderInterface.

For more detailed information go to Sylius API CurrencyProvider.

Models¶

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!

Currency¶

Every currency is represented by a Currency model which by default has the following properties:

Method	Description
id	Unique id of the currency
code	Currency’s code
createdAt	Date of creation
updatedAt	Date of last update

Note

This model implements CurrencyInterface.

For more detailed information go to Sylius API Currency.

Interfaces¶

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!

Model Interfaces¶

CurrencyInterface¶

This interface provides you with basic management of a currency’s code, name, exchange rate and whether the currency should be enabled or not.

Note

This interface extends CodeAwareInterface and TimestampableInterface.

For more detailed information go to Sylius API CurrencyInterface.

Service Interfaces¶

CurrenciesAwareInterface¶

Any container used to store, and manage currencies should implement this interface.

Note

For more detailed information go to Sylius API CurrenciesAwareInterface.

CurrencyContextInterface¶

This interface should be implemented by a service used for managing the currency name. It also contains the default storage key:

Related constant	Storage key
STORAGE_KEY	_sylius_currency

Note

For more detailed information go to Sylius API CurrencyContextInterface.

CurrencyConverterInterface¶

This interface should be implemented by any service used to convert the amount of money from one currency to another, according to their exchange rates.

Note

For more detailed information go to Sylius API CurrencyConverterInterface.

CurrencyProviderInterface¶

This interface allows you to implement one fast service which gets all available currencies from any container you would like.

Note

For more detailed information go to Sylius API CurrencyProviderInterface.

UnavailableCurrencyException¶

This exception is thrown when you try converting to a currency which is not present in the provided repository.

Note

This exception extends the \InvalidArgumentException.

Learn more¶

Currencies in the Sylius platform - concept documentation

Inventory¶

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!

Inventory management for PHP applications.

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!

You can install the component in 2 different ways:

Install it via Composer (sylius/inventory on Packagist);
Use the official Git repository (https://github.com/Sylius/Inventory).

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 Sylius component.

Basic Usage¶

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!

Stockable Object¶

The first thing you should do it is implementing stockable object. Example implementation:

<?php

class Product implements StockableInterface
{
    /**
     * Get stock keeping unit.
     *
     * @return mixed
     */
    public function getSku()
    {
        // TODO: Implement getSku() method.
    }

    /**
     * Get inventory displayed name.
     *
     * @return string
     */
    public function getInventoryName()
    {
        // TODO: Implement getInventoryName() method.
    }

    /**
     * Simply checks if there any stock available.
     *
     * @return Boolean
     */
    public function isInStock()
    {
        // TODO: Implement isInStock() method.
    }

    /**
     * Get stock on hold.
     *
     * @return integer
     */
    public function getOnHold()
    {
        // TODO: Implement getOnHold() method.
    }

    /**
     * Set stock on hold.
     *
     * @param integer
     */
    public function setOnHold($onHold)
    {
        // TODO: Implement setOnHold() method.
    }

    /**
     * Get stock on hand.
     *
     * @return integer
     */
    public function getOnHand()
    {
        // TODO: Implement getOnHand() method.
    }

    /**
     * Set stock on hand.
     *
     * @param integer $onHand
     */
    public function setOnHand($onHand)
    {
        // TODO: Implement setOnHand() method.
    }
}

InventoryOperator¶

The InventoryOperator provides basic operations on your inventory.

<?php

use Sylius\Component\Inventory\Operator\InventoryOperator;
use Sylius\Component\Inventory\Checker\AvailabilityChecker;
use Sylius\Component\Resource\Repository\InMemoryRepository;

$inMemoryRepository = new InMemoryRepository(); // Repository model.
$product = new Product(); // Stockable model.
$eventDispatcher; // It gives a possibility to hook before or after each operation.
// If you are not familiar with events, check the symfony Event Dispatcher.

$availabilityChecker = new AvailabilityChecker(false);
$inventoryOperator = new InventoryOperator($availabilityChecker, $eventDispatcher);

$product->getOnHand(); // Output will be 0.
$inventoryOperator->increase($product, 5);
$product->getOnHand(); // Output will be 5.

$product->getOnHold(); // Output will be 0.
$inventoryOperator->hold($product, 4);
$product->getOnHold(); // Output will be 4.

$inventoryOperator->release($product, 3);
$product->getOnHold(); // Output will be 1.

Decrease¶

<?php

use Sylius\Component\Inventory\Operator\InventoryOperator;
use Sylius\Component\Inventory\Checker\AvailabilityChecker;
use Doctrine\Common\Collections\ArrayCollection;
use Sylius\Component\Inventory\Model\InventoryUnit;
use Sylius\Component\Inventory\Model\InventoryUnitInterface;

$inventoryUnitRepository; // Repository model.
$product = new Product(); // Stockable model.
$eventDispatcher; // It gives possibility to hook before or after each operation.
// If you are not familiar with events. Check symfony event dispatcher.

$availabilityChecker = new AvailabilityChecker(false);
$inventoryOperator = new InventoryOperator($availabilityChecker, $eventDispatcher);
$inventoryUnit1 = new InventoryUnit();
$inventoryUnit2 = new InventoryUnit();
$inventoryUnits = new ArrayCollection();
$product->getOnHand(); // Output will be 5.

$inventoryUnit1->setStockable($product);
$inventoryUnit1->setInventoryState(InventoryUnitInterface::STATE_SOLD);

$inventoryUnit2->setStockable($product);

$inventoryUnits->add($inventoryUnit1);
$inventoryUnits->add($inventoryUnit2);

count($inventoryUnits); // Output will be 2.
$inventoryOperator->decrease($inventoryUnits);
$product->getOnHand(); // Output will be 4.

Caution

All methods in InventoryOperator throw InvalidArgumentException or InsufficientStockException if an error occurs.

Note

For more detailed information go to Sylius API InventoryOperator.

Hint

To understand how events work check Symfony EventDispatcher.

NoopInventoryOperator¶

In some cases, you may want to have unlimited inventory, this operator will allow you to do that.

Hint

This operator is based on the null object pattern. For more detailed information go to Null Object pattern.

Note

For more detailed information go to Sylius API NoopInventoryOperator.

AvailabilityChecker¶

The AvailabilityChecker checks availability of a given stockable object. To characterize an object which is an AvailabilityChecker, it needs to implement the AvailabilityCheckerInterface. Second parameter of the ->isStockSufficient() method gives a possibility to check for a given quantity of a stockable.

<?php

use Sylius\Component\Inventory\Checker\AvailabilityChecker;

$product = new Product(); // Stockable model.
$product->getOnHand(); // Output will be 5
$product->getOnHold(); // Output will be 4

$availabilityChecker = new AvailabilityChecker(false);
$availabilityChecker->isStockAvailable($product); // Output will be true.
$availabilityChecker->isStockSufficient($product, 5); // Output will be false.

InventoryUnitFactory¶

The InventoryUnitFactory creates a collection of new inventory units.

<?php

use Sylius\Component\Inventory\Factory\InventoryUnitFactory;
use Sylius\Component\Inventory\Model\InventoryUnitInterface;

$inventoryUnitRepository; // Repository model.
$product = new Product(); // Stockable model.

$inventoryUnitFactory = new InventoryUnitFactory($inventoryUnitRepository);

$inventoryUnits = $inventoryUnitFactory->create($product, 10, InventoryUnitInterface::STATE_RETURNED);
// Output will be collection of inventory units.

$inventoryUnits[0]->getStockable(); // Output will be your's stockable model.
$inventoryUnits[0]->getInventoryState(); // Output will be 'returned'.
count($inventoryUnits); // Output will be 10.

Note

For more detailed information go to Sylius API InventoryUnitFactory.

Models¶

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!

InventoryUnit¶

InventoryUnit object represents an inventory unit. InventoryUnits have the following properties:

Property	Description
id	Unique id of the inventory unit
stockable	Reference to any stockable unit. (Implements StockableInterface)
inventoryState	State of the inventory unit (e.g. “checkout”, “sold”)
createdAt	Date when inventory unit was created
updatedAt	Date of last change

Note

This model implements the InventoryUnitInterface For more detailed information go to Sylius API InventoryUnit.

Interfaces¶

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!

Model Interfaces¶

InventoryUnitInterface¶

This interface should be implemented by model representing a single InventoryUnit.

Hint

It also contains the default State Machine.

Note

This interface extends TimestampableInterface.

For more detailed information go to Sylius API InventoryUnitInterface.

StockableInterface¶

This interface provides basic operations for any model that can be stored.

Note

For more detailed information go to Sylius API StockableInterface.

Service Interfaces¶

AvailabilityCheckerInterface¶

This interface provides methods for checking availability of stockable objects.

Note

For more detailed information go to Sylius API AvailabilityCheckerInterface.

InventoryUnitFactoryInterface¶

This interface is implemented by services responsible for creating collection of new inventory units.

Note

For more detailed information go to Sylius API InventoryUnitFactoryInterface.

State Machine¶

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!

Inventory Unit States¶

Sylius itself uses a complex state machine system to manage all states of the business domain. This component has some sensible default states defined in the InventoryUnitInterface.

All new InventoryUnit instances have the state checkout by default, which means they are in the cart and wait for verification.

The following states are defined:

Related constant	State	Description
STATE_CHECKOUT	checkout	Item is in the cart
STATE_ONHOLD	onhold	Item is hold (e.g. waiting for the payment)
STATE_SOLD	sold	Item has been sold and is no longer in the warehouse
STATE_RETURNED	returned	Item has been sold, but returned and is in stock

Tip

Please keep in mind that these states are just default, you can define and use your own. If you use this component with SyliusInventoryBundle and Symfony, you will have full state machine configuration at your disposal.

Inventory Unit Transitions¶

There are the following order’s transitions by default:

Related constant	Transition
SYLIUS_HOLD	hold
SYLIUS_SELL	sell
SYLIUS_RELEASE	release
SYLIUS_RETURN	return

There is also the default graph name included:

Related constant	Name
GRAPH	sylius_inventory_unit

Note

All of above transitions and the graph are constant fields in the InventoryUnitTransitions class.

Learn more¶

Inventory in the Sylius platform - concept documentation

Locale¶

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!

Managing different locales for PHP apps.

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!

You can install the component in 2 different ways:

Install it via Composer (sylius/locale on Packagist);
Use the official Git repository (https://github.com/Sylius/Locale).

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 Sylius component.

Basic Usage¶

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!

LocaleContext¶

In the Locale component there are three LocaleContexts defined: * CompositeLocaleContext * ImmutableLocaleContext * ProviderBasedLocaleContext

CompositeLocaleContext¶

It is a composite of different contexts available in your application, which are prioritized while being injected here (the one with highest priority is used). It has the getLocaleCode() method available, that helps you to get the currently used locale.

LocaleProvider¶

The LocaleProvider allows you to get all available locales.

<?php

use Sylius\Component\Locale\Provider\LocaleProvider;

$locales = new InMemoryRepository();

$localeProvider = new LocaleProvider($locales);

$localeProvider->getAvailableLocalesCodes(); //Output will be a collection of available locales
$localeProvider->isLocaleAvailable('en'); //It will check if that locale is enabled

Note

For more detailed information go to Sylius API LocaleProvider.

Models¶

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!

Locale¶

Locale represents one locale available in the application. It uses Symfony Intl component to return locale name. Locale has the following properties:

Property	Description
id	Unique id of the locale
code	Locale’s code
createdAt	Date when locale was created
updatedAt	Date of last change

Hint

This model has one const STORAGE_KEY it is key used to store the locale in storage.

Note

This model implements the LocaleInterface For more detailed information go to Sylius API Locale.

Interfaces¶

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!

Model Interfaces¶

LocaleInterface¶

This interface should be implemented by models representing a single Locale.

Note

This interface extends CodeAwareInterface and TimestampableInterface.

For more detailed information go to Sylius API LocaleInterface.

LocalesAwareInterface¶

This interface provides basic operations for locale management. If you want to have locales in your model just implement this interface.

Note

For more detailed information go to Sylius API LocalesAwareInterface.

Service Interfaces¶

LocaleContextInterface¶

This interface is implemented by the service responsible for managing the current locale.

Note

For more detailed information go to Sylius API LocaleContextInterface.

LocaleProviderInterface¶

This interface is implemented by the service responsible for providing you with a list of available locales.

Note

For more detailed information go to Sylius API LocaleProviderInterface.

Learn more¶

Locales in the Sylius platform - concept documentation

Order¶

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!

E-Commerce PHP library for creating and managing sales orders.

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!

You can install the component in 2 different ways:

Install it via Composer (sylius/order on Packagist);
Use the official Git repository (https://github.com/Sylius/Order).

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 Sylius component.

Basic Usage¶

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!

Order¶

Every order has 2 main identifiers, an ID and a human-friendly number. You can access those by calling ->getId() and ->getNumber() respectively. The number is mutable, so you can change it by calling ->setNumber('E001') on the order instance.

Order Totals¶

Note

All money amounts in Sylius are represented as “cents” - integers. An order has 3 basic totals, which are all persisted together with the order. The first total is the items total, it is calculated as the sum of all item totals. The second total is the adjustments total, you can read more about this in next chapter.

<?php

echo $order->getItemsTotal(); //Output will be 1900.
echo $order->getAdjustmentsTotal(); //Output will be -250.

$order->calculateTotal();
echo $order->getTotal(); //Output will be 1650.

The main order total is a sum of the previously mentioned values. You can access the order total value using the ->getTotal() method.

Recalculation of totals can happen by calling ->calculateTotal() method, using the simplest math. It will also update the item totals.

Items Management¶

The collection of items (Implementing the Doctrine\Common\Collections\Collection interface) can be obtained using the ->getItems(). To add or remove items, you can simply use the addItem and removeItem methods.

<?php

use Sylius\Component\Order\Model\Order;
use Sylius\Component\Order\Model\OrderItem;

$order = new Order();

$item1 = new OrderItem();
$item1->setName('Super cool product');
$item1->setUnitPrice(1999); // 19.99!
$item1->setQuantity(2);

$item2 = new OrderItem();
$item2->setName('Interesting t-shirt');
$item2->setUnitPrice(2549); // 25.49!

$order->addItem($item1);
$order->addItem($item2);
$order->removeItem($item1);

Order Item¶

An order item model has only the id property as identifier and it has the order reference, accessible via ->getOrder() method.

Order Item totals¶

Just like for the order, the total is available via the same method, but the unit price is accessible using the ->getUnitPrice() Each item also can calculate its total, using the quantity (->getQuantity()) and the unit price.

<?php

use Sylius\Component\Order\Model\OrderItem;

$item = new OrderItem();
$item->setUnitPrice(2000);
$item->setQuantity(4);
$item->calculateTotal();

$item->getTotal(); //Output will be 8000.

Applying adjustments to OrderItem¶

An OrderItem can also hold adjustments.

<?php

use Sylius\Component\Order\Model\OrderItem;
use Sylius\Component\Order\Model\Adjustment;

$adjustment = new Adjustment();
$adjustment->setAmount(1200);
$adjustment->setType('tax');

$item = new OrderItem();
$item->addAdjustment($adjustment);
$item->setUnitPrice(2000);
$item->setQuantity(2);
$item->calculateTotal();

$item->getTotal(); //Output will be 5200.

Adjustments¶

Neutral Adjustments¶

In some cases, you may want to use Adjustment just for displaying purposes. For example, when your order items have the tax already included in the price.

Every Adjustment instance has the neutral property, which indicates if it should be counted against object total.

<?php

use Sylius\Component\Order\Order;
use Sylius\Component\Order\OrderItem;
use Sylius\Component\Order\Adjustment;

$order = new Order();
$tshirt = new OrderItem();
$tshirt->setUnitPrice(4999);

$shippingFees = new Adjustment();
$shippingFees->setAmount(1000);

$tax = new Adjustment();
$tax->setAmount(1150);
$tax->setNeutral(true);

$order->addItem($tshirt);
$order->addAdjustment($shippingFees);
$order->addAdjustment($tax);

$order->calculateTotal();
$order->getTotal();  // Output will be 5999.

Negative Adjustments¶

Adjustments can also have negative amounts, which means that they will decrease the order total by certain amount. Let’s add a 5$ discount to the previous example.

<?php

use Sylius\Component\Order\Order;
use Sylius\Component\Order\OrderItem;
use Sylius\Component\Order\Adjustment;

$order = new Order();
$tshirt = new OrderItem();
$tshirt->setUnitPrice(4999);

$shippingFees = new Adjustment();
$shippingFees->setAmount(1000);

$tax = new Adjustment();
$tax->setAmount(1150);
$tax->setNeutral(true);

$discount = new Adjustment();
$discount->setAmount(-500);

$order->addItem($tshirt);
$order->addAdjustment($shippingFees);
$order->addAdjustment($tax);
$order->addAdjustment($discount);
$order->calculateTotal();
$order->getTotal(); // Output will be 5499.

Locked Adjustments¶

You can also lock an adjustment, this will ensure that it won’t be deleted from order or order item.

<?php

use Sylius\Component\Order\Order;
use Sylius\Component\Order\OrderItem;
use Sylius\Component\Order\Adjustment;

$order = new Order();
$tshirt = new OrderItem();
$tshirt->setUnitPrice(4999);

$shippingFees = new Adjustment();
$shippingFees->setAmount(1000);
$shippingFees->lock();

$discount = new Adjustment();
$discount->setAmount(-500);

$order->addItem($tshirt);
$order->addAdjustment($shippingFees);
$order->addAdjustment($discount);
$order->removeAdjustment($shippingFees);
$order->calculateTotal();
$order->getTotal(); // Output will be 5499.

Models¶

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!

Order¶

Order object represents order. Orders have the following properties:

Property	Description
id	Unique id of the order
checkoutCompletedAt	The time at which checkout was completed
number	Number is human-friendly identifier
notes	Additional information about order
items	Collection of items
itemsTotal	Total value of items in order (default 0)
adjustments	Collection of adjustments
adjustmentsTotal	Total value of adjustments (default 0)
total	Calculated total (items + adjustments)
state	State of the order (e.g. “cart”, “pending”)
createdAt	Date when order was created
updatedAt	Date of last change

Note

This model implements the OrderInterface For more detailed information go to Sylius API Order.

OrderItem¶

OrderItem object represents items in order. OrderItems have the following properties:

Property	Description
id	Unique id of the orderItem
order	Reference to Order
quantity	Items quantity
unitPrice	The price of a single unit
adjustments	Collection of adjustments
adjustmentsTotal	Total of the adjustments in orderItem
total	Total of the orderItem (unitPrice * quantity + adjustmentsTotal)
immutable	Boolean flag of immutability

Note

This model implements the OrderItemInterface For more detailed information go to Sylius API OrderItem.

OrderItemUnit¶

OrderItemUnit object represents every single unit of order (for example OrderItem with quantity 5 should have 5 units). OrderItemUnits have the following properties:

Property	Description
id	Unique id of the orderItem
total	Total of the orderItemUnit (orderItem unitPrice + adjustmentsTotal)
orderItem	Reference to OrderItem
adjustments	Collection of adjustments
adjustmentsTotal	Total of the adjustments in orderItem

Note

This model implements the OrderItemUnitInterface For more detailed information go to Sylius API OrderItemUnit.

Adjustment¶

Adjustment object represents an adjustment to the order’s or order item’s total. Their amount can be positive (charges - taxes, shipping fees etc.) or negative (discounts etc.). Adjustments have the following properties:

Property	Description
id	Unique id of the adjustment
order	Reference to Order
orderItem	Reference to OrderItem
orderItemUnit	Reference to OrderItemUnit
type	Type of the adjustment (e.g. “tax”)
label	e.g. “Clothing Tax 9%”
amount	Adjustment amount
neutral	Boolean flag of neutrality
locked	Adjustment lock (prevent from deletion)
originId	Origin id of the adjustment
originType	Origin type of the adjustment
createdAt	Date when adjustment was created
updatedAt	Date of last change

Note

This model implements the AdjustmentInterface For more detailed information go to Sylius API Adjustment.

Interfaces¶

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!

Model Interfaces¶

OrderInterface¶

This interface should be implemented by model representing a single Order.

Hint

It also contains the default State Machine.

Note

This interface extends TimestampableInterface, TimestampableInterface, AdjustableInterface and CommentAwareInterface

For more detailed information go to Sylius API OrderInterface.

OrderAwareInterface¶

This interface provides basic operations for order management. If you want to have orders in your model just implement this interface.

Note

For more detailed information go to Sylius API OrderAwareInterface.

OrderItemInterface¶

This interface should be implemented by model representing a single OrderItem.

Note

This interface extends the OrderAwareInterface and the AdjustableInterface,

For more detailed information go to Sylius API OrderItemInterface.

OrderItemUnitInterface¶

This interface should be implemented by model representing a single OrderItemUnit.

Note

This interface extends the AdjustableInterface,

For more detailed information go to Sylius API OrderItemUnitInterface.

AdjustmentInterface¶

This interface should be implemented by model representing a single Adjustment.

Note

This interface extends the TimestampableInterface.

For more detailed information go to Sylius API AdjustmentInterface.

AdjustableInterface¶

This interface provides basic operations for adjustment management. Use this interface if you want to make a model adjustable.

For example following models implement this interface:

Note

For more detailed information go to Sylius API AdjustableInterface.

CommentInterface¶

This interface should be implemented by model representing a single Comment.

Note

This interface extends the TimestampableInterface

For more detailed information go to Sylius API CommentInterface.

CommentAwareInterface¶

This interface provides basic operations for comments management. If you want to have comments in your model just implement this interface.

Note

For more detailed information go to Sylius API CommentAwareInterface.

IdentityInterface¶

This interface should be implemented by model representing a single Identity. It can be used for storing external identifications.

Note

For more detailed information go to Sylius API IdentityInterface.

Services Interfaces¶

OrderRepositoryInterface¶

In order to decouple from storage that provides recently completed orders or check if given order’s number is already used, you should create repository class which implements this interface.

Note

This interface extends the RepositoryInterface.

For more detailed information about the interface go to Sylius API OrderRepositoryInterface.

State Machine¶

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!

Order States¶

Sylius itself uses a complex state machine system to manage all states of the business domain. This component has some sensible default states defined in the OrderInterface.

All new Order instances have the state cart by default, which means they are unconfirmed.

The following states are defined:

Related constant	State	Description
STATE_CART	cart	Unconfirmed order, ready to add/remove items
STATE_NEW	new	Confirmed order
STATE_CANCELLED	cancelled	Cancelled by customer or manager
STATE_FULFILLED	fulfilled	Order has been fulfilled

Tip

Please keep in mind that these states are just default, you can define and use your own. If you use this component with SyliusOrderBundle and Symfony, you will have full state machine configuration at your disposal.

Order Transitions¶

There are following order’s transitions by default:

Related constant	Transition
SYLIUS_CREATE	create
SYLIUS_CANCEL	cancel
SYLIUS_FULFILL	fulfill

There is also the default graph name included:

Related constant	Name
GRAPH	sylius_order

Note

All of above transitions and the graph are constant fields in the OrderTransitions class.

Processors¶

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!

Order processors are responsible for manipulating the orders to apply different predefined adjustments or other modifications based on order state.

OrderProcessorInterface¶

You can use it when you want to create your own custom processor.

The following code applies 10% discount adjustment to orders above 100€.

<?php

use Sylius\Component\Order\Processor\OrderProcessorInterface;
use Sylius\Component\Order\Model\OrderInterface;
use Sylius\Component\Order\Model\Adjustment;

class DiscountByPriceOrderProcessor implements OrderProcessorInterface
{
    public function process(OrderInterface $order)
    {
        if($order->getTotal() > 10000) {
            $discount10Percent = new Adjustment();
            $discount10Percent->setAmount($order->getTotal() / 100 * 10);
            $discount10Percent->setType('Percent Discount');
            // It would be good practice to set `label` but it's not mandatory
            $discount10Percent->setLabel('10% discount');
            $order->addAdjustment($discount10Percent);
        }
    }
}

CompositeOrderProcessor¶

Composite order processor works as a registry of processors, allowing to run multiple processors in priority order.

Learn more¶

Carts & Orders in the Sylius platform - concept documentation

Payment¶

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!

PHP library which provides abstraction of payments management.

It ships with default Payment and PaymentMethod models.

Note

This component does not provide any payment gateway. Integrate it with Payum.

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!

You can install the component in 2 different ways:

Install it via Composer (sylius/payment on Packagist);
Use the official Git repository (https://github.com/Sylius/Payment).

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 Sylius component.

Models¶

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!

Payment¶

Every payment is represented by a Payment instance and has the following properties:

Property	Description
id	Unique id of the payment
method	Payment method associated with this payment
currency	Payment’s currency
amount	Payment’s amount
state	Payment’s state
details	Payment’s details
createdAt	Date of creation
updatedAt	Date of the last update

Note

This model implements the PaymentInterface.

For more detailed information go to Sylius API Payment.

Hint

All default payment states are available in Payment States.

PaymentMethod¶

Every method of payment is represented by a PaymentMethod instance and has the following properties:

Property	Description
id	Unique id of the payment method
code	Unique code of the payment method
name	Payment method’s name
enabled	Indicate whether the payment method is enabled
description	Payment method’s description
gatewayConfig	Payment method’s gateway (and its configuration) to use
position	Payment method’s position among other methods
environment	Required app environment
createdAt	Date of creation
updatedAt	Date of the last update

Note

This model implements the PaymentMethodInterface.

For more detailed information go to Sylius API PaymentMethod.

PaymentMethodTranslation¶

This model is used to ensure that different locales have the correct representation of the following payment properties:

Property	Description
id	Unique id of the payment method
name	Payment method’s name
description	Payment method’s description

Note

This model implements the PaymentMethodTranslationInterface.

For more detailed information go to Sylius API PaymentMethodTranslation.

Interfaces¶

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!

Model Interfaces¶

PaymentInterface¶

This interface should be implemented by any custom model representing a payment. Also it keeps all of the default Payment States.

Note

This interface extends the CodeAwareInterface and TimestampableInterface.

For more detailed information go to Sylius API PaymentInterface.

PaymentMethodInterface¶

In order to create a custom payment method class, which could be used by other models or services from this component, it needs to implement this interface.

Note

This interface extends the TimestampableInterface and the PaymentMethodTranslationInterface.

For more detailed information go to Sylius API PaymentMethodInterface.

PaymentMethodsAwareInterface¶

This interface should be implemented by any custom storage used to store representations of the payment method.

Note

For more detailed information go to Sylius API PaymentMethodsAwareInterface.

PaymentMethodTranslationInterface¶

This interface is needed in creating a custom payment method translation class, which then could be used by the payment method itself.

Note

For more detailed information go to Sylius API PaymentMethodTranslationInterface.

PaymentSourceInterface¶

This interface needs to be implemented by any custom payment source.

Note

For more detailed information go to Sylius API PaymentSourceInterface.

PaymentsSubjectInterface¶

Any container which manages multiple payments should implement this interface.

Note

For more detailed information go to Sylius API PaymentsSubjectInterface.

Service Interfaces¶

PaymentMethodRepositoryInterface¶

This interface should be implemented by your custom repository, used to handle payment method objects.

Note

For more detailed information go to Sylius API PaymentMethodRepositoryInterface.

State Machine¶

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!

Payment States¶

The following payment states are available by default:

Related constant	State	Description
STATE_CART	cart	Initial; Before the subject of payment is completed
STATE_NEW	new	After completion of the payment subject
STATE_PROCESSING	processing	Payment which is in process of verification
STATE_COMPLETED	completed	Completed payment
STATE_FAILED	failed	Payment has failed
STATE_CANCELLED	cancelled	Cancelled by a customer or manager
STATE_REFUNDED	refunded	A completed payment which has been refunded
STATE_UNKNOWN	unknown	Auxiliary state for handling external states

Note

All the above states are constant fields in the PaymentInterface.

Payment Transitions¶

The following payment transitions are available by default:

Related constant	Transition
SYLIUS_CREATE	create
SYLIUS_PROCESS	process
SYLIUS_COMPLETE	complete
SYLIUS_FAIL	fail
SYLIUS_CANCEL	cancel
SYLIUS_REFUND	refund

There’s also the default graph name included:

Related constant	Name
GRAPH	sylius_payment

Note

All of above transitions and the graph are constant fields in the PaymentTransitions class.

Learn more¶

Payments in the Sylius platform - concept documentation

Product¶

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!

Powerful products catalog for PHP applications.

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!

You can install the component in 2 different ways:

Install it via Composer (sylius/product on Packagist).
Use the official Git repository (https://github.com/Sylius/Product).

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 Sylius component.

Basic Usage¶

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!

Creating a product¶

<?php

use Sylius\Component\Product\Model\Product;

$product = new Product();

$product->getCreatedAt(); // Returns the \DateTime when it was created.

Product attributes management¶

<?php

use Sylius\Component\Product\Model\Attribute;
use Sylius\Component\Product\Model\AttributeValue;
use Doctrine\Common\Collections\ArrayCollection;

$attribute = new Attribute();

$colorGreen = new AttributeValue();
$colorRed = new AttributeValue();

$attributes = new ArrayCollection();

$attribute->setName('Color');

$colorGreen->setValue('Green');
$colorRed->setValue('Red');

$colorGreen->setAttribute($attribute);
$colorRed->setAttribute($attribute);

$product->addAttribute($colorGreen);
$product->hasAttribute($colorGreen); // Returns true.
$product->removeAttribute($colorGreen);

$attributes->add($colorGreen);
$attributes->add($colorRed);
$product->setAttributes($attributes);

$product->hasAttributeByName('Color');
$product->getAttributeByName('Color'); // Returns $colorGreen.

$product->getAttributes(); // Returns $attributes.

Note

Only instances of AttributeValue from the Product component can be used with the Product model.

Hint

The getAttributeByName will only return the first occurrence of AttributeValue assigned to the Attribute with specified name, the rest will be omitted.

Product variants management¶

<?php

use Sylius\Component\Product\Model\Variant;

$variant = new Variant();
$availableVariant = new Variant();

$variants = new ArrayCollection();

$availableVariant->setAvailableOn(new \DateTime());

$product->hasVariants(); // return false

$product->addVariant($variant);
$product->hasVariant($variant); // returns true
$product->hasVariants(); // returns true
$product->removeVariant($variant);

$variants->add($variant);
$variants->add($availableVariant);

$product->setVariants($variants);

$product->getVariants(); // Returns an array containing $variant and $availableVariant.

Note

Only instances of Variant from the Product component can be used with the Product model.

Product options management¶

<?php

use Sylius\Component\Product\Model\Option;

$firstOption = new Option();
$secondOption = new Option();

$options = new ArrayCollection();

$product->addOption($firstOption);
$product->hasOption($firstOption); // Returns true.
$product->removeOption($firstOption);

$options->add($firstOption);
$options->add($secondOption);

$product->setOptions($options);
$product->hasOptions(); // Returns true.
$product->getOptions(); // Returns an array containing all inserted options.

Models¶

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!

Product¶

The Product model represents every unique product in the catalog. By default it contains the following properties:

Property	Description
id	Unique id of the product
name	Product’s name taken from the `ProductTranslation`
slug	Product’s urlized name taken from the `ProductTranslation`
description	Product’s description taken from the `ProductTranslation`
metaKeywords	Product’s meta keywords taken from the `ProductTranslation`
metaDescription	Product’s meta description taken from the `ProductTranslation`
attributes	Attributes assigned to this product
variants	Variants assigned to this product
options	Options assigned to this product
createdAt	Product’s date of creation
updatedAt	Product’s date of update

Note

This model uses the TranslatableTrait and implements the ProductInterface.

For more detailed information go to Sylius API Product.

ProductTranslation¶

This model is responsible for keeping a translation of product’s simple properties according to given locale. By default it has the following properties:

Property	Description
id	Unique id of the product translation

Note

This model extends the AbstractTranslation class and implements the ProductTranslationInterface.

For more detailed information go to Sylius API ProductTranslation.

AttributeValue¶

This AttributeValue extension ensures that it’s subject is an instance of the ProductInterface.

Note

This model extends the AttributeValue and implements the AttributeValueInterface.

For more detailed information go to Sylius API AttributeValue.

Variant¶

This Variant extension ensures that it’s object is an instance of the ProductInterface and provides an additional property:

Property	Description
availableOn	The date indicating when a product variant is available

Note

This model implements the ProductVariantInterface.

For more detailed information go to Sylius API Variant.

Interfaces¶

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!

Model Interfaces¶

ProductInterface¶

This interface should be implemented by models characterizing a product.

Note

This interface extends SlugAwareInterface, TimestampableInterface and ProductTranslationInterface.

For more information go to Sylius API ProductInterface.

ProductTranslationInterface¶

This interface should be implemented by models used for storing a single translation of product fields.

Note

This interface extends the SlugAwareInterface.

For more information go to Sylius API ProductTranslationInterface.

AttributeValueInterface¶

This interfaces should be implemented by models used to bind an attribute and a value to a specific product.

Note

This interface extends the AttributeValueInterface.

For more information go to Sylius API AttributeValueInterface.

ProductVariantInterface¶

This interface should be implemented by models binding a product with a specific combination of attributes.

Learn more¶

Products in the Sylius platform - concept documentation

Promotion¶

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!

Super-flexible promotions system with support of complex rules and actions. Coupon codes included!

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!

You can install the component in 2 different ways:

Install it via Composer (sylius/promotion on Packagist);
Use the official Git repository (https://github.com/Sylius/Promotion).

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 Sylius component.

Basic Usage¶

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!

In order to benefit from the component’s features at first you need to create a basic class that will implement the PromotionSubjectInterface. Let’s assume that you would like to have a system that applies promotions on Tickets. Your Ticket class therefore will implement the CountablePromotionSubjectInterface to give you an ability to count the subjects for promotion application purposes.

<?php

namespace App\Entity;

use Doctrine\Common\Collections\Collection;
use Doctrine\Common\Collections\ArrayCollection;
use Sylius\Component\Promotion\Model\CountablePromotionSubjectInterface;
use Sylius\Component\Promotion\Model\PromotionSubjectInterface;
use Sylius\Component\Promotion\Model\PromotionInterface;

class Ticket implements CountablePromotionSubjectInterface
{
    /**
     * @var int
     */
    private $quantity;

    /**
     * @var Collection
     */
    private $promotions;

    /**
     * @var int
     */
    private $unitPrice;

    public function __construct()
    {
        $this->promotions = new ArrayCollection();
    }
    /**
     * @return int
     */
    public function getQuantity()
    {
        return $this->quantity;
    }

    /**
     * @param int $quantity
     */
    public function setQuantity($quantity)
    {
        $this->quantity = $quantity;
    }

    /**
     * {@inheritdoc}
     */
    public function getPromotions()
    {
        return $this->promotions;
    }

    /**
     * {@inheritdoc}
     */
    public function hasPromotion(PromotionInterface $promotion)
    {
        return $this->promotions->contains($promotion);
    }

    /**
     * {@inheritdoc}
     */
    public function getPromotionSubjectTotal()
    {
        //implementation
    }

    /**
     * {@inheritdoc}
     */
    public function addPromotion(PromotionInterface $promotion)
    {
        if (!$this->hasPromotion($promotion)) {
            $this->promotions->add($promotion);
        }
    }

    /**
     * {@inheritdoc}
     */
    public function removePromotion(PromotionInterface $promotion)
    {
        if($this->hasPromotion($promotion))
        {
            $this->promotions->removeElement($promotion);
        }
    }

    /**
     * {@inheritdoc}
     */
    public function getPromotionSubjectCount()
    {
        return $this->getQuantity();
    }

    /**
     * @return int
     */
    public function getUnitPrice()
    {
        return $this->unitPrice;
    }

    /**
     * @param int $price
     */
    public function setUnitPrice($price)
    {
        $this->unitPrice = $price;
    }

    /**
     * @return int
     */
    public function getTotal()
    {
        return $this->getUnitPrice() * $this->getQuantity();
    }
}

PromotionProcessor¶

The component provides us with a PromotionProcessor which checks all rules of a subject and applies configured actions if rules are eligible.

<?php

use Sylius\Component\Promotion\Processor\PromotionProcessor;
use App\Entity\Ticket;

/**
 * @param PromotionRepositoryInterface         $repository
 * @param PromotionEligibilityCheckerInterface $checker
 * @param PromotionApplicatorInterface         $applicator
 */
$processor = new PromotionProcessor($repository, $checker, $applicator);

$subject = new Ticket();

$processor->process($subject);

Note

It implements the PromotionProcessorInterface.

CompositePromotionEligibilityChecker¶

The Promotion component provides us with a delegating service - the CompositePromotionEligibilityChecker that checks if the promotion rules are eligible for a given subject. Below you can see how it works:

Warning

Remember! That before you start using rule checkers you need to have two Registries - rule checker registry and promotion action registry. In these you have to register your rule checkers and promotion actions. You will also need working services - ‘item_count’ rule checker service for our example:

<?php

use Sylius\Component\Promotion\Model\Promotion;
use Sylius\Component\Promotion\Model\PromotionAction;
use Sylius\Component\Promotion\Model\PromotionRule;
use Sylius\Component\Promotion\Checker\CompositePromotionEligibilityChecker;
use App\Entity\Ticket;

$checkerRegistry = new ServiceRegistry('Sylius\Component\Promotion\Checker\RuleCheckerInterface');
$actionRegistry = new ServiceRegistry('Sylius\Component\Promotion\Model\PromotionActionInterface');
$ruleRegistry = new ServiceRegistry('Sylius\Component\Promotion\Model\PromotionRuleInterface');

$dispatcher = new EventDispatcher();

/**
 * @param ServiceRegistryInterface $registry
 * @param EventDispatcherInterface $dispatcher
 */
$checker = new CompositePromotionEligibilityChecker($checkerRegistry, $dispatcher);

$itemCountChecker = new ItemCountRuleChecker();
$checkerRegistry->register('item_count', $itemCountChecker);

// Let's create a new promotion
$promotion = new Promotion();
$promotion->setName('Test');

// And a new action for that promotion, that will give a fixed discount of 10
$action = new PromotionAction();
$action->setType('fixed_discount');
$action->setConfiguration(array('amount' => 10));
$action->setPromotion($promotion);

$actionRegistry->register('fixed_discount', $action);

// That promotion will also have a rule - works for item amounts over 2
$rule = new PromotionRule();
$rule->setType('item_count');

$configuration = array('count' => 2);
$rule->setConfiguration($configuration);

$ruleRegistry->register('item_count', $rule);

$promotion->addRule($rule);

// Now we need an object that implements the PromotionSubjectInterface
// so we will use our custom Ticket class.
$subject = new Ticket();

$subject->addPromotion($promotion);
$subject->setQuantity(3);
$subject->setUnitPrice(10);

$checker->isEligible($subject, $promotion); // Returns true

Note

It implements the PromotionEligibilityCheckerInterface.

PromotionApplicator¶

In order to automate the process of promotion application the component provides us with a Promotion Applicator, which is able to apply and revert single promotions on a subject implementing the PromotionSubjectInterface.

<?php

use Sylius\Component\Promotion\PromotionAction\PromotionApplicator;
use Sylius\Component\Promotion\Model\Promotion;
use Sylius\Component\Registry\ServiceRegistry;
use App\Entity\Ticket;

// In order for the applicator to work properly you need to have your actions created and registered before.
$registry = new ServiceRegistry('Sylius\Component\Promotion\Model\PromotionActionInterface');
$promotionApplicator = new PromotionApplicator($registry);

$promotion = new Promotion();

$subject = new Ticket();
$subject->addPromotion($promotion);

$promotionApplicator->apply($subject, $promotion);

$promotionApplicator->revert($subject, $promotion);

Note

It implements the PromotionApplicatorInterface.

PromotionCouponGenerator¶

In order to automate the process of coupon generation the component provides us with a Coupon Generator.

<?php

use Sylius\Component\Promotion\Model\Promotion;
use Sylius\Component\Promotion\Generator\PromotionCouponGeneratorInstruction;
use Sylius\Component\Promotion\Generator\PromotionCouponGenerator;

$promotion = new Promotion();

$instruction = new PromotionCouponGeneratorInstruction(); // $amount = 5 by default

/**
 * @param RepositoryInterface    $repository
 * @param EntityManagerInterface $manager
 */
$generator = new PromotionCouponGenerator($repository, $manager);

//This will generate and persist 5 coupons into the database
//basing on the instruction provided for the given promotion object
$generator->generate($promotion, $instruction);

// We can also generate one unique code, and assign it to a new Coupon.
$code = $generator->generateUniqueCode();
$coupon = new Coupon();
$coupon->setCode($code);

Checkers¶

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!

ItemCountRuleChecker¶

You can use it when your subject implements the CountablePromotionSubjectInterface:

<?php

$itemCountChecker = new ItemCountRuleChecker();
// a Subject that implements the CountablePromotionSubjectInterface
$subject->setQuantity(3);

$configuration = array('count' => 2);

$itemCountChecker->isEligible($subject, $configuration); // returns true

ItemTotalRuleChecker¶

If your subject implements the PromotionSubjectInterface you can use it with this checker.

<?php

$itemTotalChecker = new ItemTotalRuleChecker();

// a Subject that implements the PromotionSubjectInterface
// Let's assume the subject->getSubjectItemTotal() returns 199

$configuration = array('amount' => 199);

$itemTotalChecker->isEligible($subject, $configuration); // returns true

Models¶

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!

Promotion¶

The promotion is represented by a Promotion instance. It has the following properties as default:

Property	Description
id	Unique id of the promotion
code	Unique code of the promotion
name	Promotion’s name
description	Promotion’s description
priority	When exclusive, promotion with top priority will be applied
exclusive	Cannot be applied together with other promotions
usageLimit	Promotion’s usage limit
used	Number of times this coupon has been used
startsAt	Start date
endsAt	End date
couponBased	Whether this promotion is triggered by a coupon
coupons	Associated coupons
rules	Associated rules
actions	Associated actions
createdAt	Date of creation
updatedAt	Date of update

Note

This model implements the PromotionInterface .

Coupon¶

The coupon is represented by a Coupon instance. It has the following properties as default:

Property	Description
id	Unique id of the coupon
code	Coupon’s code
usageLimit	Coupon’s usage limit
used	Number of times the coupon has been used
promotion	Associated promotion
expiresAt	Expiration date
createdAt	Date of creation
updatedAt	Date of update

Note

This model implements the CouponInterface.

PromotionRule¶

The promotion rule is represented by a PromotionRule instance. PromotionRule is a requirement that has to be satisfied by the promotion subject. It has the following properties as default:

Property	Description
id	Unique id of the coupon
type	Rule’s type
configuration	Rule’s configuration
promotion	Associated promotion

Note

This model implements the PromotionRuleInterface.

PromotionAction¶

The promotion action is represented by an PromotionAction instance. PromotionAction takes place if the rules of a promotion are satisfied. It has the following properties as default:

Property	Description
id	Unique id of the action
type	Rule’s type
configuration	Rule’s configuration
promotion	Associated promotion

Note

This model implements the PromotionActionInterface.

Interfaces¶

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!

Model Interfaces¶

PromotionSubjectInterface¶

To characterize an object with attributes and options from a promotion, the object class needs to implement the PromotionSubjectInterface.

Note

You will find more information about this interface in Sylius API PromotionSubjectInterface.

PromotionInterface¶

This interface should be implemented by models representing a Promotion.

Note

This interface extends the CodeAwareInterface and TimestampableInterface.

You will find more information about this interface in Sylius API PromotionInterface.

PromotionActionInterface¶

This interface should be implemented by models representing an PromotionAction.

An PromotionActionInterface has two defined types by default:

Related constant	Type
TYPE_FIXED_DISCOUNT	fixed_discount
TYPE_PERCENTAGE_DISCOUNT	percentage_discount

Note

You will find more information about this interface in Sylius API PromotionActionInterface.

CouponInterface¶

This interface should be implemented by models representing a Coupon.

Note

This interface extends the CodeAwareInterface and the TimestampableInterface.

You will find more information about this interface in Sylius API CouponInterface.

PromotionRuleInterface¶

This interface should be implemented by models representing a PromotionRule.

A PromotionRuleInterface has two defined types by default:

Related constant	Type
TYPE_ITEM_TOTAL	item_total
TYPE_ITEM_COUNT	item_count

Note

You will find more information about this interface in Sylius API PromotionRuleInterface.

CountablePromotionSubjectInterface¶

To be able to count the object’s promotion subjects, the object class needs to implement the CountablePromotionSubjectInterface.

Note

This interface extends the PromotionSubjectInterface.

You will find more information about this interface in Sylius API CountablePromotionSubjectInterface.

PromotionCouponAwarePromotionSubjectInterface¶

To make the object able to get its associated coupon, the object class needs to implement the PromotionCouponAwarePromotionSubjectInterface.

Note

This interface extends the PromotionSubjectInterface.

You will find more information about this interface in Sylius API PromotionCouponAwarePromotionSubjectInterface.

PromotionCouponsAwareSubjectInterface¶

To make the object able to get its associated coupons collection, the object class needs to implement the PromotionCouponsAwareSubjectInterface.

Note

This interface extends the PromotionSubjectInterface.

You will find more information about this interface in Sylius API PromotionCouponsAwareSubjectInterface.

Services Interfaces¶

PromotionEligibilityCheckerInterface¶

Services responsible for checking the promotions eligibility on the promotion subjects should implement this interface.

Note

You will find more information about this interface in Sylius API PromotionEligibilityCheckerInterface.

RuleCheckerInterface¶

Services responsible for checking the rules eligibility should implement this interface.

Note

You will find more information about this interface in Sylius API RuleCheckerInterface.

PromotionApplicatorInterface¶

Service responsible for applying promotions in your system should implement this interface.

Note

You will find more information about this interface in Sylius API PromotionApplicatorInterface.

PromotionProcessorInterface¶

Service responsible for checking all rules and applying configured actions if rules are eligible in your system should implement this interface.

Note

You will find more information about this interface in Sylius API PromotionProcessorInterface.

PromotionRepositoryInterface¶

In order to be able to find active promotions in your system you should create a repository class which implements this interface.

Note

This interface extends the RepositoryInterface.

For more detailed information about this interface go to Sylius API PromotionRepositoryInterface.

PromotionCouponGeneratorInterface¶

In order to automate the process of coupon generation your system needs to have a service that will implement this interface.

Note

For more detailed information about this interface go to Sylius API PromotionCouponGeneratorInterface.

PromotionActionCommandInterface¶

This interface should be implemented by services that execute actions on the promotion subjects.

Note

You will find more information about this interface in Sylius API PromotionActionCommandInterface.

Learn more¶

Promotions in the Sylius platform - concept documentation

Shipping¶

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!

Shipments and shipping methods management for PHP E-Commerce applications. It contains flexible calculators system for computing the shipping costs.

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!

You can install the component in 2 different ways:

Install it via Composer (sylius/shipping on Packagist);
Use the official Git repository (https://github.com/Sylius/Shipping).

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 Sylius component.

Basic Usage¶

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!

In all examples is used an exemplary class implementing ShippableInterface, which looks like:

<?php

declare(strict_types=1);

use Sylius\Component\Shipping\Model\ShippableInterface;
use Sylius\Component\Shipping\Model\ShippingCategoryInterface;

class Wardrobe implements ShippableInterface
{
    /**
     * @var ShippingCategoryInterface
     */
    private $category;

    /**
     * @var float
     */
    private $weight;

    /**
     * @var float
     */
    private $volume;

    /**
     * @var float
     */
    private $width;

    /**
     * @var float
     */
    private $height;

    /**
     * @var float
     */
    private $depth;

    /**
     * {@inheritdoc}
     */
    public function getShippingWeight(): float
    {
        return $this->weight;
    }

    /**
     * {@inheritdoc}
     */
    public function setShippingWeight(float $weight): void
    {
        $this->weight = $weight;
    }

    /**
     * {@inheritdoc}
     */
    public function getShippingVolume(): float
    {
        return $this->volume;
    }

    /**
     * @param int $volume
     */
    public function setShippingVolume(float $volume)
    {
        $this->volume = $volume;
    }

    /**
     * {@inheritdoc}
     */
    public function getShippingWidth(): float
    {
        return $this->width;
    }


    /**
     * {@inheritdoc}
     */
    public function setShippingWidth(float $width)
    {
        $this->width = $width;
    }

    /**
     * {@inheritdoc}
     */
    public function getShippingHeight(): float
    {
        return $this->height;
    }

    /**
     * {@inheritdoc}
     */
    public function setShippingHeight(float $height)
    {
        $this->height = $height;
    }

    /**
     * {@inheritdoc}
     */
    public function getShippingDepth(): float
    {
        return $this->depth;
    }

    /**
     * {@inheritdoc}
     */
    public function setShippingDepth(float $depth)
    {
        $this->depth = $depth;
    }

    /**
     * {@inheritdoc}
     */
    public function getShippingCategory(): ShippingCategoryInterface
    {
        return $this->category;
    }

    /**
     * {@inheritdoc}
     */
    public function setShippingCategory(ShippingCategoryInterface $category)
    {
        $this->category = $category;
    }
}

Shipping Category¶

Every shipping category has three identifiers, an ID, code and name. You can access those by calling ->getId(), ->getCode() and ->getName() methods respectively. The name is mutable, so you can change them by calling and ->setName('Regular') on the shipping category instance.

Shipping Method¶

Every shipping method has three identifiers, an ID code and name. You can access those by calling ->getId(), ->getCode() and ->getName() methods respectively. The name is mutable, so you can change them by calling ->setName('FedEx') on the shipping method instance.

Setting Shipping Category¶

Every shipping method can have shipping category. You can simply set or unset it by calling ->setCategory().

<?php

use Sylius\Component\Shipping\Model\ShippingMethod;
use Sylius\Component\Shipping\Model\ShippingCategory;
use Sylius\Component\Shipping\Model\ShippingMethodInterface;

$shippingCategory = new ShippingCategory();
$shippingCategory->setName('Regular'); // Regular weight items

$shippingMethod = new ShippingMethod();
$shippingMethod->setCategory($shippingCategory); //default null, detach
$shippingMethod->getCategory(); // Output will be ShippingCategory object
$shippingMethod->setCategory(null);

Shipping Method Translation¶

ShippingMethodTranslation allows shipping method’s name translation according to given locales. To see how to use translation please go to ResourceBundle documentation.

Shipment Item¶

You can use a ShippingItem for connecting a shippable object with a proper Shipment. Note that a ShippingItem can exist without a Shipment assigned.

<?php

use Sylius\Component\Shipping\Model\Shipment;
use Sylius\Component\Shipping\Model\ShipmentItem;
use Sylius\Component\Shipping\Model\ShipmentInterface;

$shipment = new Shipment();
$wardrobe = new Wardrobe();
$shipmentItem = new ShipmentItem();

$shipmentItem->setShipment($shipment);
$shipmentItem->getShipment(); // returns shipment object
$shipmentItem->setShipment(null);

$shipmentItem->setShippable($wardrobe);
$shipmentItem->getShippable(); // returns shippable object

$shipmentItem->getShippingState(); // returns const STATE_READY
$shipmentItem->setShippingState(ShipmentInterface::STATE_SOLD);

Shipment¶

Every Shipment can have the types of state defined in the ShipmentInterface and the ShippingMethod, which describe the way of delivery.

<?php

use Sylius\Component\Shipping\Model\ShippingMethod;
use Sylius\Component\Shipping\Model\Shipment;
use Sylius\Component\Shipping\Model\ShipmentInterface;

$shippingMethod = new ShippingMethod();

$shipment = new Shipment();
$shipment->getState(); // returns const checkout
$shipment->setState(ShipmentInterface::STATE_CANCELLED);

$shipment->setMethod($shippingMethod);
$shipment->getMethod();

Adding shipment item¶

You can add many shipment items to shipment, which connect shipment with shippable object.

<?php

use Sylius\Component\Shipping\Model\Shipment;
use Sylius\Component\Shipping\Model\ShipmentItem;

$shipmentItem = new ShipmentItem();
$shipment = new Shipment();

$shipment->addItem($shipmentItem);
$shipment->hasItem($shipmentItem); // returns true
$shipment->getItems(); // returns collection of shipment items
$shipment->getShippingItemCount(); // returns 1
$shipment->removeItem($shipmentItem);

Tracking shipment¶

You can also define tracking code for your shipment:

<?php

use Sylius\Component\Shipping\Model\Shipment;

$shipment->isTracked();// returns false
$shipment->setTracking('5346172074');
$shipment->getTracking(); // returns 5346172074
$shipment->isTracked();// returns true

RuleCheckerInterface¶

This example shows how use an exemplary class implementing RuleCheckerInterface.

<?php

use Sylius\Component\Shipping\Model\Shipment;
use Sylius\Component\Shipping\Model\ShipmentItem;
use Sylius\Component\Shipping\Model\Rule;
use Sylius\Component\Shipping\Checker\ItemCountRuleChecker;

$rule = new Rule();
$rule->setConfiguration(array('count' => 5, 'equal' => true));

$wardrobe = new Wardrobe();

$shipmentItem = new ShipmentItem();
$shipmentItem->setShippable($wardrobe);

$shipment = new Shipment();
$shipment->addItem($shipmentItem);

$ruleChecker = new ItemCountRuleChecker();
$ruleChecker->isEligible($shipment, $rule->getConfiguration()); // returns false, because
// quantity of shipping item in shipment is smaller than count from rule's configuration

Hint

You can read more about each of the available checkers in the Checkers chapter.

Delegating calculation to correct calculator instance¶

DelegatingCalculator class delegates the calculation of charge for particular shipping subject to a correct calculator instance, based on the name defined on the shipping method. It uses ServiceRegistry to keep all calculators registered inside container. The calculators are retrieved by name.

<?php

use Sylius\Component\Shipping\Model\ShippingMethod;
use Sylius\Component\Shipping\Calculator\DefaultCalculators;
use Sylius\Component\Shipping\Calculator\PerItemRateCalculator;
use Sylius\Component\Shipping\Calculator\FlexibleRateCalculator;
use Sylius\Component\Shipping\Model\Shipment;
use Sylius\Component\Shipping\Model\ShipmentItem;
use Sylius\Component\Shipping\Calculator\DelegatingCalculator;
use Sylius\Component\Registry\ServiceRegistry;

$configuration = array(
    'first_item_cost'       => 1000,
    'additional_item_cost'  => 200,
    'additional_item_limit' => 2
);
$shippingMethod = new ShippingMethod();
$shippingMethod->setConfiguration($configuration);
$shippingMethod->setCalculator(DefaultCalculators::FLEXIBLE_RATE);

$shipmentItem = new ShipmentItem();

$shipment = new Shipment();
$shipment->setMethod($shippingMethod);
$shipment->addItem($shipmentItem);

$flexibleRateCalculator = new FlexibleRateCalculator();
$perItemRateCalculator = new PerItemRateCalculator();

$calculatorRegistry = new ServiceRegistry(CalculatorInterface::class);
$calculatorRegistry->register(DefaultCalculators::FLEXIBLE_RATE, $flexibleRateCalculator);
$calculatorRegistry->register(DefaultCalculators::PER_ITEM_RATE, $perItemRateCalculator);

$delegatingCalculators = new DelegatingCalculator($calculatorRegistry);
$delegatingCalculators->calculate($shipment); // returns 1000

$configuration2 = array('amount' => 200);
$shippingMethod2 = new ShippingMethod();
$shippingMethod2->setConfiguration($configuration2);
$shippingMethod2->setCalculator(DefaultCalculators::PER_ITEM_RATE);

$shipment->setMethod($shippingMethod2);
$delegatingCalculators->calculate($shipment); // returns 200

Caution

The method ->register() and ->get() used in ->calculate throw InvalidArgumentException. The method ->calculate throws UndefinedShippingMethodException when given shipment does not have a shipping method defined.

Hint

You can read more about each of the available calculators in the Calculators chapter.

Resolvers¶

ShippingMethodsResolver¶

Sylius has flexible system for displaying the shipping methods available for given shippables (subjects which implement ShippableInterface), which is base on ShippingCategory objects and category requirements. The requirements are constant default defined in ShippingMethodInterface. To provide information about the number of allowed methods it use ShippingMethodResolver.

First you need to create a few instances of ShippingCategory class:

<?php

use Sylius\Component\Shipping\Model\ShippingCategory;

$shippingCategory = new ShippingCategory();
$shippingCategory->setName('Regular');
$shippingCategory1 = new ShippingCategory();
$shippingCategory1->setName('Light');

Next you have to create a repository w which holds a few instances of ShippingMethod. An InMemoryRepository, which holds a collection of ShippingMethod objects, was used. The configuration is shown below:

<?php

// ...
// notice:
// $categories = array($shippingCategory, $shippingCategory1);

$firstMethod = new ShippingMethod();
$firstMethod->setCategory($categories[0]);

$secondMethod = new ShippingMethod();
$secondMethod->setCategory($categories[1]);

$thirdMethod = new ShippingMethod();
$thirdMethod->setCategory($categories[1]);
// ...

Finally you can create a method resolver:

<?php

use Sylius\Component\Shipping\Model\ShippingCategory;
use Sylius\Component\Shipping\Model\Shipment;
use Sylius\Component\Shipping\Model\ShipmentItem;
use Sylius\Component\Shipping\Model\RuleInterface;
use Sylius\Component\Shipping\Checker\Registry\RuleCheckerRegistry;
use Sylius\Component\Shipping\Checker\ItemCountRuleChecker;
use Sylius\Component\Shipping\Resolver\ShippingMethodsResolver;
use Sylius\Component\Shipping\Checker\ShippingMethodEligibilityChecker;

$ruleCheckerRegistry = new RuleCheckerRegistry();
$methodEligibilityChecker = new shippingMethodEligibilityChecker($ruleCheckerRegistry);

$shippingRepository = new InMemoryRepository(); //it has collection of shipping methods

$wardrobe = new Wardrobe();
$wardrobe->setShippingCategory($shippingCategory);
$wardrobe2 = new Wardrobe();
$wardrobe2->setShippingCategory($shippingCategory1);

$shipmentItem = new ShipmentItem();
$shipmentItem->setShippable($wardrobe);
$shipmentItem2 = new ShipmentItem();
$shipmentItem2->setShippable($wardrobe2);

$shipment = new Shipment();
$shipment->addItem($shipmentItem);
$shipment->addItem($shipmentItem2);

$methodResolver = new ShippingMethodsResolver($shippingRepository, $methodEligibilityChecker);
$methodResolver->getSupportedMethods($shipment);

The ->getSupportedMethods($shipment) method return the number of methods allowed for shipment object. There are a few possibilities:

All shippable objects and all ShippingMethod have category Regular. The returned number will be 3.
All ShippingMethod and one shippable object have category Regular. Second shippable object has category Light. The returned number will be 3.
Two ShippingMethod and one shippable object have category Regular. Second shippable object and one ShippingMethod have category Light. The returned number will be 3.
Two ShippingMethod and one shippable object have category Regular. Second shippable object and second ShippingMethod have category Light. The second Shipping category sets the category requirements as CATEGORY_REQUIREMENT_MATCH_NONE. The returned number will be 2.
Two ShippingMethod and all shippable objects have category Regular. Second ShippingMethod has category Light. The second Shipping category sets the category requirements as CATEGORY_REQUIREMENT_MATCH_NONE. The returned number will be 3.
Two ShippingMethod and one shippable object have category Regular. Second shippable object and second ShippingMethod have category Light. The second Shipping category sets the category requirements as CATEGORY_REQUIREMENT_MATCH_ALL. The returned number will be 2.
Two ShippingMethod have category Regular. All shippable object and second ShippingMethod have category Light. The second Shipping category sets the category requirements as CATEGORY_REQUIREMENT_MATCH_ALL. The returned number will be 1.

Note

The categoryRequirement property in ShippingMethod is set default to CATEGORY_REQUIREMENT_MATCH_ANY. For more detailed information about requirements please go to Shipping method requirements.

Calculators¶

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!

FlatRateCalculator¶

FlatRateCalculator class charges a flat rate per shipment.

<?php

use Sylius\Component\Shipping\Model\Shipment;
use Sylius\Component\Shipping\Calculator\FlatRateCalculator;
use Sylius\Component\Shipping\Model\ShipmentItem;

$shipmentItem = new ShipmentItem();
$shipment = new Shipment();
$shipment->addItem($shipmentItem);

$flatRateCalculator = new FlatRateCalculator();
// this configuration should be defined in shipping method allowed for shipment
$configuration = array('amount' => 1500);

$flatRateCalculator->calculate($shipment, $configuration); // returns 1500
$configuration = array('amount' => 500);
$flatRateCalculator->calculate($shipment, $configuration); // returns 500

FlexibleRateCalculator¶

FlexibleRateCalculator calculates a shipping charge, where first item has different cost that other items.

<?php

use Sylius\Component\Shipping\Model\Shipment;
use Sylius\Component\Shipping\Calculator\FlexibleRateCalculator;

$shipment = new Shipment();
$shipmentItem = new ShipmentItem();
$shipmentItem2 = new ShipmentItem();
$shipmentItem3 = new ShipmentItem();
$shipmentItem4 = new ShipmentItem();

// this configuration should be defined in shipping method allowed for shipment
$configuration = array(
    'first_item_cost'       => 1000,
    'additional_item_cost'  => 200,
    'additional_item_limit' => 2
);

$flexibleRateCalculator = new FlexibleRateCalculator();

$shipment->addItem($shipmentItem);
$flexibleRateCalculator->calculate($shipment, $configuration); // returns 1000

$shipment->addItem($shipmentItem2);
$shipment->addItem($shipmentItem3);
$flexibleRateCalculator->calculate($shipment, $configuration); // returns 1400

$shipment->addItem($shipmentItem4);
$flexibleRateCalculator->calculate($shipment, $configuration);
// returns 1400, because additional item limit is 3

PerItemRateCalculator¶

PerItemRateCalculator charges a flat rate per item.

<?php

use Sylius\Component\Shipping\Model\Shipment;
use Sylius\Component\Shipping\Model\ShipmentItem;
use Sylius\Component\Shipping\Calculator\PerItemRateCalculator;

// this configuration should be defined in shipping method allowed for shipment
$configuration = array('amount' => 200);
$perItemRateCalculator = new PerItemRateCalculator();

$shipment = new Shipment();
$shipmentItem = new ShipmentItem();
$shipmentItem2 = new ShipmentItem();

$perItemRateCalculator->calculate($shipment, $configuration); // returns 0

$shipment->addItem($shipmentItem);
$perItemRateCalculator->calculate($shipment, $configuration); // returns 200

$shipment->addItem($shipmentItem2);
$perItemRateCalculator->calculate($shipment, $configuration); // returns 400

VolumeRateCalculator¶

VolumeRateCalculator charges amount rate per volume.

<?php

use Sylius\Component\Shipping\Model\Shipment;
use Sylius\Component\Shipping\Model\ShipmentItem;
use Sylius\Component\Shipping\Calculator\VolumeRateCalculator;

$wardrobe = new Wardrobe();

$shipmentItem = new ShipmentItem();
$shipmentItem->setShippable($wardrobe);

$shipment = new Shipment();
$shipment->addItem($shipmentItem);

$configuration = array('amount' => 200, 'division' => 5);
// this configuration should be defined in shipping method allowed for shipment
$volumeRateCalculator = new VolumeRateCalculator();

$wardrobe->setShippingVolume(100);
$volumeRateCalculator->calculate($shipment, $configuration); // returns 4000

$wardrobe->setShippingVolume(20);
$volumeRateCalculator->calculate($shipment, $configuration); // returns  800

Hint

To see implementation of Wardrobe class please go to Basic Usage.

WeightRateCalculator¶

WeightRateCalculator charges amount rate per weight.

<?php

use Sylius\Component\Shipping\Model\Shipment;
use Sylius\Component\Shipping\Model\ShipmentItem;
use Sylius\Component\Shipping\Calculator\WeightRateCalculator;

$configuration = array('fixed' => 200, 'variable' => 500, 'division' => 5);
// this configuration should be defined in shipping method allowed for shipment
$weightRateCalculator = new WeightRateCalculator();

$wardrobe = new Wardrobe();

$shipmentItem = new ShipmentItem();
$shipmentItem->setShippable($wardrobe);

$shipment = new Shipment();
$shipment->addItem($shipmentItem);

$wardrobe->setShippingWeight(100);
$weightRateCalculator->calculate($shipment, $configuration); // returns 10200

$wardrobe->setShippingWeight(10);
$weightRateCalculator->calculate($shipment, $configuration); // returns 1200

Hint

To see implementation of Wardrobe class please go to Basic Usage.

Checkers¶

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!

ItemCountRuleChecker¶

This class checks if item count exceeds (or at least is equal) the configured count. An example about how to use it is on RuleCheckerInterface.

Note

This checker implements the RuleCheckerInterface.

For more detailed information go to Sylius API ItemCountRuleChecker.

ShippingMethodEligibilityChecker¶

This class checks if shipping method rules are capable of shipping given subject.

<?php

use Sylius\Component\Shipping\Model\Rule;
use Sylius\Component\Shipping\Model\ShippingMethod;
use Sylius\Component\Shipping\Model\ShippingCategory;
use Sylius\Component\Shipping\Model\Shipment;
use Sylius\Component\Shipping\Model\ShipmentItem;
use Sylius\Component\Shipping\Model\ShippingMethodTranslation;
use Sylius\Component\Shipping\Model\RuleInterface;
use Sylius\Component\Shipping\Checker\ItemCountRuleChecker;
use Sylius\Component\Shipping\Checker\ShippingMethodEligibilityChecker;
use Sylius\Component\Shipping\Checker\RuleCheckerInterface;
use Sylius\Component\Registry\ServiceRegistry;

$rule = new Rule();
$rule->setConfiguration(array('count' => 0, 'equal' => true));
$rule->setType(RuleInterface::TYPE_ITEM_COUNT);

$shippingCategory = new ShippingCategory();
$shippingCategory->setName('Regular');

$hippingMethodTranslate = new ShippingMethodTranslation();
$hippingMethodTranslate->setLocale('en');
$hippingMethodTranslate->setName('First method');

$shippingMethod = new ShippingMethod();
$shippingMethod->setCategory($shippingCategory);
$shippingMethod->setCurrentLocale('en');
$shippingMethod->setFallbackLocale('en');
$shippingMethod->addTranslation($hippingMethodTranslate);

$shippingMethod->addRule($rule);

$shippable = new ShippableObject();
$shippable->setShippingCategory($shippingCategory);

$shipmentItem = new ShipmentItem();
$shipmentItem->setShippable($shippable);

$shipment = new Shipment();
$shipment->addItem($shipmentItem);

$ruleChecker = new ItemCountRuleChecker();

$ruleCheckerRegistry = new ServiceRegistry(RuleCheckerInterface::class);
$ruleCheckerRegistry->register(RuleInterface::TYPE_ITEM_COUNT, $ruleChecker);

$methodEligibilityChecker = new ShippingMethodEligibilityChecker($ruleCheckerRegistry);

///returns true, because quantity of shipping item in shipment is equal as count in rule's configuration
$methodEligibilityChecker->isEligible($shipment, $shippingMethod);

// returns true, because the shippable object has the same category as shippingMethod
// and shipping method has default category requirement
$methodEligibilityChecker->isCategoryEligible($shipment, $shippingMethod);

Caution

The method ->register() throws InvalidArgumentException.

Note

This model implements the ShippingMethodEligibilityCheckerInterface.

For more detailed information go to Sylius API ShippingMethodEligibilityChecker.

Models¶

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!

Shipment¶

Shipment object has methods to represent the events that take place during the process of shipment. Shipment has the following properties:

Property	Description
id	Unique id of the shipment
state	Reference to constant from ShipmentInterface
method	Reference to ShippingMethod
items	Reference to Collection of shipping items
tracking	Tracking code for shipment
createdAt	Creation time
updatedAt	Last update time

Note

This model implements the ShipmentInterface.

For more detailed information go to Sylius API Shipment.

ShipmentItem¶

ShipmentItem object is used for connecting a shippable object with a proper shipment. ShipmentItems have the following properties:

Property	Description
id	Unique id of the ShipmentItem
shipment	Reference to Shipment
shippable	Reference to shippable object
shippingState	Reference to constant from ShipmentInterface
createdAt	Creation time
updatedAt	Last update time

Note

This model implements the ShipmentItemInterface.

For more detailed information go to Sylius API ShipmentItem.

ShippingCategory¶

ShippingCategory object represents category which can be common for ShippingMethod and object which implements ShippableInterface. ShippingCategory has the following properties:

Property	Description
id	Unique id of the ShippingCategory
code	Unique code of the ShippingCategory
name	e.g. “Regular”
description	e.g. “Regular weight items”
createdAt	Creation time
updatedAt	Last update time

Hint

To understand relationship between ShippingMethod and shippable object base on ShippingCategory go to Shipping method requirements.

Note

This model implements the ShippingCategoryInterface.

For more detailed information go to Sylius API ShippingCategory.

ShippingMethod¶

ShippingMethod object represents method of shipping allowed for given shipment. It has the following properties:

Property	Description
id	Unique id of the ShippingMethod
code	Unique code of the ShippingMethod
category	e.g. “Regular”
categoryRequirement	Reference to constant from ShippingMethodInterface
enabled	Boolean flag of enablement
calculator	Reference to constant from DefaultCalculators
configuration	Extra configuration for calculator
rules	Collection of Rules
createdAt	Creation time
updatedAt	Last update time
currentTranslation	Translation chosen from translations list accordingly to current locale
currentLocale	Currently set locale
translations	Collection of translations
fallbackLocale	Locale used in case no translation is available

Note

This model implements the ShippingMethodInterface and uses the TranslatableTrait.

For more detailed information go to Sylius API ShippingMethod.

ShippingMethodTranslation¶

ShippingMethodTranslation object allows to translate the shipping method’s name accordingly to the provided locales. It has the following properties:

Property	Description
id	Unique id of the ShippingMethodTranslation
name	e.g. “FedEx”
locale	Translation locale
translatable	The translatable model assigned to this translation

Note

This model implements the ShippingMethodTranslationInterface and extends AbstractTranslation class.

Form more information go to Sylius API ShippingMethodTranslation.

Interfaces¶

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!

Model Interfaces¶

RuleInterface¶

This interface should be implemented by class which will provide additional restriction for ShippingMethod.

Note

For more detailed information go to Sylius API RuleInterface.

ShipmentInterface¶

This interface should be implemented by class which will provide information about shipment like: state, shipping method and so on. It also has a method for shipment tracking.

Note

This interface extends the ShippingSubjectInterface.

For more detailed information go to Sylius API ShipmentInterface.

ShipmentItemInterface¶

This interface is implemented by class responsible for connecting shippable object with proper shipment. It also provides information about shipment state.

Note

This interface extends the ShippingSubjectInterface.

For more detailed information go to Sylius API ShipmentItemInterface.

ShippableInterface¶

This interface should be implemented by model representing physical object which can by stored in a shop.

Note

For more detailed information go to Sylius API ShippableInterface.

ShippingCategoryInterface¶

This interface should be implemented by model representing a shipping category and it is required if you want to classify shipments and connect it with right shipment method.

Note

This interface extends the CodeAwareInterface and TimestampableInterface.

For more detailed information go to Sylius API ShippingCategoryInterface.

ShippingMethodInterface¶

This interface provides default requirements for system of matching shipping methods with shipments based on ShippingCategory and allows to add a new restriction to a basic shipping method.

Note

This interface extends the CodeAwareInterface, TimestampableInterface and ShippingMethodTranslationInterface.

For more detailed information go to Sylius API ShippingMethodInterface.

ShippingMethodTranslationInterface¶

This interface should be implemented by model responsible for keeping translation for ShippingMethod name.

Note

For more detailed information go to Sylius API ShippingMethodTranslationInterface.

ShippingSubjectInterface¶

This interface should be implemented by any object, which needs to be evaluated by default shipping calculators and rule checkers.

Note

For more detailed information go to Sylius API ShippingSubjectInterface.

Calculator interfaces¶

CalculatorInterface¶

This interface provides basic methods for calculators. Every custom calculator should implement CalculatorInterface or extends class Calculator, which has a basic implementation of methods from this interface.

Note

For more detailed information go to Sylius API CalculatorInterface.

DelegatingCalculatorInterface¶

This interface should be implemented by any object, which will be responsible for delegating the calculation to a correct calculator instance.

Note

For more detailed information go to Sylius API DelegatingCalculatorInterface.

CalculatorRegistryInterface¶

This interface should be implemented by an object, which will keep all calculators registered inside container.

Note

For more detailed information go to Sylius API CalculatorRegistryInterface.

Checker Interfaces¶

RuleCheckerRegistryInterface¶

This interface should be implemented by an service responsible for providing an information about available rule checkers.

Note

For more detailed information go to Sylius API RuleCheckerRegistryInterface.

RuleCheckerInterface¶

This interface should be implemented by an object, which checks if a shipping subject meets the configured requirements.

Note

For more detailed information go to Sylius API RuleCheckerInterface.

ShippingMethodEligibilityCheckerInterface¶

This interface should be implemented by an object, which checks if the given shipping subject is eligible for the shipping method rules.

Note

For more detailed information go to Sylius API ShippingMethodEligibilityCheckerInterface.

Processor Interfaces¶

ShipmentProcessorInterface¶

This interface should be implemented by an object, which updates shipments and shipment items states.

Note

For more detailed information go to Sylius API ShipmentProcessorInterface.

Resolver Interfaces¶

ShippingMethodsResolverInterface¶

This interface should be used to create object, which provides information about all allowed shipping methods for given shipping subject.

Note

For more detailed information go to Sylius API ShippingMethodsResolverInterface.

State Machine¶

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!

Shipment States¶

Sylius itself uses a state machine system to manage all states of the business domain. This component has some sensible default states defined in ShipmentInterface.

All new Shipment instances have the state ready by default, which means they are prepared to be sent.

The following states are defined:

Related constant	State	Description
STATE_READY	ready	Payment received, shipment has been ready to be sent
STATE_CHECKOUT	checkout	Shipment has been created
STATE_ONHOLD	onhold	Shipment has been locked and it has been waiting to payment
STATE_PENDING	pending	Shipment has been waiting for confirmation of receiving payment
STATE_SHIPPED	shipped	Shipment has been sent to the customer
STATE_CANCELLED	cancelled	Shipment has been cancelled
STATE_RETURNED	returned	Shipment has been returned

Learn more¶

Shipments in the Sylius platform - concept documentation

Taxation¶

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!

Tax rates and tax classification for PHP applications. You can define different tax categories and match them to objects.

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!

You can install the component in 2 different ways:

Install it via Composer (sylius/taxation on Packagist);
Use the official Git repository (https://github.com/Sylius/Taxation).

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 Sylius component.

Basic Usage¶

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!

Tax Rate¶

Every tax rate has three identifiers, an ID, code and name. You can access those by calling ->getId(), ->getCode() and getName() respectively. The name and code are mutable, so you can change them by calling ->setCode('X12XW') and ->setName('EU VAT') on the tax rate instance.

Setting Tax Amount¶

A tax rate has two basic amounts - the amount and the amount as percentage (by default equal 0).

<?php

use Sylius\Component\Taxation\Model\TaxRate;
use Sylius\Component\Taxation\Model\TaxCategory;

$taxRate = new TaxRate();
$taxCategory = new TaxCategory();

$taxRate->setAmount(0.5);
$taxRate->getAmount(); // Output will be 0.5
$taxRate->getAmountAsPercentage(); // Output will be 50

Setting Tax Category¶

Every tax rate can have a tax category. You can simply set or unset it by calling ->setCategory().

<?php

$taxRate->setCategory($taxCategory);
$taxRate->getCategory(); // Output will be  $taxCategory object
$taxRate->setCategory();
$taxRate->getCategory(); // Output will be null

Including tax rate in price¶

You can mark a tax rate as included in price by calling setIncludedInPrice(true) (false by default). To check if tax rate is included in price call isIncludedInPrice().

Hint

You can read how this property influences on the tax calculation in chapter Default Calculator.

Setting calculator¶

To set type of calculator for your tax rate object call setCalculator('nameOfCalculator'). Notice that nameOfCalculator should be the same as name of your calculator object.

Hint

To understand meaning of this property go to Delegating Calculator.

Tax Category¶

Every tax category has three identifiers, an ID, code and name. You can access those by calling ->getId(), ->getCode() and getName() respectively. The code and name are mutable, so you can change them by calling ->setCode('X12X') and ->setName('Clothing') on the tax category instance.

Tax Rate Management¶

The collection of tax rates (Implementing the Doctrine\Common\Collections\Collection interface) can be obtained using the getRates() method. To add or remove tax rates, you can use the addRate() and removeRate() methods.

<?php

use Sylius\Component\Taxation\Model\TaxRate;
use Sylius\Component\Taxation\Model\TaxCategory;

$taxCategory = new TaxCategory();

$taxRate1 = new TaxRate();
$taxRate1->setName('taxRate1');

$taxRate2 = new TaxRate();
$taxRate2->setName('taxRate2');

$taxCategory->addRate($taxRate1);
$taxCategory->addRate($taxRate2);
$taxCategory->getRates();
//returns a collection of objects that implement the TaxRateInterface
$taxCategory->removeRate($taxRate1);
$taxCategory->hasRate($taxRate2); // returns true
$taxCategory->getRates(); // returns collection with one element

Calculators¶

Default Calculator¶

Default Calculator gives you the ability to calculate the tax amount for given base amount and tax rate.

<?php

use Sylius\Component\Taxation\Model\TaxRate;
use Sylius\Component\Taxation\Calculator\DefaultCalculator;

$taxRate = new TaxRate();
$taxRate->setAmount(0.2);
$basicPrice = 100;
$defaultCalculator = new DefaultCalculator();
$defaultCalculator->calculate($basicPrice, $taxRate); //return 20
$taxRate->setIncludedInPrice(true);
$defaultCalculator->calculate($basicPrice, $taxRate);
// return 17, because the tax is now included in price

Delegating Calculator¶

Delegating Calculator gives you the ability to delegate the calculation of amount of tax to a correct calculator instance based on a type defined in an instance of TaxRate class.

<?php

use Sylius\Component\Taxation\Model\TaxRate;
use Sylius\Component\Taxation\Calculator\DefaultCalculator;
use Sylius\Component\Registry\ServiceRegistry;
use Sylius\Component\Taxation\Calculator\DelegatingCalculator;
use Sylius\Component\Taxation\Calculator\CalculatorInterface;

$taxRate = new TaxRate();
$taxRate->setAmount(0.2);
$base = 100; //set base price to 100
$defaultCalculator = new DefaultCalculator();

$serviceRegistry =
new ServiceRegistry(CalculatorInterface::class);
$serviceRegistry->register('default', $defaultCalculator);

$delegatingCalculator = new DelegatingCalculator($serviceRegistry);
$taxRate->setCalculator('default');
$delegatingCalculator->calculate($base, $taxRate); // returns 20

Tax Rate Resolver¶

TaxRateResolver gives you ability to get information about tax rate for given taxable object and specific criteria. The criteria describes tax rate object.

<?php

use Sylius\Component\Taxation\Resolver\TaxRateResolver;
use Sylius\Component\Taxation\Model\TaxCategory;

$taxRepository = new InMemoryTaxRepository(); // class which implements RepositoryInterface
$taxRateResolver= new TaxRateResolver($taxRepository);

$taxCategory = new TaxCategory();
$taxCategory->setName('TaxableGoods');

$taxableObject = new TaxableObject(); // class which implements TaxableInterface
$taxableObject->setTaxCategory($taxCategory);

$criteria = array('name' => 'EU VAT');
$taxRateResolver->resolve($taxableObject, $criteria);
// returns instance of class TaxRate, which has name 'EU VAT' and category 'TaxableGoods'

Models¶

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!

TaxRate¶

Tax rate model holds the configuration for particular tax rate.

Property	Description
id	Unique id of the tax rate
code	Unique code of the tax rate
category	Tax rate category
name	Name of the rate
amount	Amount as float (for example 0,23)
includedInPrice	Is the tax included in price?
calculator	Type of calculator
createdAt	Date when the rate was created
updatedAt	Date of the last tax rate update

Note

This model implements TaxRateInterface.

TaxCategory¶

Tax category model holds the configuration for particular tax category.

Property	Description
id	Unique id of the tax category
code	Unique code of the tax category
name	Name of the category
description	Description of tax category
rates	Collection of tax rates belonging to this tax category
createdAt	Date when the category was created
updatedAt	Date of the last tax category update

Note

This model implements TaxCategoryInterface.

Interfaces¶

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!

Model Interfaces¶

Taxable Interface¶

To create taxable object which has specific type of tax category, the object class needs to implement TaxableInterface.

Note

For more detailed information go to Sylius API Taxable Interface.

Tax Category Interface¶

To create object which provides information about tax category, the object class needs to implement TaxCategoryInterface.

Note

This interface extends CodeAwareInterface and TimestampableInterface.

For more detailed information go to Sylius API Tax Category Interface.

Tax Rate Interface¶

To create object which provides information about tax rate, the object class needs to implement TaxCategoryInterface.

Note

This interface extends CodeAwareInterface and TimestampableInterface.

For more detailed information go to Sylius API Tax Rate Interface.

Calculator Interfaces¶

CalculatorInterface¶

To make the calculator able to calculate the tax amount for given base amount and tax rate, the calculator class needs implement the CalculatorInterface.

Note

For more detailed information about the interfaces go to Sylius API Calculator Interface.

Resolver Interfaces¶

TaxRateResolverInterface¶

To create class which provides information about tax rate for given taxable object and specific criteria, the class needs to implement TaxRateResolverInterface. The criteria describes tax rate object.

Note

For more detailed information about the interfaces go to Sylius API Tax Rate Resolver Interface.

Learn more¶

Taxation in the Sylius platform - concept documentation

Taxonomy¶

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!

Basic taxonomies library for any PHP application. Taxonomies work similarly to the distinction of species in the fauna and flora and their aim is to help the store owner manage products.

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!

You can install the component in 2 different ways:

Install it via Composer (sylius/taxonomy on Packagist);
Use the official Git repository (https://github.com/Sylius/Taxonomy).

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 Sylius component.

Basic Usage¶

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!

<?php

use Sylius\Component\Taxonomy\Model\Taxon;
use Sylius\Component\Taxonomy\Model\Taxonomy;

// Let's assume we want to begin creating new taxonomy in our system
// therefore we think of a new taxon that will be a root for us.
$taxon = new Taxon();

// And later on we create a taxonomy with our taxon as a root.
$taxonomy = new Taxonomy($taxon);

// Before we can start using the newly created taxonomy, we have to define its locales.
$taxonomy->setFallbackLocale('en');
$taxonomy->setCurrentLocale('en');
$taxonomy->setName('Root');

$taxon->getName(); //will return 'Root'

Models¶

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!

Taxonomy is a list constructed from individual Taxons. Taxonomy is a special case of Taxon itself (it has no parent). All taxons can have many child taxons, you can define as many of them as you need.

Good examples of taxonomies are “Categories” and “Brands”. Below you can see exemplary trees.

| Categories
|\__T-Shirts
|   |\__Men
|    \__Women
|\__Stickers
|\__Mugs
 \__Books

| Brands
|\__SuperTees
|\__Stickypicky
|\__Mugland
 \__Bookmania

Taxon¶

Property	Description
id	Unique id of the taxon
code	Unique code of the taxon
name	Name of the taxon taken form the `TaxonTranslation`
slug	Urlized name taken from the `TaxonTranslation`
description	Description of taxon taken from the `TaxonTranslation`
parent	Parent taxon
children	Sub taxons
left	Location within taxonomy
right	Location within taxonomy
level	How deep it is in the tree
position	Position of the taxon on its taxonomy

Note

This model implements the TaxonInterface. You will find more information about this model in Sylius API Taxon.

TaxonTranslation¶

This model stores translations for the Taxon instances.

Property	Description
id	Unique id of the taxon translation
name	Name of the taxon
slug	Urlized name
description	Description of taxon

Note

This model implements the TaxonTranslationInterface. You will find more information about this model in Sylius API TaxonTranslation.

Interfaces¶

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!

Models Interfaces¶

TaxonInterface¶

The TaxonInterface gives an object an ability to have Taxons assigned as children.

Note

This interface extends the CodeAwareInterface, TranslatableInterface and the TaxonTranslationInterface.

You will find more information about that interface in Sylius API TaxonInterface.

TaxonsAwareInterface¶

The TaxonsAwareInterface should be implemented by models that can be classified with taxons.

Note

You will find more information about that interface in Sylius API TaxonsAwareInterface.

TaxonTranslationInterface¶

This interface should be implemented by models that will store the Taxon translation data.

Note

You will find more information about that interface in Sylius API TaxonTranslationInterface.

Services Interfaces¶

TaxonRepositoryInterface¶

In order to have a possibility to get Taxons as a list you should create a repository class, that implements this interface.

Note

You will find more information about that interface in Sylius API TaxonRepositoryInterface.

Learn more¶

Taxons in the Sylius platform - concept documentation

User¶

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!

Users management implementation in PHP.

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!

You can install the component in 2 different ways:

Install it via Composer (sylius/user on Packagist);
Use the official Git repository (https://github.com/Sylius/User).

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 Sylius component.

Models¶

Customer¶

The customer is represented as a Customer instance. It should have everything concerning personal data and as default has the following properties:

Property	Description	Type
id	Unique id of the customer	integer
email	Customer’s email	string
emailCanonical	Normalized representation of an email (lowercase)	string
firstName	Customer’s first name	string
lastName	Customer’s last name	string
birthday	Customer’s birthday	DateTime
gender	Customer’s gender	string
user	Corresponding user object	UserInterface
group	Customer’s groups	Collection
createdAt	Date of creation	DateTime
updatedAt	Date of update	DateTime

Note

This model implements CustomerInterface

User¶

The registered user is represented as an User instance. It should have everything concerning application user preferences and a corresponding Customer instance. As default has the following properties:

Property	Description	Type
id	Unique id of the user	integer
customer	Customer which is associated to this user (required)	CustomerInterface
username	User’s username	string
usernameCanonical	Normalized representation of a username (lowercase)	string
enabled	Indicates whether user is enabled	bool
salt	Additional input to a function that hashes a password	string
password	Encrypted password, must be persisted	string
plainPassword	Password before encryption, must not be persisted	string
lastLogin	Last login date	DateTime
confirmationToken	Random string used to verify user	string
passwordRequestedAt	Date of password request	DateTime
locked	Indicates whether user is locked	bool
expiresAt	Date when user account will expire	DateTime
credentialExpiresAt	Date when user account credentials will expire	DateTime
roles	Security roles of a user	array
oauthAccounts	Associated OAuth accounts	Collection
createdAt	Date of creation	DateTime
updatedAt	Date of update	DateTime

Note

This model implements UserInterface

CustomerGroup¶

The customer group is represented as a CustomerGroup instance. It can be used to classify customers. As default has the following properties:

Property	Description	Type
id	Unique id of the group	integer
name	Group name	string

Note

This model implements CustomerGroupInterface

UserOAuth¶

The user OAuth account is represented as an UserOAuth instance. It has all data concerning OAuth account and as default has the following properties:

Property	Description	Type
id	Unique id of the customer	integer
provider	OAuth provider name	string
identifier	OAuth identifier	string
accessToken	OAuth access token	string
user	Corresponding user account	UserInterface

Note

This model implements UserOAuthInterface

Basic Usage¶

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!

Canonicalization¶

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!

In order to be able to query or sort by some string, we should normalize it. The most common use case for that is canonical email or username. We can then allow for case insensitive users identification by email or username.

Canonicalizer¶

User component offers simple canonicalizer which converts given string to lowercase letters. Example usage:

<?php
// src/script.php

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

use Sylius\Component\User\Model\User;
use Sylius\Component\Canonicalizer\Canonicalizer;

$canonicalizer = new Canonicalizer();

$user = new User();
$user->setEmail('MyEmail@eXample.Com');

$canonicalEmail = $canonicalizer->canonicalize($user->getEmail());
$user->setEmailCanonical($canonicalEmail);

$user->getEmail(); // returns 'MyEmail@eXample.Com'
$user->getEmailCanonical(); // returns 'myemail@example.com'

Updating password¶

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!

In order to store user’s password safely you need to encode it and get rid of the plain password.

PasswordUpdater¶

User component offers simple password updater and encoder. All you need to do is set the plain password on User entity and use updatePassword method on PasswordUpdater. The plain password will be removed and the encoded password will be set on User entity. Now you can safely store the encoded password. Example usage:

<?php
// src/script.php

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

use Sylius\Component\User\Model\User;
use Sylius\Component\User\Security\PasswordUpdater;
use Sylius\Component\User\Security\UserPbkdf2PasswordEncoder;

$user = new User();
$user->setPlainPassword('secretPassword');

$user->getPlainPassword(); // returns 'secretPassword'
$user->getPassword(); // returns null

// after you set user's password you need to encode it and get rid of unsafe plain text
$passwordUpdater = new PasswordUpdater(new UserPbkdf2PasswordEncoder());
$passwordUpdater->updatePassword($user);

// the plain password no longer exist
$user->getPlainPassword(); // returns null
// encoded password can be safely stored
$user->getPassword(); //returns 'notPredictableBecauseOfSaltHashedPassword'

Note

The password encoder takes user’s salt (random, autogenerated string in the User constructor) as an additional input to a one-way function that hashes a password. The primary function of salts is to defend against dictionary attacks versus a list of password hashes and against pre-computed rainbow table attacks.

Learn more¶

Customers & Users in the Sylius platform - concept documentation

The Performance Guide¶

With The Performance Guide you can decrease page loading times.

The Performance Guide¶

With huge databases some of you may experience performance issues, with this guide you can learn how to handle even millions of records.

Database indexes¶

Indexing tables allow you to decrease fetching time from the database.

As an example, let’s take a look at the customers’ list.

The default index page is sorted by registration date, to create a table index all you need to do is modify AppEntityCustomerCustomer entity and add the index using annotations.

In this file, add indexes attribute into the table configuration:

/**
* @ORM\Table(name="sylius_customer", indexes={@ORM\Index(name="created_at_index", columns={"created_at"})})
*/

Your class should now look like this:

<?php

declare(strict_types=1);

namespace App\Entity\Customer;

use Doctrine\ORM\Mapping as ORM;
use Sylius\Component\Core\Model\Customer as BaseCustomer;

/**
 * @ORM\Entity
 * @ORM\Table(name="sylius_customer",indexes={@ORM\Index(name="created_at_index", columns={"created_at"})})
 */
class Customer extends BaseCustomer
{
}

Note

You can learn more here about ORM annotations

This should be considered for the most common sorting in your application.

Note

Using this solution you can increase speed of customer listing by around 10%. Indexes should be used when working with huge tables, otherwise it doesnt really affect loading times.

Query optimization¶

A huge performance boost is achieved by optimizing queries. For example, let’s take a look at the customers’ list.

By default, we don’t really need to fetch every single field from a customer entity to create a list of 10 customers. All we need, is to load the id and the field we are sorting by (for pagination purposes).

Once these 10 customers are fetched, we can create 10 queries to fetch data for them. As it can slow down small databases (a lot of unnecessary queries), this allows tables with millions of records to be loaded in less than a second.

It seems to be a bit complicated, but PagerfantaAdapterDoctrineORMAdapter allow us to achieve it easily.

The second argument of PagerfantaAdapterDoctrineORMAdapter is fetchJoinCollection, which is set to false by default. Changing it to true, forces the database to fetch additional data once we get sorted results.

With 3 000 000 customers this method allows you to load page up to 70% faster.

Warning

This solution may slow down loading page with small tables as it will create additional database queries.

This solution will be turned on by default on SyliusGridBundle since version 1.10. For the earlier versions, the PagerfantaAdapterDoctrineORMAdapter has to be adjusted manually, by overriding the SyliusBundleGridBundleDoctrineORMDataSource class.