*/
class ACPForm extends AbstractForm {
/**
- * Active acp menu item.
- *
+ * active acp menu item
* @var string
*/
public $activeMenuItem = '';
/**
* list of all option categories
- * @var array<OptionCategory>
+ * @var array<wcf\data\option\category\OptionCategory>
*/
public $cachedCategories = array();
/**
* list of all options
- * @var array<Option>
+ * @var array<wcf\data\option\Option>
*/
public $cachedOptions = array();
/**
* cronjob id
- *
* @var integer
*/
public $cronjobID = 0;
/**
* cronjob object
- *
- * @var Cronjob
+ * @var wcf\data\cronjob\Cronjob
*/
public $cronjob = null;
/**
* user object
- * @var User
+ * @var wcf\data\user\User
*/
public $user;
/**
* master password
- *
* @var string
*/
public $masterPassword = '';
/**
* forward url
- *
* @var string
*/
public $url = '';
/**
* master password confirm
- *
* @var string
*/
public $confirmMasterPassword = '';
public $templateName = 'optionImport';
/**
- * @see wcf\acp\form\ACPForm::$activeMenuItem
+ * @see wcf\page\AbstractPage::$neededPermissions
*/
- public $activeMenuItem = 'wcf.acp.menu.link.option.importAndExport';
+ public $neededPermissions = array('admin.system.canEditOption');
/**
- * @see wcf\page\AbstractPage::$neededPermissions
+ * @see wcf\acp\form\ACPForm::$activeMenuItem
*/
- public $neededPermissions = array('admin.system.canEditOption');
+ public $activeMenuItem = 'wcf.acp.menu.link.option.importAndExport';
/**
* upload file data
* @category Community Framework
*/
class PackageStartInstallForm extends ACPForm {
+ /**
+ * @see wcf\page\AbstractPage::$templateName
+ */
public $templateName = 'packageStartInstall';
+
+ /**
+ * @see wcf\acp\form\ACPForm::$activeMenuItem
+ */
public $activeMenuItem = 'wcf.acp.menu.link.package.install';
-
+
+ /**
+ * id of the updated package
+ * @var integer
+ */
public $packageID = 0;
+
+ /**
+ * updated package object
+ * @var wcf\system\package\Package
+ */
public $package = null;
+
+ /**
+ * url to the package to download
+ * @var string
+ */
public $downloadPackage = '';
+
+ /**
+ * data of the uploaded package
+ * @var array<string>
+ */
public $uploadPackage = '';
+
+ /**
+ * archive of the instalation/update package
+ * @var wcf\system\package\PackageArchive
+ */
public $archive = null;
+
+ /**
+ * package installation/update queue
+ * @var wcf\data\package\installation\queue\PackageInstallationQueue
+ */
public $queue = null;
/**
* @category Community Framework
*/
class PackageUpdateAuthForm extends ACPForm {
+ /**
+ * @see wcf\page\AbstractPage::$templateName
+ */
public $templateName = 'packageUpdateAuth';
+
+ /**
+ * @see wcf\page\AbstractPage::$neededPermissions
+ */
public $neededPermissions = array('admin.system.package.canUpdatePackage', 'admin.system.package.canInstallPackage');
+
+ /**
+ * @see wcf\acp\form\ACPForm::$activeMenuItem
+ */
public $activeMenuItem = 'wcf.acp.menu.link.package';
- public $exception;
+ /**
+ * exception thrown if an authorization for the package update server is needed
+ * @var wcf\system\package\PackageUpdateAuthorizationRequiredException
+ */
+ public $exception = null;
+
+ /**
+ * login username for package update server
+ * @var string
+ */
public $loginUsername = '';
+
+ /**
+ * login password for package update server
+ * @var string
+ */
public $loginPassword = '';
+
+ /**
+ * indicates if login data is saved
+ * @var integer
+ */
public $saveAuthData = 0;
+ /**
+ * id of the relevant package update server
+ * @var integer
+ */
public $packageUpdateServerID = 0;
+
+ /**
+ * url of the relevant package update server
+ * @var integer
+ */
public $url = '';
- public $eader = '';
+
+ /**
+ * response header of the relavent package update server
+ * @var string
+ */
+ public $header = '';
+
+ /**
+ * realm part of the response header
+ * @var string
+ */
public $realm = '';
+
+ /**
+ * response of the relevant package update server
+ * @var integer
+ */
public $message = '';
+ /**
+ * post parameters of the form
+ * @var string
+ */
public $postParameters = '';
+
+ /**
+ * get parameters of the form
+ * @var string
+ */
public $getParameters = '';
+ /**
+ * list of reserved parameters that may not be part of the post and get
+ * parameters
+ * @var array<string>
+ */
protected static $reservedParameters = array('s', 'packageID', 'page', 'form', 'action', 'packageUpdateServerID', 'loginUsername', 'loginPassword', 'saveAuthData', 'requestedPage', 'requestedForm', 'requestedAction');
/**
* @category Community Framework
*/
class PackageUpdateForm extends ACPForm {
+ /**
+ * @see wcf\page\AbstractPage::$templateName
+ */
public $templateName = 'packageUpdate';
+
+ /**
+ * @see wcf\page\AbstractPage::$neededPermissions
+ */
public $neededPermissions = array('admin.system.package.canUpdatePackage', 'admin.system.package.canInstallPackage');
+
+ /**
+ * @see wcf\acp\form\ACPForm::$activeMenuItem
+ */
public $activeMenuItem = 'wcf.acp.menu.link.package';
+ /**
+ * list of packages to update
+ * @var array<string>
+ */
public $updates = array();
+
+ /**
+ * list with data of excluded packages
+ * @var array<array>
+ */
public $excludedPackages = array();
+
+ /**
+ * list with data of packages which will be installed
+ * @var array<array>
+ */
public $packageInstallationStack = array();
+
+ /**
+ * scheduler for package update
+ * @var wcf\system\package\PackageInstallationScheduler
+ */
public $packageUpdate = null;
/**
* @category Community Framework
*/
class PackageUpdateSearchForm extends ACPForm {
+ /**
+ * @see wcf\page\AbstractPage::$templateName
+ */
public $templateName = 'packageUpdateSearch';
+
+ /**
+ * @see wcf\page\AbstractPage::$neededPermissions
+ */
public $neededPermissions = array('admin.system.package.canUpdatePackage', 'admin.system.package.canInstallPackage');
+
+ /**
+ * @see wcf\acp\form\ACPForm::$activeMenuItem
+ */
public $activeMenuItem = 'wcf.acp.menu.link.package.database';
+ /**
+ * list of package server ids which are searched
+ * @var array<integer>
+ */
public $packageUpdateServerIDs = array();
+
+ /**
+ * searched package name
+ * @var string
+ */
public $packageName = '';
+
+ /**
+ * searched author
+ * @var string
+ */
public $author = '';
+
+ /**
+ * indicates if package description is searched
+ * @var integer
+ */
public $searchDescription = 0;
+
+ /**
+ * indicates if plugins for already installed packages are searched
+ * @var integer
+ */
public $plugin = 1;
+
+ /**
+ * indicates if standalone applications are searched
+ * @var integer
+ */
public $standalone = 1;
+
+ /**
+ * indicates if packages that aren't plugins or standalone applications
+ * are searched
+ * @var integer
+ */
public $other = 0;
+
+ /**
+ * indicates if unique packages are ignored that are already installed
+ * @var integer
+ */
public $ignoreUniques = 1;
+ /**
+ * list of available update servers
+ * @var array<wcf\data\package\update\server\PackageUpdateServer>
+ */
public $updateServers = array();
+
+ /**
+ * ids of package updates
+ * @var string
+ */
public $packageUpdateIDs = '';
/**
* @category Community Framework
*/
class UserAssignToGroupForm extends ACPForm {
+ /**
+ * @see wcf\page\AbstractPage::$templateName
+ */
public $templateName = 'userAssignToGroup';
- public $activeMenuItem = 'wcf.acp.menu.link.user.management';
+
+ /**
+ * @see wcf\page\AbstractPage::$neededPermissions
+ */
public $neededPermissions = array('admin.user.canEditUser');
+ /**
+ * @see wcf\acp\form\ACPForm::$activeMenuItem
+ */
+ public $activeMenuItem = 'wcf.acp.menu.link.user.management';
+
public $userIDs = array();
public $groupIDs = array();
public $users = array();
/**
* session log id
- *
* @var integer
*/
public $sessionLogID = 0;
/**
* session log object
- *
* @var wcf\data\acp\session\log\ACPSessionLog
*/
public $sessionLog = null;
* @category Community Framework
*/
class CacheListPage extends AbstractPage {
- // system
+ /**
+ * @see wcf\page\AbstractPage::$templateName
+ */
public $templateName = 'cacheList';
+
+ /**
+ * @see wcf\page\AbstractPage::$neededPermissions
+ */
public $neededPermissions = array('admin.system.canViewLog');
+
+ /**
+ * indicates if cache was cleared
+ * @var integer
+ */
public $cleared = 0;
/**
* contains a list of cache resources
- *
* @var array
*/
public $caches = array();
/**
* contains general cache information
- *
* @var array
*/
public $cacheData = array();
* @category Community Framework
*/
class IndexPage extends AbstractPage {
- // system
+ /**
+ * @see wcf\page\AbstractPage::$templateName
+ */
public $templateName = 'index';
/**
* @category Community Framework
*/
class PackageAutoUpdateListPage extends AbstractPage {
+ /**
+ * @see wcf\page\AbstractPage::$templateName
+ */
public $templateName = 'packageAutoUpdateList';
+
+ /**
+ * @see wcf\page\AbstractPage::$neededPermissions
+ */
public $neededPermissions = array('admin.system.package.canUpdatePackage');
+ /**
+ * list with data of available updates
+ * @var array
+ */
public $availableUpdates = array();
/**
* @category Community Framework
*/
class PackageListPage extends SortablePage {
- // system
+ /**
+ * @see wcf\page\AbstractPage::$templateName
+ */
public $templateName = 'packageList';
+
+ /**
+ * @see wcf\page\AbstractPage::$neededPermissions
+ */
public $neededPermissions = array('admin.system.package.canUpdatePackage', 'admin.system.package.canUninstallPackage');
+
+ /**
+ * @see wcf\page\MultipleLinkPage::$itemsPerPage
+ */
public $itemsPerPage = 50;
+
+ /**
+ * @see wcf\page\SortablePage::$defaultSortField
+ */
public $defaultSortField = 'packageType';
- public $defaultSortOrder = 'DESC';
/**
- * list of packages
- *
- * @var PackageList
+ * @see wcf\page\SortablePage::$defaultSortOrder
*/
- public $packageList = null;
+ public $defaultSortOrder = 'DESC';
/**
- * class name for DatabaseObjectList
- *
- * @var string
+ * @see wcf\page\MultipleLinkPage::$objectListClassName
*/
public $objectListClassName = 'wcf\data\package\PackageList';
/**
- * @see wcf\page\MuletipleLinkPage::readObjects()
+ * @see wcf\page\MultipleLinkPage::readObjects()
*/
protected function readObjects() {
$this->sqlOrderBy = 'package.'.($this->sortField == 'packageType' ? 'standalone '.$this->sortOrder.', package.parentPackageID '.$this->sortOrder : $this->sortField.' '.$this->sortOrder).($this->sortField != 'packageName' ? ', package.packageName ASC' : '');
* @category Community Framework
*/
class PackageUpdateSearchResultPage extends SortablePage {
+ /**
+ * @see wcf\page\AbstractPage::$templateName
+ */
public $templateName = 'packageUpdateSearchResult';
- public $defaultSortField = 'packageName';
+
+ /**
+ * @see wcf\page\AbstractPage::$neededPermissions
+ */
public $neededPermissions = array('admin.system.package.canUpdatePackage', 'admin.system.package.canInstallPackage');
+ /**
+ * @see wcf\page\SortablePage::$defaultSortField
+ */
+ public $defaultSortField = 'packageName';
+
+ /**
+ * id of the package update search
+ * @var integer
+ */
public $searchID = 0;
/**
* @var wcf\data\search\Search
*/
public $search = null;
+
+ /**
+ * list with data of package updates
+ * @var array
+ */
public $packages = array();
/**
* @category Community Framework
*/
class PackageViewPage extends AbstractPage {
- public $package;
- public $packageID = 0;
+ /**
+ * @see wcf\page\AbstractPage::$templateName
+ */
public $templateName = 'packageView';
+
+ /**
+ * @see wcf\page\AbstractPage::$neededPermissions
+ */
public $neededPermissions = array('admin.system.package.canUpdatePackage', 'admin.system.package.canUninstallPackage');
+
+ /**
+ * list with data of required packages explicitly given in the requiredPackages
+ * tag during installation
+ * @var array<string>
+ */
public $requiredPackages = array();
+
+ /**
+ * list with data of dependent packages
+ * @var array<string>
+ */
public $dependentPackages = array();
+
+ /**
+ * list with data of required packages
+ * @var array<string>
+ */
public $dependencies = array();
+ /**
+ * id of the package
+ * @var integer
+ */
+ public $packageID = 0;
+
+ /**
+ * package object
+ * @var Package
+ */
+ public $package = null;
+
/**
* @see wcf\page\IPage::readParameters()
*/
* @category Community Framework
*/
class UpdateServerListPage extends SortablePage {
- // system
+ /**
+ * @see wcf\page\AbstractPage::$templateName
+ */
public $templateName = 'updateServerList';
+
+ /**
+ * @see wcf\page\AbstractPage::$neededPermissions
+ */
public $neededPermissions = array('admin.system.package.canEditServer');
+
+ /**
+ * @see wcf\page\SortablePage::$defaultSortField
+ */
public $defaultSortField = 'serverURL';
- public $deletedPackageUpdateServerID = 0;
/**
* @see wcf\page\MultipleLinkPage::$objectListClassName
*/
public $objectListClassName = 'wcf\data\package\update\server\PackageUpdateServerList';
+ /**
+ * id of a package update server that has just been deleted
+ * @var integer
+ */
+ public $deletedPackageUpdateServerID = 0;
+
/**
* @see wcf\page\IPage::readParameters()
*/
* @category Community Framework
*/
class UserGroupListPage extends SortablePage {
- // system
+ /**
+ * @see wcf\page\AbstractPage::$templateName
+ */
public $templateName = 'userGroupList';
- public $deletedGroups = 0;
- public $defaultSortField = 'groupName';
+
+ /**
+ * @see wcf\page\AbstractPage::$neededPermissions
+ */
public $neededPermissions = array('admin.user.canEditGroup', 'admin.user.canDeleteGroup');
+ /**
+ * @see wcf\page\SortablePage::$defaultSortField
+ */
+ public $defaultSortField = 'groupName';
+
/**
* @see wcf\page\MultipleLinkPage::$objectListClassName
*/
public $objectListClassName = 'wcf\data\user\group\UserGroupList';
+ /**
+ * indicates if a group has just been deleted
+ * @var integer
+ */
+ public $deletedGroups = 0;
+
/**
* @see wcf\page\IPage::readParameters()
*/
* @category Community Framework
*/
class UserListPage extends SortablePage {
- // system
- public $itemsPerPage = 50;
- public $defaultSortField = 'username';
+ /**
+ * @see wcf\page\AbstractPage::$templateName
+ */
public $templateName = 'userList';
+
+ /**
+ * @see wcf\page\AbstractPage::$neededPermissions
+ */
public $neededPermissions = array('admin.user.canSearchUser');
- // parameters
+ /**
+ * @see wcf\page\MultipleLinkPage::$itemsPerPage
+ */
+ public $itemsPerPage = 50;
+
+ /**
+ * @see wcf\page\SortablePage::$defaultSortField
+ */
+ public $defaultSortField = 'username';
+
+ /**
+ * id of a user search
+ * @var integer
+ */
public $searchID = 0;
// data
*/
abstract class AbstractForm extends AbstractPage implements IForm {
/**
- * Name of error field.
- *
+ * name of error field
* @var string
*/
public $errorField = '';
/**
- * Name of error type.
- *
+ * error type
* @var string
*/
public $errorType = '';
*/
abstract class AbstractPage implements IPage {
/**
- * Name of the template for the called page.
- *
+ * name of the template for the called page
* @var string
*/
public $templateName = '';
/**
- * Value of the given action parameter.
- *
+ * value of the given action parameter
* @var string
*/
public $action = '';
/**
- * Needed modules to view this page.
- *
+ * needed modules to view this page
* @var array<string>
*/
public $neededModules = array();
/**
- * Needed permissions to view this page.
- *
+ * needed permissions to view this page
* @var array<string>
*/
public $neededPermissions = array();
*/
abstract class MultipleLinkPage extends AbstractPage {
/**
- * The current page number.
- *
+ * current page number
* @var integer
*/
public $pageNo = 0;
/**
- * The number of all pages.
- *
+ * number of all pages
* @var integer
*/
public $pages = 0;
/**
- * The number of items shown per page.
- *
+ * number of items shown per page
* @var integer
*/
public $itemsPerPage = 20;
/**
- * The number of all items.
- *
+ * number of all items
* @var integer
*/
public $items = 0;
/**
- * Indicates the range of the listed items.
- *
+ * indicates the range of the listed items
* @var integer
*/
public $startIndex = 0;
/**
- * Indicates the range of the listed items.
- *
+ * indicates the range of the listed items.
* @var integer
*/
public $endIndex = 0;
/**
* DatabaseObjectList object
- *
* @var wcf\data\DatabaseObjectList
*/
public $objectList = null;
/**
* class name for DatabaseObjectList
- *
* @var string
*/
public $objectListClassName = '';
/**
* list of DatabaseObject objects
- *
* @var array<wcf\data\DatabaseObject>
*/
public $objects = array();
*/
abstract class SortablePage extends MultipleLinkPage {
/**
- * The selected sort field.
- *
+ * selected sort field
* @var string
*/
public $sortField = '';
/**
- * The selected sort order.
- *
+ * selected sort order
* @var string
*/
public $sortOrder = '';
/**
- * The default sort field.
- *
+ * default sort field
* @var string
*/
public $defaultSortField = '';
/**
- * The default sort order.
- *
+ * default sort order
* @var string
*/
public $defaultSortOrder = 'ASC';
projects / GitHub / WoltLab / WCF.git / commitdiff