Documentation

TextCrudController extends BaseController
in package

Lwt

Modules

Text

Http

Controller for text CRUD operations and list management.

Handles:

New text form and save
Edit text form and save
Delete/archive/unarchive single texts
Text list with bulk actions

Constants

MODULE_VIEWS = __DIR__ . '/../Views'

Properties

$languageService : LanguageFacade
$textService : TextFacade

Methods

__construct() : mixed: Initialize controller.
archive() : RedirectResponse: Archive a text.
delete() : RedirectResponse: Delete a text.
edit() : RedirectResponse|null: Edit texts list.
editSingle() : RedirectResponse|null: Edit single text form.
handleMarkAction() : string|RedirectResponse: Handle mark actions for multiple texts.
handleTextOperation() : array{message: string, redirect: bool}|RedirectResponse: Handle text save/update operations.
new() : RedirectResponse|null: Show new text form.
showEditTextForm() : void: Show the edit text form.
showNewTextForm() : void: Show the new text form.
showTextsList() : void: Show the texts list.
unarchive() : RedirectResponse: Unarchive a text.
endRender() : void: End page rendering with standard LWT footer.
execute() : int: Execute an INSERT/UPDATE/DELETE query.
get() : string: Get a string GET parameter.
getMarkedIds() : array<string|int, int>: Get IDs from marked checkboxes.
getValue() : mixed: Get a single value from the database.
hasParam() : bool: Check if a parameter exists in the request.
isGet() : bool: Check if the request is a GET request.
isPost() : bool: Check if the request is a POST request.
json() : JsonResponse: Return JSON response.
message() : void: Display a message (success/error) to the user using Bulma notifications.
param() : string: Get a string request parameter (GET, POST, or REQUEST).
paramArray() : array<string|int, mixed>: Get an array request parameter.
paramInt() : int|null: Get an integer request parameter.
post() : string: Get a string POST parameter.
query() : mysqli_result|bool: Execute a database query using the LWT query wrapper.
redirect() : RedirectResponse: Redirect to another URL.
render() : void: Start page rendering with standard LWT header.
requireInt() : int: Get a required integer request parameter.
handleAutoSplitImport() : array{message: string, redirect: bool}|RedirectResponse: Handle auto-split import for long texts.

MODULE_VIEWS


    private
        mixed
    MODULE_VIEWS
    = __DIR__ . '/../Views'

$languageService


        private
            LanguageFacade
    $languageService

$textService


        private
            TextFacade
    $textService

__construct()

Initialize controller.


    public
                    __construct([TextFacade|null $textService = null ][, LanguageFacade|null $languageService = null ]) : mixed

Parameters

$textService : TextFacade|null = null
$languageService : LanguageFacade|null = null

archive()

Archive a text.


    public
                    archive(int $id) : RedirectResponse

Parameters

$id : int: Text ID from route parameter

Return values

RedirectResponse —

Redirect to texts list

delete()

Delete a text.


    public
                    delete(int $id) : RedirectResponse

Parameters

$id : int: Text ID from route parameter

Return values

RedirectResponse —

Redirect to texts list

edit()

Edit texts list.


    public
                    edit(array<string|int, mixed> $params) : RedirectResponse|null

Parameters

$params : array<string|int, mixed>: Route parameters

Return values

RedirectResponse|null —

Redirect response or null if rendered

editSingle()

Edit single text form.


    public
                    editSingle(int $id) : RedirectResponse|null

Parameters

$id : int: Text ID from route parameter

Return values

RedirectResponse|null —

Redirect response or null if rendered

handleMarkAction()

Handle mark actions for multiple texts.


    public
                    handleMarkAction(string $markAction, array<string|int, mixed> $marked, string $actionData) : string|RedirectResponse

Parameters

$markAction : string: Action to perform
$marked : array<string|int, mixed>: Array of marked text IDs
$actionData : string: Additional data for the action

Return values

string|RedirectResponse —

Result message or redirect

handleTextOperation()

Handle text save/update operations.


    public
                    handleTextOperation(string $op, bool $noPagestart, string|int $currentLang) : array{message: string, redirect: bool}|RedirectResponse

Parameters

$op : string: Operation name
$noPagestart : bool: Whether to skip page start
$currentLang : string|int: Current language ID

Return values

array{message: string, redirect: bool}|RedirectResponse

new()

Show new text form.


    public
                    new(array<string|int, mixed> $params) : RedirectResponse|null

Parameters

$params : array<string|int, mixed>: Route parameters

Return values

RedirectResponse|null —

Redirect response or null if rendered

showEditTextForm()

Show the edit text form.


    public
                    showEditTextForm(int $txid) : void

Parameters

$txid : int: Text ID

showNewTextForm()

Show the new text form.


    public
                    showNewTextForm(int $langId) : void

Parameters

$langId : int: Language ID

showTextsList()

Show the texts list.


    public
                    showTextsList(string|int $currentLang, string $message) : void

Parameters

$currentLang : string|int: Current language filter
$message : string: Message to display

unarchive()

Unarchive a text.


    public
                    unarchive(int $id) : RedirectResponse

Parameters

$id : int: Text ID from route parameter

Return values

RedirectResponse —

Redirect to archived texts list

endRender()

End page rendering with standard LWT footer.


    protected
                    endRender() : void

execute()

Execute an INSERT/UPDATE/DELETE query.


    protected
                    execute(string $sql) : int

Parameters

$sql : string: SQL query

Return values

