Skip to content
  • Documentation >
  • Commerce >
  • Shopping list >
  • Install shopping list

Install Shopping list

Install framework

Run the following command to install the package:

1
composer require ibexa/shopping-list

TODO: Describe what install does

Check that the following line have been added by the recipe to config/bundles.php file's array: 

1
    Ibexa\Bundle\ShoppingList\IbexaShoppingListBundle::class => ['all' => true],

Modify database schema

Add the tables needed by the bundle:

1
php bin/console ibexa:doctrine:schema:dump-sql vendor/ibexa/shopping-list/src/bundle/Resources/config/schema.yaml | mysql -u <username> -p <password> <database_name>

1
php bin/console ibexa:doctrine:schema:dump-sql --force-platform=postgres vendor/ibexa/shopping-list/src/bundle/Resources/config/schema.yaml | psql <database_name>

TODO: possible charset issue, see https://github.com/ibexa/doctrine-schema/pull/38

TODO: Default shopping list creation for existing customers? The default shopping lists are created when used.

Configure

By default, the maximum shopping list count per user is 10 and the maximum entries per list is 100.

TODO: explain list_per_page_limit

You can override the following parameters to change their values:

1
2
3
4
parameters:
    ibexa.site_access.config.default.shopping_list.limits.max_lists_per_user: 10
    ibexa.site_access.config.default.shopping_list.limits.max_entries_per_list: 100
    ibexa.site_access.config.default.shopping_list.pagination.list_per_page_limit: 25

TODO: Probably a file that will be created by recipe:

1
2
3
4
5
6
7
8
# config/routes/ibexa_shopping_list.yaml

ibexa.shopping_list:
    resource: '@IbexaShoppingListBundle/Resources/config/routing.php'

ibexa.rest.shopping_list:
    resource: '@IbexaShoppingListBundle/Resources/config/routing_rest.php'
    prefix: '%ibexa.rest.path_prefix%'

Role

As anonymous users can't have shopping lists, create a new role and then assign it to registered customer groups who should be able to use this feature. Use the limitation 'Shopping List Owner: Self' to restrict to only their own lists.

To create such role, you can use a migration file, for example, with the following content:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
-   type: role
    mode: create
    metadata:
        identifier: Shopping List User
    policies:
        -   module: shopping_list
            function: create
            limitations:
                -   identifier: ShoppingListOwner
                    values: [self]
        -   module: shopping_list
            function: view
            limitations:
                -   identifier: ShoppingListOwner
                    values: [self]
        -   module: shopping_list
            function: edit
            limitations:
                -   identifier: ShoppingListOwner
                    values: [self]
        -   module: shopping_list
            function: delete
            limitations:
                -   identifier: ShoppingListOwner
                    values: [self]

TODO: On a clean install, which user groups would be the best candidates to have this role assigned to?