},
/**
- * Returns true, if dictionary is empty.
+ * Returns true if dictionary is empty.
*
* @return integer
*/
},
/**
- * Force display of first erroneous tab, returns true, if at
- * least one tab contains an error.
+ * Force display of first erroneous tab and returns true if at least one
+ * tab contains an error.
*
* @return boolean
*/
},
/**
- * Returns true, if dialog is visible.
+ * Returns true if dialog is visible.
*
* @return boolean
*/
},
/**
- * Returns true, if identifier is used by an anchor.
+ * Returns true if identifier is used by an anchor.
*
* @param string identifier
* @param boolean isChildren
* Represents an ACP session.
*
* @author Alexander Ebert
- * @copyright 2001-2012 WoltLab GmbH
+ * @copyright 2001-2013 WoltLab GmbH
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package com.woltlab.wcf
* @subpackage data.acp.session
protected static $databaseTableIndexName = 'sessionID';
/**
- * Returns true, if this session type supports persistent logins.
+ * Returns true if this session type supports persistent logins.
*
* @return boolean
*/
* Represents a session access log entry.
*
* @author Marcel Werk
- * @copyright 2001-2012 WoltLab GmbH
+ * @copyright 2001-2013 WoltLab GmbH
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package com.woltlab.wcf
* @subpackage data.acp.session.access.log
protected static $databaseTableIndexName = 'sessionAccessLogID';
/**
- * Returns true, if the URI of this log entry is protected.
+ * Returns true if the URI of this log entry is protected.
*
* @return boolean
*/
* Represents a session log entry.
*
* @author Marcel Werk
- * @copyright 2001-2012 WoltLab GmbH
+ * @copyright 2001-2013 WoltLab GmbH
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package com.woltlab.wcf
* @subpackage data.log
}
/**
- * Returns true, if this session is active.
+ * Returns true if this session is active.
*
* @return boolean
*/
}
/**
- * Returns true, if this session is the active user session.
+ * Returns true if this session is the active user session.
*
* @return boolean
*/
* Represents an option.
*
* @author Alexander Ebert
- * @copyright 2001-2012 WoltLab GmbH
+ * @copyright 2001-2013 WoltLab GmbH
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package com.woltlab.wcf
* @subpackage data.option
}
/**
- * Returns true, if option is visible
+ * Returns true if option is visible
*
* @return boolean
*/
protected static $requirements = null;
/**
- * Returns true, if this package is required by other packages.
+ * Returns true if this package is required by other packages.
*
* @return boolean
*/
}
/**
- * Returns true, if current user can uninstall this package.
+ * Returns true if current user can uninstall this package.
*
* @return boolean
*/
}
/**
- * Returns true, if package identified by $package is already installed.
+ * Returns true if package identified by $package is already installed.
*
* @param string $package
* @return boolean
}
/**
- * Returns true, if package version is valid.
+ * Returns true if package version is valid.
*
* Examples of valid package versions:
* 1.0.0 pl 3
* Represents a page menu item.
*
* @author Alexander Ebert
- * @copyright 2001-2012 WoltLab GmbH
+ * @copyright 2001-2013 WoltLab GmbH
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package com.woltlab.wcf
* @subpackage data.page.menu.item
}
/**
- * Returns true, if current menu item may be set as landing page.
+ * Returns true if current menu item may be set as landing page.
*
* @return boolean
*/
}
/**
- * Returns true, if this item can be deleted.
+ * Returns true if this item can be deleted.
*
* @return boolean
*/
}
/**
- * Returns true, if this item can be disabled.
+ * Returns true if this item can be disabled.
*
* @return boolean
*/
}
/**
- * Returns true, if the given password is the correct password for this user.
+ * Returns true if the given password is the correct password for this user.
*
* @param string $password
* @return boolean password correct
}
/**
- * Returns true, if the given password hash from a cookie is the correct password for this user.
+ * Returns true if the given password hash from a cookie is the correct password for this user.
*
* @param string $passwordHash
* @return boolean password correct
}
/**
- * Returns true, if this user is marked.
+ * Returns true if this user is marked.
*
* @return boolean
*/
}
/**
- * Returns true, if the active user can edit this user.
+ * Returns true if the active user can edit this user.
*
* @return boolean
*/
}
/**
- * Returns true, if the given user is member of the group. If no user is
+ * Returns true if the given user is member of the group. If no user is
* given, the active user is used.
*
* @param wcf\data\user\User $user
}
/**
- * Returns true, if the given groups are accessible for the active user.
+ * Returns true if the given groups are accessible for the active user.
*
* @param array $groupIDs
* @return boolean
}
/**
- * Returns true, if this group is accessible for the active user.
+ * Returns true if this group is accessible for the active user.
*
* @return boolean
*/
* Represents a user option.
*
* @author Marcel Werk
- * @copyright 2001-2012 WoltLab GmbH
+ * @copyright 2001-2013 WoltLab GmbH
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package com.woltlab.wcf
* @subpackage data.user.option
}
/**
- * Returns true, if this option is editable.
+ * Returns true if this option is editable.
*
* @return boolean
*/
* Handles the page number parameter automatically.
*
* @author Marcel Werk
- * @copyright 2001-2012 WoltLab GmbH
+ * @copyright 2001-2013 WoltLab GmbH
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package com.woltlab.wcf
* @subpackage page
}
/**
- * Returns true, if current page is the first page.
+ * Returns true if current page is the first page.
*
* @return boolean
*/
}
/**
- * Returns true, if current page is the last page.
+ * Returns true if current page is the last page.
*
* @return boolean
*/
}
/**
- * Returns true, if memory_limit is set to at least 64 MB
+ * Returns true if memory_limit is set to at least 64 MB
*
* @return boolean
*/
}
/**
- * Returns true, if given $url is an internal URL.
+ * Returns true if given $url is an internal URL.
*
* @param string $url
* @return boolean
* Default interface for all applications for the community framework.
*
* @author Alexander Ebert
- * @copyright 2001-2012 WoltLab GmbH
+ * @copyright 2001-2013 WoltLab GmbH
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package com.woltlab.wcf
* @subpackage system.application
public function __run();
/**
- * Returns true, if current application is treated as active and was invoked directly.
+ * Returns true if current application is treated as active and was invoked directly.
*
* @return boolean
*/
* Every category type has to implement this interface.
*
* @author Matthias Schmidt
- * @copyright 2001-2012 WoltLab GmbH
+ * @copyright 2001-2013 WoltLab GmbH
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package com.woltlab.wcf
* @subpackage system.category
public function afterDeletion(CategoryEditor $categoryEditor);
/**
- * Returns true, if the active user can add a category of this type.
+ * Returns true if the active user can add a category of this type.
*
* @return boolean
*/
public function canAddCategory();
/**
- * Returns true, if the active user can delete a category of this type.
+ * Returns true if the active user can delete a category of this type.
*
* @return boolean
*/
public function canDeleteCategory();
/**
- * Returns true, if the active user can edit a category of this type.
+ * Returns true if the active user can edit a category of this type.
*
* @return boolean
*/
* Abstract implementation of a database access class using PDO.
*
* @author Marcel Werk
- * @copyright 2001-2012 WoltLab GmbH
+ * @copyright 2001-2013 WoltLab GmbH
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package com.woltlab.wcf
* @subpackage system.database
}
/**
- * Returns true, if this database type is supported.
+ * Returns true if this database type is supported.
*
* @return boolean
*/
* }
*
* @author Marcel Werk
- * @copyright 2001-2012 WoltLab GmbH
+ * @copyright 2001-2013 WoltLab GmbH
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package com.woltlab.wcf
* @subpackage system.io
}
/**
- * Returns true, if this tar is (g)zipped.
+ * Returns true if this tar is (g)zipped.
*
* @return boolean
*/
* Provides internationalization support for input fields.
*
* @author Alexander Ebert
- * @copyright 2001-2011 WoltLab GmbH
+ * @copyright 2001-2013 WoltLab GmbH
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package com.woltlab.wcf
* @subpackage system.language
}
/**
- * Returns true, if given element has disabled i18n functionality.
+ * Returns true if given element has disabled i18n functionality.
*
* @param string elementID
* @return boolean
}
/**
- * Returns true, if given element has enabled i18n functionality.
+ * Returns true if given element has enabled i18n functionality.
*/
public function hasI18nValues($elementID) {
if (isset($this->i18nValues[$elementID])) {
}
/**
- * Returns false, if element value is not empty.
+ * Returns true if the value with the given id is valid.
*
* @param string $elementID
* @param boolean $requireI18n
}
/**
- * Returns true, if given string equals a language variable.
+ * Returns true if given string equals a language variable.
*
* @param string $string
* @return boolean
* Any option type has to implement this interface.
*
* @author Marcel Werk
- * @copyright 2001-2012 WoltLab GmbH
+ * @copyright 2001-2013 WoltLab GmbH
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package com.woltlab.wcf
* @subpackage system.option
public function getCSSClassName();
/**
- * Returns true, if options supports internationalization .
+ * Returns true if options supports internationalization .
*
* @return boolean
*/
/**
* User group option type implementation for boolean values.
*
- * The merge of option values returns true, if at least one value is true.
+ * The merge of option values returns true if at least one value is true.
*
* @author Marcel Werk
* @copyright 2001-2012 WoltLab GmbH
* User group option type implementation for integer input fields with an option
* for an infinite value.
*
- * The merge of option values returns true, if at least one value is -1. Otherwise
+ * The merge of option values returns true if at least one value is -1. Otherwise
* it returns the highest value.
*
* @author Marcel Werk
}
/**
- * Return true, if the package archive supports a new installation.
+ * Returns true if the package archive supports a new installation.
*
* @return boolean
*/
* Every PackageInstallationPlugin has to implement this interface.
*
* @author Marcel Werk
- * @copyright 2001-2012 WoltLab GmbH
+ * @copyright 2001-2013 WoltLab GmbH
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package com.woltlab.wcf
* @subpackage system.package.plugin
public function update();
/**
- * Returns true, if the uninstallation of the given package should execute
+ * Returns true if the uninstallation of the given package should execute
* this plugin.
*
* @return boolean
* Represents a page request.
*
* @author Marcel Werk
- * @copyright 2001-2012 WoltLab GmbH
+ * @copyright 2001-2013 WoltLab GmbH
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package com.woltlab.wcf
* @subpackage system.request
}
/**
- * Returns true, if this request has already been executed.
+ * Returns true if this request has already been executed.
*
* @return boolean
*/
}
/**
- * Returns true, if the requested page is avaiable during the offline mode.
+ * Returns true if the requested page is avaiable during the offline mode.
*
* @return boolean
*/
* the Microsoft Public License (MS-PL) http://www.opensource.org/licenses/ms-pl.html
*
* @author Alexander Ebert
- * @copyright 2001-2012 WoltLab GmbH
+ * @copyright 2001-2013 WoltLab GmbH
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package com.woltlab.wcf
* @subpackage system.request
}
/**
- * Returns true, if given request url matches this route.
+ * Returns true if given request url matches this route.
*
* @param string $requestURL
* @return boolean
* the Microsoft Public License (MS-PL) http://www.opensource.org/licenses/ms-pl.html
*
* @author Alexander Ebert
- * @copyright 2001-2012 WoltLab GmbH
+ * @copyright 2001-2013 WoltLab GmbH
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package com.woltlab.wcf
* @subpackage system.request
}
/**
- * Returns true, if a route matches. Please bear in mind, that the
+ * Returns true if a route matches. Please bear in mind, that the
* first route which is able to consume all path components is used,
* even if other routes may fit better. Route order is crucial!
*
}
/**
- * Returns true, if route uses default controller.
+ * Returns true if route uses default controller.
*
* @return boolean
*/
}
/**
- * Returns true, if this is a secure connection.
+ * Returns true if this is a secure connection.
*
* @return true
*/
* Abstract implementation of a ACP search result provider with nested categories.
*
* @author Alexander Ebert
- * @copyright 2001-2012 WoltLab GmbH
+ * @copyright 2001-2013 WoltLab GmbH
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package com.woltlab.wcf
* @subpackage system.search.acp
}
/**
- * Returns true, if given category is valid and accessible.
+ * Returns true if given category is valid and accessible.
*
* @param string $categoryName
* @return boolean
* Every user authentication has to implement this interface.
*
* @author Marcel Werk
- * @copyright 2001-2012 WoltLab GmbH
+ * @copyright 2001-2013 WoltLab GmbH
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package com.woltlab.wcf
* @subpackage system.user.authentication
public static function getInstance();
/**
- * Returns true, if this authentication supports persistent logins.
+ * Returns true if this authentication supports persistent logins.
*
* @return boolean
*/
* Contains file-related functions.
*
* @author Marcel Werk
- * @copyright 2001-2012 WoltLab GmbH
+ * @copyright 2001-2013 WoltLab GmbH
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package com.woltlab.wcf
* @subpackage util
}
/**
- * Return true, if the given filename is an url (http or ftp).
+ * Returns true if the given filename is an url (http or ftp).
*
* @param string $filename
* @return boolean
}
/**
- * Returns true, if php is running as apache module.
+ * Returns true if php is running as apache module.
*
* @return boolean
*/
*/
final class ImageUtil {
/**
- * Checks the content of an image for bad sections.
- * e.g. the use of javascript.
- * Returns false, if any bad stuff was found.
+ * Checks the content of an image for bad sections, e.g. the use of javascript
+ * and returns false if any bad stuff was found.
*
- * @return boolean
+ * @return boolean
*/
public static function checkImageContent($file) {
// get file content
const BCRYPT_TYPE = '2a';
/**
- * Returns true, if given encryption type is supported.
+ * Returns true if given encryption type is supported.
*
* @param string $type
* @return boolean
}
/**
- * Returns true, if given hash looks like a valid bcrypt hash.
+ * Returns true if given hash looks like a valid bcrypt hash.
*
* @param string $hash
* @return boolean
}
/**
- * Returns true, if given bcrypt hash uses a different cost factor and should be re-computed.
+ * Returns true if given bcrypt hash uses a different cost factor and should be re-computed.
*
* @param string $hash
* @return boolean
* Contains string-related functions.
*
* @author Oliver Kliebisch, Marcel Werk
- * @copyright 2001-2012 WoltLab GmbH
+ * @copyright 2001-2013 WoltLab GmbH
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package com.woltlab.wcf
* @subpackage util
}
/**
- * Returns true, if the given string contains only ASCII characters.
+ * Returns true if the given string contains only ASCII characters.
*
* @param string $string
* @return boolean
}
/**
- * Returns true, if the given string is utf-8 encoded.
+ * Returns true if the given string is utf-8 encoded.
* @see http://www.w3.org/International/questions/qa-forms-utf-8
*
* @param string $string
}
/**
- * Returns false, if the given word is forbidden by given word filter.
+ * Returns false if the given word is forbidden by given word filter.
*
* @param string $word
* @param string $filter
* Contains user-related functions.
*
* @author Marcel Werk
- * @copyright 2001-2012 WoltLab GmbH
+ * @copyright 2001-2013 WoltLab GmbH
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package com.woltlab.wcf
* @subpackage util
*/
final class UserUtil {
/**
- * Returns true, if the given name is a valid username.
+ * Returns true if the given name is a valid username.
*
* @param string $name
* @return boolean
}
/**
- * Returns true, if the given username is available.
+ * Returns true if the given username is available.
*
* @param string $name
* @return boolean
}
/**
- * Returns true, if the given e-mail is a valid address.
+ * Returns true if the given e-mail is a valid address.
* @see http://www.faqs.org/rfcs/rfc821.html
*
* @param string $email
}
/**
- * Returns true, if the given email address is available.
+ * Returns true if the given email address is available.
*
* @param string $email
* @return boolean
projects / GitHub / WoltLab / WCF.git / commitdiff