ModuleHierarchy
in package
Modules hierarchy basic class.
Tags
Table of Contents
- $hierarchy : mixed
- $modulesByLevels : mixed
- accessModulesByLevel() : mixed
- accessModulesByParent() : mixed
- getChildModules() : array<string|int, string>
- Get child modules.
- getFieldsForListFilter() : array<string|int, mixed>
- Get fields for list filter.
- getHierarchyByRelation() : array<string|int, mixed>
- Get hierarchy info by relation.
- getMappingRelatedField() : mixed
- getModuleLevel() : mixed
- getModulesByLevel() : mixed
- getModulesByUitype() : array<string|int, mixed>
- Get modules list by uitype field.
- getModulesHierarchy() : mixed
- getModulesMap1M() : mixed
- getModulesMapMMBase() : mixed
- getModulesMapMMCustom() : mixed
- getQueryRelatedRecords() : Query|null
- Get related query by hierarchy.
- getRelatedRecords() : array<string|int, int>
- Get related records by hierarchy.
- getRelationFieldByHierarchy() : array<string|int, mixed>
- The function takes a hierarchy relationship.
- getUitypeByModule() : mixed
- init() : mixed
- getRelatedRecordsByField() : array<string|int, int>
- Get related records by field.
- getQueriesForRelatedRecords() : array<string|int, mixed>
- Function to get array of queries. Quries are used to create union.
Properties
$hierarchy
protected
static mixed
$hierarchy
$modulesByLevels
protected
static mixed
$modulesByLevels
= []
Methods
accessModulesByLevel()
public
static accessModulesByLevel(mixed $level[, mixed $actionName = 'EditView' ]) : mixed
Parameters
- $level : mixed
- $actionName : mixed = 'EditView'
Return values
mixed —accessModulesByParent()
public
static accessModulesByParent(mixed $parent[, mixed $actionName = 'EditView' ]) : mixed
Parameters
- $parent : mixed
- $actionName : mixed = 'EditView'
Return values
mixed —getChildModules()
Get child modules.
public
static getChildModules(string $moduleName[, array<string|int, int> $hierarchy = [1] ]) : array<string|int, string>
Parameters
- $moduleName : string
- $hierarchy : array<string|int, int> = [1]
Return values
array<string|int, string> —getFieldsForListFilter()
Get fields for list filter.
public
static getFieldsForListFilter(string $moduleName) : array<string|int, mixed>
Parameters
- $moduleName : string
Return values
array<string|int, mixed> —getHierarchyByRelation()
Get hierarchy info by relation.
public
static getHierarchyByRelation([int|null $relationId = null ]) : array<string|int, mixed>
Parameters
- $relationId : int|null = null
Return values
array<string|int, mixed> —getMappingRelatedField()
public
static getMappingRelatedField(mixed $moduleName) : mixed
Parameters
- $moduleName : mixed
Return values
mixed —getModuleLevel()
public
static getModuleLevel(mixed $moduleName) : mixed
Parameters
- $moduleName : mixed
Return values
mixed —getModulesByLevel()
public
static getModulesByLevel([mixed $level = null ]) : mixed
Parameters
- $level : mixed = null
Return values
mixed —getModulesByUitype()
Get modules list by uitype field.
public
static getModulesByUitype(int $uitype) : array<string|int, mixed>
Parameters
- $uitype : int
Return values
array<string|int, mixed> —getModulesHierarchy()
public
static getModulesHierarchy() : mixed
Return values
mixed —getModulesMap1M()
public
static getModulesMap1M(mixed $moduleName) : mixed
Parameters
- $moduleName : mixed
Return values
mixed —getModulesMapMMBase()
public
static getModulesMapMMBase() : mixed
Return values
mixed —getModulesMapMMCustom()
public
static getModulesMapMMCustom(mixed $moduleName) : mixed
Parameters
- $moduleName : mixed
Return values
mixed —getQueryRelatedRecords()
Get related query by hierarchy.
public
static getQueryRelatedRecords(int $record, array<string|int, mixed> $hierarchy) : Query|null
Parameters
- $record : int
- $hierarchy : array<string|int, mixed>
Return values
Query|null —getRelatedRecords()
Get related records by hierarchy.
public
static getRelatedRecords(int $record, array<string|int, mixed> $hierarchy) : array<string|int, int>
Parameters
- $record : int
- $hierarchy : array<string|int, mixed>
Return values
array<string|int, int> —getRelationFieldByHierarchy()
The function takes a hierarchy relationship.
public
static getRelationFieldByHierarchy(string $moduleName[, bool $field = false ]) : array<string|int, mixed>
Parameters
- $moduleName : string
- $field : bool = false
Return values
array<string|int, mixed> —getUitypeByModule()
public
static getUitypeByModule(mixed $moduleName) : mixed
Parameters
- $moduleName : mixed
Return values
mixed —init()
public
static init() : mixed
Return values
mixed —getRelatedRecordsByField()
Get related records by field.
protected
static getRelatedRecordsByField(int $record, array<string|int, mixed> $field) : array<string|int, int>
Parameters
- $record : int
- $field : array<string|int, mixed>
Return values
array<string|int, int> —getQueriesForRelatedRecords()
Function to get array of queries. Quries are used to create union.
private
static getQueriesForRelatedRecords(int $record, string $moduleName, array<string|int, mixed> $hierarchy[, Query $subQuery = null ]) : array<string|int, mixed>
Parameters
- $record : int
- $moduleName : string
- $hierarchy : array<string|int, mixed>
- $subQuery : Query = null