LinkItEngine: Business logic of the LinkIt application

In moturoa/linkitr: LinkIt as an R package

Business logic of the LinkIt application

Description

An R6 object with methods for use in the Shiny application 'ede_linkt_app', and 'ede-izm_frontend'.

Methods

Public methods

• LinkItEngine$new()

• LinkItEngine$list_tables()

• LinkItEngine$close()

• LinkItEngine$read_table()

• LinkItEngine$append_data()

• LinkItEngine$query()

• LinkItEngine$execute_query()

• LinkItEngine$delete_rows_where()

• LinkItEngine$delete_rows_where2()

• LinkItEngine$replace_value_where()

• LinkItEngine$get_con()

• LinkItEngine$has_value()

• LinkItEngine$make_choices()

• LinkItEngine$add_user()

• LinkItEngine$username_from_userid()

• LinkItEngine$is_admin()

• LinkItEngine$get_favorites()

• LinkItEngine$is_favorite()

• LinkItEngine$format_dossierid()

• LinkItEngine$add_favorite()

• LinkItEngine$delete_favorite()

• LinkItEngine$toggle_favorite()

• LinkItEngine$laatste_login()

• LinkItEngine$next_dossier_id()

• LinkItEngine$add_dossier()

• LinkItEngine$get_dossier()

• LinkItEngine$get_my_active_dossiers()

• LinkItEngine$get_all_active_dossiers()

• LinkItEngine$get_verwijderde_dossiers()

• LinkItEngine$get_personen_active_dossiers()

• LinkItEngine$dossier_naam_from_id()

• LinkItEngine$delete_dossier()

• LinkItEngine$verwijder_dossier()

• LinkItEngine$undo_verwijder_dossier()

• LinkItEngine$dossier_exists()

• LinkItEngine$log_audit()

• LinkItEngine$get_audit()

• LinkItEngine$is_object_in_dossier()

• LinkItEngine$add_object_to_dossier()

• LinkItEngine$remove_object_from_dossier()

• LinkItEngine$add_persoon_kenmerken()

• LinkItEngine$add_unknown_person()

• LinkItEngine$get_persoon()

• LinkItEngine$edit_unknown_persoon()

• LinkItEngine$add_unknown_location()

• LinkItEngine$delete_unknown_location()

• LinkItEngine$get_unknown_location()

• LinkItEngine$set_adres_as_hoofdadres()

• LinkItEngine$set_object_relations()

• LinkItEngine$get_object_kenmerk()

• LinkItEngine$set_object_kenmerk()

• LinkItEngine$get_objects()

• LinkItEngine$add_dossier_kenmerken()

• LinkItEngine$get_dossier_kenmerken()

• LinkItEngine$replace_dossier_kenmerken()

• LinkItEngine$get_dossierid_dossier_kenmerken()

• LinkItEngine$add_coordinatoren()

• LinkItEngine$delete_dossier_coordinatoren()

• LinkItEngine$replace_dossier_coordinatoren()

• LinkItEngine$get_coordinatoren()

• LinkItEngine$get_dossierid_coordinatoren()

• LinkItEngine$encrypt()

• LinkItEngine$decrypt()

• LinkItEngine$clone()

---

Method new()

Usage

LinkItEngine$new(gemeente, schema, pool, config_file = "conf/config.yml")

---

Method list_tables()

Usage

LinkItEngine$list_tables()

---

Method close()

Usage

LinkItEngine$close()

---

Method read_table()

Usage

LinkItEngine$read_table(table, lazy = FALSE)

---

Method append_data()

Usage

LinkItEngine$append_data(table, data)

---

Method query()

Usage

LinkItEngine$query(txt, glue = TRUE)

---

Method execute_query()

Usage

LinkItEngine$execute_query(txt, glue = TRUE)

---

Method delete_rows_where()

Usage

LinkItEngine$delete_rows_where(table, col_compare, val_compare)

---

Method delete_rows_where2()

Usage

LinkItEngine$delete_rows_where2(
  table,
  col_compare,
  val_compare,
  col_compare2,
  val_compare2
)

---

Method replace_value_where()

Usage

LinkItEngine$replace_value_where(
  table,
  col_replace,
  val_replace,
  col_compare,
  val_compare
)

---

Method get_con()

Usage

LinkItEngine$get_con()

---

Method has_value()

Usage

LinkItEngine$has_value(table, column, value)

---

Method make_choices()

Usage

LinkItEngine$make_choices(values_from, names_from = values_from, data = NULL)

---

Method add_user()

Usage

LinkItEngine$add_user(userid, role = 1, username)

---

Method username_from_userid()

Usage

LinkItEngine$username_from_userid(userid)

