README

Model418 is a nice-to-use & highly flexible ORM.
It maps your data, from a database or another source, and its relationships into accessible objects.
It could be used with or without a framework.

1. Features
2. Let's code
3. How to Install
4. How to Contribute
5. Author & Community

Features

For now, Model418 supports only the following storage:

• File System:
  • Encoding: in Yaml (default), JSON, Text or Markdown
  • Subfile: Write the data of an attribute in another file
  • Multi folders: Use multiple folders, like plugins folder
• Session System

↑ top

Let's code

// Save a new Model
$user = (new UserModel)
    ->set('firstName', 'John')
    ->save();

// Retrieve all models
$userList = (new UserModel)->query()->fetchAll();
count($userList) // 1 
    
// Retrieve by primary key
$john = (new UserModel)->query()->fetchById(1);
    
// Update an existing Model
$john->set('lastName', 'Doe')
    ->save();
    
// Delete an existing Model
$john->delete();

To go further, you should read the complete documentation.

↑ top

How to Install

This library package requires PHP 5.4 or later.
Install Composer and run the following command to get the latest version:

composer require baddum/model418:1.2.*

↑ top

How to Contribute

Get involved

1. Star the project!
2. Report a bug that you find
3. Tweet and blog about Model418 and Let me know about it.

Pull Requests

Pull requests are highly appreciated.
Please review the guidelines for contributing to go further.

↑ top

Author & Community

Model418 is under MIT License.
It was created & is maintained by Thomas ZILLIOX.