GroupModel.php

<?php namespace Myth\Auth\Authorization;

use CodeIgniter\Model;

class GroupModel extends Model
{
    protected $table = 'auth_groups';
    protected $primaryKey = 'id';

    protected $allowedFields = [
        'name', 'description'
    ];

    protected $useTimestamps = false;

    protected $validationRules = [
        'name' => 'required|max_length[255]|is_unique[auth_groups.name,name,{name}]',
        'description' => 'max_length[255',
    ];
    protected $validationMessages = [];
    protected $skipValidation = false;

    //--------------------------------------------------------------------
    // Users
    //--------------------------------------------------------------------

    /**
     * Adds a single user to a single group.
     *
     * @param $userId
     * @param $groupId
     *
     * @return object
     */
    public function addUserToGroup(int $userId, int $groupId)
    {
        $data = [
            'user_id'   => (int)$userId,
            'group_id'  => (int)$groupId
        ];

        return $this->db->insert('auth_groups_users', $data);
    }

    /**
     * Removes a single user from a single group.
     *
     * @param $userId
     * @param $groupId
     *
     * @return bool
     */
    public function removeUserFromGroup(int $userId, $groupId)
    {
        return $this->db->where([
            'user_id' => (int)$userId,
            'group_id' => (int)$groupId
        ])->delete('auth_groups_users');
    }

    /**
     * Removes a single user from all groups.
     *
     * @param $userId
     *
     * @return mixed
     */
    public function removeUserFromAllGroups(int $userId)
    {
        return $this->db->where('user_id', (int)$userId)
            ->delete('auth_groups_users');
    }

    /**
     * Returns an array of all groups that a user is a member of.
     *
     * @param $userId
     *
     * @return object
     */
    public function getGroupsForUser(int $userId)
    {
        return $this->select('auth_groups_users.*, auth_groups.name, auth_groups.description')
            ->join('auth_groups_users', 'auth_groups_users.group_id = auth_groups.id', 'left')
            ->where('user_id', $userId)
            ->as_array()
            ->find_all();
    }


    //--------------------------------------------------------------------
    // Permissions
    //--------------------------------------------------------------------

    /**
     * Add a single permission to a single group, by IDs.
     *
     * @param $permissionId
     * @param $groupId
     *
     * @return mixed
     */
    public function addPermissionToGroup(int $permissionId, int $groupId)
    {
        $data = [
            'permission_id' => (int)$permissionId,
            'group_id'      => (int)$groupId
        ];

        return $this->db->insert('auth_groups_permissions', $data);
    }

    //--------------------------------------------------------------------


    /**
     * Removes a single permission from a single group.
     *
     * @param $permissionId
     * @param $groupId
     *
     * @return mixed
     */
    public function removePermissionFromGroup(int $permissionId, int $groupId)
    {
        return $this->db->where([
            'permission_id' => $permissionId,
            'group_id'      => $groupId
        ])->delete('auth_groups_permissions');
    }

    //--------------------------------------------------------------------

    /**
     * Removes a single permission from all groups.
     *
     * @param $permissionId
     *
     * @return mixed
     */
    public function removePermissionFromAllGroups(int $permissionId)
    {
        return $this->db->where('permission_id', $permissionId)
            ->delete('auth_groups_permissions');
    }
}