locomotivemtl/charcoal-core

Charcoal Web Framework

Charcoal Core

, _(*1)

The charcoal-core module contains a few core charcoal namespaces: \Charcoal\Loader, \Charcoal\Model, \Charcoal\Source and \Charcoal\Validator., _(*2)

How to Install

The preferred (and only supported) way of installing charcoal-core is with composer:, _(*3)

★ composer require locomotivemtl/charcoal-core

For a complete, ready-to-use Charcoal project, start from the boilerplate:, _(*4)

★ composer create-project locomotivemtl/charcoal-project-boilerplate:@dev --prefer-source

Dependencies and Requirements

Charcoal depends on:, _(*5)

• PHP** 5.6+
  • PHP 7 is recommended, for performance and security.
• ext-pdo
• ext-mbstring
• psr/log
• psr/cache
• locomotivemtl/charcoal-config
• locomotivemtl/charcoal-factory
• locomotivemtl/charcoal-property
• locomotivemtl/charcoal-view

Loader

Model

Source

Validator

The validator namespace is obsolete and should not be used. Its usage is currently being removed from everywhere in charcoal., _(*6)

Development

To install the development environment:, _(*7)

★ composer install --prefer-source

To run the tests:, _(*8)

★ composer test

API documentation

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

Development dependencies

• phpunit/phpunit
• squizlabs/php_codesniffer
• satooshi/php-coveralls

Continuous Integration

Service	Badge	Description
Travis		Runs code sniff check and unit tests. Auto-generates API documentation.
Scrutinizer		Code quality checker. Also validates API documentation quality.
Coveralls		Unit Tests code coverage.
Sensiolabs		Another code quality checker, focused on PHP.

Coding Style

The charcoal-core module follows the Charcoal coding-style:, _(*9)

• PSR-1
• PSR-2
• PSR-4, autoloading is therefore provided by Composer.
• phpDocumentor comments.
• Read the phpcs.xml file for all the details on code style.

Coding style validation / enforcement can be performed with composer phpcs. An auto-fixer is also available with composer phpcbf., _(*10)

Authors

• Mathieu Ducharme mat@locomotive.ca

License

Charcoal is licensed under the MIT license. See LICENSE for details., _(*11)

Changelog

• Unreleased.

TODOs

• Remove the dependency on charcoal-app