locomotivemtl / charcoal-core
Charcoal Web Framework
Installs: 23 249
Dependents: 16
Suggesters: 0
Security: 0
Stars: 6
Watchers: 13
Forks: 0
Open Issues: 4
Requires
- php: >=5.6.0 || >=7.0
- ext-mbstring: *
- ext-pdo: *
- locomotivemtl/charcoal-cache: ~0.1
- locomotivemtl/charcoal-config: ~0.9
- locomotivemtl/charcoal-factory: ~0.4
- locomotivemtl/charcoal-property: ~0.10
- locomotivemtl/charcoal-view: ~0.3
- pimple/pimple: ^3.0
- psr/cache: ^1.0
- psr/log: ^1.0
Requires (Dev)
- cache/void-adapter: ^0.3.0
- locomotivemtl/charcoal-app: ^0.4
- mockery/mockery: ^0.9.6
- php-coveralls/php-coveralls: ^2.0
- phpunit/phpunit: ^5.7 || ^6.5
- squizlabs/php_codesniffer: ^3.0
- tedivm/stash: ~0.14
- dev-master / 0.6.x-dev
- 0.6.4
- 0.6.3
- 0.6.2.1
- 0.6.2
- 0.6.1
- 0.6.0
- 0.5.0
- 0.4.7
- 0.4.6
- 0.4.5
- 0.4.4.1
- 0.4.4
- 0.4.3
- 0.4.2
- 0.4.1
- 0.4.0
- 0.3.8
- 0.3.7
- 0.3.6
- 0.3.5
- 0.3.4
- 0.3.3
- 0.3.2
- 0.3.1
- 0.3
- 0.2.11
- 0.2.10
- 0.2.9
- 0.2.8
- 0.2.7.1
- 0.2.7
- 0.2.6
- 0.2.5
- 0.2.4
- 0.2.3
- 0.2.2
- 0.2.1
- 0.2
- 0.1
- dev-michel/advanced-search
- dev-feature/between-filter
- dev-feature/has-active-filters
- dev-joel/feat/query
- dev-mcaskill-patch-table-structure
- dev-feature/camelizePropertiesAndUseArrayAccess
- dev-mcaskill-callable-resolver
This package is auto-updated.
Last update: 2024-11-26 13:59:12 UTC
README
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:
★ composer require locomotivemtl/charcoal-core
For a complete, ready-to-use Charcoal project, start from the boilerplate:
★ composer create-project locomotivemtl/charcoal-project-boilerplate:@dev --prefer-source
Dependencies and Requirements
Charcoal depends on:
PHP** 5.6+PHP 7is recommended, for performance and security.
ext-pdoext-mbstringpsr/logpsr/cachelocomotivemtl/charcoal-configlocomotivemtl/charcoal-factorylocomotivemtl/charcoal-propertylocomotivemtl/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:
★ composer install --prefer-source
To run the tests:
★ composer test
API documentation
- The auto-generated
phpDocumentorAPI documentation is available at https://locomotivemtl.github.io/charcoal-core/docs/master/ - The auto-generated
apigenAPI documentation is available at https://codedoc.pub/locomotivemtl/charcoal-core/master/
Development dependencies
phpunit/phpunitsquizlabs/php_codesniffersatooshi/php-coveralls
Continuous Integration
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 mat@locomotive.ca
License
Charcoal is licensed under the MIT license. See LICENSE for details.
Changelog
- Unreleased.
TODOs
- Remove the dependency on charcoal-app