Class SortablePage

com.woltlab.wcf.page

Description

Provides default implementations for a sortable page of listed items.

Handles the sorting parameters automatically.

  • author: Marcel Werk
  • copyright: 2001-2009 WoltLab GmbH
  • abstract:
  • license: GNU
AbstractPage
   |
   --MultipleLinkPage
      |
      --SortablePage

Direct descendents

Class Description
BoardPage Shows the board page.
ModerationThreadsPage Provides default implementations for the pages of thread moderation.
SubscriptionsListPage Shows the subscription page.
AvatarCategoryListPage Shows a list of avatar categories.
AvatarListPage Shows a list of avatars.
BBCodeListPage Shows a list of installed bbcodes.
CronjobsListPage Shows information about configured cron jobs.
CronjobsShowLogPage Shows cron jobs log information.
FailedLoginListPage Shows a list of failed user logins.
GroupListPage Shows a list of all user groups.
LanguageListPage Shows a list of all installed languages.
PackageListPage Shows a list of all installed packages.
PackageUpdateSearchResultPage Shows the list of package update search results.
SessionLogListPage Shows a list of log sessions.
SessionLogPage Shows the details of a logged sessions.
SmileyCategoryListPage Shows a list of smiley categories.
SmileyListPage Shows a list of installed smilies.
SuspensionListPage Shows a list of predefined suspensions.
TemplatePackListPage Shows a list of installed template packs.
UpdateServerListPage Shows information about available update package servers.
UserListPage Shows the result of a user search.
UserOptionCategoryListPage Shows a list of user option categories.
UserOptionListPage Shows a list of installed user options.
UserRankListPage Shows a list of user ranks.
UserSuspensionListPage Shows a list of user suspensions.
UserWarningListPage Shows a list of active user warnings.
WarningListPage Shows a list of predefined warnings.
AbstractAttachmentListPage Shows a list of attachments.
CalendarBirthdayEventPage Shows a birthday event page
CalendarEventsPage Shows the start page of the calendar.
CalendarListPage Lists all calendars
MembersListPage Shows a list of all members.
PMListPage Lists all private messages in the folder with the given folder id.
PMRuleListPage Shows a list of all rules.
UserGalleryOverviewPage Shows an overview of all user galleries.
UserGalleryPhotosPage Shows a list of tagged photos.
UserGroupLeaderPage Shows the user group leader page.
UsersOnlinePage Shows the users online page.

Variable Summary

Type Name
string $defaultSortField
string $defaultSortOrder
string $sortField
string $sortOrder

Method Summary

Return Name
void assignVariables()
void readData()
void readParameters()
void validateSortField()
void validateSortOrder()

Variables

$defaultSortField

public string $defaultSortField = ''

The default sort field.

Redefined in descendants as: BoardPage::$defaultSortField, ModerationThreadsPage::$defaultSortField, SubscriptionsListPage::$defaultSortField, AvatarCategoryListPage::$defaultSortField, AvatarListPage::$defaultSortField, BBCodeListPage::$defaultSortField, CronjobsListPage::$defaultSortField, CronjobsShowLogPage::$defaultSortField, FailedLoginListPage::$defaultSortField, GroupListPage::$defaultSortField, LanguageListPage::$defaultSortField, PackageListPage::$defaultSortField, PackageUpdateSearchResultPage::$defaultSortField, SessionLogListPage::$defaultSortField, SessionLogPage::$defaultSortField, SmileyCategoryListPage::$defaultSortField, SmileyListPage::$defaultSortField, SuspensionListPage::$defaultSortField, TemplatePackListPage::$defaultSortField, UpdateServerListPage::$defaultSortField, UserListPage::$defaultSortField, UserOptionCategoryListPage::$defaultSortField, UserOptionListPage::$defaultSortField, UserRankListPage::$defaultSortField, UserSuspensionListPage::$defaultSortField, UserWarningListPage::$defaultSortField, WarningListPage::$defaultSortField, AbstractAttachmentListPage::$defaultSortField, CalendarBirthdayEventPage::$defaultSortField: Default sort field of user birthdays, CalendarEventsPage::$defaultSortField: default sort field of events, CalendarListPage::$defaultSortField, MembersListPage::$defaultSortField, PMListPage::$defaultSortField, PMRuleListPage::$defaultSortField, UserGalleryOverviewPage::$defaultSortField, UserGalleryPhotosPage::$defaultSortField, UserGroupLeaderPage::$defaultSortField, UsersOnlinePage::$defaultSortField

$defaultSortOrder

public string $defaultSortOrder = 'ASC'

The default sort order.

Redefined in descendants as: BoardPage::$defaultSortOrder, ModerationThreadsPage::$defaultSortOrder, SubscriptionsListPage::$defaultSortOrder, CronjobsShowLogPage::$defaultSortOrder, FailedLoginListPage::$defaultSortOrder, PackageListPage::$defaultSortOrder, SessionLogListPage::$defaultSortOrder, UserSuspensionListPage::$defaultSortOrder, CalendarBirthdayEventPage::$defaultSortOrder: Default sort order of user birthdays, CalendarEventsPage::$defaultSortOrder: default sort order of events, MembersListPage::$defaultSortOrder, PMListPage::$defaultSortOrder, UserGalleryOverviewPage::$defaultSortOrder, UserGalleryPhotosPage::$defaultSortOrder, UserGroupLeaderPage::$defaultSortOrder, UsersOnlinePage::$defaultSortOrder

$sortField

public string $sortField = ''

The selected sort field.

$sortOrder

public string $sortOrder = ''

The selected sort order.

Inherited variables from MultipleLinkPage

MultipleLinkPage::$endIndex, MultipleLinkPage::$items, MultipleLinkPage::$itemsPerPage, MultipleLinkPage::$pageNo, MultipleLinkPage::$pages, MultipleLinkPage::$startIndex

Inherited variables from AbstractPage

AbstractPage::$action, AbstractPage::$neededPermissions, AbstractPage::$templateName

Methods

assignVariables

public void assignVariables()

Redefinition of: MultipleLinkPage::assignVariables()

Redefined in descendants as: BoardPage::assignVariables(), ModerationThreadsPage::assignVariables(), SubscriptionsListPage::assignVariables(), AvatarCategoryListPage::assignVariables(), AvatarListPage::assignVariables(), BBCodeListPage::assignVariables(), CronjobsListPage::assignVariables(), CronjobsShowLogPage::assignVariables(), FailedLoginListPage::assignVariables(), GroupListPage::assignVariables(), LanguageListPage::assignVariables(), PackageListPage::assignVariables(), PackageUpdateSearchResultPage::assignVariables(), SessionLogListPage::assignVariables(), SessionLogPage::assignVariables(), SmileyCategoryListPage::assignVariables(), SmileyListPage::assignVariables(), SuspensionListPage::assignVariables(), TemplatePackListPage::assignVariables(), UpdateServerListPage::assignVariables(), UserListPage::assignVariables(), UserOptionCategoryListPage::assignVariables(), UserOptionListPage::assignVariables(), UserRankListPage::assignVariables(), UserSuspensionListPage::assignVariables(), UserWarningListPage::assignVariables(), WarningListPage::assignVariables(), AbstractAttachmentListPage::assignVariables(), AdminAttachmentListPage::assignVariables(), CalendarBirthdayEventPage::assignVariables(), CalendarEventsPage::assignVariables(), CalendarEventsModerationPage::assignVariables(), CalendarListPage::assignVariables(), CalendarModerationPage::assignVariables(), MembersListPage::assignVariables(), UserFriendListPage::assignVariables(), TeamPage::assignVariables(), PMListPage::assignVariables(), PMViewPage::assignVariables(), PMRuleListPage::assignVariables(), UserGalleryOverviewPage::assignVariables(), UserGalleryPhotosPage::assignVariables(), UserGroupLeaderPage::assignVariables(), UsersOnlinePage::assignVariables()

readData

public void readData()

Redefinition of: MultipleLinkPage::readData()

Redefined in descendants as: BoardPage::readData(), ModerationThreadsPage::readData(), SubscriptionsListPage::readData(), AvatarCategoryListPage::readData(), AvatarListPage::readData(), BBCodeListPage::readData(), CronjobsListPage::readData(), CronjobsShowLogPage::readData(), FailedLoginListPage::readData(), GroupListPage::readData(), LanguageListPage::readData(), PackageListPage::readData(), PackageUpdateSearchResultPage::readData(), SessionLogListPage::readData(), SessionLogPage::readData(), SmileyCategoryListPage::readData(), SmileyListPage::readData(), SuspensionListPage::readData(), TemplatePackListPage::readData(), UpdateServerListPage::readData(), UserListPage::readData(), UserOptionCategoryListPage::readData(), UserOptionListPage::readData(), UserSuspensionListPage::readData(), UserWarningListPage::readData(), WarningListPage::readData(), AbstractAttachmentListPage::readData(), CalendarBirthdayEventPage::readData(), CalendarEventsPage::readData(), CalendarEventsModerationPage::readData(), CalendarListPage::readData(), MembersListPage::readData(), MyFriendsListPage::readData(), PMListPage::readData(), PMViewPage::readData(), PMRuleListPage::readData(), UserGalleryOverviewPage::readData(), UserGalleryPhotosPage::readData(), UserGroupLeaderPage::readData(), UsersOnlinePage::readData()

readParameters

public void readParameters()

Redefinition of: MultipleLinkPage::readParameters()

Redefined in descendants as: BoardPage::readParameters(), ModerationThreadsPage::readParameters(), SubscriptionsListPage::readParameters(), AvatarCategoryListPage::readParameters(), AvatarListPage::readParameters(), BBCodeListPage::readParameters(), CronjobsListPage::readParameters(), FailedLoginListPage::readParameters(), GroupListPage::readParameters(), LanguageListPage::readParameters(), PackageUpdateSearchResultPage::readParameters(), SessionLogListPage::readParameters(), SessionLogPage::readParameters(), SmileyCategoryListPage::readParameters(), SmileyListPage::readParameters(), SuspensionListPage::readParameters(), TemplatePackListPage::readParameters(), UpdateServerListPage::readParameters(), UserListPage::readParameters(), UserOptionCategoryListPage::readParameters(), UserOptionListPage::readParameters(), UserRankListPage::readParameters(), UserSuspensionListPage::readParameters(), UserWarningListPage::readParameters(), WarningListPage::readParameters(), AbstractAttachmentListPage::readParameters(), AdminAttachmentListPage::readParameters(), UserAttachmentListPage::readParameters(), CalendarBirthdayEventPage::readParameters(), CalendarEventsPage::readParameters(), CalendarListPage::readParameters(), CalendarModerationPage::readParameters(), MembersListPage::readParameters(), UserFriendListPage::readParameters(), PMListPage::readParameters(), PMViewPage::readParameters(), PMRuleListPage::readParameters(), UserGalleryOverviewPage::readParameters(), UserGalleryPhotosPage::readParameters(), UsersOnlinePage::readParameters()

validateSortField

public void validateSortField()

Validates the given sort field parameter.

Redefined in descendants as: BoardPage::validateSortField(), ModerationThreadsPage::validateSortField(), SubscriptionsListPage::validateSortField(), AvatarCategoryListPage::validateSortField(), AvatarListPage::validateSortField(), BBCodeListPage::validateSortField(), CronjobsListPage::validateSortField(), CronjobsShowLogPage::validateSortField(), FailedLoginListPage::validateSortField(), GroupListPage::validateSortField(), LanguageListPage::validateSortField(), PackageListPage::validateSortField(), PackageUpdateSearchResultPage::validateSortField(), SessionLogListPage::validateSortField(), SessionLogPage::validateSortField(), SmileyCategoryListPage::validateSortField(), SmileyListPage::validateSortField(), SuspensionListPage::validateSortField(), TemplatePackListPage::validateSortField(), UpdateServerListPage::validateSortField(), UserListPage::validateSortField(), UserOptionCategoryListPage::validateSortField(), UserOptionListPage::validateSortField(), UserRankListPage::validateSortField(), UserSuspensionListPage::validateSortField(), UserWarningListPage::validateSortField(), WarningListPage::validateSortField(), AbstractAttachmentListPage::validateSortField(), CalendarBirthdayEventPage::validateSortField(), CalendarEventsPage::validateSortField(), CalendarListPage::validateSortField(), MembersListPage::validateSortField(), PMListPage::validateSortField(), PMRuleListPage::validateSortField(), UserGalleryOverviewPage::validateSortField(), UserGalleryPhotosPage::validateSortField(), UserGroupLeaderPage::validateSortField(), UsersOnlinePage::validateSortField()

validateSortOrder

public void validateSortOrder()

Validates the given sort order parameter.

Inherited methods from MultipleLinkPage

MultipleLinkPage::assignVariables(), MultipleLinkPage::calculateNumberOfPages(), MultipleLinkPage::countItems(), MultipleLinkPage::readData(), MultipleLinkPage::readParameters()

Inherited methods from AbstractPage

AbstractPage::__construct(), AbstractPage::assignVariables(), AbstractPage::readData(), AbstractPage::readParameters(), AbstractPage::show()