dr2gsistemas/korm

Pseudo library orm utils

dev-main 2022-04-24 02:56 UTC

Requires

• ext-pdo: *

Requires (Dev)

• pestphp/pest: ^1.21

proprietary

• Dario Garcia

• database
• orm
• utils
• entity

README

Pseudo library to be a orm utility.

💀 Don't use in production, is just for fun and practice!

💀 No utilice en producción, es solo por diversión y practica

Usage/Uso

<?php

use DR2GSistemas\korm\classes\Column;
use DR2GSistemas\korm\classes\Entity;
use DR2GSistemas\korm\classes\Index;


/*Declare a class and extends with Entity class*/
/*Declarar la clase extendiendo con Entity*/
class Product extends Entity {
    //typed public fields
    //variables publicas tipadas
    #[Column(type:"integer",  primaryKey:true, autoincrement:true)]
    public int $id;
    #[Column(type:"varchar(255)", nullable: false )]  //declare as field varchar(255) not null
    #[Index(indexname:"idx_product_name",unique: false)]  //declare as index with name idx_product_name and unique false
    public string $name;
    #[Column(type:"numeric(10,2)", nullable: true)]
    public float $price;

    public function __construct() {
        //optional: can define your tablename in the constructor
        //opcional: se puede definir el nombre de la tabla en el contructor
        $this->tablename = 'products';
    }
}


/*init a new instance*/
/*iniciar la instancia*/
$product = new Product();
/*or create from json*/
/*o desde un json*/
$product = Product::fromJson(["name"=>"sugar", "id"=>1, "price"=>3.59]);

/*populate from array...*/
/*poblar con un array...*/
$product->populate(["name"=>"sugar", "id"=>1, "price"=>3.59]);

/*build a insert statement*/
/*construir la sentencia de inserción*/
$stmt = $product->insert();

/*build a update statement*/
/*construir la sentencia de actualización*/
$product->name = "sugar rainbow"; /* changed */
$product->price = "4.59";
$stmt = $product->update();

/*build delete statement*/
/*construir la sentencia de borrado*/
$stmt = $product->delete();


/*execute the stmt in a favorite conection */
/*ejecutar la sentencia en su conector favorito*/
GhostlyDatabaseInstanceManager::getInstace()->executeOrFail($stmt);

From Villeta, Paraguay with 💖

Desde Villeta, Paraguay con 💖

History

• 0.1.0:

  • init the journey

• 0.1.1:

  • bugfix on detect primaryKeyFieldName on update() and insert()
  • bugfix on detect tablename fieldname on insert(), update() and delete()
  • add EntityTest.php for testing

• 0.1.2:

  • some small fixes

• 0.1.3

  • add selectAll() and selectOne()

• 0.1.4

  • add DDLBuilder class
  • add IDDL interface for entities
    • public function _createDDL(): string;
    • public function _dropDDL(): string;
    • public function _createIndexesDDL(): array;
    • public function _dropIndexesDDL(): array;
    • public function _createForeignKeysDDL(): array;
    • public function _dropForeignKeysDDL(): array;
    • public function _resetAutoIncrement(int $value = 1): string;

Todo:

• add functions selectAll() and selectOne()
• test functions selectAll() and selectOne()
• Reach better performance on build statements 🚤
• Relations 🔗
• Conectors 🔌
• Build from classes to database scheme 🔌
• Build classes from database scheme 🏗️
• Do better documentation 📖
• Enjoy a 🍺 of a contributor 😄 (optional)