Docs For Class Module

Description

Module page class.

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

Method Summary

tempcode choose (tempcode $title)

tempcode details (tempcode $title)

void ensure_in ()

tempcode finish (tempcode $title)

?array get_entry_points ()

?array info ()

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

tempcode licence (tempcode $title)

tempcode message (tempcode $title)

tempcode pay (tempcode $title)

tempcode product_info (tempcode $title)

tempcode run ()

void uninstall ()

tempcode wrap (tempcode $content, tempcode $title, ?mixed $url, [boolean $get = false])

Methods

choose (line 237)

Choose product step.

return: The result of execution.

tempcode choose (tempcode $title)

tempcode $title: The page title.

details (line 352)

Details about purchase step.

return: The result of execution.

tempcode details (tempcode $title)

tempcode $title: The page title.

ensure_in (line 205)

Only allow logged in members to here.

void ensure_in ()

finish (line 483)

Finish step.

return: The result of execution.

tempcode finish (tempcode $title)

tempcode $title: The page title.

get_entry_points (line 168)

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

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)

licence (line 325)

Licence agreement step.

return: The result of execution.

tempcode licence (tempcode $title)

tempcode $title: The page title.

message (line 290)

Message about product step.

return: The result of execution.

tempcode message (tempcode $title)

tempcode $title: The page title.

pay (line 375)

Payment step.

return: The result of execution.

tempcode pay (tempcode $title)

tempcode $title: The page title.

product_info (line 562)

Product info for all ecommerce items

return: The result of execution.

tempcode product_info (tempcode $title)

tempcode $title: The page title.

run (line 178)

Standard modular run function.

return: The result of execution.

tempcode run ()

uninstall (line 48)

Standard modular uninstall function.

void uninstall ()

wrap (line 224)

Wrap-up so as to remove redundancy in templates.

return: Wrapped.

tempcode wrap (tempcode $content, tempcode $title, ?mixed $url, [boolean $get = false])

tempcode $content: To wrap.
tempcode $title: The title to use.
?mixed $url: URL (NULL: no next URL).
boolean $get: Whether it is a GET form

Class Module_purchase