Extending Shield User Entity

[bgeneto]

How can I properly extend Shield\Entities\User class? Is there a simple approach without side effects?
To be clear, I would like to add new methods for a logged in user, i.e. to the User entity, not to the UserModel. The Shield's UserModel can be extended quiet easily.
TIA.

[sammyskills]

This is the basis for extending a class in PHP.

use CodeIgniter\Shield\Entities\User;
...
...
class YourEntity extends User {
    // Your code here
}

But if your question is about how to extend the User entity and use it within your code, the steps below should get you up and running:

1. Extend the User entity as explained above, and add your extra methods.
2. Extend the default UserModel and update the $returnType variable to return your newly created entity. For example: protected $returnType = YourEntity::class;
3. Update your $userProvider to your custom model. You'll find this in the Config/Auth.php file.

[pippuccio76]

hi , this is my code :

<?php
  namespace App\Models\Entities;
  
  use CodeIgniter\Entity;
  use App\Models\Colori_htmlModel;
  use CodeIgniter\Shield\Models\UserModel as ShieldUserModel;
  use CodeIgniter\Shield\Entities\User as ShieldUserEntity;
  
  
  class Users_Entity extends ShieldUserEntity
  {
      function colori_html()
      {
        $colori_html_model= new Colori_htmlModel();
        return $colori_html_model->find($this->id_colori_html);
      
      }
  
  
      
  }

In view :

<td> <a href="#" type="button" class="btn btn-square-md ms-1" title='Colore' style="background-color:<?= $row->colori_html()->nome?> ;">&nbsp;</a></td>

$row come to <?php foreach ($user_list as $row): ?>

but Call to undefined method CodeIgniter\Shield\Entities\User::colori_html()

ps: wich is the way to insert code correctly (is not better insert tag code ?)

[datamweb]

but Call to undefined method CodeIgniter\Shield\Entities\User::colori_html()

Set the return type in your custom model(App\Models\UserModel.php ).

<?php

declare(strict_types=1);

namespace App\Models;

use CodeIgniter\Shield\Models\UserModel as ShieldUserModel;
+use App\Entities\User;

class UserModel extends ShieldUserModel
{
    //protected $returnType = User::class;
    protected function initialize(): void
    {
        parent::initialize();

        $this->allowedFields = [
            ...$this->allowedFields,

            // 'first_name',
        ];
+$this->returnType = User::class;
    }
}

Make sure you set the public string $userProvider = \App\Models\UserModel::class; on the custom model.

[kenjis]

An Entity uses a Model?
If so, there seems to be a major problem with the design.
Because an Entity represents a table record, and a Model returns Entities.

  class Users_Entity extends ShieldUserEntity
  {
      function colori_html()
      {
          $colori_html_model = new Colori_htmlModel();
          return $colori_html_model->find($this->id_colori_html);
      }
  }

[pippuccio76]

My code :

<?php
    
declare(strict_types=1);
    
namespace App\Models;
    
use CodeIgniter\Shield\Models\UserModel as ShieldUserModel;
use App\Entity\Users_Entity;
    
class UserModel extends ShieldUserModel
{
protected function initialize(): void
{
parent::initialize();

$this->allowedFields = [
...$this->allowedFields,

'nome',
'cognome',
'telefono',
];
$this->returnType = UserModel::class;


}
    
}

Call to undefined method App\Models\UserModel::colori_html it seem call Model's function instead Entitie's function

Furthermore $row->email return empty ... if i remove $this->returnType = UserModel::class; return correct value

[datamweb]

Please see here before anything else.

Where did I explain to use $this->returnType = UserModel::class;!!

Your Entity name is Users_Entity. So you need to set the name $this->returnType = Users_Entity::class;. Or you can proceed as follows:

