From: Brion Vibber <brion@pobox.com>
Date: Mon, 29 Nov 2010 19:57:27 +0000 (-0800)
Subject: doc comments on User::allowed_nickname
X-Git-Url: https://git.mxchange.org/?a=commitdiff_plain;h=6e249b4ab5aa292d78cfaa9be9dce8706e27ad80;p=quix0rs-gnu-social.git

doc comments on User::allowed_nickname
---

diff --git a/classes/User.php b/classes/User.php
index 964bc3e7f3..92180a9fbc 100644
--- a/classes/User.php
+++ b/classes/User.php
@@ -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.