Skip to content

Commit

Permalink
Initial release
Browse files Browse the repository at this point in the history
  • Loading branch information
knowler authored Nov 23, 2018
1 parent 91f6d42 commit 75959bf
Show file tree
Hide file tree
Showing 7 changed files with 751 additions and 13 deletions.
22 changes: 22 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
Copyright 2018 Nathan Knowler

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or
sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
52 changes: 48 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,52 @@
# WordPress Schema Migration
# WordPress Capsule

Fluent schema (database) migrations for WordPress. Ideally, this
package can be used by a plugin.
[![Build Status](https://travis-ci.org/knowler/wp-capsule.svg?branch=master)](https://travis-ci.org/knowler/wp-capsule)

**Requirements**
Illuminate's [Capsule] preset for WordPress. This is just a
wrapper with a config, so kudos to Laravel for being awesome.

This is _not_ a plugin, it's a package for use in a WordPress
plugin.

[Capsule]: https://github.com/illuminate/database

## Requirements

* PHP: ^7.1

## Installation

```sh
composer require knowler/wp-capsule
```

## Usage

Here's example usage within a plugin:

```php
/** Autoload */
require_once __DIR__ . '/vendor/autoload.php';

/** Boot Capsule */
new Knowler\WP\Capsule\Boot;

use Knowler\WP\Capsule\Capsule;

register_activation_hook(__FILE__, function () {
Capsule::schema()->create('products', function ($table) {
$table->increments('id');
$table->string('name');
$table->timestamps();
});
});

register_deactivation_hook(__FILE__, function () {
Capsule::schema()->dropIfExists('products');
});
```

## Contributing

Feel free to make a pull request or report issues. I threw this
together pretty quickly.
20 changes: 15 additions & 5 deletions composer.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "knowler/wp-schema-migration",
"description": "A fluent interface for schema migrations in WordPress.",
"name": "knowler/wp-capsule",
"description": "Laravel Illuminate Capsule configured for WordPress.",
"license": "MIT",
"authors": [
{
Expand All @@ -9,18 +9,28 @@
"homepage": "https://knowlerkno.ws"
}
],
"keywords": [
"capsule",
"wordpress",
"laravel",
"illuminate",
"database"
],
"autoload": {
"psr-4": {
"Knowler\\WP\\Database\\": "src"
"Knowler\\WP\\Capsule\\": "src"
}
},
"autoload-dev": {
"psr-4": {
"Knowler\\WP\\DatabaseTests\\": "tests"
"Knowler\\WP\\CapsuleTests\\": "tests"
}
},
"require": {
"php": "^7.1"
"php": "^7.1",
"illuminate/database": "^5.7",
"illuminate/events": "^5.7",
"illuminate/support": "^5.7"
},
"require-dev": {
"squizlabs/php_codesniffer": "^3.3",
Expand Down
Loading

0 comments on commit 75959bf

Please sign in to comment.