Function Hook_task_import_catalogue->run
Definitions
sources/hooks/systems/tasks/import_catalogue.php
- Run the task hook.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Return: array
Parameters
| Name | Type | Default | Set | Range | Description |
|---|---|---|---|---|---|
| $catalogue_name | ID_TEXT | required parameter | N/A | N/A | The name of the catalogue that was used |
| $key_field | string | required parameter | N/A | N/A | The title of the key field (blank: none) |
| $new_handling | ID_TEXT | required parameter | N/A | N/A | New handling method |
| $delete_handling | ID_TEXT | required parameter | N/A | N/A | Delete handling method |
| $update_handling | ID_TEXT | required parameter | N/A | N/A | Update handling method |
| $meta_keywords_field | ID_TEXT | required parameter | N/A | N/A | Meta keywords field (blank: none) |
| $meta_description_field | ID_TEXT | required parameter | N/A | N/A | Meta description field (blank: none) |
| $notes_field | ID_TEXT | required parameter | N/A | N/A | Notes field (blank: none) |
| $allow_rating | boolean | required parameter | N/A | N/A | Whether rating is allowed for this resource |
| $allow_comments | boolean | required parameter | N/A | N/A | Whether comments are allowed for this resource |
| $allow_trackbacks | boolean | required parameter | N/A | N/A | Whether trackbacks are allowed for this resource |
| $spreadsheet_path | PATH | required parameter | N/A | N/A | The path of the file to import |
| $filename | ?string | Null | N/A | N/A | The filename of the file to import (null: detect from $spreadsheet_path) |
Return
- A tuple of at least 2: Return mime-type, content (either Tempcode, or a string, or a filename and file-path pair to a temporary file), map of HTTP headers if transferring immediately, map of ini_set commands if transferring immediately (null: show standard success message)
- Type: ?array
- Set: N/A
- Range: N/A