* Creates a new SystemException.
*
* @param string $message error message
- * @param integer $code error code
+ * @param int $code error code
* @param string $description description of the error
* @param \Exception $previous repacked Exception
*/
/**
* Catches php errors and throws instead a system exception.
*
- * @param integer $errorNo
+ * @param int $errorNo
* @param string $message
* @param string $filename
- * @param integer $lineNo
+ * @param int $lineNo
* @throws SystemException
*/
function handleError($errorNo, $message, $filename, $lineNo) {
class BasicFileUtil {
/**
* chmod mode
- * @var integer
+ * @var int
*/
protected static $mode = null;
/**
* chunk size for extracting
- * @var integer
+ * @var int
*/
const CHUNK_SIZE = 8192;
/**
* Returns the filesize of the unzipped file.
*
- * @return integer
+ * @return int
*/
public function getFileSize() {
$byteBlock = 1<<14;
/**
* current queue id
- * @var integer
+ * @var int
*/
public $queueID = 0;
/**
* Returns current action by queue id.
*
- * @param integer $queueID
+ * @param int $queueID
* @return string
*/
protected function getCurrentAction($queueID) {
class UninstallPackageAction extends InstallPackageAction {
/**
* active package id
- * @var integer
+ * @var int
*/
protected $packageID = 0;
public $user;
/**
- * @var integer
+ * @var int
*/
public $userID = 0;
/**
* matches
- * @var integer[]
+ * @var int[]
*/
public $matches = [];
/**
* results per page
- * @var integer
+ * @var int
*/
public $itemsPerPage = 50;
/**
* number of results
- * @var integer
+ * @var int
*/
public $maxResults = 2000;
/**
* loop counter
- * @var integer
+ * @var int
*/
protected $loopCount = -1;
/**
* Sends a JSON-encoded response.
*
- * @param integer $progress
+ * @param int $progress
* @param array $parameters
* @param string $proceedURL
*/
/**
* number of objects affected by bulk processing
- * @var integer
+ * @var int
*/
public $affectedObjectCount = 0;
abstract class AbstractCategoryAddForm extends AbstractForm {
/**
* id of the category acl object type
- * @var integer
+ * @var int
*/
public $aclObjectTypeID = 0;
/**
* is `1` if HTML is used in the description
- * @var integer
+ * @var int
*/
public $descriptionUseHtml = 0;
/**
* indicates if the category is disabled
- * @var integer
+ * @var int
*/
public $isDisabled = 0;
/**
* id of the package the created package belongs to
- * @var integer
+ * @var int
*/
public $packageID = 0;
/**
* id of the parent category id
- * @var integer
+ * @var int
*/
public $parentCategoryID = 0;
/**
* category show order
- * @var integer
+ * @var int
*/
public $showOrder = 0;
/**
* id of the edited category
- * @var integer
+ * @var int
*/
public $categoryID = 0;
/**
* show order
- * @var integer
+ * @var int
*/
public $showOrder = 0;
/**
* object id
- * @var integer
+ * @var int
*/
public $optionID;
/**
* 1 if the ad is disabled
- * @var integer
+ * @var int
*/
public $isDisabled = 0;
/**
* id of the selected location's object type
- * @var integer
+ * @var int
*/
public $objectTypeID = 0;
/**
* order used to the show the ads
- * @var integer
+ * @var int
*/
public $showOrder = 0;
/**
* id of the edited ad
- * @var integer
+ * @var int
*/
public $adID = 0;
/**
* landing page id
- * @var integer
+ * @var int
*/
public $landingPageID = 0;
/**
* application package id
- * @var integer
+ * @var int
*/
public $packageID = 0;
/**
* category id
- * @var integer
+ * @var int
*/
public $categoryID = 0;
/**
* publication status
- * @var integer
+ * @var int
*/
public $publicationStatus = Article::PUBLISHED;
/**
* image ids
- * @var integer[]
+ * @var int[]
*/
public $imageID = [];
/**
* thumbnail image ids
- * @var integer[]
+ * @var int[]
*/
public $teaserImageID = [];
/**
* list of label ids
- * @var integer[]
+ * @var int[]
*/
public $labelIDs = [];
/**
* article id
- * @var integer
+ * @var int
*/
public $articleID = 0;
/**
* bbcode id
- * @var integer
+ * @var int
*/
public $bbcodeID = 0;
/**
* media provider package id
- * @var integer
+ * @var int
*/
public $packageID = PACKAGE_ID;
/**
* id of the edited media provider
- * @var integer
+ * @var int
*/
public $providerID = 0;
/**
* show order
- * @var integer
+ * @var int
*/
public $showOrder = 0;
/**
* image ids
- * @var integer[]
+ * @var int[]
*/
public $imageID = [];
/**
* page ids
- * @var integer[]
+ * @var int[]
*/
public $pageIDs = [];
/**
* object type id of the selected box controller
- * @var integer
+ * @var int
*/
public $boxControllerID = 0;
/**
* box id
- * @var integer
+ * @var int
*/
public $boxID = 0;
/**
* 1 if the question is disabled
- * @var integer
+ * @var int
*/
public $isDisabled = 0;
/**
* id of the edited captcha question
- * @var integer
+ * @var int
*/
public $captchaQuestionID = 0;
/**
* 1 if the recipient is disabled
- * @var integer
+ * @var int
*/
public $isDisabled = 0;
/**
* order used to the show the recipients
- * @var integer
+ * @var int
*/
public $showOrder = 0;
public $recipient;
/**
- * @var integer
+ * @var int
*/
public $recipientID = 0;
/**
* cronjob package id
- * @var integer
+ * @var int
*/
public $packageID = PACKAGE_ID;
/**
* cronjob id
- * @var integer
+ * @var int
*/
public $cronjobID = 0;
/**
* user merge mode
- * @var integer
+ * @var int
*/
public $userMergeMode = UserImporter::MERGE_MODE_EMAIL;
/**
* project id
- * @var integer
+ * @var int
*/
public $projectID = 0;
/**
* label group id
- * @var integer
+ * @var int
*/
public $groupID = 0;
/**
* show order
- * @var integer
+ * @var int
*/
public $showOrder = 0;
/**
* label id
- * @var integer
+ * @var int
*/
public $labelID = 0;
/**
* object type id
- * @var integer
+ * @var int
*/
public $objectTypeID = 0;
/**
* show order
- * @var integer
+ * @var int
*/
public $showOrder = 0;
/**
* Saves label group to object relations.
*
- * @param integer $groupID
+ * @param int $groupID
*/
protected function saveObjectTypeRelations($groupID) {
WCF::getDB()->beginTransaction();
/**
* group id
- * @var integer
+ * @var int
*/
public $groupID = 0;
/**
* source language id
- * @var integer
+ * @var int
*/
public $sourceLanguageID = 0;
class LanguageEditForm extends LanguageAddForm {
/**
* language id
- * @var integer
+ * @var int
*/
public $languageID = 0;
/**
* language id
- * @var integer
+ * @var int
*/
public $languageID = 0;
/**
* max package name length
- * @var integer
+ * @var int
*/
public $packageNameLength = 0;
/**
* source language id
- * @var integer
+ * @var int
*/
public $sourceLanguageID = 0;
/**
* indicates if multilingualism is enabled
- * @var integer
+ * @var int
*/
public $enable = 0;
/**
* ids of selected available languages
- * @var integer[]
+ * @var int[]
*/
public $languageIDs = [];
/**
* show order
- * @var integer
+ * @var int
*/
public $showOrder = 0;
/**
* page ids
- * @var integer[]
+ * @var int[]
*/
public $pageIDs = [];
/**
* menu id
- * @var integer
+ * @var int
*/
public $menuID = 0;
/**
* menu id
- * @var integer
+ * @var int
*/
public $menuID = 0;
/**
* page id
- * @var integer
+ * @var int
*/
public $pageID = null;
/**
* page object id
- * @var integer
+ * @var int
*/
public $pageObjectID = null;
/**
* id of the parent menu item
- * @var integer
+ * @var int
*/
public $parentItemID = null;
/**
* show order
- * @var integer
+ * @var int
*/
public $showOrder = 0;
class MenuItemEditForm extends MenuItemAddForm {
/**
* menu item id
- * @var integer
+ * @var int
*/
public $itemID = 0;
/**
* 1 if the notice is disabled
- * @var integer
+ * @var int
*/
public $isDisabled = 0;
/**
* 1 if the notice is dismissible
- * @var integer
+ * @var int
*/
public $isDismissible = 0;
/**
* 1 if html is used in the notice text
- * @var integer
+ * @var int
*/
public $noticeUseHtml = 0;
/**
* order used to the show the notices
- * @var integer
+ * @var int
*/
public $showOrder = 0;
/**
* id of the edited notice object
- * @var integer
+ * @var int
*/
public $noticeID = 0;
/**
* 1 if the notice will be displayed for all users again
- * @var integer
+ * @var int
*/
public $resetIsDismissed = 0;
/**
* category id
- * @var integer
+ * @var int
*/
public $categoryID = 0;
/**
* update server id
- * @var integer
+ * @var int
*/
public $packageUpdateServerID = 0;
/**
* parent page id
- * @var integer
+ * @var int
*/
public $parentPageID = 0;
/**
* application id of the page
- * @var integer
+ * @var int
*/
public $applicationPackageID = 1;
/**
* list of box ids
- * @var integer[]
+ * @var int[]
*/
public $boxIDs = [];
/**
* parent menu item id
- * @var integer
+ * @var int
*/
public $parentMenuItemID;
/**
* Validates given custom url.
*
- * @param integer $languageID
+ * @param int $languageID
* @param string $customURL
*
* @throws UserInputException
/**
* Returns the list of box ids that are enabled by default.
*
- * @return integer[]
+ * @return int[]
*/
protected function getDefaultBoxIDs() {
$boxIDs = [];
/**
* page id
- * @var integer
+ * @var int
*/
public $pageID = 0;
/**
* subscription show order
- * @var integer
+ * @var int
*/
public $showOrder = 0;
/**
* subscription length
- * @var integer
+ * @var int
*/
public $subscriptionLength = 0;
/**
* list of group ids
- * @var integer[]
+ * @var int[]
*/
public $groupIDs = [];
/**
* list of excluded subscriptions
- * @var integer[]
+ * @var int[]
*/
public $excludedSubscriptionIDs = [];
/**
* id of the edited subscription
- * @var integer
+ * @var int
*/
public $subscriptionID = 0;
/**
* subscription id
- * @var integer
+ * @var int
*/
public $subscriptionID = 0;
class PaidSubscriptionUserEditForm extends PaidSubscriptionUserAddForm {
/**
* subscription user id
- * @var integer
+ * @var int
*/
public $subscriptionUserID = 0;
/**
* `1` iff the sitemap is disabled. Otherwise `0`.
- * @var integer
+ * @var int
*/
public $isDisabled = 0;
/**
* The time in seconds how long the sitemap should be cached.
- * @var integer
+ * @var int
*/
public $rebuildTime = 172800; // two days
/**
* show order value
- * @var integer
+ * @var int
*/
public $showOrder = 0;
/**
* categoryID value
- * @var integer
+ * @var int
*/
public $categoryID = 0;
/**
* smiley id
- * @var integer
+ * @var int
*/
public $smileyID = 0;
/**
* template group id
- * @var integer
+ * @var int
*/
public $templateGroupID = 0;
/**
* current scroll offsets before submitting the form
- * @var integer[]
+ * @var int[]
*/
public $scrollOffsets = [];
/**
* style id
- * @var integer
+ * @var int
*/
public $styleID = 0;
/**
* style id
- * @var integer
+ * @var int
*/
public $styleID = 0;
/**
* current scroll offset before submitting the form
- * @var integer
+ * @var int
*/
public $stylesScrollOffset = 0;
/**
* tag id
- * @var integer
+ * @var int
*/
public $tagID = 0;
/**
* template group id
- * @var integer
+ * @var int
*/
public $templateGroupID = 0;
/**
* template's package id
- * @var integer
+ * @var int
*/
public $packageID = 1;
/**
* id of copied template
- * @var integer
+ * @var int
*/
public $copy = 0;
/**
* template id
- * @var integer
+ * @var int
*/
public $templateID = 0;
/**
* template group folder
- * @var integer
+ * @var int
*/
public $templateGroupFolderName = '';
/**
* parent template group id
- * @var integer
+ * @var int
*/
public $parentTemplateGroupID = 0;
/**
* template group id
- * @var integer
+ * @var int
*/
public $templateGroupID = 0;
/**
* category id for the trophy.
- * @var integer
+ * @var int
*/
public $categoryID = 0;
/**
* points to objectType
- * @var integer[]
+ * @var int[]
*/
public $points = [];
/**
* user group ids
- * @var integer[]
+ * @var int[]
*/
public $groupIDs = [];
/**
* language id
- * @var integer
+ * @var int
*/
public $languageID = 0;
/**
* visible languages
- * @var integer[]
+ * @var int[]
*/
public $visibleLanguages = [];
/**
* date when the signature will be enabled again
- * @var integer
+ * @var int
*/
public $disableSignatureExpires = 0;
/**
* ids of the relevant users
- * @var integer[]
+ * @var int[]
*/
public $userIDs = [];
/**
* ids of the assigned user groups
- * @var integer[]
+ * @var int[]
*/
public $groupIDs = [];
/**
* id of the user clipboard item object type
- * @var integer
+ * @var int
*/
protected $objectTypeID = null;
/**
* ids of the relevant users
- * @var integer[]
+ * @var int[]
*/
public $userIDs = [];
/**
* timeframe to consider
- * @var integer
+ * @var int
*/
public $timeframe = 7;
/**
* id of the user clipboard item object type
- * @var integer
+ * @var int
*/
protected $objectTypeID = null;
/**
* user id
- * @var integer
+ * @var int
*/
public $userID = 0;
/**
* date when the ban expires
- * @var integer
+ * @var int
*/
public $banExpires = 0;
/**
* date when the avatar will be enabled again
- * @var integer
+ * @var int
*/
public $disableAvatarExpires = 0;
/**
* date when the cover photo will be enabled again
- * @var integer
+ * @var int
*/
public $disableCoverPhotoExpires = 0;
/**
* ids of the users whose email addresses are exported
- * @var integer[]
+ * @var int[]
*/
public $userIDs = [];
/**
* clipboard item type id
- * @var integer
+ * @var int
*/
protected $objectTypeID = null;
/**
* group priority
- * @var integer
+ * @var int
*/
protected $priority = 0;
/**
* shows the members of this group on the team page
- * @var integer
+ * @var int
*/
protected $showOnTeamPage = 0;
/**
* id of the selected user group
- * @var integer
+ * @var int
*/
public $groupID = 0;
/**
* true if the automatic assignment is disabled
- * @var integer
+ * @var int
*/
public $isDisabled = 0;
/**
* id of the edited automatic user group assignment
- * @var integer
+ * @var int
*/
public $assignmentID = 0;
/**
* id of the edited user group
- * @var integer
+ * @var int
*/
public $groupID = 0;
/**
* user group option id
- * @var integer
+ * @var int
*/
public $userGroupOptionID = 0;
/**
* list of group ids
- * @var integer[]
+ * @var int[]
*/
public $groupIDs = [];
/**
* single user id
- * @var integer
+ * @var int
*/
public $userID = 0;
/**
* list of user ids
- * @var integer[]
+ * @var int[]
*/
public $userIDs = [];
/**
* ids of the relevant users
- * @var integer[]
+ * @var int[]
*/
public $userIDs = [];
/**
* destination user id
- * @var integer
+ * @var int
*/
public $destinationUserID = 0;
/**
* ids of merge users (without destination user)
- * @var integer[]
+ * @var int[]
*/
public $mergedUserIDs = [];
/**
* id of the user clipboard item object type
- * @var integer
+ * @var int
*/
protected $objectTypeID = null;
/**
* edit permission bitmask
- * @var integer
+ * @var int
*/
public $editable = 3;
/**
* view permission bitmask
- * @var integer
+ * @var int
*/
public $visible = 15;
/**
* show order
- * @var integer
+ * @var int
*/
public $showOrder = 0;
/**
* show order
- * @var integer
+ * @var int
*/
public $showOrder = 0;
/**
* category id
- * @var integer
+ * @var int
*/
public $categoryID = 0;
/**
* user option id
- * @var integer
+ * @var int
*/
public $optionID = 0;
/**
* Returns the default form language id.
*
- * @return integer $languageID
+ * @return int $languageID
*/
protected function getDefaultFormLanguageID() {
return LanguageFactory::getInstance()->getDefaultLanguageID();
/**
* rank group id
- * @var integer
+ * @var int
*/
public $groupID = 0;
/**
* required activity points to acquire the rank
- * @var integer
+ * @var int
*/
public $requiredPoints = 0;
/**
* number of image repeats
- * @var integer
+ * @var int
*/
public $repeatImage = 1;
/**
* required gender setting (1=male; 2=female)
- * @var integer
+ * @var int
*/
public $requiredGender = 0;
/**
* hide generic user title
- * @var integer
+ * @var int
*/
public $hideTitle = 0;
/**
* rank id
- * @var integer
+ * @var int
*/
public $rankID = 0;
/**
* search id
- * @var integer
+ * @var int
*/
public $searchID = 0;
/**
* results per page
- * @var integer
+ * @var int
*/
public $itemsPerPage = 50;
/**
* number of results
- * @var integer
+ * @var int
*/
public $maxResults = 2000;
/**
* id of the group the users have to belong to
* is used on the user group list to show all users of a user group
- * @var integer
+ * @var int
*/
public $groupID = 0;
/**
* List of user ids which earn the trophy.
- * @var integer[]
+ * @var int[]
*/
public $userIDs = [];
public $trophyUseHtml = 0;
/**
- * @var integer
+ * @var int
*/
public $trophyID = 0;
/**
* session log id
- * @var integer
+ * @var int
*/
public $sessionLogID = 0;
/**
* ids of collapsed categories
- * @var integer[]
+ * @var int[]
*/
public $collapsedCategoryIDs = null;
/**
* id of the collapsible category object type
- * @var integer
+ * @var int
*/
public $collapsibleObjectTypeID = 0;
/**
* category id
- * @var integer
+ * @var int
*/
public $categoryID = 0;
/**
* display 'Add Article' dialog on load
- * @var integer
+ * @var int
*/
public $showArticleAddDialog = 0;
/**
* publication status filter
- * @var integer
+ * @var int
*/
public $publicationStatus = -1;
/**
* display 'Add Box' dialog on load
- * @var integer
+ * @var int
*/
public $showBoxAddDialog = 0;
/**
* indicates if cache was cleared
- * @var integer
+ * @var int
*/
public $cleared = 0;
public $objectListClassName = CronjobLogList::class;
/**
- * @var integer
+ * @var int
*/
public $cronjobID = 0;
/**
- * @var integer
+ * @var int
*/
public $success = -1;
/**
* indicates the range of the listed items
- * @var integer
+ * @var int
*/
public $endIndex = 0;
/**
* number of items shown per page
- * @var integer
+ * @var int
*/
public $itemsPerPage = 100;
/**
* number of all items
- * @var integer
+ * @var int
*/
public $items = 0;
/**
* current page number
- * @var integer
+ * @var int
*/
public $pageNo = 0;
/**
* number of all pages
- * @var integer
+ * @var int
*/
public $pages = 0;
/**
* project id
- * @var integer
+ * @var int
*/
public $projectID = 0;
/**
* indicates the range of the listed items
- * @var integer
+ * @var int
*/
public $startIndex = 0;
/**
* project id
- * @var integer
+ * @var int
*/
public $projectID = 0;
/**
* project id
- * @var integer
+ * @var int
*/
public $objectID = 0;
/**
* if of the label group to which the displayed labels belong
- * @var integer
+ * @var int
*/
public $groupID = 0;
/**
* language id
- * @var integer
+ * @var int
*/
public $languageID = 0;
/**
* language category id
- * @var integer
+ * @var int
*/
public $languageCategoryID = 0;
/**
* is `1` if only custom language items (created via ACP) should be shown
- * @var integer
+ * @var int
* @since 5.2
*/
public $isCustomLanguageItem = 0;
/**
* id of the selected media category
- * @var integer
+ * @var int
*/
public $categoryID = 0;
/**
* menu id
- * @var integer
+ * @var int
*/
public $menuID = 0;
/**
* queue id
- * @var integer
+ * @var int
*/
public $queueID = 0;
/**
* package id for uninstallation
- * @var integer
+ * @var int
*/
public $packageID = 0;
/**
* list of compatible API versions
- * @var integer[]
+ * @var int[]
*/
public $compatibleVersions = [];
/**
* id of the package
- * @var integer
+ * @var int
*/
public $packageID = 0;
/**
* Plugin-Store fileID
- * @var integer
+ * @var int
*/
public $pluginStoreFileID = 0;
/**
* page id
- * @var integer
+ * @var int
*/
public $pageID = 0;
/**
* application id of the page
- * @var integer
+ * @var int
*/
public $applicationPackageID = 0;
/**
* subscription id
- * @var integer
+ * @var int
*/
public $subscriptionID = 0;
/**
* log entry id
- * @var integer
+ * @var int
*/
public $logID = 0;
/**
* subscription id
- * @var integer
+ * @var int
*/
public $subscriptionID = 0;
/**
* category id
- * @var integer
+ * @var int
*/
public $categoryID = 0;
/**
* template id
- * @var integer
+ * @var int
*/
public $templateID = 0;
/**
* template id of the template to compare with
- * @var integer
+ * @var int
*/
public $parentID = 0;
/**
* template group id
- * @var integer
+ * @var int
*/
public $templateGroupID = 0;
/**
* indicates if a group has just been deleted
- * @var integer
+ * @var int
*/
public $deletedGroups = 0;
/**
* list of marked user ids
- * @var integer[]
+ * @var int[]
*/
public $markedUsers = [];
/**
* id of a user search
- * @var integer
+ * @var int
*/
public $searchID = 0;
/**
* list of user ids
- * @var integer[]
+ * @var int[]
*/
public $userIDs = [];
/**
* The filter value for the trophy id.
- * @var integer
+ * @var int
*/
public $trophyID = 0;
class VersionTrackerListPage extends AbstractPage {
/**
* object id
- * @var integer
+ * @var int
*/
public $objectID = 0;
/**
* left / old version id
- * @var integer
+ * @var int
*/
public $oldID = 0;
/**
* right / new version id
- * @var integer
+ * @var int
*/
public $newID = 0;
/**
* list of object ids
- * @var integer[]
+ * @var int[]
*/
protected $objectIDs = [];
class BackgroundQueuePerformAction extends AbstractAction {
/**
* number of jobs that will be processed per invocation
- * @var integer
+ * @var int
*/
public static $jobsPerRun = 5;
class GravatarDownloadAction extends AbstractAction {
/**
* user id
- * @var integer
+ * @var int
*/
public $userID = 0;
/**
* avatar size
- * @var integer
+ * @var int
*/
public $size = UserAvatar::AVATAR_SIZE;
/**
* indicates if the WCF.Message.Quote.Manager object requesting data has any
* quote handlers which require updated object ids of full quotes
- * @var integer
+ * @var int
*/
public $_getFullQuoteObjectIDs = false;
/**
* Returns the count of stored quotes.
*
- * @return integer
+ * @return int
*/
protected function count() {
return MessageQuoteManager::getInstance()->countQuotes();
/**
* Removes a list of quotes from storage and returns the remaining count.
*
- * @return integer
+ * @return int
* @throws SystemException
* @throws UserInputException
*/
/**
* Removes all quotes marked for removal and returns the remaining count.
*
- * @return integer
+ * @return int
*/
protected function removeMarkedQuotes() {
MessageQuoteManager::getInstance()->removeMarkedQuotes();
/**
* user notification id
- * @var integer
+ * @var int
*/
public $notificationID = 0;
class NotificationDisableAction extends AbstractAction {
/**
* event id
- * @var integer
+ * @var int
*/
public $eventID = 0;
/**
* user id
- * @var integer
+ * @var int
*/
public $userID = 0;
/**
* list of option ids
- * @var integer[]
+ * @var int[]
*/
public $optionIDs = [];
/**
* poll id
- * @var integer
+ * @var int
*/
public $pollID = 0;
/**
* list of object ids
- * @var integer[]
+ * @var int[]
*/
protected $objectIDs = [];
/**
* Reads a value and validates it. If you set $allowEmpty to true, no exception will
- * be thrown if the variable evaluates to 0 (integer) or '' (string). Furthermore the
+ * be thrown if the variable evaluates to 0 (int) or '' (string). Furthermore the
* variable will be always created with a sane value if it does not exist.
*
* @param string $variableName
* @param boolean $allowEmpty
* @param string $arrayIndex
- * @param integer $type
- * @param integer $structure
+ * @param int $type
+ * @param int $structure
* @throws SystemException
* @throws UserInputException
*/
/**
* Returns the id of the object.
*
- * @return integer
+ * @return int
*/
public function getObjectID() {
return $this->data[static::getDatabaseTableIndexName()];
/**
* ids of result objects
- * @var integer[]
+ * @var int[]
*/
public $objectIDs = null;
/**
* sql offset
- * @var integer
+ * @var int
*/
public $sqlOffset = 0;
/**
* sql limit
- * @var integer
+ * @var int
*/
public $sqlLimit = 0;
/**
* current iterator index
- * @var integer
+ * @var int
*/
protected $index = 0;
/**
* list of index to object relation
- * @var integer[]
+ * @var int[]
*/
protected $indexToObject = null;
/**
* Counts the number of objects.
*
- * @return integer
+ * @return int
*/
public function countObjects() {
$sql = "SELECT COUNT(*)
/**
* Returns the object ids of the list.
*
- * @return integer[]
+ * @return int[]
*/
public function getObjectIDs() {
return $this->objectIDs;
/**
* Sets the object ids.
*
- * @param integer[] $objectIDs
+ * @param int[] $objectIDs
*/
public function setObjectIDs(array $objectIDs) {
$this->objectIDs = array_merge($objectIDs);
/**
* @inheritDoc
- * @param integer $languageID id of the language that should be used
+ * @param int $languageID id of the language that should be used
* @throws \DomainException
*/
public function __construct($languageID = null) {
/**
* Returns DatabaseObject-related object ids.
*
- * @return integer[]
+ * @return int[]
*/
public function getObjectIDs();
/**
* Deletes the relevant objects and returns the number of deleted objects.
*
- * @return integer
+ * @return int
*/
public function delete();
* objects.
*
* @param array $objectIDs
- * @return integer
+ * @return int
*/
public static function deleteAll(array $objectIDs = []);
}
/**
* Returns the number of comments.
*
- * @return integer
+ * @return int
*/
public function getComments();
* @since 3.0
*
* @property-read string $fileType type of the physical attachment file
- * @property-read integer $isImage is `1` if the file is an image, otherwise `0`
- * @property-read integer $width width of the file if `$isImage` is `1`, otherwise `0`
- * @property-read integer $height height of the file if `$isImage` is `1`, otherwise `0`
+ * @property-read int $isImage is `1` if the file is an image, otherwise `0`
+ * @property-read int $width width of the file if `$isImage` is `1`, otherwise `0`
+ * @property-read int $height height of the file if `$isImage` is `1`, otherwise `0`
*/
interface IFile extends IStorableObject {
/**
/**
* Returns the unique id of the object.
*
- * @return integer
+ * @return int
*/
public function getObjectID();
}
/**
* Returns a simplified message (only inline codes), truncated to 255 characters by default.
*
- * @param integer $maxLength
+ * @param int $maxLength
* @return string
*/
public function getExcerpt($maxLength = 255);
* Returns a message list object.
*
* @param DatabaseObject $container
- * @param integer $lastMessageTime
+ * @param int $lastMessageTime
* @return DatabaseObjectList
*/
public function getMessageList(DatabaseObject $container, $lastMessageTime);
*
* The minimum depth is `1`.
*
- * @return integer
+ * @return int
*/
public function getDepth();
/**
* Returns the number of open parent nodes.
*
- * @return integer
+ * @return int
*/
public function getOpenParentNodes();
/**
* Returns the id of the poll that belongs to this object or `null` if there is no such poll.
*
- * @return null|integer
+ * @return null|int
*/
public function getPollID();
}
/**
* Sets internal iterator pointer based upon related object id.
*
- * @param integer $objectID
+ * @param int $objectID
*/
public function seekTo($objectID);
* Searches a specific object by object id and setting internal iterator
* pointer to found item. Returns `null` if object id is not found.
*
- * @param integer $objectID
+ * @param int $objectID
* @return DatabaseObject|null
*/
public function search($objectID);
/**
* Returns message creation timestamp.
*
- * @return integer
+ * @return int
*/
public function getTime();
/**
* Returns author's user id.
*
- * @return integer
+ * @return int
*/
public function getUserID();
/**
* ids of the object's categories
- * @var integer[]
+ * @var int[]
*/
protected $categoryIDs = [];
/**
* Returns the list of category ids.
*
- * @return integer[]
+ * @return int[]
*/
public function getCategoryIDs() {
return $this->categoryIDs;
/**
* Sets a category id.
*
- * @param integer $categoryID
+ * @param int $categoryID
*/
public function setCategoryID($categoryID) {
$this->categoryIDs[] = $categoryID;
/**
* Sets a category ids.
*
- * @param integer[] $categoryIDs
+ * @param int[] $categoryIDs
*/
public function setCategoryIDs(array $categoryIDs) {
$this->categoryIDs = $categoryIDs;
/**
* current iterator key
- * @var integer
+ * @var int
*/
protected $index = 0;
/**
* Returns the number of child nodes.
*
- * @return integer
+ * @return int
*/
public function count() {
return count($this->children);
*
* The minimum depth is `1`.
*
- * @return integer
+ * @return int
*/
public function getDepth() {
$element = $this;
/**
* Returns the number of open parent nodes.
*
- * @return integer
+ * @return int
*/
public function getOpenParentNodes() {
$element = $this;
/**
* Return the key of the currently iterated child node.
*
- * @return integer
+ * @return int
*/
public function key() {
return $this->index;
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\Acl\Option
*
- * @property-read integer $optionID unique id of the acl option
- * @property-read integer $packageID id of the package which delivers the acl option
- * @property-read integer $objectTypeID id of the `com.woltlab.wcf.acl` object type
+ * @property-read int $optionID unique id of the acl option
+ * @property-read int $packageID id of the package which delivers the acl option
+ * @property-read int $objectTypeID id of the `com.woltlab.wcf.acl` object type
* @property-read string $optionName name and textual identifier of the acl option
* @property-read string $categoryName name of the acl option category the option belongs to
*/
/**
* Returns a list of options by object type id.
*
- * @param integer $objectTypeID
+ * @param int $objectTypeID
* @return ACLOptionList
*/
public static function getOptions($objectTypeID) {
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\Acl\Option\Category
*
- * @property-read integer $categoryID unique id of the acl option category
- * @property-read integer $packageID id of the package which delivers the acl option category
- * @property-read integer $objectTypeID id of the `com.woltlab.wcf.acl` object type
+ * @property-read int $categoryID unique id of the acl option category
+ * @property-read int $packageID id of the package which delivers the acl option category
+ * @property-read int $objectTypeID id of the `com.woltlab.wcf.acl` object type
* @property-read string $categoryName name and textual identifier of the acl option category
*/
class ACLOptionCategory extends DatabaseObject {}
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\Acp\Menu\Item
*
- * @property-read integer $menuItemID unique id of the ACP menu item
- * @property-read integer $packageID id of the package which delivers the ACP menu item
+ * @property-read int $menuItemID unique id of the ACP menu item
+ * @property-read int $packageID id of the package which delivers the ACP menu item
* @property-read string $menuItem textual identifier of the ACP menu item
* @property-read string $parentMenuItem textual identifier of the ACP menu item's parent menu item or empty if it has no parent menu item
* @property-read string $menuItemController class name of the ACP menu item's controller used to generate menu item link
* @property-read string $menuItemLink additional part of the ACP menu item link if `$menuItemController` is set, external link or name of language item which contains the external link
- * @property-read integer $showOrder position of the ACP menu item in relation to its siblings
+ * @property-read int $showOrder position of the ACP menu item in relation to its siblings
* @property-read string $permissions comma separated list of user group permissions of which the active user needs to have at least one to see the ACP menu item
* @property-read string $options comma separated list of options of which at least one needs to be enabled for the ACP menu item to be shown
* @property-read string $icon FontAwesome CSS class name for ACP menu items on the first or third level
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\Acp\Search\Provider
*
- * @property-read integer $providerID unique id of the ACP search provider
- * @property-read integer $packageID id of the package which delivers the ACP search provider
+ * @property-read int $providerID unique id of the ACP search provider
+ * @property-read int $packageID id of the package which delivers the ACP search provider
* @property-read string $providerName textual identifier of the ACP search provider
* @property-read string $className class name of the `wcf\system\search\acp\IACPSearchResultProvider` implementation executing the search
- * @property-read integer $showOrder position of the grouped results of the ACP search provider within the result list
+ * @property-read int $showOrder position of the grouped results of the ACP search provider within the result list
*/
class ACPSearchProvider extends DatabaseObject {
/**
* @package WoltLabSuite\Core\Data\Acp\Session
*
* @property-read string $sessionID unique textual identifier of the acp session
- * @property-read integer|null $userID id of the user the acp session belongs to or `null` if the acp session belongs to a guest
+ * @property-read int|null $userID id of the user the acp session belongs to or `null` if the acp session belongs to a guest
* @property-read string $ipAddress id of the user whom the acp session belongs to
* @property-read string $userAgent user agent of the user whom the acp session belongs to
- * @property-read integer $lastActivityTime timestamp at which the latest activity occurred
+ * @property-read int $lastActivityTime timestamp at which the latest activity occurred
* @property-read string $requestURI uri of the latest request
* @property-read string $requestMethod used request method of the latest request (`GET`, `POST`)
* @property-read string $sessionVariables serialized array with variables stored on a session-basis
* Returns the existing session object for given user id or null if there
* is no such session.
*
- * @param integer $userID
+ * @param int $userID
* @return ACPSession
*/
public static function getSessionByUserID($userID) {
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\Acp\Session\Access\Log
*
- * @property-read integer $sessionAccessLogID unique id of the acp session access log entry
- * @property-read integer $sessionLogID id of the acp session log entry the access log entry belongs to
+ * @property-read int $sessionAccessLogID unique id of the acp session access log entry
+ * @property-read int $sessionLogID id of the acp session log entry the access log entry belongs to
* @property-read string $ipAddress ip address of the user who has caused the acp session access log entry
- * @property-read integer $time timestamp at which the acp session access log entry has been created
+ * @property-read int $time timestamp at which the acp session access log entry has been created
* @property-read string $requestURI uri of the logged request
* @property-read string $requestMethod used request method (`GET`, `POST`)
* @property-read string $className name of the PHP controller class
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\Acp\Session\Log
*
- * @property-read integer $sessionLogID unique id of the acp session log entry
+ * @property-read int $sessionLogID unique id of the acp session log entry
* @property-read string $sessionID id of the acp session the acp session log entry belongs to
- * @property-read integer|null $userID id of the user who has caused the acp session log entry or `null`
+ * @property-read int|null $userID id of the user who has caused the acp session log entry or `null`
* @property-read string $ipAddress ip address of the user who has caused the acp session access log entry
* @property-read string $hostname name of the internet host corresponding to the user's IP address
* @property-read string $userAgent user agent of the user who has caused the acp session access log entry
- * @property-read integer $time timestamp at which the acp session log entry has been created
- * @property-read integer $lastActivityTime timestamp at which the associated session has been active for the last time
+ * @property-read int $time timestamp at which the acp session log entry has been created
+ * @property-read int $lastActivityTime timestamp at which the associated session has been active for the last time
* @property-read string|null $active has the corresponding acp session id as the value if the session is still active, otherwise `null`
*/
class ACPSessionLog extends DatabaseObject {
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\Acp\Template
*
- * @property-read integer $templateID unique id of the acp template
- * @property-read integer|null $packageID id of the package which delivers the acp template
+ * @property-read int $templateID unique id of the acp template
+ * @property-read int|null $packageID id of the package which delivers the acp template
* @property-read string $templateName name of the template
* @property-read string $application abbreviation of the application to which the template belongs
*/
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\Ad
*
- * @property-read integer $adID unique id of the ad
- * @property-read integer $objectTypeID id of the `com.woltlab.wcf.adLocation` object type
+ * @property-read int $adID unique id of the ad
+ * @property-read int $objectTypeID id of the `com.woltlab.wcf.adLocation` object type
* @property-read string $adName name of the ad shown in ACP
* @property-read string $ad ad text
- * @property-read integer $isDisabled is `1` if the ad is disabled and thus not shown, otherwise `0`
- * @property-read integer $showOrder position of the ad in relation to the other ads at the same location
+ * @property-read int $isDisabled is `1` if the ad is disabled and thus not shown, otherwise `0`
+ * @property-read int $showOrder position of the ad in relation to the other ads at the same location
*/
class Ad extends DatabaseObject implements IRouteController {
/**
/**
* Sets the show order of the ad.
*
- * @param integer $showOrder
+ * @param int $showOrder
*/
public function setShowOrder($showOrder = 0) {
$sql = "SELECT MAX(showOrder)
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\Application
*
- * @property-read integer $packageID id of the package which delivers the application
+ * @property-read int $packageID id of the package which delivers the application
* @property-read string $domainName domain used to access the application (may not contain path components, see `$domainPath`)
* @property-read string $domainPath path used to access the application
* @property-read string $cookieDomain domain used to set cookies (corresponds to `domain` cookie property; may not contain path components)
- * @property-read integer $isTainted is `1` if the application is being uninstalled and thus should not be loaded during uninstallation, otherwise `0`
- * @property-read integer $landingPageID id of the page that is used as initial page when app is accessed without a controller name
+ * @property-read int $isTainted is `1` if the application is being uninstalled and thus should not be loaded during uninstallation, otherwise `0`
+ * @property-read int $landingPageID id of the page that is used as initial page when app is accessed without a controller name
*/
class Application extends DatabaseObject {
/**
* @package WoltLabSuite\Core\Data\Article
* @since 3.0
*
- * @property-read integer $articleID unique id of the article
- * @property-read integer|null $userID id of the user the article belongs to or `null` if the user does not exist anymore
+ * @property-read int $articleID unique id of the article
+ * @property-read int|null $userID id of the user the article belongs to or `null` if the user does not exist anymore
* @property-read string $username name of the user the article belongs to
- * @property-read integer $time timestamp at which the comment has been written
- * @property-read integer $categoryID id of the category the article belongs to
- * @property-read integer $isMultilingual is `1` if the article is available in multiple languages, otherwise `0`
- * @property-read integer $publicationStatus publication status of the article (see `Article::UNPUBLISHED`, `Article::PUBLISHED` and `Article::DELAYED_PUBLICATION`)
- * @property-read integer $publicationDate timestamp at which the article will be automatically published or `0` if it has already been published
- * @property-read integer $enableComments is `1` if comments are enabled for the article, otherwise `0`
- * @property-read integer $comments number of comments on the article
- * @property-read integer $views number of times the article has been viewed
- * @property-read integer $cumulativeLikes cumulative result of likes (counting `+1`) and dislikes (counting `-1`) for the article
- * @property-read integer $isDeleted is 1 if the article is in trash bin, otherwise 0
- * @property-read integer $hasLabels is `1` if labels are assigned to the article
+ * @property-read int $time timestamp at which the comment has been written
+ * @property-read int $categoryID id of the category the article belongs to
+ * @property-read int $isMultilingual is `1` if the article is available in multiple languages, otherwise `0`
+ * @property-read int $publicationStatus publication status of the article (see `Article::UNPUBLISHED`, `Article::PUBLISHED` and `Article::DELAYED_PUBLICATION`)
+ * @property-read int $publicationDate timestamp at which the article will be automatically published or `0` if it has already been published
+ * @property-read int $enableComments is `1` if comments are enabled for the article, otherwise `0`
+ * @property-read int $comments number of comments on the article
+ * @property-read int $views number of times the article has been viewed
+ * @property-read int $cumulativeLikes cumulative result of likes (counting `+1`) and dislikes (counting `-1`) for the article
+ * @property-read int $isDeleted is 1 if the article is in trash bin, otherwise 0
+ * @property-read int $hasLabels is `1` if labels are assigned to the article
*/
class Article extends DatabaseObject implements ILinkableObject, IUserContent {
/**
/**
* Unmarks articles.
*
- * @param integer[] $articleIDs
+ * @param int[] $articleIDs
*/
protected function unmarkItems(array $articleIDs = []) {
if (empty($articleIDs)) {
/**
* Creates a new CategoryArticleList object.
*
- * @param integer|integer[] $categoryID
+ * @param int|int[] $categoryID
* @param boolean $includeChildCategories
* @throws \InvalidArgumentException
*/
/**
* Creates a new FeedArticleList object.
*
- * @param integer $categoryID
+ * @param int $categoryID
*/
public function __construct($categoryID = 0) {
if ($categoryID) {
* @method Article getDecoratedObject()
* @method ArticleContent|ViewableArticleContent getArticleContent()
* @mixin Article
- * @property-read integer|null $visitTime last time the active user has visited the time or `null` if object has not been fetched via `ViewableArticleList` or if the active user is a guest
+ * @property-read int|null $visitTime last time the active user has visited the time or `null` if object has not been fetched via `ViewableArticleList` or if the active user is a guest
*/
class ViewableArticle extends DatabaseObjectDecorator {
/**
/**
* effective visit time
- * @var integer
+ * @var int
*/
protected $effectiveVisitTime;
/**
* number of unread articles
- * @var integer
+ * @var int
*/
protected static $unreadArticles;
/**
* number of unread articles in watched categories
- * @var integer
+ * @var int
* @since 5.2
*/
protected static $unreadWatchedArticles;
/**
* number of unread articles ordered by categories
- * @var integer
+ * @var int
* @since 5.2
*/
protected static $unreadArticlesByCategory;
/**
* Returns a specific article decorated as viewable article or `null` if it does not exist.
*
- * @param integer $articleID
+ * @param int $articleID
* @param boolean $enableContentLoading Enables/disables the loading of article content objects
* @return ViewableArticle
*/
/**
* Returns the effective visit time.
*
- * @return integer
+ * @return int
*/
public function getVisitTime() {
if ($this->effectiveVisitTime === null) {
/**
* Returns the number of unread articles.
*
- * @return integer
+ * @return int
*/
public static function getUnreadArticles() {
if (self::$unreadArticles === null) {
/**
* Returns the number of unread articles for a specific category.
*
- * @param integer $articleCategoryID
- * @return integer
+ * @param int $articleCategoryID
+ * @return int
* @since 5.2
*/
public static function getUnreadArticlesForCategory($articleCategoryID) {
/**
* Returns the unread article count for a specific category.
*
- * @param integer $articleCategoryID
- * @return integer
+ * @param int $articleCategoryID
+ * @return int
* @since 5.2
*/
private static function fetchUnreadArticlesForCategory($articleCategoryID) {
/**
* Returns the number of unread articles in watched categories.
*
- * @return integer
+ * @return int
* @since 5.2
*/
public static function getWatchedUnreadArticles() {
/**
* subscribed categories
- * @var integer[]
+ * @var int[]
*/
protected static $subscribedCategories;
* Returns a list with ids of accessible categories.
*
* @param string[] $permissions
- * @return integer[]
+ * @return int[]
*/
public static function getAccessibleCategoryIDs(array $permissions = ['canReadArticle']) {
$categoryIDs = [];
/**
* Returns the list of subscribed categories.
*
- * @return integer[]
+ * @return int[]
* @since 5.2
*/
public static function getSubscribedCategoryIDs() {
class ArticleCategoryCache extends SingletonFactory {
/**
* number of total articles
- * @var integer[]
+ * @var int[]
*/
protected $articles;
/**
* Counts the articles contained in this category and its children.
*
- * @param integer[] $categoryToParent
- * @param integer[] $articles
- * @param integer $categoryID
- * @return integer
+ * @param int[] $categoryToParent
+ * @param int[] $articles
+ * @param int $categoryID
+ * @return int
*/
protected function countArticles(array &$categoryToParent, array &$articles, $categoryID) {
$count = (isset($articles[$categoryID])) ? $articles[$categoryID] : 0;
/**
* Returns the number of articles in the category with the given id.
*
- * @param integer $categoryID
- * @return integer
+ * @param int $categoryID
+ * @return int
*/
public function getArticles($categoryID) {
if ($this->articles === null) {
/**
* number of articles in the category
- * @var integer
+ * @var int
*/
protected $articles;
/**
* Returns number of articles in the category.
*
- * @return integer
+ * @return int
*/
public function getArticles() {
if ($this->articles === null) {
* @package WoltLabSuite\Core\Data\Article\Content
* @since 3.0
*
- * @property-read integer $articleContentID unique id of the article content
- * @property-read integer $articleID id of the article the article content belongs to
- * @property-read integer $languageID id of the article content's language
+ * @property-read int $articleContentID unique id of the article content
+ * @property-read int $articleID id of the article the article content belongs to
+ * @property-read int $languageID id of the article content's language
* @property-read string $title title of the article in the associated language
* @property-read string $content actual content of the article in the associated language
* @property-read string $teaser teaser of the article in the associated language or empty if no teaser exists
- * @property-read integer|null $imageID id of the (image) media object used as article image for the associated language or `null` if no image is used
- * @property-read integer|null $teaserImageID id of the (image) media object used as article teaser image for the associated language or `null` if no image is used
- * @property-read integer $hasEmbeddedObjects is `1` if there are embedded objects in the article content, otherwise `0`
+ * @property-read int|null $imageID id of the (image) media object used as article image for the associated language or `null` if no image is used
+ * @property-read int|null $teaserImageID id of the (image) media object used as article teaser image for the associated language or `null` if no image is used
+ * @property-read int $hasEmbeddedObjects is `1` if there are embedded objects in the article content, otherwise `0`
* @property-read string $metaTitle title of the article used in the title tag
* @property-read string $metaDescription meta description of the article
*/
/**
* Returns a certain article content or `null` if it does not exist.
*
- * @param integer $articleID
- * @param integer $languageID
+ * @param int $articleID
+ * @param int $languageID
* @return ArticleContent|null
*/
public static function getArticleContent($articleID, $languageID) {
/**
* Returns a specific article content decorated as viewable article content.
*
- * @param integer $articleContentID
+ * @param int $articleContentID
* @return ViewableArticleContent
*/
public static function getArticleContent($articleContentID) {
/**
* Returns attachment statistics.
*
- * @return integer[]
+ * @return int[]
*/
public function getStats() {
$sql = "SELECT COUNT(*) AS count,
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\Attachment
*
- * @property-read integer $attachmentID unique id of the attachment
- * @property-read integer $objectTypeID id of the `com.woltlab.wcf.attachment.objectType` object type
- * @property-read integer|null $objectID id of the attachment container object the attachment belongs to
- * @property-read integer|null $userID id of the user who uploaded the attachment or `null` if the user does not exist anymore or if the attachment has been uploaded by a guest
+ * @property-read int $attachmentID unique id of the attachment
+ * @property-read int $objectTypeID id of the `com.woltlab.wcf.attachment.objectType` object type
+ * @property-read int|null $objectID id of the attachment container object the attachment belongs to
+ * @property-read int|null $userID id of the user who uploaded the attachment or `null` if the user does not exist anymore or if the attachment has been uploaded by a guest
* @property-read string $tmpHash temporary hash used to identify uploaded attachments but not associated with an object yet or empty if the attachment has been associated with an object
* @property-read string $filename name of the physical attachment file
- * @property-read integer $filesize size of the physical attachment file
+ * @property-read int $filesize size of the physical attachment file
* @property-read string $fileType type of the physical attachment file
* @property-read string $fileHash hash of the physical attachment file
- * @property-read integer $isImage is `1` if the attachment is an image, otherwise `0`
- * @property-read integer $width width of the attachment if `$isImage` is `1`, otherwise `0`
- * @property-read integer $height height of the attachment if `$isImage` is `1`, otherwise `0`
+ * @property-read int $isImage is `1` if the attachment is an image, otherwise `0`
+ * @property-read int $width width of the attachment if `$isImage` is `1`, otherwise `0`
+ * @property-read int $height height of the attachment if `$isImage` is `1`, otherwise `0`
* @property-read string $tinyThumbnailType type of the tiny thumbnail file for the attachment if `$isImage` is `1`, otherwise empty
- * @property-read integer $tinyThumbnailSize size of the tiny thumbnail file for the attachment if `$isImage` is `1`, otherwise `0`
- * @property-read integer $tinyThumbnailWidth width of the tiny thumbnail file for the attachment if `$isImage` is `1`, otherwise `0`
- * @property-read integer $tinyThumbnailHeight height of the tiny thumbnail file for the attachment if `$isImage` is `1`, otherwise `0`
+ * @property-read int $tinyThumbnailSize size of the tiny thumbnail file for the attachment if `$isImage` is `1`, otherwise `0`
+ * @property-read int $tinyThumbnailWidth width of the tiny thumbnail file for the attachment if `$isImage` is `1`, otherwise `0`
+ * @property-read int $tinyThumbnailHeight height of the tiny thumbnail file for the attachment if `$isImage` is `1`, otherwise `0`
* @property-read string $thumbnailType type of the thumbnail file for the attachment if `$isImage` is `1`, otherwise empty
- * @property-read integer $thumbnailSize size of the thumbnail file for the attachment if `$isImage` is `1`, otherwise `0`
- * @property-read integer $thumbnailWidth width of the thumbnail file for the attachment if `$isImage` is `1`, otherwise `0`
- * @property-read integer $thumbnailHeight height of the thumbnail file for the attachment if `$isImage` is `1`, otherwise `0`
- * @property-read integer $downloads number of times the attachment has been downloaded
- * @property-read integer $lastDownloadTime timestamp at which the attachment has been downloaded the last time
- * @property-read integer $uploadTime timestamp at which the attachment has been uploaded
- * @property-read integer $showOrder position of the attachment in relation to the other attachment to the same message
+ * @property-read int $thumbnailSize size of the thumbnail file for the attachment if `$isImage` is `1`, otherwise `0`
+ * @property-read int $thumbnailWidth width of the thumbnail file for the attachment if `$isImage` is `1`, otherwise `0`
+ * @property-read int $thumbnailHeight height of the thumbnail file for the attachment if `$isImage` is `1`, otherwise `0`
+ * @property-read int $downloads number of times the attachment has been downloaded
+ * @property-read int $lastDownloadTime timestamp at which the attachment has been downloaded the last time
+ * @property-read int $uploadTime timestamp at which the attachment has been uploaded
+ * @property-read int $showOrder position of the attachment in relation to the other attachment to the same message
*/
class Attachment extends DatabaseObject implements ILinkableObject, IRouteController, IThumbnailFile {
/**
/**
* Returns the objects of the list.
*
- * @param integer $objectID
+ * @param int $objectID
* @return Attachment[]
*/
public function getGroupedObjects($objectID) {
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\Bbcode
*
- * @property-read integer $bbcodeID unique id of the bbcode
+ * @property-read int $bbcodeID unique id of the bbcode
* @property-read string $bbcodeTag tag of the bbcode
- * @property-read integer $packageID id of the package which delivers the bbcode or `1` if it has been created in the acp
+ * @property-read int $packageID id of the package which delivers the bbcode or `1` if it has been created in the acp
* @property-read string $htmlOpen html code of the opening tag (without the less-than sign and greater-than sign) or empty if no such html code exists
* @property-read string $htmlClose html code of the closing tag (without the less-than sign and greater-than sign) or empty if no such html code exists
* @property-read string $className name of the PHP class implementing `wcf\system\bbcode\IBBCode` or empty if no such class exists
- * @property-read integer $isBlockElement is `1` if the bbcode represents a block element and thus can contain multiple lines, otherwise `0`
+ * @property-read int $isBlockElement is `1` if the bbcode represents a block element and thus can contain multiple lines, otherwise `0`
* @property-read string $wysiwygIcon css class name used as icon for the bbcode in the editor toolbar
* @property-read string $buttonLabel name of the language item used as button label for the bbcode in the editor toolbar
- * @property-read integer $isSourceCode is `1` if the bbcode's content is treated as source code, otherwise `0`
- * @property-read integer $showButton is `1` if a button for the bbcode will be shown in the editor toolbar, otherwise `0`
- * @property-read integer $originIsSystem is `1` if the bbcode has been delivered by a package, otherwise `0` (if the bbcode has been created by an admin in the acp)
+ * @property-read int $isSourceCode is `1` if the bbcode's content is treated as source code, otherwise `0`
+ * @property-read int $showButton is `1` if a button for the bbcode will be shown in the editor toolbar, otherwise `0`
+ * @property-read int $originIsSystem is `1` if the bbcode has been delivered by a package, otherwise `0` (if the bbcode has been created by an admin in the acp)
*/
class BBCode extends ProcessibleDatabaseObject implements IRouteController {
/**
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\Bbcode\Attribute
*
- * @property-read integer $attributeID unique id of the bbcode attribute
- * @property-read integer $bbcodeID id of the bbcode the attribute belongs to
- * @property-read integer $attributeNo number of bbcode attribute
+ * @property-read int $attributeID unique id of the bbcode attribute
+ * @property-read int $bbcodeID id of the bbcode the attribute belongs to
+ * @property-read int $attributeNo number of bbcode attribute
* @property-read string $attributeHtml html code used to render the bbcode attribute or empty if no such html code exists
* @property-read string $validationPattern regular expression used to validate the bbcode attribute's value or empty if no such regular expression exists
- * @property-read integer $required is `1` if the bbcode attribute is required of the bbcode, otherwise `0`
- * @property-read integer $useText is `1` if the bbcode's content will be used as the bbcode attribute value
+ * @property-read int $required is `1` if the bbcode attribute is required of the bbcode, otherwise `0`
+ * @property-read int $useText is `1` if the bbcode's content will be used as the bbcode attribute value
*/
class BBCodeAttribute extends DatabaseObject {
/**
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\Bbcode\Media\Provider
*
- * @property-read integer $providerID unique id of the bbcode media provider
+ * @property-read int $providerID unique id of the bbcode media provider
* @property-read string $title title of the bbcode media provider (shown in acp)
* @property-read string $regex regular expression to recognize media elements/element urls
* @property-read string $html html code used to render media elements
* @package WoltLabSuite\Core\Data\Box
* @since 3.0
*
- * @property-read integer $boxID unique id of the box
- * @property-read integer|null $objectTypeID id of the box controller object type
+ * @property-read int $boxID unique id of the box
+ * @property-read int|null $objectTypeID id of the box controller object type
* @property-read string $identifier unique textual identifier of the box
* @property-read string $name monolingual name of the box shown in the ACP
* @property-read string $boxType type of the box which determines the method of outputting its content (default box types are `text`, `html`, `tpl`, `system`)
* @property-read string $position name of the position on the page at which the box is shown
- * @property-read integer $showOrder position of the box in relation to its siblings
- * @property-read integer $visibleEverywhere is `1` if the box is visible on every page, otherwise `0`
- * @property-read integer $isMultilingual is `1` if the box content is available in multiple languages, otherwise `0`
- * @property-read integer $lastUpdateTime timestamp at which the box has been updated the last time
+ * @property-read int $showOrder position of the box in relation to its siblings
+ * @property-read int $visibleEverywhere is `1` if the box is visible on every page, otherwise `0`
+ * @property-read int $isMultilingual is `1` if the box content is available in multiple languages, otherwise `0`
+ * @property-read int $lastUpdateTime timestamp at which the box has been updated the last time
* @property-read string $cssClassName css class name(s) of the box
- * @property-read integer $showHeader is `1` if the box header will be shown, otherwise `0`
- * @property-read integer $originIsSystem is `1` if the box has been delivered by a package, otherwise `0` (i.e. the box has been created in the ACP)
- * @property-read integer $packageID id of the package which delivers the box or `1` if it has been created in the ACP
- * @property-read integer|null $menuID id of the menu whose menu items are shown in the contents if `$boxType = menu`, otherwise `null`
- * @property-read integer|null $linkPageID id of the (internal) page the box image and box title are linking to or `null` if no internal page is linked
- * @property-read integer $linkPageObjectID id of the object the (internal) page links refers to or `0` if no internal link is used or no specific object is linked
+ * @property-read int $showHeader is `1` if the box header will be shown, otherwise `0`
+ * @property-read int $originIsSystem is `1` if the box has been delivered by a package, otherwise `0` (i.e. the box has been created in the ACP)
+ * @property-read int $packageID id of the package which delivers the box or `1` if it has been created in the ACP
+ * @property-read int|null $menuID id of the menu whose menu items are shown in the contents if `$boxType = menu`, otherwise `null`
+ * @property-read int|null $linkPageID id of the (internal) page the box image and box title are linking to or `null` if no internal page is linked
+ * @property-read int $linkPageObjectID id of the object the (internal) page links refers to or `0` if no internal link is used or no specific object is linked
* @property-read string $externalURL external link used to for the box image and box title or empty if no external link is set
* @property-read array $additionalData array with additional data of the box
- * @property-read integer|null $limit number of objects shown in the box for `AbstractDatabaseObjectListBoxController` controllers or `null` otherwise
+ * @property-read int|null $limit number of objects shown in the box for `AbstractDatabaseObjectListBoxController` controllers or `null` otherwise
* @property-read string|null $sortField sort field of the objects shown in the box for `AbstractDatabaseObjectListBoxController` controllers or `null` otherwise
* @property-read string|null $sortOrder sort order of the objects shown in the box for `AbstractDatabaseObjectListBoxController` controllers or `null` otherwise
- * @property-read integer $isDisabled is `1` if the box is disabled and thus is not displayed, otherwise `0`
+ * @property-read int $isDisabled is `1` if the box is disabled and thus is not displayed, otherwise `0`
*/
class Box extends DatabaseObject {
/**
/**
* box to page assignments
- * @var integer[]
+ * @var int[]
*/
protected $pageIDs;
/**
* virtual show order of this box
- * @var integer
+ * @var int
*/
public $virtualShowOrder = -1;
/**
* Returns the template name of this box.
*
- * @param integer $languageID
+ * @param int $languageID
* @return string
*/
public function getTplName($languageID = null) {
/**
* Returns box to page assignments.
*
- * @return integer[]
+ * @return int[]
*/
public function getPageIDs() {
if ($this->pageIDs === null) {
/**
* Sets the virtual show order of this box.
*
- * @param integer $virtualShowOrder
+ * @param int $virtualShowOrder
*/
public function setVirtualShowOrder($virtualShowOrder) {
$this->virtualShowOrder = $virtualShowOrder;
/**
* Creates the template file for "tpl"-type boxes.
*
- * @param integer $languageID
+ * @param int $languageID
* @param string $content
*/
public function writeTemplate($languageID, $content) {
* @package WoltLabSuite\Core\Data\Box\Content
* @since 3.0
*
- * @property-read integer $boxContentID unique id of the box content
- * @property-read integer $boxID id of the box the box content belongs to
- * @property-read integer $languageID id of the box content's language
+ * @property-read int $boxContentID unique id of the box content
+ * @property-read int $boxID id of the box the box content belongs to
+ * @property-read int $languageID id of the box content's language
* @property-read string $title title of the page in the associated language
* @property-read string $content actual content of the box in the associated language
- * @property-read integer|null $imageID id of the (image) media object used as box image for the associated language or `null` if no image is used
- * @property-read integer $hasEmbeddedObjects is `1` if the box content contains embedded objects, otherwise `0`
+ * @property-read int|null $imageID id of the (image) media object used as box image for the associated language or `null` if no image is used
+ * @property-read int $hasEmbeddedObjects is `1` if the box content contains embedded objects, otherwise `0`
*/
class BoxContent extends DatabaseObject {
/**
/**
* Returns a certain box content or `null` if it does not exist.
*
- * @param integer $boxID
- * @param integer $languageID
+ * @param int $boxID
+ * @param int $languageID
* @return BoxContent|null
*/
public static function getBoxContent($boxID, $languageID) {
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\Captcha\Question
*
- * @property-read integer $questionID unique id of the captcha question
+ * @property-read int $questionID unique id of the captcha question
* @property-read string $question question of the captcha or name of language item which contains the question
* @property-read string $answers newline-separated list of answers or name of language item which contains the answers
- * @property-read integer $isDisabled is `1` if the captcha question is disabled and thus not offered to answer, otherwise `0`
+ * @property-read int $isDisabled is `1` if the captcha question is disabled and thus not offered to answer, otherwise `0`
*/
class CaptchaQuestion extends DatabaseObject {
/**
* Returns the decorated category with the given id or `null` if no such
* category exists.
*
- * @param integer $categoryID
+ * @param int $categoryID
* @return AbstractDecoratedCategory|null
*/
public static function getCategory($categoryID) {
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\Category
*
- * @property-read integer $categoryID unique id of the category
- * @property-read integer $objectTypeID id of the `com.woltlab.wcf.category` object type
- * @property-read integer $parentCategoryID id of the category's parent category or `0` if it has no parent category
+ * @property-read int $categoryID unique id of the category
+ * @property-read int $objectTypeID id of the `com.woltlab.wcf.category` object type
+ * @property-read int $parentCategoryID id of the category's parent category or `0` if it has no parent category
* @property-read string $title title of the category or name of language item which contains the title
* @property-read string $description description of the category or name of language item which contains the description
- * @property-read integer $descriptionUseHtml is `1` if html is enabled in the description, otherwise `0`
- * @property-read integer $showOrder position of the category in relation to its siblings
- * @property-read integer $time timestamp at which the comment has been created
- * @property-read integer $isDisabled is `1` if the category is disabled and thus neither accessible nor selectable, otherwise `0`
+ * @property-read int $descriptionUseHtml is `1` if html is enabled in the description, otherwise `0`
+ * @property-read int $showOrder position of the category in relation to its siblings
+ * @property-read int $time timestamp at which the comment has been created
+ * @property-read int $isDisabled is `1` if the category is disabled and thus neither accessible nor selectable, otherwise `0`
* @property-read array $additionalData array with additional data of the category
*/
class Category extends ProcessibleDatabaseObject implements IPermissionObject, IRouteController {
* Prepares the update of the show order of this category and return the
* correct new show order.
*
- * @param integer $parentCategoryID
- * @param integer $showOrder
- * @return integer
+ * @param int $parentCategoryID
+ * @param int $showOrder
+ * @return int
*/
public function updateShowOrder($parentCategoryID, $showOrder) {
// correct invalid values
/**
* Returns the show order for a new category.
*
- * @param integer $objectTypeID
- * @param integer $parentCategoryID
- * @param integer $showOrder
- * @return integer
+ * @param int $objectTypeID
+ * @param int $parentCategoryID
+ * @param int $showOrder
+ * @return int
*/
protected static function getShowOrder($objectTypeID, $parentCategoryID, $showOrder) {
// correct invalid values
class CategoryNodeTree implements \IteratorAggregate {
/**
* list of ids of categories which will not be included in the node tree
- * @var integer[]
+ * @var int[]
*/
protected $excludedCategoryIDs = [];
/**
* maximum depth considered when building the node tree
- * @var integer
+ * @var int
*/
protected $maxDepth = -1;
/**
* id of the parent category
- * @var integer
+ * @var int
*/
protected $parentCategoryID = 0;
* Creates a new instance of CategoryNodeTree.
*
* @param string $objectType
- * @param integer $parentCategoryID
+ * @param int $parentCategoryID
* @param boolean $includeDisabledCategories
- * @param integer[] $excludedCategoryIDs
+ * @param int[] $excludedCategoryIDs
* @throws SystemException
*/
public function __construct($objectType, $parentCategoryID = 0, $includeDisabledCategories = false, array $excludedCategoryIDs = []) {
* Sets the maximum depth considered when building the node tree, defaults
* to -1 which equals infinite.
*
- * @param integer $maxDepth
+ * @param int $maxDepth
*/
public function setMaxDepth($maxDepth) {
$this->maxDepth = $maxDepth;
* Builds a certain level of the tree.
*
* @param CategoryNode $parentNode
- * @param integer $depth
+ * @param int $depth
*/
protected function buildTreeLevel(CategoryNode $parentNode, $depth = 0) {
if ($this->maxDepth != -1 && $depth < 0) {
/**
* Returns the category with the given id.
*
- * @param integer $categoryID
+ * @param int $categoryID
* @return Category
*/
protected function getCategory($categoryID) {
/**
* Returns the category node for the category with the given id.
*
- * @param integer $categoryID
+ * @param int $categoryID
* @return CategoryNode
*/
protected function getNode($categoryID) {
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\Clipboard\Action
*
- * @property-read integer $actionID unique id of the clipboard action
- * @property-read integer $packageID id of the package which delivers the clipboard action
+ * @property-read int $actionID unique id of the clipboard action
+ * @property-read int $packageID id of the package which delivers the clipboard action
* @property-read string $actionName name and textual identifier of the clipboard action
* @property-read string $actionClassName PHP class name implementing `wcf\system\clipboard\action\IClipboardAction`
- * @property-read integer $showOrder position of the clipboard action in relation to the other clipboard actions
+ * @property-read int $showOrder position of the clipboard action in relation to the other clipboard actions
*/
class ClipboardAction extends DatabaseObject {}
class ClipboardItemAction extends AbstractDatabaseObjectAction {
/**
* object type id
- * @var integer
+ * @var int
*/
public $objectTypeID = 0;
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\Comment
*
- * @property-read integer $commentID unique id of the comment
- * @property-read integer $objectTypeID id of the `com.woltlab.wcf.comment.commentableContent` object type
- * @property-read integer $objectID id of the commented object of the object type represented by `$objectTypeID`
- * @property-read integer $time timestamp at which the comment has been written
- * @property-read integer|null $userID id of the user who wrote the comment or `null` if the user does not exist anymore or if the comment has been written by a guest
+ * @property-read int $commentID unique id of the comment
+ * @property-read int $objectTypeID id of the `com.woltlab.wcf.comment.commentableContent` object type
+ * @property-read int $objectID id of the commented object of the object type represented by `$objectTypeID`
+ * @property-read int $time timestamp at which the comment has been written
+ * @property-read int|null $userID id of the user who wrote the comment or `null` if the user does not exist anymore or if the comment has been written by a guest
* @property-read string $username name of the user or guest who wrote the comment
* @property-read string $message comment message
- * @property-read integer $responses number of responses on the comment
+ * @property-read int $responses number of responses on the comment
* @property-read string $responseIDs serialized array with the ids of the five latest comment responses
- * @property-read integer $unfilteredResponses number of all responses on the comment, including disabled ones
+ * @property-read int $unfilteredResponses number of all responses on the comment, including disabled ones
* @property-read string $unfilteredResponseIDs serialized array with the ids of the five latest comment responses, including disabled ones
- * @property-read integer $enableHtml is 1 if HTML will rendered in the comment, otherwise 0
- * @property-read integer $isDisabled is 1 if the comment is disabled, otherwise 0
+ * @property-read int $enableHtml is 1 if HTML will rendered in the comment, otherwise 0
+ * @property-read int $isDisabled is 1 if the comment is disabled, otherwise 0
*/
class Comment extends DatabaseObject implements IMessage {
use TUserContent;
/**
* Returns a list of response ids.
*
- * @return integer[]
+ * @return int[]
*/
public function getResponseIDs() {
if ($this->responseIDs === null || $this->responseIDs == '') {
/**
* Returns a list of unfiltered response ids, including those that are still disabled.
*
- * @return integer[]
+ * @return int[]
*/
public function getUnfilteredResponseIDs() {
if ($this->unfilteredResponseIDs === null || $this->unfilteredResponseIDs == '') {
/**
* Enables a comment.
*
- * @return integer[]
+ * @return int[]
*/
public function enable() {
if ($this->comment === null) $this->comment = reset($this->objects);
/**
* Enables a response.
*
- * @return integer[]
+ * @return int[]
*/
public function enableResponse() {
if ($this->comment === null) $this->comment = reset($this->objects);
/**
* Removes a comment or response.
*
- * @return integer[]
+ * @return int[]
*/
public function remove() {
if ($this->comment !== null) {
/**
* Validates object type id parameter.
*
- * @param integer $objectTypeID
+ * @param int $objectTypeID
* @return ObjectType
* @throws UserInputException
*/
* Returns the current html input processor or a new one if `$message` is not null.
*
* @param string|null $message source message
- * @param integer $objectID object id
+ * @param int $objectID object id
* @return HtmlInputProcessor
*/
public function getHtmlInputProcessor($message = null, $objectID = 0) {
/**
* iterator index
- * @var integer
+ * @var int
*/
private $position = 0;
/**
* Returns timestamp of oldest response loaded.
*
- * @return integer
+ * @return int
*/
public function getLastResponseTime() {
$lastResponseTime = 0;
/**
* minimum comment time
- * @var integer
+ * @var int
*/
public $minCommentTime = 0;
/**
* object type id
- * @var integer
+ * @var int
*/
public $objectTypeID = 0;
/**
* object id
- * @var integer
+ * @var int
*/
public $objectID = 0;
/**
* ids of the responses of the comments in the list
- * @var integer[]
+ * @var int[]
*/
public $responseIDs = [];
* Creates a new structured comment list.
*
* @param ICommentManager $commentManager
- * @param integer $objectTypeID
- * @param integer $objectID
+ * @param int $objectTypeID
+ * @param int $objectID
*/
public function __construct(ICommentManager $commentManager, $objectTypeID, $objectID) {
parent::__construct();
/**
* Returns minimum comment time.
*
- * @return integer
+ * @return int
*/
public function getMinCommentTime() {
return $this->minCommentTime;
/**
* Returns a specific comment decorated as comment entry.
*
- * @param integer $commentID
+ * @param int $commentID
* @return ViewableComment
*/
public static function getComment($commentID) {
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\Comment\Response
*
- * @property-read integer $responseID unique id of the comment response
- * @property-read integer $commentID id of the comment the comment response belongs to
- * @property-read integer $time timestamp at which the comment response has been written
- * @property-read integer|null $userID id of the user who wrote the comment response or `null` if the user does not exist anymore or if the comment response has been written by a guest
+ * @property-read int $responseID unique id of the comment response
+ * @property-read int $commentID id of the comment the comment response belongs to
+ * @property-read int $time timestamp at which the comment response has been written
+ * @property-read int|null $userID id of the user who wrote the comment response or `null` if the user does not exist anymore or if the comment response has been written by a guest
* @property-read string $username name of the user or guest who wrote the comment response
* @property-read string $message comment response message
- * @property-read integer $enableHtml is 1 if HTML will rendered in the comment response, otherwise 0
- * @property-read integer $isDisabled is 1 if the comment response is disabled, otherwise 0
+ * @property-read int $enableHtml is 1 if HTML will rendered in the comment response, otherwise 0
+ * @property-read int $isDisabled is 1 if the comment response is disabled, otherwise 0
*/
class CommentResponse extends DatabaseObject implements IMessage {
use TUserContent;
/**
* Validates object type id parameter.
*
- * @param integer $objectTypeID
+ * @param int $objectTypeID
* @return ObjectType
* @throws UserInputException
*/
* Returns the current html input processor or a new one if `$message` is not null.
*
* @param string|null $message source message
- * @param integer $objectID object id
+ * @param int $objectID object id
* @return HtmlInputProcessor
*/
public function getHtmlInputProcessor($message = null, $objectID = 0) {
/**
* Returns a structured response.
*
- * @param integer $responseID
+ * @param int $responseID
* @return StructuredCommentResponse
*/
public static function getResponse($responseID) {
/**
* minimum response time
- * @var integer
+ * @var int
*/
public $minResponseTime = 0;
/**
* Returns minimum response time.
*
- * @return integer
+ * @return int
*/
public function getMinResponseTime() {
return $this->minResponseTime;
/**
* Returns a specific comment response decorated as viewable comment response.
*
- * @param integer $responseID
+ * @param int $responseID
* @return ViewableCommentResponse
*/
public static function getResponse($responseID) {
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\Condition
*
- * @property-read integer $conditionID unique id of the condition
- * @property-read integer $objectTypeID id of the condition object type (of different condition object type definitions)
- * @property-read integer $objectID id of the conditioned object of the object type represented by `$objectTypeID`
+ * @property-read int $conditionID unique id of the condition
+ * @property-read int $objectTypeID id of the condition object type (of different condition object type definitions)
+ * @property-read int $objectID id of the conditioned object of the object type represented by `$objectTypeID`
* @property-read array $conditionData array with the condition data with is processed by the condition object type's processor
*/
class Condition extends DatabaseObject {
* @package WoltLabSuite\Core\Data\Contact\Recipient
* @since 3.1
*
- * @property-read integer $recipientID unique id of the recipient
+ * @property-read int $recipientID unique id of the recipient
* @property-read string $name name of the recipient
* @property-read string $email email address of the recipient
- * @property-read integer $showOrder position of the recipient in relation to other recipients
- * @property-read integer $isAdministrator is `1` if the recipient is the administrator and the `email` value equals `MAIL_ADMIN_ADDRESS`, otherwise `0`
- * @property-read integer $isDisabled is `1` if the recipient is disabled and thus is not available for selection, otherwise `0`
- * @property-read integer $originIsSystem is `1` if the recipient has been delivered by a package, otherwise `0` (i.e. the recipient has been created in the ACP)
+ * @property-read int $showOrder position of the recipient in relation to other recipients
+ * @property-read int $isAdministrator is `1` if the recipient is the administrator and the `email` value equals `MAIL_ADMIN_ADDRESS`, otherwise `0`
+ * @property-read int $isDisabled is `1` if the recipient is disabled and thus is not available for selection, otherwise `0`
+ * @property-read int $originIsSystem is `1` if the recipient has been delivered by a package, otherwise `0` (i.e. the recipient has been created in the ACP)
*/
class ContactRecipient extends DatabaseObject {
/**
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\Core\Object
*
- * @property-read integer $objectID unique id of the core object
- * @property-read integer $packageID id of the package which delivers the core object
+ * @property-read int $objectID unique id of the core object
+ * @property-read int $packageID id of the package which delivers the core object
* @property-read string $objectName PHP class name of the core object
*/
class CoreObject extends DatabaseObject {}
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\Cronjob
*
- * @property-read integer $cronjobID unique id of the cronjob
+ * @property-read int $cronjobID unique id of the cronjob
* @property-read string $className PHP class name implementing `wcf\system\cronjob\ICronjob`
- * @property-read integer $packageID id of the package which delivers the cronjob or the id of the active application during creation in the ACP
+ * @property-read int $packageID id of the package which delivers the cronjob or the id of the active application during creation in the ACP
* @property-read string $cronjobName name and textual identifier of the cronjob
* @property-read string $description description of the cronjob or name of language item which contains the description
* @property-read string $startMinute minutes in the hour at which the cronjob is executed, wildcard `*` (any minute) or a rule using wildcard `*`
* @property-read string $startDom day of the month at which the cronjob is executed, wildcard `*` (any day) or a rule using wildcard `*`
* @property-read string $startMonth month in the year in which the cronjob is executed, wildcard `*` (any month) or a rule using wildcard `*`
* @property-read string $startDow day in the week at which the cronjob is executed, wildcard `*` (any day) or a rule using wildcard `*`
- * @property-read integer $lastExec timestamp at which the cronjob has been executed the last time
- * @property-read integer $nextExec timestamp at which the cronjob will be executed next
- * @property-read integer $afterNextExec timestamp at which the cronjob will be executed after next
- * @property-read integer $isDisabled is `1` if the cronjob is disabled and thus not executed, otherwise `0`
- * @property-read integer $canBeEdited is `1` if the cronjob can be edited in the ACP, otherwise `0`
- * @property-read integer $canBeDisabled is `1` if the cronjob can be disabled in the ACP so that it will not be executed, otherwise `0`
- * @property-read integer $state current state of the cronjob (see `Cronjob::READY`, `Cronjob::PENDING`, `Cronjob::EXECUTING` and `Cronjob::MAX_FAIL_COUNT`)
- * @property-read integer $failCount number of times the cronjob execution failed consecutively
+ * @property-read int $lastExec timestamp at which the cronjob has been executed the last time
+ * @property-read int $nextExec timestamp at which the cronjob will be executed next
+ * @property-read int $afterNextExec timestamp at which the cronjob will be executed after next
+ * @property-read int $isDisabled is `1` if the cronjob is disabled and thus not executed, otherwise `0`
+ * @property-read int $canBeEdited is `1` if the cronjob can be edited in the ACP, otherwise `0`
+ * @property-read int $canBeDisabled is `1` if the cronjob can be disabled in the ACP so that it will not be executed, otherwise `0`
+ * @property-read int $state current state of the cronjob (see `Cronjob::READY`, `Cronjob::PENDING`, `Cronjob::EXECUTING` and `Cronjob::MAX_FAIL_COUNT`)
+ * @property-read int $failCount number of times the cronjob execution failed consecutively
* @property-read string $options comma separated list of options of which at least one needs to be enabled for the cronjob to be executed
*/
class Cronjob extends DatabaseObject {
/**
* Returns timestamp of next execution.
*
- * @param integer $timeBase
- * @return integer
+ * @param int $timeBase
+ * @return int
*/
public function getNextExec($timeBase = null) {
if ($timeBase === null) {
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\Cronjob\Log
*
- * @property-read integer $cronjobLogID unique id of the cronjob execution log
- * @property-read integer $cronjobID id of the cronjob the log belongs to
- * @property-read integer $execTime timestamp at which the cronjob has been executed
- * @property-read integer $success is `1` if the cronjob has been successfully executed, otherwise `0`
+ * @property-read int $cronjobLogID unique id of the cronjob execution log
+ * @property-read int $cronjobID id of the cronjob the log belongs to
+ * @property-read int $execTime timestamp at which the cronjob has been executed
+ * @property-read int $success is `1` if the cronjob has been successfully executed, otherwise `0`
* @property-read string $error error message if the cronjob did not execute successfully, otherwise empty
*/
class CronjobLog extends DatabaseObject {
* @package WoltLabSuite\Core\Data\Custom\Option
* @since 3.1
*
- * @property-read integer $optionID unique id of the option
+ * @property-read int $optionID unique id of the option
* @property-read string $optionTitle title of the option or name of language item which contains the title
* @property-read string $optionDescription description of the option or name of language item which contains the description
* @property-read string $optionType type of the option which determines its input and output
* @property-read string $defaultValue default value of the option
* @property-read string $validationPattern regular expression used to validate the value of the option
* @property-read string $selectOptions possible values of the option separated by newlines
- * @property-read integer $required is `1` if the option has to be filled out, otherwise `0`
- * @property-read integer $showOrder position of the option in relation to the other options
- * @property-read integer $isDisabled is `1` if the option is disabled, otherwise `0`
- * @property-read integer $originIsSystem is `1` if the option has been delivered by a package, otherwise `0` (i.e. the option has been created in the ACP)
+ * @property-read int $required is `1` if the option has to be filled out, otherwise `0`
+ * @property-read int $showOrder position of the option in relation to the other options
+ * @property-read int $isDisabled is `1` if the option is disabled, otherwise `0`
+ * @property-read int $originIsSystem is `1` if the option has been delivered by a package, otherwise `0` (i.e. the option has been created in the ACP)
*/
abstract class CustomOption extends Option implements ITitledObject {
/**
* @package WoltLabSuite\Core\Devtools\Missing\Language\Item
* @since 5.3
*
- * @property-read integer $itemID unique id of the missing language item log entry
- * @property-read integer $languageID id of the language the missing language item was requested for
+ * @property-read int $itemID unique id of the missing language item log entry
+ * @property-read int $languageID id of the language the missing language item was requested for
* @property-read string $languageItem name of the missing language item
- * @property-read integer $lastTime timestamp of the last time the missing language item was requested
+ * @property-read int $lastTime timestamp of the last time the missing language item was requested
* @property-read string $stackTrace stack trace of how the missing language item was requested for the last time
*/
class DevtoolsMissingLanguageItem extends DatabaseObject {
* @package WoltLabSuite\Core\Devtools\Project
* @since 3.1
*
- * @property-read integer $projectID unique id of the project
+ * @property-read int $projectID unique id of the project
* @property-read string $name internal name for display inside the ACP
* @property-read string $path file system path
*/
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\Edit\History\Entry
*
- * @property-read integer $entryID unique id of the edit history entry
- * @property-read integer $objectTypeID id of the `com.woltlab.wcf.edit.historySavingObject` object type
- * @property-read integer $objectID id of the edited object of the object type with id `$objectTypeID`
- * @property-read integer|null $userID id of the user who has created the previous version of the object or `null` if the user does not exist anymore or if the previous version has been created by a guest
+ * @property-read int $entryID unique id of the edit history entry
+ * @property-read int $objectTypeID id of the `com.woltlab.wcf.edit.historySavingObject` object type
+ * @property-read int $objectID id of the edited object of the object type with id `$objectTypeID`
+ * @property-read int|null $userID id of the user who has created the previous version of the object or `null` if the user does not exist anymore or if the previous version has been created by a guest
* @property-read string $username name of the user who has created the previous version of the object
- * @property-read integer $time timestamp at which the original version has been created
- * @property-read integer $obsoletedAt timestamp at which the edited version has been created and time used for clean up
- * @property-read integer|null $obsoletedByUserID id of the user who has created this version of the object
+ * @property-read int $time timestamp at which the original version has been created
+ * @property-read int $obsoletedAt timestamp at which the edited version has been created and time used for clean up
+ * @property-read int|null $obsoletedByUserID id of the user who has created this version of the object
* @property-read string $message message of the edited object prior to the edit
* @property-read string $editReason reason for the edit
*/
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\Event\Listener
*
- * @property-read integer $listenerID unique id of the event listener
- * @property-read integer $packageID id of the package which delivers the event listener
+ * @property-read int $listenerID unique id of the event listener
+ * @property-read int $packageID id of the package which delivers the event listener
* @property-read string $environment environment in which the event listener is executed, possible values: 'all', 'user' or 'admin'
* @property-read string $listenerName name and textual identifier of the event listener
* @property-read string $eventClassName name of the class in which the listened event is fired
* @property-read string $eventName name of the listened event
* @property-read string $listenerClassName class name of the event listener class
- * @property-read integer $inherit is `1` if the event listener is also executed for classes inheriting from the listened class, otherwise `0`
- * @property-read integer $niceValue value from [-128, 127] used to determine event listener execution order (event listeners with smaller `$niceValue` are executed first)
+ * @property-read int $inherit is `1` if the event listener is also executed for classes inheriting from the listened class, otherwise `0`
+ * @property-read int $niceValue value from [-128, 127] used to determine event listener execution order (event listeners with smaller `$niceValue` are executed first)
* @property-read string $permissions comma separated list of user group permissions of which the active user needs to have at least one for the event listener to be executed
* @property-read string $options comma separated list of options of which at least one needs to be enabled for the event listener to be executed
*/
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\Label
*
- * @property-read integer $labelID unique id of the label
- * @property-read integer $groupID id of the label group the label belongs to
+ * @property-read int $labelID unique id of the label
+ * @property-read int $groupID id of the label group the label belongs to
* @property-read string $label label text or name of language item which contains the label text
* @property-read string $cssClassName css class name used when displaying the label
- * @property-read integer $showOrder position of the label in relation to the other labels in the label group
+ * @property-read int $showOrder position of the label in relation to the other labels in the label group
*/
class Label extends DatabaseObject implements IRouteController {
/**
/**
* Adds the label to a specific position in the label group.
*
- * @param integer $groupID
- * @param integer $showOrder
+ * @param int $groupID
+ * @param int $showOrder
*/
public function setShowOrder($groupID, $showOrder = 0) {
// shift back labels in old label group with higher showOrder
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\Label\Group
*
- * @property-read integer $groupID unique id of the label group
+ * @property-read int $groupID unique id of the label group
* @property-read string $groupName name of the label group or name of language item which contains the label text
* @property-read string $groupDescription description of the label group (only shown in ACP)
- * @property-read integer $forceSelection is `1` if a label in the label group has to be selected when creating an object for which the label group is available, otherwise `0`
- * @property-read integer $showOrder position of the label group in relation to the other label groups
+ * @property-read int $forceSelection is `1` if a label in the label group has to be selected when creating an object for which the label group is available, otherwise `0`
+ * @property-read int $showOrder position of the label group in relation to the other label groups
*/
class LabelGroup extends DatabaseObject implements IRouteController {
/**
*
* @param DatabaseObject $groupA
* @param DatabaseObject $groupB
- * @return integer
+ * @return int
*/
public static function sortLabelGroups(DatabaseObject $groupA, DatabaseObject $groupB) {
/** @noinspection PhpUndefinedFieldInspection */
/**
* list of permissions by type
- * @var integer[][]
+ * @var int[][]
*/
protected $permissions = [
'group' => [],
/**
* current iterator index
- * @var integer
+ * @var int
*/
protected $index = 0;
/**
* list of index to object relation
- * @var integer[]
+ * @var int[]
*/
protected $indexToObject = null;
/**
* Returns true, if label is known.
*
- * @param integer $labelID
+ * @param int $labelID
* @return boolean
*/
public function isValid($labelID) {
* Returns true, if the given user fulfils option id permissions.
* If the user parameter is null, the method checks the current user.
*
- * @param integer $optionID
+ * @param int $optionID
* @param User $user
* @return boolean
*/
/**
* Returns a list of label ids.
*
- * @return integer[]
+ * @return int[]
*/
public function getLabelIDs() {
return array_keys($this->labels);
/**
* Returns a label by id.
*
- * @param integer $labelID
+ * @param int $labelID
* @return Label|null
*/
public function getLabel($labelID) {
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\Language
*
- * @property-read integer $languageID unique id of the language
+ * @property-read int $languageID unique id of the language
* @property-read string $languageCode code of the language according to ISO 639-1
* @property-read string $languageName name of the language within the language itself
* @property-read string $countryCode code of the country using the language according to ISO 3166-1, used to determine the language's country flag
- * @property-read integer $isDefault is `1` if the language is the default language, otherwise `0`
- * @property-read integer $hasContent is `1` if the language can be selected when creating language-specific content, otherwise `0`
- * @property-read integer $isDisabled is `1` if the language is disabled and thus not selectable, otherwise `0`
+ * @property-read int $isDefault is `1` if the language is the default language, otherwise `0`
+ * @property-read int $hasContent is `1` if the language can be selected when creating language-specific content, otherwise `0`
+ * @property-read int $isDisabled is `1` if the language is disabled and thus not selectable, otherwise `0`
*/
class Language extends DatabaseObject {
/**
/**
* id of the active package
- * @var integer
+ * @var int
*/
public $packageID = PACKAGE_ID;
/**
* Write the languages files.
*
- * @param integer[] $languageCategoryIDs
+ * @param int[] $languageCategoryIDs
*/
protected function writeLanguageFiles(array $languageCategoryIDs) {
$conditions = new PreparedStatementConditionBuilder();
/**
* Exports this language.
*
- * @param integer[] $packageIDArray
+ * @param int[] $packageIDArray
* @param boolean $exportCustomValues
*/
public function export($packageIDArray = [], $exportCustomValues = false) {
* Updates the relevant language files automatically.
*
* @param XML $xml
- * @param integer $packageID
+ * @param int $packageID
* @param boolean $updateFiles
* @param boolean $updateExistingItems
* @throws \InvalidArgumentException if given XML file is invalid
* Updates the relevant language files automatically.
*
* @param XML $xml
- * @param integer $packageID
+ * @param int $packageID
* @param Language $source
* @return LanguageEditor
*/
*
* @param array $items
* @param LanguageCategory $category
- * @param integer $packageID
+ * @param int $packageID
* @param array $useCustom
*/
public function updateItems(array $items, LanguageCategory $category, $packageID = PACKAGE_ID, array $useCustom = []) {
/**
* Copies all cms contents (article, box, media, page) from given source language to language specified as $destinationLanguageID.
*
- * @param integer $sourceLanguageID
- * @param integer $destinationLanguageID
+ * @param int $sourceLanguageID
+ * @param int $destinationLanguageID
*/
public static function copyLanguageContent($sourceLanguageID, $destinationLanguageID) {
// article content
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\Language\Category
*
- * @property-read integer $languageCategoryID unique id of the language category
+ * @property-read int $languageCategoryID unique id of the language category
* @property-read string $languageCategory name and textual identifier of the language category
*/
class LanguageCategory extends DatabaseObject implements ITitledObject {
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\Language\Item
*
- * @property-read integer $languageItemID unique id of the language item
- * @property-read integer $languageID id of the language the language item belongs to
+ * @property-read int $languageItemID unique id of the language item
+ * @property-read int $languageID id of the language the language item belongs to
* @property-read string $languageItem name and textual identifier of the language item
* @property-read string $languageItemValue default value of the language item
* @property-read string $languageCustomItemValue custom value of the language item set by an admin
- * @property-read integer $languageUseCustomValue is `1` if the custom value is used instead of the default value, otherwise `0`
- * @property-read integer $languageItemOriginIsSystem is `1` if the language item has been delivered by a package, otherwise `0` (for example, if language item has been created for i18n content)
- * @property-read integer $languageCategoryID id of the language category the language item belongs to
- * @property-read integer|null $packageID id of the package the which delivers the language item or with which the language item is associated
+ * @property-read int $languageUseCustomValue is `1` if the custom value is used instead of the default value, otherwise `0`
+ * @property-read int $languageItemOriginIsSystem is `1` if the language item has been delivered by a package, otherwise `0` (for example, if language item has been created for i18n content)
+ * @property-read int $languageCategoryID id of the language category the language item belongs to
+ * @property-read int|null $packageID id of the package the which delivers the language item or with which the language item is associated
* @property-read string $languageItemOldValue previous default value of the language item
- * @property-read integer $languageCustomItemDisableTime the timestamp at which the custom version has been disabled due to a change to the original value
- * @property-read integer $isCustomLanguageItem is `1` if the language item has been added manually via the ACP
+ * @property-read int $languageCustomItemDisableTime the timestamp at which the custom version has been disabled due to a change to the original value
+ * @property-read int $isCustomLanguageItem is `1` if the language item has been added manually via the ACP
*/
class LanguageItem extends DatabaseObject {
/**
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\Like
*
- * @property-read integer $likeID unique id of the like
- * @property-read integer $objectID id of the liked object
- * @property-read integer $objectTypeID id of the `com.woltlab.wcf.like.likeableObject` object type
- * @property-read integer|null $objectUserID id of the user who created the liked object or null if user has been deleted or object was created by guest
- * @property-read integer $userID id of the user who created the like
- * @property-read integer $time timestamp at which the like has been created
- * @property-read integer $likeValue value of the like (`+1` = like, `-1` = dislike, see `Like::LIKE` and `Like::Dislike`)
- * @property-read integer $reactionTypeID reactionTypeID of the reaction
+ * @property-read int $likeID unique id of the like
+ * @property-read int $objectID id of the liked object
+ * @property-read int $objectTypeID id of the `com.woltlab.wcf.like.likeableObject` object type
+ * @property-read int|null $objectUserID id of the user who created the liked object or null if user has been deleted or object was created by guest
+ * @property-read int $userID id of the user who created the like
+ * @property-read int $time timestamp at which the like has been created
+ * @property-read int $likeValue value of the like (`+1` = like, `-1` = dislike, see `Like::LIKE` and `Like::Dislike`)
+ * @property-read int $reactionTypeID reactionTypeID of the reaction
*/
class Like extends DatabaseObject {
/**
* like value
- * @var integer
+ * @var int
*/
const LIKE = 1;
/**
* dislike value
- * @var integer
+ * @var int
*/
const DISLIKE = -1;
/**
* Returns the like with given type, object id and user id.
*
- * @param integer $objectTypeID
- * @param integer $objectID
- * @param integer $userID
+ * @param int $objectTypeID
+ * @param int $objectID
+ * @param int $userID
* @return Like
*/
public static function getLike($objectTypeID, $objectID, $userID) {
* Sets like/dislike for an object, executing this method again with the same parameters
* will revert the status (removing like/dislike).
*
- * @param integer $likeValue
+ * @param int $likeValue
* @return array
*/
protected function updateLike($likeValue) {
/**
* Returns timestamp of oldest like fetched.
*
- * @return integer
+ * @return int
*/
public function getLastLikeTime() {
$lastLikeTime = 0;
/**
* Returns the user id of the owner of this object.
*
- * @return integer
+ * @return int
*/
public function getUserID();
/**
* Updates the cumulative likes for this object.
*
- * @param integer $cumulativeLikes
+ * @param int $cumulativeLikes
*/
public function updateLikeCounter($cumulativeLikes);
/**
* Returns the language id of this object or its parent or `null` if no explicit language is set.
*
- * @return integer|null
+ * @return int|null
*/
public function getLanguageID();
}
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\Like\Object
*
- * @property-read integer $likeObjectID unique id of the liked object
- * @property-read integer $objectTypeID id of the `com.woltlab.wcf.like.likeableObject` object type
- * @property-read integer $objectID id of the liked object
- * @property-read integer|null $objectUserID id of the user who created the liked object or null if user has been deleted or object was created by guest
- * @property-read integer $likes number of likes of the liked object
- * @property-read integer $dislikes legacy column, not used anymore
- * @property-read integer $cumulativeLikes number of likes of the liked object
+ * @property-read int $likeObjectID unique id of the liked object
+ * @property-read int $objectTypeID id of the `com.woltlab.wcf.like.likeableObject` object type
+ * @property-read int $objectID id of the liked object
+ * @property-read int|null $objectUserID id of the user who created the liked object or null if user has been deleted or object was created by guest
+ * @property-read int $likes number of likes of the liked object
+ * @property-read int $dislikes legacy column, not used anymore
+ * @property-read int $cumulativeLikes number of likes of the liked object
* @property-read string $cachedUsers serialized array with the ids and names of the three users who liked (+1) the object last
* @property-read string $cachedReactions serialized array with the reactionTypeIDs and the count of the reactions
*/
/**
* A list with all reaction counts.
- * @var integer[]
+ * @var int[]
*/
protected $reactions = [];
/**
* The reputation for the current object.
- * @var integer
+ * @var int
*/
protected $reputation = null;
* Returns all reaction counts for this object. Reactions without any count won't be saved in the array.
* So this method returns an empty array, if this object has no reactions.
*
- * @return integer[]
+ * @return int[]
* @since 5.2
*/
public function getReactions() {
/**
* Returns the like object with the given type and object id.
*
- * @param integer $objectTypeID
- * @param integer $objectID
+ * @param int $objectTypeID
+ * @param int $objectID
* @return LikeObject
*/
public static function getLikeObject($objectTypeID, $objectID) {
* @package WoltLabSuite\Core\Data\Media
* @since 3.0
*
- * @property-read integer $mediaID unique id of the media file
- * @property-read integer $categoryID id of the category the media file belongs to or `null` if it belongs to no category
+ * @property-read int $mediaID unique id of the media file
+ * @property-read int $categoryID id of the category the media file belongs to or `null` if it belongs to no category
* @property-read string $filename name of the physical media file
- * @property-read integer $filesize size of the physical media file
+ * @property-read int $filesize size of the physical media file
* @property-read string $fileType type of the physical media file
* @property-read string $fileHash hash of the physical media file
- * @property-read integer $uploadTime timestamp at which the media file has been uploaded
+ * @property-read int $uploadTime timestamp at which the media file has been uploaded
* @property-read int $fileUpdateTime timestamp at which the media file was updated the last or `0` if it has not been updated
- * @property-read integer|null $userID id of the user who uploaded the media file or null if the user does not exist anymore
+ * @property-read int|null $userID id of the user who uploaded the media file or null if the user does not exist anymore
* @property-read string $username name of the user who uploaded the media file
- * @property-read integer|null $languageID id of the language associated with the media file or null if the media file is multilingual or if the language has been deleted
- * @property-read integer $isMultilingual is `1` if the media file's title, description and altText is available in multiple languages, otherwise `0`
- * @property-read integer $captionEnableHtml is `1` if html code in caption is supported, otherwise `0`
- * @property-read integer $isImage is `1` if the media file is an image, otherwise `0`
- * @property-read integer $width width of the media file if `$isImage` is `1`, otherwise `0`
- * @property-read integer $height height of the media file if `$isImage` is `1`, otherwise `0`
+ * @property-read int|null $languageID id of the language associated with the media file or null if the media file is multilingual or if the language has been deleted
+ * @property-read int $isMultilingual is `1` if the media file's title, description and altText is available in multiple languages, otherwise `0`
+ * @property-read int $captionEnableHtml is `1` if html code in caption is supported, otherwise `0`
+ * @property-read int $isImage is `1` if the media file is an image, otherwise `0`
+ * @property-read int $width width of the media file if `$isImage` is `1`, otherwise `0`
+ * @property-read int $height height of the media file if `$isImage` is `1`, otherwise `0`
* @property-read string $tinyThumbnailType type of the tiny thumbnail file for the media file if `$isImage` is `1`, otherwise empty
- * @property-read integer $tinyThumbnailSize size of the tiny thumbnail file for the media file if `$isImage` is `1`, otherwise `0`
- * @property-read integer $tinyThumbnailWidth width of the tiny thumbnail file for the media file if `$isImage` is `1`, otherwise `0`
- * @property-read integer $tinyThumbnailHeight height of the tiny thumbnail file for the media file if `$isImage` is `1`, otherwise `0`
+ * @property-read int $tinyThumbnailSize size of the tiny thumbnail file for the media file if `$isImage` is `1`, otherwise `0`
+ * @property-read int $tinyThumbnailWidth width of the tiny thumbnail file for the media file if `$isImage` is `1`, otherwise `0`
+ * @property-read int $tinyThumbnailHeight height of the tiny thumbnail file for the media file if `$isImage` is `1`, otherwise `0`
* @property-read string $smallThumbnailType type of the small thumbnail file for the media file if `$isImage` is `1`, otherwise empty
- * @property-read integer $smallThumbnailSize size of the small thumbnail file for the media file if `$isImage` is `1`, otherwise `0`
- * @property-read integer $smallThumbnailWidth width of the small thumbnail file for the media file if `$isImage` is `1`, otherwise `0`
- * @property-read integer $smallThumbnailHeight height of the small thumbnail file for the media file if `$isImage` is `1`, otherwise `0`
+ * @property-read int $smallThumbnailSize size of the small thumbnail file for the media file if `$isImage` is `1`, otherwise `0`
+ * @property-read int $smallThumbnailWidth width of the small thumbnail file for the media file if `$isImage` is `1`, otherwise `0`
+ * @property-read int $smallThumbnailHeight height of the small thumbnail file for the media file if `$isImage` is `1`, otherwise `0`
* @property-read string $mediumThumbnailType type of the medium thumbnail file for the media file if `$isImage` is `1`, otherwise empty
- * @property-read integer $mediumThumbnailSize size of the medium thumbnail file for the media file if `$isImage` is `1`, otherwise `0`
- * @property-read integer $mediumThumbnailWidth width of the medium thumbnail file for the media file if `$isImage` is `1`, otherwise `0`
- * @property-read integer $mediumThumbnailHeight height of the medium thumbnail file for the media file if `$isImage` is `1`, otherwise `0`
+ * @property-read int $mediumThumbnailSize size of the medium thumbnail file for the media file if `$isImage` is `1`, otherwise `0`
+ * @property-read int $mediumThumbnailWidth width of the medium thumbnail file for the media file if `$isImage` is `1`, otherwise `0`
+ * @property-read int $mediumThumbnailHeight height of the medium thumbnail file for the media file if `$isImage` is `1`, otherwise `0`
* @property-read string $largeThumbnailType type of the large thumbnail file for the media file if `$isImage` is `1`, otherwise empty
- * @property-read integer $largeThumbnailSize size of the large thumbnail file for the media file if `$isImage` is `1`, otherwise `0`
- * @property-read integer $largeThumbnailWidth width of the large thumbnail file for the media file if `$isImage` is `1`, otherwise `0`
- * @property-read integer $largeThumbnailHeight height of the large thumbnail file for the media file if `$isImage` is `1`, otherwise `0`
- * @property-read integer $downloads number of times the media file has been downloaded
- * @property-read integer $lastDownloadTime timestamp at which the media file has been downloaded the last time
+ * @property-read int $largeThumbnailSize size of the large thumbnail file for the media file if `$isImage` is `1`, otherwise `0`
+ * @property-read int $largeThumbnailWidth width of the large thumbnail file for the media file if `$isImage` is `1`, otherwise `0`
+ * @property-read int $largeThumbnailHeight height of the large thumbnail file for the media file if `$isImage` is `1`, otherwise `0`
+ * @property-read int $downloads number of times the media file has been downloaded
+ * @property-read int $lastDownloadTime timestamp at which the media file has been downloaded the last time
*/
class Media extends DatabaseObject implements ILinkableObject, IRouteController, IThumbnailFile {
/**
* Returns the width of the thumbnail file with the given size.
*
* @param string $size
- * @return integer
+ * @return int
* @throws \InvalidArgumentException
*/
public function getThumbnailWidth($size) {
* Returns the height of the thumbnail file with the given size.
*
* @param string $size
- * @return integer
+ * @return int
* @throws \InvalidArgumentException
*/
public function getThumbnailHeight($size) {
* Unmarks the media files with the given ids. If no media ids are given,
* all media files currently loaded are unmarked.
*
- * @param integer[] $mediaIDs ids of the media files to be unmarked
+ * @param int[] $mediaIDs ids of the media files to be unmarked
*/
protected function unmarkItems(array $mediaIDs = []) {
if (empty($mediaIDs)) {
class ViewableMedia extends DatabaseObjectDecorator {
/**
* force localized content by language id
- * @var integer
+ * @var int
*/
protected $forceLanguageID;
/**
* Registers localized content by language id.
*
- * @param integer $languageID
+ * @param int $languageID
* @param string[] $content
*/
public function setLocalizedContent($languageID, array $content) {
/**
* Returns an instance of this class with localized versions.
*
- * @param integer $languageID
+ * @param int $languageID
* @return ViewableMedia
*/
public function getLocalizedVersion($languageID) {
/**
* Forces the localized values by language id.
*
- * @param integer $languageID
+ * @param int $languageID
*/
protected function forceLanguageID($languageID) {
$this->forceLanguageID = $languageID;
/**
* Returns the viewable media file with the given id.
*
- * @param integer $mediaID
+ * @param int $mediaID
* @return ViewableMedia|null
*/
public static function getMedia($mediaID) {
* @package WoltLabSuite\Core\Data\Menu
* @since 3.0
*
- * @property-read integer $menuID unique id of the menu
+ * @property-read int $menuID unique id of the menu
* @property-read string $identifier textual identifier of the menu
* @property-read string $title title of the menu or name of language item which contains the title
- * @property-read integer $originIsSystem is `1` if the menu has been delivered by a package, otherwise `0` (if the menu has been created by an admin in the ACP)
- * @property-read integer $packageID id of the package the which delivers the menu or `1` if it has been created in the ACP
+ * @property-read int $originIsSystem is `1` if the menu has been delivered by a package, otherwise `0` (if the menu has been created by an admin in the ACP)
+ * @property-read int $packageID id of the package the which delivers the menu or `1` if it has been created in the ACP
*/
class Menu extends DatabaseObject implements ITitledObject {
/**
/**
* Returns a menu by id.
*
- * @param integer $menuID menu id
+ * @param int $menuID menu id
* @return Menu|null menu object or null if menu id is unknown
*/
public function getMenuByID($menuID) {
/**
* Returns a menu item list by menu id.
*
- * @param integer $menuID menu id
+ * @param int $menuID menu id
* @return MenuItemList|null menu item list object or null if menu id is unknown
*/
public function getMenuItemsByMenuID($menuID) {
/**
* Returns the id of the main menu.
*
- * @return integer
+ * @return int
*/
public function getMainMenuID() {
return MenuCacheBuilder::getInstance()->getData([], 'mainMenuID');
* @package WoltLabSuite\Core\Data\Menu\Item
* @since 3.0
*
- * @property-read integer $itemID unique id of the menu item
- * @property-read integer $menuID id of the menu the menu item belongs to
- * @property-read integer|null $parentItemID id of the menu item's parent menu item or null if it has no parent menu item
+ * @property-read int $itemID unique id of the menu item
+ * @property-read int $menuID id of the menu the menu item belongs to
+ * @property-read int|null $parentItemID id of the menu item's parent menu item or null if it has no parent menu item
* @property-read string $identifier textual identifier of the menu item
* @property-read string $title title of the menu item or name of language item which contains title
- * @property-read integer|null $pageID id of the linked `wcf\data\page\Page` object or null of no such page is linked
- * @property-read integer $pageObjectID id of the object required to show the page referenced by `$pageID`
+ * @property-read int|null $pageID id of the linked `wcf\data\page\Page` object or null of no such page is linked
+ * @property-read int $pageObjectID id of the object required to show the page referenced by `$pageID`
* @property-read string $externalURL external link of the menu item
- * @property-read integer $showOrder position of the menu item in relation to its siblings
- * @property-read integer $isDisabled is `1` if the menu item is disabled and thus not shown in the menu, otherwise `0`
- * @property-read integer $originIsSystem is `1` if the menu item has been delivered by a package, otherwise `0` (if the menu item has been created by an admin in the ACP)
- * @property-read integer $packageID id of the package the which delivers the menu item or `1` if it has been created in the ACP
+ * @property-read int $showOrder position of the menu item in relation to its siblings
+ * @property-read int $isDisabled is `1` if the menu item is disabled and thus not shown in the menu, otherwise `0`
+ * @property-read int $originIsSystem is `1` if the menu item has been delivered by a package, otherwise `0` (if the menu item has been created by an admin in the ACP)
+ * @property-read int $packageID id of the package the which delivers the menu item or `1` if it has been created in the ACP
*/
class MenuItem extends DatabaseObject implements ITitledObject {
/**
/**
* Returns the number of outstanding items for this menu.
*
- * @return integer
+ * @return int
*/
public function getOutstandingItems() {
if ($this->getMenuPageHandler() !== null) {
/**
* node depth
- * @var integer
+ * @var int
*/
protected $depth = 0;
/**
* iterator position
- * @var integer
+ * @var int
*/
private $position = 0;
*
* @param MenuItemNode $parentNode
* @param MenuItem $menuItem
- * @param integer $depth
+ * @param int $depth
*/
public function __construct($parentNode = null, MenuItem $menuItem = null, $depth = 0) {
if ($menuItem === null) {
/**
* Returns the number of children.
*
- * @return integer
+ * @return int
*/
public function count() {
return count($this->children);
/**
* Returns the number of open parent nodes.
*
- * @return integer
+ * @return int
*/
public function getOpenParentNodes() {
$element = $this;
/**
* Returns node depth.
*
- * @return integer
+ * @return int
*/
public function getDepth() {
return $this->depth;
/**
* menu id
- * @var integer
+ * @var int
*/
public $menuID;
/**
* number of visible items
- * @var integer
+ * @var int
*/
protected $visibleItemCount = 0;
/**
* Creates a new MenuItemNodeTree object.
*
- * @param integer $menuID menu id
+ * @param int $menuID menu id
* @param MenuItemList $menuItemList optional object to be provided when building the tree from cache
* @param boolean $checkVisibility if `false`, individual menu item visibility will not be checked
*/
/**
* Generates the node tree recursively.
*
- * @param integer $parentID parent menu item id
+ * @param int $parentID parent menu item id
* @param MenuItemNode $parentNode parent menu item object
* @return MenuItemNode[] nested menu item tree
*/
/**
* Returns the number of visible items.
*
- * @return integer
+ * @return int
*/
public function getVisibleItemCount() {
return $this->visibleItemCount;
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\Moderation\Queue
*
- * @property-read integer $queueID unique id of the moderation queue entry
- * @property-read integer $objectTypeID id of the `com.woltlab.wcf.moderation.type` object type
- * @property-read integer $objectID id of the object of the object type with id `$objectTypeID` to which the moderation queue entry belongs to
- * @property-read integer $containerID id of the object's container object to which the modification log entry belongs to or `0` if no such container object exists or is logged
- * @property-read integer|null $userID id of the user who created the moderation queue entry or `null` if the user does not exist anymore or if the moderation queue entry has been created by a guest
- * @property-read integer $time timestamp at which the moderation queue entry has been created
- * @property-read integer|null $assignedUserID id of the user to which the moderation queue entry is assigned or `null` if it is not assigned to any user
- * @property-read integer $status status of the moderation queue entry (see `ModerationQueue::STATUS_*` constants)
- * @property-read integer $comments number of comments on the moderation queue entry
- * @property-read integer $lastChangeTime timestamp at which the moderation queue entry has been changed the last time
+ * @property-read int $queueID unique id of the moderation queue entry
+ * @property-read int $objectTypeID id of the `com.woltlab.wcf.moderation.type` object type
+ * @property-read int $objectID id of the object of the object type with id `$objectTypeID` to which the moderation queue entry belongs to
+ * @property-read int $containerID id of the object's container object to which the modification log entry belongs to or `0` if no such container object exists or is logged
+ * @property-read int|null $userID id of the user who created the moderation queue entry or `null` if the user does not exist anymore or if the moderation queue entry has been created by a guest
+ * @property-read int $time timestamp at which the moderation queue entry has been created
+ * @property-read int|null $assignedUserID id of the user to which the moderation queue entry is assigned or `null` if it is not assigned to any user
+ * @property-read int $status status of the moderation queue entry (see `ModerationQueue::STATUS_*` constants)
+ * @property-read int $comments number of comments on the moderation queue entry
+ * @property-read int $lastChangeTime timestamp at which the moderation queue entry has been changed the last time
* @property-read array $additionalData array with additional data of the moderation queue entry
* @property-read boolean $markAsJustified true if the report was closed, but it was actually justified and other actions may have been taken
*/
/**
* Returns status text.
*
- * @param integer $status
+ * @param int $status
* @return string
*/
public function getStatus($status = null) {
/**
* Returns a viewable moderation queue entry.
*
- * @param integer $queueID
+ * @param int $queueID
* @return ViewableModerationQueue
*/
public static function getViewableModerationQueue($queueID) {
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\Modification\Log
*
- * @property-read integer $logID unique id of the modification log entry
- * @property-read integer $objectTypeID id of the `com.woltlab.wcf.modifiableContent` object type
- * @property-read integer $objectID id of the object of the object type with id `$objectTypeID` to which the modification log entry belongs to
- * @property-read integer|null $parentObjectID id of the object's parent object to which the modification log entry belongs to or `null` if no such parent object exists or is logged
- * @property-read integer|null $userID id of the user who caused the modification log entry or `null` if the user does not exist anymore or if the modification log entry has been caused by a guest
+ * @property-read int $logID unique id of the modification log entry
+ * @property-read int $objectTypeID id of the `com.woltlab.wcf.modifiableContent` object type
+ * @property-read int $objectID id of the object of the object type with id `$objectTypeID` to which the modification log entry belongs to
+ * @property-read int|null $parentObjectID id of the object's parent object to which the modification log entry belongs to or `null` if no such parent object exists or is logged
+ * @property-read int|null $userID id of the user who caused the modification log entry or `null` if the user does not exist anymore or if the modification log entry has been caused by a guest
* @property-read string $username name of the user or guest who caused the modification log entry
- * @property-read integer $time timestamp at which the modification log entry has been created
+ * @property-read int $time timestamp at which the modification log entry has been created
* @property-read string $action name of the modification action that is logged
* @property-read array $additionalData array with additional data of the modification log entry
*/
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\Notice
*
- * @property-read integer $noticeID unique id of the notice
+ * @property-read int $noticeID unique id of the notice
* @property-read string $noticeName name of the notice shown in ACP
* @property-read string $notice text of the notice or name of language item which contains the text
- * @property-read integer $noticeUseHtml is `1` if the notice text will be rendered as HTML, otherwise `0`
+ * @property-read int $noticeUseHtml is `1` if the notice text will be rendered as HTML, otherwise `0`
* @property-read string $cssClassName css class name(s) used for the notice HTML element
- * @property-read integer $showOrder position of the notice in relation to the other notices
- * @property-read integer $isDisabled is `1` if the notice is disabled and thus not shown, otherwise `0`
- * @property-read integer $isDismissible is `1` if the notice can be dismissed by users, otherwise `0`
+ * @property-read int $showOrder position of the notice in relation to the other notices
+ * @property-read int $isDisabled is `1` if the notice is disabled and thus not shown, otherwise `0`
+ * @property-read int $isDismissible is `1` if the notice can be dismissed by users, otherwise `0`
*/
class Notice extends DatabaseObject implements IRouteController {
/**
/**
* Dismisses a certain notice.
*
- * @return integer[]
+ * @return int[]
*/
public function dismiss() {
if (WCF::getUser()->userID) {
/**
* Sets the show order of the notice.
*
- * @param integer $showOrder
+ * @param int $showOrder
*/
public function setShowOrder($showOrder = 0) {
$sql = "SELECT MAX(showOrder)
/**
* Returns an object by its ID.
*
- * @param integer $objectID
+ * @param int $objectID
* @return DatabaseObject
*/
public function getObjectByID($objectID);
/**
* Returns objects by their IDs.
*
- * @param integer[] $objectIDs
+ * @param int[] $objectIDs
* @return DatabaseObject[]
*/
public function getObjectsByIDs(array $objectIDs);
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\Object\Type
*
- * @property-read integer $objectTypeID unique id of the object type
- * @property-read integer $definitionID id of the object type definition the object type belongs to
- * @property-read integer $packageID id of the package the which delivers the object type
+ * @property-read int $objectTypeID unique id of the object type
+ * @property-read int $definitionID id of the object type definition the object type belongs to
+ * @property-read int $packageID id of the package the which delivers the object type
* @property-read string $objectType textual identifier of the object type
* @property-read string $className PHP class name of the object type processor (implementing the interface forced by the object type definition)
* @property-read array $additionalData array with additional data of the object type
/**
* object type definition ids grouped by category name
- * @var integer[][]
+ * @var int[][]
*/
protected $definitionsByCategory = [];
* Returns the object type definition with the given id or null if no such
* object type definition exists.
*
- * @param integer $definitionID
+ * @param int $definitionID
* @return ObjectTypeDefinition
*/
public function getDefinition($definitionID) {
* Returns the object type with the given id or null if no such object type
* exists.
*
- * @param integer $objectTypeID
+ * @param int $objectTypeID
* @return ObjectType
*/
public function getObjectType($objectTypeID) {
*
* @param string $definitionName
* @param string $objectTypeName
- * @return integer
+ * @return int
*/
public function getObjectTypeIDByName($definitionName, $objectTypeName) {
$objectType = $this->getObjectTypeByName($definitionName, $objectTypeName);
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\Object\Type\Definition
*
- * @property-read integer $definitionID unique id of the object type definition
+ * @property-read int $definitionID unique id of the object type definition
* @property-read string $definitionName textual identifier of the object type definition
- * @property-read integer $packageID id of the package the which delivers the object type definition
+ * @property-read int $packageID id of the package the which delivers the object type definition
* @property-read string $interfaceName PHP interface name the PHP classes of the object types' processors need to implement
* @property-read string $categoryName
*/
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\Option
*
- * @property-read integer $optionID unique id of the option
- * @property-read integer $packageID id of the package the which delivers the option
+ * @property-read int $optionID unique id of the option
+ * @property-read int $packageID id of the package the which delivers the option
* @property-read string $optionName name and textual identifier of the option
* @property-read string $categoryName name of the option category the option belongs to
* @property-read string $optionType textual identifier of the option (corresponds to a class implementing `wcf\system\option\IOptionType`)
* @property-read string $validationPattern regular expression used to validate the option's value or empty if no such regular expression exists
* @property-read string $selectOptions newline-separated list of selectable options for a selectable option type (line pattern: `{value}:{language item name}`)
* @property-read string $enableOptions list of options that are enabled based on the option's value (simple comma-separated list of boolean options, otherwise newline-separated list with line pattern: `{select value}:{comma-separated list}`)
- * @property-read integer $showOrder position of the option in relation to the other option in the option category
- * @property-read integer $hidden is `1` if the option is hidden and thus cannot be explicitly set by in the acp, otherwise `0`
+ * @property-read int $showOrder position of the option in relation to the other option in the option category
+ * @property-read int $hidden is `1` if the option is hidden and thus cannot be explicitly set by in the acp, otherwise `0`
* @property-read string $permissions comma separated list of user group permissions of which the active user needs to have at least one to set the option value
* @property-read string $options comma separated list of options of which at least one needs to be enabled for the option to be editable
- * @property-read integer $supportI18n is `1` if the option supports different values for all available languages, otherwise `0`
- * @property-read integer $requireI18n is `1` if `$supportI18n = 1` and the option's value has to explicitly set for all values so that the `monolingual` option is not available, otherwise `0`
+ * @property-read int $supportI18n is `1` if the option supports different values for all available languages, otherwise `0`
+ * @property-read int $requireI18n is `1` if `$supportI18n = 1` and the option's value has to explicitly set for all values so that the `monolingual` option is not available, otherwise `0`
* @property-read array $additionalData array with additional data of the option
*/
class Option extends DatabaseObject {
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\Option\Category
*
- * @property-read integer $categoryID unique id of the option category
- * @property-read integer $packageID id of the package the which delivers the option category
+ * @property-read int $categoryID unique id of the option category
+ * @property-read int $packageID id of the package the which delivers the option category
* @property-read string $categoryName name and textual identifier of the option category
* @property-read string $parentCategoryName name of the option category's parent category or empty if the option category has no parent category
- * @property-read integer $showOrder position of the option category in relation its siblings
+ * @property-read int $showOrder position of the option category in relation its siblings
* @property-read string $permissions comma separated list of user group permissions of which the active user needs to have at least one to see the option category
* @property-read string $options comma separated list of options of which at least one needs to be enabled for the option category to be shown
*/
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\Package
*
- * @property-read integer $packageID unique id of the package
+ * @property-read int $packageID unique id of the package
* @property-read string $package unique textual identifier of the package
* @property-read string $packageDir relative directory to Core in which the application is installed or empty if package is no application or Core
* @property-read string $packageName name of the package or name of language item which contains the name
* @property-read string $packageDescription description of the package or name of language item which contains the description
* @property-read string $packageVersion installed version of package
- * @property-read integer $packageDate timestamp at which the installed package version has been released
- * @property-read integer $installDate timestamp at which the package has been installed
- * @property-read integer $updateDate timestamp at which the package has been updated or installed if it has not been updated yet
+ * @property-read int $packageDate timestamp at which the installed package version has been released
+ * @property-read int $installDate timestamp at which the package has been installed
+ * @property-read int $updateDate timestamp at which the package has been updated or installed if it has not been updated yet
* @property-read string $packageURL external url to website with more information about the package
- * @property-read integer $isApplication is `1` if the package delivers an application, otherwise `0`
+ * @property-read int $isApplication is `1` if the package delivers an application, otherwise `0`
* @property-read string $author author of the package
* @property-read string $authorURL external url to the website of the package author
*/
/**
* list of ids of packages which are required by another package
- * @var integer[]
+ * @var int[]
*/
protected static $requiredPackageIDs = null;
/**
* Writes the config.inc.php for an application.
*
- * @param integer $packageID
+ * @param int $packageID
*/
public static function writeConfigFile($packageID) {
$package = new Package($packageID);
/**
* Returns a specific package.
*
- * @param integer $packageID
+ * @param int $packageID
* @return Package
*/
public function getPackage($packageID) {
* @package WoltLabSuite\Core\Data\Package\Installation\Plugin
*
* @property-read string $pluginName unique name and textual identifier of the package installation plugin
- * @property-read integer|null $packageID id of the package the which delivers the package installation plugin
- * @property-read integer $priority priority in which the package installation plugins are installed, `1` for Core package installation plugins (executed first) and `0` for other package installation plugins
+ * @property-read int|null $packageID id of the package the which delivers the package installation plugin
+ * @property-read int $priority priority in which the package installation plugins are installed, `1` for Core package installation plugins (executed first) and `0` for other package installation plugins
* @property-read string $className name of the PHP class implementing `wcf\system\package\plugin\IPackageInstallationPlugin` handling installing and uninstalling handled data
*/
class PackageInstallationPlugin extends DatabaseObject {
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\Package\Installation\Queue
*
- * @property-read integer $queueID unique id of the package installation queue entry
- * @property-read integer $parentQueueID id of the package installation queue entry's parent entry or `0` if it has no parent entry
- * @property-read integer $processNo numerical identifier of a group of dependent package installation queue entries, i.e. a parent entry and all of its children
- * @property-read integer $userID id of the user who started the package installation, update or uninstallation
+ * @property-read int $queueID unique id of the package installation queue entry
+ * @property-read int $parentQueueID id of the package installation queue entry's parent entry or `0` if it has no parent entry
+ * @property-read int $processNo numerical identifier of a group of dependent package installation queue entries, i.e. a parent entry and all of its children
+ * @property-read int $userID id of the user who started the package installation, update or uninstallation
* @property-read string $package identifier of the relevant package
* @property-read string $packageName name of the relevant package
- * @property-read integer|null $packageID id of relevant package
+ * @property-read int|null $packageID id of relevant package
* @property-read string $archive location of the package file for `$action = install` or `$action = update`, otherwise empty
* @property-read string $action action the package installation queue entry belongs to (`install`, `update`, `uninstall`)
- * @property-read integer $done is `1` if the package installation queue entry has been completed, otherwise `0`
- * @property-read integer $isApplication is `1` if the package installation queue entry belongs to an application, otherwise `0`
+ * @property-read int $done is `1` if the package installation queue entry has been completed, otherwise `0`
+ * @property-read int $isApplication is `1` if the package installation queue entry belongs to an application, otherwise `0`
*/
class PackageInstallationQueue extends DatabaseObject {
/**
* Returns a new process number for package installation queue.
*
- * @return integer
+ * @return int
*/
public static function getNewProcessNo() {
$sql = "SELECT MAX(processNo) AS processNo
/**
* Prepares a new package installation queue.
*
- * @return integer[]
+ * @return int[]
*/
public function prepareQueue() {
$processNo = PackageInstallationQueue::getNewProcessNo();
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\Package\Update
*
- * @property-read integer $packageUpdateID unique id of the package update
- * @property-read integer $packageUpdateServerID id of the package update server the package update is located on
+ * @property-read int $packageUpdateID unique id of the package update
+ * @property-read int $packageUpdateServerID id of the package update server the package update is located on
* @property-read string $package identifier of the package
* @property-read string $packageName name of the package
* @property-read string $packageDescription description of the package
* @property-read string $author author of the package
* @property-read string $authorURL external url to the website of the package author
- * @property-read integer $isApplication is `1` if the package update belongs to an application, otherwise `0`
- * @property-read integer $pluginStoreFileID file id for related package on pluginstore.woltlab.com, otherwise `0`
+ * @property-read int $isApplication is `1` if the package update belongs to an application, otherwise `0`
+ * @property-read int $pluginStoreFileID file id for related package on pluginstore.woltlab.com, otherwise `0`
*/
class PackageUpdate extends DatabaseObject {
/**
* Validates dependencies and exclusions of a package,
* optionally limited by a minimum version number.
*
- * @param integer $packageUpdateID
+ * @param int $packageUpdateID
* @param string|null $minVersion
* @param string[] $installedPackages
* @param string[] $excludedPackagesOfInstalledPackages
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\Package\Update\Server
*
- * @property-read integer $packageUpdateServerID unique id of the package update server
+ * @property-read int $packageUpdateServerID unique id of the package update server
* @property-read string $serverURL url of the package update server
* @property-read string $loginUsername username used to login on the package update server
* @property-read string $loginPassword password used to login on the package update server
- * @property-read integer $isDisabled is `1` if the package update server is disabled and thus not considered for package updates, otherwise `0`
- * @property-read integer $lastUpdateTime timestamp at which the data of the package update server has been fetched the last time
+ * @property-read int $isDisabled is `1` if the package update server is disabled and thus not considered for package updates, otherwise `0`
+ * @property-read int $lastUpdateTime timestamp at which the data of the package update server has been fetched the last time
* @property-read string $status status of the package update server (`online` or `offline`)
* @property-read string $errorMessage error message if the package update server if offline or empty otherwise
* @property-read string $apiVersion version of the supported package update server api (`2.0`, `2.1`)
/**
* Returns all active update package servers sorted by hostname.
*
- * @param integer[] $packageUpdateServerIDs
+ * @param int[] $packageUpdateServerIDs
* @return PackageUpdateServer[]
*/
public static final function getActiveUpdateServers(array $packageUpdateServerIDs = []) {
/**
* Stores auth data for a package update server.
*
- * @param integer $packageUpdateServerID
+ * @param int $packageUpdateServerID
* @param string $username
* @param string $password
* @param boolean $saveCredentials
/**
* Returns true if update server requires license data instead of username/password.
*
- * @return integer
+ * @return int
*/
public final function requiresLicense() {
return Regex::compile('^https?://update.woltlab.com/')->match($this->serverURL);
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\Package\Update\Version
*
- * @property-read integer $packageUpdateVersionID unique id of the package update version
- * @property-read integer $packageUpdateID id of the package update the package update version belongs to
+ * @property-read int $packageUpdateVersionID unique id of the package update version
+ * @property-read int $packageUpdateID id of the package update the package update version belongs to
* @property-read string $packageVersion version number of the package update version
- * @property-read integer $packageDate date of the package update version
+ * @property-read int $packageDate date of the package update version
* @property-read string $filename location of the package update version file or empty if no file is given
* @property-read string $license name of the license of the package update version or empty if no license is given
* @property-read string $licenseURL link to the license of the package update version or empty if no license or license link is given
- * @property-read integer $isAccessible is `1` if the package update version is accessible and thus can be installed, otherwise `0`
+ * @property-read int $isAccessible is `1` if the package update version is accessible and thus can be installed, otherwise `0`
*/
class PackageUpdateVersion extends DatabaseObject {
/**
* @package WoltLabSuite\Core\Data\Page
* @since 3.0
*
- * @property-read integer $pageID unique id of the page
- * @property-read integer|null $parentPageID id of the page's parent page or `null` if it has no parent page
+ * @property-read int $pageID unique id of the page
+ * @property-read int|null $parentPageID id of the page's parent page or `null` if it has no parent page
* @property-read string $identifier unique textual identifier of the page
* @property-read string $name monolingual name of the page shown in the ACP
* @property-read string $pageType type of the page, default types: `text`, `html`, `tpl` `system`
- * @property-read integer $isDisabled is `1` if the page is disabled and thus cannot be accessed, otherwise `0`
- * @property-read integer $isLandingPage is `1` if the page is the landing page, otherwise `0`
- * @property-read integer $isMultilingual is `1` if the page is available in different languages, otherwise `0`
- * @property-read integer $originIsSystem is `1` if the page has been delivered by a package, otherwise `0` (i.e. the page has been created in the ACP)
- * @property-read integer $packageID id of the package the which delivers the page or `1` if it has been created in the ACP
- * @property-read integer $applicationPackageID id of the package of the application the pages belongs to
- * @property-read integer $overrideApplicationPackageID id of the package of the application that the page virtually belongs to
+ * @property-read int $isDisabled is `1` if the page is disabled and thus cannot be accessed, otherwise `0`
+ * @property-read int $isLandingPage is `1` if the page is the landing page, otherwise `0`
+ * @property-read int $isMultilingual is `1` if the page is available in different languages, otherwise `0`
+ * @property-read int $originIsSystem is `1` if the page has been delivered by a package, otherwise `0` (i.e. the page has been created in the ACP)
+ * @property-read int $packageID id of the package the which delivers the page or `1` if it has been created in the ACP
+ * @property-read int $applicationPackageID id of the package of the application the pages belongs to
+ * @property-read int $overrideApplicationPackageID id of the package of the application that the page virtually belongs to
* @property-read string $controller name of the page controller class
* @property-read string $handler name of the page handler class for `system` pages or empty
* @property-read string $controllerCustomURL custom url of the page
- * @property-read integer $requireObjectID is `1` if the page requires an object id parameter, otherwise `0`
- * @property-read integer $hasFixedParent is `1` if the page's parent page cannot be changed, otherwise `0`
- * @property-read integer $lastUpdateTime timestamp at which the page has been updated the last time
+ * @property-read int $requireObjectID is `1` if the page requires an object id parameter, otherwise `0`
+ * @property-read int $hasFixedParent is `1` if the page's parent page cannot be changed, otherwise `0`
+ * @property-read int $lastUpdateTime timestamp at which the page has been updated the last time
* @property-read string $cssClassName css class name(s) of the page
* @property-read string $availableDuringOfflineMode is `1` if the page is available during offline mode, otherwise `0`
* @property-read string $allowSpidersToIndex is `1` if the page is accessible for search spiders, otherwise `0`
/**
* box to page assignments
- * @var integer[]
+ * @var int[]
*/
protected $boxIDs;
* Returns content for a single language, passing `null` for `$languageID` is undefined
* for multilingual pages.
*
- * @param integer $languageID language id or `null` if there are no localized versions
+ * @param int $languageID language id or `null` if there are no localized versions
* @return PageContent|null page content data
*/
public function getPageContentByLanguage($languageID = null) {
/**
* Returns box to page assignments.
*
- * @return integer[]
+ * @return int[]
*/
public function getBoxIDs() {
if ($this->boxIDs === null) {
/**
* Returns the template name of this page.
*
- * @param integer $languageID
+ * @param int $languageID
* @return string
*/
public function getTplName($languageID = null) {
/**
* Returns a page by page id or null.
*
- * @param integer $pageID page id
+ * @param int $pageID page id
* @return Page|null
*/
public function getPage($pageID) {
* Returns the localized page title by page id, optionally retrieving the title
* for given language id if it is a multilingual page.
*
- * @param integer $pageID page id
- * @param integer $languageID specific value by language id
+ * @param int $pageID page id
+ * @param int $languageID specific value by language id
* @return string localized page title
*/
public function getPageTitle($pageID, $languageID = null) {
/**
* Creates or updates the page's template file.
*
- * @param integer $languageID language id or `null`
+ * @param int $languageID language id or `null`
* @param string $content template content
*/
public function updateTemplate($languageID, $content) {
* Returns true if given custom url is unique.
*
* @param string $customURL
- * @param integer $packageID
+ * @param int $packageID
*
* @return boolean
*/
class PageLanguage {
/**
* language id
- * @var integer
+ * @var int
*/
protected $languageID;
/**
* page id
- * @var integer
+ * @var int
*/
protected $pageID;
/**
* Creates a new PageLanguage object.
*
- * @param integer $pageID
- * @param integer $languageID
+ * @param int $pageID
+ * @param int $languageID
*/
public function __construct($pageID, $languageID) {
$this->pageID = $pageID;
/**
* node depth
- * @var integer
+ * @var int
*/
protected $depth = 0;
/**
* iterator position
- * @var integer
+ * @var int
*/
private $position = 0;
*
* @param PageNode $parentNode
* @param Page $page
- * @param integer $depth
+ * @param int $depth
*/
public function __construct($parentNode = null, Page $page = null, $depth = 0) {
if ($page === null) {
/**
* Returns the number of children.
*
- * @return integer
+ * @return int
*/
public function count() {
return count($this->children);
/**
* Returns node depth.
*
- * @return integer
+ * @return int
*/
public function getDepth() {
return $this->depth;
class PageNodeTree {
/**
* parent page id
- * @var integer
+ * @var int
*/
public $parentID = null;
/**
* start depth
- * @var integer
+ * @var int
*/
public $startDepth = 0;
/**
* Creates a new PageNodeTree object.
*
- * @param integer $parentID
- * @param integer $startDepth
+ * @param int $parentID
+ * @param int $startDepth
*/
public function __construct($parentID = null, $startDepth = 0) {
$this->parentID = $parentID;
/**
* Generates the node tree recursively.
*
- * @param integer $parentID
+ * @param int $parentID
* @param PageNode $parentNode
* @return PageNode[]
*/
* @package WoltLabSuite\Core\Data\Page\Content
* @since 3.0
*
- * @property-read integer $pageContentID unique id of the page content
- * @property-read integer $pageID id of the page the page content belongs to
- * @property-read integer $languageID id of the page content's language
+ * @property-read int $pageContentID unique id of the page content
+ * @property-read int $pageID id of the page the page content belongs to
+ * @property-read int $languageID id of the page content's language
* @property-read string $title title of the page in the associated language
* @property-read string $content actual content of the page in the associated language
* @property-read string $metaDescription meta description of the page in the associated language
* @property-read string $customURL custom url of the page in the associated language
- * @property-read integer $hasEmbeddedObjects is `1` if the page content contains embedded objects, otherwise `0`
+ * @property-read int $hasEmbeddedObjects is `1` if the page content contains embedded objects, otherwise `0`
*/
class PageContent extends DatabaseObject implements ILinkableObject {
/**
/**
* Returns a certain page content.
*
- * @param integer $pageID
- * @param integer $languageID
+ * @param int $pageID
+ * @param int $languageID
* @return PageContent|null
*/
public static function getPageContent($pageID, $languageID) {
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\Paid\Subscription
*
- * @property-read integer $subscriptionID unique id of the paid subscription
+ * @property-read int $subscriptionID unique id of the paid subscription
* @property-read string $title title of the paid subscription or name of language item which contains the title
* @property-read string $description description of the paid subscription or name of language item which contains the description
- * @property-read integer $isDisabled is `1` if the paid subscription is disabled and thus cannot be bought, otherwise `0`
- * @property-read integer $showOrder position of the paid subscription in relation to the other paid subscriptions
+ * @property-read int $isDisabled is `1` if the paid subscription is disabled and thus cannot be bought, otherwise `0`
+ * @property-read int $showOrder position of the paid subscription in relation to the other paid subscriptions
* @property-read double $cost cost of the paid subscription
* @property-read string $currency identifier for the currency of the paid subscription cost
- * @property-read integer $subscriptionLength magnitude part of the duration of the subscription or `0` if the subscription is permanent
+ * @property-read int $subscriptionLength magnitude part of the duration of the subscription or `0` if the subscription is permanent
* @property-read string $subscriptionLengthUnit unit part of the duration of the subscription (`D` for days, `M` for months, `Y` for years) or empty if the subscription is permanent
- * @property-read integer $isRecurring is `1` if the paid subscription is recurring and thus requires regular (automatic) payments, otherwise `0`
+ * @property-read int $isRecurring is `1` if the paid subscription is recurring and thus requires regular (automatic) payments, otherwise `0`
* @property-read string $groupIDs comma-separated list with the ids of the user groups for which the subscription pays membership
* @property-read string $excludedSubscriptionIDs comma-separated list with the ids of paid subscriptions which prohibit purchase of this paid subscription
*/
/**
* Sets the show order of the subscription.
*
- * @param integer $showOrder
+ * @param int $showOrder
*/
public function setShowOrder($showOrder = 0) {
$sql = "SELECT MAX(showOrder)
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\Paid\Subscription\Transaction\Log
*
- * @property-read integer $logID unique id of the paid subscription transaction log entry
- * @property-read integer|null $subscriptionUserID id of the paid subscription-user-association or `null` if no such association exists
- * @property-read integer|null $userID id of the user who caused the paid subscription transaction log entry or `null` if the user does not exist anymore
- * @property-read integer $subscriptionID id of the paid subscription
- * @property-read integer $paymentMethodObjectTypeID id of the `com.woltlab.wcf.payment.method` object type
- * @property-read integer $logTime timestamp at which the log has been created
+ * @property-read int $logID unique id of the paid subscription transaction log entry
+ * @property-read int|null $subscriptionUserID id of the paid subscription-user-association or `null` if no such association exists
+ * @property-read int|null $userID id of the user who caused the paid subscription transaction log entry or `null` if the user does not exist anymore
+ * @property-read int $subscriptionID id of the paid subscription
+ * @property-read int $paymentMethodObjectTypeID id of the `com.woltlab.wcf.payment.method` object type
+ * @property-read int $logTime timestamp at which the log has been created
* @property-read string $transactionID identifier of the paid subscription transaction
* @property-read string $transactionDetails serialized details of the paid subscription transaction
* @property-read string $logMessage log message describing the status of the paid subscription transaction
/**
* Returns the transaction log entry by transaction id or `null` if no such entry exists.
*
- * @param integer $paymentMethodObjectTypeID
+ * @param int $paymentMethodObjectTypeID
* @param string $transactionID
* @return PaidSubscriptionTransactionLog|null
*/
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\Paid\Subscription\User
*
- * @property-read integer $subscriptionUserID unique id of the paid subscription-user-association
- * @property-read integer $subscriptionID id of the paid subscription the paid subscription-user-association belongs to
- * @property-read integer $userID id of the user the paid subscription-user-association belongs to
- * @property-read integer $startDate timestamp at which the paid subscription started
- * @property-read integer $endDate timestamp at which the paid subscription ended or will end
- * @property-read integer $isActive is `1` if the user's paid subscription is currently active and thus not expired, otherwise `0`
- * @property-read integer $sentExpirationNotification is `1` if the user has been notified that the paid subscription is expiring
+ * @property-read int $subscriptionUserID unique id of the paid subscription-user-association
+ * @property-read int $subscriptionID id of the paid subscription the paid subscription-user-association belongs to
+ * @property-read int $userID id of the user the paid subscription-user-association belongs to
+ * @property-read int $startDate timestamp at which the paid subscription started
+ * @property-read int $endDate timestamp at which the paid subscription ended or will end
+ * @property-read int $isActive is `1` if the user's paid subscription is currently active and thus not expired, otherwise `0`
+ * @property-read int $sentExpirationNotification is `1` if the user has been notified that the paid subscription is expiring
*/
class PaidSubscriptionUser extends DatabaseObject {
/**
/**
* Returns a specific subscription user or `null` if such a user does not exist.
*
- * @param integer $subscriptionID
- * @param integer $userID
+ * @param int $subscriptionID
+ * @param int $userID
* @return PaidSubscriptionUser|null
*/
public static function getSubscriptionUser($subscriptionID, $userID) {
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\Poll
*
- * @property-read integer $pollID unique id of the poll
- * @property-read integer $objectTypeID id of the `com.woltlab.wcf.poll` object type
- * @property-read integer $objectID id of the poll container object the poll belongs to
+ * @property-read int $pollID unique id of the poll
+ * @property-read int $objectTypeID id of the `com.woltlab.wcf.poll` object type
+ * @property-read int $objectID id of the poll container object the poll belongs to
* @property-read string $question question of the poll
- * @property-read integer $time timestamp at which the poll has been created
- * @property-read integer $endTime timestamp at which the poll has been/will be closed
- * @property-read integer $isChangeable is `1` if participants can change their vote, otherwise `0`
- * @property-read integer $isPublic is `1` if the result of the poll is public, otherwise `0`
- * @property-read integer $sortByVotes is `1` if the results will be sorted by votes, otherwise `0`
- * @property-read integer $resultsRequireVote is `1` if a user has to have voted to see the results, otherwise `0`
- * @property-read integer $maxVotes maximum number of options the user can select
- * @property-read integer $votes number of votes in the poll
+ * @property-read int $time timestamp at which the poll has been created
+ * @property-read int $endTime timestamp at which the poll has been/will be closed
+ * @property-read int $isChangeable is `1` if participants can change their vote, otherwise `0`
+ * @property-read int $isPublic is `1` if the result of the poll is public, otherwise `0`
+ * @property-read int $sortByVotes is `1` if the results will be sorted by votes, otherwise `0`
+ * @property-read int $resultsRequireVote is `1` if a user has to have voted to see the results, otherwise `0`
+ * @property-read int $maxVotes maximum number of options the user can select
+ * @property-read int $votes number of votes in the poll
*/
class Poll extends DatabaseObject {
/**
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\Poll\Poll
*
- * @property-read integer $optionID unique id of the poll option
- * @property-read integer $pollID id of the poll the option belongs to
+ * @property-read int $optionID unique id of the poll option
+ * @property-read int $pollID id of the poll the option belongs to
* @property-read string $optionValue text of the poll option
- * @property-read integer $votes number of votes for the poll option
- * @property-read integer $showOrder position of the poll option in relation to the other options of the poll
+ * @property-read int $votes number of votes for the poll option
+ * @property-read int $showOrder position of the poll option in relation to the other options of the poll
*/
class PollOption extends DatabaseObject {
/**
* Returns relative amount of votes for this option.
*
* @param Poll $poll
- * @return integer
+ * @return int
*/
public function getRelativeVotes(Poll $poll) {
if ($poll->votes) {
* @package WoltLabSuite\Core\Data\Reaction\Type
* @since 5.2
*
- * @property-read integer $reactionTypeID unique id of the reaction type
+ * @property-read int $reactionTypeID unique id of the reaction type
* @property-read string $title
- * @property-read integer $showOrder position of the reaction type in relation to the other reaction types
+ * @property-read int $showOrder position of the reaction type in relation to the other reaction types
* @property-read string $iconFile the file location of the icon
* @property-read boolean $isAssignable `1`, if the reaction can be assigned
*/
/**
* Returns the reaction type with the given reactionTypeID.
*
- * @param integer $reactionTypeID
+ * @param int $reactionTypeID
* @return ReactionType
*/
public function getReactionTypeByID($reactionTypeID) {
/**
* Returns the reaction types with the given reactionTypeIDs.
*
- * @param integer[] $reactionTypeIDs
+ * @param int[] $reactionTypeIDs
* @return ReactionType[]
*/
public function getReactionTypesByID(array $reactionTypeIDs) {
/**
* Returns the creation time.
*
- * @return integer
+ * @return int
*/
public function getTime();
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\Search
*
- * @property-read integer $searchID unique id of the search
- * @property-read integer|null $userID id of the user who has done the search or `null` if a guest has done the search
+ * @property-read int $searchID unique id of the search
+ * @property-read int|null $userID id of the user who has done the search or `null` if a guest has done the search
* @property-read string $searchData serialized array with data and parameters of the seatch
- * @property-read integer $searchTime timestamp of the search
+ * @property-read int $searchTime timestamp of the search
* @property-read string $searchType type of search, like `messages` or `users`
* @property-read string $searchHash hash identifying the search for the user to reuse the result within the first 30 minutes
*/
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\Search\Keyword
*
- * @property-read integer $keywordID unique id of the search keyword
+ * @property-read int $keywordID unique id of the search keyword
* @property-read string $keyword search keyword
- * @property-read integer $searches times the keyword has been searched
- * @property-read integer $lastSearchTime last time the keyword has been searched
+ * @property-read int $searches times the keyword has been searched
+ * @property-read int $lastSearchTime last time the keyword has been searched
*/
class SearchKeyword extends DatabaseObject {}
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\Session
*
- * @property-read integer|null $pageID id of the latest page visited
- * @property-read integer|null $pageObjectID id of the object the latest page visited belongs to
- * @property-read integer|null $parentPageID id of the parent page of latest page visited
- * @property-read integer|null $parentPageObjectID id of the object the parent page of latest page visited belongs to
- * @property-read integer $spiderID id of the spider the session belongs to
+ * @property-read int|null $pageID id of the latest page visited
+ * @property-read int|null $pageObjectID id of the object the latest page visited belongs to
+ * @property-read int|null $parentPageID id of the parent page of latest page visited
+ * @property-read int|null $parentPageObjectID id of the object the parent page of latest page visited belongs to
+ * @property-read int $spiderID id of the spider the session belongs to
*/
class Session extends ACPSession {
/**
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\Smiley
*
- * @property-read integer $smileyID unique id of the smiley
- * @property-read integer $packageID id of the package which delivers the smiley
- * @property-read integer|null $categoryID id of the category the smiley belongs to or `null` if it belongs to the default category
+ * @property-read int $smileyID unique id of the smiley
+ * @property-read int $packageID id of the package which delivers the smiley
+ * @property-read int|null $categoryID id of the category the smiley belongs to or `null` if it belongs to the default category
* @property-read string $smileyPath path to the smiley file relative to wcf's default path
* @property-read string $smileyPath2x path to the smiley file relative to wcf's default path (2x version)
* @property-read string $smileyTitle title of the smiley or name of language item that contains the title
* @property-read string $smileyCode code used for displaying the smiley
* @property-read string $aliases alternative codes used for displaying the smiley
- * @property-read integer $showOrder position of the smiley in relation to the other smileys in the same category
+ * @property-read int $showOrder position of the smiley in relation to the other smileys in the same category
*/
class Smiley extends DatabaseObject implements ITitledObject {
protected $height;
/**
* Returns the height of the smiley.
*
- * @return integer
+ * @return int
*/
public function getHeight() {
if ($this->height === null) {
/**
* Returns all the smilies of a category.
*
- * @param integer $categoryID
+ * @param int $categoryID
* @return array
*/
public function getCategorySmilies($categoryID = null) {
class SmileyCategory extends AbstractDecoratedCategory implements \Countable, ITraversableObject {
/**
* current iterator index
- * @var integer
+ * @var int
*/
protected $index = 0;
/**
* list of index to object relation
- * @var integer[]
+ * @var int[]
*/
protected $indexToObject = null;
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\Spider
*
- * @property-read integer $spiderID unique id of the spider
+ * @property-read int $spiderID unique id of the spider
* @property-read string $spiderIdentifier unique textual identifier of the spider
* @property-read string $spiderName name of the spider
* @property-read string $spiderURL link to the spider's website or empty if no such website exists
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\Stat\Daily
*
- * @property-read integer $statID unique id of the daily statistic entry
- * @property-read integer $objectTypeID id of the `com.woltlab.wcf.statDailyHandler` object type
+ * @property-read int $statID unique id of the daily statistic entry
+ * @property-read int $objectTypeID id of the `com.woltlab.wcf.statDailyHandler` object type
* @property-read string $date date when the daily statistic entry has been created
- * @property-read integer $counter daily statistic entry count for the last day
- * @property-read integer $total cumulative daily statistic entry count up to the date
+ * @property-read int $counter daily statistic entry count for the last day
+ * @property-read int $total cumulative daily statistic entry count up to the date
*/
class StatDaily extends DatabaseObject {}
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\Style
*
- * @property-read integer $styleID unique id of the style
- * @property-read integer $packageID id of the package which delivers the style
+ * @property-read int $styleID unique id of the style
+ * @property-read int $packageID id of the package which delivers the style
* @property-read string $styleName name of style
- * @property-read integer $templateGroupID id of the template group used for the style or `0` if the style uses no specific template group
- * @property-read integer $isDefault is `1` if the style is the default style for guests and users, otherwise `0`
- * @property-read integer $isDisabled is `1` if the style is disabled and thus cannot be used without having the specific permission to do so, otherwise `0`
+ * @property-read int $templateGroupID id of the template group used for the style or `0` if the style uses no specific template group
+ * @property-read int $isDefault is `1` if the style is the default style for guests and users, otherwise `0`
+ * @property-read int $isDisabled is `1` if the style is disabled and thus cannot be used without having the specific permission to do so, otherwise `0`
* @property-read string $styleDescription description of the style or name of the language item which contains the description
* @property-read string $styleVersion version number of the style
* @property-read string $styleDate date when the used version of the style has been published
* @property-read string $authorURL link to the author's website
* @property-read string $imagePath path (relative to `WCF_DIR`) to the images used by the style or empty if style has no special image path
* @property-read string $packageName package identifier used to export the style as a package or empty (thus style cannot be exported as package)
- * @property-read integer $isTainted is `0` if the original declarations of an imported or installed style are not and cannot be altered, otherwise `1`
- * @property-read integer $hasFavicon is `0` if the default favicon data should be used
- * @property-read integer $coverPhotoExtension extension of the style's cover photo file
+ * @property-read int $isTainted is `0` if the original declarations of an imported or installed style are not and cannot be altered, otherwise `1`
+ * @property-read int $hasFavicon is `0` if the default favicon data should be used
+ * @property-read int $coverPhotoExtension extension of the style's cover photo file
* @property-read string $apiVersion the style's compatibility version, possible values: '3.0' or '3.1'
*/
class Style extends DatabaseObject {
/**
* list of compatible API versions
- * @var integer[]
+ * @var int[]
* @deprecated 5.2
*/
public static $compatibilityApiVersions = [2018];
* Imports a style.
*
* @param string $filename
- * @param integer $packageID
+ * @param int $packageID
* @param StyleEditor $style
* @param boolean $skipFontDownload
* @return StyleEditor
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\Style\Variable
*
- * @property-read integer $variableID unique id of the style variable
+ * @property-read int $variableID unique id of the style variable
* @property-read string $variableName name of the style variable
* @property-read string $defaultValue default value of the style variable
*/
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\Tag
*
- * @property-read integer $tagID unique id of the tag
- * @property-read integer $languageID id of the language the tag belongs to
+ * @property-read int $tagID unique id of the tag
+ * @property-read int $languageID id of the language the tag belongs to
* @property-read string $name name/text of the tag
- * @property-read integer|null $synonymFor id of the tag for which the tag is a synonym or `null` if the tag is no synonym
+ * @property-read int|null $synonymFor id of the tag for which the tag is a synonym or `null` if the tag is no synonym
*/
class Tag extends DatabaseObject implements IRouteController {
/**
* Return the tag with the given name or null of no such tag exists.
*
* @param string $name
- * @param integer $languageID
+ * @param int $languageID
* @return Tag|null
*/
public static function getTag($name, $languageID = 0) {
/**
* Unmarks tags.
*
- * @param integer[] $tagIDs
+ * @param int[] $tagIDs
* @since 3.0
*/
protected function unmarkItems(array $tagIDs = []) {
* @method Tag getDecoratedObject()
* @mixin Tag
*
- * @property-read integer|null $counter number of the times the tag has been used for a certain object type or `null`
+ * @property-read int|null $counter number of the times the tag has been used for a certain object type or `null`
*/
class TagCloudTag extends DatabaseObjectDecorator {
/**
/**
* weight of the tag in a weighted list
- * @var integer
+ * @var int
*/
protected $weight = 1;
/**
* Returns the weight of the tag.
*
- * @return integer
+ * @return int
*/
public function getWeight() {
return $this->weight;
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\Template
*
- * @property-read integer $templateID unique id of the template
- * @property-read integer $packageID id of the package which delivers the template
+ * @property-read int $templateID unique id of the template
+ * @property-read int $packageID id of the package which delivers the template
* @property-read string $templateName name of the template
* @property-read string $application abbreviation of the application to which the template belongs
- * @property-read integer|null $templateGroupID id of the template group to which the template belongs or `null` if the template belongs to no template group
- * @property-read integer $lastModificationTime timestamp at which the template has been edited the last time
+ * @property-read int|null $templateGroupID id of the template group to which the template belongs or `null` if the template belongs to no template group
+ * @property-read int $lastModificationTime timestamp at which the template has been edited the last time
*/
class Template extends DatabaseObject {
/**
* Renames the file of this template.
*
* @param string $name
- * @param integer $templateGroupID
+ * @param int $templateGroupID
*/
public function rename($name, $templateGroupID = 0) {
// get current path
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\Template\Group
*
- * @property-read integer $templateGroupID unique id of the template group
- * @property-read integer|null $parentTemplateGroupID id of the template group's parent template group or `null` if the template group has no parent template group
+ * @property-read int $templateGroupID unique id of the template group
+ * @property-read int|null $parentTemplateGroupID id of the template group's parent template group or `null` if the template group has no parent template group
* @property-read string $templateGroupName name of the template group
* @property-read string $templateGroupFolderName name of the folder containing the modified templates (relative to the normal template folder)
*/
/**
* Creates a select list of all template groups.
*
- * @param integer[] $ignore Array of template group ids that should be excluded with all of their children.
+ * @param int[] $ignore Array of template group ids that should be excluded with all of their children.
* -1 denotes that all immutable groups should be ignored.
- * @param integer $initialDepth Specifies the initial indentation depth of the list
+ * @param int $initialDepth Specifies the initial indentation depth of the list
* @return array
*/
public static function getSelectList($ignore = [], $initialDepth = 0) {
/**
* Generates the select list.
*
- * @param integer $parentID id of the parent template group
- * @param integer $depth current list depth
+ * @param int $parentID id of the parent template group
+ * @param int $depth current list depth
* @param array $ignore list of template group ids to ignore in result
*/
protected static function makeSelectList($parentID = 0, $depth = 0, $ignore = []) {
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\Template\Listener
*
- * @property-read integer $listenerID unique id of the template listener
- * @property-read integer $packageID id of the package which delivers the template listener
+ * @property-read int $listenerID unique id of the template listener
+ * @property-read int $packageID id of the package which delivers the template listener
* @property-read string $name name of the template listener
* @property-read string $environment environment in which the template listener is executed, possible values: 'user' or 'admin'
* @property-read string $templateName name of the template in which the listened event is fired
* @property-read string $eventName name of the listened event
* @property-read string $templateCode included template code at the position of the listened event
- * @property-read integer $niceValue value from [-128, 127] used to determine template listener execution order (template listeners with smaller `$niceValue` are executed first)
+ * @property-read int $niceValue value from [-128, 127] used to determine template listener execution order (template listeners with smaller `$niceValue` are executed first)
* @property-read string $permissions comma separated list of user group permissions of which the active user needs to have at least one for the template listener to be executed
* @property-read string $options comma separated list of options of which at least one needs to be enabled for the template listener to be executed
*/
* @package WoltLabSuite\Core\Data\Trophy
* @since 3.1
*
- * @property-read integer $trophyID unique id for the trophy
+ * @property-read int $trophyID unique id for the trophy
* @property-read string $title the trophy title
* @property-read string $description the trophy description
- * @property-read integer $categoryID the categoryID of the trophy
- * @property-read integer $type the trophy type
+ * @property-read int $categoryID the categoryID of the trophy
+ * @property-read int $type the trophy type
* @property-read string $iconFile the file location of the icon
* @property-read string $iconName the icon name
* @property-read string $iconColor the icon color
* @property-read string $badgeColor the icon badge color
- * @property-read integer $isDisabled `1` if the trophy is disabled
- * @property-read integer $awardAutomatically `1` if the trophy is awarded automatically
- * @property-read integer $revokeAutomatically `1` if the trophy should be automatically revoked once the conditions are no longer met.
- * @property-read integer $trophyUseHtml `1` if the trophy use a html description
- * @property-read integer $showOrder position of the trophy in relation to the other trophies at the same location
+ * @property-read int $isDisabled `1` if the trophy is disabled
+ * @property-read int $awardAutomatically `1` if the trophy is awarded automatically
+ * @property-read int $revokeAutomatically `1` if the trophy should be automatically revoked once the conditions are no longer met.
+ * @property-read int $trophyUseHtml `1` if the trophy use a html description
+ * @property-read int $showOrder position of the trophy in relation to the other trophies at the same location
*/
class Trophy extends DatabaseObject implements ITitledLinkObject, IRouteController {
/**
* The type value, if this trophy is an image trophy.
- * @var integer
+ * @var int
*/
const TYPE_IMAGE = 1;
/**
* The type value, if this trophy is a badge trophy (based on CSS icons).
- * @var integer
+ * @var int
*/
const TYPE_BADGE = 2;
/**
* Renders a trophy.
*
- * @param integer $size
+ * @param int $size
* @param boolean $showTooltip
* @return string
*/
/**
* Returns the trophy with the given trophyID.
*
- * @param integer $trophyID
+ * @param int $trophyID
* @return Trophy
*/
public function getTrophyByID($trophyID) {
/**
* Returns the trophy with the given trophyID.
*
- * @param integer[] $trophyIDs
+ * @param int[] $trophyIDs
* @return Trophy[]
*/
public function getTrophiesByID(array $trophyIDs) {
/**
* Returns all trophies for a specific category.
*
- * @param integer $categoryID
+ * @param int $categoryID
* @return Trophy[]
*/
public function getTrophiesByCategoryID($categoryID) {
/**
* Returns all enabled trophies for a specific category.
*
- * @param integer $categoryID
+ * @param int $categoryID
* @return Trophy[]
*/
public function getEnabledTrophiesByCategoryID($categoryID) {
/**
* Sets the show order of the trophy.
*
- * @param integer $showOrder
+ * @param int $showOrder
*/
public function setShowOrder($showOrder = 0) {
$sql = "SELECT MAX(showOrder)
/**
* Returns the trophy category with the given id.
*
- * @param integer $categoryID
+ * @param int $categoryID
* @return TrophyCategory|null
*/
public function getCategoryByID($categoryID) {
/**
* Returns the categories with the given id.
*
- * @param integer[] $categoryIDs
+ * @param int[] $categoryIDs
* @return TrophyCategory[]
*/
public function getCategoriesByID(array $categoryIDs) {
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\User
*
- * @property-read integer $userID unique id of the user
+ * @property-read int $userID unique id of the user
* @property-read string $username name of the user
* @property-read string $email email address of the user
* @property-read string $password double salted hash of the user's password
* @property-read string $accessToken token used for access authentication, for example used by feed pages
- * @property-read integer $languageID id of the interface language used by the user
- * @property-read integer $registrationDate timestamp at which the user has registered/has been created
- * @property-read integer $styleID id of the style used by the user
- * @property-read integer $banned is `1` if the user is banned, otherwise `0`
+ * @property-read int $languageID id of the interface language used by the user
+ * @property-read int $registrationDate timestamp at which the user has registered/has been created
+ * @property-read int $styleID id of the style used by the user
+ * @property-read int $banned is `1` if the user is banned, otherwise `0`
* @property-read string $banReason reason why the user is banned
- * @property-read integer $banExpires timestamp at which the banned user is automatically unbanned
- * @property-read integer $activationCode flag which determines, whether the user is activated (for legacy reasons an random integer, if the user is *not* activated)
+ * @property-read int $banExpires timestamp at which the banned user is automatically unbanned
+ * @property-read int $activationCode flag which determines, whether the user is activated (for legacy reasons an random integer, if the user is *not* activated)
* @property-read string $emailConfirmed code sent to the user's email address used for account activation or null if the email is confirmed
- * @property-read integer $lastLostPasswordRequestTime timestamp at which the user has reported that they lost their password or 0 if password has not been reported as lost
+ * @property-read int $lastLostPasswordRequestTime timestamp at which the user has reported that they lost their password or 0 if password has not been reported as lost
* @property-read string $lostPasswordKey code used for authenticating setting new password after password loss or empty if password has not been reported as lost
- * @property-read integer $lastUsernameChange timestamp at which the user changed their name the last time or 0 if username has not been changed
+ * @property-read int $lastUsernameChange timestamp at which the user changed their name the last time or 0 if username has not been changed
* @property-read string $newEmail new email address of the user that has to be manually confirmed or empty if no new email address has been set
* @property-read string $oldUsername previous name of the user or empty if they have had no previous name
- * @property-read integer $quitStarted timestamp at which the user terminated their account
- * @property-read integer $reactivationCode code used for authenticating setting new email address or empty if no new email address has been set
+ * @property-read int $quitStarted timestamp at which the user terminated their account
+ * @property-read int $reactivationCode code used for authenticating setting new email address or empty if no new email address has been set
* @property-read string $registrationIpAddress ip address of the user at the time of registration or empty if user has been created manually or if no ip address are logged
- * @property-read integer|null $avatarID id of the user's avatar or null if they have no avatar
- * @property-read integer $disableAvatar is `1` if the user's avatar has been disabled, otherwise `0`
+ * @property-read int|null $avatarID id of the user's avatar or null if they have no avatar
+ * @property-read int $disableAvatar is `1` if the user's avatar has been disabled, otherwise `0`
* @property-read string $disableAvatarReason reason why the user's avatar is disabled
- * @property-read integer $disableAvatarExpires timestamp at which the user's avatar will automatically be enabled again
- * @property-read integer $enableGravatar is `1` if the user uses a gravatar as avatar, otherwise `0`
+ * @property-read int $disableAvatarExpires timestamp at which the user's avatar will automatically be enabled again
+ * @property-read int $enableGravatar is `1` if the user uses a gravatar as avatar, otherwise `0`
* @property-read string $gravatarFileExtension extension of the user's gravatar file
* @property-read string $signature text of the user's signature
- * @property-read integer $signatureEnableHtml is `1` if HTML will rendered in the user's signature, otherwise `0`
- * @property-read integer $disableSignature is `1` if the user's signature has been disabled, otherwise `0`
+ * @property-read int $signatureEnableHtml is `1` if HTML will rendered in the user's signature, otherwise `0`
+ * @property-read int $disableSignature is `1` if the user's signature has been disabled, otherwise `0`
* @property-read string $disableSignatureReason reason why the user's signature is disabled
- * @property-read integer $disableSignatureExpires timestamp at which the user's signature will automatically be enabled again
- * @property-read integer $lastActivityTime timestamp of the user's last activity
- * @property-read integer $profileHits number of times the user's profile has been visited
- * @property-read integer|null $rankID id of the user's rank or null if they have no rank
+ * @property-read int $disableSignatureExpires timestamp at which the user's signature will automatically be enabled again
+ * @property-read int $lastActivityTime timestamp of the user's last activity
+ * @property-read int $profileHits number of times the user's profile has been visited
+ * @property-read int|null $rankID id of the user's rank or null if they have no rank
* @property-read string $userTitle custom user title used instead of rank title or empty if user has no custom title
- * @property-read integer|null $userOnlineGroupID id of the user group whose online marking is used when printing the user's formatted name or null if no special marking is used
- * @property-read integer $activityPoints total number of the user's activity points
+ * @property-read int|null $userOnlineGroupID id of the user group whose online marking is used when printing the user's formatted name or null if no special marking is used
+ * @property-read int $activityPoints total number of the user's activity points
* @property-read string $notificationMailToken token used for authenticating requests by the user to disable notification emails
* @property-read string $authData data of the third party used for authentication
- * @property-read integer $likesReceived cumulative result of likes (counting +1) the user's contents have received
+ * @property-read int $likesReceived cumulative result of likes (counting +1) the user's contents have received
* @property-read string $coverPhotoHash hash of the user's cover photo
* @property-read string $coverPhotoExtension extension of the user's cover photo file
- * @property-read integer $disableCoverPhoto is `1` if the user's cover photo has been disabled, otherwise `0`
+ * @property-read int $disableCoverPhoto is `1` if the user's cover photo has been disabled, otherwise `0`
* @property-read string $disableCoverPhotoReason reason why the user's cover photo is disabled
- * @property-read integer $disableCoverPhotoExpires timestamp at which the user's cover photo will automatically be enabled again
- * @property-read integer $articles number of articles written by the user
+ * @property-read int $disableCoverPhotoExpires timestamp at which the user's cover photo will automatically be enabled again
+ * @property-read int $articles number of articles written by the user
* @property-read string $blacklistMatches JSON string of an array with all matches in the blacklist, otherwise an empty string
- * @property-read integer $multifactorActive is `1` if the use has enabled a second factor, otherwise `0`
+ * @property-read int $multifactorActive is `1` if the use has enabled a second factor, otherwise `0`
*/
final class User extends DatabaseObject implements IPopoverObject, IRouteController, IUserContent {
/**
* list of group ids
- * @var integer[]
+ * @var int[]
*/
protected $groupIDs;
/**
* list of language ids
- * @var integer[]
+ * @var int[]
*/
protected $languageIDs;
* Returns an array with all the groups in which the actual user is a member.
*
* @param boolean $skipCache
- * @return integer[]
+ * @return int[]
*/
public function getGroupIDs($skipCache = false) {
if ($this->groupIDs === null || $skipCache) {
/**
* Returns a list of language ids for this user.
*
- * @return integer[]
+ * @return int[]
*/
public function getLanguageIDs() {
if ($this->languageIDs === null) {
* Returns the id of a user option.
*
* @param string $name
- * @return integer id
+ * @return int id
*/
public static function getUserOptionID($name) {
// get user option cache if necessary
/**
* Unmarks users.
*
- * @param integer[] $userIDs
+ * @param int[] $userIDs
*/
protected function unmarkItems(array $userIDs = []) {
if (empty($userIDs)) {
/**
* Inserts default options.
*
- * @param integer $userID
+ * @param int $userID
*/
protected static function createUserOptions($userID) {
// fetch default values
/**
* Adds a user to a user group.
*
- * @param integer $groupID
+ * @param int $groupID
*/
public function addToGroup($groupID) {
$sql = "INSERT IGNORE INTO wcf".WCF_N."_user_to_group
/**
* Removes a user from a user group.
*
- * @param integer $groupID
+ * @param int $groupID
*/
public function removeFromGroup($groupID) {
$sql = "DELETE FROM wcf".WCF_N."_user_to_group
/**
* list of ignored user ids
- * @var integer[]
+ * @var int[]
*/
protected $ignoredUserIDs;
/**
* list of user ids that are ignoring this user
- * @var integer[]
+ * @var int[]
*/
protected $ignoredByUserIDs;
/**
* list of follower user ids
- * @var integer[]
+ * @var int[]
*/
protected $followerUserIDs;
/**
* list of following user ids
- * @var integer[]
+ * @var int[]
*/
protected $followingUserIDs;
/**
* age of this user
- * @var integer
+ * @var int
*/
protected $__age;
/**
* Returns a list of all user ids being followed by current user.
*
- * @return integer[]
+ * @return int[]
*/
public function getFollowingUsers() {
if ($this->followingUserIDs === null) {
/**
* Returns a list of user ids following current user.
*
- * @return integer[]
+ * @return int[]
*/
public function getFollowers() {
if ($this->followerUserIDs === null) {
/**
* Returns a list of ignored user ids.
*
- * @return integer[]
+ * @return int[]
*/
public function getIgnoredUsers() {
if ($this->ignoredUserIDs === null) {
/**
* Returns a list of user ids that are ignoring this user.
*
- * @return integer[]
+ * @return int[]
*/
public function getIgnoredByUsers() {
if ($this->ignoredByUserIDs === null) {
/**
* Returns true if current user is following given user id.
*
- * @param integer $userID
+ * @param int $userID
* @return boolean
*/
public function isFollowing($userID) {
/**
* Returns true if given user ids follows current user.
*
- * @param integer $userID
+ * @param int $userID
* @return boolean
*/
public function isFollower($userID) {
/**
* Returns true if given user is ignored.
*
- * @param integer $userID
+ * @param int $userID
* @return boolean
*/
public function isIgnoredUser($userID) {
/**
* Returns true if the given user ignores the current user.
*
- * @param integer $userID
+ * @param int $userID
* @return boolean
*/
public function isIgnoredByUser($userID) {
/**
* Returns the last activity time.
*
- * @return integer
+ * @return int
*/
public function getLastActivityTime() {
return max($this->lastActivityTime, $this->sessionLastActivityTime);
/**
* Returns a new user profile object.
*
- * @param integer $userID
+ * @param int $userID
* @return UserProfile
* @deprecated 3.0, use UserProfileRuntimeCache::getObject()
*/
/**
* Returns a list of user profiles.
*
- * @param integer[] $userIDs
+ * @param int[] $userIDs
* @return UserProfile[]
* @deprecated 3.0, use UserProfileRuntimeCache::getObjects()
*/
/**
* Returns the age of this user.
*
- * @param integer $year
- * @return integer
+ * @param int $year
+ * @return int
*/
public function getAge($year = null) {
$showYear = $this->birthdayShowYear || WCF::getSession()->getPermission('admin.general.canViewPrivateUserOptions');
/**
* Returns the formatted birthday of this user.
*
- * @param integer $year
+ * @param int $year
* @return string
*/
public function getBirthday($year = null) {
/**
* Returns the age of user account in days.
*
- * @return integer
+ * @return int
*/
public function getProfileAge() {
return (TIME_NOW - $this->registrationDate) / 86400;
/**
* Sets the session-based last activity time.
*
- * @param integer $timestamp
+ * @param int $timestamp
*/
public function setSessionLastActivityTime($timestamp) {
$this->object->data['sessionLastActivityTime'] = $timestamp;
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\User\Activity\Event
*
- * @property-read integer $eventID unique id of the user activity event
- * @property-read integer $objectTypeID id of the `com.woltlab.wcf.user.recentActivityEvent` object type
- * @property-read integer $objectID id of the object the user activity event belongs to
- * @property-read integer|null $languageID id of the language of the related object or null if the object has no specific language
- * @property-read integer $userID id of the user who has triggered the user activity event
- * @property-read integer $time timestamp at which the user activity event has been triggered
+ * @property-read int $eventID unique id of the user activity event
+ * @property-read int $objectTypeID id of the `com.woltlab.wcf.user.recentActivityEvent` object type
+ * @property-read int $objectID id of the object the user activity event belongs to
+ * @property-read int|null $languageID id of the language of the related object or null if the object has no specific language
+ * @property-read int $userID id of the user who has triggered the user activity event
+ * @property-read int $time timestamp at which the user activity event has been triggered
* @property-read array $additionalData array with additional data of the user activity event
*/
class UserActivityEvent extends DatabaseObject {
/**
* Returns timestamp of oldest entry fetched.
*
- * @return integer
+ * @return int
*/
public function getLastEventTime() {
$lastEventTime = 0;
/**
* Validates event permissions and returns a list of orphaned event ids.
*
- * @return integer[]
+ * @return int[]
*/
public function validateEvents() {
$orphanedEventIDs = [];
/**
* Truncates the items in object list to given number of items.
*
- * @param integer $limit
+ * @param int $limit
*/
public function truncate($limit) {
$this->objects = array_slice($this->objects, 0, $limit, true);
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\User\Authentication\Failure
*
- * @property-read integer $failureID unique if of the user authentication failure
+ * @property-read int $failureID unique if of the user authentication failure
* @property-read string $environment environment in which the user authentication failure occurred, possible values: 'user' or 'admin'
- * @property-read integer|null $userID id of the user using an incorrect password or null if the provided username or email address is not associated with any registered user
+ * @property-read int|null $userID id of the user using an incorrect password or null if the provided username or email address is not associated with any registered user
* @property-read string $username user name or email address used to login
- * @property-read integer $time timestamp at which the user authentication failure has occurred
+ * @property-read int $time timestamp at which the user authentication failure has occurred
* @property-read string $ipAddress ip address of the user trying to login in
* @property-read string $userAgent user agent of the user trying to login in
*/
/**
* Returns the number of authentication failures for given user account.
*
- * @param integer $userID
+ * @param int $userID
* @return boolean
*/
public static function countUserFailures($userID) {
class DefaultAvatar implements IUserAvatar {
/**
* image size
- * @var integer
+ * @var int
*/
public $size = UserAvatar::AVATAR_SIZE;
/**
* Returns the perceived luminance of the given color.
*
- * @param integer $r
- * @param integer $g
- * @param integer $b
+ * @param int $r
+ * @param int $g
+ * @param int $b
* @return float luminance expressed in a float in the range of 0 and 1
*/
protected function getPerceptiveLuminance($r, $g, $b) {
/**
* gravatar expire time (days)
- * @var integer
+ * @var int
*/
const GRAVATAR_CACHE_EXPIRE = 7;
/**
* user id
- * @var integer
+ * @var int
*/
public $userID = 0;
/**
* Creates a new Gravatar object.
*
- * @param integer $userID
+ * @param int $userID
* @param string $gravatar
* @param string $fileExtension
*/
/**
* Returns the url to this avatar.
*
- * @param integer $size
+ * @param int $size
* @return string
*/
public function getURL($size = null);
/**
* Returns the html code to display this avatar.
*
- * @param integer $size
+ * @param int $size
* @return string
*/
public function getImageTag($size = null);
/**
* Returns the image tag used for cropping.
*
- * @param integer $size
+ * @param int $size
* @return string
* @deprecated 3.0
*/
/**
* Returns the width of this avatar.
*
- * @return integer
+ * @return int
*/
public function getWidth();
/**
* Returns the height of this avatar.
*
- * @return integer
+ * @return int
*/
public function getHeight();
}
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\User\Avatar
*
- * @property-read integer $avatarID unique id of the user avatar
+ * @property-read int $avatarID unique id of the user avatar
* @property-read string $avatarName name of the original avatar file
* @property-read string $avatarExtension extension of the avatar file
- * @property-read integer $width width of the user avatar image
- * @property-read integer $height height of the user avatar image
- * @property-read integer|null $userID id of the user to which the user avatar belongs or null
+ * @property-read int $width width of the user avatar image
+ * @property-read int $height height of the user avatar image
+ * @property-read int|null $userID id of the user to which the user avatar belongs or null
* @property-read string $fileHash SHA1 hash of the original avatar file
*/
class UserAvatar extends DatabaseObject implements IUserAvatar {
/**
* needed avatar thumbnail sizes
- * @var integer[]
+ * @var int[]
* @deprecated 3.0
*/
public static $avatarThumbnailSizes = [32, 96, 128, 256];
/**
* maximum thumbnail size
- * @var integer
+ * @var int
* @deprecated 3.0
*/
public static $maxThumbnailSize = 128;
/**
* minimum height and width of an uploaded avatar
- * @var integer
+ * @var int
* @deprecated 3.0
*/
const MIN_AVATAR_SIZE = 96;
/**
* minimum height and width of an uploaded avatar
- * @var integer
+ * @var int
*/
const AVATAR_SIZE = 128;
/**
* Returns the physical location of this avatar.
*
- * @param integer $size
+ * @param int $size
* @return string
*/
public function getLocation($size = null) {
/**
* Returns the file name of this avatar.
*
- * @param integer $size
+ * @param int $size
* @return string
*/
public function getFilename($size = null) {
/**
* user id
- * @var integer
+ * @var int
*/
protected $userID;
/**
* UserCoverPhoto constructor.
*
- * @param integer $userID
+ * @param int $userID
* @param string $coverPhotoHash
* @param string $coverPhotoExtension
*/
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\User\Follow
*
- * @property-read integer $followID unique id of the following relation
- * @property-read integer $userID id of the following user
- * @property-read integer $followUserID id of the followed user
- * @property-read integer $time time at which following relation has been established
+ * @property-read int $followID unique id of the following relation
+ * @property-read int $userID id of the following user
+ * @property-read int $followUserID id of the followed user
+ * @property-read int $time time at which following relation has been established
*/
class UserFollow extends DatabaseObject {
/**
* Retrieves a follower.
*
- * @param integer $userID
- * @param integer $followUserID
+ * @param int $userID
+ * @param int $followUserID
* @return UserFollow
*/
public static function getFollow($userID, $followUserID) {
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\User\Group
*
- * @property-read integer $groupID unique id of the user group
+ * @property-read int $groupID unique id of the user group
* @property-read string $groupName name of the user group or name of language
* item which contains the name
* @property-read string $groupDescription description of the user group or name of
* language item which contains the description
- * @property-read integer $groupType identifier of the type of user group
- * @property-read integer $priority priority of the user group used to determine
+ * @property-read int $groupType identifier of the type of user group
+ * @property-read int $priority priority of the user group used to determine
* member's user rank and online marking
* @property-read string $userOnlineMarking HTML code used to print the formatted name of
* a user group member
- * @property-read integer $showOnTeamPage is `1` if the user group and its members
+ * @property-read int $showOnTeamPage is `1` if the user group and its members
* should be shown on the team page, otherwise `0`
* @property-read int $allowMention is `1` if the user group can be mentioned in messages,
* otherwise `0`
class UserGroup extends DatabaseObject implements ITitledObject {
/**
* group type everyone user group
- * @var integer
+ * @var int
*/
const EVERYONE = 1;
/**
* group type guests user group
- * @var integer
+ * @var int
*/
const GUESTS = 2;
/**
* group type registered users user group
- * @var integer
+ * @var int
*/
const USERS = 3;
/**
* group type of other user groups
- * @var integer
+ * @var int
*/
const OTHER = 4;
/**
* list of accessible groups for active user
- * @var integer[]
+ * @var int[]
*/
protected static $accessibleGroups = null;
/**
* Returns group ids by given type.
*
- * @param integer[] $types
- * @return integer[]
+ * @param int[] $types
+ * @return int[]
*/
public static function getGroupIDsByType(array $types) {
self::getCache();
/**
* Returns groups by given type. Returns all groups if no types given.
*
- * @param integer[] $types
- * @param integer[] $invalidGroupTypes
+ * @param int[] $types
+ * @param int[] $invalidGroupTypes
* @return UserGroup[]
*/
public static function getGroupsByType(array $types = [], array $invalidGroupTypes = []) {
/**
* Returns a sorted list of groups filtered by given type.
*
- * @param integer[] $types
- * @param integer[] $invalidGroupTypes
+ * @param int[] $types
+ * @param int[] $invalidGroupTypes
* @return UserGroup[]
* @since 5.3
*/
/**
* Returns unique group by given type. Only works for the default user groups.
*
- * @param integer $type
+ * @param int $type
* @return UserGroup
* @throws SystemException
*/
* Returns the user group with the given id or null if no such user group
* exists.
*
- * @param integer $groupID
+ * @param int $groupID
* @return UserGroup|null
*/
public static function getGroupByID($groupID) {
/**
* Returns a list of groups by group id.
*
- * @param integer[] $groupIDs list of group ids
+ * @param int[] $groupIDs list of group ids
* @return UserGroup[]
*/
public static function getGroupsByIDs(array $groupIDs) {
/**
* Returns a list of accessible groups.
*
- * @param integer[] $groupTypes
- * @param integer[] $invalidGroupTypes
+ * @param int[] $groupTypes
+ * @param int[] $invalidGroupTypes
* @return UserGroup[]
*/
public static function getAccessibleGroups(array $groupTypes = [], array $invalidGroupTypes = []) {
/**
* Returns a sorted list of accessible groups.
*
- * @param integer[] $groupTypes
- * @param integer[] $invalidGroupTypes
+ * @param int[] $groupTypes
+ * @param int[] $invalidGroupTypes
* @return UserGroup[]
* @since 5.2
*/
/**
* Updates the value from the accessiblegroups option.
*
- * @param integer $groupID this group is added or deleted in the value
+ * @param int $groupID this group is added or deleted in the value
* @param boolean $delete flag for group deletion
* @throws SystemException
*/
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\User\Group\Assignment
*
- * @property-read integer $assignmentID unique id of the automatic user group assignment
- * @property-read integer $groupID id of the user group to which users are automatically assigned
+ * @property-read int $assignmentID unique id of the automatic user group assignment
+ * @property-read int $groupID id of the user group to which users are automatically assigned
* @property-read string $title title of the automatic user group assignment
- * @property-read integer $isDisabled is `1` if the user group assignment is disabled and thus not checked for automatic assignments, otherwise `0`
+ * @property-read int $isDisabled is `1` if the user group assignment is disabled and thus not checked for automatic assignments, otherwise `0`
*/
class UserGroupAssignment extends DatabaseObject implements IRouteController {
/**
* @package WoltLabSuite\Core\Data\User\Group\Option
*
* @property-read string $defaultValue default value of the user option
- * @property-read integer $usersOnly is `1` if the option only applies to user groups for registered users, otherwise `1`
+ * @property-read int $usersOnly is `1` if the option only applies to user groups for registered users, otherwise `1`
*/
class UserGroupOption extends Option {
/**
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\User\Group\Option\Category
*
- * @property-read integer $categoryID unique id of the user group options category
- * @property-read integer $packageID id of the package which delivers the user group options category
+ * @property-read int $categoryID unique id of the user group options category
+ * @property-read int $packageID id of the package which delivers the user group options category
* @property-read string $categoryName name and textual identifier of the user group option category
* @property-read string $parentCategoryName name of the user group option category's parent category or empty if it has no parent category
- * @property-read integer $showOrder position of the user group options category in relation to its siblings
+ * @property-read int $showOrder position of the user group options category in relation to its siblings
* @property-read string $permissions comma separated list of user group permissions of which the active user needs to have at least one to see the user group options category
* @property-read string $options comma separated list of options of which at least one needs to be enabled for the user group options category to be shown
*/
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\User\Ignore
*
- * @property-read integer $ignoreID unique id of the ignore relation
- * @property-read integer $userID id of the ignoring user
- * @property-read integer $ignoreUserID id of the ignored user
- * @property-read integer $time time at which ignore relation has been established
+ * @property-read int $ignoreID unique id of the ignore relation
+ * @property-read int $userID id of the ignoring user
+ * @property-read int $ignoreUserID id of the ignored user
+ * @property-read int $time time at which ignore relation has been established
*/
class UserIgnore extends DatabaseObject {
/**
* Returns a UserIgnore object for given ignored user id.
*
- * @param integer $ignoreUserID
+ * @param int $ignoreUserID
* @return UserIgnore
*/
public static function getIgnore($ignoreUserID) {
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\User\Menu\Item
*
- * @property-read integer $menuItemID unique id of the user menu item
- * @property-read integer $packageID id of the package the which delivers the user menu item
+ * @property-read int $menuItemID unique id of the user menu item
+ * @property-read int $packageID id of the package the which delivers the user menu item
* @property-read string $menuItem textual identifier of the user menu item
* @property-read string $parentMenuItem textual identifier of the menu item's parent menu item or empty if it has no parent menu item
* @property-read string $menuItemController class name of the user menu item's controller used to generate menu item link
* @property-read string $menuItemLink additional part of the user menu item link if `$menuItemController` is set or external link
- * @property-read integer $showOrder position of the user menu item in relation to its siblings
+ * @property-read int $showOrder position of the user menu item in relation to its siblings
* @property-read string $permissions comma separated list of user group permissions of which the active user needs to have at least one to see the user menu item
* @property-read string $options comma separated list of options of which at least one needs to be enabled for the user menu item to be shown
* @property-read string $className name of the class implementing the user menu item provider interface or empty if there is no specific user menu item provider
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\User\Notification
*
- * @property-read integer $notificationID unique id of the user notification
- * @property-read integer $packageID deprecated
- * @property-read integer $eventID id of the user notification event the user notification belongs to
- * @property-read integer $objectID id of the object that triggered the user notification
- * @property-read integer $baseObjectID id of a generic base object of object that triggered the user notification or 0 if there is no such base object
+ * @property-read int $notificationID unique id of the user notification
+ * @property-read int $packageID deprecated
+ * @property-read int $eventID id of the user notification event the user notification belongs to
+ * @property-read int $objectID id of the object that triggered the user notification
+ * @property-read int $baseObjectID id of a generic base object of object that triggered the user notification or 0 if there is no such base object
* @property-read string $eventHash hash of the event the user notification represents, is used to stack notifications
- * @property-read integer|null $authorID id of the user that triggered the user notification or null if there is no such user or the user was a guest
- * @property-read integer $timesTriggered total number of times a stacked notification has been triggered by registered users and guests
- * @property-read integer $guestTimesTriggered number of times a stacked notification has been triggered by guests
- * @property-read integer $userID id of the user who receives the user notification
- * @property-read integer $time timestamp at which the user notification has been created
- * @property-read integer $mailNotified is 0 has not be notified by mail about the user notification, otherwise 1
- * @property-read integer $confirmTime timestamp at which the user notification has been marked as confirmed/read
+ * @property-read int|null $authorID id of the user that triggered the user notification or null if there is no such user or the user was a guest
+ * @property-read int $timesTriggered total number of times a stacked notification has been triggered by registered users and guests
+ * @property-read int $guestTimesTriggered number of times a stacked notification has been triggered by guests
+ * @property-read int $userID id of the user who receives the user notification
+ * @property-read int $time timestamp at which the user notification has been created
+ * @property-read int $mailNotified is 0 has not be notified by mail about the user notification, otherwise 1
+ * @property-read int $confirmTime timestamp at which the user notification has been marked as confirmed/read
* @property-read array $additionalData array with additional data of the user notification event
*/
class UserNotification extends DatabaseObject {
/**
* Returns an existing notification.
*
- * @param integer $packageID
- * @param integer $eventID
- * @param integer $objectID
+ * @param int $packageID
+ * @param int $eventID
+ * @param int $objectID
* @return UserNotification
*/
public static function getNotification($packageID, $eventID, $objectID) {
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\User\Notification\Event
*
- * @property-read integer $eventID unique id of the user notification event
- * @property-read integer $packageID id of the package which delivers the user notification event
+ * @property-read int $eventID unique id of the user notification event
+ * @property-read int $packageID id of the package which delivers the user notification event
* @property-read string $eventName name and textual identifier (within the object type) of the user notification event
- * @property-read integer $objectTypeID id of the `com.woltlab.wcf.notification.objectType` object type
+ * @property-read int $objectTypeID id of the `com.woltlab.wcf.notification.objectType` object type
* @property-read string $className name of the PHP class implementing `wcf\system\user\notification\event\IUserNotificationEvent`
* @property-read string $permissions comma separated list of user group permissions of which the active user needs to have at least one to see the user notification event setting
* @property-read string $options comma separated list of options of which at least one needs to be enabled for the user notification event setting to be shown
- * @property-read integer $preset is `1` if the user notification event is enabled by default otherwise `0`
+ * @property-read int $preset is `1` if the user notification event is enabled by default otherwise `0`
* @property-read string $presetMailNotificationType default mail notification type if the user notification event is enabled by default, otherwise empty
*/
class UserNotificationEvent extends ProcessibleDatabaseObject {
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\User\Object\Watch
*
- * @property-read integer $watchID unique id of the watched object
- * @property-read integer $objectTypeID id of the `com.woltlab.wcf.user.objectWatch` object type
- * @property-read integer $objectID id of the watched object of the specific object type
- * @property-read integer $userID id of the user watching the object
- * @property-read integer $notification is `1` if the user wants to receive notifications for the watched object, otherwise `0`
+ * @property-read int $watchID unique id of the watched object
+ * @property-read int $objectTypeID id of the `com.woltlab.wcf.user.objectWatch` object type
+ * @property-read int $objectID id of the watched object of the specific object type
+ * @property-read int $userID id of the user watching the object
+ * @property-read int $notification is `1` if the user wants to receive notifications for the watched object, otherwise `0`
*/
class UserObjectWatch extends DatabaseObject {
/**
* Returns the UserObjectWatch with the given data or null if no such object
* exists.
*
- * @param integer $objectTypeID
- * @param integer $userID
- * @param integer $objectID
+ * @param int $objectTypeID
+ * @param int $userID
+ * @param int $objectID
* @return UserObjectWatch
*/
public static function getUserObjectWatch($objectTypeID, $userID, $objectID) {
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\User\Online
*
- * @property-read integer|null $pageID id of the last visited page
- * @property-read integer|null $pageObjectID id of the object the last visited page belongs to
- * @property-read integer|null $parentPageObjectID id of the parent of the object the last visited page belongs to
+ * @property-read int|null $pageID id of the last visited page
+ * @property-read int|null $pageObjectID id of the object the last visited page belongs to
+ * @property-read int|null $parentPageObjectID id of the parent of the object the last visited page belongs to
* @property-read string|null $userOnlineMarking HTML code used to print the formatted name of a user group member
*/
class UserOnline extends UserProfile {
/**
* Checks the 'canViewOnlineStatus' setting.
*
- * @param integer $userID
- * @param integer $canViewOnlineStatus
+ * @param int $userID
+ * @param int $canViewOnlineStatus
* @return boolean
* @deprecated 5.3 Use `isVisibleUser` instead
*/
* @package WoltLabSuite\Core\Data\User\Option
*
* @property-read string $defaultValue default value of the user option
- * @property-read integer $required is `1` if the user option has to be filled out, otherwise `0`
- * @property-read integer $askDuringRegistration is `1` if the user option will be shown during registration to be filled out, otherwise `0`
- * @property-read integer $editable setting for who can edit the user option, see `UserOption::EDITABILITY_*` constants
- * @property-read integer $visible setting for who can see the user option, see `UserOption::VISIBILITY_*` constants
+ * @property-read int $required is `1` if the user option has to be filled out, otherwise `0`
+ * @property-read int $askDuringRegistration is `1` if the user option will be shown during registration to be filled out, otherwise `0`
+ * @property-read int $editable setting for who can edit the user option, see `UserOption::EDITABILITY_*` constants
+ * @property-read int $visible setting for who can see the user option, see `UserOption::VISIBILITY_*` constants
* @property-read string $outputClass name of the PHP class implementing `wcf\system\option\user\IUserOptionOutput` for outputting the user option in the user profile
- * @property-read integer $searchable is `1` if the user option can be searched, otherwise `0`
- * @property-read integer $isDisabled is `1` if the user option is disabled and thus neither shown nor editable, otherwise `0`
- * @property-read integer $originIsSystem is `1` if the user option was created by the system and not manually by an administrator, otherwise `0`
+ * @property-read int $searchable is `1` if the user option can be searched, otherwise `0`
+ * @property-read int $isDisabled is `1` if the user option is disabled and thus neither shown nor editable, otherwise `0`
+ * @property-read int $originIsSystem is `1` if the user option was created by the system and not manually by an administrator, otherwise `0`
* @property-read string $labeledUrl the url, if the option type is `labeledUrl`
*/
class UserOption extends Option implements ITitledObject {
/**
* visible for no one (no valid bit)
- * @var integer
+ * @var int
*/
const VISIBILITY_NONE = 0;
/**
* visible for the owner
- * @var integer
+ * @var int
*/
const VISIBILITY_OWNER = 1;
/**
* visible for admins
- * @var integer
+ * @var int
*/
const VISIBILITY_ADMINISTRATOR = 2;
/**
* visible for users
- * @var integer
+ * @var int
*/
const VISIBILITY_REGISTERED = 4;
/**
* visible for guests
- * @var integer
+ * @var int
*/
const VISIBILITY_GUEST = 8;
/**
* visible for all (no valid bit)
- * @var integer
+ * @var int
*/
const VISIBILITY_ALL = 15;
/**
* editable for no one (no valid bit)
- * @var integer
+ * @var int
*/
const EDITABILITY_NONE = 0;
/**
* editable for the owner
- * @var integer
+ * @var int
*/
const EDITABILITY_OWNER = 1;
/**
* editable for admins
- * @var integer
+ * @var int
*/
const EDITABILITY_ADMINISTRATOR = 2;
/**
* editable for all (no valid bit)
- * @var integer
+ * @var int
*/
const EDITABILITY_ALL = 3;
/**
* editable for owner during registration
- * @var integer
+ * @var int
*/
const EDITABILITY_OWNER_DURING_REGISTRATION = 4;
/**
* editable for owner during registration and admins (no valid bit)
- * @var integer
+ * @var int
*/
const EDITABILITY_OWNER_DURING_REGISTRATION_AND_ADMINISTRATOR = 6;
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\User\Option\Category
*
- * @property-read integer $categoryID unique id of the user option category
- * @property-read integer $packageID id of the package which delivers the user option category
+ * @property-read int $categoryID unique id of the user option category
+ * @property-read int $packageID id of the package which delivers the user option category
* @property-read string $categoryName name and textual identifier of the user option category
* @property-read string $parentCategoryName name of the user option category's parent category or empty if it has no parent category
- * @property-read integer $showOrder position of the user option category in relation to its siblings
+ * @property-read int $showOrder position of the user option category in relation to its siblings
* @property-read string $permissions comma separated list of user group permissions of which the active user needs to have at least one to see the user option category
* @property-read string $options comma separated list of options of which at least one needs to be enabled for the user option category to be shown
*/
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\User\Profile\Menu\Item
*
- * @property-read integer $menuItemID unique id of the user profile menu item
- * @property-read integer $packageID id of the package which delivers the user profile menu item
+ * @property-read int $menuItemID unique id of the user profile menu item
+ * @property-read int $packageID id of the package which delivers the user profile menu item
* @property-read string $menuItem textual identifier of the user profile menu item
- * @property-read integer $showOrder position of the user profile menu item in relation to its siblings
+ * @property-read int $showOrder position of the user profile menu item in relation to its siblings
* @property-read string $permissions comma separated list of user group permissions of which the active user needs to have at least one to see the user profile menu item
* @property-read string $options comma separated list of options of which at least one needs to be enabled for the user profile menu item to be shown
* @property-read string $className name of the PHP class implementing `wcf\system\menu\user\profile\content\IUserProfileMenuContent` handling outputting the content of the user profile tab
/**
* Updates show order for current menu item.
*
- * @param integer $showOrder
+ * @param int $showOrder
*/
protected function updateShowOrder($showOrder) {
if ($this->showOrder != $showOrder) {
/**
* Returns show order for a new menu item.
*
- * @param integer $showOrder
- * @return integer
+ * @param int $showOrder
+ * @return int
*/
protected static function getShowOrder($showOrder = 0) {
if ($showOrder == 0) {
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\User\Profile\Visitor
*
- * @property-read integer $visitorID unique id of the user profile visitor
- * @property-read integer $ownerID id of the user whose user profile has been visited
- * @property-read integer $userID id of the user visiting the user profile
- * @property-read integer $time timestamp of the (latest) visit
+ * @property-read int $visitorID unique id of the user profile visitor
+ * @property-read int $ownerID id of the user whose user profile has been visited
+ * @property-read int $userID id of the user visiting the user profile
+ * @property-read int $time timestamp of the (latest) visit
*/
class UserProfileVisitor extends DatabaseObject {
/**
* Returns a profile visitor object or `null` if it does not exist.
*
- * @param integer $ownerID
- * @param integer $userID
+ * @param int $ownerID
+ * @param int $userID
* @return UserProfileVisitor|null
*/
public static function getObject($ownerID, $userID) {
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\Data\User\Rank
*
- * @property-read integer $rankID unique id of the user rank
- * @property-read integer $groupID id of the user group to which the user rank belongs
- * @property-read integer $requiredPoints minimum number of user activity points required for a user to get the user rank
+ * @property-read int $rankID unique id of the user rank
+ * @property-read int $groupID id of the user group to which the user rank belongs
+ * @property-read int $requiredPoints minimum number of user activity points required for a user to get the user rank
* @property-read string $rankTitle title of the user rank or name of the language item which contains the rank
* @property-read string $cssClassName css class name used when displaying the user rank
* @property-read string $rankImage (WCF relative) path to the image displayed next to the rank or empty if no rank image exists
- * @property-read integer $repeatImage number of times the rank image is displayed
- * @property-read integer $requiredGender numeric representation of the user's gender required for the user rank (see `UserProfile::GENDER_*` constants) or 0 if no specific gender is required
- * @property-read integer $hideTitle hides the generic title of the rank, but not custom titles, `0` to show the title at all times
+ * @property-read int $repeatImage number of times the rank image is displayed
+ * @property-read int $requiredGender numeric representation of the user's gender required for the user rank (see `UserProfile::GENDER_*` constants) or 0 if no specific gender is required
+ * @property-read int $hideTitle hides the generic title of the rank, but not custom titles, `0` to show the title at all times
*/
class UserRank extends DatabaseObject implements ITitledObject {
* @package WoltLabSuite\Core\Data\User\Trophy
* @since 3.1
*
- * @property-read integer $userTrophyID unique id of the user trophy
- * @property-read integer $trophyID trophy id
- * @property-read integer $userID user id
- * @property-read integer $time the time when the trophy was rewarded
+ * @property-read int $userTrophyID unique id of the user trophy
+ * @property-read int $trophyID trophy id
+ * @property-read int $userID user id
+ * @property-read int $time the time when the trophy was rewarded
* @property-read string $description the custom trophy description
* @property-read string $useCustomDescription `1`, if the trophy use a custom description
- * @property-read integer $trophyUseHtml `1`, if the trophy use a html description
+ * @property-read int $trophyUseHtml `1`, if the trophy use a html description
*/
class UserTrophy extends DatabaseObject {
/**
/**
* Returns a user trophy list for a certain users.
*
- * @param integer[] $userIDs
+ * @param int[] $userIDs
* @param boolean $includeDisabled
* @return UserTrophy[][]
*/
abstract class AbstractModerationForm extends AbstractForm {
/**
* id of the assigned user
- * @var integer
+ * @var int
*/
public $assignedUserID = 0;
/**
* queue id
- * @var integer
+ * @var int
*/
public $queueID = 0;
/**
* comment object type id
- * @var integer
+ * @var int
*/
public $commentObjectTypeID = 0;
/**
* indicates if the user quit
- * @var integer
+ * @var int
*/
public $quit = 0;
/**
* indicates if the user canceled their quit
- * @var integer
+ * @var int
*/
public $cancelQuit = 0;
/**
* timestamp at which the user quit
- * @var integer
+ * @var int
*/
public $quitStarted = 0;
/**
* indicates if the user wants to connect github
- * @var integer
+ * @var int
*/
public $githubConnect = 0;
/**
* indicates if the user wants to disconnect github
- * @var integer
+ * @var int
*/
public $githubDisconnect = 0;
/**
* indicates if the user wants to connect twitter
- * @var integer
+ * @var int
*/
public $twitterConnect = 0;
/**
* indicates if the user wants to disconnect twitter
- * @var integer
+ * @var int
*/
public $twitterDisconnect = 0;
/**
* indicates if the user wants to connect facebook
- * @var integer
+ * @var int
*/
public $facebookConnect = 0;
/**
* indicates if the user wants to disconnect facebook
- * @var integer
+ * @var int
*/
public $facebookDisconnect = 0;
/**
* indicates if the user wants to connect google
- * @var integer
+ * @var int
*/
public $googleConnect = 0;
/**
* indicates if the user wants to disconnect google
- * @var integer
+ * @var int
*/
public $googleDisconnect = 0;
/**
* recipient id
- * @var integer
+ * @var int
*/
public $recipientID = 0;
class EmailActivationForm extends AbstractForm {
/**
* user id
- * @var integer
+ * @var int
*/
public $userID = null;
/**
* activation code
- * @var integer
+ * @var int
*/
public $activationCode = '';
/**
* object id for attachments
- * @var integer
+ * @var int
*/
public $attachmentObjectID = 0;
/**
* parent object id for attachments
- * @var integer
+ * @var int
*/
public $attachmentParentObjectID = 0;
/**
* content language id
- * @var integer
+ * @var int
*/
public $languageID;
/**
* maximum text length
- * @var integer
+ * @var int
*/
public $maxTextLength = 0;
/**
* user id
- * @var integer
+ * @var int
*/
public $userID = 0;
/**
* min number of seconds between form request and submit
- * @var integer
+ * @var int
*/
public static $minRegistrationTime = 10;
}
/**
- * @return integer[]
+ * @return int[]
* @since 5.2
*/
protected function getRecipientsForNotificationEvent() {
/**
* end date
- * @var integer
+ * @var int
*/
public $endDate = '';
/**
* search id used for modification
- * @var integer
+ * @var int
*/
public $modifySearchID = 0;
/**
* require exact matches
- * @var integer
+ * @var int
*/
public $nameExactly = 1;
/**
* user id
- * @var integer
+ * @var int
*/
public $userID = 0;
/**
* search id
- * @var integer
+ * @var int
*/
public $searchID = 0;
/**
* start date
- * @var integer
+ * @var int
*/
public $startDate = '';
/**
* search for subject only
- * @var integer
+ * @var int
*/
public $subjectOnly = 0;
/**
* Returns user ids.
*
- * @return integer[]
+ * @return int[]
*/
public function getUserIDs() {
$userIDs = [];
/**
* list of content language ids
- * @var integer[]
+ * @var int[]
*/
public $contentLanguageIDs = [];
/**
* language id
- * @var integer
+ * @var int
*/
public $languageID = 0;
/**
* style id
- * @var integer
+ * @var int
*/
public $styleID = 0;
/**
* special trophies
- * @var integer[]
+ * @var int[]
*/
public $specialTrophies = [];
/**
* matches
- * @var integer[]
+ * @var int[]
*/
public $matches = [];
/**
* search id
- * @var integer
+ * @var int
*/
public $searchID = 0;
/**
* number of results
- * @var integer
+ * @var int
*/
public $maxResults = 1000;
/**
* article content id
- * @var integer
+ * @var int
*/
public $articleContentID = 0;
/**
* parsed contents of $_REQUEST['id']
- * @var integer[]
+ * @var int[]
*/
public $objectIDs = [];
/**
* id of the category the listed articles belong to
- * @var integer
+ * @var int
*/
public $categoryID = 0;
/**
* label filter
- * @var integer[]
+ * @var int[]
*/
public $labelIDs = [];
/**
* display 'Add Article' dialog on load
- * @var integer
+ * @var int
*/
public $showArticleAddDialog = 0;
/**
* comment object type id
- * @var integer
+ * @var int
*/
public $commentObjectTypeID = 0;
/**
* attachment id
- * @var integer
+ * @var int
*/
public $attachmentID = 0;
/**
* id of the category the listed articles belong to
- * @var integer
+ * @var int
*/
public $categoryID = 0;
public $content;
/**
- * @var integer
+ * @var int
*/
public $languageID;
public $page;
/**
- * @var integer
+ * @var int
*/
public $pageID;
/**
* left / old version id
- * @var integer
+ * @var int
*/
public $oldID = 0;
/**
* right / new version id
- * @var integer
+ * @var int
*/
public $newID = 0;
/**
* id of the requested object
- * @var integer
+ * @var int
*/
public $objectID = 0;
/**
* Returns the parent object id.
*
- * @return integer
+ * @return int
*/
public function getParentObjectID();
/**
* Returns the object id.
*
- * @return integer
+ * @return int
*/
public function getObjectID();
}
/**
* id of the requested media file
- * @var integer
+ * @var int
*/
public $mediaID = 0;
/**
* id of a user search
- * @var integer
+ * @var int
*/
public $searchID = 0;
class ModerationListPage extends SortablePage {
/**
* assigned user id
- * @var integer
+ * @var int
*/
public $assignedUserID = -1;
/**
* definition id for filtering
- * @var integer
+ * @var int
*/
public $definitionID = 0;
/**
* status bit
- * @var integer
+ * @var int
*/
public $status = -1;
abstract class MultipleLinkPage extends AbstractPage {
/**
* current page number
- * @var integer
+ * @var int
*/
public $pageNo = 0;
/**
* number of all pages
- * @var integer
+ * @var int
*/
public $pages = 0;
/**
* number of items shown per page
- * @var integer
+ * @var int
*/
public $itemsPerPage = 20;
/**
* number of all items
- * @var integer
+ * @var int
*/
public $items = 0;
/**
* indicates the range of the listed items
- * @var integer
+ * @var int
*/
public $startIndex = 0;
/**
* indicates the range of the listed items.
- * @var integer
+ * @var int
*/
public $endIndex = 0;
/**
* Counts the displayed items.
*
- * @return integer
+ * @return int
*/
public function countItems() {
// call countItems event
/**
* search id
- * @var integer
+ * @var int
*/
public $searchID = 0;
/**
* tag id
- * @var integer
+ * @var int
*/
public $tagID = 0;
/**
* user id
- * @var integer
+ * @var int
*/
public $userID = 0;
class MetaTagHandler extends SingletonFactory implements \Countable, \Iterator {
/**
* current iterator index
- * @var integer
+ * @var int
*/
protected $index = 0;
/**
* list of index to object relation
- * @var integer[]
+ * @var int[]
*/
protected $indexToObject = [];
/**
* indicates that no modifier is applied
- * @var integer
+ * @var int
*/
const MODIFIER_NONE = 0;
/**
* indicates case insensitive matching
- * @var integer
+ * @var int
*/
const CASE_INSENSITIVE = 1;
/**
* indicates ungreedy matching
- * @var integer
+ * @var int
*/
const UNGREEDY = 2;
/**
* indicates that no extra time is spent on analysing
- * @var integer
+ * @var int
*/
const NO_ANALYSE = 8;
/**
* indicates that whitespaces are ignored in regex
- * @var integer
+ * @var int
*/
const IGNORE_WHITESPACE = 16;
/**
* indicates that a dot matches every char
- * @var integer
+ * @var int
*/
const DOT_ALL = 32;
/**
* indicates that ^/$ match start and end of a line instead of the whole string
- * @var integer
+ * @var int
*/
const MULTILINE = 64;
/**
* indicates that pattern string is treated as UTF-8.
- * @var integer
+ * @var int
*/
const UTF_8 = 128;
/**
* indicates that no flags are set
- * @var integer
+ * @var int
*/
const FLAGS_NONE = 0;
/**
* indicates that default flags are set
- * @var integer
+ * @var int
*/
const FLAGS_DEFAULT = 1;
/**
* captures the offset of an match (all excluding replace)
- * @var integer
+ * @var int
*/
const CAPTURE_OFFSET = 2;
/**
* indicates default pattern ordering (match all only)
- * @var integer
+ * @var int
*/
const ORDER_MATCH_BY_PATTERN = 4;
/**
* indicates alternative set ordering (match all only)
- * @var integer
+ * @var int
*/
const ORDER_MATCH_BY_SET = 8;
/**
* indicates that only non-empty pieces will be splitted (split only)
- * @var integer
+ * @var int
*/
const SPLIT_NON_EMPTY_ONLY = 16;
/**
* indicates that the split delimiter is returned as well (split only)
- * @var integer
+ * @var int
*/
const CAPTURE_SPLIT_DELIMITER = 32;
* Creates a regex.
*
* @param string $regex
- * @param integer $modifier
+ * @param int $modifier
*/
public function __construct($regex, $modifier = self::MODIFIER_NONE) {
// escape delimiter
*
* @param string $string string to match
* @param boolean $all indicates if all matches are collected
- * @param integer $flags match flags
- * @return integer return value of preg_match(_all)
+ * @param int $flags match flags
+ * @return int return value of preg_match(_all)
*/
public function match($string, $all = false, $flags = self::FLAGS_DEFAULT) {
$matchFlags = 0;
* Splits the string with the regex.
*
* @param string $string
- * @param integer $flags
+ * @param int $flags
* @return string[]
*/
public function split($string, $flags = self::FLAGS_DEFAULT) {
class WCF {
/**
* list of supported legacy API versions
- * @var integer[]
+ * @var int[]
* @deprecated 5.2
*/
private static $supportedLegacyApiVersions = [2017, 2018];
/**
* Turns PHP errors into an ErrorException.
*
- * @param integer $severity
+ * @param int $severity
* @param string $message
* @param string $file
- * @param integer $line
+ * @param int $line
* @throws ErrorException
*/
public static final function handleError($severity, $message, $file, $line) {
/**
* Loads an application on runtime, do not use this outside the package installation.
*
- * @param integer $packageID
+ * @param int $packageID
*/
public static function loadRuntimeApplication($packageID) {
$package = new Package($packageID);
/**
* Changes the active language.
*
- * @param integer $languageID
+ * @param int $languageID
*/
public static final function setLanguage($languageID) {
if (!$languageID || LanguageFactory::getInstance()->getLanguage($languageID) === null) {
/**
* Returns number of available updates.
*
- * @return integer
+ * @return int
*/
public function getAvailableUpdates() {
$data = PackageUpdateCacheBuilder::getInstance()->getData();
/**
* Returns true if the given API version is currently supported.
*
- * @param integer $apiVersion
+ * @param int $apiVersion
* @return boolean
* @deprecated 5.2
*/
/**
* Returns the list of supported legacy API versions.
*
- * @return integer[]
+ * @return int[]
* @deprecated 5.2
*/
public static function getSupportedLegacyApiVersions() {
/**
* Calculates the current state of the progress bar.
*
- * @param integer $currentStep
+ * @param int $currentStep
*/
protected function calcProgress($currentStep) {
// calculate progress
* which will be created in the next step.
*
* @param \wcf\system\database\Database $db
- * @param integer $dbNumber
+ * @param int $dbNumber
* @return string[] list of already existing tables
*/
protected function getConflictedTables($db, $dbNumber) {
class ACLHandler extends SingletonFactory {
/**
* indicates if assignment of variables is disabled
- * @var integer
+ * @var int
*/
protected $assignVariablesDisabled = false;
/**
* Assigns the acl values to the template.
*
- * @param integer $objectTypeID
+ * @param int $objectTypeID
*/
public function assignVariables($objectTypeID) {
if (WCF::getTPL()->get('aclValues') === null) {
* Note: This method primarily only exists for form builder. If you are not
* using form builder, you do not need this method.
*
- * @param integer $objectTypeID
+ * @param int $objectTypeID
* @param array|null $valuesSource array used to read the values from (if `null`, `$_POST['aclValues']` is used)
* @since 5.2
*/
* Note: This method primarily only exists for form builder. If you are not
* using form builder, you do not need this method.
*
- * @param integer $objectTypeID
+ * @param int $objectTypeID
* @since 5.2
*/
public function resetValues($objectTypeID) {
* Returns the id of the given acl object type.
*
* @param string $objectType
- * @return integer
+ * @return int
* @throws SystemException
*/
public function getObjectTypeID($objectType) {
* Returns the acl option category with the given object type id and name
* or `null` if no such category exists.
*
- * @param integer $objectTypeID
+ * @param int $objectTypeID
* @param string $categoryName
* @return ACLOptionCategory|null
*/
/**
* Saves acl for a given object.
*
- * @param integer $objectID
- * @param integer $objectTypeID
+ * @param int $objectID
+ * @param int $objectTypeID
*/
public function save($objectID, $objectTypeID) {
// get options
*
* @param ACLOptionList $optionList
* @param string $type
- * @param integer $objectID
+ * @param int $objectID
*/
protected function replaceValues(ACLOptionList $optionList, $type, $objectID) {
$options = $optionList->getObjects();
/**
* Returns a list of permissions by object type id.
*
- * @param integer $objectTypeID
+ * @param int $objectTypeID
* @param array $objectIDs
* @param string $categoryName
* @param boolean $settingsView
/**
* Returns a list of options by object type id.
*
- * @param integer $objectTypeID
+ * @param int $objectTypeID
* @param string $categoryName
* @return ACLOptionList
*/
/**
* Removes ACL values from database.
*
- * @param integer $objectTypeID
- * @param integer[] $objectIDs
+ * @param int $objectTypeID
+ * @param int[] $objectIDs
* @param ACLOptionCategory $category
*/
public function removeValues($objectTypeID, array $objectIDs, ACLOptionCategory $category = null) {
* Returns the object type id by object type.
*
* @param string $objectType object type name
- * @return integer object type id
+ * @return int object type id
* @throws \InvalidArgumentException
*/
public function getObjectTypeID($objectType) {
* Returns the user and group values for provided object type and object id.
*
* @param string $objectType object type name
- * @param integer $objectID object id
+ * @param int $objectID object id
* @return array array containing the keys `allowAll`, `user` and `group`
*/
public function getValues($objectType, $objectID) {
* Sets the user and group values for provided object type and object id.
*
* @param string $objectType object type name
- * @param integer $objectID object id
+ * @param int $objectID object id
* @param array $values list of user and group ids
* @throws \InvalidArgumentException
*/
* one of its group is allowed.
*
* @param string $objectType object type name
- * @param integer $objectID object id
+ * @param int $objectID object id
* @param User|null $user user object, if `null` uses current user
* @return boolean false if user is not allowed
*/
/**
* evaluation end date, `0` to disable
- * @var integer
+ * @var int
*/
protected $evaluationEndDate = 0;
/**
* WoltLab Plugin-Store file id
- * @var integer
+ * @var int
*/
protected $evaluationPluginStoreID = 0;
/**
* application's package id
- * @var integer
+ * @var int
*/
protected $packageID = 0;
* Returns an application delivered by the package with the given id or `null`
* if no such application exists.
*
- * @param integer $packageID package id
+ * @param int $packageID package id
* @return Application|null application object
* @since 3.0
*/
/**
* Returns abbreviation for a given package id or `null` if application is unknown.
*
- * @param integer $packageID unique package id
+ * @param int $packageID unique package id
* @return string|null
*/
public function getAbbreviation($packageID) {
* Returns the timestamp at which the evaluation period ends for this application. The
* special value `0` indicates that there is no active evaluation period at this time.
*
- * @return integer
+ * @return int
*/
public function getEvaluationEndDate();
* Returns the id of the WoltLab Plugin-Store file where this app is for purchase. The
* special value `0` indicates that there is no such file or it is a WoltLab app.
*
- * @return integer
+ * @return int
*/
public function getEvaluationPluginStoreID();
/**
* object id
- * @var integer
+ * @var int
*/
protected $objectID = 0;
/**
* parent object id
- * @var integer
+ * @var int
*/
protected $parentObjectID = 0;
* Creates a new AttachmentHandler object.
*
* @param string $objectType
- * @param integer $objectID
+ * @param int $objectID
* @param string $tmpHash
- * @param integer $parentObjectID
+ * @param int $parentObjectID
* @throws SystemException
*/
public function __construct($objectType, $objectID, $tmpHash = '', $parentObjectID = 0) {
/**
* Sets the object id of temporary saved attachments.
*
- * @param integer $objectID
+ * @param int $objectID
*/
public function updateObjectID($objectID) {
$conditions = new PreparedStatementConditionBuilder();
* Transfers attachments to a different object id of the same type (e.g. merging content)
*
* @param string $objectType
- * @param integer $newObjectID
- * @param integer[] $oldObjectIDs
+ * @param int $newObjectID
+ * @param int[] $oldObjectIDs
*/
public static function transferAttachments($objectType, $newObjectID, array $oldObjectIDs) {
$conditions = new PreparedStatementConditionBuilder();
* Removes all attachments for given object ids by type.
*
* @param string $objectType
- * @param integer[] $objectIDs
+ * @param int[] $objectIDs
*/
public static function removeAttachments($objectType, array $objectIDs) {
$attachmentList = new AttachmentList();
* Returns the id of the object the handled attachments belong to. If the object does not
* exist (yet), `0` is returned.
*
- * @return integer
+ * @return int
* @since 5.2
*/
public function getObjectID() {
* Returns the id of the parent object of the object the handled attachments belong to.
* If no such parent object exists, `0` is returned.
*
- * @return integer
+ * @return int
* @since 5.2
*/
public function getParentObjectID() {
/**
* Returns true if the active user has the permission to download attachments.
*
- * @param integer $objectID
+ * @param int $objectID
* @return boolean
*/
public function canDownload($objectID);
* Returns true if the active user has the permission to view attachment
* previews (thumbnails).
*
- * @param integer $objectID
+ * @param int $objectID
* @return boolean
*/
public function canViewPreview($objectID);
/**
* Returns true if the active user has the permission to upload attachments.
*
- * @param integer $objectID
- * @param integer $parentObjectID
+ * @param int $objectID
+ * @param int $parentObjectID
* @return boolean
*/
public function canUpload($objectID, $parentObjectID = 0);
/**
* Returns true if the active user has the permission to delete attachments.
*
- * @param integer $objectID
+ * @param int $objectID
* @return boolean
*/
public function canDelete($objectID);
/**
* Returns the maximum filesize for an attachment.
*
- * @return integer
+ * @return int
*/
public function getMaxSize();
/**
* Returns the maximum number of attachments.
*
- * @return integer
+ * @return int
*/
public function getMaxCount();
/**
* Returns the container object of an attachment or `null` if the container object does not exist.
*
- * @param integer $objectID
+ * @param int $objectID
* @return IUserContent|null
*/
public function getObject($objectID);
/**
* Caches the data of the given container objects.
*
- * @param integer[] $objectIDs
+ * @param int[] $objectIDs
*/
public function cacheObjects(array $objectIDs);
/**
* active object id
- * @var integer
+ * @var int
* @deprecated
*/
protected static $objectID = 0;
/**
* Sets the active object id.
*
- * @param integer $objectID
+ * @param int $objectID
* @deprecated
*/
public static function setObjectID($objectID) {
/**
* number of executed sql queries
- * @var integer
+ * @var int
*/
protected $queryCount = 0;
* Starts a benchmark.
*
* @param string $text
- * @param integer $type
- * @return integer index
+ * @param int $type
+ * @return int index
*/
public function start($text, $type = self::TYPE_OTHER) {
$newIndex = count($this->items);
* Stops the benchmark with the given index. If no index is given, the
* latest benchmark is stopped.
*
- * @param integer $index
+ * @param int $index
*/
public function stop($index = null) {
if ($index === null) {
/**
* Returns the number of executed sql queries.
*
- * @return integer
+ * @return int
*/
public function getQueryCount() {
return $this->queryCount;
/**
* default limit value for the maximum number of shown database objects
* if this property is null, setting a limit is disabled
- * @var integer
+ * @var int
*/
public $defaultLimit;
/**
* limit value for the maximum number of shown database objects
- * @var integer
+ * @var int
*/
public $limit;
/**
* maximum limit value, if `null` no maximum is set
- * @var integer
+ * @var int
*/
public $maximumLimit;
/**
* minimum limit value
- * @var integer
+ * @var int
*/
public $minimumLimit = 1;
/**
* Returns the box with the given id or `null` if it does not exist.
*
- * @param integer $boxID
+ * @param int $boxID
* @return Box|null
*/
public function getBox($boxID) {
/**
* Returns the list of boxes sorted by their global and page-local show order.
*
- * @param integer $pageID page id
+ * @param int $pageID page id
* @param boolean $forDisplay enables content loading and removes inaccessible boxes from view
* @return Box[][]
*/
/**
* Returns true if provided page id uses a custom box show order.
*
- * @param integer $pageID page id
+ * @param int $pageID page id
* @return boolean true if there is a custom show order for boxes
*/
public static function hasCustomShowOrder($pageID) {
/**
* Filters given user ids.
*
- * @param integer[] $userIDs
+ * @param int[] $userIDs
*/
protected function filterUserIDs(&$userIDs) {
// does nothing, can be overwritten by child classes
/**
* ids of the shown users loaded from cache
- * @var integer[]|null
+ * @var int[]|null
*/
public $userIDs;
* Replaces a breadcrumb, returns true if replacement was successful.
*
* @param Breadcrumb $item
- * @param integer $index
+ * @param int $index
* @deprecated 3.0
*/
public function replace(Breadcrumb $item, $index) {
/**
* Removes a breadcrumb, returns true if deletion was successful.
*
- * @param integer $index
+ * @param int $index
* @deprecated 3.0
*/
public function remove($index) {
/**
* ids of selected user groups
- * @var integer[]
+ * @var int[]
*/
public $userGroupIDs = [];
class SendMailUserBulkProcessingAction extends AbstractUserBulkProcessingAction {
/**
* is 1 if HTML for the email is enabled
- * @var integer
+ * @var int
*/
public $enableHTML = 0;
/**
* maximum cache lifetime in seconds, '0' equals infinite
- * @var integer
+ * @var int
*/
protected $maxLifetime = 0;
abstract class AbstractSortedUserCacheBuilder extends AbstractCacheBuilder {
/**
* default limit value if no limit parameter is provided
- * @var integer
+ * @var int
*/
protected $defaultLimit = 5;
/**
* Returns maximum lifetime for cache resource.
*
- * @return integer
+ * @return int
*/
public function getMaxLifetime();
/**
* language ids
- * @var integer
+ * @var int
*/
protected $languageIDs = [];
/**
* object type ids
- * @var integer
+ * @var int
*/
protected $objectTypeIDs = [];
/**
* Parses a list of language ids. If one given language id evaluates to '0' all ids will be discarded.
*
- * @param integer[] $parameters
- * @return integer[]
+ * @param int[] $parameters
+ * @return int[]
*/
protected function parseLanguageIDs(array $parameters) {
// handle special '0' value
*
* @param TagCloudTag $tagA
* @param TagCloudTag $tagB
- * @return integer
+ * @return int
*/
protected static function compareTags($tagA, $tagB) {
if ($tagA->counter > $tagB->counter) return -1;
/**
* ids of objects which will be fetched next
- * @var integer[]
+ * @var int[]
*/
protected $objectIDs = [];
* Caches the given object id so that during the next object fetch, the object with
* this id will also be fetched.
*
- * @param integer $objectID
+ * @param int $objectID
*/
public function cacheObjectID($objectID);
* Caches the given object ids so that during the next object fetch, the objects with
* these ids will also be fetched.
*
- * @param integer[] $objectIDs
+ * @param int[] $objectIDs
*/
public function cacheObjectIDs(array $objectIDs);
* If the given object id should not have been cached before, it will be cached
* during this method call and the object, if existing, will be returned.
*
- * @param integer $objectID
+ * @param int $objectID
* @return DatabaseObject|null
*/
public function getObject($objectID);
* If the given object ids should not have been cached before, they will be cached
* during this method call and the objects, if existing, will be returned.
*
- * @param integer[] $objectIDs
+ * @param int[] $objectIDs
* @return DatabaseObject[]
*/
public function getObjects(array $objectIDs);
/**
* Removes the object with the given id from the runtime cache if it has already been loaded.
*
- * @param integer $objectID
+ * @param int $objectID
*/
public function removeObject($objectID);
/**
* Removes the objects with the given ids from the runtime cache if they have already been loaded.
*
- * @param integer[] $objectIDs
+ * @param int[] $objectIDs
*/
public function removeObjects(array $objectIDs);
}
* Determines whether the cache needs to be rebuild or not.
*
* @param string $filename
- * @param integer $maxLifetime
+ * @param int $maxLifetime
* @return boolean
*/
protected function needRebuild($filename, $maxLifetime) {
* Returns a cached variable.
*
* @param string $cacheName
- * @param integer $maxLifetime
+ * @param int $maxLifetime
* @return mixed
*/
public function get($cacheName, $maxLifetime);
*
* @param string $cacheName
* @param mixed $value
- * @param integer $maxLifetime
+ * @param int $maxLifetime
*/
public function set($cacheName, $value, $maxLifetime);
}
/**
* Returns time to live in seconds, defaults to 3 days.
*
- * @param integer $maxLifetime
- * @return integer
+ * @param int $maxLifetime
+ * @return int
*/
protected function getTTL($maxLifetime = 0) {
// max lifetime is a timestamp -> http://www.php.net/manual/en/memcached.expiration.php
/**
* Returns time to live in seconds, defaults to 3 days.
*
- * @param integer $maxLifetime
- * @return integer
+ * @param int $maxLifetime
+ * @return int
*/
protected function getTTL($maxLifetime = 0) {
if ($maxLifetime) return $maxLifetime;
* Returns the captcha object type with the given id or `null` if no such
* object type exists.
*
- * @param integer $objectTypeID
+ * @param int $objectTypeID
* @return ObjectType|null
*/
public function getObjectType($objectTypeID) {
/**
* maximum category nesting label
- * @var integer
+ * @var int
*/
protected $maximumNestingLevel = -1;
/**
* category ids grouped by the object type they belong to
- * @var integer[][]
+ * @var int[][]
*/
protected $objectTypeCategoryIDs = [];
/**
* maps the names of the category object types to the object type ids
- * @var integer[]
+ * @var int[]
*/
protected $objectTypeIDs = [];
/**
* Returns the category with the given id or `null` if no such category exists.
*
- * @param integer $categoryID
+ * @param int $categoryID
* @return Category|null
*/
public function getCategory($categoryID) {
*
* The second parameter is only needed if $categoryID is 0.
*
- * @param integer $categoryID
- * @param integer $objectTypeID
+ * @param int $categoryID
+ * @param int $objectTypeID
* @return Category[]
* @throws SystemException
*/
/**
* Returns the category object type with the given id or `null` if no such object type exists.
*
- * @param integer $objectTypeID
+ * @param int $objectTypeID
* @return ObjectType|null
*/
public function getObjectType($objectTypeID) {
*
* @param Category $category
* @param User $user
- * @return integer[]
+ * @return int[]
*/
public function getPermissions(Category $category, User $user = null) {
if ($user === null) {
* Returns the maximum category nesting level for this type. "-1" means
* that there is no maximum.
*
- * @return integer
+ * @return int
*/
public function getMaximumNestingLevel();
/**
* user merge mode
- * @var integer
+ * @var int
*/
public $userMergeMode = 0;
/**
* Returns number of affected items.
*
- * @return integer
+ * @return int
*/
public function getCount() {
if (isset($this->parameters['objectIDs'])) {
/**
* page object id
- * @var integer
+ * @var int
*/
protected $pageObjectID = 0;
* Marks objects as marked.
*
* @param array $objectIDs
- * @param integer $objectTypeID
+ * @param int $objectTypeID
*/
public function mark(array $objectIDs, $objectTypeID) {
// remove existing entries first, prevents conflict with INSERT
* Removes an object marking.
*
* @param array $objectIDs
- * @param integer $objectTypeID
+ * @param int $objectTypeID
*/
public function unmark(array $objectIDs, $objectTypeID) {
$conditions = new PreparedStatementConditionBuilder();
/**
* Unmarks all items of given type.
*
- * @param integer $objectTypeID
+ * @param int $objectTypeID
*/
public function unmarkAll($objectTypeID) {
$sql = "DELETE FROM wcf".WCF_N."_clipboard_item
* clipboard object type exists.
*
* @param string $typeName
- * @return integer|null
+ * @return int|null
*/
public function getObjectTypeID($typeName) {
if (isset($this->cache['objectTypeNames'][$typeName])) {
* Returns the clipboard object type with the given id or `null` if no such
* clipboard object type exists.
*
- * @param integer $objectTypeID
+ * @param int $objectTypeID
* @return ObjectType|null
*/
public function getObjectType($objectTypeID) {
* clipboard object type exists.
*
* @param string $objectType
- * @return integer|null
+ * @return int|null
*/
public function getObjectTypeByName($objectType) {
foreach ($this->cache['objectTypes'] as $objectTypeID => $objectTypeObj) {
/**
* Loads a list of marked items grouped by type name.
*
- * @param integer $objectTypeID
+ * @param int $objectTypeID
* @throws SystemException
*/
protected function loadMarkedItems($objectTypeID = null) {
/**
* Loads a list of marked items grouped by type name.
*
- * @param integer $objectTypeID
+ * @param int $objectTypeID
* @return array
*/
public function getMarkedItems($objectTypeID = null) {
* Returns the data of the items for clipboard editor or `null` if no items are marked.
*
* @param string|string[] $page
- * @param integer $pageObjectID
+ * @param int $pageObjectID
* @return array|null
* @throws ImplementationException
*/
/**
* Removes items from clipboard.
*
- * @param integer $typeID
+ * @param int $typeID
*/
public function removeItems($typeID = null) {
$conditions = new PreparedStatementConditionBuilder();
/**
* Returns true (1) if at least one item (of the given object type) is marked.
*
- * @param integer $objectTypeID
- * @return integer
+ * @param int $objectTypeID
+ * @return int
*/
public function hasMarkedItems($objectTypeID = null) {
if (!WCF::getUser()->userID) return 0;
/**
* Returns page object id.
*
- * @return integer
+ * @return int
*/
public function getPageObjectID() {
return $this->pageObjectID;
/**
* Returns the ids of the articles that can be deleted.
*
- * @return integer[]
+ * @return int[]
*/
public function validateDelete() {
$objectIDs = [];
/**
* Returns the ids of the articles that can be published.
*
- * @return integer[]
+ * @return int[]
*/
public function validatePublish() {
$objectIDs = [];
/**
* Returns the ids of the articles that can be restored.
*
- * @return integer[]
+ * @return int[]
*/
public function validateRestore() {
return $this->validateDelete();
/**
* Returns the ids of the articles whose category can be set.
*
- * @return integer[]
+ * @return int[]
*/
public function validateSetCategory() {
if (!WCF::getSession()->getPermission('admin.content.article.canManageArticle')) {
/**
* Returns the ids of the articles that can be trashed.
*
- * @return integer[]
+ * @return int[]
*/
public function validateTrash() {
$objectIDs = [];
/**
* Returns the ids of the articles that can be unpublished.
*
- * @return integer[]
+ * @return int[]
*/
public function validateUnpublish() {
$objectIDs = [];
/**
* Returns the ids of the media files which can be deleted.
*
- * @return integer[]
+ * @return int[]
*/
public function validateDelete() {
if (!WCF::getSession()->getPermission('admin.content.cms.canManageMedia')) {
/**
* Returns the ids of the media files which can be inserted.
*
- * @return integer[]
+ * @return int[]
*/
public function validateInsert() {
return array_keys($this->objects);
/**
* Returns the ids of the media files whose category can be set.
*
- * @return integer[]
+ * @return int[]
*/
public function validateSetCategory() {
if (!WCF::getSession()->getPermission('admin.content.cms.canManageMedia')) {
/**
* Returns the ids of the tags which can be deleted.
*
- * @return integer[]
+ * @return int[]
*/
protected function validateDelete() {
if (!WCF::getSession()->getPermission('admin.content.tag.canManageTag')) {
/**
* Returns the ids of the tags which can be set as synonyms.
*
- * @return integer[]
+ * @return int[]
*/
protected function validateSetAsSynonyms() {
if (!WCF::getSession()->getPermission('admin.content.tag.canManageTag')) {
/**
* Returns the ids of the users which can be deleted.
*
- * @return integer[]
+ * @return int[]
*/
protected function validateDelete() {
// check permissions
/**
* Returns the ids of the users which can be banned.
*
- * @return integer[]
+ * @return int[]
*/
protected function validateBan() {
// check permissions
/**
* Validates accessible groups.
*
- * @param integer[] $userIDs
+ * @param int[] $userIDs
* @param boolean $ignoreOwnUser
- * @return integer[]
+ * @return int[]
*/
protected function __validateAccessibleGroups(array $userIDs, $ignoreOwnUser = true) {
if ($ignoreOwnUser) {
/**
* Returns the ids of the users which can be marked as email confirmed.
*
- * @return integer[]
+ * @return int[]
* @since 5.3
*/
protected function validateConfirmEmail() {
/**
* Returns the ids of the users which can be unmarked as email confirmed.
*
- * @return integer[]
+ * @return int[]
* @since 5.3
*/
protected function validateUnconfirmEmail() {
/**
* Returns the ids of the users which can be sent new passwords.
*
- * @return integer[]
+ * @return int[]
*/
public function validateSendNewPassword() {
// check permissions
/**
* Returns the ids of the users which can be enabled.
*
- * @return integer[]
+ * @return int[]
* @since 3.0
*/
protected function validateEnable() {
/**
* Returns the ids of the users which can be merge.
*
- * @return integer[]
+ * @return int[]
* @since 3.0
*/
protected function validateMerge() {
/**
* Returns the ids of the users which aren't activated.
*
- * @return integer[]
+ * @return int[]
* @since 5.2
*/
protected function validateResendActivationMail() {
/**
* Returns the ids of the users whose contents can be deleted.
*
- * @return integer[]
+ * @return int[]
* @since 5.4
*/
protected function validateDeleteUserContent() {
/**
* Returns the ids of the users whose edits can be reverted.
*
- * @return integer[]
+ * @return int[]
*/
protected function validateRevertContentChanges() {
if (!MODULE_EDIT_HISTORY) {
* such object type exists.
*
* @param string $objectType
- * @return integer|null
+ * @return int|null
*/
public function getObjectTypeID($objectType) {
if (isset($this->cache['objectTypeIDs'][$objectType])) {
* Returns the comment object type with the given name or `null` if no such
* object type exists.
*
- * @param integer $objectTypeID
+ * @param int $objectTypeID
* @return ObjectType|null
*/
public function getObjectType($objectTypeID) {
* Returns a comment list for a given object type and object id.
*
* @param ICommentManager $commentManager
- * @param integer $objectTypeID
- * @param integer $objectID
+ * @param int $objectTypeID
+ * @param int $objectID
* @param boolean $readObjects
* @return StructuredCommentList
*/
* Removes all comments for given objects.
*
* @param string $objectType
- * @param integer[] $objectIDs
+ * @param int[] $objectIDs
*/
public function deleteObjects($objectType, array $objectIDs) {
$objectTypeID = $this->getObjectTypeID($objectType);
* the given ids as confirmed for the active user.
*
* @param string $objectType comment object type name
- * @param integer[] $objectIDs ids of the objects whose comment-related notifications will be marked as confirmed
- * @param integer $time only notifications older than the given timestamp will be marked as confirmed
+ * @param int[] $objectIDs ids of the objects whose comment-related notifications will be marked as confirmed
+ * @param int $time only notifications older than the given timestamp will be marked as confirmed
* @throws \InvalidArgumentException if invalid comment object type name is given
* @since 5.2
*/
abstract class AbstractCommentManager extends SingletonFactory implements ICommentManager {
/**
* display comments per page
- * @var integer
+ * @var int
*/
public $commentsPerPage = 30;
/**
* Returns the object ID for the given Comment or CommentResponse.
*
- * @return integer
+ * @return int
*/
protected final function getObjectID($commentOrResponse) {
if ($commentOrResponse instanceof CommentResponse || ($commentOrResponse instanceof DatabaseObjectDecorator && $commentOrResponse->getDecoratedObject() instanceof CommentResponse)) {
/**
* Returns true if the current user may add comments or responses.
*
- * @param integer $objectID
+ * @param int $objectID
* @return boolean
*/
public function canAdd($objectID);
/**
* Returns true if a comment requires approval.
*
- * @param integer $objectID
+ * @param int $objectID
* @return boolean
*/
public function canAddWithoutApproval($objectID);
* Returns true if the current user may moderated content identified by
* object type id and object id.
*
- * @param integer $objectTypeID
- * @param integer $objectID
+ * @param int $objectTypeID
+ * @param int $objectID
* @return boolean
*/
public function canModerate($objectTypeID, $objectID);
/**
* Returns the amount of comments per page.
*
- * @return integer
+ * @return int
*/
public function getCommentsPerPage();
/**
* Returns a link to the commented object with the given object type id and object id.
*
- * @param integer $objectTypeID
- * @param integer $objectID
+ * @param int $objectTypeID
+ * @param int $objectID
* @return string
*/
public function getLink($objectTypeID, $objectID);
/**
* Returns the title for a comment or response.
*
- * @param integer $objectTypeID
- * @param integer $objectID
+ * @param int $objectTypeID
+ * @param int $objectID
* @param boolean $isResponse
* @return string
*/
* Returns true if comments and responses for given object id are accessible
* by current user.
*
- * @param integer $objectID
+ * @param int $objectID
* @param boolean $validateWritePermission
* @return boolean
*/
/**
* Updates total count of comments (includes responses).
*
- * @param integer $objectID
- * @param integer $value
+ * @param int $objectID
+ * @param int $value
*/
public function updateCounter($objectID, $value);
/**
* is `1` if the checkbox is checked
- * @var integer
+ * @var int
*/
protected $fieldValue = 0;
abstract class AbstractIntegerCondition extends AbstractSingleFieldCondition {
/**
* property value has to be greater than the given value
- * @var integer
+ * @var int
*/
protected $greaterThan = null;
/**
* property value has to be less than the given value
- * @var integer
+ * @var int
*/
protected $lessThan = null;
/**
* maximum value the property can have
- * @var integer
+ * @var int
*/
protected $maxValue = null;
/**
* minimum value the property can have
- * @var integer
+ * @var int
*/
protected $minValue = null;
* Returns the maximum value the property can have or `null` if there is no
* such maximum.
*
- * @return integer|null
+ * @return int|null
*/
protected function getMaxValue() {
if ($this->getDecoratedObject()->maxvalue !== null) {
* Returns the minimum value the property can have or `null` if there is no
* such minimum.
*
- * @return integer|null
+ * @return int|null
*/
protected function getMinValue() {
if ($this->getDecoratedObject()->minvalue !== null) {
* Creates condition objects for the object with the given id and based
* on the given condition object types.
*
- * @param integer $objectID
+ * @param int $objectID
* @param ObjectType[] $conditionObjectTypes
*/
public function createConditions($objectID, array $conditionObjectTypes) {
* Deletes all conditions of the objects with the given ids.
*
* @param string $definitionName
- * @param integer[] $objectIDs
+ * @param int[] $objectIDs
* @throws SystemException
*/
public function deleteConditions($definitionName, array $objectIDs) {
* object type definition and object id.
*
* @param string $definitionName
- * @param integer $objectID
+ * @param int $objectID
* @return Condition[]
* @throws SystemException
*/
/**
* Updates the conditions for the object with the given object id.
*
- * @param integer $objectID
+ * @param int $objectID
* @param Condition[] $oldConditions
* @param ObjectType[] $conditionObjectTypes
*/
/**
* value of the "user has no avatar" option
- * @var integer
+ * @var int
*/
const NO_AVATAR = 0;
/**
* value of the "user has a custom avatar" option
- * @var integer
+ * @var int
*/
const AVATAR = 1;
/**
* value of the "user has a gravatar" option
- * @var integer
+ * @var int
*/
const GRAVATAR = 2;
class UserBirthdayCondition extends AbstractCondition implements IContentCondition {
/**
* 1 if birthday today checkbox is checked
- * @var integer
+ * @var int
*/
protected $birthdayToday = 0;
/**
* value of the "user has no cover photo" option
- * @var integer
+ * @var int
*/
const NO_COVER_PHOTO = 0;
/**
* value of the "user has a cover photo" option
- * @var integer
+ * @var int
*/
const COVER_PHOTO = 1;
/**
* ids of the selected user groups the user has to be member of
- * @var integer[]
+ * @var int[]
*/
protected $groupIDs = [];
/**
* ids of the selected user groups the user may not be member of
- * @var integer[]
+ * @var int[]
*/
protected $notGroupIDs = [];
/**
* ids of the selected languages
- * @var integer[]
+ * @var int[]
*/
protected $languageIDs = [];
/**
* 1 if mobile browser checkbox is checked
- * @var integer
+ * @var int
*/
protected $usesMobileBrowser = 0;
/**
* 1 if not use mobile browser checkbox is checked
- * @var integer
+ * @var int
*/
protected $usesNoMobileBrowser = 0;
/**
* 1 if multifactor active checkbox is checked
- * @var integer
+ * @var int
*/
protected $multifactorActive = 0;
/**
* 1 if multifactor not active checkbox is checked
- * @var integer
+ * @var int
*/
protected $multifactorNotActive = 0;
/**
* value of the "user has no signature" option
- * @var integer
+ * @var int
*/
const NO_SIGNATURE = 0;
/**
* value of the "user has a signature" option
- * @var integer
+ * @var int
*/
const SIGNATURE = 1;
/**
* true if the the user has to be banned
- * @var integer
+ * @var int
*/
protected $userIsBanned = 0;
/**
* true if the user has to be disabled
- * @var integer
+ * @var int
*/
protected $userIsDisabled = 0;
/**
* true if the user has to be enabled
- * @var integer
+ * @var int
*/
protected $userIsEnabled = 0;
/**
* true if the the user may not be banned
- * @var integer
+ * @var int
*/
protected $userIsNotBanned = 0;
/**
* true if the the user has confirmed their email address
*
- * @var integer
+ * @var int
*/
protected $userIsEmailConfirmed = 0;
/**
* true if the the user has not confirmed their email address
- * @var integer
+ * @var int
*/
protected $userIsNotEmailConfirmed = 0;
/**
* ids of the selected trophies the user has earned
- * @var integer[]
+ * @var int[]
*/
protected $userTrophyIDs = [];
/**
* ids of the selected trophies the user has not earned
- * @var integer[]
+ * @var int[]
*/
protected $notUserTrophyIDs = [];
class CronjobScheduler extends SingletonFactory {
/**
* cached times of the next and after next cronjob execution
- * @var integer[]
+ * @var int[]
*/
protected $cache = [];
/**
* Returns the next execution time.
*
- * @return integer
+ * @return int
*/
public function getNextExec() {
return $this->cache['nextExec'];
/**
* sql server post
- * @var integer
+ * @var int
*/
protected $port = 0;
/**
* number of executed queries
- * @var integer
+ * @var int
*/
protected $queryCount = 0;
/**
* amount of active transactions
- * @var integer
+ * @var int
*/
protected $activeTransactions = 0;
* @param string $user SQL database server username
* @param string $password SQL database server password
* @param string $database SQL database server database name
- * @param integer $port SQL database server port
+ * @param int $port SQL database server port
* @param boolean $failsafeTest
* @param boolean $tryToCreateDatabase
* @param array $defaultDriverOptions
*
* @param string $table
* @param string $field
- * @return integer
+ * @return int
* @throws DatabaseException
*/
public function getInsertID($table, $field) {
* Prepares a statement for execution and returns a statement object.
*
* @param string $statement
- * @param integer $limit
- * @param integer $offset
+ * @param int $limit
+ * @param int $offset
* @return PreparedStatement
* @throws DatabaseQueryException
*/
* Other database implementations should override this function.
*
* @param string $query
- * @param integer $limit
- * @param integer $offset
+ * @param int $limit
+ * @param int $offset
* @return string
*/
public function handleLimitParameter($query, $limit = 0, $offset = 0) {
/**
* Returns the number of the last error.
*
- * @return integer
+ * @return int
*/
public function getErrorNumber() {
if ($this->pdo !== null) return $this->pdo->errorCode();
/**
* Returns the amount of executed sql queries.
*
- * @return integer
+ * @return int
*/
public function getQueryCount() {
return $this->queryCount;
class DatabaseException extends SystemException {
/**
* error number
- * @var integer
+ * @var int
*/
protected $errorNumber = null;
/**
* Returns the error number of this exception.
*
- * @return integer
+ * @return int
*/
public function getErrorNumber() {
return $this->errorNumber;
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\System\Database
*
- * @method integer del($key1, $key2 = null, $key3 = null)
+ * @method int del($key1, $key2 = null, $key3 = null)
* @method boolean expire($key, $ttl)
* @method string|bool get($key)
- * @method integer hDel($key, $hashKey1, $hashKey2 = null, $hashKeyN = null)
+ * @method int hDel($key, $hashKey1, $hashKey2 = null, $hashKeyN = null)
* @method string hGet($key, $hashKey)
- * @method integer hSet($key, $hashKey, $value)
- * @method integer incr($key)
+ * @method int hSet($key, $hashKey, $value)
+ * @method int incr($key)
* @method string info($option = null)
* @method boolean setex($key, $ttl, $value)
* @method boolean setnx($key, $value)
- * @method integer ttl($key)
+ * @method int ttl($key)
*/
class Redis {
/**
/**
* Fetches the next row from a result set in an array.
*
- * @param integer $type fetch type
+ * @param int $type fetch type
* @return mixed
*/
public function fetchArray($type = null) {
* Note: It is not possible to fetch further rows after calling
* this method!
*
- * @param integer $type fetch type
+ * @param int $type fetch type
* @return mixed
* @see \wcf\system\database\statement\PreparedStatement::fetchArray()
*/
* Note: It is not possible to fetch further rows after calling
* this method!
*
- * @param integer $columnNumber
+ * @param int $columnNumber
* @return mixed
* @see \PDOStatement::fetchColumn()
*/
/**
* Counts number of affected rows by the last sql statement (INSERT, UPDATE or DELETE).
*
- * @return integer number of affected rows
+ * @return int number of affected rows
* @throws DatabaseQueryException
*/
public function getAffectedRows() {
/**
* Returns the number of the last error.
*
- * @return integer
+ * @return int
*/
public function getErrorNumber() {
if ($this->pdoStatement !== null) return $this->pdoStatement->errorCode();
* Returns the id of the object type with the given name.
*
* @param string $objectType
- * @return integer
+ * @return int
* @throws SystemException
*/
public function getObjectTypeID($objectType) {
* Adds a new entry.
*
* @param string $objectType
- * @param integer $objectID
+ * @param int $objectID
* @param string $message
- * @param integer $time
- * @param integer $userID
+ * @param int $time
+ * @param int $userID
* @param string $username
* @param string $editReason
- * @param integer $obsoletedByUserID The userID of the user that forced this entry to become outdated
+ * @param int $obsoletedByUserID The userID of the user that forced this entry to become outdated
*/
public function add($objectType, $objectID, $message, $time, $userID, $username, $editReason, $obsoletedByUserID) {
// no op, if edit history is disabled
* Deletes edit history entries.
*
* @param string $objectType
- * @param integer[] $objectIDs
+ * @param int[] $objectIDs
*/
public function delete($objectType, array $objectIDs) {
$objectTypeID = $this->getObjectTypeID($objectType);
/**
* Performs mass reverting of edits by the given users in the given timeframe.
*
- * @param integer[] $userIDs
- * @param integer $timeframe
+ * @param int[] $userIDs
+ * @param int $timeframe
*/
public function bulkRevert(array $userIDs, $timeframe = 86400) {
if (empty($userIDs)) return;
* mime part will be further down the email (see RFC 2046, 5.1.4).
*
* @param AbstractMimePart $part
- * @param integer $data The priority.
+ * @param int $data The priority.
* @throws \InvalidArgumentException
* @throws \DomainException
*/
/**
* port to use
- * @var integer
+ * @var int
*/
protected $port;
* Creates a new SmtpEmailTransport using the given host.
*
* @param string $host host of the smtp server to use
- * @param integer $port port to use
+ * @param int $port port to use
* @param string $username username to use for authentication
* @param string $password corresponding password
* @param string $starttls one of 'none', 'may' and 'encrypt'
* Reads a server reply and validates it against the given expected status codes.
* Returns a tuple [ status code, reply text ].
*
- * @param integer[] $expectedCodes
+ * @param int[] $expectedCodes
* @return array
* @throws PermanentFailure
* @throws TransientFailure
* Connects to the server and enables STARTTLS if available. Bails
* out if STARTTLS is not available and connection is set to 'encrypt'.
*
- * @param integer $overrideTimeout
+ * @param int $overrideTimeout
* @throws PermanentFailure
*/
protected function connect($overrideTimeout = null) {
*
* @param HtmlInputNodeProcessor $processor
* @param Regex $regex
- * @return integer[]
+ * @return int[]
*/
protected function getObjectIDs(HtmlInputNodeProcessor $processor, Regex $regex) {
$objectIDs = [];
class AJAXException extends LoggedException {
/**
* missing parameters
- * @var integer
+ * @var int
*/
const MISSING_PARAMETERS = 400;
/**
* session expired
- * @var integer
+ * @var int
*/
const SESSION_EXPIRED = 401;
/**
* insufficient permissions
- * @var integer
+ * @var int
*/
const INSUFFICIENT_PERMISSIONS = 403;
/**
* illegal link
- * @var integer
+ * @var int
*/
const ILLEGAL_LINK = 404;
/**
* bad parameters
- * @var integer
+ * @var int
*/
const BAD_PARAMETERS = 412;
/**
* internal server error
- * @var integer
+ * @var int
*/
const INTERNAL_ERROR = 503;
* Throws a JSON-encoded error message
*
* @param string $message
- * @param integer $errorType
+ * @param int $errorType
* @param string $stacktrace
* @param mixed[] $returnValues
* @param string $exceptionID
* Creates a new SystemException.
*
* @param string $message error message
- * @param integer $code error code
+ * @param int $code error code
* @param string $description description of the error
* @param \Exception $previous repacked Exception
*/
/**
* limits for items per run
- * @var integer[]
+ * @var int[]
*/
protected $limits = [];
/**
* default limit for items per run
- * @var integer
+ * @var int
*/
protected $defaultLimit = 1000;
*
* @param string $tableName
* @param string $columnName
- * @return integer
+ * @return int
*/
protected function __getMaxID($tableName, $columnName) {
$sql = "SELECT MAX(".$columnName.") AS maxID
* Counts the number of required loops for given type.
*
* @param string $objectType
- * @return integer
+ * @return int
*/
public function countLoops($objectType);
* Runs the data export.
*
* @param string $objectType
- * @param integer $loopCount
+ * @param int $loopCount
*/
public function exportData($objectType, $loopCount = 0);
/**
* size of the enclosure in bytes
- * @var integer
+ * @var int
*/
protected $length = 0;
*
* @param string $url url to the enclosure
* @param string $type enclosure's MIME type
- * @param integer $length size of the enclosure in bytes
+ * @param int $length size of the enclosure in bytes
*/
public function __construct($url, $type, $length) {
$this->url = $url;
/**
* Returns the size of the enclosure in bytes.
*
- * @return integer
+ * @return int
*/
public function getLength() {
return $this->length;
/**
* current iterator index
- * @var integer
+ * @var int
*/
protected $index = 0;
/**
* id of the previewed message
- * @var integer
+ * @var int
*/
protected $objectId = 0;
*
* By default, `0` is returned.
*
- * @return integer
+ * @return int
*/
public function getObjectId() {
return $this->objectId;
/**
* Sets the id of the previewed message and returns this button.
*
- * @param integer $objectId id of previewed message
+ * @param int $objectId id of previewed message
* @return WysiwygPreviewFormButton this button
*/
public function objectId($objectId) {
/**
* id of the edited object
- * @var integer
+ * @var int
*/
protected $objectId;
* By default, no attachment data is set.
*
* @param null|string $objectType name of attachment object type or `null` to unset previous attachment data
- * @param integer $parentObjectID id of the parent of the object the attachments belong to or `0` if no such parent exists
+ * @param int $parentObjectID id of the parent of the object the attachments belong to or `0` if no such parent exists
* @return WysiwygFormContainer this form container
* @throws \BadMethodCallException if the attachment form field has already been initialized
*/
/**
* Returns the id of the edited object or `0` if no object is edited.
*
- * @return integer
+ * @return int
*/
public function getObjectId() {
return $this->objectId;
* @param null|int $minimumLength minimum field value length
* @return static this field
*
- * @throws \InvalidArgumentException if the given minimum length is no integer or otherwise invalid
+ * @throws \InvalidArgumentException if the given minimum length is no int or otherwise invalid
*/
public function minimumLength($minimumLength = null);
/**
* Returns the sorted list of possible ratings used to generate the form field's html code.
*
- * @return integer[]
+ * @return int[]
*/
public function getRatings() {
if (WCF::getLanguage()->get('wcf.global.pageDirection') === 'rtl') {
* Sets the message context data.
*
* @param string $objectType object type identifier
- * @param integer $objectID object id
+ * @param int $objectID object id
* @throws InvalidObjectTypeException
*/
public function setContext($objectType, $objectID) {
*
* @param string $html html string
* @param string $objectType object type identifier
- * @param integer $objectID object id
+ * @param int $objectID object id
* @param boolean $convertFromBBCode interpret input as bbcode
*/
public function process($html, $objectType, $objectID = 0, $convertFromBBCode = false) {
*
* @param string $html html string
* @param string $objectType object type identifier
- * @param integer $objectID object id
+ * @param int $objectID object id
* @since 3.1
*/
public function reprocess($html, $objectType, $objectID) {
*
* @param string $html html string
* @param string $objectType object type identifier
- * @param integer $objectID object id
+ * @param int $objectID object id
* @throws \UnexpectedValueException
*/
public function processEmbeddedContent($html, $objectType, $objectID) {
/**
* Enforces the maximum depth of nested quotes.
*
- * @param integer $depth
+ * @param int $depth
*/
public function enforceQuoteDepth($depth) {
$this->getHtmlInputNodeProcessor()->enforceQuoteDepth($depth);
/**
* Sets the new object id.
*
- * @param integer $objectID object id
+ * @param int $objectID object id
*/
public function setObjectID($objectID) {
$this->context['objectID'] = $objectID;
class HtmlInputNodeImg extends AbstractHtmlInputNode {
/**
* number of found smilies
- * @var integer
+ * @var int
*/
protected $smiliesFound = 0;
/**
* Returns the number of smilies found within the message.
*
- * @return integer
+ * @return int
*/
public function getSmileyCount() {
return $this->smiliesFound;
/**
* Enforces the maximum depth of nested quotes.
*
- * @param integer $depth
+ * @param int $depth
*/
public function enforceQuoteDepth($depth) {
$quotes = [];
/**
* number of found smilies
- * @var integer
+ * @var int
*/
protected $smileyCount = 0;
* HtmlInputNodeTextParser constructor.
*
* @param HtmlInputNodeProcessor $htmlInputNodeProcessor
- * @param integer $smileyCount
+ * @param int $smileyCount
*/
public function __construct(HtmlInputNodeProcessor $htmlInputNodeProcessor, $smileyCount = 0) {
$this->htmlInputNodeProcessor = $htmlInputNodeProcessor;
/**
* content language id
- * @var integer
+ * @var int
*/
protected $languageID;
*
* @param string $html html string
* @param string $objectType object type identifier
- * @param integer $objectID object id
+ * @param int $objectID object id
* @param boolean $doKeywordHighlighting enable keyword highlighting
- * @param integer $languageID content language id
+ * @param int $languageID content language id
*/
public function process($html, $objectType, $objectID, $doKeywordHighlighting = true, $languageID = null) {
$this->languageID = $languageID;
* Sets the embedded object context.
*
* @param string $objectType object type identifier
- * @param integer $objectID object id
+ * @param int $objectID object id
*/
public function setContext($objectType, $objectID) {
MessageEmbeddedObjectManager::getInstance()->setActiveMessage($objectType, $objectID);
* Parses a message to identify any embedded content using simple placeholders.
*
* @param string $objectType object type identifier
- * @param integer $objectID object id
+ * @param int $objectID object id
* @param string $message message content
* @return boolean true if there is at least one embedded content found
*/
* Replaces simple placeholders with embedded content data.
*
* @param string $objectType object type identifier
- * @param integer $objectID object id
+ * @param int $objectID object id
* @param string $message message content
* @return string parsed and replaced string
*/
/**
* Returns the number of children.
*
- * @return integer
+ * @return int
*/
public function count() {
return count($this->children);
class GDImageAdapter implements IImageAdapter {
/**
* active color
- * @var integer
+ * @var int
*/
protected $color = null;
/**
* image height
- * @var integer
+ * @var int
*/
protected $height = 0;
/**
* image type
- * @var integer
+ * @var int
*/
protected $type = 0;
/**
* image width
- * @var integer
+ * @var int
*/
protected $width = 0;
*
* @param resource $dst_im destination image resource
* @param resource $src_im source image resource
- * @param integer $dst_x x-coordinate of destination point
- * @param integer $dst_y y-coordinate of destination point
- * @param integer $src_x x-coordinate of source point
- * @param integer $src_y y-coordinate of source point
- * @param integer $src_w source width
- * @param integer $src_h source height
- * @param integer $pct opacity percent
+ * @param int $dst_x x-coordinate of destination point
+ * @param int $dst_y y-coordinate of destination point
+ * @param int $src_x x-coordinate of source point
+ * @param int $src_y y-coordinate of source point
+ * @param int $src_w source width
+ * @param int $src_h source height
+ * @param int $pct opacity percent
* @return boolean
*/
private function imagecopymerge_alpha($dst_im, $src_im, $dst_x, $dst_y, $src_x, $src_y, $src_w, $src_h, $pct) { // phpcs:ignore
* Loads an image resource.
*
* @param mixed $image
- * @param integer $type
+ * @param int $type
*/
public function load($image, $type = 0);
/**
* Creates a new empty image.
*
- * @param integer $width
- * @param integer $height
+ * @param int $width
+ * @param int $height
*/
public function createEmptyImage($width, $height);
/**
* Creates a thumbnail from previously loaded image.
*
- * @param integer $maxWidth
- * @param integer $maxHeight
+ * @param int $maxWidth
+ * @param int $maxHeight
* @param boolean $preserveAspectRatio
* @return mixed
*/
/**
* Clips a part of currently loaded image, overwrites image resource within instance.
*
- * @param integer $originX
- * @param integer $originY
- * @param integer $width
- * @param integer $height
+ * @param int $originX
+ * @param int $originY
+ * @param int $width
+ * @param int $height
* @see \wcf\system\image\adapter\IImageAdapter::getImage()
*/
public function clip($originX, $originY, $width, $height);
/**
* Resizes an image with optional scaling, overwrites image resource within instance.
*
- * @param integer $originX
- * @param integer $originY
- * @param integer $originWidth
- * @param integer $originHeight
- * @param integer $targetWidth
- * @param integer $targetHeight
+ * @param int $originX
+ * @param int $originY
+ * @param int $originWidth
+ * @param int $originHeight
+ * @param int $targetWidth
+ * @param int $targetHeight
* @see \wcf\system\image\adapter\IImageAdapter::getImage()
*/
public function resize($originX, $originY, $originWidth, $originHeight, $targetWidth, $targetHeight);
/**
* Draws a rectangle, overwrites image resource within instance.
*
- * @param integer $startX
- * @param integer $startY
- * @param integer $endX
- * @param integer $endY
+ * @param int $startX
+ * @param int $startY
+ * @param int $endX
+ * @param int $endY
* @see \wcf\system\image\adapter\IImageAdapter::getImage()
* @see \wcf\system\image\adapter\IImageAdapter::setColor()
*/
* Draws a line of text, overwrites image resource within instance.
*
* @param string $text
- * @param integer $x
- * @param integer $y
+ * @param int $x
+ * @param int $y
* @param string $font path to TrueType font file
- * @param integer $size font size
+ * @param int $size font size
* @param float $opacity
* @see \wcf\system\image\adapter\IImageAdapter::getImage()
* @see \wcf\system\image\adapter\IImageAdapter::setColor()
*
* @param string $text
* @param string $position
- * @param integer $margin in pixels
- * @param integer $offsetX
- * @param integer $offsetY
+ * @param int $margin in pixels
+ * @param int $offsetX
+ * @param int $offsetY
* @param string $font path to TrueType font file
- * @param integer $size font size
+ * @param int $size font size
* @param float $opacity
*/
public function drawTextRelative($text, $position, $margin, $offsetX, $offsetY, $font, $size, $opacity = 1.0);
* Returns true if the given text fits the image.
*
* @param string $text
- * @param integer $margin
+ * @param int $margin
* @param string $font path to TrueType font file
- * @param integer $size font size
- * @return integer
+ * @param int $size font size
+ * @return int
* @return boolean
*/
public function textFitsImage($text, $margin, $font, $size);
* image. Returns 0 if no appropriate font size could be determined.
*
* @param string $text
- * @param integer $margin
+ * @param int $margin
* @param string $font path to TrueType font file
- * @param integer $size font size
- * @return integer
+ * @param int $size font size
+ * @return int
*/
public function adjustFontSize($text, $margin, $font, $size);
/**
* Sets active color.
*
- * @param integer $red
- * @param integer $green
- * @param integer $blue
+ * @param int $red
+ * @param int $green
+ * @param int $blue
*/
public function setColor($red, $green, $blue);
/**
* Sets a color to be transparent with alpha 0.
*
- * @param integer $red
- * @param integer $green
- * @param integer $blue
+ * @param int $red
+ * @param int $green
+ * @param int $blue
*/
public function setTransparentColor($red, $green, $blue);
/**
* Returns image width.
*
- * @return integer
+ * @return int
*/
public function getWidth();
/**
* Returns image height
*
- * @return integer
+ * @return int
*/
public function getHeight();
/**
* Returns the image type (GD only)
*
- * @return integer
+ * @return int
*/
public function getType();
* Overlays the given image at an absolute position.
*
* @param string $file
- * @param integer $x
- * @param integer $y
+ * @param int $x
+ * @param int $y
* @param float $opacity
*/
public function overlayImage($file, $x, $y, $opacity);
*
* @param string $file
* @param string $position
- * @param integer $margin
+ * @param int $margin
* @param float $opacity
*/
public function overlayImageRelative($file, $position, $margin, $opacity);
* Returns whether it is believed that sufficient memory
* is available to process an image with the given properties.
*
- * @param integer $width
- * @param integer $height
+ * @param int $width
+ * @param int $height
* @param string $mimeType
* @return boolean
*/
/**
* image height
- * @var integer
+ * @var int
*/
protected $height = 0;
/**
* image width
- * @var integer
+ * @var int
*/
protected $width = 0;
class AbstractACLImporter extends AbstractImporter {
/**
* object type id for options
- * @var integer
+ * @var int
*/
protected $objectTypeID = 0;
/**
* object type name
- * @var integer
+ * @var int
*/
protected $objectTypeName = '';
/**
* object type id for attachments
- * @var integer
+ * @var int
*/
protected $objectTypeID = 0;
* Replaces old attachment BBCodes with BBCodes with the new attachment id.
*
* @param string $message
- * @param integer $oldID
- * @param integer $newID
+ * @param int $oldID
+ * @param int $newID
* @return string|boolean
*/
protected function fixEmbeddedAttachments($message, $oldID, $newID) {
/**
* object type id for categories
- * @var integer
+ * @var int
*/
protected $objectTypeID = 0;
/**
* object type name
- * @var integer
+ * @var int
*/
protected $objectTypeName = '';
/**
* object type id for comments
- * @var integer
+ * @var int
*/
protected $objectTypeID = 0;
/**
* object type name
- * @var integer
+ * @var int
*/
protected $objectTypeName = '';
* Returns the language category id.
*
* @param string $languageCategory
- * @return integer
+ * @return int
*/
protected function getLanguageCategoryID($languageCategory) {
static $languageCategoryIDs = [];
/**
* object type id for likes
- * @var integer
+ * @var int
*/
protected $objectTypeID = 0;
/**
- * @var integer|null
+ * @var int|null
*/
protected static $dislikeReactionTypeID;
}
/**
- * @return integer
+ * @return int
*/
protected static function getDislikeReactionTypeID() {
if (self::$dislikeReactionTypeID === null) {
/**
* object type id for poll
- * @var integer
+ * @var int
*/
protected $objectTypeID = 0;
/**
* object type id for watched objects
- * @var integer
+ * @var int
*/
protected $objectTypeID = 0;
/**
* category for orphaned articles
- * @var integer
+ * @var int
*/
private $importCategoryID = 0;
/**
* Returns the id of the category used for articles without previous categories.
*
- * @return integer
+ * @return int
*/
private function getImportCategoryID() {
if (!$this->importCategoryID) {
/**
* user merge mode
- * @var integer
+ * @var int
*/
protected $userMergeMode = 2;
*
* @param string $type
* @param mixed $oldID
- * @return integer $newID
+ * @return int $newID
*/
public function getNewID($type, $oldID) {
if (!$oldID) return null;
* Saves an id mapping.
*
* @param string $type
- * @param integer $oldID
- * @param integer $newID
+ * @param int $oldID
+ * @param int $newID
*/
public function saveNewID($type, $oldID, $newID) {
$objectTypeID = $this->objectTypes[$type]->objectTypeID;
/**
* Sets the user merge mode.
*
- * @param integer $mode
+ * @param int $mode
*/
public function setUserMergeMode($mode) {
$this->userMergeMode = $mode;
/**
* Returns the user merge mode.
*
- * @return integer
+ * @return int
*/
public function getUserMergeMode() {
return $this->userMergeMode;
/**
* category for orphaned trophies
- * @var integer
+ * @var int
*/
private $importCategoryID = 0;
/**
* Returns a categoryID for trophies without categoryID.
*
- * @return integer
+ * @return int
*/
private function getImportCategoryID() {
if (!$this->importCategoryID) {
/**
* ids of default notification events
- * @var integer[]
+ * @var int[]
*/
protected $eventIDs = [];
/**
* language category id
- * @var integer
+ * @var int
*/
protected $languageCategoryID = null;
* Opens a new ftp connection to given host.
*
* @param string $host
- * @param integer $port
- * @param integer $timeout
+ * @param int $port
+ * @param int $timeout
* @throws SystemException
*/
public function __construct($host = 'localhost', $port = 21, $timeout = 30) {
*
* @method boolean close()
* @method boolean eof()
- * @method integer filesize()
+ * @method int filesize()
* @method string gets($length = null)
* @method resource open($mode, $use_include_path = false, $context = null)
- * @method integer puts($string, $length = null) alias of `write`
+ * @method int puts($string, $length = null) alias of `write`
* @method string read($length)
- * @method integer seek($offset, $whence = SEEK_SET)
+ * @method int seek($offset, $whence = SEEK_SET)
* @method array stat()
- * @method integer tell()
+ * @method int tell()
* @method boolean touch($time = 0, $atime = 0) note: default value of `$time` actually is `time()`
- * @method integer write($string, $length = null)
+ * @method int write($string, $length = null)
*/
class File {
/**
/**
* Returns the filesize of the unzipped file.
*
- * @return integer
+ * @return int
*/
public function getFileSize() {
$byteBlock = 1<<14;
* Returns false if not found.
*
* @param string $filename
- * @return integer index of the requested file
+ * @return int index of the requested file
*/
public function getIndexByFilename($filename);
}
/**
* port
- * @var integer
+ * @var int
*/
protected $port = 0;
/**
* error number
- * @var integer
+ * @var int
*/
protected $errorNumber = 0;
* Opens a new connection to a remote host.
*
* @param string $host
- * @param integer $port
- * @param integer $timeout
+ * @param int $port
+ * @param int $timeout
* @param array $options
* @throws SystemException
*/
/**
* Returns the error number of the last error.
*
- * @return integer
+ * @return int
*/
public function getErrorNumber() {
return $this->errorNumber;
/**
* chunk size for extracting
- * @var integer
+ * @var int
*/
const CHUNK_SIZE = 8192;
* Writes header block.
*
* @param string $filename
- * @param integer $size
- * @param integer $mtime
- * @param integer $permissions
+ * @param int $size
+ * @param int $mtime
+ * @param int $permissions
* @param string $typeFlag
- * @param integer $uid
- * @param integer $gid
+ * @param int $uid
+ * @param int $gid
* @return boolean
*/
public function writeHeaderBlock($filename, $size, $mtime = 0, $permissions = 0, $typeFlag = '', $uid = 0, $gid = 0) {
* Checks whether the next record is a file.
* This does not change the position of the file-pointer.
*
- * @param integer $offset where to start reading
+ * @param int $offset where to start reading
* @return boolean
* @throws SystemException
*/
/**
* Reads a file and returns it.
*
- * @param integer $offset where to start reading
+ * @param int $offset where to start reading
* @return array
* @throws SystemException
*/
/**
* Reads in the specified number of bytes and unpacks them.
*
- * @param integer $length Number of bytes to read
+ * @param int $length Number of bytes to read
* @param string $type Which type are the bytes of
* @return mixed
*/
* Adds a folder to the Zip archive.
*
* @param string $name dirname
- * @param integer $date
+ * @param int $date
*/
public function addDir($name, $date = TIME_NOW) {
// replace backward slashes with forward slashes in the dirname
*
* @param string $data content of the file
* @param string $name filename
- * @param integer $date file creation time as unix timestamp
+ * @param int $date file creation time as unix timestamp
*/
public function addFile($data, $name, $date = TIME_NOW) {
// replace backward slashes with forward slashes in the filename
/**
* Converts an unix timestamp to Zip file time.
*
- * @param integer $date unix timestamp
+ * @param int $date unix timestamp
* @return string
*/
protected static function getDosDatetime($date) {
* no such option exists.
*
* @param string $optionName
- * @return integer
+ * @return int
*/
public function getOptionID($optionName) {
foreach ($this->labelGroups['options'] as $option) {
/**
* Returns an array with view permissions for the labels with the given id.
*
- * @param integer[] $labelIDs
+ * @param int[] $labelIDs
* @param User $user
* @return array
* @see \wcf\system\label\LabelHandler::getPermissions()
/**
* Returns an array with use permissions for the labels with the given id.
*
- * @param integer[] $labelIDs
+ * @param int[] $labelIDs
* @param User $user
* @return array
* @see \wcf\system\label\LabelHandler::getPermissions()
* Returns an array with boolean values for each given label id.
*
* @param string $optionName
- * @param integer[] $labelIDs
+ * @param int[] $labelIDs
* @param User $user
* @return array
* @throws SystemException
* Sets labels for given object id, pass an empty array to remove all previously
* assigned labels.
*
- * @param integer[] $labelIDs
- * @param integer $objectTypeID
- * @param integer $objectID
+ * @param int[] $labelIDs
+ * @param int $objectTypeID
+ * @param int $objectID
* @param boolean $validatePermissions
*/
public function setLabels(array $labelIDs, $objectTypeID, $objectID, $validatePermissions = true) {
* label for any of the given label group is given, an existing label from this group will
* be removed.
*
- * @param integer[] $groupIDs ids of the relevant label groups
- * @param integer[] $labelIDs ids of the new labels
+ * @param int[] $groupIDs ids of the relevant label groups
+ * @param int[] $labelIDs ids of the new labels
* @param string $objectType label object type of the updated object
- * @param integer $objectID id of the updated object
+ * @param int $objectID id of the updated object
* @since 5.2
*/
public function replaceLabels(array $groupIDs, array $labelIDs, $objectType, $objectID) {
/**
* Returns all assigned labels, optionally filtered to validate permissions.
*
- * @param integer $objectTypeID
- * @param integer[] $objectIDs
+ * @param int $objectTypeID
+ * @param int[] $objectIDs
* @param boolean $validatePermissions
* @return Label[][]
*/
/**
* Returns given label groups by id.
*
- * @param integer[] $groupIDs
+ * @param int[] $groupIDs
* @param boolean $validatePermissions
* @param string $permission
* @return ViewableLabelGroup[]
/**
* Returns a list of accessible label ids.
*
- * @return integer[]
+ * @return int[]
*/
public function getAccessibleLabelIDs() {
$labelIDs = [];
/**
* Returns label group by id.
*
- * @param integer $groupID
+ * @param int $groupID
* @return ViewableLabelGroup
*/
public function getLabelGroup($groupID) {
/**
* Removes all assigned labels for given object ids.
*
- * @param integer $objectTypeID
- * @param integer[] $objectIDs
+ * @param int $objectTypeID
+ * @param int[] $objectIDs
*/
public function removeLabels($objectTypeID, array $objectIDs) {
$conditions = new PreparedStatementConditionBuilder();
/**
* object type id
- * @var integer
+ * @var int
*/
protected $objectTypeID = 0;
/**
* Sets the label groups available for the categories with the given ids.
*
- * @param integer[] $categoryIDs
+ * @param int[] $categoryIDs
*/
public function setCategoryIDs($categoryIDs) {
$labelGroupsToCategories = ArticleCategoryLabelCacheBuilder::getInstance()->getData();
* Returns a list of label group ids.
*
* @param array $parameters
- * @return integer[]
+ * @return int[]
*/
public function getLabelGroupIDs(array $parameters = []);
/**
* Returns true, if all given label ids are valid and accessible.
*
- * @param integer[] $labelIDs
+ * @param int[] $labelIDs
* @param string $optionName
* @param boolean $legacyReturnValue
* @return mixed
/**
* Assigns labels to an object.
*
- * @param integer[] $labelIDs
- * @param integer $objectID
+ * @param int[] $labelIDs
+ * @param int $objectID
* @param boolean $validatePermissions
* @see \wcf\system\label\LabelHandler::setLabels()
*/
/**
* Removes all assigned labels.
*
- * @param integer $objectID
+ * @param int $objectID
* @param boolean $validatePermissions
* @see \wcf\system\label\LabelHandler::removeLabels()
*/
/**
* Returns a list of assigned labels.
*
- * @param integer[] $objectIDs
+ * @param int[] $objectIDs
* @param boolean $validatePermissions
* @return Label[]
*/
/**
* object type id
- * @var integer
+ * @var int
*/
public $objectTypeID = 0;
/**
* Sets object type id.
*
- * @param integer $objectTypeID
+ * @param int $objectTypeID
*/
public function setObjectTypeID($objectTypeID);
/**
* Returns object type id.
*
- * @return integer
+ * @return int
*/
public function getObjectTypeID();
class LabelObjectType {
/**
* indentation level
- * @var integer
+ * @var int
*/
public $depth = 0;
/**
* object id
- * @var integer
+ * @var int
*/
public $objectID = 0;
/**
* option value
- * @var integer
+ * @var int
*/
public $optionValue = 0;
* Creates a new LabelObjectType object.
*
* @param string $label
- * @param integer $objectID
- * @param integer $depth
+ * @param int $objectID
+ * @param int $depth
* @param boolean $isCategory
*/
public function __construct($label, $objectID = 0, $depth = 0, $isCategory = false) {
/**
* Returns the object id.
- * @return integer
+ * @return int
*/
public function getObjectID() {
return $this->objectID;
/**
* Returns indentation level.
*
- * @return integer
+ * @return int
*/
public function getDepth() {
return $this->depth;
/**
* Sets option value.
*
- * @param integer $optionValue
+ * @param int $optionValue
*/
public function setOptionValue($optionValue) {
$this->optionValue = $optionValue;
/**
* Returns option value.
*
- * @return integer
+ * @return int
*/
public function getOptionValue() {
return $this->optionValue;
/**
* object type id
- * @var integer
+ * @var int
*/
public $objectTypeID = 0;
/**
* iterator position
- * @var integer
+ * @var int
*/
private $position = 0;
/**
* Creates a new LabelObjectTypeContainer object.
*
- * @param integer $objectTypeID
+ * @param int $objectTypeID
*/
public function __construct($objectTypeID) {
$this->objectTypeID = $objectTypeID;
/**
* Returns the object type id.
*
- * @return integer
+ * @return int
*/
public function getObjectTypeID() {
return $this->objectTypeID;
* @param string|string[] $elementID either the id of the element or externally passed array `languageID => value`
* @param string $languageVariable
* @param string $languageCategory
- * @param integer $packageID
+ * @param int $packageID
*/
public function save($elementID, $languageVariable, $languageCategory, $packageID = PACKAGE_ID) {
// get language category id
/**
* Sets additional options for elements, required if updating values.
*
- * @param integer $elementID
- * @param integer $packageID
+ * @param int $elementID
+ * @param int $packageID
* @param string $value
* @param string $pattern
*/
* `f` is the fractional number as a whole number (1.234 yields 234)
*
* @param number $n
- * @return integer
+ * @return int
*/
private static function getF($n) {
$n = (string)$n;
* `v` represents the number of digits of the fractional part (1.234 yields 3)
*
* @param number $n
- * @return integer
+ * @return int
*/
private static function getV($n) {
return strlen(preg_replace('/^[^.]*\.?/', '', (string)$n));
/**
* bit-mask to alter validation rules
- * @var integer
+ * @var int
*/
protected $flags = 0;
/**
* Sets bit flags.
*
- * @param integer $flags
+ * @param int $flags
*/
public function setFlags($flags) {
$this->flags = $flags;
/**
* Returns true if given flag is set.
*
- * @param integer $flag
+ * @param int $flag
* @return boolean
*/
public function getFlag($flag) {
/**
* Returns a Language object for the language with the given id.
*
- * @param integer $languageID
+ * @param int $languageID
* @return Language
*/
public function getLanguage($languageID) {
/**
* Returns the preferred language of the current user.
*
- * @param integer $languageID
+ * @param int $languageID
* @return Language
*/
public function getUserLanguage($languageID = 0) {
/**
* Returns language category by id.
*
- * @param integer $languageCategoryID
+ * @param int $languageCategoryID
* @return LanguageCategory
*/
public function getCategoryByID($languageCategoryID) {
/**
* Returns the default language id
*
- * @return integer
+ * @return int
*/
public function getDefaultLanguageID() {
return $this->cache['default'];
/**
* Returns the list of content language ids.
*
- * @return integer[]
+ * @return int[]
* @since 3.1
*/
public function getContentLanguageIDs() {
/**
* Makes given language the default language.
*
- * @param integer $languageID
+ * @param int $languageID
*/
public function makeDefault($languageID) {
// remove old default language
/**
* Returns the number of phrases that have been automatically disabled in the past 7 days.
*
- * @return integer
+ * @return int
*/
public function countRecentlyDisabledCustomValues() {
$sql = "SELECT COUNT(*) AS count
* Returns a like object.
*
* @param ObjectType $objectType
- * @param integer $objectID
+ * @param int $objectID
* @return LikeObject|null
*/
public function getLikeObject(ObjectType $objectType, $objectID) {
*
* @param ObjectType $objectType
* @param array $objectIDs
- * @return integer
+ * @return int
*/
public function loadLikeObjects(ObjectType $objectType, array $objectIDs) {
return ReactionHandler::getInstance()->loadLikeObjects($objectType, $objectIDs);
*
* @param ILikeObject $likeable
* @param User $user
- * @param integer $likeValue
- * @param integer $time
+ * @param int $likeValue
+ * @param int $time
* @return array
*/
public function like(ILikeObject $likeable, User $user, $likeValue, $time = TIME_NOW) {
* Removes all likes for given objects.
*
* @param string $objectType
- * @param integer[] $objectIDs
+ * @param int[] $objectIDs
* @param string[] $notificationObjectTypes
*/
public function removeLikes($objectType, array $objectIDs, array $notificationObjectTypes = []) {
* Creates a modification log entry.
*
* @param string $action
- * @param integer $objectID
- * @param integer|null $parentObjectID
+ * @param int $objectID
+ * @param int|null $parentObjectID
* @param array $additionalData
- * @param integer $time
- * @param integer|null $userID
+ * @param int $time
+ * @param int|null $userID
* @param string|null $username
- * @param integer $hidden
+ * @param int $hidden
* @return ModificationLog
*/
public function createLog($action, $objectID, $parentObjectID = null, array $additionalData = [], $time = TIME_NOW, $userID = null, $username = null, $hidden = 1) {
/**
* Deletes modification log entries.
*
- * @param integer[] $objectIDs
+ * @param int[] $objectIDs
* @param string[] $ignoredActions names of actions whose log entries will not be deleted
*/
public function deleteLogs(array $objectIDs, array $ignoredActions = []) {
/**
* Deletes modification log entries by the id of the parent object.
*
- * @param integer[] $parentObjectIDs
+ * @param int[] $parentObjectIDs
*/
public function deleteLogsByParentIDs(array $parentObjectIDs) {
if (empty($parentObjectIDs)) return;
/**
* Updates the parent object id of modification log entries.
*
- * @param integer[] $objectIDs
- * @param integer $newParentObjectID
+ * @param int[] $objectIDs
+ * @param int $newParentObjectID
*/
public function updateParentObjectID(array $objectIDs, $newParentObjectID) {
if (empty($objectIDs)) return;
* Adds a new entry to modification log.
*
* @param string $objectType
- * @param integer $objectID
+ * @param int $objectID
* @param string $action
* @param array $additionalData
- * @param integer $time
- * @param integer $userID
+ * @param int $time
+ * @param int $userID
* @param string $username
* @return ModificationLog
* @throws SystemException
* Removes log entries.
*
* @param string $objectType
- * @param integer[] $objectIDs
+ * @param int[] $objectIDs
* @throws SystemException
*/
protected function _remove($objectType, array $objectIDs) {
* @param string $cc
* @param string $bcc
* @param array $attachments
- * @param integer|string $priority
+ * @param int|string $priority
* @param string $header
*/
public function __construct($to = '', $subject = '', $message = '', $from = '', $cc = '', $bcc = '', $attachments = [], $priority = '', $header = '') {
/**
* Sets the priority of the mail.
*
- * @param integer $priority
+ * @param int $priority
*/
public function setPriority($priority) {
$this->email->addHeader('x-priority', $priority);
/**
* Returns the active menu item.
*
- * @param integer $level
+ * @param int $level
* @return string
*/
public function getActiveMenuItem($level = 0) {
/**
* Returns the first visible menu item.
*
- * @param integer $userID
+ * @param int $userID
* @return UserProfileMenuItem
*/
public function getActiveMenuItem($userID = 0) {
/**
* object type id
- * @var integer
+ * @var int
*/
public $objectTypeID = 0;
/**
* Returns content for this user profile menu item.
*
- * @param integer $userID
+ * @param int $userID
* @return string
*/
public function getContent($userID);
/**
* Returns true if the associated menu item should be visible for the active user.
*
- * @param integer $userID
+ * @param int $userID
* @return boolean
*/
public function isVisible($userID);
/**
* object id
- * @var integer
+ * @var int
*/
public $objectID = 0;
* Returns a stored message from session.
*
* @param string $type
- * @param integer $objectID
+ * @param int $objectID
* @return string
*/
public function getMessage($type, $objectID) {
* Stores a message in session.
*
* @param string $type
- * @param integer $objectID
+ * @param int $objectID
* @param string $message
*/
public function setMessage($type, $objectID, $message) {
* Removes a stored message from session.
*
* @param string $type
- * @param integer $objectID
+ * @param int $objectID
*/
public function removeMessage($type, $objectID) {
WCF::getSession()->unregister('quickReply-'.$type.'-'.$objectID);
/**
* Looks behind in the word list.
*
- * @param integer $index
+ * @param int $index
* @param string $search
* @return boolean
*/
/**
* Looks ahead in the word list.
*
- * @param integer $index
+ * @param int $index
* @param string $search
* @return mixed
*/
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package WoltLabSuite\Core\System\Message\Embedded\Object
*
- * @property-read integer $objectTypeID id of the embedded object type
+ * @property-read int $objectTypeID id of the embedded object type
*/
interface IMessageEmbeddedObjectHandler {
/**
*
* @param HtmlInputProcessor $htmlInputProcessor html input processor holding the current document
* @param mixed[] $embeddedData list of found embedded data with attributes
- * @return integer[] ids of found embedded objects
+ * @return int[] ids of found embedded objects
*/
public function parse(HtmlInputProcessor $htmlInputProcessor, array $embeddedData);
* Validates the provided values for existence and returns the filtered list.
*
* @param string $objectType object type identifier
- * @param integer $objectID object id
- * @param integer[] $values list of value ids
- * @return integer[] filtered list
+ * @param int $objectID object id
+ * @param int[] $values list of value ids
+ * @return int[] filtered list
*/
public function validateValues($objectType, $objectID, array $values);
* if no replacement should be performed due to invalid or missing arguments.
*
* @param string $objectType object type identifier
- * @param integer $objectID object id
- * @param integer $value value id
+ * @param int $objectID object id
+ * @param int $value value id
* @param array $attributes list of additional attributes
* @return string|null replacement string or null if value id is unknown
*/
/**
* object type of the active message
- * @var integer
+ * @var int
*/
protected $activeMessageObjectTypeID;
/**
* id of the active message
- * @var integer
+ * @var int
*/
protected $activeMessageID;
/**
* language id of the active message
- * @var integer
+ * @var int
*/
protected $activeMessageLanguageID;
/**
* content language id
- * @var integer
+ * @var int
*/
protected $contentLanguageID;
* Registers the embedded objects found in a message using the simplified syntax.
*
* @param string $messageObjectType object type identifier
- * @param integer $messageID object id
- * @param integer[][] $embeddedContent list of object ids for embedded objects by object type id
+ * @param int $messageID object id
+ * @param int[][] $embeddedContent list of object ids for embedded objects by object type id
* @return boolean true if at least one embedded object was found
*/
public function registerSimpleObjects($messageObjectType, $messageID, array $embeddedContent) {
* Removes embedded object assignments for given messages.
*
* @param string $messageObjectType
- * @param integer[] $messageIDs
+ * @param int[] $messageIDs
*/
public function removeObjects($messageObjectType, array $messageIDs) {
$conditionBuilder = new PreparedStatementConditionBuilder();
* Loads the embedded objects for given messages.
*
* @param string $messageObjectType
- * @param integer[] $messageIDs
- * @param integer $contentLanguageID
+ * @param int[] $messageIDs
+ * @param int $contentLanguageID
* @throws InvalidObjectTypeException
*/
public function loadObjects($messageObjectType, array $messageIDs, $contentLanguageID = null) {
/**
* Returns the content language id or null.
*
- * @return integer
+ * @return int
*/
public function getContentLanguageID() {
return $this->contentLanguageID;
* Sets active message information.
*
* @param string $messageObjectType
- * @param integer $messageID
- * @param integer $languageID
+ * @param int $messageID
+ * @param int $languageID
*/
public function setActiveMessage($messageObjectType, $messageID, $languageID = null) {
$this->activeMessageObjectTypeID = ObjectTypeCache::getInstance()->getObjectTypeIDByName('com.woltlab.wcf.message', $messageObjectType);
/**
* Returns the language id of the active message.
*
- * @return integer
+ * @return int
*/
public function getActiveMessageLanguageID() {
return $this->activeMessageLanguageID;
* Returns a specific embedded object.
*
* @param string $embeddedObjectType
- * @param integer $objectID
+ * @param int $objectID
* @return \wcf\data\DatabaseObject
*/
public function getObject($embeddedObjectType, $objectID) {
/**
* Returns a specific embedded object handler.
*
- * @param integer $objectTypeID
+ * @param int $objectTypeID
* @return IMessageEmbeddedObjectHandler
*/
protected function getEmbeddedObjectHandler($objectTypeID) {
class MessageQuoteManager extends SingletonFactory {
/**
* current object ids
- * @var integer[]
+ * @var int[]
*/
protected $objectIDs = [];
/**
* message id for quoting
- * @var integer
+ * @var int
*/
protected $quoteMessageID = 0;
* $message and $obj->getMessage() for $fullQuote.
*
* @param string $objectType
- * @param integer $parentObjectID
- * @param integer $objectID
+ * @param int $parentObjectID
+ * @param int $objectID
* @param string $message
* @param string $fullQuote
* @param boolean $returnFalseIfExists
* Returns the quote id for given quote.
*
* @param string $objectType
- * @param integer $objectID
+ * @param int $objectID
* @param string $message
* @param string $fullQuote
* @return string
* Returns a list of quotes by object type and id.
*
* @param string $objectType
- * @param integer[] $objectIDs
+ * @param int[] $objectIDs
* @param boolean $markForRemoval
* @return string[]
*/
* Returns a list of quotes by object type and parent object id.
*
* @param string $objectType
- * @param integer $parentObjectID
+ * @param int $parentObjectID
* @param boolean $markForRemoval
* @return string[]
*/
* Returns the object id by quote id.
*
* @param string $quoteID
- * @return integer
+ * @return int
*/
public function getObjectID($quoteID) {
if (isset($this->quoteData[$quoteID])) {
/**
* Returns the number of stored quotes.
*
- * @return integer
+ * @return int
*/
public function countQuotes() {
$count = 0;
* Sets object type and object ids.
*
* @param string $objectType
- * @param integer[] $objectIDs
+ * @param int[] $objectIDs
* @throws SystemException
*/
public function initObjects($objectType, array $objectIDs) {
/**
* Returns quote message id.
*
- * @return integer
+ * @return int
*/
public function getQuoteMessageID() {
return $this->quoteMessageID;
/**
* Removes orphaned quote ids
*
- * @param integer[] $quoteIDs
+ * @param int[] $quoteIDs
*/
public function removeOrphanedQuotes(array $quoteIDs) {
foreach ($quoteIDs as $quoteID) {
* @method string getFormattedMessage()
* @method string getLink()
* @method string getMessage()
- * @method integer getTime()
+ * @method int getTime()
* @method string getTitle()
- * @method integer getUserID()
+ * @method int getUserID()
* @method string getUsername()
* @method boolean isVisible()
*/
/**
* current iterator index
- * @var integer
+ * @var int
*/
protected $index = 0;
/**
* list of index to object relation
- * @var integer[]
+ * @var int[]
*/
protected $indexToObject = null;
/**
* Returns a comment object by comment id or null if comment id is invalid.
*
- * @param integer $objectID
+ * @param int $objectID
* @return Comment|null
*/
protected function getComment($objectID) {
/**
* Returns a comment response object by response id or null if response id is invalid.
*
- * @param integer $objectID
+ * @param int $objectID
* @return CommentResponse|null
*/
protected function getResponse($objectID) {
/**
* Adds an entry to moderation queue.
*
- * @param integer $objectTypeID
- * @param integer $objectID
- * @param integer $containerID
+ * @param int $objectTypeID
+ * @param int $objectID
+ * @param int $containerID
* @param array $additionalData
*/
protected function addEntry($objectTypeID, $objectID, $containerID = 0, array $additionalData = []) {
*
* This method is intended for bulk processing.
*
- * @param integer $objectTypeID
- * @param integer[] $objectIDs
- * @param integer[] $containerIDs format: `objectID => containerID`
+ * @param int $objectTypeID
+ * @param int[] $objectIDs
+ * @param int[] $containerIDs format: `objectID => containerID`
* @param array $additionalData
*/
protected function addEntries($objectTypeID, array $objectIDs, array $containerIDs, array $additionalData = []) {
/**
* Marks a list of moderation queue entries as done.
*
- * @param integer $objectTypeID
- * @param integer[] $objectIDs
+ * @param int $objectTypeID
+ * @param int[] $objectIDs
*/
protected function removeEntries($objectTypeID, array $objectIDs) {
$queueList = new ModerationQueueList();
/**
* Returns the container id for current object id, may return 0.
*
- * @param integer $objectID
- * @return integer
+ * @param int $objectID
+ * @return int
*/
public function getContainerID($objectID);
/**
* Validates object ids and returns orphaned queue ids.
*
- * @param integer[] $queues
- * @return integer[]
+ * @param int[] $queues
+ * @return int[]
*/
public function identifyOrphans(array $queues);
/**
* Returns true if given object id is valid.
*
- * @param integer $objectID
+ * @param int $objectID
* @return boolean
*/
public function isValid($objectID);
* Removes queses from database, should only be called if the referenced
* object is permanently deleted.
*
- * @param integer[] $objectIDs
+ * @param int[] $objectIDs
*/
public function removeQueues(array $objectIDs);
* Returns true, if given user is affected by given queue entry.
*
* @param ModerationQueue $queue
- * @param integer $userID
+ * @param int $userID
* @return boolean
*/
public function isAffectedUser(ModerationQueue $queue, $userID);
/**
* Creates queue assignments for matching object type ids.
*
- * @param integer $objectTypeID
+ * @param int $objectTypeID
* @param ModerationQueue[] $queues
*/
public function assignQueues($objectTypeID, array $queues);
* Returns true if given object type is valid, optionally checking object id.
*
* @param string $objectType
- * @param integer $objectID
+ * @param int $objectID
* @return boolean
*/
public function isValid($objectType, $objectID = null);
/**
* Returns link for viewing/editing objects for this moderation type.
*
- * @param integer $queueID
+ * @param int $queueID
* @return string
*/
public function getLink($queueID);
* Returns object type id for given object type.
*
* @param string $objectType
- * @return integer
+ * @return int
*/
public function getObjectTypeID($objectType);
* Returns object type processor by object type.
*
* @param string $objectType
- * @param integer $objectTypeID
+ * @param int $objectTypeID
* @return object
*/
public function getProcessor($objectType, $objectTypeID = null);
/**
* Populates object properties for viewing.
*
- * @param integer $objectTypeID
+ * @param int $objectTypeID
* @param ViewableModerationQueue[] $objects
*/
public function populate($objectTypeID, array $objects);
* Adds an entry for moderated content.
*
* @param string $objectType
- * @param integer $objectID
+ * @param int $objectID
* @param array $additionalData
* @throws InvalidObjectTypeException
*/
* This method is intended for bulk processing.
*
* @param string $objectType
- * @param integer[] $objectID
- * @poram integer[] $containerIDs format: `objectID => containerID`
+ * @param int[] $objectID
+ * @poram int[] $containerIDs format: `objectID => containerID`
* @param array $additionalData
* @throws InvalidObjectTypeException
*/
* Marks entries from moderation queue as done.
*
* @param string $objectType
- * @param integer[] $objectIDs
+ * @param int[] $objectIDs
* @throws InvalidObjectTypeException
*/
public function removeModeratedContent($objectType, array $objectIDs) {
/**
* list of object type names categorized by type
- * @var integer[][]
+ * @var int[][]
*/
protected $objectTypeNames = [];
*
* @param string $definitionName
* @param string $objectType
- * @param integer $objectTypeID
+ * @param int $objectTypeID
* @return object
*/
public function getProcessor($definitionName, $objectType, $objectTypeID = null) {
/**
* Returns link for viewing/editing an object type.
*
- * @param integer $objectTypeID
- * @param integer $queueID
+ * @param int $objectTypeID
+ * @param int $queueID
* @return string
*/
public function getLink($objectTypeID, $queueID) {
*
* @param string $definitionName
* @param string $objectType
- * @return integer
+ * @return int
*/
public function getObjectTypeID($definitionName, $objectType) {
if ($this->isValid($definitionName, $objectType)) {
/**
* Returns a list of object type ids for given definition ids.
*
- * @param integer[] $definitionIDs
- * @return integer[]
+ * @param int[] $definitionIDs
+ * @return int[]
*/
public function getObjectTypeIDs(array $definitionIDs) {
$objectTypeIDs = [];
/**
* Populates object properties for viewing.
*
- * @param integer $objectTypeID
+ * @param int $objectTypeID
* @param ViewableModerationQueue[] $objects
* @throws SystemException
*/
/**
* Returns the count of outstanding moderation queue items.
*
- * @return integer
+ * @return int
*/
public function getOutstandingModerationCount() {
// get count
* Returns the count of unread moderation queue items.
*
* @param boolean $skipCache
- * @return integer
+ * @return int
*/
public function getUnreadModerationCount($skipCache = false) {
// get count
/**
* Removes a list of orphaned queue ids.
*
- * @param integer[] $queueIDs
+ * @param int[] $queueIDs
*/
public function removeOrphans(array $queueIDs) {
if (!empty($queueIDs)) {
/**
* Resets moderation count for all users or optionally only for one user.
*
- * @param integer $userID
+ * @param int $userID
*/
public function resetModerationCount($userID = null) {
if ($userID === null) {
* Removes moderation queues, should only be called if related objects are permanently deleted.
*
* @param string $objectType
- * @param integer[] $objectIDs
+ * @param int[] $objectIDs
* @throws SystemException
*/
public function removeQueues($objectType, array $objectIDs) {
* Returns true if given item was already reported.
*
* @param string $objectType
- * @param integer $objectID
+ * @param int $objectID
* @return boolean
*/
public function isAlreadyReported($objectType, $objectID) {
* A pending report has a status other than done.
*
* @param string $objectType
- * @param integer $objectID
+ * @param int $objectID
* @return boolean
*/
public function hasPendingReport($objectType, $objectID) {
* Returns true if current user can report given content.
*
* @param string $objectType
- * @param integer $objectID
+ * @param int $objectID
* @return boolean
*/
public function canReport($objectType, $objectID) {
* Returns the reported object.
*
* @param string $objectType
- * @param integer $objectID
+ * @param int $objectID
* @return \wcf\data\IUserContent
*/
public function getReportedObject($objectType, $objectID) {
* Adds a report for specified content.
*
* @param string $objectType
- * @param integer $objectID
+ * @param int $objectID
* @param string $message
* @param array $additionalData
* @throws InvalidObjectTypeException
/**
* Returns true if current user can report given content.
*
- * @param integer $objectID
+ * @param int $objectID
* @return boolean
*/
public function canReport($objectID);
/**
* Returns reported object.
*
- * @param integer $objectID
+ * @param int $objectID
* @return \wcf\data\IUserContent
*/
public function getReportedObject($objectID);
/**
* Returns a user object by user id or null if user id is invalid.
*
- * @param integer $objectID
+ * @param int $objectID
* @return User|null
*/
protected function getUser($objectID) {
* Returns the tree of options.
*
* @param string $parentCategoryName
- * @param integer $level
+ * @param int $level
* @return array
*/
public function getOptionTree($parentCategoryName = '', $level = 0);
*
* @param mixed $value1
* @param mixed $value2
- * @return integer
+ * @return int
*/
public function compare($value1, $value2);
* Splits the given dashed date into its components.
*
* @param string $value
- * @return integer[]
+ * @return int[]
*/
protected static function splitDate($value) {
$year = $month = $day = 0;
/**
* list of compatible API versions
- * @var integer[]
+ * @var int[]
* @deprecated 5.2
*/
protected $compatibility = [];
/**
* Returns the list of compatible API versions.
*
- * @return integer[]
+ * @return int[]
* @deprecated 5.2
*/
public function getCompatibleVersions() {
/**
* Returns current package id.
*
- * @return integer
+ * @return int
*/
public function getPackageID() {
return $this->queue->packageID;
* Opens the package installation queue and
* starts the installation, update or uninstallation of the first entry.
*
- * @param integer $parentQueueID
- * @param integer $processNo
+ * @param int $parentQueueID
+ * @param int $processNo
*/
public static function openQueue($parentQueueID = 0, $processNo = 0) {
$conditions = new PreparedStatementConditionBuilder();
/**
* Checks the package installation queue for outstanding entries.
*
- * @return integer
+ * @return int
*/
public static function checkPackageInstallationQueue() {
$sql = "SELECT queueID
* Converts shorthand byte values into an integer representing bytes.
*
* @param string $value
- * @return integer
+ * @return int
* @see http://www.php.net/manual/en/faq.using.php#faq.using.shorthandbytes
*/
protected static function convertShorthandByteValue($value) {
/**
* current sequence number within one node
- * @var integer
+ * @var int
*/
public $sequenceNo = 0;
/**
* Returns package name associated with given queue id.
*
- * @param integer $queueID
+ * @param int $queueID
* @return string
*/
public function getPackageNameByQueue($queueID) {
/**
* Returns installation type by queue id.
*
- * @param integer $queueID
+ * @param int $queueID
* @return string
*/
public function getInstallationTypeByQueue($queueID) {
* Calculates current setup process.
*
* @param string $node
- * @return integer
+ * @return int
*/
public function calculateProgress($node) {
$progress = [
* Duplicates a node by re-inserting it and moving all descendants into a new tree.
*
* @param string $node
- * @param integer $sequenceNo
+ * @param int $sequenceNo
*/
public function cloneNode($node, $sequenceNo) {
$newNode = $this->getToken();
/**
* Returns queue id based upon current node.
*
- * @param integer $processNo
+ * @param int $processNo
* @param string $node
- * @return integer|null
+ * @return int|null
*/
public function getQueueByNode($processNo, $node) {
$sql = "SELECT queueID
*
* @param string $tableName
* @param string $columnName
- * @return integer package id
+ * @return int package id
*/
protected function getColumnOwnerID($tableName, $columnName) {
$sql = "SELECT packageID
*
* @param string $tableName
* @param string $indexName
- * @return integer package id
+ * @return int package id
*/
protected function getIndexOwnerID($tableName, $indexName) {
$sql = "SELECT packageID
*
* @param string $package package identifier
* @param string $version package version
- * @param integer $stackPosition
+ * @param int $stackPosition
* @param boolean $validateInstallInstructions
*/
protected function installPackage($package, $version = '', $stackPosition = -1, $validateInstallInstructions = false) {
* Resolves the package requirements of an package update.
* Starts the installation or update to higher version of required packages.
*
- * @param integer $packageUpdateVersionID
+ * @param int $packageUpdateVersionID
*/
protected function resolveRequirements($packageUpdateVersionID) {
// resolve requirements
/**
* Updates an existing package.
*
- * @param integer $packageID
+ * @param int $packageID
* @param string $version
*/
protected function updatePackage($packageID, $version) {
*
* @param array $updateThreadListA
* @param array $updateThreadListB
- * @return integer
+ * @return int
*/
protected function compareUpdateThreadLists($updateThreadListA, $updateThreadListB) {
$countA = count($updateThreadListA);
/**
* Refreshes the package database.
*
- * @param integer[] $packageUpdateServerIDs
+ * @param int[] $packageUpdateServerIDs
* @param boolean $ignoreCache
*/
public function refreshPackageDatabase(array $packageUpdateServerIDs = [], $ignoreCache = false) {
* Updates information parsed from a packages_update.xml into the database.
*
* @param array $allNewPackages
- * @param integer $packageUpdateServerID
+ * @param int $packageUpdateServerID
*/
protected function savePackageUpdates(array &$allNewPackages, $packageUpdateServerID) {
$excludedPackagesParameters = $fromversionParameters = $insertParameters = $optionalInserts = $requirementInserts = $compatibilityInserts = [];
* Removes unnecessary updates of requirements from the list of available updates.
*
* @param array $updates
- * @param integer $packageUpdateVersionID
+ * @param int $packageUpdateVersionID
* @return array $updates
*/
protected function removeUpdateRequirements(array $updates, $packageUpdateVersionID) {
/**
* list of loaded acl object type ids sorted by their option type name
- * @var integer[]
+ * @var int[]
*/
protected $optionTypeIDs = [];
* or throws a SystemException if no such option type exists.
*
* @param string $optionType
- * @return integer
+ * @return int
* @throws SystemException
*/
protected function getObjectTypeID($optionType) {
*
* @param array $option
* @param string $categoryName
- * @param integer $existingOptionID
+ * @param int $existingOptionID
*/
abstract protected function saveOption($option, $categoryName, $existingOptionID = 0);
/**
* Returns the show order value.
*
- * @param null|integer $showOrder
+ * @param null|int $showOrder
* @param string $parentName
* @param string $columnName
* @param string $tableNameExtension
- * @return integer
+ * @return int
*/
protected function getShowOrder($showOrder, $parentName = null, $columnName = null, $tableNameExtension = '') {
if ($showOrder === null) {
* menu or parent item.
*
* @param string $position box position
- * @return integer
+ * @return int
*/
protected function getItemOrder($position) {
$sql = "SELECT MAX(showOrder) AS showOrder
* in case they are now empty.
*
* @param array $categoryIDs
- * @param integer $packageID
+ * @param int $packageID
*/
protected function deleteEmptyCategories(array $categoryIDs, $packageID) {
// Get empty categories which where changed by this package.
* Returns the show order for a new item that will append it to the current
* menu or parent item.
*
- * @param integer $menuID
- * @param integer $parentItemID
- * @return integer
+ * @param int $menuID
+ * @param int $parentItemID
+ * @return int
*/
protected function getItemOrder($menuID, $parentItemID = null) {
$sql = "SELECT MAX(showOrder) AS showOrder
* Returns the id of the object type definition with the given name.
*
* @param string $definitionName
- * @return integer
+ * @return int
* @throws SystemException
*/
protected function getDefinitionID($definitionName) {
class UserGroupOptionPackageInstallationPlugin extends AbstractOptionPackageInstallationPlugin implements IGuiPackageInstallationPlugin {
/**
* list of group ids by type
- * @var integer[][]
+ * @var int[][]
*/
protected $groupIDs = null;
/**
* Returns a list of group ids by type.
*
- * @return integer[][]
+ * @return int[][]
*/
protected function getGroupIDs() {
if ($this->groupIDs === null) {
/**
* preset event ids
- * @var integer[]
+ * @var int[]
*/
protected $presetEventIDs = [];
* Gets the id of given object type id.
*
* @param string $objectType
- * @return integer
+ * @return int
* @throws SystemException
*/
protected function getObjectTypeID($objectType) {
/**
* nesting depth
- * @var integer
+ * @var int
*/
protected $depth = 0;
/**
* children pointer
- * @var integer
+ * @var int
*/
private $position = 0;
*
* @param string $archive
* @param PackageValidationArchive $parent
- * @param integer $depth
+ * @param int $depth
*/
public function __construct($archive, PackageValidationArchive $parent = null, $depth = 0) {
$this->archive = new PackageArchive($archive);
* Validates this package and optionally it's delivered requirements. The set validation
* mode will toggle between different checks.
*
- * @param integer $validationMode
+ * @param int $validationMode
* @param string $requiredVersion
* @return boolean
*/
* Validates if the package has suitable install or update instructions
*
* @param string $requiredVersion
- * @param integer $validationMode
+ * @param int $validationMode
* @throws PackageValidationException
*/
protected function validateInstructions($requiredVersion, $validationMode) {
/**
* Returns nesting depth.
*
- * @return integer
+ * @return int
*/
public function getDepth() {
return $this->depth;
/**
* missing archive, expects the detail 'archive' and optionally 'targetArchive' (extracting archive from the archive)
- * @var integer
+ * @var int
*/
const FILE_NOT_FOUND = 1;
/**
* missing package.xml, expects the detail 'archive'
- * @var integer
+ * @var int
*/
const MISSING_PACKAGE_XML = 2;
/**
* package name violates WCF's schema, expects the detail 'packageName'
- * @var integer
+ * @var int
*/
const INVALID_PACKAGE_NAME = 3;
/**
* package version violates WCF's schema, expects the detail 'packageVersion'
- * @var integer
+ * @var int
*/
const INVALID_PACKAGE_VERSION = 4;
/**
* package contains no install instructions and an update is not possible, expects the detail 'packageName'
- * @var integer
+ * @var int
*/
const NO_INSTALL_PATH = 5;
/**
* package is already installed and cannot be updated using current archive, expects the details 'packageName', 'packageVersion' and 'deliveredPackageVersion'
- * @var integer
+ * @var int
*/
const NO_UPDATE_PATH = 6;
/**
* packages which exclude the current package, expects the detail 'packages' (list of \wcf\data\package\Package)
- * @var integer
+ * @var int
*/
const EXCLUDING_PACKAGES = 7;
/**
* packages which are excluded by current package, expects the detail 'packages' (list of \wcf\data\package\Package)
- * @var integer
+ * @var int
*/
const EXCLUDED_PACKAGES = 8;
/**
* package version is lower than the request version, expects the details 'packageName', 'packageVersion' and 'deliveredPackageVersion'
- * @var integer
+ * @var int
*/
const INSUFFICIENT_VERSION = 9;
/**
* requirement is set but neither installed nor provided, expects the details 'packageName', 'packageVersion' and 'package' (must be
* an instance of \wcf\data\package\Package or null if not installed)
- * @var integer
+ * @var int
*/
const MISSING_REQUIREMENT = 10;
/**
* file reference for a package installation plugin is missing, expects the details 'pip', 'type' and 'value'
- * @var integer
+ * @var int
*/
const MISSING_INSTRUCTION_FILE = 11;
/**
* the uploaded version is already installed, expects the details 'packageName' and 'packageVersion'
- * @var integer
+ * @var int
*/
const ALREADY_INSTALLED = 12;
/**
* the provided API version string is invalid and does not fall into the range from `2017` through `2099`
- * @var integer
+ * @var int
* @deprecated 5.2
*/
const INVALID_API_VERSION = 13;
/**
* the package is not compatible with the current API version or any other of the supported ones
- * @var integer
+ * @var int
* @deprecated 5.2
*/
const INCOMPATIBLE_API_VERSION = 14;
/**
* the package lacks any sort of API compatibility data
- * @var integer
+ * @var int
* @deprecated 5.2
*/
const MISSING_API_VERSION = 15;
/**
* the void is not the only instruction
- * @var integer
+ * @var int
*/
const VOID_NOT_ALONE = 16;
/**
* the void is used during installation
- * @var integer
+ * @var int
*/
const VOID_ON_INSTALL = 17;
/**
* Creates a new PackageArchiveValidationException.
*
- * @param integer $code
+ * @param int $code
* @param string[] $details
*/
public function __construct($code, array $details = []) {
/**
* Returns the readable error message.
*
- * @param integer $code
+ * @param int $code
* @return string
*/
public function getErrorMessage($code = null) {
/**
* Returns legacy error messages to mimic WCF 2.0.x PackageArchive's exceptions.
*
- * @param integer $code
+ * @param int $code
* @return string
*/
protected function getLegacyMessage($code) {
/**
* validation will only check if the primary package looks like it can be installed or updated
- * @var integer
+ * @var int
*/
const VALIDATION_WEAK = 0;
/**
* validation will recursively check dependencies
- * @var integer
+ * @var int
*/
const VALIDATION_RECURSIVE = 1;
/**
* validation will use the previously gathered exclusions and check them
- * @var integer
+ * @var int
*/
const VALIDATION_EXCLUSION = 2;
* is its assumed priority when matching suitable menu items.
*
* @param string $identifier internal page identifier
- * @param integer $pageObjectID page object id
+ * @param int $pageObjectID page object id
* @param ITitledLinkObject $locationObject optional label for breadcrumbs usage
* @param boolean $useAsParentLocation
* @throws SystemException
/**
* Returns the link for a page with an object id.
*
- * @param integer $objectID page object id
+ * @param int $objectID page object id
* @return string page url
*/
public function getLink($objectID);
/**
* Returns true if provided object id exists and is valid.
*
- * @param integer $objectID page object id
+ * @param int $objectID page object id
* @return boolean true if object id is valid
*/
public function isValid($objectID);
* Returns the number of outstanding items for this page for display as a badge, optionally
* specifying a corresponding object id to limit the scope.
*
- * @param integer|null $objectID optional page object id
- * @return integer number of outstanding items
+ * @param int|null $objectID optional page object id
+ * @return int number of outstanding items
*/
public function getOutstandingItemCount($objectID = null);
* Returns false if this page should be hidden from menus, but does not control the accessibility
* of the page itself. The visibility can optionally be scoped to the given object id.
*
- * @param integer|null $objectID optional page object id
+ * @param int|null $objectID optional page object id
* @return boolean false if the page should be hidden from menus
*/
public function isVisible($objectID = null);
/**
* Returns the link for a page with an object id.
*
- * @param integer $objectID page object id
+ * @param int $objectID page object id
* @return string page url
* @see ILookupPageHandler::getLink()
*/
/**
* Returns true if provided object id exists and is valid.
*
- * @param integer $objectID page object id
+ * @param int $objectID page object id
* @return boolean true if object id is valid
* @see ILookupPageHandler::isValid()
*/
* Returns false if this page should be hidden from menus, but does not control the accessibility
* of the page itself. The visibility can optionally be scoped to the given object id.
*
- * @param integer|null $objectID optional page object id
+ * @param int|null $objectID optional page object id
* @return boolean false if the page should be hidden from menus
* @see IMenuPageHandler::isVisible()
*/
/**
* Returns true if provided object id exists and is valid.
*
- * @param integer $objectID page object id
+ * @param int $objectID page object id
* @return boolean true if object id is valid
* @see ILookupPageHandler::isValid()
*/
* @param string $returnURL
* @param string $cancelReturnURL
* @param boolean $isRecurring
- * @param integer $subscriptionLength
+ * @param int $subscriptionLength
* @param string $subscriptionLengthUnit
*
* @return string
/**
* Processes the given transaction.
*
- * @param integer $paymentMethodObjectTypeID
+ * @param int $paymentMethodObjectTypeID
* @param string $token
* @param float $amount
* @param string $currency
/**
* current object id
- * @var integer
+ * @var int
*/
protected $objectID = 0;
/**
* poll id
- * @var integer
+ * @var int
*/
protected $pollID = 0;
/**
* Removes a list of polls by id.
*
- * @param integer[] $pollIDs
+ * @param int[] $pollIDs
*/
public function removePolls(array $pollIDs) {
$conditions = new PreparedStatementConditionBuilder();
* Sets object data.
*
* @param string $objectType
- * @param integer $objectID
- * @param integer $pollID
+ * @param int $objectID
+ * @param int $pollID
* @return boolean
* @throws SystemException
*/
* Handles poll creation, modification and deletion. Returns poll id or zero
* if poll was deleted or nothing was created.
*
- * @param integer $objectID
- * @return integer
+ * @param int $objectID
+ * @return int
* @throws SystemException
*/
public function save($objectID = null) {
*
* @param IPollContainer $pollContainer object the poll belongs to
* @param array $pollData poll data
- * @return null|integer id of the poll
+ * @return null|int id of the poll
* @since 5.2
*/
public function savePoll(IPollContainer $pollContainer, array $pollData) {
/**
* Returns a list of polls including options and vote state for current user.
*
- * @param integer[] $pollIDs
+ * @param int[] $pollIDs
* @return Poll[]
*/
public function getPolls(array $pollIDs) {
/**
* Returns a list of poll options with vote state for current user.
*
- * @param integer[] $pollIDs
+ * @param int[] $pollIDs
* @return PollOptionList
*/
public function getPollOptions(array $pollIDs) {
* Returns the handler object for given object type. Returns false if object type (id)
* is not found, or null if no handler is assigned.
*
- * @param integer $objectTypeID
+ * @param int $objectTypeID
* @param string $objectType
* @return mixed
* @throws SystemException
/**
* Returns a reaction type by id.
*
- * @param integer $reactionID
+ * @param int $reactionID
* @return ReactionType|null
*/
public function getReactionTypeByID($reactionID) {
* Builds the data attributes for the object container.
*
* @param string $objectTypeName
- * @param integer $objectID
+ * @param int $objectID
* @return string
*/
public function getDataAttributes($objectTypeName, $objectID) {
* Cache likeable objects.
*
* @param string $objectTypeName
- * @param integer[] $objectIDs
+ * @param int[] $objectIDs
*/
public function cacheLikeableObjects($objectTypeName, array $objectIDs) {
$objectType = $this->getObjectType($objectTypeName);
* Get an likeable object from the internal cache.
*
* @param string $objectTypeName
- * @param integer $objectID
+ * @param int $objectID
* @return ILikeObject
*/
public function getLikeableObject($objectTypeName, $objectID) {
* Returns a like object.
*
* @param ObjectType $objectType
- * @param integer $objectID
+ * @param int $objectID
* @return LikeObject|null
*/
public function getLikeObject(ObjectType $objectType, $objectID) {
*
* @param ObjectType $objectType
* @param array $objectIDs
- * @return integer
+ * @return int
*/
public function loadLikeObjects(ObjectType $objectType, array $objectIDs) {
if (empty($objectIDs)) {
*
* @param ILikeObject $likeable
* @param User $user
- * @param integer $reactionTypeID
- * @param integer $time
+ * @param int $reactionTypeID
+ * @param int $time
* @return array
* @throws DatabaseQueryException
*/
* Removes all reactions for given objects.
*
* @param string $objectType
- * @param integer[] $objectIDs
+ * @param int[] $objectIDs
* @param string[] $notificationObjectTypes
*/
public function removeReactions($objectType, array $objectIDs, array $notificationObjectTypes = []) {
* Returns the package id of the provided package.
*
* @param string $package
- * @return integer
+ * @return int
*/
protected function getPackageID($package) {
$packageObj = PackageCache::getInstance()->getPackageByIdentifier($package);
* Looks up a cms page URL, returns an array containing the application identifier
* and url controller name or null if there was no match.
*
- * @param integer $pageID page id
- * @param integer $languageID content language id
+ * @param int $pageID page id
+ * @param int $languageID content language id
* @return string[]|null
*/
public function lookupCmsPage($pageID, $languageID) {
* Passing in an illegal page id will cause this method to fail silently, returning an
* empty string.
*
- * @param integer $pageID page id
- * @param integer $languageID language id, optional
+ * @param int $pageID page id
+ * @param int $languageID language id, optional
* @return string full URL of empty string if `$pageID` is invalid
* @since 3.0
*/
/**
* current page id
- * @var integer
+ * @var int
*/
protected $pageID;
/**
* Returns the current page id.
*
- * @return integer current page id or `0` if unknown
+ * @return int current page id or `0` if unknown
*/
public function getPageID() {
if ($this->pageID === null) {
class ArticleSearch extends AbstractSearchableObjectType {
/**
* ids of the selected categories
- * @var integer[]
+ * @var int[]
*/
public $articleCategoryIDs = [];
* @param boolean $subjectOnly
* @param PreparedStatementConditionBuilder $searchIndexCondition
* @param string $orderBy
- * @param integer $limit
+ * @param int $limit
* @return array
*/
public function getInnerJoin($objectTypeName, $q, $subjectOnly = false, PreparedStatementConditionBuilder $searchIndexCondition = null, $orderBy = 'time DESC', $limit = 1000);
* @param PreparedStatementConditionBuilder $searchIndexCondition
* @param array $additionalConditions
* @param string $orderBy
- * @param integer $limit
+ * @param int $limit
* @return array
*/
public function search($q, array $objectTypes, $subjectOnly = false, PreparedStatementConditionBuilder $searchIndexCondition = null, array $additionalConditions = [], $orderBy = 'time DESC', $limit = 1000);
* Adds or updates an entry.
*
* @param string $objectType
- * @param integer $objectID
+ * @param int $objectID
* @param string $message
* @param string $subject
- * @param integer $time
- * @param integer $userID
+ * @param int $time
+ * @param int $userID
* @param string $username
- * @param integer $languageID
+ * @param int $languageID
* @param string $metaData
*/
public function set($objectType, $objectID, $message, $subject, $time, $userID, $username, $languageID = null, $metaData = '');
* Adds a new entry.
*
* @param string $objectType
- * @param integer $objectID
+ * @param int $objectID
* @param string $message
* @param string $subject
- * @param integer $time
- * @param integer $userID
+ * @param int $time
+ * @param int $userID
* @param string $username
- * @param integer $languageID
+ * @param int $languageID
* @param string $metaData
* @deprecated 3.0 - please use `set()` instead
*/
* Updates the search index.
*
* @param string $objectType
- * @param integer $objectID
+ * @param int $objectID
* @param string $message
* @param string $subject
- * @param integer $time
- * @param integer $userID
+ * @param int $time
+ * @param int $userID
* @param string $username
- * @param integer $languageID
+ * @param int $languageID
* @param string $metaData
* @deprecated 3.0 - please use `set() instead`
*/
* Deletes search index entries.
*
* @param string $objectType
- * @param integer[] $objectIDs
+ * @param int[] $objectIDs
*/
public function delete($objectType, array $objectIDs);
/**
* Returns the object with the given object id.
*
- * @param integer $objectID
+ * @param int $objectID
* @return ISearchResultObject
*/
public function getObject($objectID);
class SearchEngine extends SingletonFactory implements ISearchEngine {
/**
* limit for inner search limits
- * @var integer
+ * @var int
*/
const INNER_SEARCH_LIMIT = 2500;
* Returns the id of the object type with the given name.
*
* @param string $objectType
- * @return integer
+ * @return int
* @throws SystemException
*/
public function getObjectTypeID($objectType) {
class SearchResultTextParser extends SingletonFactory {
/**
* max length for message abstract
- * @var integer
+ * @var int
*/
const MAX_LENGTH = 500;
* Returns a list of search result collections for given query.
*
* @param string $query
- * @param integer $limit
+ * @param int $limit
* @param string $providerName
* @return ACPSearchResultList[]
* @throws ImplementationException
class ACPSearchResultList implements \Countable, \Iterator {
/**
* current iterator index
- * @var integer
+ * @var int
*/
protected $index = 0;
* Reduces the result collection by given count. If the count is higher
* than the actual amount of results, the results will be cleared.
*
- * @param integer $count
+ * @param int $count
*/
public function reduceResults($count) {
// more results than available should be wiped, just set it to 0
/**
* Reduces the result collection to specified size.
*
- * @param integer $size
+ * @param int $size
*/
public function reduceResultsTo($size) {
$count = count($this->results);
* Returns a level 1 or 2 category id for given category name.
*
* @param string $categoryName
- * @return integer
+ * @return int
*/
protected function getCategoryID($categoryName) {
return $this->getTopCategory($categoryName)->categoryID;
class MysqlSearchEngine extends AbstractSearchEngine {
/**
* MySQL's minimum word length for fulltext indices
- * @var integer
+ * @var int
*/
protected $ftMinWordLen = null;
* @package WoltLabSuite\Core\System\Session
*
* @property-read string $sessionID unique textual identifier of the session
- * @property-read integer|null $userID id of the user the session belongs to or `null` if the session belongs to a guest
- * @property-read integer|null $pageID id of the latest page visited
- * @property-read integer|null $pageObjectID id of the object the latest page visited belongs to
- * @property-read integer|null $parentPageID id of the parent page of latest page visited
- * @property-read integer|null $parentPageObjectID id of the object the parent page of latest page visited belongs to
- * @property-read integer $spiderID id of the spider the session belongs to
+ * @property-read int|null $userID id of the user the session belongs to or `null` if the session belongs to a guest
+ * @property-read int|null $pageID id of the latest page visited
+ * @property-read int|null $pageObjectID id of the object the latest page visited belongs to
+ * @property-read int|null $parentPageID id of the parent page of latest page visited
+ * @property-read int|null $parentPageObjectID id of the object the parent page of latest page visited belongs to
+ * @property-read int $spiderID id of the spider the session belongs to
*/
final class SessionHandler extends SingletonFactory {
/**
/**
* language id for active user
- * @var integer
+ * @var int
*/
protected $languageID = 0;
/**
* language ids for active user
- * @var integer[]
+ * @var int[]
*/
protected $languageIDs = null;
/**
* style id
- * @var integer
+ * @var int
*/
protected $styleID = null;
/**
* Returns language ids for active user.
*
- * @return integer[]
+ * @return int[]
*/
public function getLanguageIDs() {
$this->loadLanguageIDs();
/**
* Returns currently active language id.
*
- * @return integer
+ * @return int
*/
public function getLanguageID() {
return $this->languageID;
/**
* Sets the currently active language id.
*
- * @param integer $languageID
+ * @param int $languageID
*/
public function setLanguageID($languageID) {
$this->languageID = $languageID;
/**
* Returns currently active style id.
*
- * @return integer
+ * @return int
*/
public function getStyleID() {
return $this->styleID;
/**
* Sets the currently active style id.
*
- * @param integer $styleID
+ * @param int $styleID
*/
public function setStyleID($styleID) {
$this->styleID = $styleID;
/**
* Resets session-specific storage data.
*
- * @param integer[] $userIDs
+ * @param int[] $userIDs
*/
public static function resetSessions(array $userIDs = []) {
if (!empty($userIDs)) {
* Creates a file in the target directory.
*
* @param string $file
- * @param integer $index
+ * @param int $index
* @param Tar $tar
*/
protected function createFile($file, $index, Tar $tar) {
/**
* Counts the number of rows for a single day.
*
- * @param integer $date
+ * @param int $date
* @param string $tableName
* @param string $dateColumnName
- * @return integer
+ * @return int
*/
protected function getCounter($date, $tableName, $dateColumnName) {
$conditionBuilder = new PreparedStatementConditionBuilder();
/**
* Counts the total number of rows.
*
- * @param integer $date
+ * @param int $date
* @param string $tableName
* @param string $dateColumnName
- * @return integer
+ * @return int
*/
protected function getTotal($date, $tableName, $dateColumnName) {
$conditionBuilder = new PreparedStatementConditionBuilder();
/**
* Returns the stats.
*
- * @param integer $date
+ * @param int $date
* @return array
*/
public function getData($date);
/**
* Returns a formatted counter value.
*
- * @param integer $counter
+ * @param int $counter
* @return mixed
*/
public function getFormattedCounter($counter);
/**
* Changes the active style.
*
- * @param integer $styleID
+ * @param int $styleID
* @param boolean $ignorePermissions
* @throws SystemException
*/
/**
* Returns number of available styles.
*
- * @return integer
+ * @return int
*/
public function countStyles() {
return count($this->getAvailableStyles());
class TagCloud {
/**
* max font size
- * @var integer
+ * @var int
* @deprecated 3.0
*/
const MAX_FONT_SIZE = 170;
/**
* min font size
- * @var integer
+ * @var int
* @deprecated 3.0
*/
const MIN_FONT_SIZE = 85;
/**
* max value of tag counter
- * @var integer
+ * @var int
*/
protected $maxCounter = 0;
/**
* min value of tag counter
- * @var integer
+ * @var int
*/
protected $minCounter = 4294967295;
/**
* active language ids
- * @var integer[]
+ * @var int[]
*/
protected $languageIDs = [];
/**
* Constructs a new TagCloud object.
*
- * @param integer[] $languageIDs
+ * @param int[] $languageIDs
*/
public function __construct(array $languageIDs = []) {
$this->languageIDs = $languageIDs;
/**
* Returns a list of weighted tags.
*
- * @param integer $slice
+ * @param int $slice
* @return TagCloudTag[] the tags to get
*/
public function getTags($slice = 50) {
/**
* Calculates the weight of the tag based on the given tag count.
*
- * @param integer $counter
+ * @param int $counter
* @return float|int
*/
private function calculateWeight($counter) {
* Adds tags to a tagged object.
*
* @param string $objectType
- * @param integer $objectID
+ * @param int $objectID
* @param array $tags
- * @param integer $languageID
+ * @param int $languageID
* @param boolean $replace
*/
public function addObjectTags($objectType, $objectID, array $tags, $languageID, $replace = true) {
* Deletes all tags assigned to given tagged object.
*
* @param string $objectType
- * @param integer $objectID
- * @param integer $languageID
+ * @param int $objectID
+ * @param int $languageID
*/
public function deleteObjectTags($objectType, $objectID, $languageID = null) {
$objectTypeID = $this->getObjectTypeID($objectType);
* Deletes all tags assigned to given tagged objects.
*
* @param string $objectType
- * @param integer[] $objectIDs
+ * @param int[] $objectIDs
*/
public function deleteObjects($objectType, array $objectIDs) {
$objectTypeID = $this->getObjectTypeID($objectType);
* Returns all tags set for given object.
*
* @param string $objectType
- * @param integer $objectID
- * @param integer[] $languageIDs
+ * @param int $objectID
+ * @param int[] $languageIDs
* @return Tag[]
*/
public function getObjectTags($objectType, $objectID, array $languageIDs = []) {
* Returns all tags set for given objects.
*
* @param string $objectType
- * @param integer[] $objectIDs
- * @param integer[] $languageIDs
+ * @param int[] $objectIDs
+ * @param int[] $languageIDs
* @return array
*/
public function getObjectsTags($objectType, array $objectIDs, array $languageIDs = []) {
* Returns id of the object type with the given name.
*
* @param string $objectType
- * @return integer
+ * @return int
* @throws InvalidObjectTypeException
*/
public function getObjectTypeID($objectType) {
* there are two or more top language ids with the same amount of tags.
*
* @param string $objectType
- * @param integer $objectID
- * @return integer|null
+ * @param int $objectID
+ * @return int|null
*/
public function getImplicitLanguageID($objectType, $objectID) {
$existingTags = $this->getObjectTags($objectType, $objectID);
class TypedTagCloud extends TagCloud {
/**
* object type ids
- * @var integer[]
+ * @var int[]
*/
protected $objectTypeIDs = [];
* Constructs a new TypedTagCloud object.
*
* @param string $objectType
- * @param integer[] $languageIDs
+ * @param int[] $languageIDs
*/
public function __construct($objectType, array $languageIDs = []) {
$objectTypeObj = ObjectTypeCache::getInstance()->getObjectTypeByName('com.woltlab.wcf.tagging.taggableObject', $objectType);
/**
* This method always throws, because changing the template group is not supported.
*
- * @param integer $templateGroupID
+ * @param int $templateGroupID
* @throws \BadMethodCallException
*/
public function setTemplateGroupID($templateGroupID) {
/**
* This method always throws, because changing the template group is not supported.
*
- * @param integer $templateGroupID
+ * @param int $templateGroupID
* @throws \BadMethodCallException
*/
public function setTemplateGroupID($templateGroupID) {
/**
* active language id used to identify specific language versions of compiled templates
- * @var integer
+ * @var int
*/
public $languageID = 0;
/**
* active template group id
- * @var integer
+ * @var int
*/
protected $templateGroupID = 0;
/**
* Sets active language id.
*
- * @param integer $languageID
+ * @param int $languageID
*/
public function setLanguageID($languageID) {
$this->languageID = $languageID;
/**
* Returns the active template group id.
*
- * @return integer
+ * @return int
*/
public function getTemplateGroupID() {
return $this->templateGroupID;
/**
* Sets the active template group id.
*
- * @param integer $templateGroupID
+ * @param int $templateGroupID
*/
public function setTemplateGroupID($templateGroupID) {
if ($templateGroupID && !isset($this->templateGroupCache[$templateGroupID])) {
*
* @param string $errorMsg
* @param string $file
- * @param integer $line
+ * @param int $line
* @return string
*/
public static function formatSyntaxError($errorMsg, $file = null, $line = null) {
/**
* Returns the current line number.
*
- * @return integer
+ * @return int
*/
public function getCurrentLineNo() {
return $this->currentLineNo;
class EmbeddedObjectBlockTemplatePlugin implements IBlockTemplatePlugin {
/**
* internal loop counter
- * @var integer
+ * @var int
*/
protected $counter = 0;
class LinkBlockTemplatePlugin implements IBlockTemplatePlugin {
/**
* internal loop counter
- * @var integer
+ * @var int
*/
protected $counter = 0;
class PageBlockTemplatePlugin implements IBlockTemplatePlugin {
/**
* internal loop counter
- * @var integer
+ * @var int
*/
protected $counter = 0;
* Inserts the page number into the link.
*
* @param string $link
- * @param integer $pageNo
+ * @param int $pageNo
* @return string final link
*/
protected static function insertPageNumber($link, $pageNo) {
* Generates HTML code for a link.
*
* @param string $link
- * @param integer $pageNo
- * @param integer $activePage
- * @param integer $pages
+ * @param int $pageNo
+ * @param int $activePage
+ * @param int $pages
* @return string
*/
protected function makeLink($link, $pageNo, $activePage, $pages) {
* Generates HTML code for 'previous' link.
*
* @param string $link
- * @param integer $pageNo
+ * @param int $pageNo
* @return string
*/
protected function makePreviousLink($link, $pageNo) {
* Generates HTML code for 'next' link.
*
* @param string $link
- * @param integer $pageNo
- * @param integer $pages
+ * @param int $pageNo
+ * @param int $pages
* @return string
*/
protected function makeNextLink($link, $pageNo, $pages) {
/**
* Assign trophies based on rules.
*
- * @param integer $maxAssigns
+ * @param int $maxAssigns
*/
public function assignTrophies($maxAssigns = 500) {
$trophyList = new TrophyList();
/**
* Revoke user trophies which are not longer fulfills the conditions.
*
- * @param integer $maxRevokes
+ * @param int $maxRevokes
* @since 5.2
*/
public function revokeTrophies($maxRevokes = 500) {
* Returns the users who fulfill all conditions of the given trophy.
*
* @param Trophy $trophy
- * @return integer[]
+ * @return int[]
* @since 5.2
*/
private function getUserIDs(Trophy $trophy) {
* Returns the userTrophyIDs of the users, which no longer fulfills the trophy conditions.
*
* @param Trophy $trophy
- * @param integer $maxTrophyIDs maximum number of trophies that are processed
- * @return integer[]
+ * @param int $maxTrophyIDs maximum number of trophies that are processed
+ * @return int[]
* @since 5.2
*/
private function getRevocableUserTrophyIDs(Trophy $trophy, $maxTrophyIDs) {
*/
class AvatarUploadFileSaveStrategy implements IUploadFileSaveStrategy {
/**
- * @var integer
+ * @var int
*/
protected $userID = 0;
/**
* Creates a new instance of AvatarUploadFileSaveStrategy.
*
- * @param integer $userID
+ * @param int $userID
*/
public function __construct($userID = null) {
$this->userID = ($userID ?: WCF::getUser()->userID);
class DefaultUploadFileValidationStrategy implements IUploadFileValidationStrategy {
/**
* allowed max size
- * @var integer
+ * @var int
*/
protected $maxFilesize = 0;
/**
* Creates a new DefaultUploadFileValidationStrategy object.
*
- * @param integer $maxFilesize
+ * @param int $maxFilesize
* @param string[] $fileExtensions
*/
public function __construct($maxFilesize, array $fileExtensions) {
class TrophyImageUploadFileValidationStrategy implements IUploadFileValidationStrategy {
/**
* minimum trophy image width and height
- * @var integer
+ * @var int
*/
const MIN_TROPHY_IMAGE_SIZE = 64;
/**
* internal file id
- * @var integer
+ * @var int
*/
protected $internalFileID = 0;
/**
* file size
- * @var integer
+ * @var int
*/
protected $filesize = 0;
/**
* file upload error code
- * @var integer
+ * @var int
*/
protected $errorCode = 0;
*
* @param string $filename
* @param string $location
- * @param integer $filesize
- * @param integer $errorCode
+ * @param int $filesize
+ * @param int $errorCode
* @param string $mimeType
*
* @throws \Exception if an error occurred during upload and debug mode is enabled
/**
* Returns internal file id.
*
- * @return integer
+ * @return int
*/
public function getInternalFileID() {
return $this->internalFileID;
/**
* Returns the file size.
*
- * @return integer
+ * @return int
*/
public function getFilesize() {
return $this->filesize;
/**
* Returns the error code.
*
- * @return integer
+ * @return int
*/
public function getErrorCode() {
return $this->errorCode;
*/
class UserCoverPhotoUploadFileSaveStrategy implements IUploadFileSaveStrategy {
/**
- * @var integer
+ * @var int
*/
protected $userID = 0;
/**
* Creates a new instance of UserCoverPhotoUploadFileSaveStrategy.
*
- * @param integer $userID
+ * @param int $userID
*/
public function __construct($userID = null) {
$this->userID = ($userID ?: WCF::getUser()->userID);
/**
* current iterator index
- * @var integer
+ * @var int
*/
protected $index = 0;
/**
* list of user ids assigned for this group
- * @var integer[]
+ * @var int[]
*/
protected $userIDs = [];
/**
* Adds a list of user ids to this group.
*
- * @param integer[] $userIDs
+ * @param int[] $userIDs
*/
public function addUserIDs(array $userIDs) {
foreach ($userIDs as $userID) {
class UserBirthdayCache extends SingletonFactory {
/**
* loaded months
- * @var integer[]
+ * @var int[]
*/
protected $monthsLoaded = [];
/**
* user birthdays
- * @var integer[][]
+ * @var int[][]
*/
protected $birthdays = [];
/**
* Loads the birthday cache.
*
- * @param integer $month
+ * @param int $month
*/
protected function loadMonth($month) {
if (!isset($this->monthsLoaded[$month])) {
/**
* Returns the user birthdays for a specific day.
*
- * @param integer $month
- * @param integer $day
- * @return integer[] list of user ids
+ * @param int $month
+ * @param int $day
+ * @return int[] list of user ids
*/
public function getBirthdays($month, $day) {
$this->loadMonth($month);
/**
* Returns an object type by id.
*
- * @param integer $objectTypeID
+ * @param int $objectTypeID
* @return ObjectType
*/
public function getObjectType($objectTypeID) {
* Returns an object type id by object type name.
*
* @param string $objectType
- * @return integer
+ * @return int
*/
public function getObjectTypeID($objectType) {
if (isset($this->objectTypes['names'][$objectType])) {
* Fires a new activity event.
*
* @param string $objectType
- * @param integer $objectID
- * @param integer $languageID
- * @param integer $userID
- * @param integer $time
+ * @param int $objectID
+ * @param int $languageID
+ * @param int $userID
+ * @param int $time
* @param array $additionalData
* @return \wcf\data\user\activity\event\UserActivityEvent
* @throws SystemException
/**
* Removes an activity event.
*
- * @param integer $objectType
- * @param integer $objectID
- * @param integer $userID
+ * @param int $objectType
+ * @param int $objectID
+ * @param int $userID
* @throws SystemException
*/
public function removeEvent($objectType, $objectID, $userID = null) {
* Removes activity events.
*
* @param string $objectType
- * @param integer[] $objectIDs
+ * @param int[] $objectIDs
* @throws SystemException
*/
public function removeEvents($objectType, array $objectIDs) {
* Adds a new user activity point event.
*
* @param string $objectType
- * @param integer $objectID
- * @param integer $userID
+ * @param int $objectID
+ * @param int $userID
* @param mixed[] $additionalData
* @throws InvalidObjectTypeException
* @throws SystemException
* )
*
* @param string $objectType
- * @param integer[] $itemsToUser
+ * @param int[] $itemsToUser
* @param boolean $updateUsers
* @throws InvalidObjectTypeException
*/
* Removes activity point events.
*
* @param string $objectType
- * @param integer[] $userToItems
+ * @param int[] $userToItems
* @throws InvalidObjectTypeException
*/
public function removeEvents($objectType, array $userToItems) {
/**
* Updates total activity points and ranks for given user ids.
*
- * @param integer[] $userIDs
+ * @param int[] $userIDs
*/
public function updateUsers(array $userIDs) {
$userIDs = array_unique($userIDs);
* Returns the user activity point event object type with the given id or
* null if no such object type exists.
*
- * @param integer $objectTypeID
+ * @param int $objectTypeID
* @return ObjectType
*/
public function getObjectType($objectTypeID) {
/**
* Updates the user ranks for the given users.
*
- * @param integer[] $userIDs
+ * @param int[] $userIDs
*/
protected function updateUserRanks(array $userIDs) {
$action = new UserProfileAction($userIDs, 'updateUserRank');
/**
* list of collapsed object ids per object type id
- * @var integer[][]
+ * @var int[][]
*/
protected $collapsedContent = [];
* null, if object type is unknown.
*
* @param string $objectType
- * @return integer
+ * @return int
*/
public function getObjectTypeID($objectType) {
if (isset($this->cache['objectTypeIDs'][$objectType])) {
/**
* Returns a list of object ids being collapsed by current user.
*
- * @param integer $objectTypeID
- * @return integer[]
+ * @param int $objectTypeID
+ * @return int[]
*/
public function getCollapsedContent($objectTypeID) {
if (!isset($this->collapsedContent[$objectTypeID])) {
/**
* Marks content as collapsed.
*
- * @param integer $objectTypeID
+ * @param int $objectTypeID
* @param string $objectID
*/
public function markAsCollapsed($objectTypeID, $objectID) {
/**
* Marks content as opened, thus removing the collapsed marking.
*
- * @param integer $objectTypeID
+ * @param int $objectTypeID
* @param string $objectID
*/
public function markAsOpened($objectTypeID, $objectID) {
/**
* Deletes all saved states for a specific object type.
*
- * @param integer $objectTypeID
+ * @param int $objectTypeID
*/
public function reset($objectTypeID) {
if (WCF::getUser()->userID) {
* specific object type for all users.
*
* @param string $objectType
- * @param integer $objectID
+ * @param int $objectID
* @throws InvalidObjectTypeException
*/
public function resetAll($objectType, $objectID = null) {
* Note: This method uses the user ids as a parameter instead of user objects
* on purpose to make sure the latest data of the users are fetched.
*
- * @param integer[] $userIDs
+ * @param int[] $userIDs
*/
public function checkUsers(array $userIDs) {
if (empty($userIDs)) return;
* assignment.
*
* @param UserGroupAssignment $assignment
- * @param integer $maxUsers
+ * @param int $maxUsers
* @return User[]
*/
public function getUsers(UserGroupAssignment $assignment, $maxUsers = null) {
* Returns a new user notification object based on the given data.
*
* @param UserProfile $author
- * @param integer $timesTriggered
- * @param integer $guestTimesTriggered
+ * @param int $timesTriggered
+ * @param int $guestTimesTriggered
* @param array $additionalData
* @return UserNotification
*/
/**
* number of outstanding notifications
- * @var integer
+ * @var int
*/
protected $notificationCount = null;
* @param string $eventName
* @param string $objectType
* @param IUserNotificationObject $notificationObject
- * @param integer[] $recipientIDs
+ * @param int[] $recipientIDs
* @param mixed[] $additionalData
- * @param integer $baseObjectID
+ * @param int $baseObjectID
* @throws SystemException
*/
public function fireEvent($eventName, $objectType, IUserNotificationObject $notificationObject, array $recipientIDs, array $additionalData = [], $baseObjectID = 0) {
* Returns the number of outstanding notifications for the active user.
*
* @param boolean $skipCache
- * @return integer
+ * @return int
*/
public function getNotificationCount($skipCache = false) {
if ($this->notificationCount === null || $skipCache) {
/**
* Counts all existing notifications for current user and returns it.
*
- * @return integer
+ * @return int
*/
public function countAllNotifications() {
$sql = "SELECT COUNT(*)
/**
* Returns a list of notifications.
*
- * @param integer $limit
- * @param integer $offset
+ * @param int $limit
+ * @param int $offset
* @param boolean $showConfirmedNotifications DEPRECATED
* @return mixed[]
*/
/**
* Fetches a list of notifications based upon given conditions.
*
- * @param integer $limit
- * @param integer $offset
+ * @param int $limit
+ * @param int $offset
* @param mixed $filterByConfirmed
* @return UserNotification[]
*/
/**
* Retrieves a notification id.
*
- * @param integer $eventID
- * @param integer $objectID
- * @param integer $authorID
- * @param integer $time
- * @return integer
+ * @param int $eventID
+ * @param int $objectID
+ * @param int $authorID
+ * @param int $time
+ * @return int
* @throws SystemException
*/
public function getNotificationID($eventID, $objectID, $authorID = null, $time = null) {
* Returns object type id by name.
*
* @param string $objectType
- * @return integer
+ * @return int
*/
public function getObjectTypeID($objectType) {
if (isset($this->objectTypes[$objectType])) {
*
* @param string $eventName
* @param string $objectType
- * @param integer[] $recipientIDs
- * @param integer[] $objectIDs
+ * @param int[] $recipientIDs
+ * @param int[] $objectIDs
*/
public function deleteNotifications($eventName, $objectType, array $recipientIDs, array $objectIDs = []) {
$this->markAsConfirmed($eventName, $objectType, $recipientIDs, $objectIDs);
* Removes notifications, this method should only be invoked for delete objects.
*
* @param string $objectType
- * @param integer[] $objectIDs
+ * @param int[] $objectIDs
* @throws SystemException
*/
public function removeNotifications($objectType, array $objectIDs) {
*
* @param string $eventName
* @param string $objectType
- * @param integer[] $recipientIDs
- * @param integer[] $objectIDs
+ * @param int[] $recipientIDs
+ * @param int[] $objectIDs
* @throws SystemException
*/
public function markAsConfirmed($eventName, $objectType, array $recipientIDs, array $objectIDs = []) {
/**
* Marks a single notification id as confirmed.
*
- * @param integer $notificationID
+ * @param int $notificationID
* @deprecated 5.2 Please use `UserNotificationHandler::markAsConfirmedByIDs()` instead.
*/
public function markAsConfirmedByID($notificationID) {
/**
* Marks a list of notification ids as confirmed.
*
- * @param integer[] $notificationIDs
+ * @param int[] $notificationIDs
*/
public function markAsConfirmedByIDs(array $notificationIDs) {
if (empty($notificationIDs)) {
* that is both unread and newer than `$lastRequestTimestamp`. May return an
* empty array if there is no new notification.
*
- * @param integer $lastRequestTimestamp
+ * @param int $lastRequestTimestamp
* @return string[]
*/
public function getLatestNotification($lastRequestTimestamp) {
/**
* Returns the author id for this notification event.
*
- * @return integer
+ * @return int
*/
public function getAuthorID();
/**
* Returns the liked comment's id.
*
- * @return integer
+ * @return int
*/
protected function getCommentID() {
// this is the `wcfN_like.objectID` value
/**
* Returns the liked response's id.
*
- * @return integer
+ * @return int
*/
protected function getResponseID() {
// this is the `wcfN_like.objectID` value
/**
* Returns the ID of the related object.
*
- * @return integer
+ * @return int
*/
public function getRelatedObjectID();
}
/**
* Returns the user id of the author of this object.
*
- * @return integer
+ * @return int
*/
public function getAuthorID();
}
/**
* Returns owner id of comment context.
*
- * @param integer $objectID
- * @return integer
+ * @param int $objectID
+ * @return int
*/
public function getOwnerID($objectID);
}
* Returns the user id of the comment owner.
*
* @param Comment $comment
- * @return integer
+ * @return int
*/
public function getCommentOwnerID(Comment $comment);
}
* is returned, no notifications should be sent.
*
* @param Comment $comment
- * @return integer[]
+ * @return int[]
*/
public function getRecipientIDs(Comment $comment);
}
/**
* Returns notification objects by their IDs.
*
- * @param integer[] $objectIDs
+ * @param int[] $objectIDs
* @return IUserNotificationObject[]
*/
public function getObjectsByIDs(array $objectIDs);
/**
* Validates the given object id. Throws an exception on error.
*
- * @param integer $objectID
+ * @param int $objectID
* @throws \wcf\system\exception\UserException
*/
public function validateObjectID($objectID);
/**
* Resets the user storage for given users.
*
- * @param integer[] $userIDs
+ * @param int[] $userIDs
*/
public function resetUserStorage(array $userIDs);
}
* Returns the id of the given object type.
*
* @param string $objectTypeName
- * @return integer
+ * @return int
* @throws SystemException
*/
public function getObjectTypeID($objectTypeName) {
* Resets the object watch cache for all subscriber of the given object.
*
* @param string $objectType
- * @param integer[] $objectIDs
+ * @param int[] $objectIDs
*/
public function resetObjects($objectType, array $objectIDs) {
// get object type id
* Deletes the given objects.
*
* @param string $objectType
- * @param integer[] $objectIDs
- * @param integer[] $userIDs
+ * @param int[] $objectIDs
+ * @param int[] $userIDs
*/
public function deleteObjects($objectType, array $objectIDs, array $userIDs = []) {
// get object type id
* Updates a watched object for all subscriber.
*
* @param string $objectType
- * @param integer $objectID
+ * @param int $objectID
* @param string $notificationEventName
* @param string $notificationObjectType
* @param IUserNotificationObject $notificationObject
/**
* The userIDs which are cached by the message embedded object manager.
- * @var integer[]
+ * @var int[]
*/
protected $cachedUserIDs = [];
/**
* Loads the embedded objects for the given users.
*
- * @param integer[] $userIDs
+ * @param int[] $userIDs
* @since 5.2
*/
public function cacheUserSignature(array $userIDs) {
/**
* Loads storage for a given set of users.
*
- * @param integer[] $userIDs
+ * @param int[] $userIDs
*/
public function loadStorage(array $userIDs) {
$this->validateUserIDs($userIDs);
/**
* Returns stored data for given users.
*
- * @param integer[] $userIDs
+ * @param int[] $userIDs
* @param string $field
* @return mixed[]
*/
* data for the user has been loaded yet!
*
* @param string $field
- * @param integer $userID
+ * @param int $userID
* @return mixed
*/
public function getField($field, $userID = null) {
/**
* Inserts new data records into database.
*
- * @param integer $userID
+ * @param int $userID
* @param string $field
* @param string $fieldValue
*/
/**
* Removes a data record from database.
*
- * @param integer[] $userIDs
+ * @param int[] $userIDs
* @param string $field
*/
public function reset(array $userIDs, $field) {
* Returns the number of stored versions for provided object type and object id.
*
* @param string $objectTypeName object type name
- * @param integer $objectID target object id
- * @return integer number of stored versions
+ * @param int $objectID target object id
+ * @return int number of stored versions
*/
public function countVersions($objectTypeName, $objectID) {
$objectType = $this->getObjectType($objectTypeName);
* Returns the last stored version.
*
* @param string $objectTypeName object type name
- * @param integer $objectID target object id
+ * @param int $objectID target object id
* @return VersionTrackerEntry|null|DatabaseObject
*/
public function getLastVersion($objectTypeName, $objectID) {
* Returns the list of stored versions.
*
* @param string $objectTypeName object type name
- * @param integer $objectID target object id
+ * @param int $objectID target object id
* @return VersionTrackerEntry[]
*/
public function getVersions($objectTypeName, $objectID) {
* Returns a version including the contents of the data column.
*
* @param string $objectTypeName object type name
- * @param integer $versionID version id
+ * @param int $versionID version id
* @return VersionTrackerEntry|null|DatabaseObject
*/
public function getVersion($objectTypeName, $versionID) {
* Resets the entire history for provided object id.
*
* @param string $objectTypeName object type name
- * @param integer $objectID object id
+ * @param int $objectID object id
*/
public function reset($objectTypeName, $objectID) {
$objectType = $this->getObjectType($objectTypeName);
* @package WoltLabSuite\Core\System\Version
* @since 3.1
*
- * @property-read integer $versionID unique id of the tracked version entry
- * @property-read integer $objectID id of the edited object
- * @property-read integer|null $userID id of the user who has created the previous version of the object or `null` if the user does not exist anymore or if the previous version has been created by a guest
+ * @property-read int $versionID unique id of the tracked version entry
+ * @property-read int $objectID id of the edited object
+ * @property-read int|null $userID id of the user who has created the previous version of the object or `null` if the user does not exist anymore or if the previous version has been created by a guest
* @property-read string $username name of the user who has created the previous version of the object
- * @property-read integer $time timestamp at which the original version has been created
+ * @property-read int $time timestamp at which the original version has been created
*/
class VersionTrackerEntry {
/**
/**
* VersionTrackerEntry constructor.
*
- * @param integer $id id
+ * @param int $id id
* @param array $data version data
*/
public function __construct($id, array $data) {
* Returns the stored value of a property or null if unknown.
*
* @param string $property property name
- * @param integer $languageID language id
+ * @param int $languageID language id
* @return string
*/
public function getPayload($property, $languageID) {
* properties will be set to an empty string.
*
* @param string[] $properties list of property names
- * @param integer $languageID language id
+ * @param int $languageID language id
* @return string[]
*/
public function getPayloadForProperties(array $properties, $languageID) {
/**
* Returns the list of language ids.
*
- * @return integer[]
+ * @return int[]
*/
public function getLanguageIDs() {
return array_keys($this->payload);
class VisitTracker extends SingletonFactory {
/**
* default tracking lifetime
- * @var integer
+ * @var int
*/
const DEFAULT_LIFETIME = 604800; // = one week
* Returns the object type id of the given visit tracker object type.
*
* @param string $objectType
- * @return integer
+ * @return int
* @throws SystemException
*/
public function getObjectTypeID($objectType) {
* Returns the last visit time for a whole object type.
*
* @param string $objectType
- * @return integer
+ * @return int
*/
public function getVisitTime($objectType) {
$objectTypeID = $this->getObjectTypeID($objectType);
* Returns the last visit time for a specific object.
*
* @param string $objectType
- * @param integer $objectID
- * @return integer
+ * @param int $objectID
+ * @return int
*/
public function getObjectVisitTime($objectType, $objectID) {
if (WCF::getUser()->userID) {
* Tracks an object visit for the users with the given ids.
*
* @param string $objectType
- * @param integer $objectID
- * @param integer[] $userIDs
+ * @param int $objectID
+ * @param int[] $userIDs
* @param int $time
*/
public function trackObjectVisitByUserIDs($objectType, $objectID, array $userIDs, $time = TIME_NOW) {
* Tracks an object visit.
*
* @param string $objectType
- * @param integer $objectID
- * @param integer $time
+ * @param int $objectID
+ * @param int $time
*/
public function trackObjectVisit($objectType, $objectID, $time = TIME_NOW) {
if (WCF::getUser()->userID) {
* Tracks an object type visit.
*
* @param string $objectType
- * @param integer $time
+ * @param int $time
*/
public function trackTypeVisit($objectType, $time = TIME_NOW) {
if (WCF::getUser()->userID) {
* Returns the value of the permissions for the provided user ids. The special index `0` is
* automatically added and represents a guest user.
*
- * @param integer[] $userIDs
+ * @param int[] $userIDs
* @param string[] $permissions
* @return mixed[] permission value per user id
*/
* with the return value of `getBulkUserPermissions()`.
*
* @param mixed[] $userPermissions
- * @param integer $userID
+ * @param int $userID
* @param string $permission
* @return mixed
*/
abstract class AbstractWorker implements IWorker {
/**
* count of total actions (limited by $limit per loop)
- * @var integer
+ * @var int
*/
protected $count = null;
/**
* limit of actions per loop
- * @var integer
+ * @var int
*/
protected $limit = 0;
/**
* current loop count
- * @var integer
+ * @var int
*/
protected $loopCount = 0;
/**
* Sets current loop count.
*
- * @param integer $loopCount
+ * @param int $loopCount
*/
public function setLoopCount($loopCount);
/**
- * Returns current process of the worker, an integer between 0 and 100.
+ * Returns current process of the worker, an int between 0 and 100.
* If the progress hits 100, the worker will terminate.
*
- * @return integer
+ * @return int
*/
public function getProgress();
/**
* start timestamp
- * @var integer
+ * @var int
*/
protected $startDate = 0;
/**
* Formats time.
*
- * @param integer $timestamp
+ * @param int $timestamp
* @return string
*/
public static function formatTime($timestamp) {
/**
* Formats dates.
*
- * @param integer $timestamp
+ * @param int $timestamp
* @return string
*/
public static function formatDate($timestamp) {
/**
* result date
- * @var integer[]
+ * @var int[]
*/
protected static $result = [];
/**
* time base used as reference for finding the next execution time
- * @var integer
+ * @var int
*/
protected static $timeBase = 0;
/**
* valid ranges for each known field (range for 'day of month' is missing
* since it varies from month to month)
- * @var integer[]
+ * @var int[]
*/
public static $ranges = [
'minute' => [0, 59],
* @param string $dom
* @param string $month
* @param string $dow
- * @param integer $timeBase
- * @return integer
+ * @param int $timeBase
+ * @return int
*/
public static function calculateNextExec($minute, $hour, $dom, $month, $dow, $timeBase = TIME_NOW) {
// using the native `date()` and `mktime()` functions is dangerous
/**
* Calculates the next month and year to match given criteria.
*
- * @param integer $month
- * @param integer $year
+ * @param int $month
+ * @param int $year
* @param array $values
* @return array
*/
/**
* Calculates the date of next execution based upon a given set for day of week.
*
- * @param integer $month
- * @param integer $year
+ * @param int $month
+ * @param int $year
* @param array $values
- * @param integer $day
+ * @param int $day
* @return array
*/
protected static function calculateDow($month, $year, array &$values, $day = 1) {
/**
* Calculates the date of next execution based upon a given set for day of month.
*
- * @param integer $month
- * @param integer $year
+ * @param int $month
+ * @param int $year
* @param array $values
- * @param integer $day
+ * @param int $day
* @return array
*/
protected static function calculateDom($month, $year, array &$values, $day = 1) {
* had been added in order to match expression for hour and minutes.
*
* @param array $values
- * @param integer $timeBase
- * @return integer
+ * @param int $timeBase
+ * @return int
*/
protected static function calculateHour(array &$values, &$timeBase) {
$addAnDay = false;
* is past the current hour, thus requires to add at least one hour.
*
* @param array $values
- * @param integer $timeBase
+ * @param int $timeBase
* @param boolean $addAnDay
* @return boolean
*/
* needle. If $continue is not set to false and foreach-loop is out of bounds,
* then the array-index '0' is returned, referring the first item.
*
- * @param integer $needle
+ * @param int $needle
* @param array $haystack
* @param boolean $continue
* @return mixed
/**
* Calculates all values for a given range.
*
- * @param integer $startValue
- * @param integer $endValue
- * @param integer $step
+ * @param int $startValue
+ * @param int $endValue
+ * @param int $step
* @return array
*/
protected static function calculateRange($startValue, $endValue, $step = 1) {
/**
* format the interval to be used as a standalone phrase
- * @var integer
+ * @var int
*/
const FORMAT_DEFAULT = 1;
/**
* format the interval to be used as a phrase in a sentence
- * @var integer
+ * @var int
*/
const FORMAT_SENTENCE = 2;
/**
* format the interval without direction
- * @var integer
+ * @var int
*/
const FORMAT_PLAIN = 3;
* first day of the week
* 0=sunday
* 1=monday
- * @var integer
+ * @var int
*/
private static $firstDayOfTheWeek = null;
*
* @param \DateInterval $interval interval to be formatted
* @param boolean $fullInterval if `true`, the complete interval is returned, otherwise a rounded interval is used
- * @param integer $formatType format type for the interval, use the class constant FORMAT_DEFAULT, FORMAT_SENTENCE or FORMAT_PLAIN
+ * @param int $formatType format type for the interval, use the class constant FORMAT_DEFAULT, FORMAT_SENTENCE or FORMAT_PLAIN
* @return string
*/
public static function formatInterval(\DateInterval $interval, $fullInterval = false, $formatType = self::FORMAT_DEFAULT) {
/**
* Creates a DateTime object with the given unix timestamp.
*
- * @param integer $timestamp
+ * @param int $timestamp
* @return \DateTime
*/
public static function getDateTimeByTimestamp($timestamp) {
* Calculates the age of a given date.
*
* @param string $date format YYYY-MM-DD
- * @return integer
+ * @return int
*/
public static function getAge($date) {
// split date
/**
* Returns the first day of the week.
*
- * @return integer
+ * @return int
*/
public static function getFirstDayOfTheWeek() {
if (self::$firstDayOfTheWeek === null) {
/**
* Returns the number of weeks in the given year.
*
- * @param integer $year
- * @return integer
+ * @param int $year
+ * @return int
*/
public static function getWeeksInYear($year) {
$date = new \DateTime();
* through JavaScript.
*
* @param \DateTime $dateTimeObject target date object
- * @param integer $timestamp target timestamp
+ * @param int $timestamp target timestamp
* @param string $date localized date
* @param string $time localized time
* @param boolean $isFutureDate true if timestamp is in the future
/**
* size of a
- * @var integer
+ * @var int
*/
protected $sizeA = 0;
/**
* size of b
- * @var integer
+ * @var int
*/
protected $sizeB = 0;
/**
* Returns a string like the one generated by unix diff.
*
- * @param integer $context
+ * @param int $context
* @return string
*/
public function getUnixDiff($context = 2) {
/**
* directory size in bytes
- * @var integer
+ * @var int
*/
protected $size = 0;
/**
* indicates that files won't be sorted
- * @var integer
+ * @var int
*/
const SORT_NONE = -1;
/**
* Returns a sorted list of files.
*
- * @param integer $order sort-order
+ * @param int $order sort-order
* @param Regex $pattern pattern to match
* @param boolean $negativeMatch true if the pattern should be inversed
* @return string[]
/**
* Returns a sorted list of files, with DirectoryIterator object as value
*
- * @param integer $order sort order
+ * @param int $order sort order
* @param Regex $pattern pattern to match
* @param boolean $negativeMatch should the pattern be inversed
* @return \DirectoryIterator[]
/**
* Calculates the size of the directory.
*
- * @return integer directory size in bytes
+ * @return int directory size in bytes
* @throws SystemException
*/
public function getSize() {
/**
* orientation value for the original orientation
* @see http://jpegclub.org/exif_orientation.html
- * @var integer
+ * @var int
*/
const ORIENTATION_ORIGINAL = 1;
/**
* orientation value of a horizontal flip
* @see http://jpegclub.org/exif_orientation.html
- * @var integer
+ * @var int
*/
const ORIENTATION_HORIZONTAL_FLIP = 2;
/**
* orientation value of a 180 degree rotation
* @see http://jpegclub.org/exif_orientation.html
- * @var integer
+ * @var int
*/
const ORIENTATION_180_ROTATE = 3;
/**
* orientation value of a vertical flip
* @see http://jpegclub.org/exif_orientation.html
- * @var integer
+ * @var int
*/
const ORIENTATION_VERTICAL_FLIP = 4;
/**
* orientation value of a vertical flip and a 270 degree rotation
* @see http://jpegclub.org/exif_orientation.html
- * @var integer
+ * @var int
*/
const ORIENTATION_VERTICAL_FLIP_270_ROTATE = 5;
/**
* orientation value of a 90 degree rotation
* @see http://jpegclub.org/exif_orientation.html
- * @var integer
+ * @var int
*/
const ORIENTATION_90_ROTATE = 6;
/**
* orientation value of a horizontal flip and a 270 degree rotation
* @see http://jpegclub.org/exif_orientation.html
- * @var integer
+ * @var int
*/
const ORIENTATION_HORIZONTAL_FLIP_270_ROTATE = 7;
/**
* orientation value of a 270 degree rotation
* @see http://jpegclub.org/exif_orientation.html
- * @var integer
+ * @var int
*/
const ORIENTATION_270_ROTATE = 8;
* Returns the orientation of the image based on the given exif data.
*
* @param array $exifData
- * @return integer
+ * @return int
*/
public static function getOrientation(array $exifData) {
$orientation = self::ORIENTATION_ORIGINAL;
/**
* start byte
- * @var integer
+ * @var int
*/
protected $startByte = 0;
/**
* end byte
- * @var integer
+ * @var int
*/
protected $endByte = 0;
/**
* memory limit in bytes
- * @var integer
+ * @var int
*/
protected static $memoryLimit = null;
/**
* Formats the given filesize.
*
- * @param integer $byte
- * @param integer $precision
+ * @param int $byte
+ * @param int $precision
* @return string
*/
public static function formatFilesize($byte, $precision = 2) {
*
* For more information: <http://en.wikipedia.org/wiki/Binary_prefix>
*
- * @param integer $byte
- * @param integer $precision
+ * @param int $byte
+ * @param int $precision
* @return string
*/
public static function formatFilesizeBinary($byte, $precision = 2) {
/**
* Returns memory limit in bytes.
*
- * @return integer
+ * @return int
*/
public static function getMemoryLimit() {
if (self::$memoryLimit === null) {
/**
* Returns true if the given amount of memory is available.
*
- * @param integer $neededMemory
+ * @param int $neededMemory
* @return boolean
*/
public static function checkMemoryLimit($neededMemory) {
*
* @param string $name
* @param string $value
- * @param integer $expire
+ * @param int $expire
*/
public static function setCookie($name, $value = '', $expire = 0) {
$cookieDomain = self::getCookieDomain();
*
* @param string $location
* @param string $message
- * @param integer $delay
+ * @param int $delay
* @param string $status
*/
public static function delayedRedirect($location, $message, $delay = 5, $status = 'success') {
* Enforces dimensions for given image.
*
* @param string $filename
- * @param integer $maxWidth
- * @param integer $maxHeight
+ * @param int $maxWidth
+ * @param int $maxHeight
* @param boolean $obtainDimensions
* @return string new filename if file was changed, otherwise old filename
* @since 5.2
* Returns the JSON representation of a value.
*
* @param mixed $data
- * @param integer $options
+ * @param int $options
* @return string
*/
public static function encode($data, $options = 0) {
/**
* Returns the last error occurred.
*
- * @return integer
+ * @return int
*/
public static function getLastError() {
return json_last_error();
/**
* Generates a random value.
*
- * @param integer $min
- * @param integer $max
- * @return integer
+ * @param int $min
+ * @param int $max
+ * @return int
*/
public static function getRandomValue($min = null, $max = null) {
// generate random value
* Truncates a formatted message and keeps the HTML syntax intact.
*
* @param string $message string which shall be truncated
- * @param integer $maxLength string length after truncating
+ * @param int $maxLength string length after truncating
* @return string truncated string
*/
public static function truncateFormattedMessage($message, $maxLength = 1000) {
/**
* Generates a random alphanumeric user password with the given character length.
*
- * @param integer $length
+ * @param int $length
* @return string
*/
public static function getRandomPassword($length = 12) {
final class StringStack {
/**
* hash index
- * @var integer
+ * @var int
*/
protected static $i = 0;
/**
* Formats an integer.
*
- * @param integer $integer
+ * @param int $integer
* @return string
*/
public static function formatInteger($integer) {
* Formats a double.
*
* @param double $double
- * @param integer $maxDecimals
+ * @param int $maxDecimals
* @return string
*/
public static function formatDouble($double, $maxDecimals = 0) {
* @param string $search
* @param string $replace
* @param string $subject
- * @param integer $count
+ * @param int $count
* @return string
*/
public static function replaceIgnoreCase($search, $replace, $subject, &$count = 0) {
* Alias to php str_split() function with multibyte support.
*
* @param string $string
- * @param integer $length
+ * @param int $length
* @return string[]
*/
public static function split($string, $length = 1) {
* Alias to php str_pad function with multibyte support.
*
* @param string $input
- * @param integer $padLength
+ * @param int $padLength
* @param string $padString
- * @param integer $padType
+ * @param int $padType
* @return string
*/
public static function pad($input, $padLength, $padString = ' ', $padType = STR_PAD_RIGHT) {
/**
* Takes a numeric HTML entity value and returns the appropriate UTF-8 bytes.
*
- * @param integer $dec html entity value
+ * @param int $dec html entity value
* @return string utf-8 bytes
*/
public static function getCharacter($dec) {
* @see http://www1.tip.nl/~t876506/utf8tbl.html
*
* @param string $c
- * @return integer
+ * @return int
*/
public static function getCharValue($c) {
$ud = 0;
* Truncates the given string to a certain number of characters.
*
* @param string $string string which shall be truncated
- * @param integer $length string length after truncating
+ * @param int $length string length after truncating
* @param string $etc string to append when $string is truncated
* @param boolean $breakWords should words be broken in the middle
* @return string truncated string
* Truncates a string containing HTML code and keeps the HTML syntax intact.
*
* @param string $string string which shall be truncated
- * @param integer $length string length after truncating
+ * @param int $length string length after truncating
* @param string $etc ending string which will be appended after truncating
* @param boolean $breakWords if false words will not be split and the return string might be shorter than $length
* @return string truncated string
* Splits given string into smaller chunks.
*
* @param string $string
- * @param integer $length
+ * @param int $length
* @param string $break
* @return string
*/
* Simple multi-byte safe wordwrap() function.
*
* @param string $string
- * @param integer $width
+ * @param int $width
* @param string $break
* @return string
*/
/**
* Shortens numbers larger than 1000 by using unit suffixes.
*
- * @param integer $number
+ * @param int $number
* @return string
*/
public static function getShortUnit($number) {
/**
* maps properties to the array indices
- * @var integer[]
+ * @var int[]
*/
private static $propertyMap = [
PHP_URL_SCHEME => 'scheme',
* that they're non-empty.
*
* @param string $url
- * @param integer[] $components
+ * @param int[] $components
* @return boolean
*/
public static function contains($url, array $components) {
}
/**
- * Attempts to resolve string properties and maps them to their integer-based
+ * Attempts to resolve string properties and maps them to their int-based
* component indices. Will throw an exception if the property is unknown,
* making it easier to spot typos.
*
* @param mixed $property
- * @return integer
+ * @return int
* @throws \RuntimeException
*/
private function getIndex($property) {
* Generates a random activation code with the given length.
* Warning: A length greater than 9 is out of integer range.
*
- * @param integer $length
- * @return integer
+ * @param int $length
+ * @return int
*/
public static function getActivationCode($length = 9) {
return random_int(pow(10, $length - 1), pow(10, $length) - 1);
/**
* number of open elements
- * @var integer
+ * @var int
*/
protected $openElements = 0;
projects / GitHub / WoltLab / WCF.git / commitdiff