Skip to content

BoatraceVentureProject/Prefecture

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

31 Commits
.github/workflows
.github/workflows
 
 
config
config
 
 
src
src
 
 
tests
tests
 
 
.editorconfig
.editorconfig
 
 
.gitignore
.gitignore
 
 
LICENSE
LICENSE
 
 
README.md
README.md
 
 
composer.json
composer.json
 
 
phpunit.xml
phpunit.xml
 
 

Repository files navigation

Prefecture

Build Status codecov Latest Stable Version Latest Unstable Version License

The BVP Prefecture package is designed to retrieve information about Japanese prefectures using identifiers, including ID (Region) and Name (Short, Hiragana, Katakana, English, Region).

Installation

composer require bvp/prefecture

Usage

<?php

require __DIR__ . '/vendor/autoload.php';

use BVP\Prefecture\Prefecture;

For all()

$collection = Prefecture::all();
var_dump($collection);
/*------------------------------
object(Illuminate\Support\Collection)#9 (2) {
  ["items":protected]=>array(47) {
    [1]=>object(Illuminate\Support\Collection)#13 (2) {
      ["items":protected]=>array(6) {
        ["id"]=>int(1)
        ["name"]=>string(9) "北海道"
        ["short_name"]=>string(9) "北海道"
        ["hiragana_name"]=>string(18) "ほっかいどう"
        ["katakana_name"]=>string(18) "ホッカイドウ"
        ["english_name"]=>string(8) "hokkaido"
        ["region_id"]=>int(1)
        ["region_name"]=>string(6) "北海道"
      }
      ["escapeWhenCastingToString":protected]=>bool(false)
    }
    ...
    [47]=>object(Illuminate\Support\Collection)#59 (2) {
      ["items":protected]=>array(6) {
        ["id"]=>int(47)
        ["name"]=>string(9) "沖縄県"
        ["short_name"]=>string(6) "沖縄"
        ["hiragana_name"]=>string(18) "おきなわけん"
        ["katakana_name"]=>string(18) "オキナワケン"
        ["english_name"]=>string(7) "okinawa"
        ["region_id"]=>int(8)
        ["region_name"]=>string(6) "九州"
      }
      ["escapeWhenCastingToString":protected]=>bool(false)
    }
  }
  ["escapeWhenCastingToString":protected]=>bool(false)
}
------------------------------*/

For byXxxList()

$collection = Prefecture::byIdList(13, 34);
var_dump($collection->get(13)->get('id'));            // int(13)
var_dump($collection->get(13)->get('name'));          // string(9) "東京都"
var_dump($collection->get(13)->get('short_name'));    // string(6) "東京"
var_dump($collection->get(13)->get('hiragana_name')); // string(18) "とうきょうと"
var_dump($collection->get(13)->get('katakana_name')); // string(18) "トウキョウト"
var_dump($collection->get(13)->get('english_name'));  // string(5) "tokyo"
var_dump($collection->get(13)->get('region_id'));     // int(3)
var_dump($collection->get(13)->get('region_name'));   // string(6) "関東"

$collection = Prefecture::byNameList('東京都', '広島県');
var_dump($collection->get(13)->get('id'));            // int(13)
var_dump($collection->get(13)->get('name'));          // string(9) "東京都"
var_dump($collection->get(13)->get('short_name'));    // string(6) "東京"
var_dump($collection->get(13)->get('hiragana_name')); // string(18) "とうきょうと"
var_dump($collection->get(13)->get('katakana_name')); // string(18) "トウキョウト"
var_dump($collection->get(13)->get('english_name'));  // string(5) "tokyo"
var_dump($collection->get(13)->get('region_id'));     // int(3)
var_dump($collection->get(13)->get('region_name'));   // string(6) "関東"

$collection = Prefecture::byShortNameList('東京', '広島');
var_dump($collection->get(13)->get('id'));            // int(13)
var_dump($collection->get(13)->get('name'));          // string(9) "東京都"
var_dump($collection->get(13)->get('short_name'));    // string(6) "東京"
var_dump($collection->get(13)->get('hiragana_name')); // string(18) "とうきょうと"
var_dump($collection->get(13)->get('katakana_name')); // string(18) "トウキョウト"
var_dump($collection->get(13)->get('english_name'));  // string(5) "tokyo"
var_dump($collection->get(13)->get('region_id'));     // int(3)
var_dump($collection->get(13)->get('region_name'));   // string(6) "関東"

