gnh1201/seeddms-code
1
0
Fork 0
mirror of https://git.code.sf.net/p/seeddms/code synced 2024-11-26 15:32:13 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

add more hooks (still incomplete)

Browse Source
This commit is contained in:
Uwe Steinmann 2019-10-19 08:16:43 +02:00
parent 0205e8a08e
commit b8447b7d39
1 changed files with 20 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
doc/README.Hooks
View File

@ -59,6 +59,22 @@ AddDocument::preIndexDocument
are the document and the indexed document. Returning false will prevent are the document and the indexed document. Returning false will prevent
the document from being indexed. the document from being indexed.
EditDocument::editDocumentAttribute
Called for each custom document attribute
This hook will be called for each custom attribute to ouput the form entry.
The parameters passed are the document and the attribute definition.
Returning an empty array will prevent the attribute from being show.
Returning an array with two elements will pass those element to the formField
method. A returned string will be output as is.
EditDocument::addDocumentAttributes
Called after all custom document attributes has been output
This hook will be called right after the document attributes have been shown.
The return value is either an array with two elements or a string.
The string will be output as is, the array will be passed to the method formField.
UpdateDocument::preUpdateDocument UpdateDocument::preUpdateDocument
Called before a new document will be updated Called before a new document will be updated
@ -70,10 +86,10 @@ UpdateDocument::preUpdateDocument
UpdateDocument::updateDocument UpdateDocument::updateDocument
Called when the document is to be updated Called when the document is to be updated
This hook can be used to replace the code for updating a document. In This hook can be used to replace the code for updating a document. In
that case it must return a document content or false. If that case it must return a document content or false. If
the hook returns null, the original code for adding the the hook returns null, the original code for adding the
document will be executed. document will be executed.
UpdateDocument::postUpdateDocument UpdateDocument::postUpdateDocument
Called after a new document has been updated Called after a new document has been updated