Documentation

ModuleDatapointTopic
in package

Class ModuleDatapointTopic

This class manages the relationship between a module and datapoint topics. It provides functionality to list, create, and delete assignments for module ↔ datapoint_topic mapping.

Table of Contents

Properties

$db  : MySql

Methods

__construct()  : mixed
deleteAssignment()  : void
Soft delete a module ↔ datapoint_topic assignment (status = 9).
listOptions()  : array{module_code: string, checked_datapoint_topics: string[]}
List all datapoint_topic codes linked to a module.
saveAssignment()  : void
Create or reactivate a module ↔ datapoint_topic assignment.

Properties

Methods

deleteAssignment()

Soft delete a module ↔ datapoint_topic assignment (status = 9).

public deleteAssignment(array<string, mixed> $data) : void

Expects in $data:

  • module_code (string, required)
  • datapoint_topic_code (string, required)
  • modifiedby (string, required)
Parameters
$data : array<string, mixed>

listOptions()

List all datapoint_topic codes linked to a module.

public listOptions(string $moduleCode, array<string|int, int> $statuses) : array{module_code: string, checked_datapoint_topics: string[]}
Parameters
$moduleCode : string
$statuses : array<string|int, int>
Return values
array{module_code: string, checked_datapoint_topics: string[]}

saveAssignment()

Create or reactivate a module ↔ datapoint_topic assignment.

public saveAssignment(array<string, mixed> $data) : void

Expects in $data:

  • module_code (string, required)
  • datapoint_topic_code (string, required)
  • sort_order (int|null)
  • createdby (string, required)
  • modifiedby (string, required)
Parameters
$data : array<string, mixed>

        
On this page

Search results