Maxscape::ServerApplication Package

Synopsis

use Maxscape::ServerApplication;

Description

The Maxscape::ServerApplication package provides functions for the Maxscape administration server. The package is only be used in the scope of this server.

List of Member Functions

  1. API_Data
  2. ch
  3. displayMenu
  4. displayPageMenuNodeHyperlink
  5. DocumentCallback
  6. eh
  7. enableFinalFilter
  8. initialPageGenerationCallback
  9. Maxscape::AdministrationBody
  10. Maxscape::connectProcessDaemon
  11. Maxscape::controlChatServer
  12. Maxscape::executeObject
  13. Maxscape::FuntasyHome
  14. Maxscape::FuntasyHomePageBody
  15. Maxscape::Page::ServerGlobalElementCallback
  16. Maxscape::PageStandardSkeleton
  17. Maxscape::ProcessGlobalElementCallback
  18. Maxscape::searchDatabase
  19. Maxscape::searchResult
  20. Maxscape::searchResult
  21. Maxscape::ServerApplication::ContextCallback
  22. Maxscape::ServerApplication::finalFilter
  23. Maxscape::ServerApplication::initMenu
  24. Maxscape::ServerApplication::PageNotFound
  25. Maxscape::showMenuAndFileBody
  26. Maxscape::simpleHeadTrailorMenu
  27. Maxscape::TableLayout
  28. Maxscape::TableLayoutBottomMenu
  29. Maxscape::TableLayoutTopBottomMenu
  30. Maxscape::WorkPageBody
  31. Maxscape::XML_Parser
  32. PageGroupPermission
  33. processElement
  34. selectImage
  35. sh
  36. showParsedTextElement
  37. standardTemplateElementCallback

Member Functions

Maxscape::ServerApplication::PageNotFound

Synopsis

Maxscape::ServerApplication::PageNotFound ($Context);

Description

If this callback function is configured and defined via the application plugin, it is call by the runtime system, when no page was found in the document database.

Maxscape::ServerApplication::ContextCallback

Synopsis

Maxscape::ServerApplication::ContextCallback ($Context);

Description

This function can be used to alter the name and the category of the page to be generated, before> the database is queried. This gives applications the chance to alter the document path as given by the 'Page' and 'Category' CGI variables in depency of other CGI variables.

PageGroupPermission

Synopsis

my $PagePermission = Maxscape::ServerApplication::PageGroupPermission
                        ($Context, $UserData, $WebServerName);

Description

This function can be used to implement an own access rights and permission policy. Within the maXscape runtime system an access denied page is displayed if the function does not return a 'r' character (this means the page is readable).

initialPageGenerationCallback

Synopsis

Maxscape::ServerApplication::initialPageGenerationCallback ($Page);

Description

This function can be used to do some server global actions in respect to dynamic page generation. For example, some members can be added to the server runtime's 'Page' object.

enableFinalFilter

Synopsis

Maxscape::ServerApplication::enableFinalFilter ($Page);

Description

If the 'enableFinalFilter' function returns a non zero value, the 'finalFilter' is function is called for the actual page content. If the function returns undef or zero the 'finalFilter' function is not called.

Maxscape::ServerApplication::finalFilter

Synopsis

my $filteredText = Maxscape::ServerApplication::finalFilter ($Page, $Text);

Description

This function can be used to filter the content of a previously assambled page. The $Text parameter is a reference.

Maxscape::ServerApplication::initMenu

Synopsis

my $globalMenuList = Maxscape::ServerApplication::initMenu ($Menu, $Page);

Description

Callback function to initialise the global part of a sites menu.

displayPageMenuNodeHyperlink

Synopsis

my $Anchor = $Menu->displayPageMenuNodeHyperlink (%Parameter);

Description

This function is imported to the Maxscape::Menu scope. It displays a menu entry.

Examples

my $Anchor = $Menu->displayPageMenuNodeHyperlink (Category => ${$self->{Categories}}[$i]);

displayMenu

Synopsis

my $MenuText = $Menu->displayMenu (%Parameter);

Description

This function is imported to the Maxscape::Menu scope. It displays a menu drived from the pages context.

Maxscape::Page::ServerGlobalElementCallback

Synopsis

