KnpBundles

Developed with love by KnpLabs Hire us for your project!
52

SyliusCategorizerBundle

by Sylius

Categorizing feature for your next Symfony2 application, supports nested categories and multiple catalogs.

SyliusCategorizerBundle Build status...

Categorizing whatever you want just got easier. Grouping products, posts or any other model is common feature in most of modern web applications.
So why implement it every time you need it? You can use this bundle to create multiple categorized catalogs of any object.
It provides all controllers, routing, base mapping and services that will boost you development.

This bundle is compatible only with 2.1.x branch of Symfony2.

Features

  • Base support for many different persistence layers. Currently only Doctrine ORM driver is implemented.
  • Allows you to create custom ordered flat list of categories, default controllers and forms will handle CRUD and moving up/down the categories.
  • Thanks to Doctrine Extensions library you can have nested set of categories, just extend proper class, modify form, add little mapping and it works.
  • Handles both many-to-one and many-to-many relations between objects and the categories. Bundle will check it for you.
  • You can create as many catalogs as you want, by catalog we understand set of categories and the items, for example products or blog posts.
  • It uses Pagerfanta to paginate over the category items, but you can easily disable the pagination for specific catalog.
  • Thanks to awesome Symfony2 everything is configurable and extensible.

Sylius

Sylius is simple but end-user and developer friendly webshop engine built on top of Symfony2.

Please visit Sylius.org for more details.

Testing and build status

This bundle uses travis-ci.org for CI.
Build status...

Before running tests, load the dependencies using Composer.

$ wget http://getcomposer.org/composer.phar
$ php composer.phar install --dev

Now you can run the tests by simply using this command.

$ phpunit

Code examples

If you want to see working implementation, try out the Sylius sandbox application.
It's open sourced github project.

Documentation

Documentation is available on readthedocs.org.

Contributing

All informations about contributing to Sylius can be found on this page.

Mailing lists

Users

If you are using this bundle and have any questions, feel free to ask on users mailing list.
Mail or view it.

Developers

If you want to contribute, and develop this bundle, use the developers mailing list.
Mail or view it.

Sylius twitter account

If you want to keep up with updates, follow the official Sylius account on twitter
or follow me.

Bug tracking

This bundle uses GitHub issues.
If you have found bug, please create an issue.

Versioning

Releases will be numbered with the format major.minor.patch.

And constructed with the following guidelines.

  • Breaking backwards compatibility bumps the major.
  • New additions without breaking backwards compatibility bumps the minor.
  • Bug fixes and misc changes bump the patch.

For more information on SemVer, please visit semver.org website.

This versioning method is same for all Sylius bundles and applications.

License

License can be found here.

Authors

The bundle was originally created by Paweł Jędrzejewski.
See the list of contributors.

Copyright (c) 2011-2012 Paweł Jędrzejewski

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.
sylius_categorizer:

    driver:               ~ # Required

    engine:               twig

    catalogs:



        # Prototype

        alias:

            model:                ~ # Required

            property:             ~ # Required

            form:                 sylius_categorizer_category

            pagination:

                disable:              false

                mpp:                  10

            templates:

                frontend:             SyliusCategorizerBundle:Frontend/Category:%s.html.twig

                backend:              SyliusCategorizerBundle:Backend/Category:%s.html.twig

    classes:

        controller:

            backend:

                category:             Sylius\Bundle\CategorizerBundle\Controller\Backend\CategoryController

            frontend:

                category:             Sylius\Bundle\CategorizerBundle\Controller\Frontend\CategoryController

        manipulator:

            category:             Sylius\Bundle\CategorizerBundle\Manipulator\CategoryManipulator