รู้จักกับ Model และวิธีการใช้งาน Model ใน CodeIgniter 4

--
-- Table structure for table `users`
--

CREATE TABLE `users` (
  `id` int(11) NOT NULL,
  `name` varchar(100) NOT NULL,
  `email` varchar(100) NOT NULL,
  `createdate` datetime NOT NULL DEFAULT current_timestamp()
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
ALTER TABLE `users`
  ADD PRIMARY KEY (`id`);
ALTER TABLE `users`
  MODIFY `id` int(11) NOT NULL AUTO_INCREMENT;
COMMIT;

<?php namespace App\Controllers; 
use CodeIgniter\Controller; // เรียกใช้งาน Controller class
class Users extends Controller 
{
    public function index() 
    {	

    }
}

<?php namespace App\Models; // กำหนด namespace
use CodeIgniter\Model; // เรียกใช้งาน Model class
class UsersModel extends Model 
{
	
}

<?php namespace App\Controllers; 
use CodeIgniter\Controller; // เรียกใช้งาน Controller class
class Users extends Controller 
{
    public function index() 
    {	
		// เรียกใช้งานแบบ สร้าง instance ใหม่ แบบกำหนดเอง
		$userModel = new \App\Models\UsersModel();

		// เรียกใช้งานแบบ สร้าง instance ใหม่ โดยใช้ฟังก์ชั่น model() 
		$userModel = model('App\Models\UsersModel', false);

		// เรียกใช้งานแบบ shared instance โดยใช้ฟังก์ชั่น model() 
		$userModel = model('App\Models\UsersModel');		

    }
}

<?php namespace App\Controllers; 
use App\Models\UsersModel; // เรียกใช้งาน Model class
use CodeIgniter\Controller; // เรียกใช้งาน Controller class
class Users extends Controller 
{
    public function index() 
    {	
		// เรียกใช้งานแบบ สร้าง instance ใหม่ แบบกำหนดเอง
		$userModel = new UsersModel();

		// เรียกใช้งานแบบ สร้าง instance ใหม่ โดยใช้ฟังก์ชั่น model() 
		$userModel = model('UsersModel', false);

		// เรียกใช้งานแบบ shared instance โดยใช้ฟังก์ชั่น model() 
		$userModel = model('UsersModel');		

    }
}

public function index() 
{	
	// เรียกใช้งานแบบ shared instance ของ model
	$db = db_connect('custom');
	$userModel = model('UsersModel' , true, $db);		

}

<?php namespace App\Models; // กำหนด namespace
use CodeIgniter\Model; // เรียกใช้งาน Model class
class UsersModel extends Model // สร้าง Model class โดยสืบทอดจาก Model
{
	protected $_table = 'users';
	public function getUsers(){
		$builder = $this->db->table($this->_table);
		$query = $builder->get();
		return $query->getResultArray();
	}
	public function view($id){
		$builder = $this->db->table($this->_table);
		$query = $builder->getWhere(['id' => $id]);	
		return $query->getRowArray();	
	}
	public function add($data){
		$builder = $this->db->table($this->_table);
		return $builder->insert($data);
	}
	public function edit($data, $id){
		$builder = $this->db->table($this->_table);	
		return $builder->update($data, ['id' => $id]);	
	}
	public function del($id){
		$builder = $this->db->table($this->_table);
		return $builder->delete(['id' => $id]); 
	}
}

<?php namespace App\Controllers; 
use App\Models\UsersModel; // เรียกใช้งาน Model class
use CodeIgniter\Controller; // เรียกใช้งาน Controller class
class Users extends Controller 
{
	protected $userModel;
	public function __construct(){
		$this->userModel = model('UsersModel');		
	}
    public function index() 
    {	
		$result = $this->userModel->getUsers();
		echo "<pre>";
		print_r($result);
    }
	public function view($id){
		$row = $this->userModel->view($id);
		echo "<pre>";
		print_r($row);	
	}
	public function create(){
		$data = [
			'name' => 'test name '.time(),
			'email' => 'test email '.time(),
		];
		if($this->userModel->add($data)){
			echo "Created!";
		}
	}
	public function edit($id){
		$data = [
			'name' => 'edit test name '.time(),
			'email' => 'edit test email '.time(),
		];
		if($this->userModel->edit($data, $id)){
			echo "Updated!";			
		}
	}
	public function delete($id){
		if($this->userModel->del($id)){
			echo "Deleted!";
		}
	}
}

// แสดงรายการทั้งหมด
https://www.mysslweb.com/users
// จำลองการเพิ่มรายการข้อมูลใหม่จากตัวแปร
https://www.mysslweb.com/users/create
// แสดงรายการเฉพาะ id ที่ต้องการ
https://www.mysslweb.com/users/view/1
// แก้ไขรายการ id ที่ต้องการ
https://www.mysslweb.com/users/edit/1
// ลบรายการ id ที่ต้องการ
https://www.mysslweb.com/users/delete/1

<?php namespace App\Models;

use CodeIgniter\Model;

class UsersModel extends Model
{
    protected $DBGroup = 'group_name';
}

<?php namespace App\Controllers; 
use App\Models\UsersModel; // เรียกใช้งาน Model class
use CodeIgniter\Controller; // เรียกใช้งาน Controller class
class Users extends Controller 
{
    public function index() 
    {	
		$db = db_connect('group_name'); // เพิ่มติม http://niik.in/1001
		$userModel = model('UsersModel' , true, $db);		

    }
}

<?php namespace App\Models; // กำหนด namespace
use CodeIgniter\Model; // เรียกใช้งาน Model class
class UsersModel extends Model // สร้าง Model class โดยสืบทอดจาก Model
{
	protected $table = 'users';
	protected $primaryKey = 'id';

    protected $allowedFields = ['name', 'email','createdate'];

    public function getUsers($id = false)
    {
        if ($id === false) 
        {
             return $this->findAll();
        }
        return $this->asArray()
                    ->where(['id' => $id])
                    ->first();
    }

}

<?php namespace App\Controllers; 
use App\Models\UsersModel; // เรียกใช้งาน Model class
use CodeIgniter\Controller; // เรียกใช้งาน Controller class
class Users extends Controller 
{
	protected $userModel;
	public function __construct(){
		$this->userModel = model('UsersModel');		
	}
	// method สำหรับแสดงข้อมูลทั้งหมด
    public function index() 
    {	
		$result = $this->userModel->getUsers();
		echo "<pre>";
		print_r($result);
    }
    // method สำหรับแสดงข้อมูล เฉพาะรายการ
    public function view($id = NULL)
    {
		if(!empty($id)){
			$row = $this->userModel->getUsers($id);
			echo "<pre>";
			print_r($row);
		}
    }	
	// create method สำหรับเพิ่มข้อมูลใหม่
	public function create(){
		$data = [
			'name' => 'test name '.time(),
			'email' => 'test email '.time(),
		];
		$this->userModel->insert($data); 
		echo "Created!";	
	}
	// edit method สำหรับแก้ไขข้อมูล
	public function edit($id){
		$data = [
			'name' => 'edit test name '.time(),
			'email' => 'edit test email '.time(),
		];
        if(!empty($id)){
            $this->userModel->update($id, $data); 
			echo "Updated!";
        }   		
	}

    // delete method สำหรับลบข้อมูล
    public function delete($id){
        if(!empty($id)){
            $this->userModel->delete($id); // ลบข้อมูลจากค่า id ที่เป็น primary key
			echo "Deleted!";
        }   
    }	
}

<?php namespace App\Models;

use CodeIgniter\Model;

class UserModel extends Model
{
    protected $table      = 'users';
    protected $primaryKey = 'id';

    protected $returnType     = 'array';

    protected $allowedFields = ['name', 'email'];

    protected $useSoftDeletes = true;
    protected $dateFormat = 'datetime'; // datetime, date, int
    protected $useTimestamps = false;
    protected $createdField  = 'created_at';
    protected $updatedField  = 'updated_at';
    protected $deletedField  = 'deleted_at';

    protected $validationRules    = [];
    protected $validationMessages = [];
    protected $skipValidation     = false;
}

protected $returnType     = 'array'; // array or object or custom class
protected $allowedFields = ['name', 'email','createdate'];

public function getUsers($id = false)
{
	if ($id === false) 
	{
		 return $this->findAll();
	}
	return $this->where(['id' => $id])
				->first();
}

    protected $useSoftDeletes = true;
    protected $dateFormat = 'datetime'; // datetime, date, int
    protected $useTimestamps = false;
    protected $createdField  = 'created_at';
    protected $updatedField  = 'updated_at';
    protected $deletedField  = 'deleted_at';

<?php namespace App\Models; // กำหนด namespace
use CodeIgniter\Model; // เรียกใช้งาน Model class
class UsersModel extends Model // สร้าง Model class โดยสืบทอดจาก Model
{
	protected $table = 'users';
	protected $primaryKey = 'id';

	protected $returnType     = 'array'; // array or object or custom class
	
    protected $allowedFields = ['name', 'email','createdate'];
	
	protected $useTimestamps = true;
	protected $dateFormat = 'datetime'; // datetime or date or int // ค่า defalut เป็น datetime
    protected $createdField  = 'created_at';
    protected $updatedField  = 'updated_at';

    public function getUsers($id = false)
    {
        if ($id === false) 
        {
             return $this->findAll();
        }
        return $this->where(['id' => $id])
                    ->first();
    }

}

// กำหนดการจัดการส่วนของการ insert() และ update()
protected $useTimestamps = true;
protected $dateFormat = 'datetime'; // datetime, date, int
protected $createdField  = 'created_at';
protected $updatedField  = 'updated_at';
// กำหนดการจัดการส่วนของการ delete() 
protected $useSoftDeletes = true;
protected $deletedField  = 'deleted_at';

$this->find(1); // แบบแสดงค่าเดียว

$this->find([1,2,3]); // แบบแสดงหลายค่า

$this->find(); // ถ้าไม่กำหนด parameter ก็จะแสดงทั้งหมด เหมือนคำสั่ง findAll()

$this->userModel->find(1);

$this->userModel->find([1,2,3]);

$this->userModel->find();

findColumn($column_name); // findColumn('id');

public function test(){
	$user = $this->userModel->findColumn('id');
	echo "<pre>";
	print_r($user);
	// output
/*	Array
	(
		[0] => 1
		[1] => 2
		[2] => 4
		[3] => 5
		[4] => 6
		[5] => 7
	)*/
	
}

public function getUsers($id = false)
{
	if ($id === false) 
	{
		 return $this->findAll();
	}
	return $this->where(['id' => $id])
				->first();
}

$this->where('active', 1)
		->findAll();

$this->findAll(10,20); // แสดงทีละ 10 รายการ โดยเริ่มแถวที่ 21

$this->where('deleted', 0)->first();

$this->findAll(); // แสดงรายการทั้งหมด ไม่รวมที่ถูกลบชั่วคราว

$this->withDeleted()->findAll(); // แสดงรายการทั้งหมด รวมที่ถูกลบชั่วคราวด้วย

$this->onlyDeleted()->findAll(); // แสดงเฉพาะรายการที่ถูกลบชั่วคราว

$data = [
	'name' => 'test name '.time(),
	'email' => 'test email '.time(),
];
$this->userModel->insert($data); 

$data = [
	'name' => 'edit test name '.time(),
	'email' => 'edit test email '.time(),
];
$this->userModel->update($id, $data); 

$data = [
    'active' => 1
];
$this->userModel->update([1, 2, 3], $data);

$this->userModel
    ->whereIn('id', [1,2,3])
    ->set(['active' => 1])
    ->update();
// อัพเดท id เท่ากับ 1,2 และ 3 กำหนดค่า active เป็น 1

// กำหนด property ของ model
$primaryKey = 'id';

// insert()
$data = [
    'username' => 'darth',
    'email'    => 'd.vader@theempire.com'
];

$this->save($data);

//  update() , เมื่อกำหนด primary key, 'id' 
$data = [
    'id'       => 3,
    'username' => 'darth',
    'email'    => 'd.vader@theempire.com'
];
$this->save($data);

$this->delete(1);

$this->delete(1, true); // กรณี $useSoftDeletes เป็น true และต้องการลบแบบถาวร

$this->delete([1,2,3]);

$this->where('id', 12)->delete();

$this->purgeDeleted();

class UsersModel extends Model
{
    protected $validationRules    = [
        'username'     => 'required|alpha_numeric_space|min_length[3]',
        'email'        => 'required|valid_email|is_unique[users.email]',
        'password'     => 'required|min_length[8]',
        'pass_confirm' => 'required_with[password]|matches[password]'
    ];

    protected $validationMessages = [
        'email'        => [
            'required' => 'Sorry. That email is Required.',
            'is_unique' => 'Sorry. That email has already been taken. Please choose another.'
        ]
    ];
}

class UsersModel extends Model
{
    protected $validationRules = 'users';
}

if ($this->userModel->save($data) === false)
{
    return view('updateUser', ['errors' => $this->userModel->errors()]);
}

<?php if (! empty($errors)) : ?>
    <div class="alert alert-danger">
    <?php foreach ($errors as $field => $error) : ?>
        <p><?= $error ?></p>
    <?php endforeach ?>
    </div>
<?php endif ?>

$fieldName = 'username';
$fieldRules = 'required|alpha_numeric_space|min_length[3]';

$this->userModel->setValidationRule($fieldName, $fieldRules);
if ($this->userModel->save($data) === false)
{
    return view('updateUser', ['errors' => $this->userModel->errors()]);
}

$validationRules = [
    'username' => 'required|alpha_numeric_space|min_length[3]',
    'email' => [
        'rules'  => 'required|valid_email|is_unique[users.email]',
        'errors' => [
            'required' => 'We really need your email.',
        ],
    ],
];
$this->userModel->setValidationRules($validationRules);
if ($this->userModel->save($data) === false)
{
    return view('updateUser', ['errors' => $this->userModel->errors()]);
}

$fieldName = 'name';
$fieldValidationMessage = [
    'required' => 'Your name is required here',
];
$this->userModel->setValidationMessage($fieldName, $fieldValidationMessage);

$fieldValidationMessage = [
    'name' => [
        'required'   => 'Your baby name is missing.',
        'min_length' => 'Too short, man!',
    ],
];
$this->userModel->setValidationMessages($fieldValidationMessage);

$rules = $this->userModel->validationRules; 
// จะได้ค่า validation rules ทั้งหมด ที่กำหนดใน model มาใช้

// กรณีเอาทั้งหมด ยกเว้น ฟิลด์ "username"
$rules = $this->userModel->getValidationRules(['except' => ['username']]);

// กรณีเอาเฉพาะฟิลด์ "city" และ "state" 
$rules = $this->userModel->getValidationRules(['only' => ['city', 'state']]);

$rules = $model->getValidationRules(['except' => ['username']]);
$this->userModel->setValidationRules($rules);

protected $validationRules = [
    'email' => 'required|valid_email|is_unique[users.email,id,{id}]'
];

$_POST = [
    'id' => 4,
    'email' => 'foo@example.com'
];

protected $validationRules = [
    'email' => 'required|valid_email|is_unique[users.email,id,4]'
];

protected $allowedFields = ['name', 'email', 'address'];

$this->userModel->protect(false)
      ->insert($data)
      ->protect(true);

$builder = $this->userModel->builder();

$users = $this->userModel->where('status', 'active')
                   ->orderBy('last_login', 'asc')
                   ->findAll();

$user_name = $userModel->escape($name);

$users = $this->userModel->asArray()->where('status', 'active')->findAll();

// แบบ standard objects
$users = $this->userModel->asObject()->where('status', 'active')->findAll();

// แบบ custom class instances
$users = $this->userModel->asObject('User')->where('status', 'active')->findAll();

$this->userModel->chunk(100, function ($data)
{
    // do something.
    // $data ข้อมูลของรายการแต่ละแถว
});

protected function hashPassword(array $data)
{
    if (! isset($data['data']['password']) return $data;

    $data['data']['password_hash'] = password_hash($data['data']['password'], PASSWORD_DEFAULT);
    unset($data['data']['password'];

    return $data;
}

protected $beforeInsert = ['hashPassword'];
protected $beforeUpdate = ['hashPassword'];

protected $beforeInsert = ['hashPassword','formatTel'];

protected $allowCallbacks = false;

$this->userModel->allowCallbacks(false)->find(1); 
// หากมีการกำหนดคำสั่้งในส่วนของ $afterFind คำสั่งนั้นจะไม่ทำงานชื่อคราว 
// เพราะเราปิดการเรียกใช้ชั่วคราวผ่านคำสั่ง allowCallbacks(false)

$this->userModel->find(1);                       
// คำสั่้งในส่วนของ $afterFind ถ้ามีการกำหนดค่าไว้

    beforeInsert

    afterInsert

    beforeUpdate

    afterUpdate

    afterFind

    beforeDelete

    afterDelete

<?php namespace App\Models;
use CodeIgniter\Database\ConnectionInterface;
class UsersModel
{
    protected $db;
    public function __construct(ConnectionInterface &$db)
    {
        $this->db =& $db;
    }
}

<?php namespace App\Controllers; 
use App\Models\UsersModel; 
use CodeIgniter\Controller; // เรียกใช้งาน Controller class
 
class Users extends Controller 
{
    public function index() 
    {   
             $db = db_connect(); 
             $userModel = model('UsersModel', true, $db);
    }
}