ApiDoc BACKEND

CheckoutController extends Controller

Table of Contents

Properties

$freeAccessActions  : mixed

Methods

actionCapture()  : mixed
Desc: Captura la orden de Paypal.
actionCreate()  : mixed
Desc: Crea una orden de pago. Funciona con método POST.
actionIndex()  : mixed
actionOptions()  : bool
Desc: Compruba si el título ya se ha usado. Funciona con el método GET.
actionOrders()  : mixed
Desc: Crea ordenes de paypal con monto definido (Solo para nuevas revisiones).
actionRefund()  : mixed
Desc: Solicita una devolución
actionUpdateStatus()  : array{name: string, message: string, code: int, status: int}
Desc: Actualiza el status de la Orden.
actionView()  : mixed
Desc: Ver orden generada por el checkout elegido
behaviors()  : array<string|int, mixed>
Desc: Retorna lista de comportamientos que el controlador debe de seguir.
init()  : void
Desc: Inicializa configuraciones para el controlador.
createAddreesJson()  : array{name: string, address: array{street_number: string, col: string, dept: string|null, city: string, state: string, zip_code: string}, contact: array{email: string, phone: string}}
Desc: Crea y retorna un array de datos basado en la información de CustomerAddress.
findShippingFee()  : int|float
Desc: Retorna el costo de envío por ciudad.

Properties

Methods

actionCapture()

Desc: Captura la orden de Paypal.

public actionCapture(string $id) : mixed

Notes: n/a,

Ref: Paypal::captureOrder()

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

Example: n/a

Parameters
$id : string

ID de la orden de Paypal.

actionOptions()

Desc: Compruba si el título ya se ha usado. Funciona con el método GET.

public actionOptions([mixed $id = null ]) : bool

Notes: n/a, Ref: n/a

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

Example: n/a

Parameters
$id : mixed = null
Return values
bool

actionOrders()

Desc: Crea ordenes de paypal con monto definido (Solo para nuevas revisiones).

public actionOrders() : mixed

Notes: n/a, Ref: n/a

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

Example: n/a

actionRefund()

Desc: Solicita una devolución

public actionRefund(string $id) : mixed

Notes: n/a,

Ref: Paypal::refund()

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

Example: n/a

Parameters
$id : string

ID del la orden del checkout

actionUpdateStatus()

Desc: Actualiza el status de la Orden.

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

Notes: n/a, Ref: n/a

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

Example: n/a

Parameters
$id : string

ID generado por el metodo de pago

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

createAddreesJson()

Desc: Crea y retorna un array de datos basado en la información de CustomerAddress.

protected createAddreesJson(CustomerAddress $customerAddreess) : array{name: string, address: array{street_number: string, col: string, dept: string|null, city: string, state: string, zip_code: string}, contact: array{email: string, phone: string}}

Notes: Su finalidad es convertir el array retornado en un JSON string,

Ref: n/a

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

Example: n/a

Parameters
$customerAddreess : CustomerAddress
Return values
array{name: string, address: array{street_number: string, col: string, dept: string|null, city: string, state: string, zip_code: string}, contact: array{email: string, phone: string}}

findShippingFee()

Desc: Retorna el costo de envío por ciudad.

protected findShippingFee(string $state, string $city) : int|float

Notes: n/a, Ref: n/a

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

Example: n/a

Parameters
$state : string
$city : string
Return values
int|float

        
On this page

Search results