Architecture Overview¶

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');

    $manager->persist($product1);
    $manager->remove($product2);
    $manager->flush(); // Save changes in database.
}

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(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.
}

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 returns 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(array('foo' => true), array('createdAt' => 'desc'));
    $products->setMaxPerPage(3);
    $products->setCurrentPage($request->query->get('page', 1));
}

To create a new object instance, you can simply call the createNew() method on the repository.

Now let’s try something else than product, we’ll create a new TaxRate model.

<?php

public function myAction()
{
    $repository = $this->container->get('sylius.repository.tax_rate');
    $taxRate = $repository->createNew();
}

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 can see, these actions match the common operations in any REST API and yes, they are format agnostic. That means, all Sylius controllers can serve HTML, JSON or XML, depending on what do 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 you own resources as well. To give you some idea of what is possible, here are some examples!

Displaying a resource with custom template and repository methods:

# routing.yml

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.
            method: findForStore # Use custom repository method.
            arguments: [$slug] # Pass the slug from the url to the repository.

Creating a product using custom form and redirection method:

# routing.yml

app_product_create:
    path: /my-stores/{store}/products/new
    methods: [GET, POST]
    defaults:
        _controller: sylius.controller.product:createAction
        _sylius:
            form: app_user_product # Use this form type!
            template: AppStoreBundle:Product:create.html.twig # Use a custom template.
            factory:
                method: createForStore # Use 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 his products.
                parameters: [$store]

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