}
/**
- * 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;
}
/**
- * Gets the list of results.
+ * Fetches the list of results.
*/
protected function readUsers() {
// get user ids
}
/**
- * 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
}
/**
- * Gets the user options from cache.
+ * Fetches the user options from cache.
*/
protected function readUserOptions() {
$this->options = UserOptionCacheBuilder::getInstance()->getData([], 'options');
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
protected $containerObjectLoaded = false;
/**
- * Gets the container object of this attachment.
+ * Returns the container object of this attachment.
*
* @return IUserContent
*/
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
}
/**
- * Gets the first 3 users who liked this object.
+ * Returns the first 3 users who liked this object.
*
* @return User[]
*/
}
/**
- * 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
*/
interface IObjectTypeProvider {
/**
- * Gets an object by its ID.
+ * Returns an object by its ID.
*
* @param integer $objectID
* @return \wcf\data\DatabaseObject
public function getObjectByID($objectID);
/**
- * Gets like objects by their IDs.
+ * Returns objects by their IDs.
*
* @param integer[] $objectIDs
* @return 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 *
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) {
}
/**
- * 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 *
}
/**
- * 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
}
/**
- * Gets all user options from cache.
+ * Fetches all user options from cache.
*/
protected static function getUserOptionCache() {
self::$userOptions = UserOptionCacheBuilder::getInstance()->getData([], 'options');
}
/**
- * Gets users online stats.
+ * Fetches users online stats.
*/
public function readStats() {
$conditionBuilder = clone $this->getConditionBuilder();
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 *
}
/**
- * Gets the redirect url.
+ * Sets the redirect url.
*/
protected function checkURL() {
if (empty($this->url) || mb_stripos($this->url, '?Login/') !== false) {
}
/**
- * 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)) {
}
/**
- * 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']);
}
/**
- * Gets the selected language.
+ * Sets the selected language.
*/
protected static function getLanguageSelection() {
self::$availableLanguages = self::getAvailableLanguages();
}
/**
- * Gets the selected wcf dir from request.
+ * Sets the selected wcf dir from request.
*
* @since 3.0
*/
}
/**
- * 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
}
/**
- * Gets the object type id.
+ * Returns the id of the given acl object type.
*
* @param string $objectType
* @return integer
public function getMaxCount();
/**
- * Gets the container object of an attachment.
+ * Returns the container object of an attachment.
*
* @param integer $objectID
* @return \wcf\data\IUserContent
}
/**
- * 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])) {
}
/**
- * 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])) {
use wcf\system\package\PackageUpdateDispatcher;
/**
- * Gets update package information.
+ * Fetches update package information.
*
* @author Alexander Ebert
* @copyright 2001-2016 WoltLab GmbH
}
/**
- * Gets the current database type.
+ * Returns the current database type.
*
* @return string
*/
}
/**
- * Gets the sql version.
+ * Returns the sql version.
*
* @return string
*/
}
/**
- * Gets the database name.
+ * Returns the database name.
*
* @return string
*/
}
/**
- * Gets the max value of a specific column.
+ * Returns the maximum value of a specific column.
*
* @param string $tableName
* @param string $columnName
}
/**
- * Gets the preferred language of the current user.
+ * Returns the preferred language of the current user.
*
* @param integer $languageID
* @return Language
}
/**
- * 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])) {
}
/**
- * Gets the like objects of a specific object type.
+ * Returns the like objects of a specific object type.
*
* @param ObjectType $objectType
* @return LikeObject[]
}
/**
- * Gets the sender of this mail.
+ * Returns the sender of this mail.
*
* @return string
*/
}
/**
- * Gets error code and message from a server message.
+ * Extracts error code and message from a server message.
*
* @param string $data
*/
}
/**
- * 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']);
}
/**
- * 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
}
/**
- * 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');
}
/**
- * Gets stored auth data of given update server.
+ * Returns stored auth data the update server with given data.
*
* @param array $data
* @return array
}
/**
- * Gets the package_update.xml from an update server.
+ * Fetches the package_update.xml from an update server.
*
* @param PackageUpdateServer $updateServer
* @param boolean $forceHTTP
}
/**
- * 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
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
*/
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();
}
}
/**
- * Gets a list of weighted tags.
+ * Returns a list of weighted tags.
*
* @param integer $slice
* @return TagCloudTag[] the tags to get
}
/**
- * 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) {
}
/**
- * 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;
}
}
/**
- * Gets the user birthdays for a specific day.
+ * Returns the user birthdays for a specific day.
*
* @param integer $month
* @param integer $day
use wcf\system\SingletonFactory;
/**
- * Gets the user authentication instance.
+ * Provides the user authentication instance.
*
* @author Alexander Ebert
* @copyright 2001-2016 WoltLab GmbH
*/
interface IUserNotificationObjectType extends IDatabaseObjectProcessor {
/**
- * Gets notification objects by their IDs.
+ * Returns notification objects by their IDs.
*
* @param integer[] $objectIDs
* @return IUserNotificationObject[]
}
/**
- * 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
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
*/
projects / GitHub / WoltLab / WCF.git / commitdiff