\Aksara\Laboratory\Core->renderRead()

The documentation and cheat sheet of our framework

renderRead() formats one row for the read/detail renderer.

Purpose

renderRead() formats one row for the read/detail renderer. It lets a controller customize Aksara Core behavior while keeping the request inside the built-in CRUD, rendering, permission, validation, and response pipeline.

When to Use

Use it when you need to extend the Core CRUD flow while keeping Aksara validation, hooks, formatting, and response handling.

Reference

renderRead(array|object $data)

Parameters

Parameter	Type	Required	Default	Description
`$data`	`array\|object`	Yes	-	Data row, rows, or submitted values.

Return Value

array

Returns an array prepared for the read/detail renderer. Empty data returns an empty but stable read payload.

Behavior

renderRead() runs inside the Core data/rendering pipeline. Depending on the method, it may format data, validate input, execute a CRUD operation, or return an Aksara response.

Basic Usage

$order = $this->model->getWhere('orders', ['order_id' => 10], 1)->row();
$view = $this->renderRead($order);

Advanced Usage

$order = $this->model->getWhere('orders', ['order_id' => 10], 1)->row();
$view = $this->renderRead($order);

return $this->setOutput('preview', $view)->render();

Complete Example

namespace Modules\Orders\Controllers;

use Aksara\Laboratory\Core;

class Orders extends Core
{
    public function preview()
    {
        $order = $this->model->getWhere('orders', ['order_id' => 10], 1)->row();
        $view = $this->renderRead($order);

        return $this->setOutput('preview', $view)->render();
    }
}

Result

The Core pipeline returns the documented value while preserving Aksara validation, hook, permission, audit, and response behavior where applicable.

Notes

These methods are usually called by render() internally, but can be useful for advanced modules.
Keep direct calls close to the surrounding CRUD logic so the response flow is easy to audit.

Common Mistakes

Bypassing Core validation or hooks unintentionally by writing directly to the database.
Returning raw arrays when the caller expects an Aksara response object.