Documentation

Hierarchy extends BaseAction
in package

Webservice premium container - Gets records hierarchy class.

Table of Contents

$allowedHeaders  : array<string|int, mixed>
$allowedMethod  : array<string|int, string>
$childField  : mixed
$controller  : Controller
$findId  : bool|int
$limit  : int
$mainField  : mixed
$moduleName  : string
$records  : mixed
$recursion  : mixed
$responseType  : string
$userData  : array<string|int, mixed>
checkAction()  : void
Check called action.
get()  : array<string|int, mixed>
Get method - Gets records hierarchy.
getLanguage()  : string
Get current language.
getParentCrmId()  : int|null
Get parent record.
getPermissionType()  : int
Get permission type.
getRecords()  : void
Get records in hierarchy.
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.
loadSession()  : void
Load user session data .

Properties

$allowedHeaders

public array<string|int, mixed> $allowedHeaders = []

Allowed headers

$allowedMethod

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

Allowed methods

$findId

public bool|int $findId = false

Search id in the hierarchy

$limit

public int $limit = 20

Recursion limit

$moduleName

public string $moduleName

Module name

$responseType

public string $responseType = 'data'

Response data type.

$userData

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

User data

Methods

checkAction()

Check called action.

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

get()

Get method - Gets records hierarchy.

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

( path="/webservice/WebservicePremium/{moduleName}/Hierarchy", summary="Gets records hierarchy", description="Hierarchy of records", tags={"BaseModule"}, security={{"basicAuth" : }, "ApiKeyAuth" : }, "token" : }}}, @OA\Parameter(name="moduleName", in="path", @OA\Schema(type="string"), description="Module name", required=true, example="Accounts"), @OA\Parameter(name="X-ENCRYPTED", in="header", @OA\Schema(ref="#/components/schemas/Header-Encrypted"), required=true), @OA\Response(response=200, description="Records hierarchy details", @OA\JsonContent(ref="#/components/schemas/BaseModule_Get_Hierarchy_Response"), @OA\XmlContent(ref="#/components/schemas/BaseModule_Get_Hierarchy_Response"), ), @OA\Response(response=405, description="No hierarchy OR Not available for this type of user", @OA\JsonContent(ref="#/components/schemas/Exception"), @OA\XmlContent(ref="#/components/schemas/Exception"), ), ),

OA\Schema

( schema="BaseModule_Get_Hierarchy_Response", title="Base module - Hierarchy response schema", 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="Records", type="object", @OA\AdditionalProperties( description="Record details", type="object", @OA\Property(property="id", type="integer", example=117), @OA\Property(property="parent", type="integer", example=0), @OA\Property(property="name", type="string", example="YetiForce S.A."), ), ), ),

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 —

getRecords()

Get records in hierarchy.

public getRecords(QueryGenerator $mainQueryGenerator, int $parentId[, string $type = 'child' ]) : void
Parameters
$mainQueryGenerator : QueryGenerator
$parentId : int
$type : string = 'child'
Return values
void —

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
Return values
void —

checkPermissionToModule()

Check permission to module.

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

loadSession()

Load user session data .

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

        

        
    




    

    

                

    

        

            
Search results