Referencia de la Clase Auth2

Diagrama de herencias de Auth2

Métodos públicos
	setLogin ($field)
	Asigna el nombre de campo para el campo de nombre de usuario.
	setPass ($field)
	Asigna el nombre de campo para el campo de clave.
	setKey ($key)
	Asigna la clave de sesion.
	identify ()
	Realiza el proceso de identificacion.
	logout ()
	logout
	isValid ()
	Verifica que exista una identidad válida para la session actual.
	setCheckSession ($check)
	Indica que no se inicie sesion desde browser distinto con la misma IP.
	setAlgos ($algos, $salt=NULL)
	Indica algoritmo de cifrado.
	getError ()
	Obtiene el mensaje de error.
	setError ($error)
	Indica el mensaje de error.
Métodos públicos estáticos
static	log ($msg)
	Logger de las operaciones Auth.
static	factory ($adapter=NULL)
	Obtiene el adaptador para Auth.
static	setDefault ($adapter)
	Cambia el adaptador por defecto.
Métodos protegidos
	_check ($username, $password)
	Realiza el proceso de autenticacion segun para cada adapter.
Atributos protegidos
	$_error = null
	$_login = 'login'
	$_pass = 'password'
	$_algos = 'md5'
	$_key = 'jt2D14KIdRs7LA=='
	$_checkSession = TRUE
Atributos protegidos estáticos
static	$_defaultAdapter = 'model'
Métodos privados
	_checkSession ()
	Verificar que no se inicie sesion desde browser distinto con la misma IP.

---

Descripción detallada

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

---

Documentación de las funciones miembro

_check	(	$	username,
		$	password
	)		[abstract, protected]

Realiza el proceso de autenticacion segun para cada adapter.

Parámetros:

$username
$password

Devuelve:

bool

Reimplementado en ModelAuth.

Referenciado por identify().

Gráfico de llamadas a esta función:

_checkSession

(

)

[private]

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

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

Hace referencia a Session::get() y Session::set().

Referenciado por isValid() y setCheckSession().

Gráfico de llamadas para esta función:

Gráfico de llamadas a esta función:

static factory

(

$

adapter = NULL

)

[static]

Obtiene el adaptador para Auth.

Parámetros:

string

$adapter

(model, openid, oauth)

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

Hace referencia a $_defaultAdapter.

getError

(

)

Obtiene el mensaje de error.

Devuelve:

string

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

identify

(

)

Realiza el proceso de identificacion.

Parámetros:

void

Devuelve:

bool

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

Hace referencia a _check() y isValid().

Gráfico de llamadas para esta función:

isValid

(

)

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

Devuelve:

bool

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

Hace referencia a _checkSession(), Session::get() y Session::has().

Referenciado por identify().

Gráfico de llamadas para esta función:

Gráfico de llamadas a esta función:

static log

(

$

msg

)

[static]

Logger de las operaciones Auth.

Parámetros:

$msg

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

Hace referencia a Logger::custom().

Referenciado por ModelAuth::_check().

Gráfico de llamadas para esta función:

Gráfico de llamadas a esta función:

logout

(

)

logout

Parámetros:

void

Devuelve:

void

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

Hace referencia a Session::set().

Gráfico de llamadas para esta función:

setAlgos	(	$	algos,
		$	salt = NULL
	)

Indica algoritmo de cifrado.

Parámetros:

string

$algos

Definición en la línea 192 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 182 del archivo auth2.php.

Hace referencia a _checkSession().

Gráfico de llamadas para esta función:

static setDefault

(

$

adapter

)

[static]

Cambia el adaptador por defecto.

Parámetros:

string

$adapter

nombre del adaptador por defecto

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

setError

(

$

error

)

Indica el mensaje de error.

Parámetros:

string

$_error

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

Referenciado por ModelAuth::_check().

Gráfico de llamadas a esta función:

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 50 del archivo auth2.php.

$_checkSession = TRUE [protected]

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

$_defaultAdapter = 'model' [static, protected]

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

Referenciado por factory().

$_error = null [protected]

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

$_key = 'jt2D14KIdRs7LA==' [protected]

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

$_login = 'login' [protected]

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

$_pass = 'password' [protected]

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

---

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

• /home/joan/000www/repo/spirit/1.0/core/libs/auth2/auth2.php