int —

Number of affected rows

get()

Get a string GET parameter.


    protected
                    get(string $key[, string $default = '' ]) : string

Parameters

$key : string: Parameter name
$default : string = '': Default value if not set

Return values

string —

Parameter value or default

getMarkedIds()

Get IDs from marked checkboxes.


    protected
                    getMarkedIds(string|array<string|int, mixed> $marked) : array<string|int, int>

Parameters

$marked : string|array<string|int, mixed>: The 'marked' request parameter value

Return values

array<string|int, int> —

Array of integer IDs

getValue()

Get a single value from the database.


    protected
                    getValue(string $sql) : mixed

Parameters

$sql : string: SQL query (should return single value as 'value')

Return values

mixed —

The value or null

hasParam()

Check if a parameter exists in the request.


    protected
                    hasParam(string $key) : bool

Parameters

$key : string: Parameter name

Return values

bool —

True if the parameter exists

isGet()

Check if the request is a GET request.


    protected
                    isGet() : bool

Return values

bool

isPost()

Check if the request is a POST request.


    protected
                    isPost() : bool

Return values

bool

json()

Return JSON response.


    protected
                    json(mixed $data[, int $status = 200 ]) : JsonResponse

Return this from a controller method; the router will send it.

Parameters

$data : mixed: Data to encode as JSON
$status : int = 200: HTTP status code (default: 200)

Return values

JsonResponse

message()

Display a message (success/error) to the user using Bulma notifications.


    protected
                    message(string $message[, bool $autoHide = true ]) : void

Parameters

$message : string: The message to display
$autoHide : bool = true: Whether to auto-hide the message (default: true)

param()

Get a string request parameter (GET, POST, or REQUEST).


    protected
                    param(string $key[, string $default = '' ]) : string

Parameters

$key : string: Parameter name
$default : string = '': Default value if not set

Return values

string —

Parameter value or default

paramArray()

Get an array request parameter.


    protected
                    paramArray(string $key[, array<string|int, mixed> $default = [] ]) : array<string|int, mixed>

Parameters

$key : string: Parameter name
$default : array<string|int, mixed> = []: Default value if not set

Return values

array<string|int, mixed> —

Parameter value or default

paramInt()

Get an integer request parameter.


    protected
                    paramInt(string $key[, int|null $default = null ][, int|null $min = null ][, int|null $max = null ]) : int|null

Parameters

$key : string: Parameter name
$default : int|null = null: Default value if not set
$min : int|null = null: Minimum allowed value
$max : int|null = null: Maximum allowed value

Return values

int|null —

Parameter value or default

post()

Get a string POST parameter.


    protected
                    post(string $key[, string $default = '' ]) : string

Parameters

$key : string: Parameter name
$default : string = '': Default value if not set

Return values

string —

Parameter value or default

query()

Execute a database query using the LWT query wrapper.


    protected
                    query(string $sql) : mysqli_result|bool

Parameters

$sql : string: SQL query

Return values

mysqli_result|bool —

Query result

redirect()

Redirect to another URL.


    protected
                    redirect(string $url[, int $statusCode = 302 ]) : RedirectResponse

Return this from a controller method; the router will send it.

Parameters

$url : string: URL to redirect to
$statusCode : int = 302: HTTP status code (default: 302)

Return values

RedirectResponse

render()

Start page rendering with standard LWT header.


    protected
                    render(string $title[, bool $showMenu = true ]) : void

Parameters

$title : string: Page title
$showMenu : bool = true: Whether to show navigation menu (default: true)

requireInt()

Get a required integer request parameter.


    protected
                    requireInt(string $key[, int|null $min = null ][, int|null $max = null ]) : int

Parameters

$key : string: Parameter name
$min : int|null = null: Minimum allowed value
$max : int|null = null: Maximum allowed value

Return values

int —

Parameter value

handleAutoSplitImport()

Handle auto-split import for long texts.


    private
                    handleAutoSplitImport(int $languageId, string $title, string $text, string $audioUri, string $sourceUri, bool $openAfter) : array{message: string, redirect: bool}|RedirectResponse

Parameters

$languageId : int: Language ID
$title : string: Text title
$text : string: Text content
$audioUri : string: Audio URI
$sourceUri : string: Source URI
$openAfter : bool: Whether to open the first chapter after import

Return values

array{message: string, redirect: bool}|RedirectResponse

TextCrudController extends BaseController in package Lwt Modules Text Http

Tags

Table of Contents

Constants

Properties

Methods

Constants

MODULE_VIEWS

Properties

$languageService

$textService

Methods

__construct()

Parameters

archive()

Parameters

Return values

delete()

Parameters

Return values

edit()

Parameters

Tags

Return values

editSingle()

Parameters

Tags

Return values

handleMarkAction()

Parameters

Return values

handleTextOperation()

Parameters

Return values

new()

Parameters

Tags

Return values

showEditTextForm()

Parameters

Tags

showNewTextForm()

Parameters

Tags

showTextsList()

Parameters

Tags

unarchive()

Parameters

Return values

endRender()

execute()

Parameters

Tags

Return values

get()

Parameters

Return values

getMarkedIds()

Parameters

Tags

Return values

getValue()

Parameters

Return values

hasParam()

Parameters

Return values

isGet()

Return values

isPost()

Return values

json()

Parameters

Return values

message()

Parameters

param()

Parameters

Return values

TextCrudController extends BaseController
in package

Lwt

Modules

Text

Http