| Index: trunk/phase3/docs/user.txt |
| — | — | @@ -1,63 +0,0 @@ |
| 2 | | - |
| 3 | | -user.txt |
| 4 | | - |
| 5 | | -Documenting the MediaWiki User object. |
| 6 | | - |
| 7 | | -(DISCLAIMER: The documentation is not guaranteed to be in sync with |
| 8 | | -the code at all times. If in doubt, check the table definitions |
| 9 | | -and User.php.) |
| 10 | | - |
| 11 | | -Database fields: |
| 12 | | - |
| 13 | | - user_id |
| 14 | | - Unique integer identifier; primary key. Sent to user in |
| 15 | | - cookie "{$wgDBname}UserID". |
| 16 | | - |
| 17 | | - user_name |
| 18 | | - Text of full user name; title of "user:" page. Displayed |
| 19 | | - on change lists, etc. Sent to user as cookie "{$wgDBname}UserName". |
| 20 | | - Note that user names can contain spaces, while these are |
| 21 | | - converted to underscores in page titles. |
| 22 | | - |
| 23 | | - user_rights |
| 24 | | - Comma-separated list of rights. Right now, only "sysop", |
| 25 | | - "developer", "bureaucrat", and "bot" have meaning. |
| 26 | | - |
| 27 | | - user_password |
| 28 | | - Salted md5 hash of md5-hashed user login password. If user option to |
| 29 | | - remember password is set, an md5 password hash is stored in cookie |
| 30 | | - "{$wgDBname}UserPassword". The original password and the hashed password |
| 31 | | - can be compared to the salted-hashed-hashed password. |
| 32 | | - |
| 33 | | - user_newpassword |
| 34 | | - Hash for randomly generated password sent on 'send me a new password'. |
| 35 | | - If a match is made on login, the new password will replace the old one. |
| 36 | | - |
| 37 | | - user_email |
| 38 | | - User's e-mail address. (Optional, used for user-to-user |
| 39 | | - e-mail and password recovery.) |
| 40 | | - |
| 41 | | - user_options |
| 42 | | - A urlencoded string of name=value pairs to set various |
| 43 | | - user options. |
| 44 | | - |
| 45 | | - user_touched |
| 46 | | - Timestamp updated when the user logs in, changes preferences, alters |
| 47 | | - watchlist, or when someone edits their user talk page or they clear |
| 48 | | - the new-talk field by viewing it. Used to invalidate old cached pages |
| 49 | | - from the user's browser cache. |
| 50 | | - |
| 51 | | - user_real_name |
| 52 | | - "Real name" optionally used in some metadata lists. |
| 53 | | - |
| 54 | | -The user object encapsulates all of the settings, and clients |
| 55 | | -classes use the getXXX() functions to access them. These functions |
| 56 | | -do all the work of determining whether the user is logged in, |
| 57 | | -whether the requested option can be satisfied from cookies or |
| 58 | | -whether a database query is needed. Most of the settings needed |
| 59 | | -for rendering normal pages are set in the cookie to minimize use |
| 60 | | -of the database. |
| 61 | | - |
| 62 | | -Options |
| 63 | | - The user_options field is a list of name-value pairs. The |
| 64 | | - following option names are used at various points in the system: |