ApiDoc BACKEND

ProductOrder extends ActiveRecord uses JsonBehaviorTrait

This is the model class for table "product_order".

Table of Contents

Constants

GST_PERCENT  = 5

PO_STATUS  = ['PENDING_ORDER', 'ORDER_PLACED', 'IN_PRODUCTION', 'IN_TRANSIT', 'OTHER', 'MODIFIED', 'COMPLETED', 'CANCELLED', 'EXPIRED']

SCENARIO_ONLY_PO  = 'only_po'

SCENARIO_PAYMENT_TOKEN  = 'payment_token'

Properties

$action_log_details  : mixed

$checkout  : string

$confirmed_at  : string|null

$coupon_applied  : string|null

$created_at  : string|null

$customer  : Customer

$customer_id  : int

$discount  : float

$enable_notes_1  : int

$enable_notes_2  : int

$id  : int

$modified  : int

$notes_1  : string

$notes_2  : string

$only_discount  : mixed

$open_po  : int

$origin  : string

$parent_po_id  : int

$payment_request_id  : string|null

$po  : string

$po_no  : string

$po_status  : string

$productOrderDetails  : array<string|int, ProductOrderDetail>

$receipt_no  : string|null

$revision_no  : int

$shipping_address  : string

$shipping_fee  : float

$token  : string

$total  : float

$type  : string

$updated_at  : string|null

Methods

beforeSave()  : mixed

calculateTotal()  : array<string|int, mixed>

Desc: Calcula el total de la orden de pago.

calculateTotalByModel()  : array{total: float, subtotals: array{normal: float, discount: float}, shipping_fee: float, currency: string, count: int}

Desc: Calculo del totales usando modelo como parametro para evitar la doble consulta en el metodo

customers()  : ProductOrder

Desc: Retorna una clase anónima que retorna el método fields() modificado

dateFormatter()  : IntlDateFormatter|null

Desc: Retorna objeto para imprimir la fecha en el formato especificado por parámetros.

extraFields()  : mixed

fields()  : array<string|int, mixed>

Desc: Columnas a utilizar de los registros

filterITemsByType()  : array<string|int, ProductOrderDetail>

Desc: Filtra el listado de productos de una orden por tipo.

findByToken()  : static|null|ProductOrder

Desc: Retorna el modelo de {@see ProductOrder} en caso de que el token sea válido

generatePaymentLink()  : string

Desc: Construye un enlace de pago.

generatePoNumber()  : string

Desc: Retorna el PO en string.

generateToken()  : void

Desc: Generates token in base64 // genera un token en base64 y se asigna en {@see ProductOrder::$token}

getCustomer()  : ActiveQuery

Desc: Obtiene query para [[Customer]].

getProductOrderDetails()  : ActiveQuery

Desc: Obtiene query para [[ProductOrderDetails]].

getTimeFromToken()  : int

Desc: Obtiene el tiempo indicado en el token (segundos), el token debe de ser Base64.

getTimeRemaining()  : int

Desc: Obtiene el tiempo restante según el tiempo indicado en el parámetro. (segundos)

getTotalReturns()  : mixed

jsonDecode()  : mixed

jsonEncode()  : void

Desc método para codificar un array de datos a JSONSTRING,

readableStatus()  : string

Desc: Retorna los estados 'nativos' usados del PO a estados legibles para usuarios.

requestCheckAvailableStock()  : mixed

requestUpdateStockInNewPO()  : void

Desc: Solicita actualizacion de stock basado en PO.

rules()  : array<string|int, mixed>

Desc: Reglas de validación.

scenarios()  : array<string|int, mixed>

Desc: Retorna la lista de escenarios posibles para la validación de atributos.

sendMail()  : bool

Desc: Envía un email con el enlace de pago indicado por parámetro.

sendOwnerNotification()  : bool

sendReceiptByEmail()  : bool

Desc: Envía el recibo de pago por email. Retorna un booleano (true) en caso de éxito.

tableName()  : string

Desc: Nombre de la tabla de la base de datos.

totalReturns()  : float

Desc: Retorna el total a devolver de la orden de pago (PO). Se toma en cuenta e número de revisión para realizar el cálculo.

echo ProductOrder::generatePoNumber(5);
//Result: PO_0005