Function descriptions

Function “lmb_favoriteFile()”

Estimated reading: 1 minute

lmb_favoriteFile

boolean lmb_favoriteFile(numeric $ID, numeric $user_id=null,numeric $action=1,numeric $level=null)

Function for adding a file to favorites in the DMS (./limbas_src/extra/explorer/filestructure.lib)

Parameters

Summary of the parameters:

  • $ID : ID of the file that should be processed
  • $user_id : User ID
  • $action : Action – add / remove
  • $level : Folder ID

$ID

ID of the file that should be added to/ removed from favorites

$user_id

ID of the user to whose favorites the file should be added to. Default is the editing user.

$action

  • 1 = add to favorites
  • 2 = remove from favorites

$level

Folder ID – Alternatively a folder can be added to or removed from favorites instead of a file. If $ID and $level are provided, the file will be added as a/ removed from favorite.

Return value

TRUE if successful

Share this Doc

Function “lmb_favoriteFile()”

Or copy link

CONTENTS