opendocman_api
no way to compare when less than two revisions
Differences
This shows you the differences between two versions of the page.
Last revision | |||
— | opendocman_api [2018/12/17 11:39] – created - external edit 127.0.0.1 | ||
---|---|---|---|
Line 1: | Line 1: | ||
+ | ====== OpenDocMan™ Plug-in API ====== | ||
+ | ===== onAdminMenu() ===== | ||
+ | This function allows for new admin menu items to display for your plugin | ||
+ | |||
+ | Used in: | ||
+ | * admin.php | ||
+ | |||
+ | ===== onBeforeAdd() ===== | ||
+ | This function is run on the Add File page | ||
+ | |||
+ | Used in: | ||
+ | * add.php | ||
+ | |||
+ | ===== onDuringAdd($fileId) ===== | ||
+ | This function is run on while the file is being added to the database | ||
+ | |||
+ | Parameters: | ||
+ | * fileId | ||
+ | |||
+ | Used in: | ||
+ | * add.php | ||
+ | |||
+ | ===== onAfterAdd($fileId) ===== | ||
+ | This function is run after a new file is added | ||
+ | |||
+ | Parameters: | ||
+ | * fileId | ||
+ | |||
+ | Used in: | ||
+ | * add.php | ||
+ | |||
+ | ===== onBeforeEditFile($fileId) ===== | ||
+ | This function is run before the edit file form is finished being rendered | ||
+ | |||
+ | Parameters: | ||
+ | * fileId | ||
+ | |||
+ | Used in: | ||
+ | * edit.php | ||
+ | |||
+ | ===== onAfterEditFile($fileId) ===== | ||
+ | This function is run after the user saves and change to a file | ||
+ | |||
+ | Parameters: | ||
+ | * fileId | ||
+ | |||
+ | Used in: | ||
+ | * edit.php | ||
+ | |||
+ | ===== onAfterArchiveFile() ===== | ||
+ | This function is run after the user deletes a file (aka archive) | ||
+ | |||
+ | Used in: | ||
+ | * delete.php | ||
+ | |||
+ | ===== onAfterDeleteFile() ===== | ||
+ | This function is run after the admin permanently deletes a file | ||
+ | |||
+ | Used in: | ||
+ | * delete.php | ||
+ | |||
+ | ===== onBeforeLogin() ===== | ||
+ | This function is run before a user is logged in | ||
+ | |||
+ | Used in: | ||
+ | * index.php | ||
+ | |||
+ | ===== onAfterLogin() ===== | ||
+ | This function is run after a user is logged in | ||
+ | |||
+ | Used in: | ||
+ | * index.php | ||
+ | |||
+ | ===== onFailedLogin() ===== | ||
+ | This function is called after a failed login | ||
+ | |||
+ | Used in: | ||
+ | * index.php | ||
+ | |||
+ | ===== onAfterLogout() ===== | ||
+ | This function is run after the user session is cleared | ||
+ | |||
+ | Used in: | ||
+ | * logout.php | ||
+ | |||
+ | ===== onViewFile() ===== | ||
+ | This function is called after the user views a file | ||
+ | |||
+ | Used in: | ||
+ | * view.php | ||
+ | |||
+ | ===== onSearch() ===== | ||
+ | This function is performed after a search has been initiated | ||
+ | |||
+ | Used in: | ||
+ | * search.php | ||
+ | |||
+ | ===== onBeforeAddUser() ===== | ||
+ | This function is run at the top of the add user form | ||
+ | |||
+ | Used in: | ||
+ | * user.php | ||
+ | |||
+ | ===== onAfterAddUser() ===== | ||
+ | This function is run after the add user form is saved | ||
+ | |||
+ | Used in: | ||
+ | * user.php | ||
+ | |||
+ | ===== setProperties() ===== | ||
+ | This function allows for setting of class settings | ||
+ | |||
+ | Used in: | ||
+ | * Plugin_class.php | ||
+ | |||
+ | ===== getProperties() ===== | ||
+ | This function allows for getting of class settings | ||
+ | |||
+ | Used in: | ||
+ | * Plugin_class.php | ||
+ | |||
+ | ===== onDuringDetails($fileId) ===== | ||
+ | This function is run during the details view | ||
+ | |||
+ | Parameters: | ||
+ | |||
+ | * $fileId (int) | ||
+ | |||
+ | Used in: | ||
+ | * details.php | ||
+ | |||
+ | |||
+ | ===== onBeforeListFiles($fileList) ===== | ||
+ | This function is run before the file list view | ||
+ | |||
+ | Parameters: | ||
+ | * $fileList array() | ||
+ | |||
+ | Used in: | ||
+ | * functions.php | ||
+ | |||
+ | ===== onAfterListFiles() ===== | ||
+ | This function is run after the file list view is drawn | ||
+ | |||
+ | Used in: | ||
+ | * functions.php | ||
+ | |||
+ | ===== onBeforeEditFileSaved() ===== | ||
+ | This function is run before the edited file object is saved to the db | ||
+ | |||
+ | Used in: | ||
+ | * edit.php | ||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
opendocman_api.txt · Last modified: 2023/08/24 03:29 by 162.158.189.197