$collection = Prefecture::byHiraganaNameList('とうきょうと', 'ひろしまけん');
var_dump($collection->get(13)->get('id'));            // int(13)
var_dump($collection->get(13)->get('name'));          // string(9) "東京都"
var_dump($collection->get(13)->get('short_name'));    // string(6) "東京"
var_dump($collection->get(13)->get('hiragana_name')); // string(18) "とうきょうと"
var_dump($collection->get(13)->get('katakana_name')); // string(18) "トウキョウト"
var_dump($collection->get(13)->get('english_name'));  // string(5) "tokyo"
var_dump($collection->get(13)->get('region_id'));     // int(3)
var_dump($collection->get(13)->get('region_name'));   // string(6) "関東"

$collection = Prefecture::byKatakanaNameList('トウキョウト', 'ヒロシマケン');
var_dump($collection->get(13)->get('id'));            // int(13)
var_dump($collection->get(13)->get('name'));          // string(9) "東京都"
var_dump($collection->get(13)->get('short_name'));    // string(6) "東京"
var_dump($collection->get(13)->get('hiragana_name')); // string(18) "とうきょうと"
var_dump($collection->get(13)->get('katakana_name')); // string(18) "トウキョウト"
var_dump($collection->get(13)->get('english_name'));  // string(5) "tokyo"
var_dump($collection->get(13)->get('region_id'));     // int(3)
var_dump($collection->get(13)->get('region_name'));   // string(6) "関東"

$collection = Prefecture::byEnglishNameList('tokyo', 'hiroshima');
var_dump($collection->get(13)->get('id'));            // int(13)
var_dump($collection->get(13)->get('name'));          // string(9) "東京都"
var_dump($collection->get(13)->get('short_name'));    // string(6) "東京"
var_dump($collection->get(13)->get('hiragana_name')); // string(18) "とうきょうと"
var_dump($collection->get(13)->get('katakana_name')); // string(18) "トウキョウト"
var_dump($collection->get(13)->get('english_name'));  // string(5) "tokyo"
var_dump($collection->get(13)->get('region_id'));     // int(3)
var_dump($collection->get(13)->get('region_name'));   // string(6) "関東"

$collection = Prefecture::byRegionIdList(3, 6);
var_dump($collection->get(13)->get('id'));            // int(13)
var_dump($collection->get(13)->get('name'));          // string(9) "東京都"
var_dump($collection->get(13)->get('short_name'));    // string(6) "東京"
var_dump($collection->get(13)->get('hiragana_name')); // string(18) "とうきょうと"
var_dump($collection->get(13)->get('katakana_name')); // string(18) "トウキョウト"
var_dump($collection->get(13)->get('english_name'));  // string(5) "tokyo"
var_dump($collection->get(13)->get('region_id'));     // int(3)
var_dump($collection->get(13)->get('region_name'));   // string(6) "関東"

$collection = Prefecture::byRegionNameList('関東', '中国');
var_dump($collection->get(13)->get('id'));            // int(13)
var_dump($collection->get(13)->get('name'));          // string(9) "東京都"
var_dump($collection->get(13)->get('short_name'));    // string(6) "東京"
var_dump($collection->get(13)->get('hiragana_name')); // string(18) "とうきょうと"
var_dump($collection->get(13)->get('katakana_name')); // string(18) "トウキョウト"
var_dump($collection->get(13)->get('english_name'));  // string(5) "tokyo"
var_dump($collection->get(13)->get('region_id'));     // int(3)
var_dump($collection->get(13)->get('region_name'));   // string(6) "関東"

For byXxx()

$collection = Prefecture::byId(13);
var_dump($collection->get('id'));            // int(13)
var_dump($collection->get('name'));          // string(9) "東京都"
var_dump($collection->get('short_name'));    // string(6) "東京"
var_dump($collection->get('hiragana_name')); // string(18) "とうきょうと"
var_dump($collection->get('katakana_name')); // string(18) "トウキョウト"
var_dump($collection->get('english_name'));  // string(5) "tokyo"
var_dump($collection->get('region_id'));     // int(3)
var_dump($collection->get('region_name'));   // string(6) "関東"

