creating model instance using new, model() and Factories

[hatsat32]

Hi. I am having trouble with creating user model instance.

I use Myth\Auth UserModel to auth processes and I use my own UserModel to do other stuff in my ci4 project.

I have php code as following:

<?php namespace App\Controllers;

use CodeIgniter\Config\Factories;
use \Myth\Auth\Models\UserModel as MythUserModel;
use App\Models\UserModel as AppUserModel;

class Home extends BaseController
{
	public function index()
	{
		echo("Class Names");
		d(MythUserModel::class); // I expect myth user model
		d(AppUserModel::class);

		echo("Models with helper");
		d(model(MythUserModel::class)); // I expect myth user model
		d(model(AppUserModel::class));

		echo("Models with factories");
		d(Factories::models(MythUserModel::class)); // I expect myth user model
		d(Factories::models(AppUserModel::class));

		echo("Models with factories (str)");
		d(Factories::models('\Myth\Auth\Models\UserModel')); // I expect myth user model
		d(Factories::models('\App\Models\UserModel'));

		// all outputs are 'App\Models\UserModel'
	}
}

output is here:

When I explicitly specify \Myth\Auth\Models\UserModel in model() and Factories::model; I get App\Models\UserModel. Is this a bug. Or is this really expected. I am very confused.

I also read ci4 docs (user guide) but did not help.

Note: my english is not very good. Let me know if I made a mistake.

EDIT1: I created simple project if you would like to look at https://github.com/hatsat32/ci4-demo-app/blob/master/app/Controllers/Home.php

[MGatner]

I think you are misunderstanding Factories is this case. Check out the options, particularly the preferApp flag: https://codeigniter4.github.io/CodeIgniter4/concepts/factories.html#factories-options

When this is set (which is default), Factories will check any class basename for an equivalent in App\Models and return that if matched. Since all your examples amount to calling Factories::models('UserModel') you always receive back App\Models\UserModel.

I you already know the model you want it's never wrong to ask for it directly:

$model = new \Myth\Auth\Models\UserModel()

If you would still like to take advantage of the shared instances you can turn off the preferApp flag when you ask for Myth's model:

$model = Factories::models('Myth\Auth\Models\UserModel', ['preferApp' => false]);

Note: the helper function model($name) is simply a convenience wrapper for Factories::models($name).

[hatsat32]

Sorry for late response!

Thank you @MGatner for your answer. It was very helpful.

I had been playing with myth/auth. I saw myth/auth use model(UserModel) (model helper) internally to create usermodel instance. As I mention abowe I use two usermodels for different purposes. I use myth/auth's usermodel to do auth stuff and I use my own usermodel to do my own stuff. This used to work very well in older versions of myth/auth (1.0 beta 3). And my usermodel doesn't have auth related fields/feautes.

So I have a few questions here:

1. myth/auth use model helper to create usermodel instance internally. model helper always returns my usermodel (App\Models\UserModel) instance which doesn't have auth shuff. this make impossible to use two different usermodels. Is there any way to use two different usermodel?
2. I did read extending documentation in the repo. is Extending the best choice I have or is extending the best practice.

Any advice would be appreciated greatly.

[MGatner]

1. As it stands, you cannot have both models name "UserModel" and have Myth:Auth ignore your version in App. You could give your version a different name, or put it in a different folder (like app/Auth/UserModel.php). One solution (which might be a good idea) would be to have Myth:Auth use the instanceOf flag to make sure it is using a version of its own model - this would ignore your model (assuming it does not extend Myth's).
2. Extending versing publishing is up to you. A lot of people prefer to publish the module components into they project, which gives full control over the code. The downside is that when there are updates to Myth:Auth you have to be sure to integrate them yourself. I much prefer extending myself, but no judgment either way.

[hatsat32]

Thank you again @MGatner .

One solution (which might be a good idea) would be to have Myth:Auth use the instanceOf flag to make sure it is using a version of its own model - this would ignore your model (assuming it does not extend Myth's).

I agree. This would be a very good idea. And this prevents conflicts when updateting myth:auth (in solution 1). And it ansures all UserModels extends Myth:Auth's usermodel. I assume I can't do on my own.

For now I will use solution 2 (extending myth:auth's usermodel).

Thank you for all your effort. Very appreciated !!!