From ec1b3610b0f05234a5d33d8bfe8d4f1ce359c87a Mon Sep 17 00:00:00 2001 From: Matthias Schmidt Date: Sat, 30 Jul 2016 14:11:29 +0200 Subject: [PATCH] Replace "get" with "return" in comments --- .../install/files/lib/acp/form/UserEditForm.class.php | 4 ++-- .../install/files/lib/acp/page/UserListPage.class.php | 6 +++--- .../files/lib/data/article/ViewableArticle.class.php | 2 +- .../data/attachment/AdministrativeAttachment.class.php | 2 +- wcfsetup/install/files/lib/data/like/Like.class.php | 2 +- .../files/lib/data/like/object/LikeObject.class.php | 4 ++-- .../lib/data/object/type/IObjectTypeProvider.class.php | 4 ++-- .../log/PaidSubscriptionTransactionLog.class.php | 4 ++-- .../subscription/user/PaidSubscriptionUser.class.php | 8 ++++---- .../install/files/lib/data/style/StyleEditor.class.php | 4 ++-- wcfsetup/install/files/lib/data/user/User.class.php | 2 +- .../files/lib/data/user/online/UsersOnlineList.class.php | 2 +- .../user/profile/visitor/UserProfileVisitor.class.php | 4 ++-- wcfsetup/install/files/lib/form/LoginForm.class.php | 2 +- wcfsetup/install/files/lib/form/SearchForm.class.php | 2 +- wcfsetup/install/files/lib/system/WCFSetup.class.php | 8 ++++---- .../install/files/lib/system/acl/ACLHandler.class.php | 2 +- .../system/attachment/IAttachmentObjectType.class.php | 2 +- .../files/lib/system/category/CategoryHandler.class.php | 8 ++++---- .../lib/system/cronjob/GetUpdateInfoCronjob.class.php | 2 +- .../install/files/lib/system/database/Database.class.php | 6 +++--- .../files/lib/system/exporter/AbstractExporter.class.php | 2 +- .../files/lib/system/language/LanguageFactory.class.php | 2 +- .../install/files/lib/system/like/LikeHandler.class.php | 6 +++--- wcfsetup/install/files/lib/system/mail/Mail.class.php | 2 +- .../files/lib/system/mail/SMTPMailSender.class.php | 2 +- .../files/lib/system/option/OptionHandler.class.php | 2 +- .../package/PackageInstallationSQLParser.class.php | 2 +- .../package/PackageInstallationScheduler.class.php | 6 +++--- .../lib/system/package/PackageUpdateDispatcher.class.php | 4 ++-- .../plugin/ObjectTypePackageInstallationPlugin.class.php | 2 +- .../install/files/lib/system/tagging/ITagged.class.php | 6 +++--- .../install/files/lib/system/tagging/TagCloud.class.php | 2 +- .../install/files/lib/system/upload/UploadFile.class.php | 4 ++-- .../files/lib/system/upload/UploadHandler.class.php | 9 ++++++--- .../files/lib/system/user/UserBirthdayCache.class.php | 2 +- .../authentication/UserAuthenticationFactory.class.php | 2 +- .../object/type/IUserNotificationObjectType.class.php | 2 +- .../files/lib/system/visitTracker/VisitTracker.class.php | 2 +- .../install/files/lib/system/worker/IWorker.class.php | 4 ++-- 40 files changed, 73 insertions(+), 70 deletions(-) diff --git a/wcfsetup/install/files/lib/acp/form/UserEditForm.class.php b/wcfsetup/install/files/lib/acp/form/UserEditForm.class.php index 22257b6989..3f7d73f754 100755 --- a/wcfsetup/install/files/lib/acp/form/UserEditForm.class.php +++ b/wcfsetup/install/files/lib/acp/form/UserEditForm.class.php @@ -174,14 +174,14 @@ class UserEditForm extends UserAddForm { } /** - * Gets the selected languages. + * Sets the selected languages. */ protected function readVisibleLanguages() { $this->visibleLanguages = $this->user->getLanguageIDs(); } /** - * Gets the default values. + * Sets the default values. */ protected function readDefaultValues() { $this->username = $this->user->username; diff --git a/wcfsetup/install/files/lib/acp/page/UserListPage.class.php b/wcfsetup/install/files/lib/acp/page/UserListPage.class.php index 3cddaddc7a..f23c352db7 100755 --- a/wcfsetup/install/files/lib/acp/page/UserListPage.class.php +++ b/wcfsetup/install/files/lib/acp/page/UserListPage.class.php @@ -228,7 +228,7 @@ class UserListPage extends SortablePage { } /** - * Gets the list of results. + * Fetches the list of results. */ protected function readUsers() { // get user ids @@ -324,7 +324,7 @@ class UserListPage extends SortablePage { } /** - * Gets the result of the search with the given search id. + * Fetches the result of the search with the given search id. */ protected function readSearchResult() { // get user search from database @@ -352,7 +352,7 @@ class UserListPage extends SortablePage { } /** - * Gets the user options from cache. + * Fetches the user options from cache. */ protected function readUserOptions() { $this->options = UserOptionCacheBuilder::getInstance()->getData([], 'options'); diff --git a/wcfsetup/install/files/lib/data/article/ViewableArticle.class.php b/wcfsetup/install/files/lib/data/article/ViewableArticle.class.php index b69402c3e1..6ab05921d8 100644 --- a/wcfsetup/install/files/lib/data/article/ViewableArticle.class.php +++ b/wcfsetup/install/files/lib/data/article/ViewableArticle.class.php @@ -32,7 +32,7 @@ class ViewableArticle extends DatabaseObjectDecorator { protected $userProfile = null; /** - * Gets a specific article decorated as viewable article. + * Returns a specific article decorated as viewable article or `null` if it does not exist. * * @param integer $articleID * @param boolean $enableContentLoading Enables/disables the loading of article content objects diff --git a/wcfsetup/install/files/lib/data/attachment/AdministrativeAttachment.class.php b/wcfsetup/install/files/lib/data/attachment/AdministrativeAttachment.class.php index b55ed2d5b1..e2879441fd 100644 --- a/wcfsetup/install/files/lib/data/attachment/AdministrativeAttachment.class.php +++ b/wcfsetup/install/files/lib/data/attachment/AdministrativeAttachment.class.php @@ -34,7 +34,7 @@ class AdministrativeAttachment extends DatabaseObjectDecorator { protected $containerObjectLoaded = false; /** - * Gets the container object of this attachment. + * Returns the container object of this attachment. * * @return IUserContent */ diff --git a/wcfsetup/install/files/lib/data/like/Like.class.php b/wcfsetup/install/files/lib/data/like/Like.class.php index 9d249076bf..3dd9e854c1 100644 --- a/wcfsetup/install/files/lib/data/like/Like.class.php +++ b/wcfsetup/install/files/lib/data/like/Like.class.php @@ -43,7 +43,7 @@ class Like extends DatabaseObject { const DISLIKE = -1; /** - * Gets a like by type, object id and user id. + * Returns the like with given type, object id and user id. * * @param integer $objectTypeID * @param integer $objectID diff --git a/wcfsetup/install/files/lib/data/like/object/LikeObject.class.php b/wcfsetup/install/files/lib/data/like/object/LikeObject.class.php index b7b4a264e2..050e75d867 100644 --- a/wcfsetup/install/files/lib/data/like/object/LikeObject.class.php +++ b/wcfsetup/install/files/lib/data/like/object/LikeObject.class.php @@ -65,7 +65,7 @@ class LikeObject extends DatabaseObject { } /** - * Gets the first 3 users who liked this object. + * Returns the first 3 users who liked this object. * * @return User[] */ @@ -96,7 +96,7 @@ class LikeObject extends DatabaseObject { } /** - * Gets a like object by type and object id. + * Returns the like object with the given type and object id. * * @param integer $objectTypeID * @param integer $objectID diff --git a/wcfsetup/install/files/lib/data/object/type/IObjectTypeProvider.class.php b/wcfsetup/install/files/lib/data/object/type/IObjectTypeProvider.class.php index c83c05e164..66ed52091d 100644 --- a/wcfsetup/install/files/lib/data/object/type/IObjectTypeProvider.class.php +++ b/wcfsetup/install/files/lib/data/object/type/IObjectTypeProvider.class.php @@ -12,7 +12,7 @@ use wcf\data\DatabaseObject; */ interface IObjectTypeProvider { /** - * Gets an object by its ID. + * Returns an object by its ID. * * @param integer $objectID * @return \wcf\data\DatabaseObject @@ -20,7 +20,7 @@ interface IObjectTypeProvider { public function getObjectByID($objectID); /** - * Gets like objects by their IDs. + * Returns objects by their IDs. * * @param integer[] $objectIDs * @return DatabaseObject[] diff --git a/wcfsetup/install/files/lib/data/paid/subscription/transaction/log/PaidSubscriptionTransactionLog.class.php b/wcfsetup/install/files/lib/data/paid/subscription/transaction/log/PaidSubscriptionTransactionLog.class.php index cfcf979cfc..54a421f54c 100644 --- a/wcfsetup/install/files/lib/data/paid/subscription/transaction/log/PaidSubscriptionTransactionLog.class.php +++ b/wcfsetup/install/files/lib/data/paid/subscription/transaction/log/PaidSubscriptionTransactionLog.class.php @@ -93,11 +93,11 @@ class PaidSubscriptionTransactionLog extends DatabaseObject { } /** - * Gets a transaction log entry by transaction id. + * Returns the transaction log entry by transaction id or `null` if no such entry exists. * * @param integer $paymentMethodObjectTypeID * @param string $transactionID - * @return \wcf\data\paid\subscription\transaction\log\PaidSubscriptionTransactionLog + * @return PaidSubscriptionTransactionLog|null */ public static function getLogByTransactionID($paymentMethodObjectTypeID, $transactionID) { $sql = "SELECT * diff --git a/wcfsetup/install/files/lib/data/paid/subscription/user/PaidSubscriptionUser.class.php b/wcfsetup/install/files/lib/data/paid/subscription/user/PaidSubscriptionUser.class.php index 3b35982a93..3bc332defc 100644 --- a/wcfsetup/install/files/lib/data/paid/subscription/user/PaidSubscriptionUser.class.php +++ b/wcfsetup/install/files/lib/data/paid/subscription/user/PaidSubscriptionUser.class.php @@ -37,9 +37,9 @@ class PaidSubscriptionUser extends DatabaseObject { protected $subscription = null; /** - * Gets the paid subscription object. + * Returns the paid subscription object. * - * @return \wcf\data\paid\subscription\PaidSubscription + * @return PaidSubscription */ public function getSubscription() { if ($this->subscription === null) { @@ -59,11 +59,11 @@ class PaidSubscriptionUser extends DatabaseObject { } /** - * Gets a specific subscription user. + * Returns a specific subscription user or `null` if such a user does not exist. * * @param integer $subscriptionID * @param integer $userID - * @return \wcf\data\paid\subscription\user\PaidSubscriptionUser + * @return PaidSubscriptionUser|null */ public static function getSubscriptionUser($subscriptionID, $userID) { $sql = "SELECT * diff --git a/wcfsetup/install/files/lib/data/style/StyleEditor.class.php b/wcfsetup/install/files/lib/data/style/StyleEditor.class.php index 0e0b6c8d13..21698a3573 100644 --- a/wcfsetup/install/files/lib/data/style/StyleEditor.class.php +++ b/wcfsetup/install/files/lib/data/style/StyleEditor.class.php @@ -263,10 +263,10 @@ class StyleEditor extends DatabaseObjectEditor implements IEditableCachedObject } /** - * Gets the data of a style exchange format file. + * Returns the data of a style exchange format file. * * @param string $filename - * @return array data + * @return array */ public static function getStyleData($filename) { // open file diff --git a/wcfsetup/install/files/lib/data/user/User.class.php b/wcfsetup/install/files/lib/data/user/User.class.php index b6597f3640..8cde1f3f9c 100644 --- a/wcfsetup/install/files/lib/data/user/User.class.php +++ b/wcfsetup/install/files/lib/data/user/User.class.php @@ -278,7 +278,7 @@ final class User extends DatabaseObject implements IRouteController, IUserConten } /** - * Gets all user options from cache. + * Fetches all user options from cache. */ protected static function getUserOptionCache() { self::$userOptions = UserOptionCacheBuilder::getInstance()->getData([], 'options'); diff --git a/wcfsetup/install/files/lib/data/user/online/UsersOnlineList.class.php b/wcfsetup/install/files/lib/data/user/online/UsersOnlineList.class.php index 3f123bc8f7..9e8d9f1c21 100644 --- a/wcfsetup/install/files/lib/data/user/online/UsersOnlineList.class.php +++ b/wcfsetup/install/files/lib/data/user/online/UsersOnlineList.class.php @@ -81,7 +81,7 @@ class UsersOnlineList extends SessionList { } /** - * Gets users online stats. + * Fetches users online stats. */ public function readStats() { $conditionBuilder = clone $this->getConditionBuilder(); diff --git a/wcfsetup/install/files/lib/data/user/profile/visitor/UserProfileVisitor.class.php b/wcfsetup/install/files/lib/data/user/profile/visitor/UserProfileVisitor.class.php index 198ef8736e..6575567f94 100644 --- a/wcfsetup/install/files/lib/data/user/profile/visitor/UserProfileVisitor.class.php +++ b/wcfsetup/install/files/lib/data/user/profile/visitor/UserProfileVisitor.class.php @@ -28,11 +28,11 @@ class UserProfileVisitor extends DatabaseObject { protected static $databaseTableIndexName = 'visitorID'; /** - * Gets a profile visitor object. + * Returns a profile visitor object or `null` if it does not exist. * * @param integer $ownerID * @param integer $userID - * @return \wcf\data\user\profile\visitor\UserProfileVisitor + * @return UserProfileVisitor|null */ public static function getObject($ownerID, $userID) { $sql = "SELECT * diff --git a/wcfsetup/install/files/lib/form/LoginForm.class.php b/wcfsetup/install/files/lib/form/LoginForm.class.php index 882df98193..4a4224c8ae 100644 --- a/wcfsetup/install/files/lib/form/LoginForm.class.php +++ b/wcfsetup/install/files/lib/form/LoginForm.class.php @@ -70,7 +70,7 @@ class LoginForm extends \wcf\acp\form\LoginForm { } /** - * Gets the redirect url. + * Sets the redirect url. */ protected function checkURL() { if (empty($this->url) || mb_stripos($this->url, '?Login/') !== false) { diff --git a/wcfsetup/install/files/lib/form/SearchForm.class.php b/wcfsetup/install/files/lib/form/SearchForm.class.php index 65036aa422..2ea2b16706 100644 --- a/wcfsetup/install/files/lib/form/SearchForm.class.php +++ b/wcfsetup/install/files/lib/form/SearchForm.class.php @@ -428,7 +428,7 @@ class SearchForm extends AbstractCaptchaForm { } /** - * Gets the conditions for a search in the table of the selected object types. + * Sets the conditions for a search in the table of the selected object types. */ protected function getConditions() { if (empty($this->selectedObjectTypes)) { diff --git a/wcfsetup/install/files/lib/system/WCFSetup.class.php b/wcfsetup/install/files/lib/system/WCFSetup.class.php index e62d098cc0..a5b5babc22 100644 --- a/wcfsetup/install/files/lib/system/WCFSetup.class.php +++ b/wcfsetup/install/files/lib/system/WCFSetup.class.php @@ -103,7 +103,7 @@ class WCFSetup extends WCF { } /** - * Gets the status of the developer mode. + * Sets the status of the developer mode. */ protected static function getDeveloperMode() { if (isset($_GET['dev'])) self::$developerMode = intval($_GET['dev']); @@ -111,7 +111,7 @@ class WCFSetup extends WCF { } /** - * Gets the selected language. + * Sets the selected language. */ protected static function getLanguageSelection() { self::$availableLanguages = self::getAvailableLanguages(); @@ -129,7 +129,7 @@ class WCFSetup extends WCF { } /** - * Gets the selected wcf dir from request. + * Sets the selected wcf dir from request. * * @since 3.0 */ @@ -1224,7 +1224,7 @@ class WCFSetup extends WCF { } /** - * Gets the package names of the bundled applications in WCFSetup.tar.gz. + * Reads the package names of the bundled applications in WCFSetup.tar.gz. */ protected static function getPackageNames() { // get package name diff --git a/wcfsetup/install/files/lib/system/acl/ACLHandler.class.php b/wcfsetup/install/files/lib/system/acl/ACLHandler.class.php index a1160d628a..3054ca4c6e 100644 --- a/wcfsetup/install/files/lib/system/acl/ACLHandler.class.php +++ b/wcfsetup/install/files/lib/system/acl/ACLHandler.class.php @@ -121,7 +121,7 @@ class ACLHandler extends SingletonFactory { } /** - * Gets the object type id. + * Returns the id of the given acl object type. * * @param string $objectType * @return integer diff --git a/wcfsetup/install/files/lib/system/attachment/IAttachmentObjectType.class.php b/wcfsetup/install/files/lib/system/attachment/IAttachmentObjectType.class.php index fa9f5b904b..bb50dba802 100644 --- a/wcfsetup/install/files/lib/system/attachment/IAttachmentObjectType.class.php +++ b/wcfsetup/install/files/lib/system/attachment/IAttachmentObjectType.class.php @@ -67,7 +67,7 @@ interface IAttachmentObjectType { public function getMaxCount(); /** - * Gets the container object of an attachment. + * Returns the container object of an attachment. * * @param integer $objectID * @return \wcf\data\IUserContent diff --git a/wcfsetup/install/files/lib/system/category/CategoryHandler.class.php b/wcfsetup/install/files/lib/system/category/CategoryHandler.class.php index 4fc25a5e6e..dd7f896e36 100644 --- a/wcfsetup/install/files/lib/system/category/CategoryHandler.class.php +++ b/wcfsetup/install/files/lib/system/category/CategoryHandler.class.php @@ -103,10 +103,10 @@ class CategoryHandler extends SingletonFactory { } /** - * Gets the object type with the given id. + * Returns the category object type with the given id or null if no such object type exists. * * @param integer $objectTypeID - * @return \wcf\data\object\type\ObjectType + * @return ObjectType|null */ public function getObjectType($objectTypeID) { if (isset($this->objectTypeIDs[$objectTypeID])) { @@ -117,10 +117,10 @@ class CategoryHandler extends SingletonFactory { } /** - * Gets the object type with the given name. + * Returns the category object type with the given name or null if no such object type exists. * * @param string $objectType - * @return \wcf\data\object\type\ObjectType + * @return ObjectType|null */ public function getObjectTypeByName($objectType) { if (isset($this->objectTypes[$objectType])) { diff --git a/wcfsetup/install/files/lib/system/cronjob/GetUpdateInfoCronjob.class.php b/wcfsetup/install/files/lib/system/cronjob/GetUpdateInfoCronjob.class.php index 1bc9fd312a..ac69f5f79a 100644 --- a/wcfsetup/install/files/lib/system/cronjob/GetUpdateInfoCronjob.class.php +++ b/wcfsetup/install/files/lib/system/cronjob/GetUpdateInfoCronjob.class.php @@ -4,7 +4,7 @@ use wcf\data\cronjob\Cronjob; use wcf\system\package\PackageUpdateDispatcher; /** - * Gets update package information. + * Fetches update package information. * * @author Alexander Ebert * @copyright 2001-2016 WoltLab GmbH diff --git a/wcfsetup/install/files/lib/system/database/Database.class.php b/wcfsetup/install/files/lib/system/database/Database.class.php index 1fd81b807e..cd4e0c6c91 100644 --- a/wcfsetup/install/files/lib/system/database/Database.class.php +++ b/wcfsetup/install/files/lib/system/database/Database.class.php @@ -283,7 +283,7 @@ abstract class Database { } /** - * Gets the current database type. + * Returns the current database type. * * @return string */ @@ -302,7 +302,7 @@ abstract class Database { } /** - * Gets the sql version. + * Returns the sql version. * * @return string */ @@ -318,7 +318,7 @@ abstract class Database { } /** - * Gets the database name. + * Returns the database name. * * @return string */ diff --git a/wcfsetup/install/files/lib/system/exporter/AbstractExporter.class.php b/wcfsetup/install/files/lib/system/exporter/AbstractExporter.class.php index 1c3934229a..b017975b1c 100644 --- a/wcfsetup/install/files/lib/system/exporter/AbstractExporter.class.php +++ b/wcfsetup/install/files/lib/system/exporter/AbstractExporter.class.php @@ -181,7 +181,7 @@ abstract class AbstractExporter implements IExporter { } /** - * Gets the max value of a specific column. + * Returns the maximum value of a specific column. * * @param string $tableName * @param string $columnName diff --git a/wcfsetup/install/files/lib/system/language/LanguageFactory.class.php b/wcfsetup/install/files/lib/system/language/LanguageFactory.class.php index ea1f62b8fb..0f6e18b75a 100644 --- a/wcfsetup/install/files/lib/system/language/LanguageFactory.class.php +++ b/wcfsetup/install/files/lib/system/language/LanguageFactory.class.php @@ -61,7 +61,7 @@ class LanguageFactory extends SingletonFactory { } /** - * Gets the preferred language of the current user. + * Returns the preferred language of the current user. * * @param integer $languageID * @return Language diff --git a/wcfsetup/install/files/lib/system/like/LikeHandler.class.php b/wcfsetup/install/files/lib/system/like/LikeHandler.class.php index baffedf3ba..028494d01d 100644 --- a/wcfsetup/install/files/lib/system/like/LikeHandler.class.php +++ b/wcfsetup/install/files/lib/system/like/LikeHandler.class.php @@ -71,11 +71,11 @@ class LikeHandler extends SingletonFactory { } /** - * Gets a like object. + * Returns a like object. * * @param ObjectType $objectType * @param integer $objectID - * @return LikeObject + * @return LikeObject|null */ public function getLikeObject(ObjectType $objectType, $objectID) { if (isset($this->likeObjectCache[$objectType->objectTypeID][$objectID])) { @@ -86,7 +86,7 @@ class LikeHandler extends SingletonFactory { } /** - * Gets the like objects of a specific object type. + * Returns the like objects of a specific object type. * * @param ObjectType $objectType * @return LikeObject[] diff --git a/wcfsetup/install/files/lib/system/mail/Mail.class.php b/wcfsetup/install/files/lib/system/mail/Mail.class.php index 92dc9231e5..6a2f2b04cb 100644 --- a/wcfsetup/install/files/lib/system/mail/Mail.class.php +++ b/wcfsetup/install/files/lib/system/mail/Mail.class.php @@ -335,7 +335,7 @@ class Mail { } /** - * Gets the sender of this mail. + * Returns the sender of this mail. * * @return string */ diff --git a/wcfsetup/install/files/lib/system/mail/SMTPMailSender.class.php b/wcfsetup/install/files/lib/system/mail/SMTPMailSender.class.php index 475f5bbe13..c529f91fc7 100644 --- a/wcfsetup/install/files/lib/system/mail/SMTPMailSender.class.php +++ b/wcfsetup/install/files/lib/system/mail/SMTPMailSender.class.php @@ -277,7 +277,7 @@ class SMTPMailSender extends MailSender { } /** - * Gets error code and message from a server message. + * Extracts error code and message from a server message. * * @param string $data */ diff --git a/wcfsetup/install/files/lib/system/option/OptionHandler.class.php b/wcfsetup/install/files/lib/system/option/OptionHandler.class.php index 9f2efe6aa1..cd0631b773 100644 --- a/wcfsetup/install/files/lib/system/option/OptionHandler.class.php +++ b/wcfsetup/install/files/lib/system/option/OptionHandler.class.php @@ -387,7 +387,7 @@ class OptionHandler implements IOptionHandler { } /** - * Gets all options and option categories from cache. + * Fetches all options and option categories from cache. */ protected function readCache() { $cache = call_user_func([$this->cacheClass, 'getInstance']); diff --git a/wcfsetup/install/files/lib/system/package/PackageInstallationSQLParser.class.php b/wcfsetup/install/files/lib/system/package/PackageInstallationSQLParser.class.php index d1c94aac96..9d388de286 100644 --- a/wcfsetup/install/files/lib/system/package/PackageInstallationSQLParser.class.php +++ b/wcfsetup/install/files/lib/system/package/PackageInstallationSQLParser.class.php @@ -190,7 +190,7 @@ class PackageInstallationSQLParser extends SQLParser { } /** - * Gets known sql tables and their owners from installation log. + * Fetches known sql tables and their owners from installation log. */ protected function getKnownTables() { $sql = "SELECT packageID, sqlTable diff --git a/wcfsetup/install/files/lib/system/package/PackageInstallationScheduler.class.php b/wcfsetup/install/files/lib/system/package/PackageInstallationScheduler.class.php index 715ae286d9..e1dd02a4a9 100644 --- a/wcfsetup/install/files/lib/system/package/PackageInstallationScheduler.class.php +++ b/wcfsetup/install/files/lib/system/package/PackageInstallationScheduler.class.php @@ -613,11 +613,11 @@ class PackageInstallationScheduler { } /** - * Gets the filename of in session stored donwloads. + * Returns the filename of downloads stored in session or null if no stored downloads exist. * * @param string $package package identifier * @param string $version package version - * @return string $filename + * @return string|boolean */ protected function getCachedDownload($package, $version) { $cachedDownloads = WCF::getSession()->getVar('cachedPackageUpdateDownloads'); @@ -629,7 +629,7 @@ class PackageInstallationScheduler { } /** - * Gets stored auth data of given update server. + * Returns stored auth data the update server with given data. * * @param array $data * @return array diff --git a/wcfsetup/install/files/lib/system/package/PackageUpdateDispatcher.class.php b/wcfsetup/install/files/lib/system/package/PackageUpdateDispatcher.class.php index 42e8042e26..4b2855c27b 100644 --- a/wcfsetup/install/files/lib/system/package/PackageUpdateDispatcher.class.php +++ b/wcfsetup/install/files/lib/system/package/PackageUpdateDispatcher.class.php @@ -84,7 +84,7 @@ class PackageUpdateDispatcher extends SingletonFactory { } /** - * Gets the package_update.xml from an update server. + * Fetches the package_update.xml from an update server. * * @param PackageUpdateServer $updateServer * @param boolean $forceHTTP @@ -655,7 +655,7 @@ class PackageUpdateDispatcher extends SingletonFactory { } /** - * Gets package update versions of a package. + * Returns package update versions of the specified package. * * @param string $package package identifier * @param string $version package version diff --git a/wcfsetup/install/files/lib/system/package/plugin/ObjectTypePackageInstallationPlugin.class.php b/wcfsetup/install/files/lib/system/package/plugin/ObjectTypePackageInstallationPlugin.class.php index 4ac1eced45..f6a89dae4f 100644 --- a/wcfsetup/install/files/lib/system/package/plugin/ObjectTypePackageInstallationPlugin.class.php +++ b/wcfsetup/install/files/lib/system/package/plugin/ObjectTypePackageInstallationPlugin.class.php @@ -30,7 +30,7 @@ class ObjectTypePackageInstallationPlugin extends AbstractXMLPackageInstallation public static $reservedTags = ['classname', 'definitionname', 'name']; /** - * Gets the definition id by name + * Returns the id of the object type definition with the given name. * * @param string $definitionName * @return integer diff --git a/wcfsetup/install/files/lib/system/tagging/ITagged.class.php b/wcfsetup/install/files/lib/system/tagging/ITagged.class.php index ee705b0773..5eb1093cbf 100644 --- a/wcfsetup/install/files/lib/system/tagging/ITagged.class.php +++ b/wcfsetup/install/files/lib/system/tagging/ITagged.class.php @@ -11,16 +11,16 @@ namespace wcf\system\tagging; */ interface ITagged { /** - * Gets the id of the tagged object. + * Returns the id of the tagged object. * * @return integer the id to get */ public function getObjectID(); /** - * Gets the taggable type of this tagged object. + * Returns the taggable type of this tagged object. * - * @return \wcf\system\tagging\ITaggable + * @return ITaggable */ public function getTaggable(); } diff --git a/wcfsetup/install/files/lib/system/tagging/TagCloud.class.php b/wcfsetup/install/files/lib/system/tagging/TagCloud.class.php index 807256017d..1df409f063 100644 --- a/wcfsetup/install/files/lib/system/tagging/TagCloud.class.php +++ b/wcfsetup/install/files/lib/system/tagging/TagCloud.class.php @@ -74,7 +74,7 @@ class TagCloud { } /** - * Gets a list of weighted tags. + * Returns a list of weighted tags. * * @param integer $slice * @return TagCloudTag[] the tags to get diff --git a/wcfsetup/install/files/lib/system/upload/UploadFile.class.php b/wcfsetup/install/files/lib/system/upload/UploadFile.class.php index 27db9debd4..55ace04329 100644 --- a/wcfsetup/install/files/lib/system/upload/UploadFile.class.php +++ b/wcfsetup/install/files/lib/system/upload/UploadFile.class.php @@ -160,9 +160,9 @@ class UploadFile { } /** - * Gets image data. + * Returns the image data of the file or `null` if the file is no image. * - * @return array + * @return array|null */ public function getImageData() { if (strpos($this->getMimeType(), 'image/') == 0) { diff --git a/wcfsetup/install/files/lib/system/upload/UploadHandler.class.php b/wcfsetup/install/files/lib/system/upload/UploadHandler.class.php index 00f7f3ec6d..1b94456a90 100644 --- a/wcfsetup/install/files/lib/system/upload/UploadHandler.class.php +++ b/wcfsetup/install/files/lib/system/upload/UploadHandler.class.php @@ -110,13 +110,16 @@ class UploadHandler { } /** - * Gets an upload handler instance. + * Returns an upload handler instance for the given identifier or `null` if no data exists in `$_FILES` + * for the identifier. * * @param string $identifier - * @return \wcf\system\upload\UploadHandler + * @return UploadHandler */ public static function getUploadHandler($identifier) { - if (isset($_FILES[$identifier]) && is_array($_FILES[$identifier])) return new UploadHandler($_FILES[$identifier]); + if (isset($_FILES[$identifier]) && is_array($_FILES[$identifier])) { + return new UploadHandler($_FILES[$identifier]); + } return null; } diff --git a/wcfsetup/install/files/lib/system/user/UserBirthdayCache.class.php b/wcfsetup/install/files/lib/system/user/UserBirthdayCache.class.php index 0b4d44b49f..6a7997902a 100644 --- a/wcfsetup/install/files/lib/system/user/UserBirthdayCache.class.php +++ b/wcfsetup/install/files/lib/system/user/UserBirthdayCache.class.php @@ -37,7 +37,7 @@ class UserBirthdayCache extends SingletonFactory { } /** - * Gets the user birthdays for a specific day. + * Returns the user birthdays for a specific day. * * @param integer $month * @param integer $day diff --git a/wcfsetup/install/files/lib/system/user/authentication/UserAuthenticationFactory.class.php b/wcfsetup/install/files/lib/system/user/authentication/UserAuthenticationFactory.class.php index 0be1d00b8a..d5816fcc93 100644 --- a/wcfsetup/install/files/lib/system/user/authentication/UserAuthenticationFactory.class.php +++ b/wcfsetup/install/files/lib/system/user/authentication/UserAuthenticationFactory.class.php @@ -5,7 +5,7 @@ use wcf\system\exception\ImplementationException; use wcf\system\SingletonFactory; /** - * Gets the user authentication instance. + * Provides the user authentication instance. * * @author Alexander Ebert * @copyright 2001-2016 WoltLab GmbH diff --git a/wcfsetup/install/files/lib/system/user/notification/object/type/IUserNotificationObjectType.class.php b/wcfsetup/install/files/lib/system/user/notification/object/type/IUserNotificationObjectType.class.php index f7058eea5a..37e29c10f7 100644 --- a/wcfsetup/install/files/lib/system/user/notification/object/type/IUserNotificationObjectType.class.php +++ b/wcfsetup/install/files/lib/system/user/notification/object/type/IUserNotificationObjectType.class.php @@ -13,7 +13,7 @@ use wcf\system\user\notification\object\IUserNotificationObject; */ interface IUserNotificationObjectType extends IDatabaseObjectProcessor { /** - * Gets notification objects by their IDs. + * Returns notification objects by their IDs. * * @param integer[] $objectIDs * @return IUserNotificationObject[] diff --git a/wcfsetup/install/files/lib/system/visitTracker/VisitTracker.class.php b/wcfsetup/install/files/lib/system/visitTracker/VisitTracker.class.php index b0592d5cfc..79b4c8466e 100644 --- a/wcfsetup/install/files/lib/system/visitTracker/VisitTracker.class.php +++ b/wcfsetup/install/files/lib/system/visitTracker/VisitTracker.class.php @@ -57,7 +57,7 @@ class VisitTracker extends SingletonFactory { } /** - * Gets the last visit time for a whole object type. + * Returns the last visit time for a whole object type. * * @param string $objectType * @return integer diff --git a/wcfsetup/install/files/lib/system/worker/IWorker.class.php b/wcfsetup/install/files/lib/system/worker/IWorker.class.php index 13ac8cc4da..29db24fcd4 100644 --- a/wcfsetup/install/files/lib/system/worker/IWorker.class.php +++ b/wcfsetup/install/files/lib/system/worker/IWorker.class.php @@ -25,8 +25,8 @@ interface IWorker { public function setLoopCount($loopCount); /** - * Gets current process, integer between 0 and 100. If the progress - * hits 100 the worker will terminate. + * Returns current process of the worker, an integer between 0 and 100. + * If the progress hits 100, the worker will terminate. * * @return integer */ -- 2.20.1