Download the PHP package locomotivemtl/charcoal-contrib-database-migrator without Composer
On this page you can find all versions of the php package locomotivemtl/charcoal-contrib-database-migrator. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download locomotivemtl/charcoal-contrib-database-migrator
More information about locomotivemtl/charcoal-contrib-database-migrator
Files in locomotivemtl/charcoal-contrib-database-migrator
Package charcoal-contrib-database-migrator
Short Description Charcoal service provider for database migrations.
License MIT
Homepage https://github.com/locomotivemtl/charcoal-contrib-database-migrator/
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-database-migrator
Charcoal DatabaseMigrator
A Charcoal service provider my cool feature.
Table of Contents
- Installation
- Dependencies
- Configuration
- Usage
- Running the migration
- Creating new Migrations
- Injecting Migrations to the migrator
- Development
- API Documentation
- Development Dependencies
- Coding Style
- Credits
- License
Installation
The preferred (and only supported) method is with Composer:
Dependencies
Required
- PHP 7.2+: PHP 7.3+ is recommended.
PSR
- PSR-7: Common interface for HTTP messages. Fulfilled by Slim.
- PSR-11: Common interface for dependency containers. Fulfilled by Pimple.
Configuration
In your project's config file, require the migrator module like so :
Optionally, you can also override some migrator configurations in the project's config file using the key :
Usage
Running the migration
Simply run this command in the console to lunch the migration process
The CLI UI will guide you step by step.
Creating new Migrations
A migration should always extend AbstractMigration
MigrationYYYYMMDDHHMMSS.stub can be used as a starting point when creating new migrations. Just copy and paste it the package in need of a new migration.
A migration should always be named MigrationYYYYMMDDHHMMSS.php to facilitate readability.
A migration file consist of a PHP class which follows these guidelines :
- Contains the timestamp of the commit this migration is fixing in the class name prefixed with
migration - Have an
upand optionallydownmethods for the migration tool to process the migration when going up in version or down. - Have a
descripionmethod to briefly document the migration
you can implement the setDependencies method on a migration.
You can also use the init() function to process data that is both needed in up and down methods.
Injecting Migrations to the migrator
As long as the migration follows the guidelines described above, it'll be automatically parsed by the migrator. No need to do anything more than that.
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-database-migrator/docs/master/ - The auto-generated
apigenAPI documentation is available at:
https://codedoc.pub/locomotivemtl/charcoal-contrib-database-migrator/master/
Development Dependencies
- [php-coveralls/php-coveralls][phpcov]
- [phpunit/phpunit][phpunit]
- [squizlabs/php_codesniffer][phpcs]
Coding Style
The charcoal-contrib-database-migrator 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
License
Charcoal is licensed under the MIT license. See LICENSE for details.
All versions of charcoal-contrib-database-migrator with dependencies
ext-pdo Version *
locomotivemtl/charcoal-config Version *
locomotivemtl/charcoal-factory Version *
locomotivemtl/charcoal-core Version *
locomotivemtl/charcoal-app Version *