Maxscape::ServerApplication Package

Maxscape::ServerApplication Package

Synopsis

use Maxscape::ServerApplication;

Description

The applications for the Strinx server.

List of Member Functions

  1. ChatRequest
  2. ChatRoomName
  3. ChatWith
  4. CheckChatRequest
  5. ContextCallback
  6. deleteChatFiles
  7. displayMainMenuHyperlink
  8. DocumentCallback
  9. DocumentNotFound
  10. enableFinalFilter
  11. encodeChatRoomName
  12. finalFilter
  13. findProfileTypes
  14. findProfileTypeTables
  15. findSearchProfileTypeTables
  16. HTTP_HeaderCallback
  17. initialPageGenerationCallback
  18. lookupProfileTypes
  19. Maxscape::ServerApplication::BodyBgColor
  20. Maxscape::ServerApplication::Countries
  21. Maxscape::ServerApplication::CountriesAsString
  22. Maxscape::ServerApplication::displayImage
  23. Maxscape::ServerApplication::displayUserHomePage
  24. Maxscape::ServerApplication::displayUserHomePage2
  25. Maxscape::ServerApplication::displayUserHomePageWrapper
  26. Maxscape::ServerApplication::displayUserImage
  27. Maxscape::ServerApplication::getCategoryTypes
  28. Maxscape::ServerApplication::getCategoryTypesContent
  29. Maxscape::ServerApplication::HeaderColor
  30. Maxscape::ServerApplication::initMenu
  31. Maxscape::ServerApplication::IntroText
  32. Maxscape::ServerApplication::printSubCategory
  33. openExternalLinkWindow
  34. PageGroupPermission
  35. PageHeaderText
  36. PageStandardSkeleton
  37. processElement
  38. ProfileTableNames
  39. ProfileTypeEnabled
  40. selectChangeTableDescriptionKey
  41. selectFindTableDescriptionKey
  42. selectProfileType
  43. selectShowTableDescriptionKey
  44. showEncodedCategoryName
  45. TempChatFilePath

Member Functions

Synopsis

use Maxscape::ServerApplication;

Description

The applications for the Strinx server.

List of Member Functions

  1. ChatRequest
  2. ChatRoomName
  3. ChatWith
  4. CheckChatRequest
  5. ContextCallback
  6. deleteChatFiles
  7. displayMainMenuHyperlink
  8. DocumentCallback
  9. DocumentNotFound
  10. enableFinalFilter
  11. encodeChatRoomName
  12. finalFilter
  13. findProfileTypes
  14. findProfileTypeTables
  15. findSearchProfileTypeTables
  16. HTTP_HeaderCallback
  17. initialPageGenerationCallback
  18. lookupProfileTypes
  19. Maxscape::ServerApplication::BodyBgColor
  20. Maxscape::ServerApplication::Countries
  21. Maxscape::ServerApplication::CountriesAsString
  22. Maxscape::ServerApplication::displayImage
  23. Maxscape::ServerApplication::displayUserHomePage
  24. Maxscape::ServerApplication::displayUserHomePage2
  25. Maxscape::ServerApplication::displayUserHomePageWrapper
  26. Maxscape::ServerApplication::displayUserImage
  27. Maxscape::ServerApplication::getCategoryTypes
  28. Maxscape::ServerApplication::getCategoryTypesContent
  29. Maxscape::ServerApplication::HeaderColor
  30. Maxscape::ServerApplication::initMenu
  31. Maxscape::ServerApplication::IntroText
  32. Maxscape::ServerApplication::printSubCategory
  33. openExternalLinkWindow
  34. PageGroupPermission
  35. PageHeaderText
  36. PageStandardSkeleton
  37. processElement
  38. ProfileTableNames
  39. ProfileTypeEnabled
  40. selectChangeTableDescriptionKey
  41. selectFindTableDescriptionKey
  42. selectProfileType
  43. selectShowTableDescriptionKey
  44. showEncodedCategoryName
  45. TempChatFilePath

Member Functions

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 run-time's $Page object.

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.

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.

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.

HTTP_HeaderCallback

Synopsis

