doc comments on User::allowed_nickname

This commit is contained in:
Brion Vibber 2010-11-29 11:57:27 -08:00
parent b7e0078d10
commit 6e249b4ab5

View File

@ -116,6 +116,16 @@ class User extends Memcached_DataObject
return $result;
}
/**
* Check whether the given nickname is potentially usable, or if it's
* excluded by any blacklists on this system.
*
* WARNING: INPUT IS NOT VALIDATED OR NORMALIZED. NON-NORMALIZED INPUT
* OR INVALID INPUT MAY LEAD TO FALSE RESULTS.
*
* @param string $nickname
* @return boolean true if clear, false if blacklisted
*/
static function allowed_nickname($nickname)
{
// XXX: should already be validated for size, content, etc.