Documentation in user model and access library

This commit is contained in:
Eike Foken
2011-08-15 23:24:24 +02:00
parent 020bd13058
commit e1f3b8da54
2 changed files with 10 additions and 0 deletions

View File

@@ -48,6 +48,9 @@ class Access {
/** /**
* Changes a users password. * Changes a users password.
* *
* @param string $username
* @param string $old
* @param string $new
* @return boolean * @return boolean
*/ */
public function changePassword($username, $old, $new) { public function changePassword($username, $old, $new) {
@@ -63,6 +66,7 @@ class Access {
/** /**
* forgotten password feature * forgotten password feature
* *
* @param string $email
* @return void * @return void
*/ */
public function forgottenPassword($email) { public function forgottenPassword($email) {
@@ -101,6 +105,7 @@ class Access {
/** /**
* forgotten_password_complete * forgotten_password_complete
* *
* @param string $code
* @return void * @return void
*/ */
public function forgottenPasswordComplete($code) { public function forgottenPasswordComplete($code) {
@@ -146,6 +151,9 @@ class Access {
/** /**
* Logs the user in. * Logs the user in.
* *
* @param string $username
* @param string $password
* @param boolean $remember
* @return boolean * @return boolean
*/ */
public function login($username, $password, $remember = false) { public function login($username, $password, $remember = false) {
@@ -204,6 +212,7 @@ class Access {
/** /**
* Checks if the current user is assigned to the specified group. * Checks if the current user is assigned to the specified group.
* *
* @param string $checkGroup
* @return boolean * @return boolean
*/ */
public function isGroup($checkGroup) { public function isGroup($checkGroup) {

View File

@@ -117,6 +117,7 @@ class User extends CI_Model {
/** /**
* Checks entered usernames. * Checks entered usernames.
* *
* @param string $username
* @return boolean * @return boolean
*/ */
public function checkUsername($username = '') { public function checkUsername($username = '') {