ApiDoc BACKEND

AccController extends Controller

Table of Contents

Methods

actionAvailableUuid()  : array{name: string, message: string, code: int, status: int, data: array{available: bool}}
Desc: Comprueba disponibilidad de UUID. Funciona con el método GET.
actionChangeCurrentChild()  : array{name: string, message: string, code: int, status: int}|void
Desc: Se actualiza el material hijo colocandolo como activo. Primero se verifica si existen otros elementos activos y se actualizan a false.
actionCreate()  : array{name: string, message: string, code: int, status: int}
Desc: Metodo para crear nuevos accesorios. Funciona con el método POST.
actionCreateChild()  : array{name: string, message: string, status: int, type: string}
Desc: Crea nuevos materiales hijos. Funciona con el método POST.
actionDelete()  : array{name: string, message: string, code: int, status: int}
Desc: Elimina un item de Accessories. Funciona con el método DELETE.
actionDeleteChild()  : array{name: string, message: string, code: int, status: int}
Desc: Elimina un item de CatAccessories. Funciona con el método DELETE.
actionDuplicateItem()  : array{name: string, message: string, code: int, status: int}
Desc: Duplica un item de Accessories. 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 Accessories. Funciona con método GET.
actionList()  : array{name: string, status: int, total: int, pagination: array{pageCount: int, currentPage: int, pageSize: int}, data: array}
Desc: Obtiene el listado general de acc con su material "hijo". En caso de que el hijo no tenga datos devoverá null. Funciona con el método GET.
actionListEnables()  : array{name: string, status: int, total: int, pagination: array{pageCount: int, currentPage: int, pageSize: int}, data: array}
Desc: Obtiene el listado general de acc con su material "hijo". Funciona con el método GET.
actionUpdate()  : array{name: string, message: string, status: int, type: string}
Desc: Actualiza un item de Accessories. Funciona con los métodos PUT, PATCH.
actionUpdateChild()  : CatAccessories|null}
Desc: Actualiza un material hijo. Funciona con métodos PUT, PACH.
actionUpdatePartialChild()  : mixed
Desc: Actualiza la informacion parcial del material hijo actual o activo. 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()  : Accessories
Desc: Item de Accessories. Funciona con método GET.
actionViewChildRaw()  : array<string|int, mixed>|bool
Desc: Retorna los datos en crudo de un material hijo especifico. Funciona con el método GET.
actionViewRaw()  : Accessories|null
Desc: Item de Accessories. 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.
saveImage()  : array{status: bool, message: string, path: string, file: mixed}
Desc: Almacena el archivo en la ruta y la guarda en el modelo.

Methods

actionAvailableUuid()

Desc: Comprueba disponibilidad de UUID. Funciona con el método GET.

public actionAvailableUuid(string $uuid) : array{name: string, message: string, code: int, status: int, data: array{available: bool}}

Notes: n/a, Ref: Accessories

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

Example: n/a

Parameters
$uuid : string
Return values
array{name: string, message: string, code: int, status: int, data: array{available: bool}}

actionChangeCurrentChild()

Desc: Se actualiza el material hijo colocandolo como activo. Primero se verifica si existen otros elementos activos y se actualizan a false.

public actionChangeCurrentChild(int $parent_id, int $child_id) : array{name: string, message: string, code: int, status: int}|void

Funciona con los métodos PUT, PATCH

Notes: n/a,

Ref: CatAccessories

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

Example: n/a

Parameters
$parent_id : int
$child_id : int
Return values
array{name: string, message: string, code: int, status: int}|void

actionCreate()

Desc: Metodo para crear nuevos accesorios. Funciona con el método POST.

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

Notes: n/a,

Ref: Accessories

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

Example: n/a

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

actionCreateChild()

Desc: Crea nuevos materiales hijos. Funciona con el método POST.

public actionCreateChild() : array{name: string, message: string, status: int, type: string}

Notes: n/a,

Ref: CatAccessories

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

Example: n/a

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

actionDelete()

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

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

Notes: n/a, Ref: Accessories

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}

actionDeleteChild()

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

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

Notes: n/a, Ref: CatAccessories

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}

actionDuplicateItem()

Desc: Duplica un item de Accessories. Funciona con el método GET.

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

Notes: n/a, Ref: Accessories::cloneData()

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

Example: n/a

Parameters
$id : int
  • ID del material
Return values
array{name: string, message: string, code: int, status: int}

actionIndex()

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

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}

actionList()

Desc: Obtiene el listado general de acc con su material "hijo". En caso de que el hijo no tenga datos devoverá null. Funciona con el método GET.

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

Notes: Parametros de filtro: sort, search, ,

Ref: Accessories

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}

actionListEnables()

Desc: Obtiene el listado general de acc con su material "hijo". Funciona con el método GET.

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

Notes: n/a,

Ref: Accessories

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}

actionUpdate()

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

public actionUpdate(int $id) : array{name: string, message: string, status: int, type: string}

Notes: n/a,

Ref: Accessories

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

Example: n/a

Parameters
$id : int
Return values
array{name: string, message: string, status: int, type: string}

actionUpdateChild()

Desc: Actualiza un material hijo. Funciona con métodos PUT, PACH.

public actionUpdateChild(int $id) : CatAccessories|null}

Notes: n/a, Ref: CatAccessories,

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

Example: n/a

Parameters
$id : int
Return values
CatAccessories|null}

actionUpdatePartialChild()

Desc: Actualiza la informacion parcial del material hijo actual o activo. Funciona con los métodos PUT, PATCH.

public actionUpdatePartialChild(int $id) : mixed

Notes: n/a,

Ref: CatAccessories

Date: 2025-08-11, 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 AccController::saveImage(),

Ref: UploadedFile

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

Example: n/a

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

actionView()

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

public actionView(int $id) : Accessories

Notes: n/a.

Ref: Accessories

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

Example: n/a

Parameters
$id : int
Return values
Accessories

actionViewChildRaw()

Desc: Retorna los datos en crudo de un material hijo especifico. Funciona con el método GET.

public actionViewChildRaw(int $id) : array<string|int, mixed>|bool

Notes: No se utiliza el ORM para la consulta.

Ref: n/a,

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

Example: n/a

Parameters
$id : int
Return values
array<string|int, mixed>|bool

actionViewRaw()

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

public actionViewRaw(string $id) : Accessories|null

Notes: Retorna clase Accessories con los campos en 'crudo'.

Ref: Accessories

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

Example: n/a

Parameters
$id : string
Return values
Accessories|null

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