2. Taxonomy and Taxons¶

2.1. Retrieving taxonomies and taxons¶

Retrieving taxonomy 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 taxonomy repository is always accessible via sylius.repository.taxonomy service. Of course, sylius.repository.taxon is also available for use, but usually you obtains taxons directly from Taxonomy model. You’ll see that in further parts of this document.

<?php

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

Retrieving taxonomies is simpleas calling proper methods on the repository.

<?php

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

    $taxonomy = $repository->find(2); // Get taxonomy with id 2, returns null if not found.
    $taxonomy = $repository->findOneBy(array('name' => 'Specials')); // Get one taxonomy by defined criteria.

    $taxonomies = $repository->findAll(); // Load all the taxonomies!
    $taxonomies = $repository->findBy(array('hidden' => true)); // Find taxonomies matching some custom criteria.
}

Taxonomy repository also supports paginating taxonomies. To create a Pagerfanta instance use the createPaginator method.

<?php

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

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

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

Paginator also can be created for specific criteria and with desired sorting.

<?php

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

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

2.2. Creating new taxonomy object¶

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

<?php

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

Примечание

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

2.3. Saving & removing taxonomy¶

To save or remove a taxonomy, you can use any ObjectManager which manages Taxonomy. You can always access it via alias sylius.manager.taxonomy. But it’s also perfectly fine if you use doctrine.orm.entity_manager or other appropriate manager service.

<?php

public function myAction(Request $request)
{
    $repository = $this->container->get('sylius.repository.taxonomy');
    $manager = $this->container->get('sylius.manager.taxonomy'); // Alias for appropriate doctrine manager service.

    $taxonomy = $repository->createNew();

    $taxonomy
        ->setName('Foo')
    ;

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

To remove a taxonomy, you also use the manager.

<?php

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

    $taxonomy = $repository->find(5);

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

2.4. Taxons¶

Taxons can be handled exactly the same way, but with usage of sylius.repository.taxon.

Taxonomy contains methods which allow you to retrieve the child taxons. Let’s look again at our example tree.

| Categories
|--  T-Shirts
|    |-- Men
|    `-- Women
|--  Stickers
|--  Mugs
`--  Books

To get a flat list of taxons under taxonomy, use the getTaxonsAsList method.

<?php

public function myAction(Request $request)
{
    // Find the taxonomy
    $taxonomyRepository = $this->container->get('sylius.repository.taxonomy');
    $taxonomy = $taxonomyRepository->findOneByName('Categories');

    // Get the taxons as a list
    $taxonRepository = $this->container->get('sylius.repository.taxon');
    $taxons = $taxonRepository->getTaxonsAsList($taxonomy);
}

$taxons variable will now contain flat list (ArrayCollection) of taxons in following order: T-Shirts, Men, Women, Stickers, Mugs, Books.

If, for example, you want to render them as tree.

<?php

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

    $taxons = $taxonomy->getTaxons();
}

Now $taxons contains only the 4 main items, and you can access their children by calling $taxon->getChildren().