README

一个 Charcoal 服务提供商，拥有酷炫功能。

目录

• 安装
  • 依赖
• 配置
• 使用
• 开发
  • API 文档
  • 开发依赖
  • 编码风格
• 致谢
• 许可

安装

首选（也是唯一支持的）方法是使用 Composer

$ composer require locomotivemtl/charcoal-geolocation

依赖

• charcoal-core
• charcoal-admin

必需

• PHP 5.6+: 推荐使用 PHP 7。

配置

将 views 和 metadata 路径添加到配置文件中。

"metadata": {
       "paths": [
           "...",
           "vendor/locomotivemtl/charcoal-geolocation/metadata/"
       ]
   },
   "view": {
       "paths": [
           "...",
           "vendor/locomotivemtl/charcoal-geolocation/views/"
       ]
   }

使用

该模块基本上是一个属性、输入和组件的集合。您只需要使用它们。

• 对象仪表板的 GeolocationCollection 组件实现示例

"map": {
    "type": "charcoal/geolocation/widget/geolocation-collection",
    "geometry_property": "geometry",
    "infobox_template": "project/widget/example-infobox",
    "priority": 10
}

要使用此模块提供的属性，您必须通过对象元数据中的完整 PHP 路径来引用它们：Charcoal\\Geolocation\\Property\\MapStructureProperty Charcoal\\Geolocation\\Property\\PointProperty Charcoal\\Geolocation\\Property\\PolylineProperty Charcoal\\Geolocation\\Property\\PolygonProperty

组件

以下基本组件可用于构建各种 admin 模板

• GeolocationCollection
  • 可以显示具有实现 GeolocationInterface 属性的对象集合的组件
  • 指定要使用的属性标识符
  • 指定显示模板

属性输入

以下属性输入可用于在 admin 模块中构建表单

• MapStructure

  • 一个用于在地图上添加和编辑 geolocation 数据 的专用组件。
    • 支持的地理位置类型
      • 点
      • 折线
      • 多边形
  • 不能是 多个
  • 需要 google-map。
  • 需要 gmap。
  • 从 charcoal-property 扩展 StructureProperty。
  • 实现 GeolocationInterface。

• AbstractGeolocation

  • 基础属性
    • 点
    • 折线
    • 多边形
  • 从 charcoal-property 扩展 AbstractProperty。
  • 实现 GeolocationInterface。

• 点

  • 一个用于在地图上添加和编辑 Point 地理位置数据的专用组件。
  • 需要 google-map。
  • 需要 gmap。

• 折线

  • 一个用于在地图上添加和编辑 Polyline 地理位置数据的专用组件。
  • 需要 google-map。
  • 需要 gmap。

• 多边形

  • 一个用于在地图上添加和编辑 Polygon 地理位置数据的专用组件。
  • 需要 google-map。
  • 需要 gmap。

开发

要安装开发环境

$ composer install

要运行脚本（phplint、phpcs 和 phpunit）

$ composer test

API 文档

• 自动生成的 phpDocumentor API 文档在以下位置可用
  https://locomotivemtl.github.io/charcoal-geolocation/docs/master/
• 自动生成的 apigen API 文档在以下位置可用
  https://codedoc.pub/locomotivemtl/charcoal-geolocation/master/

开发依赖

• [php-coveralls/php-coveralls][phpcov]
• [phpunit/phpunit][phpunit]
• [squizlabs/php_codesniffer][phpcs]
• [seld/jsonlint][jsonlint]

编码风格

charcoal-geolocation 模块遵循 Charcoal 编码风格

• PSR-1
• PSR-2
• PSR-4，因此自动加载由 Composer 提供。
• phpDocumentor 注释。
• 请参考 phpcs.xml.dist 和 .editorconfig 以获取编码规范。

可以使用 composer phpcs 来执行编码风格验证/强制。同时，也可以通过 composer phpcbf 使用自动修复器。

致谢

• Locomotive
• Joel Alphonso joel@locomotive.ca

许可

Charcoal 采用 MIT 许可协议授权。详细信息请参阅 LICENSE。