Merge branch '0.9.x' into merge

[quix0rs-gnu-social.git] / lib / framework.php

diff --git a/lib/framework.php b/lib/framework.php
index acfca9f0e8698a46ddf114a558f7470f157a3809..70987e086c025090634078ef7b4938cceee3d7e3 100644 (file)
--- a/lib/framework.php
+++ b/lib/framework.php
@@ -115,6 +115,17 @@ require_once 'markdown.php';
 
 // XXX: other formats here
 
+/**
+ * Avoid the NICKNAME_FMT constant; use the Nickname class instead.
+ *
+ * Nickname::DISPLAY_FMT is more suitable for inserting into regexes;
+ * note that it includes the [] and repeating bits, so should be wrapped
+ * directly in a capture paren usually.
+ *
+ * For validation, use Nickname::normalize(), Nickname::isValid() etc.
+ *
+ * @deprecated
+ */
 define('NICKNAME_FMT', VALIDATE_NUM.VALIDATE_ALPHA_LOWER);
 
 require_once INSTALLDIR.'/lib/util.php';