Add `CountryCodeDataList` view helper and `CountryCode` validator #86

gsteel · 2022-09-13T16:20:39Z

Q	A
Documentation	not yet - required
New Feature	yes
RFC	no?

Description

Given the addition of the country code value object in #84, this patch puts it to use by adding a list object available in the container, that users can use to retrieve a list of all ISO-3166 alpha 2 country codes. The list implements and is aliased to a simple interface that user can override in the container, for example, in order to restrict the list to desired countries.

A view helper is added that outputs an HTML datalist element, useful for autocomplete and a validator for ISO3166 country codes.

Documentation is outstanding.

Ocramius

Partial review - dropping in some feedback though :-)

src/Geography/DefaultCountryCodeList.php

src/ConfigProvider.php

src/Geography/DefaultCountryCodeList.php

gsteel · 2022-09-13T16:39:50Z

Partial review - dropping in some feedback though

Thanks @Ocramius

src/Geography/CountryCodeListInterface.php

src/Geography/DefaultCountryCodeList.php

src/Geography/DefaultCountryCodeListFactory.php

src/View/Helper/CountryCodeDataList.php

Ocramius

IMO this is good to go, @gsteel!

Do we need to add docs for it, though? 🤔

Ocramius · 2022-10-10T15:52:12Z

Clearing milestone for a release meanwhile: will re-target 2.20.x

gsteel · 2022-10-10T16:00:13Z

I'll get some docs together for review by @froschdesign soon as I can :)

gsteel · 2022-12-02T16:25:27Z

Current psalm issues are unrelated - service manager needs an update so I'll do that in another patch

Signed-off-by: George Steel <george@net-glue.co.uk>

…ist` Psalm doesn't appear to like the size of the array Signed-off-by: George Steel <george@net-glue.co.uk>

…d CountryCode validator Signed-off-by: George Steel <george@net-glue.co.uk>

froschdesign

Good work! 👍🏻

Only a few minor changes are needed.

docs/book/validators/country-code.md

docs/book/view-helpers/country-code-data-list.md

Co-authored-by: Frank Brückner <info@froschdesignstudio.de> Signed-off-by: George Steel <george@netglue.uk>

Signed-off-by: George Steel <george@net-glue.co.uk>

docs/book/view-helpers/country-code-data-list.md

Co-authored-by: Frank Brückner <info@froschdesignstudio.de> Signed-off-by: George Steel <george@netglue.uk>

froschdesign · 2022-12-16T11:15:15Z

@gsteel
One last step: add the new validator and view helper to the MkDocs configuration file.

laminas-i18n/mkdocs.yml

Lines 20 to 36 in fa9fc18

    
               - Validators: 
        
                   - Introduction: validators/introduction.md 
        
                   - Alnum: validators/alnum.md 
        
                   - Alpha: validators/alpha.md 
        
                   - DateTime: validators/date-time.md 
        
                   - IsFloat: validators/is-float.md 
        
                   - IsInt: validators/is-int.md 
        
                   - PhoneNumber: validators/phone-number.md 
        
                   - PostCode: validators/post-code.md 
        
           - 'View Helpers': 
        
               - Introduction: view-helpers/introduction.md 
        
               - CurrencyFormat: view-helpers/currency-format.md 
        
               - DateFormat: view-helpers/date-format.md 
        
               - NumberFormat: view-helpers/number-format.md 
        
               - Plural: view-helpers/plural.md 
        
               - Translate: view-helpers/translate.md 
        
               - TranslatePlural: view-helpers/translate-plural.md

Thanks in advance! 👍🏻

Signed-off-by: George Steel <george@net-glue.co.uk>

gsteel · 2022-12-16T11:58:42Z

Thanks for the help @froschdesign 👍

gsteel added Documentation Needed Feature Request labels Sep 13, 2022

gsteel added this to the 2.19.0 milestone Sep 13, 2022

gsteel force-pushed the feature/country-data-list-and-validator branch from f12b022 to 2a2c6a6 Compare September 13, 2022 16:23

Ocramius reviewed Sep 13, 2022

View reviewed changes

Ocramius reviewed Sep 14, 2022

View reviewed changes

gsteel force-pushed the feature/country-data-list-and-validator branch from b593ad3 to 240c7dc Compare September 14, 2022 19:51

Ocramius approved these changes Oct 10, 2022

View reviewed changes

Ocramius removed this from the 2.19.0 milestone Oct 10, 2022

Ocramius added this to the 2.20.0 milestone Oct 10, 2022

Ocramius changed the base branch from 2.19.x to 2.20.x October 10, 2022 15:54

Ocramius removed this from the 2.20.0 milestone Dec 2, 2022

Ocramius assigned gsteel Dec 2, 2022

gsteel force-pushed the feature/country-data-list-and-validator branch from 240c7dc to fb3ab42 Compare December 2, 2022 16:19

gsteel changed the base branch from 2.20.x to 2.21.x December 2, 2022 16:20

gsteel added this to the 2.21.0 milestone Dec 2, 2022

gsteel mentioned this pull request Dec 2, 2022

Bump dev dependencies and improve config related type inference #89

Merged

Ocramius removed this from the 2.21.0 milestone Dec 2, 2022

Ocramius changed the base branch from 2.21.x to 2.22.x December 2, 2022 17:25

Ocramius added this to the 2.22.0 milestone Dec 2, 2022

gsteel added 4 commits December 15, 2022 22:23

Add CountryCodeDataList view helper and CountryCode validator

6d912c2

Signed-off-by: George Steel <george@net-glue.co.uk>

Improve type inference for the list and avoid keeping the list in memory

83ecb46

Signed-off-by: George Steel <george@net-glue.co.uk>

Call __toString on HtmlAttributes rather than casting

8999c9e

Signed-off-by: George Steel <george@net-glue.co.uk>

Remove unnecessary factory for the country code list

7ebe18a

Signed-off-by: George Steel <george@net-glue.co.uk>

gsteel force-pushed the feature/country-data-list-and-validator branch from fb3ab42 to 7ebe18a Compare December 15, 2022 22:24

Updated sealed psalm array shape to match return value

943cf59

Signed-off-by: George Steel <george@net-glue.co.uk>

gsteel added 2 commits December 15, 2022 22:29

Baseline the InvalidConstantAssignmentValue in `DefaultCountryCodeL…

