Documentation

RecordsList extends BaseAction
in package

Webservice standard container - Get users list class.

Table of Contents

$allowedHeaders  : array<string|int, mixed>
$allowedMethod  : array<string|int, string>
$controller  : Controller
$responseType  : string
$fields  : array<string|int, Vtiger_Field_Model>
$isAdmin  : bool
$queryGenerator  : QueryGenerator
$userData  : array<string|int, mixed>
checkAction()  : void
Check called action.
createQuery()  : void
Create query record list.
get()  : array<string|int, mixed>
Get users list method.
getLanguage()  : string
Get current language.
getParentCrmId()  : int|null
Get parent record.
getPermissionType()  : int
Get permission type.
getUserCrmId()  : int
Get crmid for portal user.
getUserData()  : mixed
Get user data and session data.
getUserStorageId()  : int
Get user storage ID.
preProcess()  : mixed
Pre process function.
setAllUserData()  : void
Set user data.
setUserData()  : void
Set user data.
updateSession()  : void
Update user session.
updateUser()  : void
Update user data.
checkLifetimeSession()  : void
Check lifetime user session.
checkPermission()  : void
Check permission to method.
checkPermissionToModule()  : void
Check permission to module.
getColumnNames()  : array<string|int, mixed>
Get column names.
getRawDataFromRow()  : array<string|int, mixed>
Get raw data from row.
getRecordFromRow()  : array<string|int, mixed>
Get record from row.
isRawData()  : bool
Check if you send raw data.
loadSession()  : void
Load user session data .

Properties

$allowedHeaders

public array<string|int, mixed> $allowedHeaders = ['x-condition', 'x-row-offset', 'x-row-limit', 'x-fields', 'x-order-by', 'x-parent-id']

Allowed headers

$allowedMethod

public array<string|int, string> $allowedMethod = ['GET']

Allowed methods

$responseType

public string $responseType = 'data'

Response data type.

$fields

protected array<string|int, Vtiger_Field_Model> $fields = []

Fields models instance.

$userData

private array<string|int, mixed> $userData = []

User data

Methods

checkAction()

Check called action.

public checkAction() : void
Tags
throws
Exception
Return values
void —

createQuery()

Create query record list.

public createQuery() : void
Tags
throws
Exception
Return values
void —

get()

Get users list method.

public get() : array<string|int, mixed>
Tags
OA\Get

( path="/webservice/WebserviceStandard/Users/RecordsList", description="Gets a list of all users", summary="List of users", tags={"Users"}, security={{"basicAuth" : }, "ApiKeyAuth" : }, "token" : }}}, @OA\Parameter(name="x-raw-data", in="header", @OA\Schema(type="integer", enum={0, 1}), description="Gets raw data", required=false, example=1), @OA\Parameter(name="x-row-limit", in="header", @OA\Schema(type="integer"), description="Get rows limit, default: 1000", required=false, example=1000), @OA\Parameter(name="x-row-offset", in="header", @OA\Schema(type="integer"), description="Offset, default: 0", required=false, example=0), @OA\Parameter(name="x-order-by", in="header", description="Set the sorted results by columns [Json format]", required=false, @OA\JsonContent(type="object", title="Sort conditions", description="Multiple or one condition for a query generator", example={"field_name_1" : "ASC", "field_name_2" : "DESC"}, @OA\AdditionalProperties(type="string", title="Sort Direction", enum={"ASC", "DESC"}), ), ), @OA\Parameter(name="x-fields", in="header", description="JSON array in the list of fields to be returned in response", required=false, @OA\JsonContent(type="array", example={"field_name_1", "field_name_2"}, @OA\Items(type="string")), ), @OA\Parameter(name="x-condition", in="header", description="Conditions [Json format]", required=false, @OA\JsonContent(ref="#/components/schemas/Conditions-Mix-For-Query-Generator"), ), @OA\Parameter(name="x-parent-id", in="header", @OA\Schema(type="integer"), description="Parent record id", required=false, example=5), @OA\Response(response=200, description="List of entries", @OA\JsonContent(ref="#/components/schemas/Users_RecordsList_ResponseBody"), @OA\XmlContent(ref="#/components/schemas/Users_RecordsList_ResponseBody"), ), @OA\Response(response=400, description="Incorrect json syntax: x-fields", @OA\JsonContent(ref="#/components/schemas/Exception"), @OA\XmlContent(ref="#/components/schemas/Exception"), ), @OA\Response(response=401, description="No sent token, Invalid token, Token has expired", @OA\JsonContent(ref="#/components/schemas/Exception"), @OA\XmlContent(ref="#/components/schemas/Exception"), ), @OA\Response(response=403, description="No permissions for module", @OA\JsonContent(ref="#/components/schemas/Exception"), @OA\XmlContent(ref="#/components/schemas/Exception"), ), @OA\Response(response=405, description="Invalid method", @OA\JsonContent(ref="#/components/schemas/Exception"), @OA\XmlContent(ref="#/components/schemas/Exception"), ), ),

OA\Schema

( schema="Users_RecordsList_ResponseBody", title="Users module - Response action users list", description="Module action record list response body", type="object", @OA\Property(property="status", type="integer", enum={0, 1}, description="A numeric value of 0 or 1 that indicates whether the communication is valid. 1 - success , 0 - error"), @OA\Property( property="result", description="List of records", type="object", @OA\Property( property="headers", description="Column names", type="object", @OA\AdditionalProperties, ), @OA\Property( property="records", description="Records display details", type="object", @OA\AdditionalProperties(type="object", ref="#/components/schemas/Record_Display_Details"), ), @OA\Property( property="rawData", description="Records raw details", type="object", @OA\AdditionalProperties(type="object", ref="#/components/schemas/Record_Raw_Details"), ), @OA\Property(property="count", type="integer", example=54), @OA\Property(property="isMorePages", type="boolean", example=true), ), ),

Return values
array<string|int, mixed> —

getLanguage()

Get current language.

public getLanguage() : string
Return values
string —

getParentCrmId()

Get parent record.

public getParentCrmId() : int|null
Tags
throws
Exception
Return values
int|null —

getPermissionType()

Get permission type.

public getPermissionType() : int
Return values
int —

getUserCrmId()

Get crmid for portal user.

public getUserCrmId() : int
Return values
int —

getUserData()

Get user data and session data.

public getUserData(string $key[, string $param = '' ]) : mixed
Parameters
$key : string
$param : string = ''
Return values
mixed —

getUserStorageId()

Get user storage ID.

public getUserStorageId() : int
Return values
int —

preProcess()

Pre process function.

public preProcess() : mixed
Return values
mixed —

setAllUserData()

Set user data.

public setAllUserData(array<string|int, mixed> $data) : void
Parameters
$data : array<string|int, mixed>
Return values
void —

setUserData()

Set user data.

public setUserData(string $key, mixed $value) : void
Parameters
$key : string
$value : mixed
Return values
void —

updateSession()

Update user session.

public updateSession([array<string|int, mixed> $data = [] ]) : void
Parameters
$data : array<string|int, mixed> = []
Return values
void —

updateUser()

Update user data.

public updateUser([array<string|int, mixed> $data = [] ]) : void
Parameters
$data : array<string|int, mixed> = []
Return values
void —

checkLifetimeSession()

Check lifetime user session.

protected checkLifetimeSession() : void
Tags
throws
Exception
Return values
void —

checkPermission()

Check permission to method.

protected checkPermission() : void
Tags
throws
Exception
Return values
void —

checkPermissionToModule()

Check permission to module.

protected checkPermissionToModule() : void
Tags
throws
Exception
Return values
void —

getColumnNames()

Get column names.

protected getColumnNames() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getRawDataFromRow()

Get raw data from row.

protected getRawDataFromRow(array<string|int, mixed> $row) : array<string|int, mixed>
Parameters
$row : array<string|int, mixed>
Return values
array<string|int, mixed> —

getRecordFromRow()

Get record from row.

protected getRecordFromRow(array<string|int, mixed> $row) : array<string|int, mixed>
Parameters
$row : array<string|int, mixed>
Return values
array<string|int, mixed> —

isRawData()

Check if you send raw data.

protected isRawData() : bool
Return values
bool —

loadSession()

Load user session data .

protected loadSession() : void
Tags
throws
Exception
Return values
void — 

        

        
    




    

    

                

    

        

            
Search results