wamo/gnu-social
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc comments on User::allowed_nickname

Browse Source
This commit is contained in:
Brion Vibber 2010-11-29 11:57:27 -08:00
parent b7e0078d10
commit 6e249b4ab5
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
classes/User.php
View File

@ -116,6 +116,16 @@ class User extends Memcached_DataObject
return $result; 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) static function allowed_nickname($nickname)
{ {
// XXX: should already be validated for size, content, etc. // XXX: should already be validated for size, content, etc.