e1d365c

…ist` Psalm doesn't appear to like the size of the array Signed-off-by: George Steel <george@net-glue.co.uk>

Adds initial documentation for the CountryCodeDataList view helper an…

3d2b999

…d CountryCode validator Signed-off-by: George Steel <george@net-glue.co.uk>

gsteel requested a review from froschdesign December 15, 2022 23:30

gsteel added Documentation Enhancement and removed Documentation Needed labels Dec 15, 2022

froschdesign requested changes Dec 16, 2022

View reviewed changes

gsteel and others added 2 commits December 16, 2022 09:45

Clarify 2 Letter Country Codes. Improve readability

3117da1

Co-authored-by: Frank Brückner <info@froschdesignstudio.de> Signed-off-by: George Steel <george@netglue.uk>

Improve example code by prepending example file paths

918b5a0

Signed-off-by: George Steel <george@net-glue.co.uk>

froschdesign requested changes Dec 16, 2022

View reviewed changes

docs/book/view-helpers/country-code-data-list.md Outdated Show resolved Hide resolved

docs/book/view-helpers/country-code-data-list.md Outdated Show resolved Hide resolved

docs/book/view-helpers/country-code-data-list.md Outdated Show resolved Hide resolved

Correct and standardise casing for component references

e790603

Co-authored-by: Frank Brückner <info@froschdesignstudio.de> Signed-off-by: George Steel <george@netglue.uk>

Added new documentation to mkdocs configuration

54cd26d

Signed-off-by: George Steel <george@net-glue.co.uk>

froschdesign approved these changes Dec 16, 2022

View reviewed changes

gsteel merged commit 01be81b into laminas:2.22.x Dec 16, 2022

gsteel deleted the feature/country-data-list-and-validator branch December 16, 2022 13:53

gsteel mentioned this pull request Jan 31, 2023

Country Code Data List: Improve docs, add view helper alias to IDE autocompletion trait #96

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `CountryCodeDataList` view helper and `CountryCode` validator #86

Add `CountryCodeDataList` view helper and `CountryCode` validator #86

gsteel commented Sep 13, 2022

Ocramius left a comment

gsteel commented Sep 13, 2022

Ocramius left a comment

Ocramius commented Oct 10, 2022

gsteel commented Oct 10, 2022

gsteel commented Dec 2, 2022

froschdesign left a comment

froschdesign commented Dec 16, 2022

gsteel commented Dec 16, 2022

Add CountryCodeDataList view helper and CountryCode validator #86

Add CountryCodeDataList view helper and CountryCode validator #86

Conversation

gsteel commented Sep 13, 2022

Description

Ocramius left a comment

Choose a reason for hiding this comment

gsteel commented Sep 13, 2022

Ocramius left a comment

Choose a reason for hiding this comment

Ocramius commented Oct 10, 2022

gsteel commented Oct 10, 2022

gsteel commented Dec 2, 2022

froschdesign left a comment

Choose a reason for hiding this comment

froschdesign commented Dec 16, 2022

gsteel commented Dec 16, 2022

Add `CountryCodeDataList` view helper and `CountryCode` validator #86

Add `CountryCodeDataList` view helper and `CountryCode` validator #86