Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/nguyenanhung/codeigniter-framework

CodeIgniter Framework Version 3 - Vendor Packages build - Maintain by @nguyenanhung
https://github.com/nguyenanhung/codeigniter-framework
codeigniter codeigniter-hmvc codeigniter-library codeigniter-skeleton codeigniter-starterkit codeigniter3 php
Last synced: 2 months ago
JSON representation
CodeIgniter Framework Version 3 - Vendor Packages build - Maintain by @nguyenanhung
Host: GitHub
URL: https://github.com/nguyenanhung/codeigniter-framework
Owner: nguyenanhung
License: mit
Created: 2020-12-05T03:55:42.000Z (about 4 years ago)
Default Branch: master
Last Pushed: 2024-09-21T20:26:21.000Z (3 months ago)
Last Synced: 2024-09-28T16:42:09.733Z (3 months ago)
Topics: codeigniter, codeigniter-hmvc, codeigniter-library, codeigniter-skeleton, codeigniter-starterkit, codeigniter3, php
Language: PHP
Homepage: https://packagist.org/packages/nguyenanhung/codeigniter-framework
Size: 1.43 MB
Stars: 5
Watchers: 3
Forks: 4
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: contributing.md
- License: license.txt
Awesome Lists containing this project

README

        # CodeIgniter v3.2.x - vendor packages build

