Maxscape::PageAdmin Package

Synopsis

use Maxscape::PageAdmin;

Description

The Maxscape::PageAdmin package implements the web surface to the administration and the application server content databases.

List of Member Functions

1. addElementTemplate
2. additionalPageMenu
3. addPage
4. addPageFieldMemberFunctionName
5. adminPages
6. backupPage
7. copyPage
8. deletePage
9. displayedMenueURL
10. displayedPageURL
11. displayPath
12. displayPathElement
13. DocumentCallback
14. editDatabaseFile
15. editElementContentField
16. editElementPage
17. editPage
18. editPageDisplayTypePopupMenu
19. editPageFieldMemberFunctionName
20. editPageNODE_CATEGORY
21. editPageTablePage
22. execFormInContext
23. HTTPD_ServerUserProcessDir
24. movePage
25. new
26. PageDateWidget
27. selectElement
28. selectPage
29. setPageStatus
30. showPage
31. traversePage
32. traversePageRenderRecord
33. traversePageTree

Member Functions

new

Synopsis

my $PageAdmin = Maxscape::PageAdmin->new (%P);

Description

Creates a Maxscape::PageAdmin object.

Examples

my $PageAdmin = Maxscape::PageAdmin->new (
                  Page         => $Page,
                  ...
);

DocumentCallback

Synopsis

$PageAdmin->DocumentCallback ($Context);

Description

Callback to select the wanted page. The DocumentCallback is called before the page is fetched from the content database. This allows to change the CGI variables and the context of the page generation process. The page path (Category and Page CGI variables) is redirected to the page that serves the requested action.

execFormInContext

Synopsis

my $Error = $PageAdmin->execFormInContext ();

Description

Returns context data to a $PageAdmin form as hidden input fields.

Examples

adminPages

Synopsis

my $Text = $PageAdmin->adminPages ();

Description

Main method to manage the page tree. All module service functions are called within this method.

Examples

my $PageAdmin = Maxscape::PageAdmin->new (%P);
my $Text = $PageAdmin->adminPages();

traversePage

Synopsis

my $NodeTreeAsHTML = $PageAdmin->traversePage;

Description

Displays an application server's node tree in the content database.

traversePageRenderRecord

Synopsis

my $NodeLine = $PageAdmin->traversePageRenderRecord ($Page, $Table, $Page);

Description

The traversePageRenderRecord function renders the database table rows of a node in the content databases. It is ment to be passed to the new method of the $Table object and returns an HTML formated record of the page tree's NODE table record.

Examples

my $NodeTreeTable = Maxscape::Page::Table->new (
     ...
     RecordFormatFunctionName => 'Maxscape::PageAdmin::traversePageRenderRecord',
     ...
);

traversePageTree

Synopsis

my $PageTreeText = $PageAdmin->traversePageTree ();

Description

This function is mainly a copy of the traversePage method. Is it used?

Examples

Returns a page tree.

displayPath

Synopsis

my $PageTreePath = $PageAdmin->displayPath ($NODE_CATEGORY, $currentCategory);

Description

Returns a clickable path to the current category.

displayPathElement

Synopsis

my $PathElement = $PageAdmin->displayPathElement ($NODE_CATEGORY, $currentCategory,
                                                  $StartDepth);

Description

Returns a page path element.

Examples

selectPage

Synopsis

my $PathElement = $PageAdmin->selectPage ($Page);

Description

Returns a page tree as an HTML table.

addPageFieldMemberFunctionName

Synopsis

$PageAdmin->addPageFieldMemberFunctionName (%P);

Description

Callback to add a page.

addPage

Synopsis

my $Text = $PageAdmin->addPage (%P);

Description

Add a page or page element to the page tree.

editPageNODE_CATEGORY

Synopsis

my $Text = $PageAdmin->editPageNODE_CATEGORY ($Name);

Description

Callback for a pages category.

editPageFieldMemberFunctionName

Synopsis

my $Text = $PageAdmin->editPageFieldMemberFunctionName (%P);

Description

Callback for the $Table object.

PageDateWidget

Synopsis

my $Text = $PageAdmin->PageDateWidget (\%P);

Description

Returns the time as string.

editPageTablePage

Synopsis

my $Text = $PageAdmin->editPageTablePage ($Page);

Description

Calls the editPage method.

editPage

Synopsis

my $Text = $PageAdmin->editPage ($Page);

Description

Edit a page.

editElementPage

Synopsis

my $Text = $PageAdmin->editElementPage ($Page);

Description

Edit an element page.

editElementContentField

Synopsis

my $ContentForm = $PageAdmin->editElementContentField (\%P);

Description

Edit an elements content.

editDatabaseFile

Synopsis

my $ContentForm = $PageAdmin->editDatabaseFile (\%P);

Description

Edit a page of type DatabaseFile.

addElementTemplate

Synopsis

my $Text = $PageAdmin->addElementTemplate ($ElementTable, $PageTable);

Description

Add an ElementTemplate.

additionalPageMenu

Synopsis

my $additionalEntries = $PageAdmin->additionalPageMenu ($CGI, $hidden);

Description

Adds additional entries to the page menu.

deletePage

Synopsis

my $TreePageText = $PageAdmin->deletePage ($Page);

Description

Deletes a page.

movePage

Synopsis

my $ErrorText = $PageAdmin->movePage ();

Description

Moves a page.

editPageDisplayTypePopupMenu

Synopsis

my $ErrorText = $PageAdmin->editPageDisplayTypePopupMenu ($Header, $defaultDisplayType);

Description

Return a page to select an element.

selectElement

Synopsis

my $ErrorText = $PageAdmin->selectElement ($Page, $TableName);

Description

Return a page to select an element.

copyPage

Synopsis

my $ErrorText = $PageAdmin->copyPage ($Page);

Description

Copies a page.

displayedPageURL

Synopsis

my $PageURL = $PageAdmin->displayedPageURL ($Page);

Description

Displayes a pages URL. Method takes a page object, not a PageAdmin object. used in the PageAdmin frame page to supply the URL of the page to be displayed.

displayedMenueURL

Synopsis

my $PageURL = $PageAdmin->displayedMenueURL ();

Description

Displayes a pages URL. Method takes a page object, not a PageAdmin object. used in the PageAdmin frame page to supply the URL of the page to be displayed.

showPage

Synopsis

my $Page = $PageAdmin->showPage ($Page);

Description

Displayes a page.

HTTPD_ServerUserProcessDir

Synopsis

my $HTTPD_ServerUserProcessDir = $PageAdmin->HTTPD_ServerUserProcessDir ($Page);

Description

Returns the process directory of a registered unser.

backupPage

Synopsis

$ErrorText = $PageAdmin->backupPage ($Page);

Description

Backup pages of the page tree.

setPageStatus

Synopsis

$ErrorText = $PageAdmin->setPageStatus ($Status, $where);

Description

Sets a pages status.

1