guilhermeabel/matcha-orm

A lightweight and flexible Object-Relational Mapping (ORM) library for PHP

dev-master 2023-07-12 02:53 UTC

Requires

• php: >=8.1
• ext-json: *
• ext-pdo: *

Requires (Dev)

• doctrine/dbal: ^2.10
• phpunit/phpunit: ^9.0
• squizlabs/php_codesniffer: 3.*

MIT

• Your Name

• database
• orm
• php
• mapper

README

Matcha ORM is a lightweight and flexible Object-Relational Mapping (ORM) library for PHP. It provides an easy-to-use API for working with relational databases, enabling developers to interact with data through an object-oriented approach.

Features ✨

• ✅ CRUD operations (Create, Read, Update, Delete)
• 🗺️ Mapping classes to database tables and properties to columns
• 🔍 Querying and filtering data
• 📦 Migrations and schema management (coming soon...)
• 🧑‍🤝‍🧑 Relationships between entities (one-to-one, one-to-many, many-to-many)
• 🚛 Lazy and eager loading
• 🔄 Transactions and concurrency control

Installation 📦

You can install Matcha ORM using Composer:

composer require guilhermeabel/matcha-orm

Getting Started 🏁

To get started, you have to define your database connection constants:

<?php

define('DB_NAME', 'matcha');
define('DB_USER', 'root');
define('DB_PASS', '');
define('DB_DRIVER', 'mysql');
define('DB_HOST', 'localhost');

Next, create a model class that extends the MatchaORM\Model class and maps to a database table:

use MatchaORM\Model;

class User extends Model
{
 protected $fillable = ['name', 'email', 'password'];
}

Make sure to define the $fillable property with the columns that can be mass assigned.

MatchaORM will automatically create a new instance for connection using the database configuration constants defined earlier.

Now you can perform CRUD operations and more with your User model:

// Create a user
$user = new User();
$user->name = 'John Doe';
$user->email = '[e-mail]';
$user->save();

// Update a user
$user = User::find(1);
$user->name = 'John Doe';
$user->email = '[e-mail]' . rand(1, 100);
$user->save();

// Delete a user
$user = User::find(1);
$user->delete();