my $filteredText = Maxscape::ServerApplication::HTTP_HeaderCallback (
                    $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 $MenuInitialised = Maxscape::ServerApplication::initMenu ();

Description

Is the menu initialised?

Maxscape::ServerApplication::IntroText

Synopsis

Maxscape::ServerApplication::IntroText ($Page, $Text);

Description

Returns an introduction text.

Examples

Maxscape::ServerApplication::IntroText ($Page, '
Welcome to your personal page.
');
@{[Maxscape::ServerApplication::IntroText ($Page, 'Take a tour...', { ImageAlign => 'right'})]}

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

ChatRoomName

Synopsis

my $ChatRoomName = Maxscape::ServerApplication::ChatRoomName ('foo', 'bar');

Description

Returns an encoded chat room name.

encodeChatRoomName

Synopsis

my $ChatRoomName = Maxscape::ServerApplication::encodeChatRoomName (
                     $Page, $CategoryName);

Description

Returns an encoded chat room name.

PageHeaderText

Synopsis

my $RequestLinks = Maxscape::ServerApplication::PageHeaderText ($Page);

Description

Returns a page header.

ChatRequest

Synopsis

my ($lastLoginTime, $LoginTime) = Maxscape::ServerApplication::ChatRequest (
                                    $Page);

Description

Request a chat.

CheckChatRequest

Synopsis

my ($ChatRequestUsers) = Maxscape::ServerApplication::CheckChatRequest($Page);

Description

Requests a chat with a user.

ChatWith

Synopsis

my $UserId = Maxscape::ServerApplication::ChatWith($Page);

Description

Returns a personal chat user.

TempChatFilePath

Synopsis

Maxscape::ServerApplication::TempChatFilePath();

Description

Returns a chat file path.

deleteChatFiles

Synopsis

Maxscape::ServerApplication::deleteChatFiles();

Description

Deletes the chat files.

Maxscape::ServerApplication::printSubCategory

Synopsis

Maxscape::ServerApplication::printSubCategory($Values);

Description

Returns a a sub category.

showEncodedCategoryName

Synopsis

my $ErrorText = Maxscape::ServerApplication::showEncodedCategoryName (
                 $Page, $CategoryName);

Description

Returns an encoded category name.

Maxscape::ServerApplication::getCategoryTypes

Synopsis

Maxscape::ServerApplication::getCategoryTypes($Page, $CategoryGroups);

Description

To do.

Maxscape::ServerApplication::getCategoryTypesContent

Synopsis

Maxscape::ServerApplication::getCategoryTypesContenti (
  $Page, $Cursor, $CategoryGroup);

Description

Gets the category's type content.

selectProfileType

Synopsis

Maxscape::ServerApplication::selectProfileType (
  $Page, $Page->{Data}{UserName}, $Page->{CGI}->{ProfileType});

Description

Selects a profile type.

Examples

($Page->{Data}{UserName}, $Page->{CGI}->{ProfileType},
$Page->{Data}{ProfileTypesAsString}) = 
Maxscape::ServerApplication::selectProfileType (
  $Page, $Page->{Data}{UserName}, $Page->{CGI}->{ProfileType});

ProfileTableNames

Synopsis

Maxscape::ServerApplication::ProfileTableNames ($ProfileType);

Description

To do.

Examples

my $TableName = Maxscape::ServerApplication::ProfileTableNames ($ProfileType);

findProfileTypeTables

Synopsis

Maxscape::ServerApplication::findProfileTypeTables ($Page, $ProfileType);

Description

Finds the user's group related data and places them in the $Page->{Data} object.

Examples

Maxscape::ServerApplication::findProfileTypeTables (
  $Page, $Page->{CGI}->{ProfileType}
);

findSearchProfileTypeTables

Synopsis

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

Description

Finds the search profile type tables.

findProfileTypes

Synopsis

Maxscape::ServerApplication::findProfileTypes ($Page, $Category);

Description

Finds the user's group related data and places them in the $Page->{Data} object.

selectShowTableDescriptionKey

Synopsis

my $TableDescriptionKey =
      Maxscape::ServerApplication::selectShowTableDescriptionKey ($Page);

Description

Selects a table's description key.

selectChangeTableDescriptionKey

Synopsis

my $TableDescriptionKey = Maxscape::ServerApplication::selectChangeTableDescriptionKey ($Page);

Description

Selects a table's description key.

selectFindTableDescriptionKey

Synopsis

my ($basicTableDescriptionKey, $AppTableDescriptionKey) =
       Maxscape::ServerApplication::selectFindTableDescriptionKey ($Page);

Description

Selects a table's description key.

lookupProfileTypes

Synopsis

my $ProfileType = Maxscape::ServerApplication::lookupProfileTypes ($UserId);

Description

This function gets the user groups from the users PROFILE table.

ProfileTypeEnabled

Synopsis

if (Maxscape::ServerApplication::ProfileTypeEnabled (
     $Group, $Page->{Data}{ProfileTypesAsString}))
{
  print STDERR "Yes, this group is enabled.\n";
  return '';
}

Description

This function tells, if a user has enabled the group '$Group'.

Maxscape::ServerApplication::displayUserImage

Synopsis

my $ImageLink = Maxscape::ServerApplication::displayUserImage(
                  $Page, $Size, 'UserImages');

Description

Returns a user's profile image.

Maxscape::ServerApplication::displayUserHomePageWrapper

Synopsis

my $ImageLink = Maxscape::ServerApplication::displayUserHomePageWrapper(
                  $Page, $UserId, $Text, $ProfileType);

Description

To do.

Maxscape::ServerApplication::displayUserHomePage

Synopsis

my $ImageLink = Maxscape::ServerApplication::displayUserHomePage ($Page, $Field,
                                                              $reload, $Color);

Description

Returns a user's home page.

Maxscape::ServerApplication::displayUserHomePage2

Synopsis

my $ImageLink = Maxscape::ServerApplication::displayUserHomePage2($Page, $User,
                                        $LinkText, $QueryString, $ProfileType);

Description

Returns a user's home page.

Maxscape::ServerApplication::BodyBgColor

Synopsis

my $BodyBgColor = Maxscape::ServerApplication::BodyBgColor ($Page);

Description

Returns the HTML body color.

Maxscape::ServerApplication::HeaderColor

Synopsis

my $HeaderColor = Maxscape::ServerApplication::HeaderColor ($Page);

Description

Returns the HTML header color.

Maxscape::ServerApplication::displayImage

Synopsis

my $ImageLink = Maxscape::ServerApplication::displayImage (%P);

Description

Displays an image.

Examples

my $ImageLink = Maxscape::ServerApplication::displayImage ($Page,
     ServerRoot      => "/maxscape/server/$::WebServer->{WebServerName}/docs",
     ImageDirectory  => $Page->{Data}{ImageDirectory},
     ImageName       => "$Page->{Data}{AdNumber}_Picture.jpg",
     MaxLength       => 200,
);
my $ImageLink = Maxscape::ServerApplication::displayImage ($Page,
     readImageData   => ,
     img_src         => ,
     ImageData       => ,
     MaxLength       => 200,
);

Maxscape::ServerApplication::Countries

Synopsis

my $Countries = Maxscape::ServerApplication::Countries ($Page, $Type, $OtherCountries);

Description

Returns all countries as an array.

Maxscape::ServerApplication::CountriesAsString

Synopsis

my $Countries = Maxscape::ServerApplication::CountriesAsString ();

Description

Returns all countries as a string.

displayMainMenuHyperlink

Synopsis

my $MenuHTML_Text =$Menu->displayMainMenuHyperlink (%P);

Description

Displays a menu of the category tree in the context of the current page. The function is imported into the Maxscape::Menu package.

Examples

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

openExternalLinkWindow

Synopsis

Maxscape::Page::openExternalLinkWindow (%P);

Description

Opens a browser window with an external hyperlink. The function is imported into the Maxscape::Page package.

DocumentNotFound

Synopsis

Maxscape::ServerApplication::DocumentNotFound (%P);

Description

Document not found callback.

DocumentCallback

Synopsis

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

Description

To do.

PageStandardSkeleton

Synopsis

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

Description

To do.

processElement

Synopsis

Maxscape::ServerApplication::processElement ($Page, $Element);

Description

Processes the database page elements.

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