Download the PHP package hegentopf/easy-orm without Composer

EasyORM Usage Guide

This document provides examples and explanations for using EasyORM, including model creation, query building, and fetching data.

Installation

Install via Composer:

Basic Usage

Initial Setup for Creation and Usage

Model Creation

This will generate models for all tables in your current database.

Using Models

QueryBuilder Examples

Simple Select

Select with Where, GroupBy, OrderBy

Joins

Subqueries

Notes and Best Practices

• SQL-Injections are prevented by using prepared statements.
• Joined Data can be accessed via magic getters, e.g., $model->getJoinedColumnName().
• Date, DateTime, and Timestamp columns are automatically converted to DateTime objects. Note that the DateTime object is a copy, so modifying it does not change the model's value. To change the value, use the setter method.
• Use new DbExpression( 'NOW()' ) for raw SQL expressions when needed (⚠️ be aware of SQL-Injections).
• Use take() and skip() as alternatives to limit() and offset().
• To fetch only one model, use first() instead of get() and you will receive a single model or null.
• Columns are automatically mapped to protected properties.
• Only changed Columns are updated in the database.
• Generated models follow camelCase conversion from table and column names. order_items → orderItems