/**
* Enables an option.
- *
+ *
* @param string target
* @param boolean enable
*/
/**
* Inserts hidden form elements for each value.
- *
+ *
* @param string $type
*/
_save: function($type) {
/**
* Returns container element.
- *
+ *
* @return jQuery
*/
getContainer: function() {
/**
* Escapes an ID to work with jQuery selectors.
- *
+ *
* @see http://docs.jquery.com/Frequently_Asked_Questions#How_do_I_select_an_element_by_an_ID_that_has_characters_used_in_CSS_notation.3F
* @param string id
* @return string
/**
* Counter for dynamic element ids
- *
+ *
* @var integer
*/
_idCounter: 0,
/**
* Escapes a String to work with RegExp.
- *
+ *
* @see https://github.com/sstephenson/prototype/blob/master/src/prototype/lang/regexp.js#L25
* @param string string
* @return string
/**
* Fetches the template with the given variables.
- *
+ *
* @param v variables to insert
* @return parsed template
*/
/**
* Throws an previously catched exception while maintaing the propriate stacktrace.
- *
+ *
* @param \Exception $e
*/
protected function throwException(\Exception $e) {
/**
* Returns action response.
- *
+ *
* @return mixed
*/
public function getResponse() {
/**
* Performs a debug call to AJAXInvokeAction, allowing testing without relying on JavaScript.
* The $data-array should be build like within WCF.Action.Proxy, look below for an example:
- *
+ *
* $data = array(
* 'actionName' => 'foo',
* 'className' => 'wcf\foo\bar\FooBarAction',
* )
* )
* )
- *
+ *
* @param array $data
* @param string $className
* @param string $actionName
/**
* Creates a new message and returns it.
- *
+ *
* @return array
*/
public function quickReply();
/**
* Validates the container object for quick reply.
- *
+ *
* @param wcf\data\DatabaseObject $container
*/
public function validateContainer(DatabaseObject $container);
/**
* Returns controller name.
- *
+ *
* @return string
*/
public function getController() {
/**
* Returns the menu item name.
- *
+ *
* @return string
*/
public function __toString() {
/**
* Returns the ip address and attempts to convert into IPv4.
- *
+ *
* @return string
*/
public function getIpAddress() {
/**
* Sets the permissions for attachment access.
- *
+ *
* @param array<boolean> $permissions
*/
public function setPermissions(array $permissions) {
/**
* Returns a rendered message preview.
- *
+ *
* @return array
*/
public function getMessagePreview() {
/**
* Returns parsed responses for given comment id.
- *
+ *
* @return array
*/
public function loadResponses() {
/**
* Sets editable state.
- *
+ *
* @param boolean $editable
*/
public function setIsEditable($editable) {
/**
* Returns true if the response is editable by current user.
- *
+ *
* @return boolean
*/
public function isEditable() {
/**
* Fetches the like data.
- *
+ *
* @return array
*/
public function getLikeData() {
/**
* Sets user permissions.
- *
+ *
* @param array $permissions
*/
public function setUserPermissions(array $permissions) {
}
/**
- * Gets the object type id with the given definition name and given name.
- *
+ * Returns the object type id with the given definition name and given name.
+ *
* @param string $definitionName
* @param string $objectTypeName
* @return integer
/**
* Returns the id of a specific package or 'null' if not found.
- *
+ *
* @param string $package
* @return string
*/
/**
* Returns the name of the package the update belongs to.
- *
+ *
* @return string
*/
public function getName() {
/**
* Sets latest accessible package update version object.
- *
+ *
* @param wcf\data\package\update\version\PackageUpdateVersion $latestVersion
*/
public function setAccessibleVersion(PackageUpdateVersion $latestVersion) {
/**
* Returns latest accessible package update version object.
- *
+ *
* @return wcf\data\package\update\version\PackageUpdateVersion
*/
public function getAccessibleVersion() {
/**
* Returns latest package update version object.
- *
+ *
* @return wcf\data\package\update\version\PackageUpdateVersion
*/
public function getLatestVersion() {
}
/**
- * Returns true, if update server requires license data instead of username/password.
- *
+ * Returns true if update server requires license data instead of username/password.
+ *
* @return integer
*/
public final function requiresLicense() {
/**
* CAUTION: This methods does not return the current iterator index,
* rather than the object key which maps to that index.
- *
+ *
* @see \Iterator::key()
*/
public function key() {
/**
* Return the tag with the given name or null of no such tag exists.
- *
+ *
* @param string $name
* @param integer $languageID
* @return mixed
/**
* Unmarks users.
- *
+ *
* @param array<integer> $userIDs
*/
protected function unmarkItems(array $userIDs = array()) {
/**
* Returns the formatted value of the user option with the given name.
- *
+ *
* @param string $name
* @return mixed
*/
/**
* Returns the width of this avatar.
- *
+ *
* @return integer
*/
public function getWidth();
/**
* Returns the controller name.
- *
+ *
* @return string
*/
public function getController();
/**
* Returns the parent object type.
- *
+ *
* @return string
*/
public function getParentObjectType();
/**
* Returns the parent object id.
- *
+ *
* @return integer
*/
public function getParentObjectID();
/**
* Returns the object type.
- *
+ *
* @return string
*/
public function getObjectType();
/**
* Returns the object id.
- *
+ *
* @return integer
*/
public function getObjectID();
/**
* CAUTION: This methods does not return the current iterator index,
* rather than the object key which maps to that index.
- *
+ *
* @see \Iterator::key()
*/
public function key() {
/**
* Includes the required util or exception classes automatically.
- *
+ *
* @param string $className
* @see spl_autoload_register()
*/
/**
* Returns the URI of the current page.
- *
+ *
* @return string
*/
public static function getRequestURI() {
/**
* Returns true if current application is treated as active and was invoked directly.
- *
+ *
* @return boolean
*/
public function isActiveApplication();
/**
* Returns true if the active user has the permission to upload attachments.
- *
+ *
* @return boolean
*/
public function canUpload() {
interface ICacheSource {
/**
* Flushes a specific cache, optionally removing caches which share the same name.
- *
+ *
* @param string $cacheName
* @param boolean $useWildcard
*/
/**
* Returns the ids of the users which can be banned.
- *
+ *
* @return array<integer>
*/
protected function validateBan() {
/**
* Validates accessible groups.
- *
+ *
* @return array<integer>
*/
protected function __validateAccessibleGroups(array $userIDs, $ignoreOwnUser = true) {
/**
* Returns the ids of the users which can be enabled.
- *
+ *
* @return array<integer>
*/
protected function validateEnable() {
if (!WCF::getSession()->getPermission('admin.user.canEnableUser')) {
return array();
}
-
+
$userIDs = array();
foreach ($this->objects as $user) {
if ($user->activationCode) $userIDs[] = $user->userID;
/**
* Returns the ids of the users which can be merge.
- *
+ *
* @return array<integer>
*/
protected function validateMerge() {
/**
* Removes all comments for given objects.
- *
+ *
* @param string $objectType
* @param array<integer> $objectIDs
*/
/**
* Returns a database editor object.
- *
+ *
* @return wcf\system\database\editor\DatabaseEditor
*/
public function getEditor() {
/**
* Returns true if this database type is supported.
- *
+ *
* @return boolean
*/
public static function isSupported() {
/**
* Creates a new DatabaseEditor object.
- *
+ *
* @param wcf\system\database\Database $dbObj
*/
public function __construct(Database $dbObj) {
/**
* Runs the data export.
- *
+ *
* @param string $objectType
* @param integer $loopCount
*/
/**
* Validates database access.
- *
+ *
* @throws wcf\system\database\DatabaseException
*/
public function validateDatabaseAccess();
/**
* Validates given file system path. Returns false on failure.
- *
+ *
* @return boolean
*/
public function validateFileAccess();
/**
* Sets element description.
- *
+ *
* @param string $description
*/
public function setDescription($description) {
/**
* Returns element description.
- *
+ *
* @return string
*/
public function getDescription() {
/**
* Sets a color to be transparent with alpha 0.
- *
+ *
* @param integer $red
* @param integer $green
* @param integer $blue
}
/**
- * Gets a new id from id mapping.
- *
+ * Returns a new id from id mapping.
+ *
* @param string $type
* @param mixed $oldID
* @return integer $newID
/**
* Returns an associative array with information about a specific file
* in the archive.
- *
+ *
* @param mixed $index index or name of the requested file
* @return array
*/
/**
* Searchs a file in the archive and returns the numeric file index.
* Returns false if not found.
- *
+ *
* @param string $filename
* @return integer index of the requested file
*/
/**
* Returns the object type name.
- *
+ *
* @return string
*/
public function getObjectTypeName() {
}
/**
- * Gets the mail language.
- *
+ * Returns the mail language.
+ *
* @return wcf\data\language\Language
*/
public function getLanguage() {
/**
* Returns the href of the associated menu item.
- *
+ *
* @return string
*/
public function getLink();
/**
* Returns the full quote by quote id.
- *
+ *
* @param string $quoteID
* @return string
*/
/**
* CAUTION: This methods does not return the current iterator index,
* rather than the object key which maps to that index.
- *
+ *
* @see \Iterator::key()
*/
public function key() {
interface IDeletedContentProvider {
/**
* Returns a list of deleted content.
- *
+ *
* @return wcf\data\DatabaseObjectList
*/
public function getObjectList();
/**
* Returns the template name for the result output.
- *
+ *
* @return string
*/
public function getTemplateName();
/**
* Returns the application of the result template.
- *
+ *
* @return string
*/
public function getApplication();
/**
* Enables edit mode.
- *
+ *
* @param boolean $enable
*/
public function enableEditMode($enable = true) {
/**
* Enables search mode.
- *
+ *
* @param boolean $enable
*/
public function enableSearchMode($enable = true) {
/**
* Creates a new instance of PackageInstallationDispatcher.
- *
+ *
* @param wcf\data\package\installation\queue\PackageInstallationQueue $queue
*/
public function __construct(PackageInstallationQueue $queue) {
/**
* Determines intermediate update steps using a backtracking algorithm in case there is no direct upgrade possible.
- *
+ *
* @param string $package package identifier
* @param array $fromversions list of all fromversions
* @param string $currentVersion current package version
/**
* Compares the length of two updates threads.
- *
+ *
* @param array $updateThreadListA
* @param array $updateThreadListB
* @return integer
class PackageUninstallationDispatcher extends PackageInstallationDispatcher {
/**
* Creates a new instance of PackageUninstallationDispatcher.
- *
+ *
* @param wcf\data\package\installation\queue\PackageInstallationQueue $queue
*/
public function __construct(PackageInstallationQueue $queue) {
/**
* Returns package update version.
- *
+ *
* @return array
*/
public function getPackageUpdateVersion() {
/**
* Returns the HTTP request object.
- *
+ *
* @return wcf\util\HTTPRequest
*/
public function getRequest() {
/**
* Returns package update server object.
- *
+ *
* @return wcf\data\package\update\server\PackageUpdateServer
*/
public function getUpdateServer() {
/**
* Imports options.
- *
+ *
* @param \DOMXPath $xpath
*/
protected function importOptions(\DOMXPath $xpath) {
/**
* Handles a http request.
- *
+ *
* @param string $application
* @param boolean $isACPRequest
*/
/**
* Adds a new entry.
- *
+ *
* @param string $objectType
* @param integer $objectID
* @param string $message
/**
* Returns the session id from request (GET/POST). Returns an empty string,
* if no session id was given.
- *
+ *
* @return string
*/
protected function readSessionID() {
/**
* Returns language ids for active user.
- *
+ *
* @return array<integer>
*/
public function getLanguageIDs() {
/**
* Returns the spider id for given user agent.
- *
+ *
* @param string $userAgent
* @return mixed
*/
/**
* Searches for existing session of a search spider.
- *
+ *
* @param integer $spiderID
* @return wcf\data\session\Session
*/
/**
* Returns a list of all styles.
- *
+ *
* @return array<wcf\data\style\Style>
*/
public function getStyles() {
/**
* Returns the application of the result template.
- *
+ *
* @return string
*/
public function getApplication();
/**
* Contructs a new TagCloud object.
- *
+ *
* @param array<integer> $languageIDs
*/
public function __construct(array $languageIDs = array()) {
/**
* Contructs a new TypedTagCloud object.
- *
+ *
* @param string $objectType
* @param array<integer> $languageIDs
*/
/**
* Updates total activity points and ranks for given user ids.
- *
+ *
* @param array<integer> $userIDs
*/
public function updateUsers(array $userIDs) {
/**
* Returns the message for this notification event.
- *
+ *
* @param string $notificationType
* @return string
*/
/**
* Removes a leading slash from the given path.
- *
+ *
* @param string $path
* @return string
*/
}
/**
- * Gets mentioned users.
+ * Returns the mentioned users in the given text.
*
* @param string $text
* @return array<string>
}
/**
- * Gets quoted users.
- *
+ * Returns the quoted users in the given text.
+ *
* @param string $text
* @return array<string>
*/
/**
* 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
* @return string truncated string
/**
* Validates the password hash for MyBB 1.x (mybb1).
- *
+ *
* @param string $username
* @param string $password
* @param string $salt
/**
* Reinserts strings that have been replaced by unique hash values.
- *
+ *
* @param string $string
* @param string $type
* @return string
projects / GitHub / WoltLab / WCF.git / commitdiff