Docs For Class Hook

Class Hook_mkportal

Description

Located in /sources/hooks/modules/admin_import/mkportal.php (line 36)

Method Summary

ID_TEXT custom_add_banner_type (ID_TEXT $id, [BINARY $is_textual = 0], [integer $image_width = 0], [integer $image_height = 0], [integer $max_file_size = 0], [BINARY $comcode_inline = 0])

AUTO_LINK get_news_category_id (SHORT_TEXT $title, ID_TEXT $image)

void import_banners (object The $db, string $table_prefix, PATH $old_base_dir)

void import_blocks (object The $db, string $table_prefix, PATH $old_base_dir)

void import_config (object The $db, string $table_prefix, PATH $file_base)

tempcode import_downloads_and_categories (object The $db, string $table_prefix, PATH $old_base_dir)

void import_images_and_galleries (object The $db, string $table_prefix, PATH $old_base_dir)

void import_news_and_categories (object The $db, string $table_prefix, PATH $old_base_dir)

void import_pages (object The $db, string $table_prefix, PATH $old_base_dir)

void import_quotes (object The $db, string $table_prefix, PATH $old_base_dir)

void import_reviews (object The $db, string $table_prefix, PATH $old_base_dir)

void import_rss (object The $db, string $table_prefix, PATH $old_base_dir)

?array info ()

void test_for_comments_forum ()

boolean verify_base_path (PATH $file_base)

void _import_ratings (object The $db, string $ocp_type, AUTO_LINK $id_entry, AUTO_LINK $id_entry_new, integer $average_rate, [string $table_prefix = ''])

Methods

custom_add_banner_type (line 164)

Add a banner type.

return: The banner type ID (same as $id)

ID_TEXT custom_add_banner_type (ID_TEXT $id, [BINARY $is_textual = 0], [integer $image_width = 0], [integer $image_height = 0], [integer $max_file_size = 0], [BINARY $comcode_inline = 0])

ID_TEXT $id: The name for the banner type
BINARY $is_textual: Whether this is a textual banner
integer $image_width: The image width (ignored for textual banners)
integer $image_height: The image height (ignored for textual banners)
integer $max_file_size: The maximum file size for the banners (this is a string length for textual banners)
BINARY $comcode_inline: Whether the banner will be automatically shown via Comcode hot-text (this can only happen if banners of the title are given title-text)

get_news_category_id (line 434)

Convert a named news category to an ocPortal news category ID.

return: The news category ID

AUTO_LINK get_news_category_id (SHORT_TEXT $title, ID_TEXT $image)

SHORT_TEXT $title: Named news category
ID_TEXT $image: The image code the news category will use

import_banners (line 196)

Standard import function.

void import_banners (object The $db, string $table_prefix, PATH $old_base_dir)

object The $db: DB connection to import from
string $table_prefix: The table prefix the target prefix is using
PATH $old_base_dir: The base directory we are importing from

import_blocks (line 1146)

Standard import function.

void import_blocks (object The $db, string $table_prefix, PATH $old_base_dir)

object The $db: DB connection to import from
string $table_prefix: The table prefix the target prefix is using
PATH $old_base_dir: The base directory we are importing from

import_config (line 90)

Standard import function.

void import_config (object The $db, string $table_prefix, PATH $file_base)

object The $db: DB connection to import from
string $table_prefix: The table prefix the target prefix is using
PATH $file_base: The base directory we are importing from

import_downloads_and_categories (line 770)

Standard import function.

return: Import message

tempcode import_downloads_and_categories (object The $db, string $table_prefix, PATH $old_base_dir)

object The $db: DB connection to import from
string $table_prefix: The table prefix the target prefix is using
PATH $old_base_dir: The base directory we are importing from

import_images_and_galleries (line 937)

Standard import function.

void import_images_and_galleries (object The $db, string $table_prefix, PATH $old_base_dir)

object The $db: DB connection to import from
string $table_prefix: The table prefix the target prefix is using
PATH $old_base_dir: The base directory we are importing from

import_news_and_categories (line 451)

Standard import function.

void import_news_and_categories (object The $db, string $table_prefix, PATH $old_base_dir)

object The $db: DB connection to import from
string $table_prefix: The table prefix the target prefix is using
PATH $old_base_dir: The base directory we are importing from

import_pages (line 298)

Standard import function.

void import_pages (object The $db, string $table_prefix, PATH $old_base_dir)

object The $db: DB connection to import from
string $table_prefix: The table prefix the target prefix is using
PATH $old_base_dir: The base directory we are importing from

import_quotes (line 369)

Standard import function.

void import_quotes (object The $db, string $table_prefix, PATH $old_base_dir)

object The $db: DB connection to import from
string $table_prefix: The table prefix the target prefix is using
PATH $old_base_dir: The base directory we are importing from

import_reviews (line 1537)

Standard import function.

void import_reviews (object The $db, string $table_prefix, PATH $old_base_dir)

object The $db: DB connection to import from
string $table_prefix: The table prefix the target prefix is using
PATH $old_base_dir: The base directory we are importing from

import_rss (line 395)

Standard import function.

void import_rss (object The $db, string $table_prefix, PATH $old_base_dir)

object The $db: DB connection to import from
string $table_prefix: The table prefix the target prefix is using
PATH $old_base_dir: The base directory we are importing from

info (line 44)

Standard modular info function.

return: Map of module info (NULL: module is disabled).

?array info ()

test_for_comments_forum (line 1669)

Check a comments forum has been configured.

void test_for_comments_forum ()

verify_base_path (line 77)

Verifies that the base path is correct

return: True if the base path is correct and false if it's not correct

boolean verify_base_path (PATH $file_base)

PATH $file_base: The base directory we are importing from

_import_ratings (line 1113)

Import ratings

void _import_ratings (object The $db, string $ocp_type, AUTO_LINK $id_entry, AUTO_LINK $id_entry_new, integer $average_rate, [string $table_prefix = ''])

object The $db: DB connection to import from
string $ocp_type: The ocPortal rating type - 'news'(used for blogs ratings),'downloads','galleries'
AUTO_LINK $id_entry: The rating ID according to MKPortal
AUTO_LINK $id_entry_new: The rating ID according to ocPortal
integer $average_rate: The average rating
string $table_prefix: The table prefix the target prefix is using

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