/sources/import.php

Description
Functions
add_wordfilter_word (line 103)

Add a word to the word-filter.

void add_wordfilter_word (SHORT_TEXT $word, [SHORT_TEXT $replacement = ''], [BINARY $substr = 0])
  • SHORT_TEXT $word: Word to add to the word-filter
  • SHORT_TEXT $replacement: Replacement (blank: block entirely)
  • BINARY $substr: Whether to perform a substring match
find_derivative_filename (line 117)

Find a similar but non conflicting filename to $file in the given directory.

  • return: Filename to use
string find_derivative_filename (PATH $dir, string $file, [boolean $shun_gif = false])
  • PATH $dir: Directory
  • string $file: Preferred filename
  • boolean $shun_gif: Whether GIF files are made as PNG fiels
import_check_if_imported (line 78)

Check to see if the given id of the given type has been imported (if it has a mapping).

  • return: Whether it has been imported
boolean import_check_if_imported (ID_TEXT $type, string $id_old)
  • ID_TEXT $type: An importation type code, from those ocPortal has defined
  • string $id_old: The source (old, original) ID of the mapping
import_id_remap_get (line 56)

Get the remapping for the id in the specified type. Whether it returns NULL or gives an error message depends on $fail_ok.

  • return: The remapping (NULL: not found)
?AUTO_LINK import_id_remap_get (ID_TEXT $type, string $id_old, [boolean $fail_ok = false])
  • ID_TEXT $type: An importation type code, from those ocPortal has defined
  • string $id_old: The source (old, original) ID of the mapping
  • boolean $fail_ok: If it is okay to fail to find a mapping
import_id_remap_put (line 91)

Set a mapping, indicating completion of importing some kind of content. This mapping may be used later for importing related content that requires a remapped identifier.

void import_id_remap_put (ID_TEXT $type, string $id_old, AUTO_LINK $id_new)
  • ID_TEXT $type: An importation type code, from those ocPortal has defined
  • string $id_old: The source (old, original) ID of the mapping
  • AUTO_LINK $id_new: The destination (new) ID of the mapping
init__import (line 24)

Standard code module initialisation function.

void init__import ()
i_force_refresh (line 137)

Force a page refresh due to maximum execution timeout.

void i_force_refresh ()
ocf_over_local (line 33)

Switch OCF to run over the local site-DB connection. Useful when importing and our forum driver is actually connected to a forum other than OCF.

void ocf_over_local ()
ocf_over_msn (line 42)

Undo ocf_over_local.

void ocf_over_msn ()

Documentation generated on Sun, 02 Jan 2011 23:15:59 +0000 by phpDocumentor 1.4.3