stefandoorn/sylius-street-number-plugin

Split number from street per address Sylius.

v1.0.0-beta.5 2023-11-02 14:11 UTC

Requires

• php: ^8.0
• sylius/sylius: ^1.10

Requires (Dev)

• behat/behat: ^3.4
• behat/mink: ^1.7@dev
• behat/mink-browserkit-driver: ^2.0
• behat/mink-extension: ^2.2
• behat/mink-selenium2-driver: ^1.3
• friends-of-behat/mink-debug-extension: ^2.0
• friends-of-behat/page-object-extension: ^0.3.0
• friends-of-behat/service-container-extension: ^1.0
• friends-of-behat/symfony-extension: ^2.0
• friends-of-behat/variadic-extension: ^1.1
• matthiasnoback/symfony-dependency-injection-test: ^4.0
• phpspec/phpspec: ^7.0
• phpstan/phpstan: ^1.0
• phpstan/phpstan-doctrine: ^1.0
• phpstan/phpstan-symfony: ^1.0
• phpstan/phpstan-webmozart-assert: ^1.0
• phpunit/phpunit: ^9.5
• sylius-labs/coding-standard: ^4.0
• symfony/browser-kit: ^4.4 || ^5.4 || ^6.0
• symfony/debug-bundle: ^4.4 || ^5.4 || ^6.0
• symfony/dotenv: ^4.4 || ^5.4 || ^6.0
• symfony/intl: ^4.4 || ^5.4 || ^6.0
• symfony/web-profiler-bundle: ^4.4 || ^5.4 || ^6.0
• symfony/web-server-bundle: ^4.4 || ^5.4 || ^6.0

MIT

• sylius
• sylius-plugin

README

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) }}