Maxscape::Page::ServerGlobalElementCallback ($self, $Element);

Description

The Maxscape::Page::ServerGlobalElementCallback is called for each and every element of a node. It is imported into the Maxscape::Page package and must be configured.

standardTemplateElementCallback

Synopsis

&::standardTemplateElementCallback ($self, $Element);

Description

This function can be used to do some server global actions in respect to element callbacks.

showParsedTextElement

Synopsis

&::showParsedTextElement ($self, $Element);

Description

This function can be used to do some server global actions in respect to element callbacks. It is imported in the main scope.

processElement

Synopsis

&::processElement ($self, $Element);

Description

This function renders the page's elements into HTML. It is imported in the main scope.

DocumentCallback

Synopsis

DocumentCallback ($Context);

Description

Not in use. To do.

Maxscape::ProcessGlobalElementCallback

Synopsis

my $HTML_Text = Maxscape::ProcessGlobalElementCallback ($Context);

Description

To do.

Maxscape::PageStandardSkeleton

Synopsis

my $HTML_Text = Maxscape::PageStandardSkeleton ();

Description

To do.

Maxscape::FuntasyHome

Synopsis

my $HTML_Text = Maxscape::PageStandardSkeleton ($Page);

Description

To do.

Maxscape::FuntasyHomePageBody

Synopsis

my $HTML_Text = Maxscape::FuntasyHomePageBody ($Page);

Description

To do.

Maxscape::AdministrationBody

Synopsis

my $HTML_Text = Maxscape::AdministrationBody ($Page);

Description

To do.

Maxscape::TableLayout

Synopsis

my $HTML_Text = Maxscape::TableLayout ($Page);

Description

To do.

Maxscape::TableLayoutTopBottomMenu

Synopsis

my $HTML_Text = Maxscape::TableLayoutTopBottomMenu ($Page);

Description

To do.

Maxscape::TableLayoutBottomMenu

Synopsis

my $HTML_Text = Maxscape::TableLayoutBottomMenu ($Page);

Description

To do.

Maxscape::simpleHeadTrailorMenu

Synopsis

my $HTML_Text = Maxscape::simpleHeadTrailorMenu ($Page);

Description

To do.

Maxscape::showMenuAndFileBody

Synopsis

my $HTML_Text = Maxscape::showMenuAndFileBody ($Page);

Description

To do.

Maxscape::WorkPageBody

Synopsis

my $HTML_Text = Maxscape::WorkPageBody ($Page);

Description

To do.

Maxscape::executeObject

Synopsis

my $HTML_Text = Maxscape::executeObject ($Page);

Description

Executes an object's member function from a database element definition.

Maxscape::searchDatabase

Synopsis

my $HTML_Text = Maxscape::searchDatabase ($Page);

Description

Returns a form to search the content database for a string.

Maxscape::searchResult

Synopsis

my $SearchResult_Text = Maxscape::searchResult ($Page);

Description

Returns the result of a content database search for a string.

Maxscape::searchResult

Synopsis

my $HeaderRule = Maxscape::SpectrumHR ($Width);

Description

Returns an header rule.

Maxscape::controlChatServer

Synopsis

my $HeaderRule = Maxscape::controlChatServer ($Page, $Message);

Description

To do.

Maxscape::connectProcessDaemon

Synopsis

my $HeaderRule = Maxscape::connectProcessDaemon ($Message);

Description

Returns a text send from the control daemon.

Maxscape::XML_Parser

Synopsis

my $HeaderRule = Maxscape::connectProcessDaemon ($Page, $Text);

Description

Returns a parsed XML text.

sh

Synopsis

my $HeaderRule = Maxscape::sh ($p, $Element, %atts);

Description

To do.

eh

Synopsis

my $HeaderRule = Maxscape::eh ($p, $Element);

Description

To do.

ch

Synopsis

my $HeaderRule = Maxscape::ch ($p, $Element);

Description

To do.

API_Data

Synopsis

my $HeaderRule = Maxscape::ch ($Page);

Description

To do.

selectImage

Synopsis

my $HeaderRule = Maxscape::selectImage ($Page, @Parameter);

Description

To do.

1
Next ∙ Previous ∙ Top ∙ Join ∙ Contact © Maxscape