$collection = Prefecture::byName('東京都');
var_dump($collection->get('id'));            // int(13)
var_dump($collection->get('name'));          // string(9) "東京都"
var_dump($collection->get('short_name'));    // string(6) "東京"
var_dump($collection->get('hiragana_name')); // string(18) "とうきょうと"
var_dump($collection->get('katakana_name')); // string(18) "トウキョウト"
var_dump($collection->get('english_name'));  // string(5) "tokyo"
var_dump($collection->get('region_id'));     // int(3)
var_dump($collection->get('region_name'));   // string(6) "関東"

$collection = Prefecture::byShortName('東京');
var_dump($collection->get('id'));            // int(13)
var_dump($collection->get('name'));          // string(9) "東京都"
var_dump($collection->get('short_name'));    // string(6) "東京"
var_dump($collection->get('hiragana_name')); // string(18) "とうきょうと"
var_dump($collection->get('katakana_name')); // string(18) "トウキョウト"
var_dump($collection->get('english_name'));  // string(5) "tokyo"
var_dump($collection->get('region_id'));     // int(3)
var_dump($collection->get('region_name'));   // string(6) "関東"

$collection = Prefecture::byHiraganaName('とうきょうと');
var_dump($collection->get('id'));            // int(13)
var_dump($collection->get('name'));          // string(9) "東京都"
var_dump($collection->get('short_name'));    // string(6) "東京"
var_dump($collection->get('hiragana_name')); // string(18) "とうきょうと"
var_dump($collection->get('katakana_name')); // string(18) "トウキョウト"
var_dump($collection->get('english_name'));  // string(5) "tokyo"
var_dump($collection->get('region_id'));     // int(3)
var_dump($collection->get('region_name'));   // string(6) "関東"

$collection = Prefecture::byKatakanaName('トウキョウト');
var_dump($collection->get('id'));            // int(13)
var_dump($collection->get('name'));          // string(9) "東京都"
var_dump($collection->get('short_name'));    // string(6) "東京"
var_dump($collection->get('hiragana_name')); // string(18) "とうきょうと"
var_dump($collection->get('katakana_name')); // string(18) "トウキョウト"
var_dump($collection->get('english_name'));  // string(5) "tokyo"
var_dump($collection->get('region_id'));     // int(3)
var_dump($collection->get('region_name'));   // string(6) "関東"

$collection = Prefecture::byEnglishName('tokyo');
var_dump($collection->get('id'));            // int(13)
var_dump($collection->get('name'));          // string(9) "東京都"
var_dump($collection->get('short_name'));    // string(6) "東京"
var_dump($collection->get('hiragana_name')); // string(18) "とうきょうと"
var_dump($collection->get('katakana_name')); // string(18) "トウキョウト"
var_dump($collection->get('english_name'));  // string(5) "tokyo"
var_dump($collection->get('region_id'));     // int(3)
var_dump($collection->get('region_name'));   // string(6) "関東"

$collection = Prefecture::byRegionId(3);
var_dump($collection->get('id'));            // int(8)
var_dump($collection->get('name'));          // string(9) "茨城県"
var_dump($collection->get('short_name'));    // string(6) "茨城"
var_dump($collection->get('hiragana_name')); // string(18) "いばらきけん"
var_dump($collection->get('katakana_name')); // string(18) "イバラキケン"
var_dump($collection->get('english_name'));  // string(5) "ibaraki"
var_dump($collection->get('region_id'));     // int(3)
var_dump($collection->get('region_name'));   // string(6) "関東"

$collection = Prefecture::byRegionName('関東');
var_dump($collection->get('id'));            // int(8)
var_dump($collection->get('name'));          // string(9) "茨城県"
var_dump($collection->get('short_name'));    // string(6) "茨城"
var_dump($collection->get('hiragana_name')); // string(18) "いばらきけん"
var_dump($collection->get('katakana_name')); // string(18) "イバラキケン"
var_dump($collection->get('english_name'));  // string(5) "ibaraki"
var_dump($collection->get('region_id'));     // int(3)
var_dump($collection->get('region_name'));   // string(6) "関東"

License

The BVP Prefecture package is open source software licensed under the MIT license.

About

The BVP Prefecture package for Japan.

Topics

php php-library boatrace prefecture php8

Resources

Readme

License

MIT license
Activity
Custom properties

Stars

0 stars

Watchers

1 watching

Forks

0 forks
Report repository

Releases 10

2.1.3 Latest
Mar 19, 2025
+ 9 releases

Packages

No packages published

Languages