Search by email and documentation in general

[gl2007]

Is there documentation on

1. what all providers exist and what all methods are available in each method? For e.g. this managing-users talks about findbyid but if I have to search by email or other columns in auth_identities/users (search by a logged in admin) then?
2. how do I use relationships? ChapGPT shows hasOne/isOneOf methods, which didn't work (not surprised). Do I have to do the usual query or is there lazyloading of referenced objects?

Will be a bit honest here but it's been a struggle to find things around in Shield. Would have been great to just list down all available classes, their methods, properties, ways to use etc.

Note: just started looking at the source

[datamweb]

We have tried our best to provide concise but clear documentation to users. I may not have done well in the sections on this. But fortunately, Shield is an open source project and anyone can contribute to its improvement.

Regarding your question, unfortunately, I did not understand some parts. But if you want to search based on email, do the following.

$users = auth()->getProvider();
echo $users->findByCredentials(['email' => '[email protected]'])?->username;

[gl2007]

thanks! I will try that. Having it opensource is great.
After reading UserIdentityModel.php, I was going ahead in the way below:

        $userIdentities = new UserIdentityModel();
        return $userIdentities->getIdentityBySecret('email_password', $email);

Will that work?

Also, do you have thoughts on my second question. Any examples would be great.

[datamweb]

Will that work?

It works, but it doesn't return users table data ('username', 'f_name', ...). So I don't suggest it.

do you have thoughts on my second question

sorry, in general, I did not understand your question.

[gl2007]

thanks @datamweb that helps!

[kenjis]

what all providers exist and what all methods are available in each method?

There are only one provider "User Provider" in Shield.
https://codeigniter4.github.io/shield/concepts/#user-providers

I recommend you see the source code to know all methods.
It is well documented with PHPDocs.

how do I use relationships? ChapGPT shows hasOne/isOneOf methods, which didn't work (not surprised). Do I have to do the usual query or is there lazyloading of referenced objects?

There is no special feature for relationships.
But User Provider handles email/password User Identities.

[gl2007]

thanks @kenjis for the clarifications. Yeah, started looking at source code. I have couple other questions, I will create separate thread.