Docs For Class Module_admin

Description

Module page class.

copyright: ocProducts Ltd

Located in /adminzone/pages/modules/admin_newsletter.php (line 28)

standard_aed_module
   |
   --Module_admin_newsletter

Variable Summary

mixed $cache_level_counts

mixed $do_preview

mixed $lang_type

mixed $menu_label

mixed $protect_first

mixed $select_name

Method Summary

ID_TEXT add_actualisation ()

tempcode archive ()

tempcode automatic_whats_new ()

tempcode bounce_filter_a ()

tempcode bounce_filter_b ()

tempcode bounce_filter_c ()

tempcode bounce_filter_d ()

tempcode confirm_send ()

integer count_level (AUTO_LINK $id, integer $level, ID_TEXT $lang)

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 $title = ''], [LONG_TEXT $description = ''])

tempcode import_subscribers ()

tempcode misc ()

tempcode nice_get_entries ()

tempcode run_start (ID_TEXT $type)

tempcode send_gui ([LONG_TEXT $_existing = ''])

tempcode send_message ()

tempcode view ()

tempcode view_subscribers ()

Variables

mixed $cache_level_counts (line 34)

mixed $do_preview = NULL (line 33)

Redefinition of:

standard_aed_module::$do_preview

mixed $lang_type = 'NEWSLETTER' (line 30)

mixed $menu_label = 'NEWSLETTER' (line 35)

Redefinition of:

standard_aed_module::$menu_label

mixed $protect_first = 1 (line 32)

Redefinition of:

standard_aed_module::$protect_first

mixed $select_name = 'TITLE' (line 31)

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::$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::$redirect_type
standard_aed_module::$second_stage_preview
standard_aed_module::$select_name_description
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 1225)

Standard aed_module add actualiser.

return: The entry added

ID_TEXT add_actualisation ()

archive (line 1119)

The UI to select to view a past newsletter.

return: The UI

tempcode archive ()

automatic_whats_new (line 113)

The UI to create an automated what's new newsletter.

return: The UI

tempcode automatic_whats_new ()

bounce_filter_a (line 479)

The UI to select an IMAP server for bounce filtering.

return: The UI

tempcode bounce_filter_a ()

bounce_filter_b (line 505)

The UI to select an inbox for bounce filtering.

return: The UI

tempcode bounce_filter_b ()

bounce_filter_c (line 554)

The UI to confirm which subscribers to prune.

return: The UI

tempcode bounce_filter_c ()

bounce_filter_d (line 619)

The actualiser to prune subscribers.

return: The UI

tempcode bounce_filter_d ()

confirm_send (line 989)

The UI to confirm sending of our newsletter.

return: The UI

tempcode confirm_send ()

count_level (line 291)

Count the number of users on a certain level and language of the newsletter.

return: The count

integer count_level (AUTO_LINK $id, integer $level, ID_TEXT $lang)

AUTO_LINK $id: The newsletter
integer $level: The newsletter level
ID_TEXT $lang: The language

delete_actualisation (line 1253)

Standard aed_module delete actualiser.

void delete_actualisation (ID_TEXT $id)

ID_TEXT $id: The entry being deleted

edit_actualisation (line 1240)

Standard aed_module edit actualiser.

void edit_actualisation (ID_TEXT $id)

ID_TEXT $id: The entry being edited

fill_in_edit_form (line 1209)

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 42)

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 1177)

Get tempcode for adding/editing form.

return: The input fields

tempcode get_form_fields ([SHORT_TEXT $title = ''], [LONG_TEXT $description = ''])

SHORT_TEXT $title: The title
LONG_TEXT $description: The description

import_subscribers (line 303)

The UI to import subscribers into the newsletter.

return: The UI

tempcode import_subscribers ()

misc (line 95)

The do-next manager for before content management.

return: The UI

tempcode misc ()

nice_get_entries (line 1191)

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 53)

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

send_gui (line 853)

The UI to send a newsletter.

return: The UI

tempcode send_gui ([LONG_TEXT $_existing = ''])

LONG_TEXT $_existing: Default newsletter to put in

send_message (line 1045)

The actualiser to send a newsletter.

return: The UI

tempcode send_message ()

view (line 1149)

The UI to view a past newsletter.

return: The UI

tempcode view ()

view_subscribers (line 645)

The UI to view subscribers on the newsletter.

return: The UI

tempcode view_subscribers ()

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_newsletter

Inherited Variables

Inherited Methods