https://github.com/lorddashme/wordpress-db-schema-extender
A WordPress Database extender that provides a nice structure of table schema and data seeds.
https://github.com/lorddashme/wordpress-db-schema-extender
database extender php schema wordpress
Last synced: about 1 year ago
JSON representation
A WordPress Database extender that provides a nice structure of table schema and data seeds.
- Host: GitHub
- URL: https://github.com/lorddashme/wordpress-db-schema-extender
- Owner: LordDashMe
- License: mit
- Created: 2018-08-10T11:40:53.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2023-04-01T16:07:26.000Z (about 3 years ago)
- Last Synced: 2025-03-27T00:12:18.994Z (over 1 year ago)
- Topics: database, extender, php, schema, wordpress
- Language: PHP
- Homepage:
- Size: 79.1 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# WP DB Schema Extender
A WordPress Database extender that provides a nice structure of table schema and data seeds.
[](https://packagist.org/packages/LordDashMe/wordpress-db-schema-extender) [](https://php.net/) [](https://coveralls.io/github/LordDashMe/wordpress-db-schema-extender?branch=master)
## Requirement(s)
- PHP version from 5.6.* up to latest.
## Install
- It is advice to install the package via Composer. Use the command below to install the package:
```txt
composer require lorddashme/wordpress-db-schema-extender
```
## Usage
- You can start using the package without any configuration needed.
- Below are the available functions:
| Function | Description |
| -------- | ----------- |
| ![]()
|![]()
|
| ```table('tableName', closure);``` | Use to create table structure. |
| ```column('columnName', 'statement');``` | In the ```table(...)``` function second argument, the closure return an instance that allow you to use this function. This fucntion add the definition of your column that will be add to table. |
| ```primaryKey('columnName');``` | Also same with the ```column(...)``` function you can use this function via ```table(...)``` function second argument closure. This function add primary key to the table base on the given column name. |
| ```tableSeed('tableName', closure or array);``` | Use to seed data to the given table name. |
| ```tableName('tableName');``` | The return value of this function is concatenated with the wordpress table prefix setup in the config file. |
| ```rawQuery('statement');``` | Use to provide other sql query statement. Of course not all of the sql query is wrapped to this package that is why this function is provided to still allow you to do anything what you want. |
| ```migrate();``` | Use to commit all the declared statement. |
| ```dropTable('tableName');``` | Use to drop a single table. |
| ```dropTables(['tableName', ...]);``` | Use to drop a multiple tables. |
- Below are the sample implementation:
```php
init(function($context) {
$context->table('users', function($table) {
$table->column('id', 'INT(11) NOT NULL AUTO_INCREMENT');
$table->column('name', 'TEXT NULL');
$table->primaryKey('id');
});
$context->table('user_options', function($table) {
$table->column('id', 'INT(11) NOT NULL AUTO_INCREMENT');
$table->column('user_id', 'INT(11) NOT NULL');
$table->column('nick_name', 'INT(11) NOT NULL');
$table->primaryKey('id');
});
$context->rawQuery('
ALTER TABLE ' . $context->tableName('users_options') . '
ADD KEY `user_id` (`user_id`);
ALTER TABLE ' . $context->tableName('users_options') . '
ADD CONSTRAINT `foreign_constraint_users_option_users`
FOREIGN KEY (`user_id`)
REFERENCES ' . $context->tableName('users') . ' (`id`)
ON DELETE CASCADE
ON UPDATE NO ACTION;'
);
$context->tableSeed('users', function($data) {
$data->name = 'John Doe';
return $data;
});
});
$schemaExtender->tableSeed('user_options', function($data) {
$data->user_id = 1;
$data->nick_name = 'Nick Name' . rand();
return $data;
})->iterate(2);
// You can attach the "migrate" function to "register_activation_hook" of wordpress.
// When the wordpress plugin set to active you can add the extender "migrate" function
// to execute all the query stored before the activation begin.
register_activation_hook(
'/wp-content/plugins//.php',
function () use ($schemaExtender) {
$schemaExtender->migrate();
}
);
```
- You can also use the SchemaExtender class like static-like class. See the "use" namespace path or imported class used.
```php
table('users', function($table) {
$table->column('id', 'INT(11) NOT NULL AUTO_INCREMENT');
$table->column('name', 'TEXT NULL');
$table->primaryKey('id');
});
$context->table('user_options', function($table) {
$table->column('id', 'INT(11) NOT NULL AUTO_INCREMENT');
$table->column('user_id', 'INT(11) NOT NULL');
$table->column('nick_name', 'INT(11) NOT NULL');
$table->primaryKey('id');
});
$context->rawQuery('
ALTER TABLE ' . $context->tableName('users_options') . '
ADD KEY `user_id` (`user_id`);
ALTER TABLE ' . $context->tableName('users_options') . '
ADD CONSTRAINT `foreign_constraint_users_option_users`
FOREIGN KEY (`user_id`)
REFERENCES ' . $context->tableName('users') . ' (`id`)
ON DELETE CASCADE
ON UPDATE NO ACTION;'
);
});
SchemaExtender::tableSeed('users', function($data) {
$data->name = 'John Doe';
return $data;
});
SchemaExtender::tableSeed('user_options', function($data) {
$data->user_id = 1;
$data->nick_name = 'Nick Name' . rand();
return $data;
})->iterate(2);
```
### Seed Table
- The SchemaExtender class "tableSeed" function is not only for closure type in the second argument. Also you can use array type in the second argument.
```php
init();
$schemaExtender->tableSeed('users', [
'name' => 'John Doe',
]);
$schemaExtender->tableSeed('user_options', [
'user_id' => 1,
'nick_name' => 'Nick Name' . rand()
])->iterate(2);
```
### Drop Table
- The SchemaExtender class also provide a "dropTable" or "dropTables" function to accomodate the drop table action.
```php
init();
$schemaExtender->dropTable('users');
$schemaExtender->dropTable('user_options');
// Or you can also use the alias function that support multiple table names in a single argument.
$schemaExtender->dropTables(['users', 'user_options']);
```
## License
- This package is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).