You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
102 lines
3.1 KiB
102 lines
3.1 KiB
3 years ago
|
<p align="center">
|
||
|
|
<a href="https://medoo.in" target="_blank"><img src="https://cloud.githubusercontent.com/assets/1467904/19835326/ca62bc36-9ebd-11e6-8b37-7240d76319cd.png"></a>
|
||
|
|
</p>
|
||
|
|
|
||
|
|
<p align="center">
|
||
|
|
<a href="https://packagist.org/packages/catfan/medoo"><img alt="Total Downloads" src="https://poser.pugx.org/catfan/medoo/downloads"></a>
|
||
|
|
<a href="https://packagist.org/packages/catfan/medoo"><img alt="Latest Stable Version" src="https://poser.pugx.org/catfan/medoo/v/stable"></a>
|
||
|
|
<a href="https://packagist.org/packages/catfan/medoo"><img alt="License" src="https://poser.pugx.org/catfan/medoo/license"></a>
|
||
|
|
<a href="https://opencollective.com/medoo"><img alt="Backers on Open Collective" src="https://opencollective.com/Medoo/backers/badge.svg"></a>
|
||
|
|
<a href="https://opencollective.com/medoo"><img alt="Sponsors on Open Collective" src="https://opencollective.com/Medoo/sponsors/badge.svg"> </a>
|
||
|
|
</p>
|
||
|
|
|
||
|
|
> The lightweight PHP database framework to accelerate development
|
||
|
|
|
||
|
|
## Features
|
||
|
|
|
||
|
|
* **Lightweight** - Less than 100 KB, portable with only one file
|
||
|
|
|
||
|
|
* **Easy** - Extremely easy to learn and use, friendly construction
|
||
|
|
|
||
|
|
* **Powerful** - Supports various common and complex SQL queries, data mapping, and prevent SQL injection
|
||
|
|
|
||
|
|
* **Compatible** - Supports all SQL databases, including MySQL, MSSQL, SQLite, MariaDB, PostgreSQL, Sybase, Oracle and more
|
||
|
|
|
||
|
|
* **Friendly** - Works well with every PHP frameworks, like Laravel, Codeigniter, Yii, Slim, and framework which supports singleton extension or composer
|
||
|
|
|
||
|
|
* **Free** - Under MIT license, you can use it anywhere whatever you want
|
||
|
|
|
||
|
|
## Requirement
|
||
|
|
|
||
|
|
PHP 5.4+ and PDO extension installed, recommend PHP 7.0+
|
||
|
|
|
||
|
|
## Get Started
|
||
|
|
|
||
|
|
### Install via composer
|
||
|
|
|
||
|
|
Add Medoo to composer.json configuration file.
|
||
|
|
```
|
||
|
|
$ composer require catfan/medoo
|
||
|
|
```
|
||
|
|
|
||
|
|
And update the composer
|
||
|
|
```
|
||
|
|
$ composer update
|
||
|
|
```
|
||
|
|
|
||
|
|
```php
|
||
|
|
// If you installed via composer, just use this code to require autoloader on the top of your projects.
|
||
|
|
require 'vendor/autoload.php';
|
||
|
|
|
||
|
|
// Using Medoo namespace
|
||
|
|
use Medoo\Medoo;
|
||
|
|
|
||
|
|
// Initialize
|
||
|
|
$database = new Medoo([
|
||
|
|
'database_type' => 'mysql',
|
||
|
|
'database_name' => 'name',
|
||
|
|
'server' => 'localhost',
|
||
|
|
'username' => 'your_username',
|
||
|
|
'password' => 'your_password'
|
||
|
|
]);
|
||
|
|
|
||
|
|
// Enjoy
|
||
|
|
$database->insert('account', [
|
||
|
|
'user_name' => 'foo',
|
||
|
|
'email' => 'foo@bar.com'
|
||
|
|
]);
|
||
|
|
|
||
|
|
$data = $database->select('account', [
|
||
|
|
'user_name',
|
||
|
|
'email'
|
||
|
|
], [
|
||
|
|
'user_id' => 50
|
||
|
|
]);
|
||
|
|
|
||
|
|
echo json_encode($data);
|
||
|
|
|
||
|
|
// [
|
||
|
|
// {
|
||
|
|
// "user_name" : "foo",
|
||
|
|
// "email" : "foo@bar.com",
|
||
|
|
// }
|
||
|
|
// ]
|
||
|
|
```
|
||
|
|
|
||
|
|
## Contribution Guides
|
||
|
|
|
||
|
|
For most of time, Medoo is using develop branch for adding feature and fixing bug, and the branch will be merged into master branch while releasing a public version. For contribution, submit your code to the develop branch, and start a pull request into it.
|
||
|
|
|
||
|
|
On develop branch, each commits are started with `[fix]`, `[feature]` or `[update]` tag to indicate the change.
|
||
|
|
|
||
|
|
Keep it simple and keep it clear.
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
Medoo is under the MIT license.
|
||
|
|
|
||
|
|
## Links
|
||
|
|
|
||
|
|
* Official website: [https://medoo.in](https://medoo.in)
|
||
|
|
|
||
|
|
* Documentation: [https://medoo.in/doc](https://medoo.in/doc)
|