CodeIgniter 모델 사용하기

모델

CodeIgniter의 모델은 데이터베이스의 단일 테이블과 작업하기 편리하도록 사람들이 일반적으로 사용하는 편의 기능과 추가 기능을 제공합니다.

레코드 조회, 레코드 업데이트, 레코드 삭제 등 데이터베이스 테이블과 상호작용하는 데 필요한 표준적인 방법들을 위한 헬퍼 메소드를 기본으로 제공합니다.

모델 접근하기

모델은 일반적으로 app/Models 디렉터리에 저장됩니다. 디렉터리 내 위치와 일치하는 네임스페이스를 가져야 하며, 예를 들어 namespace App\Models와 같이 설정합니다.

클래스 내에서 새 인스턴스를 생성하거나 model() 헬퍼 함수를 사용하여 모델에 접근할 수 있습니다.

<?php

// Create a new class manually.
$userModel = new \App\Models\UserModel();

// Create a shared instance of the model.
$userModel = model('UserModel');
// or
$userModel = model('App\Models\UserModel');
// or
$userModel = model(\App\Models\UserModel::class);

// Create a new class with the model() function.
$userModel = model('UserModel', false);

// Create shared instance with a supplied database connection.
$db        = db_connect('custom');
$userModel = model('UserModel', true, $db);

model()은 내부적으로 Factories::models()를 사용합니다. 첫 번째 매개변수에 대한 자세한 내용은 클래스 로딩를 참조하세요.

CodeIgniter 모델

CodeIgniter는 다음과 같은 몇 가지 유용한 기능을 갖춘 모델 클래스를 제공합니다:

• 자동 데이터베이스 연결

• 기본 CRUD 메소드

• 모델 내 유효성 검사

• 자동 페이지네이션

• 그 외 더 많은 기능

이 클래스는 자신만의 모델을 구축하기 위한 견고한 기반을 제공하여 애플리케이션의 모델 레이어를 빠르게 구축할 수 있게 해줍니다.

모델 생성하기

CodeIgniter의 모델을 활용하려면 CodeIgniter\Model을 상속하는 새 모델 클래스를 간단히 생성하면 됩니다:

<?php

namespace App\Models;

use CodeIgniter\Model;

class UserModel extends Model
{
    // ...
}

이 빈 클래스는 데이터베이스 연결, 쿼리 빌더, 그리고 다양한 편의 메소드에 손쉽게 접근할 수 있게 해줍니다.

initialize()

모델에 추가 설정이 필요한 경우 initialize() 메소드를 확장할 수 있으며, 이 메소드는 모델의 생성자 직후에 실행됩니다. 이를 통해 생성자 매개변수를 반복하지 않고도 추가 작업(예: 다른 모델 확장)을 수행할 수 있습니다:

<?php

namespace App\Models;

use Modules\Authentication\Models\UserAuthModel;

class UserModel extends UserAuthModel
{
    // ...

    /**
     * Called during initialization. Appends
     * our custom field to the module's model.
     */
    protected function initialize()
    {
        $this->allowedFields[] = 'middlename';
    }
}

데이터베이스 연결하기

클래스가 처음 인스턴스화될 때 생성자에 데이터베이스 연결 인스턴스가 전달되지 않고 모델 클래스에 $DBGroup 속성을 설정하지 않은 경우, 데이터베이스 설정에 지정된 기본 데이터베이스 그룹에 자동으로 연결됩니다.

클래스에 $DBGroup 속성을 추가하여 모델별로 사용할 그룹을 수정할 수 있습니다. 이렇게 하면 모델 내의 $this->db 참조가 적절한 연결을 통해 이루어집니다.

<?php

namespace App\Models;

use CodeIgniter\Model;

class UserModel extends Model
{
    protected $DBGroup = 'group_name';

    // ...
}

“group_name”을 데이터베이스 설정 파일에 정의된 데이터베이스 그룹 이름으로 대체하면 됩니다.

모델 구성하기

모델 클래스에는 클래스의 메소드가 원활하게 동작할 수 있도록 설정할 수 있는 몇 가지 구성 옵션이 있습니다. 처음 두 가지는 모든 CRUD 메소드에서 사용할 테이블과 필요한 레코드를 찾는 방법을 결정하는 데 사용됩니다:

<?php

namespace App\Models;

use CodeIgniter\Model;

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

    protected $useAutoIncrement = true;

    protected $returnType     = 'array';
    protected $useSoftDeletes = true;

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

    protected bool $allowEmptyInserts = false;
    protected bool $updateOnlyChanged = true;

    // Dates
    protected $useTimestamps = false;
    protected $dateFormat    = 'datetime';
    protected $createdField  = 'created_at';
    protected $updatedField  = 'updated_at';
    protected $deletedField  = 'deleted_at';

    // Validation
    protected $validationRules      = [];
    protected $validationMessages   = [];
    protected $skipValidation       = false;
    protected $cleanValidationRules = true;

    // Callbacks
    protected $allowCallbacks = true;
    protected $beforeInsert   = [];
    protected $afterInsert    = [];
    protected $beforeUpdate   = [];
    protected $afterUpdate    = [];
    protected $beforeFind     = [];
    protected $afterFind      = [];
    protected $beforeDelete   = [];
    protected $afterDelete    = [];
}

$table

이 모델이 주로 사용하는 데이터베이스 테이블을 지정합니다. 이는 내장 CRUD 메소드에만 적용됩니다. 자체 쿼리에서 이 테이블만 사용하도록 제한되지는 않습니다.

$primaryKey

이 테이블의 레코드를 고유하게 식별하는 컬럼의 이름입니다. 데이터베이스에 지정된 기본 키와 반드시 일치할 필요는 없지만, find()와 같은 메소드에서 지정된 값과 어떤 컬럼을 매칭할지 알기 위해 사용됩니다.

참고

모든 모델은 모든 기능이 예상대로 동작하도록 primaryKey가 지정되어야 합니다.

$useAutoIncrement

$primaryKey에 대해 테이블이 자동 증가 기능을 사용하는지 지정합니다. false로 설정하면 테이블의 모든 레코드에 기본 키 값을 직접 제공해야 합니다. 이 기능은 1:1 관계를 구현하거나 모델에 UUID를 사용하려는 경우 유용할 수 있습니다. 기본값은 true입니다.

참고

$useAutoIncrement를 false로 설정하는 경우, 데이터베이스의 기본 키를 unique로 설정해야 합니다. 이렇게 하면 모델의 모든 기능이 이전과 동일하게 동작함을 보장할 수 있습니다.

