Documentation

Deprecated
in package

Functions that need-rewrite / to be eliminated.

Table of Contents

checkFileAccess()  : mixed
Function to check the file access is made within web root directory.
checkFileAccessForDeletion()  : mixed
Function to check the file deletion within the deletable (safe) directories
checkFileAccessForInclusion()  : mixed
Function to check the file access is made within web root directory and whether it is not from unsafe directories
getColumnFields()  : array<string|int, mixed>
Gets fields for module.
getCurrentUserEntityFieldNameDisplay()  : string
this function returns the entity field name for a given module; for e.g. for Contacts module it return concat(lastname, ' ', firstname).
getFullNameFromArray()  : mixed
getPermittedModuleIdList()  : array<string|int, mixed>
Function to get the permitted module id Array with presence as 0.
getSettingsBlockId()  : int
This function is used to get the blockid of the settings block for a given label.
getSqlForNameInDisplayFormat()  : mixed
isFileAccessible()  : bool
function to return whether the file access is made within vtiger root directory and it exists.

Methods

checkFileAccess()

Function to check the file access is made within web root directory.

public static checkFileAccess(mixed $filepath) : mixed
Parameters
$filepath : mixed
Return values
mixed —

checkFileAccessForDeletion()

Function to check the file deletion within the deletable (safe) directories

public static checkFileAccessForDeletion(mixed $filepath) : mixed
Parameters
$filepath : mixed
Return values
mixed —

checkFileAccessForInclusion()

Function to check the file access is made within web root directory and whether it is not from unsafe directories

public static checkFileAccessForInclusion(mixed $filepath) : mixed
Parameters
$filepath : mixed
Return values
mixed —

getColumnFields()

Gets fields for module.

public static getColumnFields(string $module) : array<string|int, mixed>
Parameters
$module : string
Return values
array<string|int, mixed> —

getCurrentUserEntityFieldNameDisplay()

this function returns the entity field name for a given module; for e.g. for Contacts module it return concat(lastname, ' ', firstname).

public static getCurrentUserEntityFieldNameDisplay(mixed $module, mixed $fieldsName, mixed $fieldValues) : string
Parameters
$module : mixed
$fieldsName : mixed
$fieldValues : mixed
Tags
param1

$module - name of the module

param2

$fieldsName - fieldname with respect to module (ex : 'Accounts' - 'accountname', 'Contacts' - 'lastname','firstname')

param3

$fieldValues - array of fieldname and its value

Return values
string —

$fieldConcatName - the entity field name for the module

getFullNameFromArray()

public static getFullNameFromArray(mixed $module, mixed $fieldValues) : mixed
Parameters
$module : mixed
$fieldValues : mixed
Return values
mixed —

getPermittedModuleIdList()

Function to get the permitted module id Array with presence as 0.

public static getPermittedModuleIdList() : array<string|int, mixed>
Tags
global

Users $current_user

Return values
array<string|int, mixed> —

Array of accessible tabids

getSettingsBlockId()

This function is used to get the blockid of the settings block for a given label.

public static getSettingsBlockId(string $label) : int
Parameters
$label : string
Return values
int —

getSqlForNameInDisplayFormat()

public static getSqlForNameInDisplayFormat(mixed $input, mixed $module[, mixed $glue = ' ' ]) : mixed
Parameters
$input : mixed
$module : mixed
$glue : mixed = ' '
Return values
mixed —

isFileAccessible()

function to return whether the file access is made within vtiger root directory and it exists.

public static isFileAccessible(string $filepath) : bool
Parameters
$filepath : string

relative path to the file which need to be verified

Return values
bool —

true if file is a valid file within vtiger root directory, false otherwise


        

        
    




    

    

                

    

        

            
Search results