AuthController extends Controller
Table of Contents
Methods
- actionActivateAccount() : array{name: string, message: string, status: int}
- Desc: Activa cuenta si el token es válido.
- actionCheckExistingUser() : bool
- Desc: Comprueba la existencia de un usuario. Funciona con método GET.
- actionGetRoles() : array{name: string, message: string, code: int, status: int, data: mixed}
- Desc: Obtiene los roles del usuario. Funciona con método GET.
- actionLoginAdmin() : UserRest|null, token: mixed}}
- Desc: Valida los datos de inicio de sesión y retorna los datos necesarios para autenticado. Funciona con método POST.
- actionPasswordRecovery() : mixed
- Desc: Genera el token a ser usado para enviar por email y recuperar la contraseña
- actionPasswordRecoveryReceive() : mixed
- Desc: Valida el token y actualiza el password
- behaviors() : array<string|int, mixed>
- Desc: Retorna lista de comportamientos que el controlador debe de seguir.
- init() : void
- Desc: Inicializa configuraciones para el controlador.
Methods
actionActivateAccount()
Desc: Activa cuenta si el token es válido.
public
actionActivateAccount(string $activate) : array{name: string, message: string, status: int}
Notes: n/a,
Ref: UserRest
Date: 2025-08-11, Version: v0.2507.01
Example: n/a
Parameters
- $activate : string
Return values
array{name: string, message: string, status: int}actionCheckExistingUser()
Desc: Comprueba la existencia de un usuario. Funciona con método GET.
public
actionCheckExistingUser(string $username) : bool
Notes: n/a,
Ref: LoginFormAdmin
Date: 2025-08-11, Version: v0.2507.01
Example: n/a
Parameters
- $username : string
Return values
boolactionGetRoles()
Desc: Obtiene los roles del usuario. Funciona con método GET.
public
actionGetRoles() : array{name: string, message: string, code: int, status: int, data: mixed}
Notes: n/a,
Ref: UserRest
Date: 2025-08-11, Version: v0.2507.01
Example: n/a
Return values
array{name: string, message: string, code: int, status: int, data: mixed}actionLoginAdmin()
Desc: Valida los datos de inicio de sesión y retorna los datos necesarios para autenticado. Funciona con método POST.
public
actionLoginAdmin() : UserRest|null, token: mixed}}
Notes: n/a,
Ref: LoginFormAdmin
Date: 2025-08-11, Version: v0.2507.01
Example: n/a
Return values
UserRest|null, token: mixed}}actionPasswordRecovery()
Desc: Genera el token a ser usado para enviar por email y recuperar la contraseña
public
actionPasswordRecovery() : mixed
Notes: n/a,
Ref: UserRest
Date: 2025-08-11, Version: v0.2507.01
Example: n/a
actionPasswordRecoveryReceive()
Desc: Valida el token y actualiza el password
public
actionPasswordRecoveryReceive(string $token) : mixed
Notes: n/a,
Ref: UserRest
Date: 2025-08-11, Version: v0.2507.01
Example: n/a
Parameters
- $token : string
behaviors()
Desc: Retorna lista de comportamientos que el controlador debe de seguir.
public
behaviors() : array<string|int, mixed>
Notes: Contiene excepciones de auht, auhtenticator, filtros de cors, métodos HTTP permitidos.
Ref: https://www.yiiframework.com/doc/api/2.0/yii-rest-controller#behaviors()-detail
Date: 2025-08-11, Version: v0.2507.01
Example: n/a
Return values
array<string|int, mixed> —Configuraciones del comportamiento
init()
Desc: Inicializa configuraciones para el controlador.
public
init() : void
Notes: Se deshabilita la sesión (porque se comporta como un API rest).
Ref: https://www.yiiframework.com/doc/api/2.0/yii-rest-controller#init()-detail
Date: 2025-08-11, Version: v0.2507.01
Example: n/a