{"id":9110,"date":"2024-09-11T07:47:07","date_gmt":"2024-09-11T07:47:07","guid":{"rendered":"https:\/\/www.infinitivehost.com\/knowledge-base\/?p=9110"},"modified":"2024-09-11T11:38:12","modified_gmt":"2024-09-11T11:38:12","slug":"create-php-function-for-users-by-role-in-vtiger-7","status":"publish","type":"post","link":"https:\/\/www.infinitivehost.com\/knowledge-base\/create-php-function-for-users-by-role-in-vtiger-7\/","title":{"rendered":"Create PHP Function for Users by Role in Vtiger 7"},"content":{"rendered":"
<\/span> 1,729<\/span> Views<\/span><\/div>\n

To create a PHP custom function for retrieving all users based on a specific role in Vtiger CRM 7, you will use the Vtlib<\/strong> library, which is the framework for creating and managing custom modules and extensions in Vtiger.<\/p>\n\n\n\n

Steps to Create a Custom PHP Function to Get All Users by Role in Vtiger 7<\/strong><\/h3>\n\n\n\n

1. Understanding the Basics<\/strong><\/h4>\n\n\n\n

In Vtiger, roles are stored in the vtiger_role<\/mark><\/code> table, and users are stored in the vtiger_users<\/mark><\/code> table. The relationship between users and their roles is maintained in the vtiger_user2role<\/mark><\/code> table. To get users based on a specific role, you\u2019ll need to query these tables accordingly.<\/p>\n\n\n\n

2. Writing the Custom PHP Function<\/strong><\/h4>\n\n\n\n

Here\u2019s how you can write a custom PHP function using Vtlib<\/strong> to retrieve all users associated with a particular role.<\/p>\n\n\n\n

function getUsersByRole($roleId) {\n    global $adb; \/\/ Vtiger's global database connection object\n\n    \/\/ Sanitize input to prevent SQL injection\n    $roleId = $adb->sql_escape_string($roleId);\n\n    \/\/ Query to find users associated with the specific role\n    $query = \"SELECT vtiger_users.id, vtiger_users.user_name, vtiger_users.first_name, vtiger_users.last_name\n              FROM vtiger_users\n              INNER JOIN vtiger_user2role ON vtiger_user2role.userid = vtiger_users.id\n              WHERE vtiger_user2role.roleid = ? AND vtiger_users.status = 'Active'\";\n\n    \/\/ Execute the query using Vtiger's database API\n    $result = $adb->pquery($query, array($roleId));\n\n    \/\/ Initialize an array to hold user data\n    $users = array();\n\n    \/\/ Fetch results\n    if ($adb->num_rows($result) > 0) {\n        while ($row = $adb->fetch_array($result)) {\n            $users[] = array(\n                'id' => $row['id'],\n                'user_name' => $row['user_name'],\n                'first_name' => $row['first_name'],\n                'last_name' => $row['last_name']\n            );\n        }\n    }\n\n    return $users; \/\/ Return the list of users\n}<\/mark><\/code><\/code><\/pre>\n\n\n\n
3. Explanation of the Code<\/strong><\/h3>\n\n\n\n