Documentation

ModTracker
in package

Table of Contents

$ACTIVE  : mixed
$ARCHIVED  : mixed
$colorsActions  : array<string|int, mixed>
Colors actions.
$CONVERTTOACCOUNT  : mixed
$CREATED  : mixed
$DELETED  : mixed
$DISPLAYED  : mixed
$iconActions  : array<string|int, mixed>
Icon actions.
$LINK  : mixed
$SHOW_HIDDEN_DATA  : mixed
$TRANSFER_DELETE  : mixed
$TRANSFER_EDIT  : mixed
$TRANSFER_LINK  : mixed
$TRANSFER_UNLINK  : mixed
$TRASH  : mixed
$UNLINK  : mixed
$UPDATED  : mixed
Constant variables which indicates the status of the changed record.
disableTrackingForModule()  : mixed
Invoked to disable tracking for the module.
enableTrackingForModule()  : mixed
Invoked to enable tracking for the module.
getAllActionsTypes()  : mixed
getTrackingModules()  : array<string|int, string>
Function gives an array of module names for which tracking is enabled.
isModtrackerLinkPresent()  : mixed
Invoked to check if ModTracker links are enabled for the module.
isModulePresent()  : mixed
Invoked to check if the module is present in the table or not.
isTrackingEnabledForModule()  : mixed
Invoked to check if tracking is enabled or disabled for the module.
isViewPermitted()  : bool
This function checks access to the view.
linkRelation()  : mixed
Function is executed when adding related record.
moduleHandler()  : mixed
Invoked when special actions are performed on the module.
trackRelation()  : mixed
transferRelation()  : mixed
Transfer relation.
unLinkRelation()  : mixed
Function is executed when removing related record.

Properties

$colorsActions

Colors actions.

public static array<string|int, mixed> $colorsActions = [0 => '#9c27b0', 1 => '#ab0505', 2 => '#607d8b', 3 => '#009405', 4 => '#009cb9', 5 => '#de9100', 6 => '#e2e3e5', 7 => '#65a9ff', 8 => '#0032a2', 9 => '#000', 10 => '#000', 11 => '#000', 12 => '#000', 13 => '#000', 14 => '#000']

$CONVERTTOACCOUNT

public static mixed $CONVERTTOACCOUNT = 6

$iconActions

Icon actions.

public static array<string|int, mixed> $iconActions = [0 => 'yfi yfi-full-editing-view', 1 => 'fas fa-trash-alt', 2 => 'fas fa-plus', 3 => 'fas fa-undo-alt', 4 => 'fas fa-link', 5 => 'fas fa-unlink', 6 => 'fas fa-exchange-alt', 7 => 'fas fa-th-list', 8 => 'fas fa-archive', 9 => 'fas fa-eraser', 10 => 'yfi yfi-full-editing-view', 11 => 'fas fa-trash-alt', 12 => 'fas fa-unlink', 13 => 'fas fa-link', 14 => 'fas fa-eye']

$SHOW_HIDDEN_DATA

public static mixed $SHOW_HIDDEN_DATA = 14

$TRANSFER_DELETE

public static mixed $TRANSFER_DELETE = 11

$TRANSFER_EDIT

public static mixed $TRANSFER_EDIT = 10
public static mixed $TRANSFER_LINK = 13
public static mixed $TRANSFER_UNLINK = 12

$UPDATED

Constant variables which indicates the status of the changed record.

public static mixed $UPDATED = 0

Methods

disableTrackingForModule()

Invoked to disable tracking for the module.

public disableTrackingForModule(int $tabid) : mixed
Parameters
$tabid : int
Return values
mixed

enableTrackingForModule()

Invoked to enable tracking for the module.

public enableTrackingForModule(int $tabid) : mixed
Parameters
$tabid : int
Return values
mixed

getAllActionsTypes()

public static getAllActionsTypes() : mixed
Return values
mixed

getTrackingModules()

Function gives an array of module names for which tracking is enabled.

public static getTrackingModules() : array<string|int, string>
Return values
array<string|int, string>

isModtrackerLinkPresent()

Invoked to check if ModTracker links are enabled for the module.

public static isModtrackerLinkPresent(int $tabid) : mixed
Parameters
$tabid : int
Return values
mixed

isModulePresent()

Invoked to check if the module is present in the table or not.

public static isModulePresent(int $tabId) : mixed
Parameters
$tabId : int
Return values
mixed

isTrackingEnabledForModule()

Invoked to check if tracking is enabled or disabled for the module.

public static isTrackingEnabledForModule(string $moduleName) : mixed
Parameters
$moduleName : string
Return values
mixed

isViewPermitted()

This function checks access to the view.

public static isViewPermitted(LinkData $linkData) : bool
Parameters
$linkData : LinkData
Return values
bool

linkRelation()

Function is executed when adding related record.

public static linkRelation(string $sourceModule, int $sourceId, string $targetModule, int $targetId) : mixed
Parameters
$sourceModule : string
$sourceId : int
$targetModule : string
$targetId : int
Return values
mixed

moduleHandler()

Invoked when special actions are performed on the module.

public moduleHandler(string $moduleName, string $eventType) : mixed
Parameters
$moduleName : string
$eventType : string
Return values
mixed

trackRelation()

public static trackRelation(mixed $sourceModule, mixed $sourceId, mixed $targetModule, mixed $targetId, mixed $type) : mixed
Parameters
$sourceModule : mixed
$sourceId : mixed
$targetModule : mixed
$targetId : mixed
$type : mixed
Return values
mixed

transferRelation()

Transfer relation.

public static transferRelation(string $sourceModule, int $sourceId, string $targetModule, int $targetId, int $process) : mixed
Parameters
$sourceModule : string
$sourceId : int
$targetModule : string
$targetId : int
$process : int
Return values
mixed

unLinkRelation()

Function is executed when removing related record.

public static unLinkRelation(string $sourceModule, int $sourceId, string $targetModule, int $targetId) : mixed
Parameters
$sourceModule : string
$sourceId : int
$targetModule : string
$targetId : int
Return values
mixed

Search results