README

实现了 php-api-fr-insee-cog-interface 库的库。

此库使 insee 官方地理代码（COG）作为对象可用，以填充数据库。COG 可在以下网址找到：https://www.insee.fr/fr/information/2560452。

最后更新日期：2020-09-27

安装

此库的安装通过 composer 完成，所有类的自动加载都通过其自动加载器完成。

• 从他们的网站下载 composer.phar。
• 然后运行以下命令以将此库作为依赖项安装
• php composer.phar require php-extended/php-api-fr-insee-cog-object ^7

基本用法

此库提供了一个独特的端点：`\PhpExtended\Insee\InseeCogEndpoint`，从中可以检索所有数据。

• 要检索地区，可以使用

$endpoint = new InseeCogEndpoint();
$paysIterator = $endpoint->getPaysIterator($endpoint->getMaximumAvailableYear());
foreach($paysIterator as $pays)
{
	// @var $pays \PhpExtended\Insee\InseeCogPaysInterface
}

要获取所有年份的地区，请做

$endpoint = new InseeCogEndpoint();
foreach($year = $endpoint->getMinimumAvailableYear(); $year <= $endpoint->getMaximumAvailableYear(); $year++)
{
	foreach($endpoint->getPaysIterator($year) as $pays)
	{
		// @var $pays \PhpExtended\Insee\InseeCogPaysInterface
	}
}

• 要检索省份，可以使用

$endpoint = new InseeCogEndpoint();
$regionIterator = $endpoint->getRegionIterator($endpoint->getMaximumAvailableYear());
foreach($regionIterator as $region)
{
	// @var $region \PhpExtended\Insee\InseeCogRegionInterface
}

要获取所有年份的省份，请做

$endpoint = new InseeCogEndpoint();
foreach($year = $endpoint->getMinimumAvailableYear(); $year <= $endpoint->getMaximumAvailableYear(); $year++)
{
	foreach($endpoint->getRegionIterator($year) as $region)
	{
		// @var $region \PhpExtended\Insee\InseeCogRegionInterface
	}
}

• 要检索区，可以使用

$endpoint = new InseeCogEndpoint();
$departementIterator = $endpoint->getDepartementIterator($endpoint->getMaximumAvailableYear());
foreach($departementIterator as $departement)
{
	// @var $departement \PhpExtended\Insee\InseeCogDepartementInterface
}

要获取所有年份的区，请做

$endpoint = new InseeCogEndpoint();
foreach($year = $endpoint->getMinimumAvailableYear(); $year <= $endpoint->getMaximumAvailableYear(); $year++)
{
	foreach($endpoint->getDepartementIterator($year) as $departement)
	{
		// @var $departement \PhpExtended\Insee\InseeCogDepartementInterface
	}
}

• 要检索市镇，可以使用

$endpoint = new InseeCogEndpoint();
$arrondissementIterator = $endpoint->getArrondissementIterator($endpoint->getMaximumAvailableYear());
foreach($arrondissementIterator as $arrondissement)
{
	// @var $arrondissement \PhpExtended\Insee\InseeCogArrondissementInterface
}

要获取所有年份的市镇，请做

$endpoint = new InseeCogEndpoint();
foreach($year = $endpoint->getMinimumAvailableYear(); $year <= $endpoint->getMaximumAvailableYear(); $year++)
{
	foreach($endpoint->getArrondissementIterator($year) as $arrondissement)
	{
		// @var $arrondissement \PhpExtended\Insee\InseeCogArrondissementInterface
	}
}

• 要检索乡，可以使用

$endpoint = new InseeCogEndpoint();
$cantonIterator = $endpoint->getCantonIterator($endpoint->getMaximumAvailableYear());
foreach($cantonIterator as $canton)
{
	// @var $canton \PhpExtended\Insee\InseeCogCantonInterface
}

要获取所有年份的乡，请做

$endpoint = new InseeCogEndpoint();
foreach($year = $endpoint->getMinimumAvailableYear(); $year <= $endpoint->getMaximumAvailableYear(); $year++)
{
	foreach($endpoint->getCantonIterator($year) as $canton)
	{
		// @var $canton \PhpExtended\Insee\InseeCogCantonInterface
	}
}

• 要检索市，可以使用

$endpoint = new InseeCogEndpoint();
$communeIterator = $endpoint->getCommuneIterator($endpoint->getMaximumAvailableYear());
foreach($communeIterator as $commune)
{
	// @var $commune \PhpExtended\Insee\InseeCogCommuneInterface
}

要获取所有年份的市，请做

$endpoint = new InseeCogEndpoint();
foreach($year = $endpoint->getMinimumAvailableYear(); $year <= $endpoint->getMaximumAvailableYear(); $year++)
{
	foreach($endpoint->getCommuneIterator($year) as $commune)
	{
		// @var $commune \PhpExtended\Insee\InseeCogCommuneInterface
	}
}

• 要检索市镇事件，可以使用

$endpoint = new InseeCogEndpoint();
foreach($endpoint->getEventCommuneIterator($year) as $event)
{
	// @var $event \PhpExtended\Insee\InseeCogEventCommuneInterface
}

许可证

• 代码受 MIT 许可证保护（见许可证文件）。

• 数据受开放许可证保护（英文 / 法语）