Code Monkey home page Code Monkey logo

magento2-country-store's Introduction

Country Store Module for Magento 2

Latest Stable Version License: MIT Packagist Packagist

This module add the many countries to many stores relation and make it available to the storefront.

Setup

Magento 2 Open Source or Commerce edition is required.

Composer installation

Run the following composer command:

composer require opengento/module-country-store

Setup the module

Run the following magento command:

bin/magento setup:upgrade

If you are in production mode, do not forget to recompile and redeploy the static resources.

Features

Country to store mapping

Define many countries to many stores relation. This configuration will allows Magento to map stores with countries.

Settings

The configuration for this module is available in Stores > Configuration > General > Country Store.

Documentation

How to add a country resolver

Create a new final class and implements the following interface: Opengento\CountryStore\Api\CountryResolverInterface. The method public function getCountry(): CountryInterface should return the default country depending of the context. The country code should be compliant to ISO 3166-1 alpha-2 format.

Register the new country resolver in the method factory, Vendor/Module/etc/di.xml:

<type name="Opengento\CountryStore\Model\Resolver\ResolverFactory">
    <arguments>
        <argument name="countryResolvers" xsi:type="array">
            <item name="customCountryResolver" xsi:type="string">Vendor\Module\Model\Country\Resolver\CustomCountryResolver</item>
        </argument>
    </arguments>
</type>

If you want the resolver to be available in settings, add it to the resolver list, Vendor/Module/etc/di.xml:

<virtualType name="Opengento\CountryStore\Model\Config\Source\CountryResolver">
    <arguments>
        <argument name="options" xsi:type="array">
            <item name="customCountryResolver" xsi:type="array">
                <item name="label" xsi:type="string" translatable="true">Custom Country Resolver</item>
                <item name="value" xsi:type="const">Vendor\Module\Model\Country\Resolver\CustomCountryResolver::RESOLVER_CODE</item>
            </item>
        </argument>
    </arguments>
</virtualType>

The country resolver is ready to use.

Support

Raise a new request to the issue tracker.

Authors

  • Opengento Community - Lead - Twitter Follow
  • Thomas Klein - Maintainer - GitHub followers
  • Contributors - Contributor - GitHub contributors

License

This project is licensed under the MIT License - see the LICENSE details.

That's all folks!

magento2-country-store's People

Contributors

thomas-kl1 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

mp-biomedicals

magento2-country-store's Issues

Geoip modal

Keep native store language switcher but enables stores by brands

Open modal if requested store is different from resolved by geoip and user didn't set it's preference first

Info

Hi there! I want to ask if there is a method to create a popup to select the country for the first time when an user enters on site. Thank you!

Country Store Url

Allows to replace store code in path by a custom value, or the country code.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.