Download the PHP package locomotivemtl/charcoal-core without Composer
On this page you can find all versions of the php package locomotivemtl/charcoal-core. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download locomotivemtl/charcoal-core
More information about locomotivemtl/charcoal-core
Files in locomotivemtl/charcoal-core
Package charcoal-core
Short Description Charcoal Web Framework
License MIT
Homepage https://charcoal.locomotive.ca
Informations about the package charcoal-core
Charcoal Core
The charcoal-core
module contains a few core charcoal namespaces: \Charcoal\Loader
, \Charcoal\Model
, \Charcoal\Source
and \Charcoal\Validator
.
How to Install
The preferred (and only supported) way of installing charcoal-core is with composer:
For a complete, ready-to-use Charcoal project, start from the boilerplate
:
Dependencies and Requirements
Charcoal depends on:
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.
Development
To install the development environment:
To run the tests:
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:
- 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 withcomposer phpcbf
.
Authors
- Mathieu Ducharme [email protected]
License
Charcoal is licensed under the MIT license. See LICENSE for details.
Changelog
- Unreleased.
TODOs
- Remove the dependency on charcoal-app
All versions of charcoal-core with dependencies
ext-pdo Version *
ext-mbstring Version *
psr/log Version ^1.0
psr/cache Version ^1.0
pimple/pimple Version ^3.0
locomotivemtl/charcoal-cache Version ~0.1
locomotivemtl/charcoal-config Version ~0.9
locomotivemtl/charcoal-factory Version ~0.4
locomotivemtl/charcoal-property Version ~0.10
locomotivemtl/charcoal-view Version ~0.3