https://github.com/arif-rh/ci4-dynamic-model

Creating CodeIgniter 4 Model on-the-fly with Relationship Built-in Feature
https://github.com/arif-rh/ci4-dynamic-model

codeigniter4 codeigniter4-model codeigniter4-relationship

Last synced: 2 months ago
JSON representation

Creating CodeIgniter 4 Model on-the-fly with Relationship Built-in Feature

• Host: GitHub
• URL: https://github.com/arif-rh/ci4-dynamic-model
• Owner: arif-rh
• License: mit
• Created: 2020-04-16T00:53:47.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2021-06-08T20:38:16.000Z (over 3 years ago)
• Last Synced: 2024-10-01T00:41:21.308Z (3 months ago)
• Topics: codeigniter4, codeigniter4-model, codeigniter4-relationship
• Language: PHP
• Size: 127 KB
• Stars: 17
• Watchers: 3
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# DynaModel

Dynamic Model for CodeIgniter 4

===============================

[![Build Status](https://travis-ci.com/arif-rh/ci4-dynamic-model.svg?branch=master)](https://travis-ci.com/arif-rh/ci4-dynamic-model)  [![Coverage Status](https://coveralls.io/repos/github/arif-rh/ci4-dynamic-model/badge.svg?branch=master)](https://coveralls.io/github/arif-rh/ci4-dynamic-model?branch=master)

## Feature

* Dynamically Creating the Model on-the-fly

* Support One-to-One / Many-to-One relationship

* Support One-to-Many relationship

* Can Filter data based on child/related criteria

* Can set the order of One-to-Many relationship result based on child criteria

## Installation

````composer require arif-rh/ci4-dynamic-model````

## Usage

### Simple

```` 

    // creating postModel on-the-fly, just pass a table name

    $postModel = \Arifrh\DynaModel\DB::table('posts');

    // then you can use it, to get all posts

    $postModel->findAll();

````

### Many-to-One Relationship

````

    // assume that posts always belongs to one author using author_id 

    $postModel->belongsTo('authors);

    // then you can grab author info along with posts

    $postModel->with('authors')->findAll();

    /**

    * by default, primary key of authors will be omit in the column result

    * because its value already exist in the foregin key of relationship

    * 

    * if authors has same column name with posts, then it will be aliased with prefix "author_"

    * for example, both posts and authors has "rating" column, then it will become author_rating

    */

    // you can call only spesific column if you need, pass it on the second parameters in array

    $postModel->with('authors', ['name', 'rating'])->findAll(); 

    // will display all posts column, plus author name and author rating

    // you can filter posts based on author criteria

    $postModel->with('authors')->whereRelation('authors', ['status' => 'active'])->findAll();

    // will display all posts only from active authors

````

### One-to-Many Relationship

````

    $postModel->hasMany('comments');

    // this will return posts with all related comments

    $postModel->with('comments')->findAll();

    // you can also filter posts based on comments criteria

    $postModel->with('comments')->whereRelation('comments', ['status' => 'approved'])->findAll();

    // will display all posts with approved comments only

````

## Testing

````

    composer test

    // or

    composer testdox

    // analyse code

    composer analyse

````