ApiDoc BACKEND

BannerController extends Controller

Table of Contents

Properties

$freeAccessActions  : mixed

Methods

actionCategories()  : array<string|int, BannerCategory>
Desc: Listado de BannerCategory. Funciona con método GET.
actionCreate()  : array{name: string, message: string, code: int, status: int}
Desc: Metodo para crear nuevos Banners. Funciona con el método POST.
actionDelete()  : void
Desc: Elimina un item de Banners. 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 Banners. Funciona con método GET.
actionOptions()  : void
Desc: Método para brindar información al frontend sobre opciones de comunicación. Funciona con método OPTIONS.
actionShow()  : array<string|int, mixed>
Desc: Listado de Banners. Funciona con método GET.
actionUpdate()  : array{name: string, message: string}
Desc: Actualiza un item de Accessories. Funciona con los métodos PUT, PATCH.
actionUpload()  : array{status: bool, message: string, path: string, file: mixed}|void
Desc: Sube un archivo al servidor. Funciona con el método POST.
actionView()  : Banners
Desc: Item de Banners. 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.
saveImage()  : array{status: bool, message: string, path: string, file: mixed}
Desc: Almacena el archivo en la ruta y la guarda en el modelo.

Properties

$freeAccessActions

public mixed $freeAccessActions = ['show', 'options']

Methods

actionCreate()

Desc: Metodo para crear nuevos Banners. Funciona con el método POST.

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

Notes: n/a,

Ref: Banners

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

Example: n/a

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

actionDelete()

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

public actionDelete(int $id) : void

Notes: n/a, Ref: Banners

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

Example: n/a

Parameters
$id : int

actionIndex()

Desc: Listado de Banners. 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: Parametros URL de filtros: sort, search, status, show_in,

Ref: Banners

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}

actionShow()

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

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

Notes: Usado para visualizar las imagenes

Ref: Banners

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

Example: n/a

Return values
array<string|int, mixed>

actionUpdate()

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

public actionUpdate(int $id) : array{name: string, message: string}

Notes: n/a,

Ref: Accessories

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

Example: n/a

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

actionUpload()

Desc: Sube un archivo al servidor. Funciona con el método POST.

public actionUpload() : array{status: bool, message: string, path: string, file: mixed}|void

Notes: Funciona con ayuda de BannerController::saveImage(),

Ref: UploadedFile

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

Example: n/a

Return values
array{status: bool, message: string, path: string, file: mixed}|void

actionView()

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

public actionView(int $id) : Banners

Notes: n/a.

Ref: Banners

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

Example: n/a

Parameters
$id : int
Return values
Banners

saveImage()

Desc: Almacena el archivo en la ruta y la guarda en el modelo.

protected saveImage(mixed $model, mixed $campo, mixed $imagen) : array{status: bool, message: string, path: string, file: mixed}

Notes: n/a, Ref: n/a,

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

Example: n/a

Parameters
$model : mixed
$campo : mixed
$imagen : mixed
Return values
array{status: bool, message: string, path: string, file: mixed}

        
On this page

Search results