DiscountCouponController extends Controller
Table of Contents
Properties
- $freeAccessActions : mixed
Methods
- actionCheckOffer() : array{name: string, message: string, status: int, code: int, mesagge: string}
- Desc: Verifica oferta activa y actualiza el status de todas de ser necesario. Funciona con método GET.
- actionCreate() : array{name: string, message: string, code: int, status: int}
- Desc: Crea un nuevo item de DiscountCoupon. Funciona con método POST.
- actionDelete() : array{name: string, message: string, code: int, status: int}
- Desc: Elimina un item de DiscountCoupon. Funciona con el método DELETE.
- actionFindCoupon() : DiscountCoupon
- Desc: Devuelve el cupón activo. Funciona con método GET.
- actionIndex() : array{name: string, status: int, total: int, pagination: array{pageCount: int, currentPage: int, pageSize: int}, data: array}
- Desc: Retorna lista de elementos de DiscountCoupon. 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.
- actionUpdate() : array{name: string, message: string, code: int, status: int}
- Desc: Actualiza un item de DiscountCoupon. Funciona con los métodos PUT, PATCH.
- actionVerify() : mixed
- Desc: Verifica y devuelve item de DiscountCoupon. Funciona con método GET.
- actionView() : DiscountCoupon
- Desc: Item de DiscountCoupon. 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.
- updateAllStatus() : array{name: string, message: string, code: int, status: int}
- Desc: Actualiza los status que esten activos y los desactiva
Properties
$freeAccessActions
public
mixed
$freeAccessActions
= ['find-coupon', 'verify', 'check-offer', 'options']
Methods
actionCheckOffer()
Desc: Verifica oferta activa y actualiza el status de todas de ser necesario. Funciona con método GET.
public
actionCheckOffer() : array{name: string, message: string, status: int, code: int, mesagge: string}
Notes: n/a.
Ref: DiscountCoupon
Date: 2025-08-11, Version: v0.2507.01
Example: n/a
Return values
array{name: string, message: string, status: int, code: int, mesagge: string}actionCreate()
Desc: Crea un nuevo item de DiscountCoupon. Funciona con método POST.
public
actionCreate() : array{name: string, message: string, code: int, status: int}
Notes: n/a,
Ref: DiscountCoupon,
Date: 2025-08-08, Version: v0.2507.01
Example: n/a
Return values
array{name: string, message: string, code: int, status: int}actionDelete()
Desc: Elimina un item de DiscountCoupon. Funciona con el método DELETE.
public
actionDelete(int $id) : array{name: string, message: string, code: int, status: int}
Notes: n/a, Ref: n/a
Date: 2025-08-08, Version: v0.2507.01
Example: n/a
Parameters
- $id : int
Return values
array{name: string, message: string, code: int, status: int}actionFindCoupon()
Desc: Devuelve el cupón activo. Funciona con método GET.
public
actionFindCoupon() : DiscountCoupon
Notes: Se puede filtrar por Nombre de categría en params: category.
Ref: DiscountCoupon
Date: 2025-08-08, Version: v0.2507.01
Example: n/a
Return values
DiscountCouponactionIndex()
Desc: Retorna lista de elementos de DiscountCoupon. 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: Los parámetros URL de filtro son: sort, search,
Ref: DiscountCoupon
Date: 2025-08-08, 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}actionOptions()
Desc: Método para brindar información al fronend sobre opciones de comunicación. Funciona con método OPTIONS.
public
actionOptions() : void
Notes: n/a,
Ref: https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Methods/OPTIONS
Date: 2025-08-08, Version: v0.2507.01
Example: n/a
actionUpdate()
Desc: Actualiza un item de DiscountCoupon. Funciona con los métodos PUT, PATCH.
public
actionUpdate(int $id) : array{name: string, message: string, code: int, status: int}
Notes: n/a, Ref: n/a
Date: 2025-08-08, Version: v0.2507.01
Example: n/a
Parameters
- $id : int
-
ID del item
Return values
array{name: string, message: string, code: int, status: int}actionVerify()
Desc: Verifica y devuelve item de DiscountCoupon. Funciona con método GET.
public
actionVerify(string $code) : mixed
Notes: n/a.
Ref: DiscountCoupon
Date: 2025-08-11, Version: v0.2507.01
Example: n/a
Parameters
- $code : string
Tags
actionView()
Desc: Item de DiscountCoupon. Funciona con método GET.
public
actionView(int $id) : DiscountCoupon
Notes: n/a.
Ref: DiscountCoupon
Date: 2025-08-08, Version: v0.2507.01
Example: n/a
Parameters
- $id : int
Return values
DiscountCouponbehaviors()
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-08, 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-08, Version: v0.2507.01
Example: n/a
updateAllStatus()
Desc: Actualiza los status que esten activos y los desactiva
protected
updateAllStatus() : array{name: string, message: string, code: int, status: int}
Notes: n/a, Ref: n/a
Date: 2025-08-08, Version: v0.2507.01
Example: n/a