From 0ca80f78fbb07ebaaa1509c65021eb5f26cf5c99 Mon Sep 17 00:00:00 2001 From: Brion Vibber Date: Tue, 15 Dec 2009 18:27:03 -0500 Subject: Add doc comments listing the array parameters for User::register() and Notice::saveNew() --- classes/User.php | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) (limited to 'classes/User.php') diff --git a/classes/User.php b/classes/User.php index c62314d50..ae709b46b 100644 --- a/classes/User.php +++ b/classes/User.php @@ -180,6 +180,27 @@ class User extends Memcached_DataObject return $result; } + /** + * Register a new user account and profile and set up default subscriptions. + * If a new-user welcome message is configured, this will be sent. + * + * @param array $fields associative array of optional properties + * string 'bio' + * string 'email' + * bool 'email_confirmed' pass true to mark email as pre-confirmed + * string 'fullname' + * string 'homepage' + * string 'location' informal string description of geolocation + * float 'lat' decimal latitude for geolocation + * float 'lon' decimal longitude for geolocation + * int 'location_id' geoname identifier + * int 'location_ns' geoname namespace to interpret location_id + * string 'nickname' REQUIRED + * string 'password' (may be missing for eg OpenID registrations) + * string 'code' invite code + * ?string 'uri' permalink to notice; defaults to local notice URL + * @return mixed User object or false on failure + */ static function register($fields) { // MAGICALLY put fields into current scope -- cgit v1.2.3-54-g00ecf