`<?php

declare(strict_types=1);

namespace App\Models;

use CodeIgniter\Shield\Models\UserModel as ShieldUserModel;
-use App\Entity\Users_Entity;
+use App\Entity\Users_Entity as User;

class UserModel extends ShieldUserModel
{
protected function initialize(): void
{
    parent::initialize();

    $this->allowedFields = [
        ...$this->allowedFields,

        'nome',
        'cognome',
        'telefono',
    ];

    $this->returnType = User::class;


  }

}

[pippuccio76]

My code :

<?php

declare(strict_types=1);

namespace App\Models;

use CodeIgniter\Shield\Models\UserModel as ShieldUserModel;
use App\Entity\Users_Entity as User;

class UserModel extends ShieldUserModel
{
    protected function initialize(): void
    {
        parent::initialize();

        $this->allowedFields = [
            ...$this->allowedFields,

            'nome',
            'cognome',
            'telefono',
        ];

        $this->returnType = User::class;


    }

}

        

	public function lista_completa(){


        // Get the User Provider (UserModel by default)
        $users_model = auth()->getProvider();

		$data=[];
	
	    $data['lista']=$users_model->findAll();

        echo view('empty_view',$data);
        echo view('admin/users/lista_users');

	}//fine lista completa

mysqli_result::fetch_object(): Argument #1 ($class) must be a valid class name, App\Entity\Users_Entity given

[datamweb]

@pippuccio76 This is a simple matter. But you seem to be very careless in small matters.

You are a developer so you should know that the smallest mistake can cause big problems.

It is explained to you in the text. The class name is incorrect. So you should see where you set the name wrong.

I will give an example here, please look carefully at what has been done and then modify your code.

File app\Entities\UserEntity.php must be as follows:

<?php

namespace App\Entities;

use CodeIgniter\Shield\Entities\User as ShieldUser;

class UserEntity extends ShieldUser
{
    public function coloriHtml(): string
    {
        return 'Text Method colorHtmlfor :  '. $this->username;
    }
}

File app\Models\UserModel.php be as follows:

<?php

declare(strict_types=1);

namespace App\Models;

use CodeIgniter\Shield\Models\UserModel as ShieldUserModel;
use App\Entities\UserEntity as User;

class UserModel extends ShieldUserModel
{
    protected function initialize(): void
    {
        parent::initialize();

        $this->allowedFields = [
            ...$this->allowedFields,

            // 'first_name',
        ];
        $this->returnType = User::class;
    }
}

Now you can print the value of coloriHtml() for each user as below.

$user = auth()->getProvider()->findById(1)->coloriHtml();
echo($user);

[b-and-p]

I've been struggling with this for two days. I am using CI 4.5.5 codeigniter4/shield 1.1.0.
This doesn't work for me:

use CodeIgniter\Database\Exceptions\DataException;
use CodeIgniter\Entity\Cast\ObjectCast;
use CodeIgniter\Shield\Entities\User as EntitiesUser;
-use CodeIgniter\Shield\Entities\User;
+use App\Entities\UserEntity as User;
use CodeIgniter\Shield\Models\DatabaseException;
use CodeIgniter\Shield\Models\UserModel as ShieldUserModel;
use Exception;

/**
* UserModel
* 
* Interacts with User database table
*/
final class UserModel extends ShieldUserModel
{
   /**
    * initialize
    * 
    * Class initialisation code, runs after __construct()
    *
    * @return void
    */
   protected function initialize(): void
   {
       parent::initialize();

       $this->allowedFields = [
           ...$this->allowedFields,
           'display_name'
       ];

+        $this->returnType = User::class;
   }

But this does:

use CodeIgniter\Database\Exceptions\DataException;
use CodeIgniter\Entity\Cast\ObjectCast;
use CodeIgniter\Shield\Entities\User as EntitiesUser;
-use CodeIgniter\Shield\Entities\User;
+use App\Entities\UserEntity as User;
use CodeIgniter\Shield\Models\DatabaseException;
use CodeIgniter\Shield\Models\UserModel as ShieldUserModel;
use Exception;

/**
 * UserModel
 * 
 * Interacts with User database table
 */
final class UserModel extends ShieldUserModel
{
+    protected $returnType = User::class;

    /**
     * initialize
     * 
     * Class initialisation code, runs after __construct()
     *
     * @return void
     */
    protected function initialize(): void
    {
        parent::initialize();

        $this->allowedFields = [
            ...$this->allowedFields,
            'display_name'
        ];

-        $this->returnType = User::class;
    }

If anyone can explain why is this so, I'd appreciate it.