Referencia de la Clase Auth2

Diagrama de herencias de Auth2

Métodos públicos
	setLogin ($field)
	setPass ($field)
	setKey ($key)
	identify ($login=NULL, $pass=NULL, $mode=NULL)
	logout ()
	isValid ()
	setCheckSession ($check)
	setAlgos ($algos, $salt=NULL)
	getError ()
	setError ($error)

Métodos públicos estáticos
static	log ($msg)
static	factory ($adapter=NULL)
static	setDefault ($adapter)

Métodos protegidos
	_check ($username, $password)

Atributos protegidos
	$_error = null
	$_login = 'login'
	$_pass = 'password'
	$_algos = 'md5'
	$_key = 'jt2D14KIdRs7LA=='
	$_checkSession = TRUE

Atributos protegidos estáticos
static	$_defaultAdapter = 'model'

Descripción detallada

Definición en la línea 27 del archivo auth2.php.

Documentación de las funciones miembro

_check (   $username,   $password  )

abstractprotected

Realiza el proceso de autenticacion segun para cada adapter

Parámetros

$username
$password

Devuelve

bool

static factory (   $adapter = NULL)

static

Obtiene el adaptador para Auth

Parámetros

string

$adapter

(model, openid, oauth)

Definición en la línea 235 del archivo auth2.php.

getError

(

)

Obtiene el mensaje de error

Devuelve

string

Definición en la línea 205 del archivo auth2.php.

identify	(		$login = NULL,
			$pass = NULL,
			$mode = NULL
	)

Realiza el proceso de identificacion.

Parámetros

$login	string Valor opcional del nombre de usuario en la bd
$pass	string Valor opcional de la contraseña del usuario en la bd
$mode	string Valor opcional del método de identificación (auth)

Devuelve

bool

Definición en la línea 111 del archivo auth2.php.

isValid

(

)

Verifica que exista una identidad válida para la session actual

Devuelve

bool

Definición en la línea 154 del archivo auth2.php.

static log (   $msg)

static

Logger de las operaciones Auth

Parámetros

$msg

Definición en la línea 224 del archivo auth2.php.

logout

(

)

logout

Parámetros

void

Devuelve

void

Definición en la línea 143 del archivo auth2.php.

setAlgos	(		$algos,
			$salt = NULL
	)

Indica algoritmo de cifrado

Parámetros

string

$algos

Definición en la línea 195 del archivo auth2.php.

setCheckSession

(

$check)

Indica que no se inicie sesion desde browser distinto con la misma IP

Parámetros

bool

$check

Definición en la línea 185 del archivo auth2.php.

static setDefault (   $adapter)

static

Cambia el adaptador por defecto

Parámetros

string

$adapter

nombre del adaptador por defecto

Definición en la línea 252 del archivo auth2.php.

setError

(

$error)

Indica el mensaje de error

Parámetros

string

$error

Definición en la línea 215 del archivo auth2.php.

setKey

(

$key)

Asigna la clave de sesion

Parámetros

string

$key

clave de sesion

Definición en la línea 98 del archivo auth2.php.

setLogin

(

$field)

Asigna el nombre de campo para el campo de nombre de usuario

Parámetros

string

$field

nombre de campo que recibe por POST

Definición en la línea 78 del archivo auth2.php.

setPass

(

$field)

Asigna el nombre de campo para el campo de clave

Parámetros

string

$field

nombre de campo que recibe por POST

Definición en la línea 88 del archivo auth2.php.

Documentación de los campos

$_algos = 'md5'

protected

Definición en la línea 53 del archivo auth2.php.

$_checkSession = TRUE

protected

Definición en la línea 65 del archivo auth2.php.

$_defaultAdapter = 'model'

staticprotected

Definición en la línea 71 del archivo auth2.php.

$_error = null

protected

Definición en la línea 35 del archivo auth2.php.

$_key = 'jt2D14KIdRs7LA=='

protected

Definición en la línea 59 del archivo auth2.php.

$_login = 'login'

protected

Definición en la línea 41 del archivo auth2.php.

$_pass = 'password'

protected

Definición en la línea 47 del archivo auth2.php.

---

La documentación para esta clase fue generada a partir del siguiente fichero:

• /home/joan/git/KumbiaPHP/core/libs/auth2/auth2.php