Docs For Class Module_admin_ocf_welcome

Description

Module page class.

copyright: ocProducts Ltd

Located in /adminzone/pages/modules/admin_ocf_welcome_emails.php (line 26)

standard_aed_module
   |
   --Module_admin_ocf_welcome_emails

Variable Summary

mixed $lang_type

mixed $menu_label

mixed $select_name

mixed $select_name_description

Method Summary

ID_TEXT add_actualisation ()

void delete_actualisation (ID_TEXT $id)

void edit_actualisation (ID_TEXT $id)

tempcode fill_in_edit_form (ID_TEXT $id)

?array get_entry_points ()

tempcode get_form_fields ([SHORT_TEXT $name = ''], [SHORT_TEXT $subject = ''], [LONG_TEXT $text = ''], [integer $send_time = 0], [?AUTO_LINK $newsletter = 0])

?array info ()

void install ([?integer $upgrade_from = NULL], [?integer $upgrade_from_hack = NULL])

tempcode misc ()

tempcode nice_get_entries ()

tempcode run_start (ID_TEXT $type)

void uninstall ()

Variables

mixed $lang_type = 'WELCOME_EMAIL' (line 28)

mixed $menu_label = 'WELCOME_EMAILS' (line 31)

Redefinition of:

standard_aed_module::$menu_label

mixed $select_name = 'SUBJECT' (line 29)

mixed $select_name_description = 'DESCRIPTION_WELCOME_EMAIL_SUBJECT' (line 30)

Redefinition of:

standard_aed_module::$select_name_description

Inherited Variables

Inherited from standard_aed_module

standard_aed_module::$add_one_cat_label
standard_aed_module::$add_one_label
standard_aed_module::$add_submit_name
standard_aed_module::$add_text
standard_aed_module::$alt_aed_module
standard_aed_module::$appended_actions_already
standard_aed_module::$archive_entry_point
standard_aed_module::$archive_label
standard_aed_module::$array_key
standard_aed_module::$author
standard_aed_module::$award_type
standard_aed_module::$care_please
standard_aed_module::$catalogue
standard_aed_module::$cat_aed_module
standard_aed_module::$check_validation
standard_aed_module::$code_require
standard_aed_module::$default_type
standard_aed_module::$do_next_description
standard_aed_module::$do_next_editing_categories
standard_aed_module::$do_preview
standard_aed_module::$edit_one_cat_label
standard_aed_module::$edit_one_label
standard_aed_module::$edit_submit_name
standard_aed_module::$edit_text
standard_aed_module::$edit_this_cat_label
standard_aed_module::$edit_this_label
standard_aed_module::$extra_donext_categories
standard_aed_module::$extra_donext_entries
standard_aed_module::$extra_donext_whatever
standard_aed_module::$extra_donext_whatever_title
standard_aed_module::$javascript
standard_aed_module::$javascript_require
standard_aed_module::$module_type
standard_aed_module::$new_id
standard_aed_module::$non_integer_id
standard_aed_module::$no_blank_ids
standard_aed_module::$orderer
standard_aed_module::$organisation
standard_aed_module::$output_of_action_is_confirmation
standard_aed_module::$permissions_cat_name
standard_aed_module::$permissions_cat_name_b
standard_aed_module::$permissions_cat_require
standard_aed_module::$permissions_cat_require_b
standard_aed_module::$permissions_require
standard_aed_module::$permission_module
standard_aed_module::$permission_page
standard_aed_module::$possibly_some_kind_of_upload
standard_aed_module::$posting_form_text
standard_aed_module::$posting_form_text_parsed
standard_aed_module::$posting_form_title
standard_aed_module::$protect_first
standard_aed_module::$redirect_type
standard_aed_module::$second_stage_preview
standard_aed_module::$send_validation_request
standard_aed_module::$seo_type
standard_aed_module::$skip_validation
standard_aed_module::$special_edit_frontend
standard_aed_module::$table
standard_aed_module::$table_prefix
standard_aed_module::$title_is_multi_lang
standard_aed_module::$type_code
standard_aed_module::$upload
standard_aed_module::$user_facing
standard_aed_module::$view_entry_point

Methods

add_actualisation (line 237)

Standard aed_module add actualiser.

return: The entry added

ID_TEXT add_actualisation ()

delete_actualisation (line 280)

Standard aed_module delete actualiser.

void delete_actualisation (ID_TEXT $id)

ID_TEXT $id: The entry being deleted

edit_actualisation (line 259)

Standard aed_module edit actualiser.

void edit_actualisation (ID_TEXT $id)

ID_TEXT $id: The entry being edited

fill_in_edit_form (line 221)

Standard aed_module edit form filler.

return: The edit form

tempcode fill_in_edit_form (ID_TEXT $id)

ID_TEXT $id: The entry being edited

get_entry_points (line 102)

Standard modular entry-point finder function.

return: A map of entry points (type-code=>language-code) (NULL: disabled).

?array get_entry_points ()

Redefinition of:

standard_aed_module::get_entry_points(): Standard modular entry-point finder function.

get_form_fields (line 163)

Get tempcode for adding/editing form.

return: The input fields

tempcode get_form_fields ([SHORT_TEXT $name = ''], [SHORT_TEXT $subject = ''], [LONG_TEXT $text = ''], [integer $send_time = 0], [?AUTO_LINK $newsletter = 0])

SHORT_TEXT $name: A name for the Welcome E-mail
SHORT_TEXT $subject: The subject of the Welcome E-mail
LONG_TEXT $text: The message body of the Welcome E-mail
integer $send_time: The number of hours before sending the e-mail
?AUTO_LINK $newsletter: What newsletter to send out to instead of members (NULL: none)

info (line 38)

Standard modular info function.

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

?array info ()

Redefinition of:

standard_aed_module::info(): Standard modular info function.

install (line 67)

Standard modular install function.

void install ([?integer $upgrade_from = NULL], [?integer $upgrade_from_hack = NULL])

?integer $upgrade_from: What version we're upgrading from (NULL: new install)
?integer $upgrade_from_hack: What hack version we're upgrading from (NULL: new-install/not-upgrading-from-a-hacked-version)

misc (line 138)

The do-next manager for before content management.

return: The UI

tempcode misc ()

nice_get_entries (line 203)

Standard aed_module list function.

return: The selection list

tempcode nice_get_entries ()

Redefinition of:

standard_aed_module::nice_get_entries(): Standard modular entry list fetcher.

run_start (line 113)

Standard aed_module run_start.

return: The output of the run

tempcode run_start (ID_TEXT $type)

ID_TEXT $type: The type of module execution

uninstall (line 54)

Standard modular uninstall function.

void uninstall ()

Inherited Methods

Inherited From standard_aed_module

standard_aed_module::ad()
standard_aed_module::choose_catalogue()
standard_aed_module::do_next_manager()
standard_aed_module::ed()
standard_aed_module::get_entry_points()
standard_aed_module::get_permission_fields()
standard_aed_module::handle_confirmations()
standard_aed_module::info()
standard_aed_module::nice_get_entries()
standard_aed_module::preview_intercept()
standard_aed_module::run()
standard_aed_module::set_permissions()
standard_aed_module::_ad()
standard_aed_module::_ed()
standard_aed_module::__ed()

Class Module_admin_ocf_welcome_emails

Inherited Variables

Inherited Methods