ApiDoc BACKEND

ProductController extends Controller

Table of Contents

Properties

$freeAccessActions  : mixed

Methods

actionAll()  : array<string|int, mixed>
Desc: Listado simple de Products. Funciona con método GET.
actionCreate()  : array{name: string, message: string, data: array{id: int, name: string, created_at: string}, code: int, status: int}
Desc: Metodo para crear nuevos items de Products. Funciona con el método POST.
actionDelete()  : void
Desc: Elimina un item de Products. Funciona con el método DELETE.
actionEnables()  : array{name: string, status: int, total: int, pagination: array{pageCount: int, currentPage: int, pageSize: int}, data: array}
Desc: Listado de Products de productos activos. Funciona con método GET.
actionIndex()  : array{name: string, status: int, total: int, pagination: array{pageCount: int, currentPage: int, pageSize: int}, data: array}
Desc: Listado de Products. Funciona con método GET.
actionSubtotal()  : array{subtotal: string, subtotal_discount: string, num_products: int, shipping: string, discount: array{amount: string, percentage: string}, customization_price: float, total: string}
Desc: Genera el subtotal de los productos agregados. Funciona con método POST.
actionUpdate()  : void
Desc: Actualiza un item de Products. 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()  : Products
Desc: Item de Products. Funciona con método GET.
actionViewRaw()  : Products
Desc: Item de Products. Devuelve los campos originales de la tabla. 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.
findShippingFee()  : float
Desc: Retorna la comision de envio segun el estado y municipio.
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 = ['enables', 'index', 'view', 'subtotal']

Methods

actionAll()

Desc: Listado simple de Products. Funciona con método GET.

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

Notes: Parametros URL de filtros: category_name

Ref: Products

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

Example: n/a

Return values
array<string|int, mixed>

actionCreate()

Desc: Metodo para crear nuevos items de Products. Funciona con el método POST.

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

Notes: n/a,

Ref: Products

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

Example: n/a

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

actionDelete()

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

public actionDelete(mixed $id) : void

Notes: n/a, Ref: Products

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

Example: n/a

Parameters
$id : mixed

actionEnables()

Desc: Listado de Products de productos activos. Funciona con método GET.

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

Notes: n/a,

Ref: Products

Date: 2025-08-12, 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}

actionIndex()

Desc: Listado de Products. 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: category_name

Ref: Products

Date: 2025-08-12, 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}

actionSubtotal()

Desc: Genera el subtotal de los productos agregados. Funciona con método POST.

public actionSubtotal() : array{subtotal: string, subtotal_discount: string, num_products: int, shipping: string, discount: array{amount: string, percentage: string}, customization_price: float, total: string}

Notes: n/a,

Ref: ProductPresentation

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

Example: n/a

Return values
array{subtotal: string, subtotal_discount: string, num_products: int, shipping: string, discount: array{amount: string, percentage: string}, customization_price: float, total: string}

actionUpdate()

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

public actionUpdate(int $id) : void

Notes: n/a,

Ref: Products

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

Example: n/a

Parameters
$id : int

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 ProductController::saveImage(),

Ref: UploadedFile

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

Example: n/a

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

actionView()

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

public actionView(int $id) : Products

Notes: n/a.

Ref: Products

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

Example: n/a

Parameters
$id : int
Return values
Products

actionViewRaw()

Desc: Item de Products. Devuelve los campos originales de la tabla. Funciona con método GET.

public actionViewRaw(int $id) : Products

Notes: n/a.

Ref: Products

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

Example: n/a

Parameters
$id : int
Return values
Products

findShippingFee()

Desc: Retorna la comision de envio segun el estado y municipio.

protected findShippingFee(string $estado, string $municipio) : float

Notes: n/a,

Ref: ProductPresentation

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

Example: n/a

Parameters
$estado : string

Estado a buscar.

$municipio : string

Municipio a buscar

Return values
float —

Comision en divivsa (MXN) a cobrar.

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-12, 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