Docs For Class Module

Description

Module page class.

Located in /site/pages/modules/newsletter.php (line 24)

Method Summary

?array get_entry_points ()

?array info ()

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

tempcode newsletter_confirm_joining ()

tempcode newsletter_form ()

tempcode newsletter_maintenance ()

tempcode newsletter_password_reset ()

tempcode newsletter_unsubscribe ()

tempcode run ()

void send_confirmation (SHORT_TEXT $email, SHORT_TEXT $code_confirm, [?SHORT_TEXT $password = NULL])

void uninstall ()

Methods

get_entry_points (line 205)

Standard modular entry-point finder function.

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

?array get_entry_points ()

info (line 32)

Standard modular info function.

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

?array info ()

install (line 79)

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)

newsletter_confirm_joining (line 480)

The UI for having confirmed an e-mail address onto the newsletter.

return: The UI

tempcode newsletter_confirm_joining ()

newsletter_form (line 235)

The UI to sign up to the newsletter (actually, generally manage subscription).

return: The UI

tempcode newsletter_form ()

newsletter_maintenance (line 313)

The actualiser for newsletter subscription maintenance (adding, updating, deleting).

return: The UI

tempcode newsletter_maintenance ()

newsletter_password_reset (line 407)

The actualiser for resetting newsletter password.

return: The UI

tempcode newsletter_password_reset ()

newsletter_unsubscribe (line 433)

The actualiser for unsubscribing from the newsletter.

return: The UI

tempcode newsletter_unsubscribe ()

run (line 215)

Standard modular run function.

return: The result of execution.

tempcode run ()

send_confirmation (line 463)

Send a newsletter join confirmation.

void send_confirmation (SHORT_TEXT $email, SHORT_TEXT $code_confirm, [?SHORT_TEXT $password = NULL])

SHORT_TEXT $email: The e-mail address
SHORT_TEXT $code_confirm: The confirmation code
?SHORT_TEXT $password: The newsletter password (NULL: password may not be viewed, because it's been permanently hashed already)

uninstall (line 48)

Standard modular uninstall function.

void uninstall ()

Class Module_newsletter