ApiDoc BACKEND

PostController extends Controller

Table of Contents

Properties

$enableCsrfValidation  : mixed
$freeAccessActions  : mixed

Methods

actionAvailable()  : bool
Desc: Compruba si el título ya se ha usado. Funciona con el método GET.
actionCreate()  : Post}
Desc: Crea un item de Post. Funciona con método POST.
actionDelete()  : array{name: string, message: string, code: int, status: int}
Desc: Elimina un item de Post. Funciona con el método DELETE.
actionIndex()  : array{name: string, status: int, total: int, pagination: array{pageCount: int, currentPage: int, pageSize: int}, data: array}
Desc: Retorna lista de elementos de Post. 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 Post. Funciona con los métodos PUT, PATCH.
actionView()  : Post
Desc: Item de Post. Funciona con método GET.
actionViewPost()  : Post
Desc: Item de Post. 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

$enableCsrfValidation

public mixed $enableCsrfValidation = false

$freeAccessActions

public mixed $freeAccessActions = ['index', 'view-post', 'options']

Methods

actionAvailable()

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

public actionAvailable(string $title) : bool

Notes: n/a, Ref: n/a

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

Example: n/a

Parameters
$title : string
Return values
bool

actionCreate()

Desc: Crea un item de Post. Funciona con método POST.

public actionCreate() : Post}

Notes: n/a, Ref: n/a,

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

Example: n/a

Return values
Post}

actionDelete()

Desc: Elimina un item de Post. 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-07, Version: v0.2507.01

Example: n/a

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

actionIndex()

Desc: Retorna lista de elementos de Post. 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: per-page, search, category

Ref: Post

Date: 2025-08-07, 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 Post. 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-07, Version: v0.2507.01

Example: n/a

Parameters
$id : int

ID del item

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

actionView()

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

public actionView(int $id) : Post

Notes: n/a.

Ref: Post

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

Example: n/a

Parameters
$id : int
Return values
Post

actionViewPost()

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

public actionViewPost(string $slug) : Post

Notes: Funciona como Post::actionView() pero con Slug como parámetro.

Ref: Post

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

Example: n/a

Parameters
$slug : string
Return values
Post

        
On this page

Search results