UserModel.php

<?php

namespace App\Models;

use App\Entities\User;
use Faker\Generator;
use Myth\Auth\Entities\User as MythUser;
use Myth\Auth\Models\UserModel as MythModel;
use stdClass;

class UserModel extends MythModel
{
    use CompiledRowsTrait;

    protected $table       = 'users';
    protected $primaryKey  = 'id';
    protected $returnType  = User::class;
    protected $afterInsert = ['clearCompiledRows'];
    protected $afterUpdate = ['clearCompiledRows'];
    protected $afterDelete = ['clearCompiledRows'];

    /**
     * Add the extended properties.
     */
    protected function initialize()
    {
        // Merge properties with parent
        $this->allowedFields   = array_merge($this->allowedFields, ['firstname', 'lastname', 'balance']);
        $this->validationRules = array_merge($this->validationRules, [
            'firstname' => 'required|string',
            'lastname'  => 'required|string',
            'balance'   => 'permit_empty|integer',
        ]);
    }

    /**
     * Returns the IDs of all Users considered "staff".
     *
     * @return int[]
     */
    public function findStaffIds(): array
    {
        if (! $permission = model(PermissionModel::class)->where('name', 'manageAny')->first()) {
            return [];
        }

        $ids = $this->builder()
            ->select('users.id')
            ->join('auth_groups_users', 'users.id = auth_groups_users.user_id', 'left')
            ->join('auth_groups_permissions', 'auth_groups_permissions.group_id = auth_groups_users.group_id', 'left')
            ->where('auth_groups_permissions.permission_id', $permission->id)
            ->get()->getResultArray();

        return array_column($ids, 'id');
    }

    /**
     * Returns groups for a single user. Uses Myth:Auth's
     * GroupModel but converts the result to objects.
     *
     * @param int|string|null $userId
     *
     * @return stdClass[] Array of group objects
     */
    public function groups($userId = null): array
    {
        if (null === $userId) {
            return [];
        }

        if ($result = model(GroupModel::class)->getGroupsForUser($userId)) {
            // Convert the arrays to objects
            $result = array_map(static function ($row) {
                // Use the Group ID for the primary ID
                $row['id'] = $row['group_id'];

                return (object) $row;
            }, $result);
        }

        return $result;
    }

    /**
     * Fetch or build the compiled rows for browsing,
     * applying filters, and sorting.
     *
     * @return array[]
     */
    protected function fetchCompiledRows(): array
    {
        return $this->builder()
            ->select('users.*, auth_groups.id AS group_id, auth_groups.name as group')
            ->join('auth_groups_users', 'users.id = auth_groups_users.user_id', 'left')
            ->join('auth_groups', 'auth_groups_users.group_id = auth_groups.id', 'left')
            ->get()->getResultArray();
    }

    /**
     * Faked data for Fabricator.
     *
     * @return User
     */
    public function fake(Generator &$faker): MythUser
    {
        return new User([
            'email'     => $faker->email,
            'username'  => $faker->userName,
            'firstname' => $faker->firstName,
            'lastname'  => $faker->lastName,
            'password'  => bin2hex(random_bytes(24)),
            'balance'   => random_int(0, 1) ? random_int(100, 5000) : 0,
            'active'    => random_int(0, 20) ? 1 : 0,
        ]);
    }
}