Relation
in package
Relation class.
Table of Contents
- clearCacheById() : void
- Function clear cache by module name.
- clearCacheByModule() : void
- Function clear cache by module name.
- getById() : array<string|int, mixed>
- Get relation by id.
- getByModule() : array<string|int, mixed>
- Get all relation for module.
- getRelationId() : int|null
- Get relation id by modules.
Methods
clearCacheById()
Function clear cache by module name.
public
static clearCacheById(string $relationId[, bool $parent = true ]) : void
Parameters
- $relationId : string
- $parent : bool = true
Return values
void —clearCacheByModule()
Function clear cache by module name.
public
static clearCacheByModule(string $moduleName[, bool $child = true ]) : void
Parameters
- $moduleName : string
- $child : bool = true
Return values
void —getById()
Get relation by id.
public
static getById(int $relationId) : array<string|int, mixed>
Parameters
- $relationId : int
Return values
array<string|int, mixed> —getByModule()
Get all relation for module.
public
static getByModule(string $moduleName[, bool|null $onlyActive = false ][, string|null $relatedModuleName = null ]) : array<string|int, mixed>
Parameters
- $moduleName : string
- $onlyActive : bool|null = false
- $relatedModuleName : string|null = null
Return values
array<string|int, mixed> —getRelationId()
Get relation id by modules.
public
static getRelationId(string $moduleName, string $relModuleName[, string|null $fieldName = null ]) : int|null
Parameters
- $moduleName : string
- $relModuleName : string
- $fieldName : string|null = null