arxjei/psgc-php

There is no license information available for the latest version (v0.0.0) of this package.

A PHP package for retrieving and managing Philippine Standard Geographic Code (PSGC) data, including regions, provinces, cities, and barangays.

Maintainers

Details

github.com/arxjei/psgc-php

Source

Issues

Installs: 2

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

v0.0.0 2025-07-23 02:50 UTC

Requires

Requires (Dev)

Unknown License fcb6378771db690b60a227c62676992ed4e154d4

  • Ar Jay Marigondon <contact.woop@arjaymarigondon.dev>

This package is auto-updated.

Last update: 2025-07-31 02:36:15 UTC

README

PSGC-PHP is a PHP package for handling Philippine Standard Geographic Code (PSGC) data. It provides tools to retrieve and search geographic information such as regions, provinces, cities, municipalities, and barangays from JSON files.

Features

  • Access PSGC data from JSON files.
  • Search address records using PSGC codes.
  • Organized helper classes for file and lookup handling.
  • Includes unit tests for each geographic level.

Installation

composer require arxjei/psgc-php

Get All Methods

Address Type Method Description
Region getRegions() Get all regions.
Province getProvinces() Get all provinces.
City getCities() Get all cities.
Barangay getBarangays() Get all barangays.

Get All By Code Methods

Address Type Method Description
Province getAllProvincesByRegionCode($region_code) Provinces under a specific region.
City getAllCitiesByProvinceCode($province_code) Cities under a specific province.
Barangay getAllBarangaysByCityCode($city_code) Barangays under a specific city.

Get By Code Methods

Address Type Method Description
Region getRegionsByCode($region_code) Get a region by code.
Province getProvincesByCode($province_code) Get a province by code.
City getCitiesByCode($city_code) Get a city by code.
Barangay getBarangaysByCode($barangay_code) Get a barangay by code.

Usage Examples

Get All Provinces

use Arxjei\PSGC;

$provinces = PSGC::getProvinces();
print_r($provinces);

Get All Cities by Province Code

use Arxjei\PSGC;

$cities = PSGC::getAllCitiesByProvinceCode('0128');
print_r($cities);

Get a Specific Barangay by Code

use Arxjei\PSGC;

$barangay = PSGC::getBarangaysByCode('012801001');
print_r($barangay);

File Structure

  • src/ - Core PHP logic.
  • src/resources/json/ - PSGC JSON data.
  • tests/ - PHPUnit tests.

Run Tests

vendor/bin/phpunit

License

MIT License.