https://github.com/softwarepunt/instarecord

✨ A hyper productive ORM library for PHP + MySQL.
https://github.com/softwarepunt/instarecord

database mysql orm php query-builder

Last synced: about 2 months ago
JSON representation

✨ A hyper productive ORM library for PHP + MySQL.

• Host: GitHub
• URL: https://github.com/softwarepunt/instarecord
• Owner: SoftwarePunt
• License: mit
• Created: 2020-09-02T02:13:18.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-11-06T17:03:54.000Z (2 months ago)
• Last Synced: 2024-11-06T18:18:52.304Z (2 months ago)
• Topics: database, mysql, orm, php, query-builder
• Language: PHP
• Homepage:
• Size: 377 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Instarecord

**✨ A hyper productive ORM for PHP.**

[![Packagist Version](https://img.shields.io/packagist/v/softwarepunt/instarecord?logo=packagist)](https://packagist.org/packages/softwarepunt/instarecord)

[![PHPUnit](https://github.com/SoftwarePunt/instarecord/actions/workflows/phpunit.yml/badge.svg)](https://github.com/SoftwarePunt/instarecord/actions/workflows/phpunit.yml)

Instarecord makes it super easy and fun to work with MySQL databases in PHP. It's fast and intuitive, and loaded with optional features to make your life easier.

## The pitch

🧙‍♂️ Define your models with typed variables, and Instarecord figures out the rest!

```php

email = "[email protected]";

$user->save(); 

echo "Created user #{$user->id}!";

```

## Features

### 🗺️ [Object Mapping](./docs/ObjectMapping.md)

Define your models as pure PHP classes with typed properties. Use them like regular objects.

### 📦 [Easy CRUD](./docs/CRUD.md)

Use intuitive object-oriented CRUD (create, read, update, and delete) operations on your models.

### 🔎 [Query Builder](./docs/Queries.md)

Use the query builder to quickly build and run more complex queries with prepared statements.

### 🤝 [Relationships](./docs/Relationships.md)

Set up relationships between your models and easily load them in an optimized way.

### ✅ [Validation](./docs/Validation.md)

Add constraints to your model properties and validate them with user-friendly error messages. 

## Quickstart

### Installation

Add Instarecord to your project with [Composer](https://getcomposer.org/):

```bash

composer require softwarepunt/instarecord

```

### Configuration

Pass your own `DatabaseConfig` or modify the default one:

```php

charset = "utf8mb4";

$config->unix_socket = "/var/run/mysqld/mysqld.sock";

$config->username = "my_user";

$config->password = "my_password";

$config->database = "my_database";

$config->timezone = "UTC";

```  

### Use models

Defines your models by creating normal classes with public properties, and extending `Model`:

```php

make = "Toyota";

$car->model = "Corolla";

$car->year = 2005;

$car->save(); // INSERT INTO cars [..]

// Post insert, the primary key (id) is automatically populated

$car->year = 2006;

$car->save(); // UPDATE cars SET year = 2006 WHERE id = 123

$car->delete(); // DELETE FROM cars WHERE id = 123

```

### Run queries

You can easily build and run custom queries, and get results in various ways - from raw data to fully populated models.

#### From models

```php

$matchingCars = Car::query()

    ->where('make = ?', 'Toyota')

    ->andWhere('year > ?', 2000)

    ->orderBy('year DESC')

    ->limit(10)

    ->queryAllModels(); // Car[]

```

#### Standalone

```php

$carsPerYear = Instarecord::query()

    ->select('year, COUNT(*) as count')

    ->from('cars')

    ->groupBy('year')

    ->queryKeyValueArray(); // [2005 => 10, 2006 => 5, ..]

```