Maxscape::GlobalServerApplication Package

Synopsis

use Maxscape::GlobalServerApplication;

Description

An application progamming plugin file for applications, that are common to all webservers.

List of Member Functions

  1. ChatRequest
  2. ChatWith
  3. CheckChatRequest
  4. checkProjectMemberNames
  5. checkProjectName
  6. ContextCallback
  7. createProject
  8. createProjectPages
  9. deleteChatFiles
  10. displayMainMenuHyperlink
  11. enableFinalFilter
  12. finalFilter
  13. HTTP_HeaderCallback
  14. initialPageGenerationCallback
  15. initMenu
  16. manageProject
  17. Maxscape::ServerApplication::BodyBgColor
  18. Maxscape::ServerApplication::ContentTypes
  19. Maxscape::ServerApplication::Countries
  20. Maxscape::ServerApplication::CountriesAsString
  21. Maxscape::ServerApplication::displayImage
  22. Maxscape::ServerApplication::displayProfileImage
  23. Maxscape::ServerApplication::displayUserHomePage
  24. Maxscape::ServerApplication::displayUserHomePage2
  25. Maxscape::ServerApplication::getCategoryTypes
  26. Maxscape::ServerApplication::getCategoryTypesContent
  27. Maxscape::ServerApplication::HeaderColor
  28. Maxscape::ServerApplication::IntroText
  29. Maxscape::ServerApplication::MiniChat
  30. Maxscape::ServerApplication::printSubCategory
  31. Maxscape::ServerApplication::searchUser
  32. Maxscape::ServerApplication::searchUserMaxscape
  33. MenuHeaderRule
  34. PageGroupPermission
  35. selectRandomImage
  36. showEncodedCategoryName
  37. 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 runtime's 'Page' object.

ContextCallback

Synopsis

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

Description

This context callback function is set in the maxscape.conf' by the variable $::WebServer->{"Context.InitialClientRequestCallback"}. The name is Maxscape::ServerApplication::ContextCallback.

The function alters the name and the category of the page to be generated, before the database is queried. To use this functionality in a page, a page element named Object.execute is defined and its element attribute is set to Callback="Name of the callback". The code of the callback is defined in the Maxscape::ServerApplication::ContextCallback function, which is stored in the file lib/perl/Maxscape/ServerApplication.pm.

enableFinalFilter

Synopsis

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

Description

If the 'enableFinalFilter' function returns a non zero value, the 'finalFilter' 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.

initMenu

Synopsis

my $MenuArrayRef = initMenu ($Page);

Description

Returns an array reference to the global menu.

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

Maxscape::ServerApplication::IntroText

Synopsis




Description



Returns an introduction text.




Examples


Maxscape::ServerApplication::IntroText ($Page, 'Welcome...');

@{[Maxscape::ServerApplication::IntroText ($Page, 'Take a tour...',
                                           { ImageAlign => 'right'})
]}





Maxscape::ServerApplication::printSubCategory



Synopsis


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




Description



Returns sub categories.





showEncodedCategoryName



Synopsis


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




Description



Encodes category names.





Maxscape::ServerApplication::getCategoryTypes



Synopsis


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




Description



Get the category types.





Maxscape::ServerApplication::getCategoryTypesContent



Synopsis


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




Description



Gets the content types. 





Maxscape::ServerApplication::BodyBgColor



Synopsis


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




Description



Returns the color of an HTML body.





Maxscape::ServerApplication::HeaderColor



Synopsis


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




Description



Returns the header color of an HTML header.





Maxscape::ServerApplication::displayImage



Synopsis


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




Description



Displays an image resized by GD.





Maxscape::ServerApplication::displayUserHomePage



Synopsis


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




Description



Returns a link to a user's home page.





Maxscape::ServerApplication::displayUserHomePage2



Synopsis


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




Description



Returns a link to a user's home page.





Maxscape::ServerApplication::Countries



Synopsis


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




Description



Returns a list of contries.





Maxscape::ServerApplication::CountriesAsString



Synopsis


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




Description



Returns a list of contries, as a string.





Maxscape::ServerApplication::ContentTypes



Synopsis


my $ContentType = Maxscape::ServerApplication::ContentTypes ();




Description



To do.





Maxscape::ServerApplication::searchUserMaxscape



Synopsis


my $Countries = &Maxscape::ServerApplication::searchUserMaxscape ();




Description



Searches a user.





Maxscape::ServerApplication::searchUser



Synopsis


my $Countries = &Maxscape::ServerApplication::searchUser ();




Description



Searches a user.





ChatRequest



Synopsis


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




Description



Makes a chat request.





CheckChatRequest



Synopsis


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




Description



Checkes a chat request.





ChatWith



Synopsis


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




Description



To to.





TempChatFilePath



Synopsis


&Maxscape::ServerApplication::TempChatFilePath();




Description



To to.





deleteChatFiles



Synopsis


&Maxscape::ServerApplication::deleteChatFiles();




Description



To to.





Maxscape::ServerApplication::MiniChat



Synopsis


Maxscape::ServerApplication::MiniChat ($Page, $ChatType, $MaxSaveLines);




Description



Implements a mini chat.





Maxscape::ServerApplication::displayProfileImage



Synopsis


my $ImageLink = &Maxscape::ServerApplication::displayUserImage($Page,
   UserId      => $UserId,
   Size        => $Size,
   ImageRoot   => $ImageRoot,
   CSSClass    => $CSSClass,
);




Description



Returns a profile image.





displayMainMenuHyperlink



Synopsis


my $HyperlinkText = $Menu->displayMainMenuHyperlink (%Parameter);




Description


 
Return a menu's hyperlink.




Examples


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





MenuHeaderRule



Synopsis


my $HeaderRule = $Menu->MenuHeaderRule ();




Description



Returns an HTML header rule.





selectRandomImage



Synopsis


$Page->selectRandomImage ($Parameter);




Description



Selects a random image.





createProject



Synopsis


$Page->createProject ($PageTreeDocumentRoot);




Description



Creates a project.





checkProjectName



Synopsis


$Page->checkProjectName ($PageTreeDocumentRoot, $ProjectName);




Description



Checks a project name.





createProjectPages



Synopsis


$Page->createProjectPages ($PageTreeDocumentRoot, $ProjectName);




Description



Creates project pages.





manageProject



Synopsis


$Page->manageProject ($PageTreeDocumentRoot);




Description



Manage a project.





checkProjectMemberNames



Synopsis


$Page->checkProjectMemberNames ($PageTreeDocumentRoot, $ProjectName);




Description



Checks project member names.






1


  






  

    
      Next ∙ Previous ∙ Top ∙ Join ∙ Contact
    
    
     © Maxscape