$returnType

모델의 find*() 메소드는 Result 객체 대신 결과 데이터를 자동으로 반환하여 작업 단계를 줄여줍니다.

이 설정은 반환되는 데이터의 타입을 정의할 수 있게 해줍니다. 유효한 값은 ‘array’(기본값), ‘object’, 또는 Result 객체의 getCustomResultObject() 메소드와 함께 사용할 수 있는 완전한 클래스 이름입니다.

클래스의 특수 ::class 상수를 사용하면 대부분의 IDE에서 이름을 자동완성하고 리팩토링과 같은 기능이 코드를 더 잘 이해할 수 있게 됩니다.

$useSoftDeletes

true이면 delete() 메소드 호출 시 실제로 행을 삭제하는 대신 데이터베이스에 deleted_at을 설정합니다. 이는 다른 곳에서 참조될 수 있는 데이터를 보존하거나, 복원 가능한 객체의 “휴지통”을 유지하거나, 보안 추적의 일부로 단순히 보존하는 데 사용할 수 있습니다. true이면 find*() 메소드를 호출하기 전에 withDeleted() 메소드를 먼저 호출하지 않는 한 find*() 메소드는 삭제되지 않은 행만 반환합니다.

이는 모델의 $dateFormat 설정에 따라 데이터베이스에 DATETIME 또는 INTEGER 필드가 필요합니다. 기본 필드 이름은 deleted_at이지만 $deletedField 속성을 사용하여 원하는 이름으로 구성할 수 있습니다.

중요

데이터베이스의 deleted_at 필드는 nullable이어야 합니다.

$allowedFields

이 배열은 save(), insert(), update() 메소드 실행 중 설정할 수 있는 필드 이름으로 업데이트해야 합니다. 여기에 포함되지 않은 필드 이름은 삭제됩니다. 이는 폼 입력을 그대로 모델에 전달하여 발생할 수 있는 대량 할당 취약점을 방지하는 데 도움이 됩니다.

참고

$primaryKey 필드는 절대로 허용 필드가 되어서는 안 됩니다.

$allowEmptyInserts

Added in version 4.3.0.

빈 데이터 삽입을 허용할지 여부입니다. 기본값은 false이며, 빈 데이터를 삽입하려고 하면 “There is no data to insert.” 메시지와 함께 DataException이 발생합니다.

allowEmptyInserts() 메소드로도 이 설정을 변경할 수 있습니다.

$updateOnlyChanged

Added in version 4.5.0.

엔티티의 변경된 필드만 업데이트할지 여부입니다. 기본값은 true이며, 데이터베이스 업데이트 시 변경된 필드 데이터만 사용됩니다. 따라서 변경 사항 없이 엔티티를 업데이트하려고 하면 “There is no data to update.” 메시지와 함께 DataException이 발생합니다.

이 속성을 false로 설정하면 엔티티의 모든 허용 필드가 언제든지 데이터베이스에 제출되고 업데이트됩니다.

$casts

Added in version 4.5.0.

데이터베이스에서 조회한 데이터를 적절한 PHP 타입으로 변환할 수 있게 해줍니다. 이 옵션은 키가 필드 이름이고 값이 데이터 타입인 배열이어야 합니다. 자세한 내용은 모델 필드 캐스팅을 참조하세요.

날짜

$useTimestamps

이 불리언 값은 현재 날짜가 모든 삽입 및 업데이트에 자동으로 추가될지 여부를 결정합니다. true이면 $dateFormat에 지정된 형식으로 현재 시간을 설정합니다. 이는 테이블에 적절한 데이터 타입의 created_at, updated_at, deleted_at 컬럼이 있어야 합니다. $createdField, $updatedField, $deletedField도 참조하세요.

$dateFormat

이 값은 $useTimestamps및 $useSoftDeletes와 함께 작동하여 올바른 유형의 날짜 값이 데이터베이스에 삽입되도록 합니다. 기본적으로 DATETIME 값을 생성하지만 유효한 옵션은 'datetime', 'date', 'int'(UNIX 타임스탬프)입니다. 잘못되거나 누락된 $dateFormat과 함께 $useSoftDeletes또는 $useTimestamps를 사용하면 예외가 발생합니다.

$createdField

데이터 레코드 생성 타임스탬프에 사용할 데이터베이스 필드를 지정합니다. 빈 문자열('')로 설정하면 업데이트를 방지합니다($useTimestamps가 활성화된 경우에도).

$updatedField

데이터 레코드 업데이트 타임스탬프를 유지하는 데 사용할 데이터베이스 필드를 지정합니다. 빈 문자열('')로 설정하면 업데이트를 방지합니다($useTimestamps가 활성화된 경우에도).

$deletedField

소프트 삭제에 사용할 데이터베이스 필드를 지정합니다. $useSoftDeletes를 참조하세요.

유효성 검사

$validationRules

규칙 저장 방법에 설명된 유효성 검사 규칙 배열 또는 같은 섹션에 설명된 유효성 검사 그룹 이름을 포함하는 문자열을 담고 있습니다. 유효성 검사 규칙 설정하기도 참조하세요.

$validationMessages

사용자 정의 오류 메시지 설정에 설명된 유효성 검사 시 사용할 사용자 정의 오류 메시지 배열을 담고 있습니다. 유효성 검사 규칙 설정하기도 참조하세요.

$skipValidation

모든 삽입 및 업데이트 중 유효성 검사를 건너뛸지 여부입니다. 기본값은 false이며, 데이터는 항상 유효성 검사를 시도합니다. 이는 주로 skipValidation() 메소드에서 사용되지만, true로 변경하면 이 모델은 절대 유효성 검사를 수행하지 않습니다.

$cleanValidationRules

전달된 데이터에 존재하지 않는 유효성 검사 규칙을 제거할지 여부입니다. 이는 업데이트 시 사용됩니다. 기본값은 true이며, 전달된 데이터에 없는 필드의 유효성 검사 규칙은 유효성 검사 전에 (일시적으로) 제거됩니다. 이는 일부 필드만 업데이트할 때 유효성 검사 오류를 방지하기 위한 것입니다.

cleanRules() 메소드로도 값을 변경할 수 있습니다.

참고

v4.2.7 이전에는 버그로 인해 $cleanValidationRules가 작동하지 않았습니다.

콜백

$allowCallbacks

아래에 정의된 콜백을 사용할지 여부입니다. 모델 이벤트를 참조하세요.

