Commit 5c1f0625 authored by Nigel McNie's avatar Nigel McNie
Browse files

Add a comment to the base class import_author_data method.



The other base class methods had detailed descriptions, so this only
seems fair.
Signed-off-by: default avatarNigel McNie <nigel@catalyst.net.nz>
parent 3ecf54be
......@@ -1009,6 +1009,17 @@ abstract class LeapImportArtefactPlugin {
/**
* Gives plugins a chance to import author data
*
* This gets passed the entry ID for the entry that represents the person
* who is being imported, should there be such an entry. This method can
* then dig through it to create artefacts. Contrast this with exporting
* persondata in the plugin's export implementation. A plugin might export
* a persondata field there, and then look for it again here.
*
* @param PluginImportLeap $importer The importer
* @param string $persondataid The entry ID for the persondata entry.
* May be empty if no such entry was
* found in the import.
*/
public static function import_author_data(PluginImportLeap $importer, $persondataid) {
}
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment