Documentation

UserPrivilegesFile
in package

Create user privileges file class.

Tags
copyright

YetiForce S.A.

license

YetiForce Public License 6.5 (licenses/LicenseEN.txt or yetiforce.com)

Table of Contents

createUserPrivilegesfile()  : mixed
Creates a file with all the user, user-role,user-profile, user-groups informations.
createUserSharingPrivilegesfile()  : mixed
Creates a file with all the organization default sharing permissions and custom sharing permissins specific for the specified user.
getRelatedModuleSharingArray()  : array<string|int, mixed>
Gives an array which contains the information for what all roles, groups and user's related module data that is to be shared for the specified parent module and shared module.
populateRelatedSharingPrivileges()  : mixed
Function to populate the read/wirte Sharing permissions related module data for the specified user into the database.
populateSharingPrivileges()  : mixed
Function to populate the read/wirte Sharing permissions data for the specified user into the database.
populateSharingtmptables()  : mixed
Function to populate the read/wirte Sharing permissions data of user/groups for the specified user into the database.
recalculateAll()  : int
Function to recalculate the Sharing Rules for all the vtiger_users This function will recalculate all the sharing rules for all the vtiger_users in the Organization and will write them in flat vtiger_files.
reloadByMultiCompany()  : mixed
Reload user privileges file by multi company id.

Methods

createUserPrivilegesfile()

Creates a file with all the user, user-role,user-profile, user-groups informations.

public static createUserPrivilegesfile(int $userid) : mixed
Parameters
$userid : int
Tags
returns

User_Privileges_Userid file under the User_Privileges Directory

Return values
mixed

createUserSharingPrivilegesfile()

Creates a file with all the organization default sharing permissions and custom sharing permissins specific for the specified user.

public static createUserSharingPrivilegesfile(int $userid) : mixed

In this file the information of the other users whose data is shared with the specified user is stored.

Parameters
$userid : int
Tags
returns

sharing_privileges_userid file under the user_privileges directory

Return values
mixed

getRelatedModuleSharingArray()

Gives an array which contains the information for what all roles, groups and user's related module data that is to be shared for the specified parent module and shared module.

public static getRelatedModuleSharingArray(string $par_mod, string $share_mod, array<string|int, mixed> $mod_sharingrule_members, array<string|int, mixed> $mod_share_read_per, array<string|int, mixed> $mod_share_write_per, array<string|int, mixed> $def_org_share) : array<string|int, mixed>
Parameters
$par_mod : string
$share_mod : string
$mod_sharingrule_members : array<string|int, mixed>
$mod_share_read_per : array<string|int, mixed>
$mod_share_write_per : array<string|int, mixed>
$def_org_share : array<string|int, mixed>
Return values
array<string|int, mixed>

populateRelatedSharingPrivileges()

Function to populate the read/wirte Sharing permissions related module data for the specified user into the database.

public static populateRelatedSharingPrivileges(string $enttype, mixed $userId, string $module, string $relmodule, string $pertype[, bool $varArr = false ]) : mixed
Parameters
$enttype : string
$userId : mixed
$module : string
$relmodule : string
$pertype : string
$varArr : bool = false
Return values
mixed

populateSharingPrivileges()

Function to populate the read/wirte Sharing permissions data for the specified user into the database.

public static populateSharingPrivileges(string $enttype, int $userId, string $module, string $pertype[, bool $varArr = false ]) : mixed
Parameters
$enttype : string
$userId : int
$module : string
$pertype : string
$varArr : bool = false
Return values
mixed

populateSharingtmptables()

Function to populate the read/wirte Sharing permissions data of user/groups for the specified user into the database.

public static populateSharingtmptables(int $userid) : mixed
Parameters
$userid : int
Return values
mixed

recalculateAll()

Function to recalculate the Sharing Rules for all the vtiger_users This function will recalculate all the sharing rules for all the vtiger_users in the Organization and will write them in flat vtiger_files.

public static recalculateAll() : int
Return values
int

reloadByMultiCompany()

Reload user privileges file by multi company id.

public static reloadByMultiCompany(int $companyId) : mixed
Parameters
$companyId : int
Return values
mixed

        

Search results