You are browsing the latest version of the documentation which is not released yet. See the current stable version instead.

Extending Product List

If you want add more information to product lists, you need to do a little bit more than extending an entity. That is because the frontend product lists leverage the read model concept, i.e. special view objects are used instead of common Doctrine entities in the Twig templates.

This cookbook describes how to extend the frontend product lists with step by step instructions.

Display a brand name in a product view on the product list

1. Extend ListedProductView class and add a new attribute.

The class encapsulates the data that are needed for displaying products on FE product lists. We want to display a brand name for each product so we need to add the attribute to the class.

declare(strict_types=1);

namespace App\Model\Product\View;

use Shopsys\FrameworkBundle\Model\Product\Pricing\ProductPrice;
use Shopsys\ReadModelBundle\Image\ImageView;
use Shopsys\ReadModelBundle\Product\Action\ProductActionView;
use Shopsys\ReadModelBundle\Product\Listed\ListedProductView as BaseListedProductView;

class ListedProductView extends BaseListedProductView
{
    /**
     * @var string|null
     */
    protected $brandName;

    /**
     * @param int $id
     * @param string $name
     * @param string|null $shortDescription
     * @param string $availability
     * @param \Shopsys\FrameworkBundle\Model\Product\Pricing\ProductPrice $sellingPrice
     * @param array $flagIds
     * @param \Shopsys\ReadModelBundle\Product\Action\ProductActionView $action
     * @param \Shopsys\ReadModelBundle\Image\ImageView|null $image
     * @param string|null $brandName
     */
    public function __construct(
        int $id,
        string $name,
        ?string $shortDescription,
        string $availability,
        ProductPrice $sellingPrice,
        array $flagIds,
        ProductActionView $action,
        ?ImageView $image,
        ?string $brandName
    ) {
        parent::__construct($id, $name, $shortDescription, $availability, $sellingPrice, $flagIds, $action, $image);

        $this->brandName = $brandName;
    }

    /**
     * @return string|null
     */
    public function getBrandName(): ?string
    {
        return $this->brandName;
    }
}

2. Add new attribute to Elasticsearch

In order to add new attribute to Elasticsearch you need to add it to the structure first. You can do that by adding it to mappings in all src/Resources/definition/product/*.json files like this:

  "mappings": {
    "properties": {
+     "brand_name": {
+       "type": "text"
+     },

3. Export new attribute to Elasticsearch

The class responsible for exporting products to Elasticsearch is ProductExportRepository so we need to extend it and add the attribute to method getProductsData.

declare(strict_types=1);

namespace App\Model\Product\Elasticsearch;

use Shopsys\FrameworkBundle\Model\Product\Product as BaseProduct;
use Shopsys\FrameworkBundle\Model\Product\Elasticsearch\ProductExportRepository as BaseProductExportRepository;

class ProductExportRepository extends BaseProductExportRepository
{
   /**
    * @param \App\Model\Product\Product $product
    * @param int $domainId
    * @param string $locale
    * @return array
    */
    protected function extractResult(BaseProduct $product, int $domainId, string $locale): array
    {
        $result = parent::extractResult($product, $domainId, $locale);

        $result['brand_name'] = $product->getBrand() ? $product->getBrand()->getName() : '';

        return $result;
    }
}

You need to register your new class as an alias for the one from the FrameworkBundle in services.yaml and services_test.yaml:

Shopsys\FrameworkBundle\Model\Product\Elasticsearch\ProductExportRepository: '@App\Model\Product\Search\Export\ProductExportRepository'

Then you need to fix ProductExportRepositoryTest::getExpectedStructureForRepository (because this test check if your structure is correct) by adding new attribute:

$structure = \array_merge($structure, [
    'availability',
    'brand',
    'flags',
    'categories',
    'detail_url',
    'in_stock',
    'prices',
    'parameters',
    'ordering_priority',
    'calculated_selling_denied',
    'selling_denied',
    'main_variant',
    'visibility',
+   'brand_name',
]);

4. Extend ProductElasticsearchConverter to fill empty fields

There are old documents in the Elasticsearch, usually in the production environment. Before you reexport all products from the database, there are documents that don't have the new field brand_name. So you have to provide default values for the case of reading such old documents.

