ApiDoc BACKEND

UserController extends Controller

Table of Contents

Properties

$_verbs  : mixed

Methods

actionChangePassword()  : array{name: string, message: string, code: int, status: int}|void
Desc: Actualiza el password de User. Funciona con los métodos PUT, PATCH.
actionChangeRole()  : array{name: string, message: string, code: int, status: int}|void
Desc: Actualiza el rol del usuario. Funciona con los métodos PUT, PATCH.
actionCreate()  : array{name: string, message: string, code: int, status: int}|void
Desc: Crea un item de UserRest. Funciona con el método POST.
actionDelete()  : array{name: string, message: string, code: int, status: int}
Desc: Elimina un item de UserRest. Funciona con el método DELETE.
actionIndex()  : array{name: string, status: int, total: int, pagination: array{pageCount: int, currentPage: int, pageSize: int}, data: array}
Desc: Listado de UserRest. Funciona con método GET.
actionOptions()  : void
Desc: Método para brindar información al fronend sobre opciones de comunicación. Funciona con método OPTIONS.
actionRoles()  : array<string|int, mixed>
Desc: Obtiene listado de roles. Funciona con el método GET.
actionUpdate()  : UserRest}
Desc: Actualiza un item de UserRest. Funciona con los métodos PUT, PATCH.
actionUpdateData()  : array{name: string, message: string, code: int, status: int}|void
Desc: Actualiza item User. Funciona con los métodos PUT, PATCH.
actionView()  : UserRest
Desc: Item de UserRest. Funciona con método GET.
behaviors()  : array<string|int, mixed>
Desc: Retorna lista de comportamientos que el controlador debe de seguir.
init()  : void
Desc: Inicializa configuraciones para el controlador.

Properties

$_verbs

private mixed $_verbs = ['POST', 'OPTIONS', 'PUT', 'PATCH', 'DELETE']

Methods

actionChangePassword()

Desc: Actualiza el password de User. Funciona con los métodos PUT, PATCH.

public actionChangePassword(int $id) : array{name: string, message: string, code: int, status: int}|void

Notes: n/a,

Ref: UserRest

Date: 2025-08-11, Version: v0.2507.01

Example: n/a

Parameters
$id : int
Return values
array{name: string, message: string, code: int, status: int}|void

actionChangeRole()

Desc: Actualiza el rol del usuario. Funciona con los métodos PUT, PATCH.

public actionChangeRole(int $id) : array{name: string, message: string, code: int, status: int}|void

Notes: n/a, Ref: n/a

Date: 2025-08-11, Version: v0.2507.01

Example: n/a

Parameters
$id : int
Return values
array{name: string, message: string, code: int, status: int}|void

actionCreate()

Desc: Crea un item de UserRest. Funciona con el método POST.

public actionCreate() : array{name: string, message: string, code: int, status: int}|void

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}|void

actionDelete()

Desc: Elimina un item de UserRest. Funciona con el método DELETE.

public actionDelete(int $id) : array{name: string, message: string, code: int, status: int}

Notes: n/a, Ref: UserRest

Date: 2025-08-11, Version: v0.2507.01

Example: n/a

Parameters
$id : int
Return values
array{name: string, message: string, code: int, status: int}

actionIndex()

Desc: Listado de UserRest. Funciona con método GET.

public actionIndex() : array{name: string, status: int, total: int, pagination: array{pageCount: int, currentPage: int, pageSize: int}, data: array}

Notes: n/a,

Ref: UserRest

Date: 2025-08-11, Version: v0.2507.01

Example: n/a

Return values
array{name: string, status: int, total: int, pagination: array{pageCount: int, currentPage: int, pageSize: int}, data: array}

actionRoles()

Desc: Obtiene listado de roles. Funciona con el método GET.

public actionRoles() : array<string|int, mixed>

Notes: Es obtenido por usando un query de la tabla 'auth_item',

Ref: n/a

Date: 2025-08-11, Version: v0.2507.01

Example: n/a

Return values
array<string|int, mixed>

actionUpdate()

Desc: Actualiza un item de UserRest. Funciona con los métodos PUT, PATCH.

public actionUpdate(int $id) : UserRest}

Notes: n/a,

Ref: UserRest

Date: 2025-08-08, Version: v0.2507.01

Example: n/a

Parameters
$id : int
Return values
UserRest}

actionUpdateData()

Desc: Actualiza item User. Funciona con los métodos PUT, PATCH.

public actionUpdateData(int $id) : array{name: string, message: string, code: int, status: int}|void

Notes: n/a,

Ref: UserRest

Date: 2025-08-11, Version: v0.2507.01

Example: n/a

Parameters
$id : int
Return values
array{name: string, message: string, code: int, status: int}|void

actionView()

Desc: Item de UserRest. Funciona con método GET.

public actionView(int $id) : UserRest

Notes: n/a,

Ref: UserRest

Date: 2025-08-11, Version: v0.2507.01

Example: n/a

Parameters
$id : int
Return values
UserRest 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results