Module
in package
The Module class provides functionalities to interact with the `module` database table.
It includes methods for retrieving, creating, and updating modules, as well as methods for fetching associated hierarchies (sections) by module and company codes.
Table of Contents
Constants
- SECTION_REFERENCE_TYPE_CODE = 'HIER'
Properties
Methods
- __construct() : mixed
- createByAdmin() : void
- Create a new module (admin).
- getAll() : array<int, array<string, mixed>>
- Get all modules by status.
- getByCode() : array<string, mixed>
- Get a single module by its code.
- getCompanySections() : array<int, array<string, mixed>>
- Get company-specific sections (hierarchies) for a module.
- getDefaultSections() : array<int, array<string, mixed>>
- Get default sections (hierarchies) for a module.
- updateByCode() : void
- Update a module by its code (admin).
Constants
SECTION_REFERENCE_TYPE_CODE
private
mixed
SECTION_REFERENCE_TYPE_CODE
= 'HIER'
Properties
$mySql
protected
MySql
$mySql
Methods
__construct()
public
__construct(MySql $mySql) : mixed
Parameters
- $mySql : MySql
createByAdmin()
Create a new module (admin).
public
createByAdmin(array<string, mixed> $data) : void
Parameters
- $data : array<string, mixed>
getAll()
Get all modules by status.
public
getAll(array<string|int, int> $statuses) : array<int, array<string, mixed>>
Parameters
- $statuses : array<string|int, int>
Return values
array<int, array<string, mixed>>getByCode()
Get a single module by its code.
public
getByCode(string $moduleCode) : array<string, mixed>
Parameters
- $moduleCode : string
Return values
array<string, mixed>getCompanySections()
Get company-specific sections (hierarchies) for a module.
public
getCompanySections(string $moduleCode, string $companyCode) : array<int, array<string, mixed>>
Parameters
- $moduleCode : string
- $companyCode : string
Return values
array<int, array<string, mixed>>getDefaultSections()
Get default sections (hierarchies) for a module.
public
getDefaultSections(string $moduleCode) : array<int, array<string, mixed>>
Parameters
- $moduleCode : string
Return values
array<int, array<string, mixed>>updateByCode()
Update a module by its code (admin).
public
updateByCode(array<string, mixed> $data) : void
Parameters
- $data : array<string, mixed>