---

Method is_admin()

Usage

LinkItEngine$is_admin(userid)

---

Method get_favorites()

Usage

LinkItEngine$get_favorites(userid)

---

Method is_favorite()

Usage

LinkItEngine$is_favorite(userid, dossierid)

---

Method format_dossierid()

Usage

LinkItEngine$format_dossierid(id)

---

Method add_favorite()

Usage

LinkItEngine$add_favorite(userid, dossierid)

---

Method delete_favorite()

Usage

LinkItEngine$delete_favorite(userid, dossierid)

---

Method toggle_favorite()

Toggle favorie dossier for a user

Usage

LinkItEngine$toggle_favorite(userid, dossierid)

Details

Delete the favorite if the dossier is a favorite, otherwise add it.

Returns

TRUE if successful.

---

Method laatste_login()

Usage

LinkItEngine$laatste_login(userid)

---

Method next_dossier_id()

Usage

LinkItEngine$next_dossier_id()

---

Method add_dossier()

Make a new dossier, write to DB

Usage

LinkItEngine$add_dossier(
  dossiername,
  userid,
  aanmaakdatum,
  verloopdatum,
  betrokkeninstanties,
  id = NULL
)

Arguments

dossiername

Name of the dossier (char)

userid

Current user (char)

aanmaakdatum

Creation date (posixct)

verloopdatum

Expiry date (posixct)

betrokkeninstanties

(char)

Returns

The (usually new) ID of the dossier.

---

Method get_dossier()

Get a dossier based on its ID

Usage

LinkItEngine$get_dossier(dossierid)

---

Method get_my_active_dossiers()

Retrieves dossiers for a user 'Actief' or 'Volgen' status for

Usage

LinkItEngine$get_my_active_dossiers(userid)

---

Method get_all_active_dossiers()

Find all dossiers with 'Actief' or 'Volgen' status

Usage

LinkItEngine$get_all_active_dossiers()

---

Method get_verwijderde_dossiers()

Find all dossiers with 'Verwijderd' status Retrieve all pseudo-BSNs of all persons in active dossiers for the current user.

Usage

LinkItEngine$get_verwijderde_dossiers()

---

Method get_personen_active_dossiers()

Usage

LinkItEngine$get_personen_active_dossiers(
  userid = NULL,
  method = c("current_user", "all")
)

Returns

Vector of pseudo-BSNs

---

Method dossier_naam_from_id()

Find the name of a dossier based on its ID

Usage

LinkItEngine$dossier_naam_from_id(dossierid)

---

Method delete_dossier()

Really delete a dossier.

Usage

LinkItEngine$delete_dossier(dossierid)

---

Method verwijder_dossier()

Set status dossier to 'Verwijderd'

Usage

LinkItEngine$verwijder_dossier(dossierid)

---

Method undo_verwijder_dossier()

Undo verwijder_dossier

Usage

LinkItEngine$undo_verwijder_dossier(dossierid)

---

Method dossier_exists()

Does the given Dossier ID actually exist?

Usage

LinkItEngine$dossier_exists(dossierid)

---

Method log_audit()

Log an audit action

Usage

LinkItEngine$log_audit(userid, dossierid, actie, pseudo_bsn = "")

---

Method get_audit()

Get dossier kenmerken for a dossierid

Usage

LinkItEngine$get_audit(dossierid)

---

Method is_object_in_dossier()

Is this objectinstance a member of dossier?

Usage

LinkItEngine$is_object_in_dossier(objectinstance, dossierid)

Returns

TRUE if object is in the dossier, FALSE otherwise.

---

Method add_object_to_dossier()

Add person(s) (who has a BSN) to a dossier

Usage

LinkItEngine$add_object_to_dossier(
  ids,
  dossierid,
  userid,
  type = c("bsn_persoon", "onbekend_persoon", "bag_locatie", "onbekend_locatie"),
  dossierid_check = TRUE
)

Arguments

ids

Vector of pseudo-BSNs, or persoon-IDs (in case of unknown persons)

dossierid

Dossier ID (char)

userid

The current user (for audit trail)

Returns

TRUE if successful, FALSE if object already added to dossier.

---

Method remove_object_from_dossier()

Remove an object from a dossier

Usage

LinkItEngine$remove_object_from_dossier(ids, dossierid, userid)

---

Method add_persoon_kenmerken()

Add kenmerken to a persoon

Usage

LinkItEngine$add_persoon_kenmerken(
  dossierid,
  id,
  geboortedatum = "",
  geslacht = ""
)

---

Method add_unknown_person()

Register a new 'unknown' person

Usage

