locomotivemtl/charcoal-contrib-translatable-strings

Charcoal Translatable Strings allows an Admin user to translate hardcoded strings found in templates and controllers.

dev-master / 0.1.x-dev 2018-06-08 14:51 UTC

Requires

• php: >=5.6.0 || >=7.0
• locomotivemtl/charcoal-admin: ~0.11

Requires (Dev)

• php-coveralls/php-coveralls: ^2.0
• phpunit/phpunit: ^5.7 || ^6.5
• squizlabs/php_codesniffer: ^3.0

MIT

• Locomotive

• charcoal

README

A Charcoal service allowing an Admin user to translate hardcoded strings found in templates and controllers.

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-translatable-strings

Dependencies

Required

• PHP 5.6+: PHP 7 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-translatable-strings/docs/master/
• The auto-generated apigen API documentation is available at:
  https://codedoc.pub/locomotivemtl/charcoal-contrib-translatable-strings/master/

Development Dependencies

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

Coding Style

The charcoal-contrib-translatable-strings 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.