locomotivemtl/charcoal-contrib-google-static-map

A Charcoal module to generate a google static map compatible url

dev-master / 0.1.x-dev 2024-12-20 19:01 UTC

Requires

• php: >7.1
• emcconville/google-map-polyline-encoding-tool: ~1.2.1

Requires (Dev)

• php-coveralls/php-coveralls: ^2.2
• phpunit/phpunit: ^7.1
• squizlabs/php_codesniffer: ^3.5

MIT

• Locomotive

• map
• static
• google
• charcoal

README

A Charcoal service provider my cool feature.

Table of Contents

• Installation
  • Dependencies
• Service Provider
  • Parameters
  • Services
• Configuration
• Usage
• Development
  • API Documentation
  • Development Dependencies
  • Coding Style
• Credits
• License

Installation

The preferred (and only supported) method is with Composer:

$ composer require locomotivemtl/charcoal-contrib-google-static-map

Dependencies

Required

• PHP 7.1+: PHP 7.3+ is recommended.

PSR

--TBD--

Service Provider

Parameters

--TBD--

Services

--TBD--

Configuration

--TBD--

Usage

--TBD--

Development

To install the development environment:

$ composer install

To run the scripts (phplint, phpcs, and phpunit):

$ composer test

API Documentation

• The auto-generated phpDocumentor API documentation is available at:
  https://locomotivemtl.github.io/charcoal-contrib-google-static-map/docs/master/
• The auto-generated apigen API documentation is available at:
  https://codedoc.pub/locomotivemtl/charcoal-contrib-google-static-map/master/

Development Dependencies

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

Coding Style

The charcoal-contrib-google-static-map module follows the Charcoal coding-style:

• PSR-1
• PSR-2
• PSR-4, autoloading is therefore provided by Composer.
• phpDocumentor comments.
• phpcs.xml.dist and .editorconfig for coding standards.

Coding style validation / enforcement can be performed with composer phpcs. An auto-fixer is also available with composer phpcbf.

Credits

• Locomotive

License

Charcoal is licensed under the MIT license. See LICENSE for details.