ona  18.1.1
About: OpenNetAdmin provides a database managed inventory of your IP network (with Web and CLI interface).
  Fossies Dox: ona-18.1.1.tar.gz  ("inofficial" and yet experimental doxygen-generated source code documentation)  

auth_local Class Reference
Inheritance diagram for auth_local:
[legend]

Public Member Functions

 auth_local ()
 
 checkPass ($user, $pass)
 
 getUserData ($login_name)
 

Public Attributes

 $success = true
 
 $founduser = false
 
 $user = null
 

Detailed Description

auth/local.class.php

foundation authorisation class all auth classes should inherit from this class

Author
Chris Smith chris.nosp@m.@jal.nosp@m.akai..nosp@m.co.u.nosp@m.k

Definition at line 11 of file local.class.php.

Member Function Documentation

◆ auth_local()

auth_local::auth_local ( )

Constructor.

Carry out sanity checks to ensure the object is able to operate.

Author
Christopher Smith chris.nosp@m.@jal.nosp@m.akai..nosp@m.co.u.nosp@m.k

Definition at line 25 of file local.class.php.

◆ checkPass()

auth_local::checkPass (   $user,
  $pass 
)

Check user+password [ MUST BE OVERRIDDEN ]

Checks if the given user exists and the given password is correct

Set $this->founduser to true if we find a valid user found user should be set if we find the user even if the password does not match

Return value will be true or false depnding on match of user/pass

Author
Matt Pascoe matt@.nosp@m.open.nosp@m.netad.nosp@m.min..nosp@m.com
Returns
bool True/False indicating successful auth match of user/pass

Reimplemented in auth_ldap.

Definition at line 46 of file local.class.php.

References $onadb, $status, $user, and db_get_record().

◆ getUserData()

auth_local::getUserData (   $login_name)

Return user info [ MUST BE OVERRIDDEN ] or false

Returns info about the given user needs to contain at least these fields:

username string name of the user grps array list of groups the user is in $user['grps']['groupname']=groupidnum

sets a variable ($this->founduser) to show if a user was found by this function

Author
Matt Pascoe matt@.nosp@m.open.nosp@m.netad.nosp@m.min..nosp@m.com
Returns
array containing user data or false

Definition at line 84 of file local.class.php.

References $onadb, $record, $status, $user, date_mangle(), db_get_record(), db_get_records(), and db_update_record().

Member Data Documentation

◆ $founduser

auth_local::$founduser = false

Definition at line 14 of file local.class.php.

◆ $success

auth_local::$success = true

Definition at line 13 of file local.class.php.

◆ $user

auth_local::$user = null

Definition at line 15 of file local.class.php.

Referenced by checkPass(), auth_ldap\checkPass(), getUserData(), and auth_ldap\getUserData().


The documentation for this class was generated from the following file: