Documentation

Module
in package

Modules basic class.

Tags
copyright

YetiForce Sp. z o.o

license

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

author

Mariusz Krzaczkowski m.krzaczkowski@yetiforce.com

author

Radosław Skrzypczak r.skrzypczak@yetiforce.com

Table of Contents

$isModuleActiveCache  : mixed
$tabdataCache  : array<string|int, mixed>
Cache for tabdata.php.
changeType()  : mixed
Function changes the module type.
createModuleMetaFile()  : mixed
Function to create file about modules.
getActionId()  : int|null
Function to get a action id for a given action name.
getAllEntityModuleInfo()  : mixed
getAllModuleNames()  : array<string|int, string>
Get all module names.
getAllModuleNamesFilter()  : array<string|int, string>
Get all module names by filter.
getEntitiesInfo()  : array<string|int, mixed>
Gets all entities data.
getEntityInfo()  : array<string|int, mixed>|null
Gets entity info.
getModuleId()  : bool|int
Get module id by module name.
getModuleMeta()  : array<string|int, mixed>
Get module meta data.
getModuleName()  : bool|string
Get module nane by module id.
getModuleOwner()  : int
Get module owner by module id.
getSharingModuleList()  : array<string|int, mixed>
Function to get the list of module for which the user defined sharing rules can be defined.
getSqlForNameInDisplayFormat()  : string
Get sql for name in display format.
init()  : mixed
Init tabdata from file.
initFromDb()  : mixed
Init tabdata form db.
isModuleActive()  : bool
Function to check whether the module is active.

Properties

$isModuleActiveCache

protected static mixed $isModuleActiveCache = []

$tabdataCache

Cache for tabdata.php.

protected static array<string|int, mixed> $tabdataCache

Methods

changeType()

Function changes the module type.

public static changeType(string $moduleName, int $type) : mixed
Parameters
$moduleName : string
$type : int
Return values
mixed

createModuleMetaFile()

Function to create file about modules.

public static createModuleMetaFile() : mixed
Tags
throws
NoPermitted
Return values
mixed

getActionId()

Function to get a action id for a given action name.

public static getActionId(string $action) : int|null
Parameters
$action : string
Return values
int|null

getAllEntityModuleInfo()

public static getAllEntityModuleInfo([mixed $sort = false ]) : mixed
Parameters
$sort : mixed = false
Return values
mixed

getAllModuleNames()

Get all module names.

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

getAllModuleNamesFilter()

Get all module names by filter.

public static getAllModuleNamesFilter([bool $isEntityType = true ][, bool $showRestricted = false ][, bool|int $presence = false ]) : array<string|int, string>
Parameters
$isEntityType : bool = true
$showRestricted : bool = false
$presence : bool|int = false
Return values
array<string|int, string>

getEntitiesInfo()

Gets all entities data.

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

getEntityInfo()

Gets entity info.

public static getEntityInfo([string $moduleName = null ]) : array<string|int, mixed>|null
Parameters
$moduleName : string = null
Return values
array<string|int, mixed>|null

getModuleId()

Get module id by module name.

public static getModuleId(string $moduleName) : bool|int
Parameters
$moduleName : string
Return values
bool|int

getModuleMeta()

Get module meta data.

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

getModuleName()

Get module nane by module id.

public static getModuleName(int $tabId) : bool|string
Parameters
$tabId : int
Return values
bool|string

getModuleOwner()

Get module owner by module id.

public static getModuleOwner(int $tabId) : int
Parameters
$tabId : int
Return values
int

getSharingModuleList()

Function to get the list of module for which the user defined sharing rules can be defined.

public static getSharingModuleList([array<string|int, mixed> $eliminateModules = false ]) : array<string|int, mixed>
Parameters
$eliminateModules : array<string|int, mixed> = false
Return values
array<string|int, mixed>

getSqlForNameInDisplayFormat()

Get sql for name in display format.

public static getSqlForNameInDisplayFormat(string $moduleName) : string
Parameters
$moduleName : string
Return values
string

init()

Init tabdata from file.

public static init() : mixed
Return values
mixed

initFromDb()

Init tabdata form db.

public static initFromDb() : mixed
Return values
mixed

isModuleActive()

Function to check whether the module is active.

public static isModuleActive(string $moduleName) : bool
Parameters
$moduleName : string
Return values
bool

        

Search results