Download the PHP package locomotivemtl/charcoal-admin without Composer
On this page you can find all versions of the php package locomotivemtl/charcoal-admin. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download locomotivemtl/charcoal-admin
More information about locomotivemtl/charcoal-admin
Files in locomotivemtl/charcoal-admin
Package charcoal-admin
Short Description The Charcoal Administration Dashboard
License MIT
Homepage https://charcoal.locomotive.ca
Informations about the package charcoal-admin
Charcoal Admin Module
The standard Charcoal Admin Control Panel (Backend Dashboard).
How to install
The preferred (and only supported) way of installing charcoal-admin is with composer:
Note that charcoal-admin is intended to be run along a
charcoal-app
based project. To start from a boilerplate:shell $ composer install --prefer-source shell $ composer test
API documentation
- The auto-generated
phpDocumentor
API documentation is available at https://locomotivemtl.github.io/charcoal-admin/docs/master/ - The auto-generated
apigen
API documentation is available at https://codedoc.pub/locomotivemtl/charcoal-admin/master/
Coding style
The Charcoal-Admin module follows the Charcoal coding-style:
- PSR-1, except for
- Method names MUST be declared in
snake_case
.
- Method names MUST be declared in
- PSR-2, except for the PSR-1 requirement.q
- PSR-4, autoloading is therefore provided by Composer
- phpDocumentor
- Add DocBlocks for all classes, methods, and functions;
- For type-hinting, use
boolean
(instead ofbool
),integer
(instead ofint
),float
(instead ofdouble
orreal
); - Omit the
@return
tag if the method does not return anything.
- Naming conventions
- Read the phpcs.xml file for all the details.
Coding style validation / enforcement can be performed with
composer phpcs
. An auto-fixer is also available withcomposer phpcbf
.
For Javascript, the following coding style is enforced:
- todo
Every classes, methods and functions should be covered by unit tests. PHP code can be tested with PHPUnit and Javascript code with QUnit.
Authors
- Mathieu Ducharme [email protected]
- Benjamin Roch [email protected]
- Dominic Lord [email protected]
- Chauncey McAskill [email protected]
- Antoine Boulanger [email protected]
- Joel Alphonso [email protected]
License
Charcoal is licensed under the MIT license. See LICENSE for details.
All versions of charcoal-admin with dependencies
barryvdh/elfinder-flysystem-driver Version ^0.3
guzzlehttp/guzzle Version ^6.0 || ^7.0
kriswallsmith/assetic Version ^1.4
laminas/laminas-permissions-acl Version ^2.8
locomotivemtl/charcoal-app Version ~0.9
locomotivemtl/charcoal-cache Version ~0.1
locomotivemtl/charcoal-cms Version ~0.9
locomotivemtl/charcoal-core Version ~0.6
locomotivemtl/charcoal-email Version ~0.4
locomotivemtl/charcoal-object Version ~0.8
locomotivemtl/charcoal-translator Version ~0.3
locomotivemtl/charcoal-ui Version ~0.3
locomotivemtl/charcoal-user Version ~0.7
mcaskill/php-html-build-attributes Version ^1.0
paragonie/random_compat Version >=2
psr/cache Version ^1.0
psr/http-message Version ^1.0
psr/log Version ^1.0
studio-42/elfinder Version 2.1.61