CustomerController extends Controller
Table of Contents
Properties
- $freeAccessActions : mixed
Methods
- actionAvailable() : bool
- Desc: Verifica la disponibilidad de un nombre de usuario. Funciona con el método GET.
- actionChangePassword() : array{name: string, message: string, code: int, status: int}
- Desc: Cambio de su propio password pidiendo en la validacion la contraseña original.
- actionCreate() : array{name: string, message: string, code: int, status: int, data: mixed}
- Desc: Registra a un nuevo customer. Funciona con el método POST.
- actionCustomerData() : array{name: string|null, email: string, phone: string, shippingAddress: string}
- Desc: Retorna la información elemental del cliente (customer). Funciona con método GET.
- actionEmailAvailable() : bool
- Desc: Verifica la disponibilidad de un email. Funciona con el método GET.
- actionIndex() : array{name: string, status: int, total: int, pagination: array{pageCount: int, currentPage: int, pageSize: int}, data: array}
- Desc: Listado de Customer. Funciona con método GET.
- actionLogin() : array{name: string, message: string, code: int, status: int, authorization: mixed, data: array{name: string|null, email: string, phone: string, shippingAddress: string}}
- Desc: Verifica la disponibilidad de un email. Funciona con el 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() : void
- Desc: Actualiza un item de Customer. Funciona con los métodos PUT, PATCH.
- actionView() : Customer
- Desc: Item de Customer. 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.
Properties
$freeAccessActions
public
mixed
$freeAccessActions
= ['available', 'email-available', 'login', 'create', 'options']
Methods
actionAvailable()
Desc: Verifica la disponibilidad de un nombre de usuario. Funciona con el método GET.
public
actionAvailable(string $username) : bool
Notes: n/a,
Ref: UserRest
Date: 2025-08-11, Version: v0.2507.01
Example: n/a
Parameters
- $username : string
Return values
boolactionChangePassword()
Desc: Cambio de su propio password pidiendo en la validacion la contraseña original.
public
actionChangePassword() : array{name: string, message: string, code: int, status: int}
Notes: n/a,
Ref: UserRest
Date: 2025-08-11, Version: v0.2507.01
Example: n/a
Return values
array{name: string, message: string, code: int, status: int}actionCreate()
Desc: Registra a un nuevo customer. Funciona con el método POST.
public
actionCreate() : array{name: string, message: string, code: int, status: int, data: mixed}
Notes: n/a,
Ref: Customer, RegistrationForm
Date: 2025-08-11, Version: v0.2507.01
Example: n/a
Return values
array{name: string, message: string, code: int, status: int, data: mixed}actionCustomerData()
Desc: Retorna la información elemental del cliente (customer). Funciona con método GET.
public
actionCustomerData() : array{name: string|null, email: string, phone: string, shippingAddress: string}
Notes: n/a, Ref: n/a
Date: 2025-08-11, Version: v0.2507.01
Example: n/a
Return values
array{name: string|null, email: string, phone: string, shippingAddress: string}actionEmailAvailable()
Desc: Verifica la disponibilidad de un email. Funciona con el método GET.
public
actionEmailAvailable(string $email) : bool
Notes: n/a,
Ref: UserRest
Date: 2025-08-11, Version: v0.2507.01
Example: n/a
Parameters
- $email : string
Return values
boolactionIndex()
Desc: Listado de Customer. 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: n/a,
Ref: Customer
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}actionLogin()
Desc: Verifica la disponibilidad de un email. Funciona con el método GET.
public
actionLogin() : array{name: string, message: string, code: int, status: int, authorization: mixed, data: array{name: string|null, email: string, phone: string, shippingAddress: string}}
Notes: n/a,
Ref: UserRest
Date: 2025-08-11, Version: v0.2507.01
Example: n/a
Return values
array{name: string, message: string, code: int, status: int, authorization: mixed, data: array{name: string|null, email: string, phone: string, shippingAddress: string}}actionOptions()
Desc: Método para brindar información al fronend sobre opciones de comunicación. Funciona con método OPTIONS.
public
actionOptions([mixed $id = null ]) : void
Notes: n/a,
Ref: https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Methods/OPTIONS
Date: 2025-08-11, Version: v0.2507.01
Example: n/a
Parameters
- $id : mixed = null
actionUpdate()
Desc: Actualiza un item de Customer. Funciona con los métodos PUT, PATCH.
public
actionUpdate(int $id) : void
Notes: n/a,
Ref: Customer
Date: 2025-08-11, Version: v0.2507.01
Example: n/a
Parameters
- $id : int
actionView()
Desc: Item de Customer. Funciona con método GET.
public
actionView() : Customer
Notes: El customer es encontrado por medio del token de autenticación JWT.
Ref: Customer
Date: 2025-08-11, Version: v0.2507.01
Example: n/a
Return values
Customerbehaviors()
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-11, 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-11, Version: v0.2507.01
Example: n/a