Sylius Menu Plugin

Plugin allow to manage Shop menus from the Back Office

Features:

• Create/Delete menu with commands :
  • wemea:menu:create <code>
  • wemea:menu:delete <code>
• Manage visibility of menus
• Manage menu item (link, title, description, order/priority, icon)
• Default link types :
  • Custom: put any link inside
  • Product: choose link to a product and path is generated dynamically
  • Taxon: choose link to a taxononmy and path is generated dynamically

Summary

1. Installation
2. Usage
   1. Add new menu
   2. Change default route mapping
   3. Add Custom resource link
3. Use menu fixtures

Installation

1. Require plugin with composer:

2. Add followings to your config/bundles.php if not already automatically added:

3. Import config in your config/packages/_sylius.yaml:

4. Import routes in your config/routes.yml:

5. Add menus into your template. Check Usage - Add a menu for more information

6. Run integration test.

   :warning: There are integration tests only for admin part. You should add your owned tests for shop part.

Usage

Add a menu

Tips :

Menus can only be created and removed with Symfony command to avoid shop admin removed accidentally a menu and block the UI. Menus can be disabled on the BO.

1. Create new menu

   Run bin/console wemea:menu:create <your_menu_code>

   You can run bin/console wemea:menu:create --help to view available options

2. Add this menu in your template: add this where you want to introduce menu to your page(s)

   By default, the menu use @WemeaSyliusMenuPlugin/Shop/Menu/_default.html.twig. If you want to use your own template, add tempalte option on render :

3. Add behat test to check menu integration

   You can view full integration on this folder

Change default resource route mapping

If you change defaults routes of application, you need to change route mapping of link resources. You can do it on config/packages/wemea_sylius_menu.yml with this configuration :

Parameters node is an associative array between route parameter and the method name to access at the resource property

Add new link type to another resource

This plugin allows creating new resource link. You may need it to redirect on custom resource (like brand, we use this example for instruction example)

1. Override the default MenuLink entity:

2. Declare this entity as resource model into config/packages/_sylius.yml

3. Add form extension for Wemea\SyliusMenuPlugin\Form\Type\MenuLinkType with (autocomplete ?) choice type. Check official documentation create form extension.

   This field should NOT be mapped

   This new field is automatically add to template. By default, it uses : {{ form_row(form.brand) }}.

   If you want use a custom template, you can create templates/bundles/WemeaSyliusMenuPlugin/Admin/MenuLink/Form/Fields/_<field_name>.html.twig and use field with the property form.

4. Add routing configuration on config/packages/wemea_sylius_menu.yml

5. Clear cache and make migration to update schema

Use menu fixtures

If you need to load menu programmatically, you can use menu fixture like it :

To see a full implementation example, you can check the file footer_help_menu.yaml.

Issues / Remaining work

• Add fixtures for Menu item images
• Add possibility to add an anchor as custom link
• Manage resolve path according current locale for custom links in the case where store use localized URL