declare(strict_types=1);

namespace App\Model\Product\Search;

use Shopsys\FrameworkBundle\Model\Product\Search\ProductElasticsearchConverter as BaseProductElasticsearchConverter;

class ProductElasticsearchConverter extends BaseProductElasticsearchConverter
{
    /**
     * @param array $product
     * @return array
     */
    public function fillEmptyFields(array $product): array
    {
        $result = parent::fillEmptyFields($product);
        $result['brand_name'] = $product['brand_name'] ?? '';

        return $result;
    }
}

You need to register your new class in services.yaml and add it as an alias for the one from the bundle

App\Model\Product\Search\ProductElasticsearchConverter: ~
Shopsys\FrameworkBundle\Model\Product\Search\ProductElasticsearchConverter: '@App\Model\Product\Search\ProductElasticsearchConverter'

5. Extend ListedProductViewFactory so it returns the new required data

The class is responsible for creating the view object. We need to ensure that the objects is created with proper brand name. We are able to get the brand name from the product entity, so we just need to overwrite createFromArray() and createFromProduct() methods.

declare(strict_types=1);

namespace App\Model\Product\View;

use Shopsys\FrameworkBundle\Model\Pricing\Group\PricingGroup;
use Shopsys\FrameworkBundle\Model\Product\Product;
use Shopsys\ReadModelBundle\Image\ImageView;
use Shopsys\ReadModelBundle\Product\Action\ProductActionView;
use Shopsys\ReadModelBundle\Product\Listed\ListedProductViewFactory as BaseListedProductViewFactory;
use Shopsys\ReadModelBundle\Product\Listed\ListedProductView as BaseListedProductView;

class ListedProductViewFactory extends BaseListedProductViewFactory
{
    /**
     * @param array $productArray
     * @param \Shopsys\ReadModelBundle\Image\ImageView|null $imageView
     * @param \Shopsys\ReadModelBundle\Product\Action\ProductActionView $productActionView
     * @param \Shopsys\FrameworkBundle\Model\Pricing\Group\PricingGroup $pricingGroup
     * @return \App\Model\Product\View\ListedProductView
     */
    public function createFromArray(array $productArray, ?ImageView $imageView, ProductActionView $productActionView, PricingGroup $pricingGroup): BaseListedProductView
    {
        return new ListedProductView(
            $productArray['id'],
            $productArray['name'],
            $productArray['short_description'],
            $productArray['availability'],
            $this->priceFactory->createProductPriceFromArrayByPricingGroup($productArray['prices'], $pricingGroup),
            $productArray['flags'],
            $productActionView,
            $imageView,
            $productArray['brand_name']
        );
    }

    /**
     * @param \App\Model\Product\Product $product
     * @param \Shopsys\ReadModelBundle\Image\ImageView|null $imageView
     * @param \Shopsys\ReadModelBundle\Product\Action\ProductActionView $productActionView
     * @return \App\Model\Product\View\ListedProductView
     */
    public function createFromProduct(Product $product, ?ImageView $imageView, ProductActionView $productActionView): BaseListedProductView
    {
        return new ListedProductView(
            $product->getId(),
            $product->getName(),
            $product->getShortDescription($this->domain->getId()),
            $product->getCalculatedAvailability()->getName(),
            $this->productCachedAttributesFacade->getProductSellingPrice($product),
            $this->getFlagIdsForProduct($product),
            $productActionView,
            $imageView,
            $product->getBrand() !== null ? $product->getBrand()->getName() : null
        );
    }
}

You need to register your new class as an alias for the one from the bundle in services.yaml:

    Shopsys\ReadModelBundle\Product\Listed\ListedProductViewFactory: '@App\Model\Product\View\ListedProductViewFactory'

6. Modify the frontend template for rendering product lists so it displays the new attribute

All product lists are rendered using productListMacro.html.twig. You can modify this macro to display product brand name wherever it is suitable for you.

{# templates/Front/Content/Product/productListMacro.html.twig #}

<p class="list-products__item__info__description">
+    {{ productView.brandName }}
+    <br>
    {{ productView.shortDescription }}
</p>