Download the PHP package locomotivemtl/charcoal-contrib-redirect without Composer
On this page you can find all versions of the php package locomotivemtl/charcoal-contrib-redirect. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download locomotivemtl/charcoal-contrib-redirect
More information about locomotivemtl/charcoal-contrib-redirect
Files in locomotivemtl/charcoal-contrib-redirect
Package charcoal-contrib-redirect
Short Description A charcoal admin service that provides redirection.
License MIT
Homepage https://locomotivemtl.github.io/charcoal-contrib-redirect/
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package charcoal-contrib-redirect
Charcoal Redirect
A Charcoal service provider to handle route redirections from the admin interface.
Table of Contents
- Installation
- Dependencies
- Service Provider
- Services
- Configuration
- Usage
- Development
- API Documentation
- Development Dependencies
- Coding Style
- Credits
- License
Installation
The preferred (and only supported) method is with Composer:
Dependencies
Required
PSR
- PSR-11: Common interface for dependency containers. Fulfilled by Pimple.
Service Provider
The following services are provided with the use of charcoal-contrib-redirect
Services
- redirection instance
of
\Charcoal\Redirect\Service\Redirection
Configuration
The only required configuration for the redirect module is to require the module in the list of loaded modules in the app configuration.
Usage
When the module is loaded, a new database table (charcoal_contrib_redirect_redirections) will be created automatically
when needed. This table will be used to store redirections. When in the admin interface, a new item is added to the
system menu dropdown (Url redirections)
This system menu item requires the user to adhere to the "system/admin" acl permission.
Development
To install the development environment:
To run the scripts (phplint, phpcs, and phpunit):
API Documentation
- The auto-generated
phpDocumentorAPI documentation is available at:
https://locomotivemtl.github.io/charcoal-contrib-redirect/docs/master/ - The auto-generated
apigenAPI documentation is available at:
https://codedoc.pub/locomotivemtl/charcoal-contrib-redirect/master/
Development Dependencies
- [php-coveralls/php-coveralls][phpcov]
- [phpunit/phpunit][phpunit]
- [squizlabs/php_codesniffer][phpcs]
Coding Style
The charcoal-contrib-redirect module follows the Charcoal coding-style:
- PSR-1
- PSR-2
- PSR-4, autoloading is therefore provided by Composer.
- phpDocumentor comments.
- .editorconfig for coding standards.
Coding style validation / enforcement can be performed with
composer phpcs. An auto-fixer is also available withcomposer phpcbf.
Credits
- Locomotive
- Joel Alphonso
License
Charcoal is licensed under the MIT license. See LICENSE for details.
All versions of charcoal-contrib-redirect with dependencies
charcoal-admin Version >0.30.2
ext-json Version *