stefandoorn/sylius-street-number-plugin

Split number from street per address Sylius.


README

Sylius Street Number Plugin

This plugin helps you split street & number.

Features:

  • Add streetNumber field to Address form (and database)

Optional features:

  • Add streetNumberAddition field to Address form (and database)

Installation

  1. Require plugin with composer:

    composer require stefandoorn/sylius-street-number-plugin:^1.0@beta
  2. Add plugin class to your AppKernel.

    $bundles = [
       new \StefanDoorn\SyliusStreetNumberPlugin\SyliusStreetNumberPlugin(),
    ];
  3. Add to your config:

    - { resource: "@SyliusStreetNumberPlugin/Resources/config/config.yml" }
  4. Add doctrine mapping fields for table sylius_address (see tests/Application/config/doctrine/Address.orm.yml):

        ...
        table: sylius_address
        fields:
            number:
                column: street_number
                type: string
                nullable: false
                options:
                    default: ''
            addition:
                column: street_number_addition
                type: string
                nullable: true                 

    The streetNumberAddition field is always added, regardless whether you use it. It will be null in that cae.

  5. Add to _sylius.yaml:

       ...
    
       sylius_addressing:
          resources:
             address:
                classes:
                 model: App\Entity\Addressing\Address
  6. Add to SyliusAdminBundle/views/Common/Form/_address.html.twig:

    {{ form_row(form.number) }}
  7. Add to SyliusShopBundle/views/Common/Form/_address.html.twig:

    {{ form_row(form.number) }}
  8. Update database:

    $ bin/console doctrine:migrations:diff
    $ bin/console doctrine:migrations:migrate

(Optional) Add streetNumberAddition field

  1. Enable in config (for form extension):

    sylius_street_number:
        features:
            street_number_addition: true
  2. Add to SyliusAdminBundle/views/Common/Form/_address.html.twig:

    {{ form_row(form.addition) }}
  3. Add to SyliusShopBundle/views/Common/Form/_address.html.twig:

    {{ form_row(form.addition) }}