$beforeInsert

$afterInsert

$beforeUpdate

$afterUpdate

$beforeFind

$afterFind

$beforeDelete

$afterDelete

$beforeInsertBatch

$afterInsertBatch

$beforeUpdateBatch

$afterUpdateBatch

이 배열들을 사용하면 속성 이름에 지정된 시점에 데이터에 실행될 콜백 메소드를 지정할 수 있습니다. 모델 이벤트를 참조하세요.

모델 필드 캐스팅

Added in version 4.5.0.

데이터베이스에서 데이터를 조회할 때 정수형 데이터가 PHP에서 문자열 타입으로 변환될 수 있습니다. 또한 날짜/시간 데이터를 PHP의 Time 객체로 변환하고 싶을 수도 있습니다.

모델 필드 캐스팅을 사용하면 데이터베이스에서 조회한 데이터를 적절한 PHP 타입으로 변환할 수 있습니다.

중요

엔티티와 함께 이 기능을 사용하는 경우, 엔티티 속성 캐스팅을 사용하지 마세요. 두 캐스팅을 동시에 사용하면 작동하지 않습니다.

엔티티 속성 캐스팅은 (1)(4)에서 작동하지만, 이 캐스팅은 (2)(3)에서 작동합니다:

[App Code] --- (1) --> [Entity] --- (2) --> [Database]
[App Code] <-- (4) --- [Entity] <-- (3) --- [Database]

이 캐스팅을 사용하면 엔티티의 속성에 올바른 타입의 PHP 값이 저장됩니다. 이 동작은 이전 동작과 완전히 다릅니다. 속성이 데이터베이스의 원시 데이터를 보유할 것으로 기대하지 마세요.

데이터 타입 정의하기

$casts 속성으로 정의를 설정합니다. 이 옵션은 키가 필드 이름이고 값이 데이터 타입인 배열이어야 합니다:

<?php

namespace App\Models;

use CodeIgniter\Model;

class UserModel extends Model
{
    // ...
    protected array $casts = [
        'id'        => 'int',
        'birthdate' => '?datetime',
        'hobbies'   => 'json-array',
        'active'    => 'int-bool',
    ];
    // ...
}

데이터 타입

다음 타입들이 기본으로 제공됩니다. 타입 앞에 물음표를 붙여 필드를 nullable로 표시할 수 있습니다. 예: ?int, ?datetime.

타입	PHP 값 타입	DB 컬럼 타입
int	int	int 타입
float	float	float (숫자) 타입
bool	bool	bool/int/string 타입
int-bool	bool	int 타입 (1 또는 0)
array	array	string 타입 (직렬화)
csv	array	string 타입 (CSV)
json	stdClass	json/string 타입
json-array	array	json/string 타입
datetime	Time	datetime 타입
timestamp	Time	int 타입 (UNIX 타임스탬프)
uri	URI	string 타입
enum	Enum	string/int 타입

csv

csv로 캐스팅하면 PHP의 내장 implode()와 explode() 함수를 사용하며 모든 값이 문자열에 안전하고 쉼표가 없다고 가정합니다. 더 복잡한 데이터 캐스팅에는 array 또는 json을 사용해 보세요.

datetime

밀리초가 포함된 날짜/시간에는 datetime[ms], 마이크로초가 포함된 날짜/시간에는 datetime[us]와 같이 매개변수를 전달할 수 있습니다.

datetime 형식은 app/Config/Database.php 파일의 데이터베이스 설정에 있는 dateFormat 배열에서 설정됩니다.

참고

ms 또는 us를 매개변수로 설정하면 모델은 Time의 초 소수 부분을 처리합니다. 하지만 쿼리 빌더는 처리하지 않습니다. 따라서 where()와 같은 쿼리 빌더 메소드에 Time을 전달할 때는 여전히 format() 메소드를 사용해야 합니다:

$model = model('SomeModel');

$now = \CodeIgniter\I18n\Time::now();

// The following code passes the microseconds to Query Builder.
$model->where('my_dt_field', $now->format('Y-m-d H:i:s.u'))->findAll();
// Generates: SELECT * FROM `my_table` WHERE `my_dt_field` = '2024-07-28 18:57:58.900326'

// But the following code loses the microseconds.
$model->where('my_dt_field', $now)->findAll();
// Generates: SELECT * FROM `my_table` WHERE `my_dt_field` = '2024-07-28 18:57:58'

참고

v4.6.0 이전에는 ms 또는 us를 매개변수로 사용할 수 없었습니다. 버그로 인해 Time의 초 소수 부분이 손실되었기 때문입니다.

timestamp

생성된 Time 인스턴스의 타임존은 UTC가 아닌 기본 타임존(앱의 타임존)입니다.

enum

Added in version 4.7.0.

필드를 PHP enum으로 캐스팅할 수 있습니다. enum[App\Enums\StatusEnum]과 같이 매개변수로 enum 클래스 이름을 지정해야 합니다.

Enum 캐스팅은 다음을 지원합니다:

• Backed enum (string 또는 int) - 백킹 값이 데이터베이스에 저장됩니다

• Unit enum - case 이름이 문자열로 데이터베이스에 저장됩니다

커스텀 캐스팅

자신만의 변환 타입을 정의할 수 있습니다.

커스텀 핸들러 생성하기

먼저 타입에 대한 핸들러 클래스를 생성해야 합니다. 클래스가 app/Models/Cast 디렉터리에 위치한다고 가정해 봅시다:

<?php

namespace App\Models\Cast;

use CodeIgniter\DataCaster\Cast\BaseCast;
use InvalidArgumentException;

// The class must inherit the CodeIgniter\DataCaster\Cast\BaseCast class
class CastBase64 extends BaseCast
{
    public static function get(
        mixed $value,
        array $params = [],
        ?object $helper = null,
    ): string {
        if (! is_string($value)) {
            self::invalidTypeValueError($value);
        }

        $decoded = base64_decode($value, true);

        if ($decoded === false) {
            throw new InvalidArgumentException('Cannot decode: ' . $value);
        }

        return $decoded;
    }

    public static function set(
        mixed $value,
        array $params = [],
        ?object $helper = null,
    ): string {
        if (! is_string($value)) {
            self::invalidTypeValueError($value);
        }

        return base64_encode($value);
    }
}

값을 가져오거나 설정할 때 값을 변경할 필요가 없다면 해당 메소드를 구현하지 않으면 됩니다:

<?php

namespace App\Models\Cast;

use CodeIgniter\DataCaster\Cast\BaseCast;
use InvalidArgumentException;

class CastBase64 extends BaseCast
{
    public static function get(
        mixed $value,
        array $params = [],
        ?object $helper = null,
    ): string {
        if (! is_string($value)) {
            self::invalidTypeValueError($value);
        }

        $decoded = base64_decode($value, true);

        if ($decoded === false) {
            throw new InvalidArgumentException('Cannot decode: ' . $value);
        }

        return $decoded;
    }
}

커스텀 핸들러 등록하기

이제 등록해야 합니다:

<?php

namespace App\Models;

use App\Models\Cast\CastBase64;
use CodeIgniter\Model;

class MyModel extends Model
{
    // ...

    // Specify the type for the field
    protected array $casts = [
        'column1' => 'base64',
    ];

    // Bind the type to the handler
    protected array $castHandlers = [
        'base64' => CastBase64::class,
    ];

    // ...
}

매개변수

경우에 따라 하나의 타입으로는 충분하지 않을 수 있습니다. 이런 경우 추가 매개변수를 사용할 수 있습니다. 추가 매개변수는 대괄호 안에 type[param1, param2]처럼 쉼표로 구분하여 나열합니다.

<?php

namespace App\Models;

use App\Models\Cast\SomeHandler;
use CodeIgniter\Model;

class MyModel extends Model
{
    // ...

    // Define a type with parameters
    protected array $casts = [
        'column1' => 'class[App\SomeClass, param2, param3]',
    ];

    // Bind the type to the handler
    protected array $castHandlers = [
        'class' => SomeHandler::class,
    ];

    // ...
}

<?php

namespace App\Models\Cast;

use CodeIgniter\DataCaster\Cast\BaseCast;

class SomeHandler extends BaseCast
{
    public static function get(
        mixed $value,
        array $params = [],
        ?object $helper = null,
    ): mixed {
        var_dump($params);
        /*
         * Output:
         * array(3) {
         *   [0]=>
         *   string(13) "App\SomeClass"
         *   [1]=>
         *   string(6) "param2"
         *   [2]=>
         *   string(6) "param3"
         * }
         */
    }
}

참고

캐스팅 타입이 ?bool처럼 nullable로 표시되고 전달된 값이 null이 아닌 경우, nullable 값을 가진 매개변수가 캐스팅 타입 핸들러에 전달됩니다. 캐스팅 타입에 미리 정의된 매개변수가 있으면 nullable이 목록 끝에 추가됩니다.

데이터 다루기

데이터 조회하기

find(), insert(), update(), delete() 등 테이블에서 기본 CRUD 작업을 수행하기 위한 여러 함수가 제공됩니다.

find()

첫 번째 매개변수로 전달된 값과 기본 키가 일치하는 단일 행을 반환합니다:

<?php

$user = $userModel->find($userId);

$returnType에 지정된 형식으로 값이 반환됩니다.

하나 대신 기본 키 값의 배열을 전달하여 두 개 이상의 행을 반환하도록 지정할 수 있습니다:

<?php

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

참고

find()를 매개변수 없이 또는 null과 함께 호출하면 해당 모델의 테이블에 있는 모든 행을 반환하며, 명시적이지는 않지만 findAll()과 동일하게 동작합니다.

findColumn()

null 또는 컬럼 값의 인덱스 배열을 반환합니다:

<?php

$user = $userModel->findColumn($columnName);

$columnName은 단일 컬럼의 이름이어야 하며, 그렇지 않으면 DataException이 발생합니다.

findAll()

모든 결과를 반환합니다:

<?php

$users = $userModel->findAll();

이 메소드를 호출하기 전에 필요에 따라 쿼리 빌더 명령을 삽입하여 쿼리를 수정할 수 있습니다:

<?php

$users = $userModel->where('active', 1)->findAll();

첫 번째와 두 번째 매개변수로 각각 limit과 offset 값을 전달할 수 있습니다:

<?php

$users = $userModel->findAll($limit, $offset);

first()

결과 집합의 첫 번째 행을 반환합니다. 쿼리 빌더와 함께 사용하는 것이 가장 좋습니다.

<?php

$user = $userModel->where('deleted', 0)->first();

withDeleted()

$useSoftDeletes가 true이면 find*() 메소드는 deleted_at IS NOT NULL인 행을 반환하지 않습니다. 이를 일시적으로 재정의하려면 find*() 메소드를 호출하기 전에 withDeleted() 메소드를 사용할 수 있습니다.

<?php

// Only gets non-deleted rows (deleted = 0)
$activeUsers = $userModel->findAll();

// Gets all rows
$allUsers = $userModel->withDeleted()->findAll();

onlyDeleted()

withDeleted()는 삭제된 행과 삭제되지 않은 행을 모두 반환하는 반면, 이 메소드는 다음 find*() 메소드가 소프트 삭제된 행만 반환하도록 수정합니다:

<?php

$deletedUsers = $userModel->onlyDeleted()->findAll();

데이터 저장하기

insert()

첫 번째 매개변수는 데이터베이스에 새 데이터 행을 생성하기 위한 연관 배열입니다. 배열 대신 객체가 전달되면 배열로 변환을 시도합니다.

배열의 키는 $table의 컬럼 이름과 일치해야 하며, 배열의 값은 해당 키에 저장할 값입니다.

선택적 두 번째 매개변수는 불리언 타입이며, false로 설정하면 메소드가 쿼리의 성공 또는 실패를 나타내는 불리언 값을 반환합니다.

getInsertID() 메소드를 사용하여 마지막으로 삽입된 행의 기본 키를 조회할 수 있습니다.

<?php

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

// Inserts data and returns inserted row's primary key
$userModel->insert($data);

// Inserts data and returns true on success and false on failure
$userModel->insert($data, false);

// Returns inserted row's primary key
$userModel->getInsertID();

allowEmptyInserts()

Added in version 4.3.0.

allowEmptyInserts() 메소드를 사용하여 빈 데이터를 삽입할 수 있습니다. 모델은 기본적으로 빈 데이터를 삽입하려고 할 때 예외를 발생시킵니다. 하지만 이 메소드를 호출하면 더 이상 검사가 수행되지 않습니다.

<?php

$userModel->allowEmptyInserts()->insert([]);

$allowEmptyInserts 속성으로도 이 설정을 변경할 수 있습니다.

allowEmptyInserts(false)를 호출하여 검사를 다시 활성화할 수 있습니다.

update()

데이터베이스의 기존 레코드를 업데이트합니다. 첫 번째 매개변수는 업데이트할 레코드의 $primaryKey입니다. 데이터의 연관 배열이 두 번째 매개변수로 이 메소드에 전달됩니다. 배열의 키는 $table의 컬럼 이름과 일치해야 하며, 배열의 값은 해당 키에 저장할 값입니다:

<?php

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

$userModel->update($id, $data);

중요

v4.3.0부터 이 메소드는 WHERE 절 없이 SQL 문을 생성하면 DatabaseException을 발생시킵니다. 이전 버전에서는 $primaryKey를 지정하지 않고 호출하여 WHERE 절 없이 SQL 문이 생성된 경우에도 쿼리가 실행되어 테이블의 모든 레코드가 업데이트되었습니다.

첫 번째 매개변수로 기본 키 배열을 전달하면 단일 호출로 여러 레코드를 업데이트할 수 있습니다:

<?php

$data = [
    'active' => 1,
];

$userModel->update([1, 2, 3], $data);

더 유연한 솔루션이 필요한 경우 매개변수를 비워두면 유효성 검사, 이벤트 등의 추가 이점과 함께 쿼리 빌더의 update 명령처럼 작동합니다:

<?php

$userModel
    ->whereIn('id', [1, 2, 3])
    ->set(['active' => 1])
    ->update();

save()

이는 기본 키 값과 일치하는 배열 키가 있는지 여부에 따라 레코드의 삽입 또는 업데이트를 자동으로 처리하는 insert()와 update() 메소드의 래퍼입니다:

<?php

// Defined as a model property
$primaryKey = 'id';

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

$userModel->save($data);

// Performs an update, since the primary key, 'id', is found.
$data = [
    'id'       => 3,
    'username' => 'darth',
    'email'    => 'd.vader@theempire.com',
];
$userModel->save($data);

save 메소드는 또한 단순하지 않은 객체를 인식하여 공개 및 보호된 값을 배열로 가져와 적절한 insert 또는 update 메소드에 전달함으로써 커스텀 클래스 결과 객체를 다루는 작업을 훨씬 간단하게 만들 수 있습니다. 이를 통해 엔티티 클래스를 매우 깔끔하게 다룰 수 있습니다. 엔티티 클래스는 사용자, 블로그 게시물, 작업 등과 같은 객체 타입의 단일 인스턴스를 나타내는 단순한 클래스입니다. 이 클래스는 특정 방식으로 요소를 포맷하는 등 객체 자체와 관련된 비즈니스 로직을 유지하는 역할을 합니다. 데이터베이스에 저장되는 방법에 대해서는 알 필요가 없습니다. 가장 단순한 형태는 다음과 같습니다:

<?php

namespace App\Entities;

class Job
{
    protected $id;
    protected $name;
    protected $description;

    public function __get($key)
    {
        if (property_exists($this, $key)) {
            return $this->{$key};
        }
    }

    public function __set($key, $value)
    {
        if (property_exists($this, $key)) {
            $this->{$key} = $value;
        }
    }
}

이와 함께 작동하는 매우 간단한 모델은 다음과 같습니다:

<?php

namespace App\Models;

use CodeIgniter\Model;

class JobModel extends Model
{
    protected $table         = 'jobs';
    protected $returnType    = \App\Entities\Job::class;
    protected $allowedFields = [
        'name', 'description',
    ];
}

이 모델은 jobs 테이블의 데이터를 처리하며, 모든 결과를 App\Entities\Job의 인스턴스로 반환합니다. 해당 레코드를 데이터베이스에 저장해야 할 경우, 커스텀 메소드를 작성하거나 모델의 save() 메소드를 사용하여 클래스를 검사하고 공개 및 비공개 속성을 가져와 데이터베이스에 저장해야 합니다:

<?php

// Retrieve a Job instance
$job = $model->find(15);

// Make some changes
$job->name = 'Foobar';

// Save the changes
$model->save($job);

참고

엔티티를 자주 사용하게 된다면 CodeIgniter는 엔티티 개발을 더 간단하게 만드는 여러 편리한 기능을 제공하는 내장 엔티티 클래스를 제공합니다.

날짜 저장하기

Added in version 4.5.0.

데이터를 저장할 때 Time 인스턴스를 전달하면 데이터베이스 설정의 dateFormat['datetime']과 dateFormat['date']에 정의된 형식의 문자열로 변환됩니다.

참고

v4.5.0 이전에는 날짜/시간 형식이 모델 클래스에서 Y-m-d H:i:s와 Y-m-d로 하드코딩되어 있었습니다.

기본 키 유효성 검사

Added in version 4.7.0.

insert(), insertBatch() ($useAutoIncrement가 false인 경우), update(), delete() 메소드는 데이터베이스 쿼리를 실행하기 전에 기본 키 값의 유효성을 검사합니다. null, 0, '0', 빈 문자열, 불리언, 빈 배열, 중첩 배열과 같은 유효하지 않은 값은 특정 오류 메시지와 함께 InvalidArgumentException을 발생시킵니다.

이 동작을 커스터마이즈해야 하는 경우(예: 레거시 시스템에서 0을 유효한 기본 키로 허용), 모델에서 validateID() 메소드를 재정의할 수 있습니다.

데이터 삭제하기

delete()

첫 번째 매개변수로 기본 키 값을 받아 모델의 테이블에서 일치하는 레코드를 삭제합니다:

<?php

$userModel->delete(12);

모델의 $useSoftDeletes 값이 true이면 행을 업데이트하여 deleted_at을 현재 날짜와 시간으로 설정합니다. 두 번째 매개변수를 true로 설정하여 영구 삭제를 강제할 수 있습니다.

첫 번째 매개변수로 기본 키 배열을 전달하여 여러 레코드를 한 번에 삭제할 수 있습니다:

<?php

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

매개변수가 전달되지 않으면 이전에 where 호출이 필요한 쿼리 빌더의 delete 메소드처럼 동작합니다:

<?php

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

purgeDeleted()

‘deleted_at IS NOT NULL’인 모든 행을 영구적으로 제거하여 데이터베이스 테이블을 정리합니다.

<?php

$userModel->purgeDeleted();

모델 내 유효성 검사

경고

모델 내 유효성 검사는 데이터가 데이터베이스에 저장되기 직전에 수행됩니다. 그 이전 시점에서는 데이터가 아직 유효성 검사를 받지 않았습니다. 유효성 검사 이전에 사용자 입력 데이터를 처리하면 취약점이 발생할 수 있습니다.

데이터 유효성 검사

모델 클래스는 insert(), update(), save() 메소드로 데이터베이스에 저장하기 전에 모든 데이터를 자동으로 유효성 검사하는 방법을 제공합니다.

중요

데이터를 업데이트할 때 기본적으로 모델 클래스의 유효성 검사는 제공된 필드만 검사합니다. 이는 일부 필드만 업데이트할 때 유효성 검사 오류를 방지하기 위한 것입니다.

그러나 이는 업데이트 중에 설정한 모든 유효성 검사 규칙이 확인되지 않음을 의미합니다. 따라서 불완전한 데이터가 유효성 검사를 통과할 수 있습니다.

예를 들어, 다른 필드의 값이 필요한 required* 규칙이나 is_unique 규칙이 예상대로 동작하지 않을 수 있습니다.

이러한 문제를 방지하려면 설정으로 이 동작을 변경할 수 있습니다. 자세한 내용은 $cleanValidationRules를 참조하세요.

유효성 검사 규칙 설정하기

첫 번째 단계는 적용해야 할 필드와 규칙으로 $validationRules 클래스 속성을 채우는 것입니다.

참고

사용 가능한 규칙에서 내장 유효성 검사 규칙 목록을 확인할 수 있습니다.

사용하고 싶은 커스텀 오류 메시지가 있으면 $validationMessages 배열에 넣으세요:

<?php

namespace App\Models;

use CodeIgniter\Model;

class UserModel extends Model
{
    // ...

    protected $validationRules = [
        'username'     => 'required|max_length[30]|alpha_numeric_space|min_length[3]',
        'email'        => 'required|max_length[254]|valid_email|is_unique[users.email]',
        'password'     => 'required|max_length[255]|min_length[8]',
        'pass_confirm' => 'required_with[password]|max_length[255]|matches[password]',
    ];
    protected $validationMessages = [
        'email' => [
            'is_unique' => 'Sorry. That email has already been taken. Please choose another.',
        ],
    ];
}

유효성 검사 설정 파일 내에서 규칙과 오류 메시지를 구성하려면 그렇게 하고 $validationRules를 생성한 유효성 검사 규칙 그룹 이름으로 설정하면 됩니다:

<?php

namespace App\Models;

use CodeIgniter\Model;

class UserModel extends Model
{
    // ...

    protected $validationRules = 'users';
}

함수를 사용하여 필드에 유효성 검사 규칙을 설정하는 다른 방법도 있습니다.

class CodeIgniter\Model

CodeIgniter\Model::setValidationRule($field, $fieldRules)

매개변수:

• $field (string)

• $fieldRules (array)

이 함수는 필드 유효성 검사 규칙을 설정합니다.

사용 예시:

<?php

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

$model->setValidationRule($fieldName, $fieldRules);

CodeIgniter\Model::setValidationRules($validationRules)

매개변수:

• $validationRules (array)

이 함수는 유효성 검사 규칙을 설정합니다.

사용 예시:

<?php

$validationRules = [
    'username' => 'required|max_length[30]|alpha_numeric_space|min_length[3]',
    'email'    => [
        'rules'  => 'required|max_length[254]|valid_email|is_unique[users.email]',
        'errors' => [
            'required' => 'We really need your email.',
        ],
    ],
];
$model->setValidationRules($validationRules);

함수를 사용하여 필드에 유효성 검사 메시지를 설정하는 다른 방법도 있습니다.

CodeIgniter\Model::setValidationMessage($field, $fieldMessages)

매개변수:

• $field (string)

• $fieldMessages (array)

이 함수는 필드별 오류 메시지를 설정합니다.

사용 예시:

<?php

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

CodeIgniter\Model::setValidationMessages($validationMessages)

매개변수:

• $validationMessages (array)

이 함수는 필드 메시지를 설정합니다.

사용 예시:

<?php

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

유효성 검사 결과 가져오기

이제 insert(), update(), save() 메소드를 호출할 때마다 데이터의 유효성이 검사됩니다. 실패하면 모델은 불리언 false를 반환합니다.

유효성 검사 오류 가져오기

errors() 메소드를 사용하여 유효성 검사 오류를 조회할 수 있습니다:

<?php

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

이는 폼 상단에 모든 오류를 표시하거나 개별적으로 표시하는 데 사용할 수 있는 필드 이름과 관련 오류가 담긴 배열을 반환합니다:

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

유효성 검사 규칙 조회하기

validationRules 속성에 접근하여 모델의 유효성 검사 규칙을 조회할 수 있습니다:

<?php

$rules = $model->validationRules;

옵션과 함께 접근자 메소드를 직접 호출하여 해당 규칙의 일부만 조회할 수도 있습니다:

<?php

$rules = $model->getValidationRules($options);

$options 매개변수는 하나의 요소를 가진 연관 배열로, 키는 'except' 또는 'only'이며 값은 관심 있는 필드 이름의 배열입니다:

<?php

// get the rules for all but the "username" field
$rules = $model->getValidationRules(['except' => ['username']]);
// get the rules for only the "city" and "state" fields
$rules = $model->getValidationRules(['only' => ['city', 'state']]);

유효성 검사 플레이스홀더

모델은 전달되는 데이터를 기반으로 규칙의 일부를 대체하는 간단한 방법을 제공합니다. 다소 모호하게 들릴 수 있지만 is_unique 유효성 검사 규칙에서 특히 유용합니다. 플레이스홀더는 단순히 $data로 전달된 필드의 이름(또는 배열 키)을 중괄호로 감싼 것입니다. 이는 일치하는 수신 필드의 값으로 대체됩니다. 예시로 이해해 보겠습니다:

<?php

namespace App\Models;

use CodeIgniter\Model;

class MyModel extends Model
{
    // ...

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

참고

v4.3.5부터는 플레이스홀더 필드(id)에 대한 유효성 검사 규칙을 설정해야 합니다.

이 규칙 집합에서는 플레이스홀더의 값과 일치하는 id를 가진 행을 제외하고 이메일 주소가 데이터베이스에서 고유해야 한다고 명시합니다. 폼 POST 데이터가 다음과 같다고 가정하면:

<?php

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

{id} 플레이스홀더가 숫자 4로 대체되어 다음과 같이 수정된 규칙이 됩니다:

<?php

namespace App\Models;

use CodeIgniter\Model;

class MyModel extends Model
{
    // ...

    protected $validationRules = [
        'id'    => 'max_length[19]|is_natural_no_zero',
        'email' => 'required|max_length[254]|valid_email|is_unique[users.email,id,4]',
    ];
}

따라서 이메일이 고유한지 확인할 때 데이터베이스에서 id=4인 행을 무시합니다.

참고

v4.3.5부터 플레이스홀더(id) 값이 유효성 검사를 통과하지 못하면 플레이스홀더가 대체되지 않습니다.

전달된 동적 키가 폼 데이터와 충돌하지 않도록 주의하는 한, 이를 런타임에 더 동적인 규칙을 생성하는 데도 사용할 수 있습니다.

필드 보호하기

대량 할당 공격에 대한 보호를 위해 모델 클래스는 $allowedFields 클래스 속성에 삽입 및 업데이트 중 변경할 수 있는 모든 필드 이름을 나열하도록 요구합니다. 여기에 포함되지 않은 추가 데이터는 데이터베이스에 도달하기 전에 제거됩니다. 이는 타임스탬프나 기본 키가 변경되지 않도록 보장하는 데 유용합니다.

<?php

namespace App\Models;

use CodeIgniter\Model;

class MyModel extends Model
{
    // ...

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

때로는 이러한 요소를 변경해야 할 경우가 생깁니다. 이는 종종 테스트, 마이그레이션 또는 시드 중에 발생합니다. 이런 경우 보호를 켜거나 끌 수 있습니다:

<?php

$model->protect(false)
    ->insert($data)
    ->protect(true);

런타임 반환 타입 변경

find*() 메소드를 사용할 때 데이터가 반환되어야 할 형식을 클래스 속성 $returnType으로 지정할 수 있습니다. 하지만 다른 형식으로 데이터를 받고 싶을 때가 있습니다. 모델은 바로 그 작업을 할 수 있는 메소드를 제공합니다.

참고

이 메소드들은 다음 find*() 메소드 호출에 대해서만 반환 타입을 변경합니다. 그 후에는 기본값으로 재설정됩니다.

asArray()

다음 find*() 메소드의 데이터를 연관 배열로 반환합니다:

<?php

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

asObject()

다음 find*() 메소드의 데이터를 표준 객체 또는 커스텀 클래스 인스턴스로 반환합니다:

<?php

// Return as standard objects
$users = $userModel->asObject()->where('status', 'active')->findAll();

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

대용량 데이터 처리하기

때로는 대용량 데이터를 처리해야 하며 메모리가 부족해질 위험이 있습니다. 이를 간단하게 하기 위해 chunk() 메소드를 사용하여 작업할 수 있는 더 작은 데이터 청크를 가져올 수 있습니다. 첫 번째 매개변수는 단일 청크에서 조회할 행의 수입니다. 두 번째 매개변수는 각 데이터 행에 대해 호출될 클로저입니다.

이는 크론잡, 데이터 내보내기 또는 기타 대규모 작업 중에 가장 잘 사용됩니다.

<?php

$userModel->chunk(100, static function ($data) {
    // do something.
    // $data is a single row of data.
});

쿼리 빌더 사용하기

모델 테이블용 쿼리 빌더 가져오기

CodeIgniter 모델은 해당 모델의 데이터베이스 연결을 위한 쿼리 빌더 인스턴스를 하나 가지고 있습니다. 필요할 때 언제든지 쿼리 빌더의 공유 인스턴스에 접근할 수 있습니다:

<?php

$builder = $userModel->builder();

이 빌더는 이미 모델의 $table로 설정되어 있습니다.

참고

쿼리 빌더 인스턴스를 얻으면 쿼리 빌더의 메소드를 호출할 수 있습니다. 하지만 쿼리 빌더는 모델이 아니므로 모델의 메소드를 호출할 수 없습니다.

다른 테이블용 쿼리 빌더 가져오기

다른 테이블에 접근해야 하는 경우 쿼리 빌더의 다른 인스턴스를 얻을 수 있습니다. 테이블 이름을 매개변수로 전달하되, 이는 공유 인스턴스를 반환하지 않는다는 점에 유의하세요:

<?php

$groupBuilder = $userModel->builder('groups');

쿼리 빌더와 모델 메소드 혼합 사용하기

쿼리 빌더 메소드와 모델의 CRUD 메소드를 동일한 체인 호출에서 함께 사용할 수 있어 매우 우아하게 사용할 수 있습니다:

<?php

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

이 경우 모델이 보유한 쿼리 빌더의 공유 인스턴스에서 작동합니다.

중요

모델은 쿼리 빌더에 완벽한 인터페이스를 제공하지 않습니다. 모델과 쿼리 빌더는 서로 다른 목적을 가진 별도의 클래스입니다. 같은 데이터를 반환할 것으로 기대해서는 안 됩니다.

쿼리 빌더가 결과를 반환하면 그대로 반환됩니다. 이 경우 결과는 모델의 메소드가 반환한 것과 다를 수 있으며 예상한 것이 아닐 수 있습니다. 모델의 이벤트는 트리거되지 않습니다.

예상치 못한 동작을 방지하려면 결과를 반환하는 쿼리 빌더 메소드를 사용하지 말고 메소드 체이닝의 끝에 모델의 메소드를 지정하세요.

참고

모델의 데이터베이스 연결에도 원활하게 접근할 수 있습니다:

<?php

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

모델 이벤트

모델 실행 중 여러 콜백 메소드를 실행하도록 지정할 수 있는 여러 시점이 있습니다. 이 메소드들은 데이터 정규화, 비밀번호 해싱, 관련 엔티티 저장 등 다양한 용도로 사용할 수 있습니다.

모델 실행의 다음 시점들이 영향을 받을 수 있으며, 각각 클래스 속성을 통해 설정합니다:

• $beforeInsert, $afterInsert

• $beforeUpdate, $afterUpdate

• $beforeFind, $afterFind

• $beforeDelete, $afterDelete

• $beforeInsertBatch, $afterInsertBatch

• $beforeUpdateBatch, $afterUpdateBatch

참고

$beforeInsertBatch, $afterInsertBatch, $beforeUpdateBatch, $afterUpdateBatch는 v4.3.0부터 사용할 수 있습니다.

콜백 정의하기

먼저 모델에 사용할 새 클래스 메소드를 생성하여 콜백을 지정합니다.

이 클래스 메소드는 항상 $data 배열을 유일한 매개변수로 받습니다.

$data 배열의 정확한 내용은 이벤트마다 다르지만, 원래 메소드에 전달된 기본 데이터를 담고 있는 data라는 키를 항상 포함합니다. insert*() 또는 update*() 메소드의 경우 데이터베이스에 삽입되는 키/값 쌍이 됩니다. 메인 $data 배열은 메소드에 전달된 다른 값들도 포함하며, 이는 Event Parameters에 상세히 설명되어 있습니다.

콜백 메소드는 다른 콜백들이 전체 정보를 가질 수 있도록 원래의 $data 배열을 반환해야 합니다.

<?php

namespace App\Models;

use CodeIgniter\Model;

class MyModel extends Model
{
    // ...

    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;
    }
}

실행할 콜백 지정하기

적절한 클래스 속성($beforeInsert, $afterUpdate 등)에 메소드 이름을 추가하여 콜백을 실행할 시점을 지정합니다. 단일 이벤트에 여러 콜백을 추가할 수 있으며 순서대로 처리됩니다. 동일한 콜백을 여러 이벤트에서 사용할 수도 있습니다:

<?php

namespace App\Models;

use CodeIgniter\Model;

class MyModel extends Model
{
    // ...

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

