bvp/prefecture

The BVP Prefecture package for Japan.

Maintainers

Details

github.com/BoatraceVentureProject/Prefecture

Source

Issues

Installs: 2 434

Dependents: 1

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

2.1.3 2025-03-19 22:49 UTC

Requires

Requires (Dev)

MIT 22b913823de58f3e2ebb989f670469b5c5cabfdd

  • shimomo <developer.woop@shimomo.net>

libraryprefectureboatrace

This package is auto-updated.

Last update: 2025-03-28 05:00:30 UTC

README

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.