EventModel.php

<?php

declare(strict_types=1);

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace Tests\Support\Models;

use CodeIgniter\Model;

class EventModel extends Model
{
    protected $table          = 'user';
    protected $returnType     = 'array';
    protected $useSoftDeletes = false;
    protected $dateFormat     = 'datetime';
    protected $allowedFields  = [
        'name',
        'email',
        'country',
        'deleted_at',
    ];
    protected $beforeInsert      = ['beforeInsertMethod'];
    protected $afterInsert       = ['afterInsertMethod'];
    protected $beforeInsertBatch = ['beforeInsertBatchMethod'];
    protected $afterInsertBatch  = ['afterInsertBatchMethod'];
    protected $beforeUpdate      = ['beforeUpdateMethod'];
    protected $afterUpdate       = ['afterUpdateMethod'];
    protected $beforeUpdateBatch = ['beforeUpdateBatchMethod'];
    protected $afterUpdateBatch  = ['afterUpdateBatchMethod'];
    protected $beforeDelete      = ['beforeDeleteMethod'];
    protected $afterDelete       = ['afterDeleteMethod'];
    protected $beforeFind        = ['beforeFindMethod'];
    protected $afterFind         = ['afterFindMethod'];

    // Cache of the most recent eventData from a trigger
    public $eventData;

    // Testing directive to set $returnData on beforeFind event
    public $beforeFindReturnData = false;

    // Holds stuff for testing events
    protected $tokens = [];

    protected function beforeInsertMethod(array $data)
    {
        $this->tokens[]  = 'beforeInsert';
        $this->eventData = $data;

        return $data;
    }

    protected function afterInsertMethod(array $data)
    {
        $this->tokens[]  = 'afterInsert';
        $this->eventData = $data;

        return $data;
    }

    protected function beforeInsertBatchMethod(array $data)
    {
        $this->tokens[]  = 'beforeInsertBatch';
        $this->eventData = $data;

        return $data;
    }

    protected function afterInsertBatchMethod(array $data)
    {
        $this->tokens[]  = 'afterInsertBatch';
        $this->eventData = $data;

        return $data;
    }

    protected function beforeUpdateMethod(array $data)
    {
        $this->tokens[]  = 'beforeUpdate';
        $this->eventData = $data;

        return $data;
    }

    protected function afterUpdateMethod(array $data)
    {
        $this->tokens[]  = 'afterUpdate';
        $this->eventData = $data;

        return $data;
    }

    protected function beforeUpdateBatchMethod(array $data)
    {
        $this->tokens[]  = 'beforeUpdateBatch';
        $this->eventData = $data;

        return $data;
    }

    protected function afterUpdateBatchMethod(array $data)
    {
        $this->tokens[]  = 'afterUpdateBatch';
        $this->eventData = $data;

        return $data;
    }

    protected function beforeDeleteMethod(array $data)
    {
        $this->tokens[]  = 'beforeDelete';
        $this->eventData = $data;

        return $data;
    }

    protected function afterDeleteMethod(array $data)
    {
        $this->tokens[]  = 'afterDelete';
        $this->eventData = $data;

        return $data;
    }

    /**
     * @param array<string, mixed> $data
     */
    protected function beforeFindMethod(array $data)
    {
        $this->tokens[]  = 'beforeFind';
        $this->eventData = $data;

        if ($this->beforeFindReturnData) {
            $data['data']       = 'foobar';
            $data['returnData'] = true;
        }

        return $data;
    }

    protected function afterFindMethod(array $data)
    {
        $this->tokens[]  = 'afterFind';
        $this->eventData = $data;

        return $data;
    }

    public function hasToken(string $token)
    {
        return in_array($token, $this->tokens, true);
    }
}