Download the PHP package tarasmatskovich/house-orm without Composer

House ORM

House ORM is a simply PHP object relationship mapping library for wotk with data in database.

Available drivers

• Memory (for test environment)
• MySQL

Installing

Usage

For example in datatabase exists table users with fields id, name. You have to create corresponding entity Class and specify fields mapping:

Important part of entity class is docs annotations. It uses for mapping specifing First required type of entity annotations is Gateway in format.

For example if you have table in database named users you have to write:

Second type of entity annotations is Field

You should specify this annotation on entity class field which want to map:

Then you have to create repository (mapper) class for work with corresponding entity wich extends houseorm/mapper/DomainMapper class. Lets continue exmple with users:

Then you should to register this repository (mapper) in entity manager. This is config params:

House ORM have two drivers. First for real with real mysql database:

Second for tests (All data will be save on PHP proccess memory and you do not need real database):

Creating entity manager and register UserRepository and User entity:

Then you can get access to repository:

Find

To find user entity with primary key (default id):

Also you can find entity through criteria

Save

To save new entity you have to create new object of entity class, fill fields and save through repository:

Update

To update entity you may change some fields and save entity object through repository:

Delete

To delete entity:

Relations

For specifying relations you have to use special annotations. Exist two types of relations:

• Simple relation (for example table comments have field user_id which directly related with table users and field id)
• Complicated relation wich need one more binding table (for exampe exist tables users, roles, and binding table user_roles which have binding fields user_id and role_id which related with fields id in users and roles tables corresponding)

Simple relations

Specifying by special annotation Relation. This is our example with users. User entity class:

And new entity Comment class:

Complicated relations

To specify complicated relations you have to use special annotation ViaRelation Example - entity Role related with User through binding entity UserRole User entity class:

UserRole entity:

Role entity class:

Cache

You can use cache to increase performance of ORM work. House ORM support two drivers of cache:

• Memory cache (usefull for async php)
• Redis cache Usage memory cache:

Usage Redis cache: