/**
* Creates a new SystemException.
*
- * @param message string error message
- * @param code integer error code
- * @param description string description of the error
+ * @param string $message error message
+ * @param integer $code error code
+ * @param string $description description of the error
*/
public function __construct($message = '', $code = 0, $description = '') {
parent::__construct($message, $code);
/**
* Escapes strings for execution in sql queries.
+ *
+ * @param string $string
+ * @return string
*/
function escapeString($string) {
return \wcf\system\WCF::getDB()->escapeString($string);
* Returns an associative array with information
* about a specific file in the archive.
*
- * @param mixed $fileindex index or name of the requested file
- * @return array $fileInfo
+ * @param mixed $fileIndex index or name of the requested file
+ * @return array
*/
public function getFileInfo($fileIndex) {
if (!is_int($fileIndex)) {
/**
* Uninstalls node components and returns next node.
*
- * @param string $node
* @return string
*/
public function stepUninstall() {
* )
*
* @param array $data
- * @param string $className
- * @param string $actionName
- * @return \wcf\action\AJAXInvokeAction
+ * @return AJAXInvokeAction
*/
public static function debugCall(array $data) {
// validate $data array
/**
* Renders the result template.
+ *
+ * @param array $returnValues
*/
public function getResult(array &$returnValues) {
WCF::getTPL()->assign(array(
/**
* Renders the vote template.
+ *
+ * @param array $returnValues
*/
public function getVote(array &$returnValues) {
WCF::getTPL()->assign(array(
/**
* Sets related comment object.
*
- * @param Comment
+ * @param Comment $comment
*/
public function setComment(Comment $comment) {
if ($this->commentID == $comment->commentID) {
* @param string $search search query
* @param string $replace
* @param integer $languageID
- * @param boolean $useRegex
- * @param boolean $caseSensitive
- * @param boolean $searchVariableName
+ * @param integer $useRegex
+ * @param integer $searchVariableName
* @return array
*/
public static function search($search, $replace = null, $languageID = null, $useRegex = 0, $searchVariableName = 0) {
/**
* Sets the object type.
*
- * @param ObjectType
+ * @param ObjectType $objectType
*/
public function setObjectType(ObjectType $objectType);
/**
* Sets the liked object.
*
- * @param ILikeObject $likeObject
+ * @param ILikeObject $likedObject
*/
public function setLikedObject(ILikeObject $likedObject) {
$this->likedObject = $likedObject;
* @param string $fromVersion
* @return boolean
*/
- public static function checkFromversion($currentVersion, $fromversion) {
- if (mb_strpos($fromversion, '*') !== false) {
+ public static function checkFromversion($currentVersion, $fromVersion) {
+ if (mb_strpos($fromVersion, '*') !== false) {
// from version with wildcard
// use regular expression
- $fromversion = str_replace('\*', '.*', preg_quote($fromversion, '!'));
- if (preg_match('!^'.$fromversion.'$!i', $currentVersion)) {
+ $fromVersion = str_replace('\*', '.*', preg_quote($fromVersion, '!'));
+ if (preg_match('!^'.$fromVersion.'$!i', $currentVersion)) {
return true;
}
}
else {
- if (self::compareVersion($currentVersion, $fromversion, '=')) {
+ if (self::compareVersion($currentVersion, $fromVersion, '=')) {
return true;
}
}
*
* @param integer $parentID
* @param PageNode $parentNode
- * @param int[] $filter
* @return PageNode[]
*/
protected function generateNodeTree($parentID, PageNode $parentNode = null) {
* @param string $search search query
* @param string $replace
* @param array $templateIDs
- * @param boolean $invertTemplates
- * @param boolean $useRegex
- * @param boolean $caseSensitive
- * @param boolean $invertSearch
+ * @param integer $invertTemplates
+ * @param integer $useRegex
+ * @param integer $caseSensitive
+ * @param integer $invertSearch
* @return array
*/
public static function search($search, $replace = null, $templateIDs = null, $invertTemplates = 0, $useRegex = 0, $caseSensitive = 0, $invertSearch = 0) {
/**
* Adds a user to the groups he should be in.
*
- * @param array $groups
+ * @param array $groupIDs
* @param boolean $deleteOldGroups
* @param boolean $addDefaultGroups
*/
/**
* Turns PHP errors into an ErrorException.
*
- * @param integer $errorNo
+ * @param integer $severity
* @param string $message
- * @param string $filename
- * @param integer $lineNo
+ * @param string $file
+ * @param integer $line
*/
public static final function handleError($severity, $message, $file, $line) {
// this is neccessary for the shut-up operator
/**
* Sets the attachment list.
*
- * @param \wcf\data\attachment\GroupedAttachmentList $attachments
+ * @param \wcf\data\attachment\GroupedAttachmentList $attachmentList
* @deprecated
*/
public static function setAttachmentList(GroupedAttachmentList $attachmentList) {
/**
* Removes the objects with the given ids from the runtime cache if they have already been loaded.
*
- * @param integer $objectID
+ * @param integer[] $objectIDs
*/
public function removeObjects(array $objectIDs);
}
* Every concrete condition implementation needs to implement this interface.
*
* @author Matthias Schmidt
- * @copyright 2001-2015 WoltLab GmbH
+ * @copyright 2001-2016 WoltLab GmbH
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package com.woltlab.wcf
* @subpackage system.condition
* Extracts all needed data from the given condition to pre-fill the output
* for editing the given condition.
*
- * @param \wcf\data\condition\Condition $condition
+ * @param Condition $condition
*/
public function setData(Condition $condition);
/**
- * Validates the given data.
- *
- * @param string $value
+ * Validates the read condition data.
*/
public function validate();
}
/**
* Logs cronjob exec success or failure.
*
- * @param \wcf\data\cronjob\CronjobEditor $logEditor
- * @param \wcf\system\exception\SystemException $exception
+ * @param CronjobLogEditor $logEditor
+ * @param SystemException $exception
*/
protected function logResult(CronjobLogEditor $logEditor, SystemException $exception = null) {
if ($exception !== null) {
/**
* Sets the email's 'Reply-To'.
*
- * @param \wcf\system\email\Mailbox $sender
+ * @param Mailbox $replyTo
*/
public function setReplyTo(Mailbox $replyTo = null) {
$this->replyTo = $replyTo;
* Throws a JSON-encoded error message
*
* @param string $message
- * @param boolean $isDoomsday
+ * @param integer $errorType
* @param string $stacktrace
* @param array $returnValues
* @param string $exceptionID
* Opens a new ftp connection to given host.
*
* @param string $host
- * @param string $port
+ * @param integer $port
* @param integer $timeout
*/
public function __construct($host = 'localhost', $port = 21, $timeout = 30) {
/**
* Returns true, if all given label ids are valid and accessible.
*
- * @param array<integer> $labelIDs
- * @param array $optionName
+ * @param integer[] $labelIDs
+ * @param string $optionName
+ * @param boolean $legacyReturnValue
* @return mixed
*/
public function validateLabelIDs(array $labelIDs, $optionName = '', $legacyReturnValue = true);
* Sets additional options for elements, required if updating values.
*
* @param integer $elementID
- * @param integer $pckageID
+ * @param integer $packageID
* @param string $value
* @param string $pattern
*/
* nodes to provide to be descendants of the new node. If you intend
* to insert more than a single node, you should prefer shiftNodes().
*
- * @param string $beforeNode
- * @param \wcf\system\Callback $callback
+ * @param string $beforeNode
+ * @param Callback $callback
*/
public function insertNode($beforeNode, Callback $callback) {
$newNode = $this->getToken();
/**
* Gets stored auth data of given update server.
*
- * @param array $updateServer
- * @return array $authData
+ * @param array $data
+ * @return array
*/
protected function getAuthData(array $data) {
$updateServer = new PackageUpdateServer(null, $data);
* Compiles SCSS stylesheets into one CSS-stylesheet and writes them
* to filesystem. Please be aware not to append '.css' within $filename!
*
- * @param string $filename
- * @param array<string> $files
- * @param array<string> $variables
- * @param string $individualScss
- * @param \wcf\system\Callback $callback
+ * @param string $filename
+ * @param string[] $files
+ * @param string[] $variables
+ * @param string $individualScss
+ * @param Callback $callback
*/
protected function compileStylesheet($filename, array $files, array $variables, $individualScss, Callback $callback) {
foreach ($variables as &$value) {
/**
* Validates the uploaded files. Returns true on success, otherwise false.
*
- * @param integer $maxFilesize
- * @param array<string> $fileExtensions
+ * @param IUploadFileValidationStrategy $validationStrategy
* @return boolean
*/
public function validateFiles(IUploadFileValidationStrategy $validationStrategy) {
* Returns the user ids of the notification recipients. If an empty array
* is returned, no notifications should be sent.
*
- * @param integer $comment
+ * @param Comment $comment
* @return integer[]
*/
public function getRecipientIDs(Comment $comment);
/**
* Updates a watched object for all subscriber.
*
- * @param string $objectType
- * @param integer $objectIDs
- * @param string $notificationEventName
- * @param string $notificationObjectType
- * @param \wcf\system\user\notification\object\IUserNotificationObject $notificationObject
- * @param array $additionalData
+ * @param string $objectType
+ * @param integer $objectID
+ * @param string $notificationEventName
+ * @param string $notificationObjectType
+ * @param IUserNotificationObject $notificationObject
+ * @param array $additionalData
*/
public function updateObject($objectType, $objectID, $notificationEventName, $notificationObjectType, IUserNotificationObject $notificationObject, array $additionalData = array()) {
// get object type id
/**
* Returns an instance of DirectoryUtil (or child).
*
- * @param string $directory path
+ * @param string $tmpDirectory path
* @param boolean $recursive walk through sub-directories too
- * @return \wcf\util\DirectoryUtil
+ * @return DirectoryUtil
*/
public static function getInstance($tmpDirectory, $recursive = true) {
$directory = realpath(FileUtil::unifyDirSeparator($tmpDirectory));
/**
* Executes a callback on each file and returns false if callback is invalid.
*
- * @param \wcf\system\Callback $callback
- * @param \wcf\system\Regex $pattern callback is only applied to files matching the given pattern
+ * @param Callback $callback
+ * @param Regex $pattern callback is only applied to files matching the given pattern
* @return boolean
*/
public function executeCallback(Callback $callback, Regex $pattern = null) {
projects / GitHub / WoltLab / WCF.git / commitdiff