[![Latest Stable Version](https://img.shields.io/packagist/v/nguyenanhung/codeigniter-framework.svg?style=flat-square)](https://packagist.org/packages/nguyenanhung/codeigniter-framework)

[![Total Downloads](https://img.shields.io/packagist/dt/nguyenanhung/codeigniter-framework.svg?style=flat-square)](https://packagist.org/packages/nguyenanhung/codeigniter-framework)

[![Daily Downloads](https://img.shields.io/packagist/dd/nguyenanhung/codeigniter-framework.svg?style=flat-square)](https://packagist.org/packages/nguyenanhung/codeigniter-framework)

[![Monthly Downloads](https://img.shields.io/packagist/dm/nguyenanhung/codeigniter-framework.svg?style=flat-square)](https://packagist.org/packages/nguyenanhung/codeigniter-framework)

[![License](https://img.shields.io/packagist/l/nguyenanhung/codeigniter-framework.svg?style=flat-square)](https://packagist.org/packages/nguyenanhung/codeigniter-framework)

[![PHP Version Require](https://img.shields.io/packagist/dependency-v/nguyenanhung/codeigniter-framework/php)](https://packagist.org/packages/nguyenanhung/codeigniter-framework)

Bản đóng gói lại thư mục system framework của CodeIgniter, sử dụng tương thích với Composer và PHP 7, PHP 8

Kể từ phiên bản `v3.2.0` - framework hoàn toàn tương thích với phiên bản PHP 8.2

Bản đóng gói này được liên tục cập nhật với các feature mới từ nhánh CodeIgniter3 nguyên bản. Vì vậy nó luôn được cập

nhật các bản vá lỗi và bổ sung thêm nhiều tính năng mới

Mục lục

-------

- [Tính năng](#bổ-sung-thêm-1-số-thư-viện-mở-rộng-helpers-liên-quan)

- [Hướng dẫn cài đặt](#hướng-dẫn-cài-đặt-gói-vào-trong-dự-án)

- [Hướng dẫn sử dụng](#hướng-dẫn-sử-dụng)

    - [Hướng dẫn viết Controller kế thừa Base Controller](#hướng-dẫn-viết-controller-kế-thừa-base-controller)

    - [Hướng dẫn viết Controller chạy Queue Worker](#hướng-dẫn-viết-controller-chạy-queue-worker)

    - [Hướng dẫn viết Controller chạy RESTful API Service](#hướng-dẫn-viết-controller-chạy-restful-api-service)

    - [Hướng dẫn tích hợp mô hình HMVC (Modular) vào dự án](#hướng-dẫn-tích-hợp-mô-hình-hmvc-vào-dự-án)

    - [Hướng dẫn viết Model kế thừa Base Model](#hướng-dẫn-viết-model-kế-thừa-base-model)

    - [Hướng dẫn viết Model kế thừa Base ORM Model](#hướng-dẫn-viết-model-kế-thừa-base-orm-model)

    - [Hướng dẫn viết tích hợp SEO cơ bản](#hướng-dẫn-tích-hợp-seo-cơ-bản)

    - [Hướng dẫn sử dụng CSDL MongoDB trong dự án](#hướng-dẫn-sử-dụng-csdl-mongodb-trong-dự-án)

    - [Hướng dẫn sử dụng Elasticsearch trong dự án](#hướng-dẫn-sử-dụng-elasticsearch-trong-dự-án)

    - [Hướng dẫn sử dụng kiểm tra các filename trong dự án của bạn đã đúng chuẩn của CodeIgniter hay chưa](#hướng-dẫn-sử-dụng-kiểm-tra-các-filename-trong-dự-án-của-bạn-đã-đúng-chuẩn-của-codeigniter-hay-chưa)

    - [Hướng dẫn sử dụng ghi log tất cả các queries trong CodeIgniter và ghi lại Execution Time của từng Queries](#hướng-dẫn-sử-dụng-ghi-log-tất-cả-các-queries-trong-codeigniter-và-ghi-lại-execution-time-của-từng-queries)

- [CodeIgniter Basic Helper](#codeigniter-basic-helper)

- [Liên hệ & Hỗ trợ](#liên-hệ)

---

## Các tính năng chính

Bổ sung thêm 1 số thư viện mở rộng, helpers liên quan

- [x] Base Controllers với nhiều protected method sẵn có

- [x] Support mô hình HMVC

- [x] Support RESTful Web Service

- [x] Support Queue Worker

- [x] Support CSDL MongoDB

- [x] Support Elasticsearch: Use third party packages `"elasticsearch/elasticsearch": "^8.0 || ^7.0 || ^6.0 || ^5.0"`

- [x] Support class Base Model với 1 số hàm cơ bản đủ dùng với SQL

- [x] Support class ORM Model, cung cấp 1 phương thức đơn giản và dễ dàng hơn để query

- [x] Hỗ trợ Output Response trên giao diện CLI thông qua hàm `ResponseOutput::writeLn($message)`

- [x] Bổ sung class `StatusCodes` khai báo sẵn các HTTP code tuân chuẩn (from Symfony framework),

  VD: `StatusCodes::HTTP_OK`. Chi tiết tham khảo thêm tại class `StatusCodes`

- [x] Bổ sung rất nhiều helper tiện dụng với việc tích hợp sẵn gói `nguyenanhung/codeigniter-basic-helper` thông qua

  Composer

## Hướng dẫn cài đặt gói vào trong dự án

1. Cài đặt gói vào trong dự án với lệnh sau

```shell

composer require nguyenanhung/codeigniter-framework

```

2. Cập nhật file `index.php`

Tìm dòng

```php

/*

 *---------------------------------------------------------------

 * SYSTEM DIRECTORY NAME

 *---------------------------------------------------------------

 *

 * This variable must contain the name of your "system" directory.

 * Set the path if it is not in the same directory as this file.

 */

	$system_path = 'system';

```

Sửa thành như sau

```php

/*

 *---------------------------------------------------------------

 * SYSTEM DIRECTORY NAME

 *---------------------------------------------------------------

 *

 * This variable must contain the name of your "system" directory.

 * Set the path if it is not in the same directory as this file.

 */

	$system_path = '/your_vendor_path/nguyenanhung/codeigniter-framework/system';

```

3. Xoá thư mục `system` trong thư mục gốc dự án đi cho gọn

## Hướng dẫn sử dụng

### Hướng dẫn viết Controller kế thừa Base Controller

Trong thư viện đã xây dựng sẵn 1 Base Controller, kế thừa như sau

1. Xây dựng 1 `Controller` mới theo tài liệu CodeIgniter 3

2. Kế thừa class từ `HungNG_CI_Base_Controllers` thay vì `CI_Controller`, ví dụ như sau

```php

 * @copyright 713uk13m 

 */

class Hungna_test extends HungNG_CI_Base_Controllers

{

	public function __construct()

    {

        parent::__construct();

    }

  	

  	public function index()

    {

		echo "This is ".get_class($this); // show: This is Hungna_test

		exit();

    }

}

```

### Hướng dẫn viết Controller chạy Queue Worker

Trong thư viện đã xây dựng sẵn 1 Base Queue Worker (được xây dựng bởi yidas), kế thừa như sau

1. Xây dựng 1 `Controller` mới theo tài liệu CodeIgniter 3

2. Kế thừa class từ `HungNG_CI_Base_Queue_Worker ` thay vì `CI_Controller`, ví dụ như sau

```php

 * @copyright 713uk13m 

 */

class My_worker extends HungNG_CI_Base_Queue_Worker

{

    // Initializer

    protected function init() {}

    

    // Worker

    protected function handleWork() {}

    

    // Listener

    protected function handleListen() {}

}

```

Tìm hiểu thêm chi tiết tài liệu tại

đây: [https://github.com/nguyenanhung/codeigniter-framework-sample/tree/main/codeigniter-queue-worker](https://github.com/nguyenanhung/codeigniter-framework-sample/tree/main/codeigniter-queue-worker)

### Hướng dẫn viết Controller chạy RESTful API Service

Trong thư viện đã xây dựng sẵn 1 Base RESTful (được xây dựng bởi yidas), kế thừa như sau

1. Xây dựng 1 `Controller` mới theo tài liệu CodeIgniter 3

2. Kế thừa class từ `HungNG_CI_Base_REST ` thay vì `CI_Controller`, ví dụ như sau

```php

 * @copyright 713uk13m 

 */

class My_rest_api extends HungNG_CI_Base_REST

{

    public function index()

    {

        return $this->response->json(['bar'=>'foo']);

    }

    

	public function store($requestData=null) {

	

	    $this->db->insert('mytable', $requestData);

	    $id = $this->db->insert_id();

	    

	    return $this->response->json(['id'=>$id], 201);

	}

}

```

Tìm hiểu thêm chi tiết tài liệu tại

đây: [https://github.com/nguyenanhung/codeigniter-framework-sample/tree/main/codeigniter-rest](https://github.com/nguyenanhung/codeigniter-framework-sample/tree/main/codeigniter-rest)

### Hướng dẫn viết Model kế thừa Base Model

1. Xây dựng 1 model theo tài liệu CodeIgniter 3

2. Kế thừa class từ `HungNG_Custom_Based_model` thay vì `CI_Model`, ví dụ như sau

```php

 * @copyright 713uk13m 

 * @property \CI_DB_query_builder $db

 */

class Credentials_model extends HungNG_Custom_Based_model

{

    const IS_ACTIVE = 1;

    const ROLE_PUSH = 1;

    const ROLE_PULL = 2;

    const ROLE_FULL = 3;

    protected $fieldUsername;

    protected $fieldStatus;

    protected $fieldRole;

    /**

     * Credentials_model constructor.

     *

     * @author   : 713uk13m 

     * @copyright: 713uk13m 

     */

    public function __construct()

    {

        parent::__construct();

        $this->db            = $this->load->database('default', true, true);

        $this->tableName     = 'credentials';

        $this->primary_key   = 'id';

        $this->fieldUsername = 'username';

        $this->fieldStatus   = 'status';

        $this->fieldRole     = 'role';

    }

}

```

### Hướng dẫn viết Model kế thừa Base ORM Model

1. Package này bổ sung thêm 1 phương án viết model hiện đại theo phong cách ORM với Elegant patterns giống như Laravel

   Eloquent ORM & Yii2 Active Record (được xây dựng bởi yidas)

2. Đọc tài liệu chi tiết về cách tích hợp và triển khai tại đây với những ví dụ trực quan và cụ

   thể: [https://github.com/nguyenanhung/codeigniter-framework-sample/tree/main/codeigniter-orm-model](https://github.com/nguyenanhung/codeigniter-framework-sample/tree/main/codeigniter-orm-model)

### Hướng dẫn tích hợp SEO cơ bản

1. Package này bổ sung thêm 1 thư viện và helper SEO đơn giản

2. Đọc tài liệu chi tiết về cách tích hợp và triển khai tại đây với những ví dụ trực quan và cụ

   thể: [https://github.com/nguyenanhung/codeigniter-framework-sample/blob/main/codeigniter3-basic-seo/README.md](https://github.com/nguyenanhung/codeigniter-framework-sample/blob/main/codeigniter3-basic-seo/README.md)

### Hướng dẫn sử dụng CSDL MongoDB trong dự án

1. Mặc định, CodeIgniter v3 không hỗ trợ MongoDB. Tuy nhiên không vì thế mà hạn chế, CodeIgniter là framework mở, vì vậy

   tôi đã bổ sung thêm 1 thư viện hỗ trợ việc gọi, tương tác, xử lý với CSDL MongoDB mà cách sử dụng cũng tương đối

   giống với Query

   Builder của CodeIgniter

2. Đọc tài liệu chi tiết về cách tích hợp và triển khai tại đây với những ví dụ trực quan và cụ

   thể: [https://github.com/nguyenanhung/codeigniter-framework-sample/tree/main/codeigniter-mongodb](https://github.com/nguyenanhung/codeigniter-framework-sample/tree/main/codeigniter-mongodb)

### Hướng dẫn sử dụng Elasticsearch trong dự án

1. Mặc định, CodeIgniter v3 không hỗ trợ Elasticsearch. Tuy nhiên không vì thế mà hạn chế, CodeIgniter là framework mở,

   vì vậy tôi đã bổ sung thêm 1 thư viện hỗ trợ việc gọi, tác với Elasticsearch

2. Đọc tài liệu chi tiết về cách tích hợp và triển khai tại đây với những ví dụ trực quan và cụ

   thể: [https://github.com/nguyenanhung/codeigniter-framework-sample/tree/main/codeigniter-elasticsearch](https://github.com/nguyenanhung/codeigniter-framework-sample/tree/main/codeigniter-elasticsearch)

### Hướng dẫn tích hợp mô hình HMVC vào dự án

1. Create folder: `modules` trong thư mục `application`. Tham khảo cấu trúc thư mục `modules-samples`

   tại https://github.com/nguyenanhung/codeigniter-framework-sample/tree/main/modules-sample

```shell

.

└── modules

    └── startup

        ├── config

        │   ├── index.html

        │   └── routes.php

        ├── controllers

        │   ├── Startup.php

        │   └── index.html

        ├── index.html

        ├── models

        │   ├── Startup_model.php

        │   └── index.html

        └── views

            └── index.html

6 directories, 8 files

```

2. Create file `hmvc.php` với nội dung như sau

```php

 '../modules/'

);

```

3. Nạp file `hmvc.php` vào file `config.php`

```php

require_once __DIR__ . '/hmvc.php';

```

4. Create file `MY_Loader.php` trong thư mục `application/core/` có nội dung như sau

```php

 * @copyright 713uk13m 

 */

class MY_Loader extends HungNG_Loader

{

}

```

5. Create file `MY_Router.php` trong thư mục `application/core/` có nội dung như sau

```php

 * @copyright 713uk13m 

 */

class MY_Router extends HungNG_Router

{

}

```

6. Triển khai viết code trong thư mục modules mới, tương tự như sau

```php

 * @copyright 713uk13m 

 */

class TestModule extends HungNG_CI_Base_Module

{

	public function __construct()

    {

        parent::__construct();

    }

  	

	public function index()

    {

		echo "This is ".get_class($this); // show: This is TestModule

		exit();

    }

}

```

### Hướng dẫn sử dụng kiểm tra các filename trong dự án của bạn đã đúng chuẩn của CodeIgniter hay chưa

1. This controller checks CodeIgniter 3.0 class filename.

2. Đọc tài liệu chi tiết về cách tích hợp và triển khai tại đây với những ví dụ trực quan và cụ

   thể: [https://github.com/nguyenanhung/codeigniter-framework-sample/tree/main/codeigniter3-filename-checker](https://github.com/nguyenanhung/codeigniter-framework-sample/tree/main/codeigniter3-filename-checker)

### Hướng dẫn sử dụng ghi log tất cả các queries trong CodeIgniter và ghi lại Execution Time của từng Queries

1. Mặc định, CodeIgniter v3 không hỗ trợ ghi log Execution Time của các Queries. Tuy nhiên, có thể sử dụng Hooks để thực

   hiện điều này

2. Đọc tài liệu chi tiết về cách tích hợp và triển khai tại đây với những ví dụ trực quan và cụ

   thể: [https://github.com/nguyenanhung/codeigniter-framework-sample/tree/main/codeigniter-log-all-queries](https://github.com/nguyenanhung/codeigniter-framework-sample/tree/main/codeigniter-log-all-queries)

## CodeIgniter Basic Helper

- Trong nhiều năm làm lập trình với CodeIgniter, tôi đã sưu tập, xây dựng và viết được kha khá helper, tôi đã đóng gói

  chúng lại thành gói `nguyenanhung/codeigniter-basic-helper` và tích hợp vào bên trong gói này.

- Gói helper này vẫn đang được tôi vận hành và phát triển hàng ngày, số project tích hợp các hàm trong gói này đã lên

  con số hàng nghìn

- Thông tin chi tiết hơn về bộ helper

  này [https://github.com/nguyenanhung/codeigniter-basic-helper](https://github.com/nguyenanhung/codeigniter-basic-helper)

## Liên hệ

| Name        | Email                | Skype            | Facebook      | Website                  |

|-------------|----------------------|------------------|---------------|--------------------------|

| Hung Nguyen | [email protected] | nguyenanhung5891 | @nguyenanhung | https://nguyenanhung.com |