diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..30c8834 --- /dev/null +++ b/.gitignore @@ -0,0 +1,9 @@ +# composer package patch +vendor/ +composer.lock + +# Windows Files +Thumbs.db + +# OSX +.DS_Store \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..b4c8a88 --- /dev/null +++ b/LICENSE @@ -0,0 +1,29 @@ +BSD 3-Clause License + +Copyright (c) 2019, dynamikaweb +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + +2. 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. + +3. Neither the name of the copyright holder 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 HOLDER 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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..86803f8 --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +dynamikaweb/php-brazil-info +=========================== +[![Latest Stable Version](https://img.shields.io/github/v/release/dynamikaweb/php-brazil-info)](https://github.com/dynamikaweb/php-brazil-info/releases) +[![Total Downloads](https://poser.pugx.org/dynamikaweb/php-brazil-info/downloads)](https://packagist.org/packages/dynamikaweb/php-brazil-info) +[![License](https://img.shields.io/github/license/dynamikaweb/php-brazil-info)](https://github.com/dynamikaweb/php-brazil-info/blob/master/LICENSE) + +Installation +------------ +The preferred way to install this extension is through [composer](http://getcomposer.org/download/). + +Either run + +```SHELL +$ composer require dynamikaweb/php-brazil-info "*" +``` + +or add + +```JSON +"dynamikaweb/php-brazil-info": "*" +``` + +to the `require` section of your `composer.json` file. + +How to Use +---------- +```PHP +use dynamikaweb\brazilinfo\State as BrazilStates; + +print_r (BrazilStates::list()) +``` \ No newline at end of file diff --git a/composer.json b/composer.json new file mode 100644 index 0000000..8848f9b --- /dev/null +++ b/composer.json @@ -0,0 +1,32 @@ +{ + "name": "dynamikaweb/php-brazil-info", + "description": "helper with basic information about brazil", + "type": "yii2-extension", + "keywords": [ + "dynamika", + "brazil", + "brasil" + ], + "license": "BSD-3-Clause", + "authors": [ + { + "name": "RodrigoDornelles", + "email": "rodrigo@dornelles.me", + "role": "Developer" + } + ], + "support": { + "issues": "http://github.com/dynamikaweb/php-brazil-info/issues", + "source": "http://github.com/dynamikaweb/php-brazil-info" + }, + "require": { + "php": ">=5.5.0" + }, + "minimum-stability": "dev", + "prefer-stable": false, + "autoload": { + "psr-4": { + "dynamikaweb\\brazilinfo\\": "src" + } + } +} \ No newline at end of file diff --git a/src/States.php b/src/States.php new file mode 100644 index 0000000..b43f87c --- /dev/null +++ b/src/States.php @@ -0,0 +1,33 @@ +