    // ...
}

또한 각 모델은 $allowCallbacks 속성을 설정하여 클래스 전체에서 콜백을 허용(기본값)하거나 거부할 수 있습니다:

<?php

namespace App\Models;

use CodeIgniter\Model;

class MyModel extends Model
{
    // ...

    protected $allowCallbacks = false;

    // ...
}

allowCallbacks() 메소드를 사용하여 단일 모델 호출에 대해 일시적으로 이 설정을 변경할 수도 있습니다:

<?php

$model->allowCallbacks(false)->find(1); // No callbacks triggered
$model->find(1); // Callbacks subject to original property value

이벤트 매개변수

각 콜백에 전달되는 정확한 데이터는 약간씩 다르므로, 각 이벤트에 전달되는 $data 매개변수에 무엇이 있는지에 대한 세부 사항은 다음과 같습니다:

이벤트	$data 내용
beforeInsert	data = 삽입되는 키/값 쌍. 객체 또는 엔티티 클래스가 insert() 메소드에 전달되면 먼저 배열로 변환됩니다.
afterInsert	id = 새 행의 기본 키, 실패 시 0. data = 삽입되는 키/값 쌍. result = 쿼리 빌더를 통해 사용된 insert() 메소드의 결과.
beforeUpdate	id = update() 메소드에 전달되는 행의 기본 키 배열. data = 업데이트되는 키/값 쌍. 객체 또는 엔티티 클래스가 update() 메소드에 전달되면 먼저 배열로 변환됩니다.
afterUpdate	id = update() 메소드에 전달되는 행의 기본 키 배열. data = 업데이트되는 키/값 쌍. result = 쿼리 빌더를 통해 사용된 update() 메소드의 결과.
beforeFind	호출하는 메소드의 이름, 싱글톤 요청 여부, 그리고 다음 추가 필드들:
first()	추가 필드 없음
find()	id = 검색 중인 행의 기본 키.
findAll()	limit = 조회할 행의 수. offset = 검색 중 건너뛸 행의 수.
afterFind	beforeFind와 동일하지만 결과 데이터 행(들)을 포함하거나, 결과가 없으면 null.
beforeDelete	id = delete() 메소드에 전달되는 기본 키 행의 배열. purge = 소프트 삭제 행을 완전히 삭제해야 할지 여부를 나타내는 불리언.
afterDelete	id = delete() 메소드에 전달되는 기본 키 행의 배열. purge = 소프트 삭제 행을 완전히 삭제해야 할지 여부를 나타내는 불리언. result = 쿼리 빌더에서 delete() 호출의 결과. data = 미사용.
beforeInsertBatch	data = 삽입되는 값의 연관 배열. 객체 또는 엔티티 클래스가 insertBatch() 메소드에 전달되면 먼저 배열로 변환됩니다.
afterInsertBatch	data = 삽입되는 값의 연관 배열. result = 쿼리 빌더를 통해 사용된 insertbatch() 메소드의 결과.
beforeUpdateBatch	data = 업데이트되는 값의 연관 배열. 객체 또는 엔티티 클래스가 updateBatch() 메소드에 전달되면 먼저 배열로 변환됩니다.
afterUpdateBatch	data = 업데이트되는 키/값 쌍. result = 쿼리 빌더를 통해 사용된 updateBatch() 메소드의 결과.

참고

paginate() 메소드를 beforeFind 이벤트와 함께 사용하여 쿼리를 수정할 때 결과가 예상대로 동작하지 않을 수 있습니다.

beforeFind 이벤트는 실제 결과 조회(findAll())에만 영향을 미치지만, 페이지네이션을 위한 전체 행 수를 계산하는 데 사용되는 쿼리에는 영향을 미치지 않기 때문입니다.

결과적으로 페이지네이션 링크를 생성하는 데 사용되는 전체 행 수가 수정된 쿼리 조건을 반영하지 않아 페이지네이션에 불일치가 발생할 수 있습니다.

Find* 데이터 수정하기

beforeFind와 afterFind 메소드는 모두 모델의 일반 응답을 재정의하기 위해 수정된 데이터 집합을 반환할 수 있습니다. afterFind의 경우 반환 배열의 data에 대한 변경 사항은 자동으로 호출 컨텍스트에 다시 전달됩니다. beforeFind가 find 워크플로를 가로채려면 추가 불리언 returnData도 반환해야 합니다:

<?php

namespace App\Models;

use CodeIgniter\Model;

class MyModel extends Model
{
    // ...

    protected $beforeFind = ['checkCache'];

    // ...

    protected function checkCache(array $data)
    {
        // Check if the requested item is already in our cache
        if (isset($data['id']) && $item = $this->getCachedItem($data['id'])) {
            $data['data']       = $item;
            $data['returnData'] = true;

            return $data;
        }

        // ...
    }
}

수동 모델 생성

애플리케이션을 위한 모델을 생성하는 데 특별한 클래스를 상속할 필요가 없습니다. 데이터베이스 연결 인스턴스만 얻으면 준비가 됩니다. 이를 통해 CodeIgniter의 모델이 기본으로 제공하는 기능을 우회하고 완전히 커스텀한 경험을 만들 수 있습니다.

<?php

namespace App\Models;

use CodeIgniter\Database\ConnectionInterface;

class UserModel
{
    protected $db;

    public function __construct(ConnectionInterface $db)
    {
        $this->db = $db;
    }
}