Initial commit

Author: Erik van Velzen

.gitignore

@@ -0,0 +1,2 @@
+vendor
+composer.lock

README.md

@@ -0,0 +1,30 @@
+# ZF3 Country dropdown
+
+Country dropdown for [zend-form](https://docs.zendframework.com/zend-form/) (Zend Framework 3).
+
+Works with 2-letter ISO 3166 codes
+
+Options are displayed in the current locale.
+
+## Installation
+
+```
+$ composer require polderknowledge/country-dropdown
+```
+
+## Usage
+
+in Form::init():
+
+```php
+$this->add([
+    'type' => CountrySelect::class,
+    'name' => 'country',
+    'options' => [
+        // optional countries to display first in the dropdown above a separator
+        'top_country_codes' => ['NL', 'ES'],
+    ],
+]);
+```
+
+Rendering can be done in the same way as a normal select element.

composer.json

@@ -0,0 +1,26 @@
+{
+    "name": "polderknowledge/country-dropdown",
+    "description": "Country select box for Zend Framework 3",
+    "type": "library",
+    "autoload": {
+        "psr-4": {
+            "PolderKnowledge\\CountryDropdown\\": "src/"
+        }
+    },
+    "require": {
+        "php": ">= 7.0",
+        "league/iso3166": "^2.1",
+        "zendframework/zend-form": "^2.12",
+        "lstrojny/functional-php": "^1.8"
+    },
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Erik van Velzen",
+            "email": "erik@polderknowledge.nl"
+        }
+    ],
+    "require-dev": {
+        "phpunit/phpunit": "^7"
+    }
+}

phpunit.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit bootstrap="./vendor/autoload.php">
+    <testsuites>
+        <testsuite name="PolderKnowledge Country Dropdown Module">
+            <directory>./test</directory>
+        </testsuite>
+    </testsuites>
+</phpunit>

src/CountrySelect.php

@@ -0,0 +1,101 @@
+<?php
+
+namespace PolderKnowledge\CountryDropdown;
+
+use function Functional\map;
+use function Functional\pluck;
+use function Functional\sort;
+use League\ISO3166\ISO3166;
+use Zend\Form\Element\Select;
+
+class CountrySelect extends Select
+{
+    /**
+     * The countries which should be on top so the end-user can find them easily
+     *
+     * @var string[]
+     */
+    protected $topCountryCodes = [];
+
+    public function setTopCountryCodes(array $topCountryCodes)
+    {
+        $this->topCountryCodes = $topCountryCodes;
+    }
+
+    public function getTopCountryCodes(): array
+    {
+        return $this->topCountryCodes;
+    }
+
+    /**
+     * Usually called by Zend\Form\Factory
+     */
+    public function setOptions($options)
+    {
+        parent::setOptions($options);
+
+        if (isset($options['top_country_codes'])) {
+             $this->setTopCountryCodes($options['top_country_codes']);
+        }
+    }
+
+    /**
+     * Usually called by the FormElementManager
+     * After all the options have been set
+     * and just before handing the element to the user's form or fieldset
+     */
+    public function init()
+    {
+        parent::init();
+
+        $this->valueOptions = self::generateValueOptions($this->getTopCountryCodes());
+    }
+
+    public static function generateValueOptions(array $topCountryCodes): array
+    {
+        $bottomCountryCodes = array_diff(self::generateAllCountryCodes(), $topCountryCodes);
+        $bottomOptions = self::countryCodesToOptions($bottomCountryCodes);
+        $topOptions = self::countryCodesToOptions($topCountryCodes);
+
+        if (empty($topOptions)) {
+            return $bottomOptions;
+        }
+
+        $separatorOption = [
+            'label' => '──────────',
+            'disabled' => true,
+            'value' => null,
+        ];
+
+        return array_merge(
+            $topOptions,
+            [$separatorOption],
+            $bottomOptions
+        );
+    }
+
+    /**
+     * @return string[]
+     */
+    public static function generateAllCountryCodes(): array
+    {
+        return pluck(new ISO3166(), ISO3166::KEY_ALPHA2);
+    }
+
+    public static function countryCodesToOptions(array $countryCodes): array
+    {
+        $options = map($countryCodes, [__CLASS__, 'countryCodeToOption']);
+
+        return sort($options, function (array $left, array $right) {
+            return $left['label'] <=> $right['label'];
+        });
+    }
+
+    public static function countryCodeToOption(string $code): array
+    {
+        return [
+            'value' => $code,
+            'label' => \Locale::getDisplayRegion("-$code"),
+        ];
+    }
+}

test/CountrySelectTest.php

@@ -0,0 +1,99 @@
+<?php
+
+namespace PolderKnowledge\CountryDropdown\Test;
+
+use PHPUnit\Framework\TestCase;
+use PolderKnowledge\CountryDropdown\CountrySelect;
+use Zend\Form\Factory;
+use Zend\Form\FormElementManager\FormElementManagerV3Polyfill;
+use Zend\Form\View\Helper\FormSelect;
+use Zend\ServiceManager\ServiceManager;
+
+class CountrySelectTest extends TestCase
+{
+    protected function setUp()
+    {
+        \Locale::setDefault('de-DE');
+    }
+
+    public function testCountryCodeToOption()
+    {
+        $option = CountrySelect::countryCodeToOption('NZ');
+
+        $this->assertEquals([
+            'value' => 'NZ',
+            'label' => 'Neuseeland'
+        ], $option);
+    }
+
+    public function testCountriesAreSortedAlphabeticallyByLabel()
+    {
+        $options = CountrySelect::countryCodesToOptions(['CD', 'DK', 'AR']);
+
+        $this->assertEquals([
+            [
+                'value' => 'AR',
+                'label' => 'Argentinien',
+            ], [
+                'value' => 'DK',
+                'label' => 'Dänemark',
+            ], [
+                'value' => 'CD',
+                'label' => 'Kongo-Kinshasa',
+            ],
+        ], $options);
+    }
+
+    public function testSeparatorIsInserted()
+    {
+        $options = CountrySelect::generateValueOptions(['DE']);
+
+        $top3options = array_slice($options, 0, 3);
+
+        $this->assertEquals([
+            [
+                'value' => 'DE',
+                'label' => 'Deutschland',
+            ], [
+                'value' => null,
+                'label' => '──────────',
+                'disabled' => true,
+            ], [
+                'value' => 'AF',
+                'label' => 'Afghanistan',
+            ],
+        ], $top3options);
+    }
+
+    public function testCreateElementViaFactory()
+    {
+        $factory = new Factory();
+
+        /** @var CountrySelect $countrySelect */
+        $countrySelect = $factory->createElement([
+            'type' => CountrySelect::class,
+            'options' => [
+                'top_country_codes' => ['DE']
+            ]
+        ]);
+
+        $this->assertInstanceOf(CountrySelect::class, $countrySelect);
+        $this->assertEquals(['DE'], $countrySelect->getTopCountryCodes());
+    }
+
+    public function testCreateElementViaManager()
+    {
+        $formElementManager = new FormElementManagerV3Polyfill(new ServiceManager());
+
+        /** @var CountrySelect $countrySelect */
+        $countrySelect = $formElementManager->get(CountrySelect::class, [
+            'top_country_codes' => ['DE']
+        ]);
+
+        $this->assertInstanceOf(CountrySelect::class, $countrySelect);
+        $this->assertEquals(['DE'], $countrySelect->getTopCountryCodes());
+
+        // test if ->init() has been called
+        $this->assertTrue(count($countrySelect->getValueOptions()) > 100);
+    }
+}