Skip to content

Latest commit

 

History

History
119 lines (83 loc) · 3.52 KB

taxons.rst

File metadata and controls

119 lines (83 loc) · 3.52 KB
Raw

single: Taxons

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 funtionalities 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. On its basis for instance the breadcrumbs are generated. But also you can use it for your own logic, like for instance links generation.

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

Learn more

  • Taxonomy - Bundle Documentation </components_and_bundles/bundles/SyliusTaxonomyBundle/index>
  • taxonomy - Component Documentation </components_and_bundles/components/Taxonomy/index>