LinkItEngine$add_unknown_person(
  name,
  adresseerbaarobject = NULL,
  locatieid = "",
  woonadresomschrijving = ""
)

Returns

The new ID of the person

---

Method get_persoon()

Get a person (an unknown person) by ID

Usage

LinkItEngine$get_persoon(id)

---

Method edit_unknown_persoon()

Update name, BSN of an unknown person

Usage

LinkItEngine$edit_unknown_persoon(id, naam, bsn)

---

Method add_unknown_location()

Register an 'unknown' location

Usage

LinkItEngine$add_unknown_location(
  locatieomschrijving,
  wijk = "",
  buurt = "",
  postcode = "",
  straatnaam = "",
  huisnummer = "",
  huisnummertoevoeging = "",
  plaatsnaam = ""
)

Arguments

locatieomschrijving

Description of the location - mandatory

wijk

Optional

buurt

Optional

postcode

Optional

straatnaam

Optional

Returns

The new ID of the location

---

Method delete_unknown_location()

Usage

LinkItEngine$delete_unknown_location(id)

---

Method get_unknown_location()

Usage

LinkItEngine$get_unknown_location(id)

---

Method set_adres_as_hoofdadres()

Make an adres the hoofdadres of the dossier

Usage

LinkItEngine$set_adres_as_hoofdadres(dossierid, objectinstance)

---

Method set_object_relations()

Fill 'relation' and 'related_to' column for an object (typically, person) in a dossier.

Usage

LinkItEngine$set_object_relations(
  dossierid,
  objectinstance,
  relation,
  related_to
)

---

Method get_object_kenmerk()

Get kenmerk column for an object in a dossier.

Usage

LinkItEngine$get_object_kenmerk(dossierid, objectinstance)

Arguments

dossierid

The dossier ID (integer)

objectinstance

The object ID instance.

---

Method set_object_kenmerk()

Fill 'kenmerk' column for an object in a dossier.

Usage

LinkItEngine$set_object_kenmerk(dossierid, objectinstance, kenmerk)

Arguments

kenmerk

Text field (no validation)

---

Method get_objects()

Get all objects in a dossier

Usage

LinkItEngine$get_objects(dossierid)

Arguments

dossierid

The dossier ID (integer)

---

Method add_dossier_kenmerken()

Save kenmerktypes for a dossier

Usage

LinkItEngine$add_dossier_kenmerken(dossierid, kenmerktypeid, userid)

Arguments

dossierid

The dossier ID

A

vector of kenmerktypes

---

Method get_dossier_kenmerken()

Get dossier kenmerken for a dossierid

Usage

LinkItEngine$get_dossier_kenmerken(dossierid)

---

Method replace_dossier_kenmerken()

Replace kenmerken for a dossier

Usage

LinkItEngine$replace_dossier_kenmerken(dossierid, kenmerktypeid, userid)

---

Method get_dossierid_dossier_kenmerken()

Get dossierid's for given dossierkenmerken

Usage

LinkItEngine$get_dossierid_dossier_kenmerken(kenmerken)

Arguments

coordinatoren

A vector of coordinatoren userid's.

Returns

A vector of dossierid's

---

Method add_coordinatoren()

Write coordinatoren for a dossier.

Usage

LinkItEngine$add_coordinatoren(dossierid, userid)

---

Method delete_dossier_coordinatoren()

Usage

LinkItEngine$delete_dossier_coordinatoren(dossierid)

---

Method replace_dossier_coordinatoren()

Usage

LinkItEngine$replace_dossier_coordinatoren(dossierid, userid)

---

Method get_coordinatoren()

Get coordinatoren for a dossierid

Usage

LinkItEngine$get_coordinatoren(dossierid)

---

Method get_dossierid_coordinatoren()

Get dossierid's for given coordinatoren

Usage

LinkItEngine$get_dossierid_coordinatoren(coordinatoren)

Arguments

coordinatoren

A vector of coordinatoren userid's.

Returns

A vector of dossierid's

---

Method encrypt()

Encrypt a value using a secret

Usage

LinkItEngine$encrypt(x, secret = getOption("linkit_secret"))

Arguments

x

A vector of values to encrypt

secret

The secret to use, set options(linkit_secret = "abc")

Details

A vectorized version of 'safer::encrypt_string'

---

Method decrypt()

Decrypt a value using a secret

Usage

LinkItEngine$decrypt(x, secret = getOption("linkit_secret"))

Arguments

x

A vector of values to decrypt

secret

The secret to use, set options(linkit_secret = "abc")

Details

A vectorized version of 'safer::decrypt_string'. Missing values and empty strings are returned unchanged.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

LinkItEngine$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

moturoa/linkitr documentation built on April 15, 2023, 2 p.m.