Initial commit

Author: beastbytes

.gitignore

@@ -0,0 +1,44 @@
+# phpstorm project files
+.idea
+
+# netbeans project files
+nbproject
+
+# zend studio for eclipse project files
+.buildpath
+.project
+.settings
+
+# sublime text project / workspace files
+*.sublime-project
+*.sublime-workspace
+
+# windows thumbnail cache
+Thumbs.db
+
+# composer vendor dir
+/vendor
+
+# composer itself is not needed
+composer.phar
+
+# Mac DS_Store Files
+.DS_Store
+
+# phpunit itself is not needed
+phpunit.phar
+.phpunit.result.cache
+
+# local phpunit config
+/phpunit.xml
+/phpunit.xml.dist
+
+# NPM packages
+/node_modules
+.env
+
+# Codeception
+c3.php
+
+# Composer
+composer.lock

LICENSE.md

@@ -0,0 +1,21 @@
+The postal-code-data library is free software. It is released under the terms of the following BSD License.
+
+Copyright © 2022 BeastBytes - All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
+following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this list of conditions and the following
+  disclaimer.
+* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following
+  disclaimer in the documentation and/or other materials provided with the distribution.
+* Neither the name of BeastBytes nor the names of its contributors may be used to endorse or promote products derived
+  from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
+INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -0,0 +1,20 @@
+# Postal Code Data (postal-code-data)
+Interface for retrieving postal code data.
+
+## Installation
+
+The preferred way to install this extension is through [composer](http://getcomposer.org/download/).
+
+Either run
+
+```
+php composer.phar require --prefer-dist beastbytes/iban
+```
+
+or add
+
+```json
+"beastbytes/postal-code-data": "^1.0.0"
+```
+
+to the require section of your composer.json.

composer.json

@@ -0,0 +1,27 @@
+{
+    "name": "beastbytes/postal-code-data",
+    "type": "library",
+    "description": "Interface for retrieving postal code data",
+    "keywords": [
+        "postal code"
+    ],
+    "support": {
+        "issues": "https://github.com/beastbytes/postal-code-data/issues",
+        "source": "https://github.com/beastbytes/postal-code-data"
+    },
+    "license": "BSD-3-Clause",
+    "authors": [{
+        "name": "Chris Yates",
+        "email": "chris.l.yates@gmail.com"
+    }],
+    "minimum-stability": "dev",
+    "prefer-stable": true,
+    "require": {
+        "php": "^8.0"
+    },
+    "autoload": {
+        "psr-4": {
+            "BeastBytes\\PostalCode\\": "src"
+        }
+    }
+}

src/PostalCodeDataInterface.php

@@ -0,0 +1,16 @@
+<?php
+/**
+ * @copyright Copyright © 2022 BeastBytes - All rights reserved
+ * @license BSD 3-Clause
+ */
+
+declare(strict_types=1);
+
+namespace BeastBytes\PostalCode;
+
+interface PostalCodeDataInterface
+{
+    public function getCountries(): array;
+    public function getPattern(string $country): string;
+    public function hasCountry(string $country): bool;
+}