Aksara CMS Icon
Main Navigation

\Aksara\Laboratory\Core->addField()

The documentation and cheat sheet of our framework

addField() adds a mock field that is not physically present in the table.

Purpose

addField() adds a mock field that is not physically present in the table. 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 the generated table, form, or read view is mostly correct but one or more fields need custom behavior.

Reference

addField(string|array $name, string $type = 'varchar')

Parameters

ParameterTypeRequiredDefaultDescription
$namestring|arrayYes-Mock field name or an associative array of field => type pairs.
$typestringNo'varchar'Field renderer type or mock field type.

Return Value

static

Returns the current controller instance so it can be chained with other Core methods.

Behavior

addField() updates field metadata used by the renderer. The generated output changes when the table, read, or form view is rendered.

[!NOTE]

Mock fields are useful for display or vertical schema data, but they are not physical columns unless the model or schema provides storage for them.

Basic Usage

$this->addField('display_name', 'varchar');

return $this->render('orders');

Advanced Usage

$this->addField([
    'display_name' => 'varchar',
    'display_summary' => 'textarea'
])
    ->setAlias('display_name', phrase('Display Name'))
    ->setField('display_summary', 'textarea')
    ->fieldOrder('display_name, display_summary, status');

return $this->render('orders');

Complete Example

namespace Modules\Orders\Controllers;

use Aksara\Laboratory\Core;

class Orders extends Core
{
    public function index()
    {
        $this->setTitle(phrase('Orders'))
            ->addField('display_name', 'varchar');

        return $this->render('orders');
    }
}

Result

The generated table, form, or read view uses the configured field behavior when the response is prepared.

Notes

  • This method is chainable and returns the current controller instance.
  • Field names must match table columns, selected aliases, relation aliases, or mock fields.
  • Most field configuration methods accept a single field/value pair or an associative array for bulk configuration.

Common Mistakes

  • Using a field name that is not present in the selected data.
  • Expecting the method to output HTML immediately instead of configuring the renderer.

Related Methods

Improve Documentation
addDropdown
addFilter

Available Methods

addButton addClass addDropdown addField addFilter addSubmitButton addToolbar afterDelete afterInsert afterUpdate allowPublicFormSubmission allowTokenFrom beforeDelete beforeInsert beforeUpdate columnOrder columnSize databaseConfig debug defaultValue deleteBatch deleteData distinct fieldAppend fieldOrder fieldPosition fieldPrepend fieldSize formCallback from fromSubquery getMethod gridView groupBy groupEnd groupField groupStart having havingGroupEnd havingGroupStart havingIn havingLike havingNotIn ignoreQueryString insertData insertId itemReference join like limit mergeContent mergeField modalSize notGroupStart notHavingGroupStart notHavingLike notLike offset orGroupStart orHaving orHavingGroupStart orHavingIn orHavingLike orHavingNotIn orLike orNotGroupStart orNotHavingGroupStart orNotHavingLike orNotLike orWhere orWhereIn orWhereNotIn orderBy parentModule permitUpsert render renderForm renderRead renderTable restrictOnDemo searchable select selectAvg selectCount selectMax selectMin selectSubquery selectSum serialize serializeRow setAiContext setAlias setAttribute setAutocomplete setBreadcrumb setButton setDefault setDescription setField setHeading setIcon setMessages setMethod setOptionLabel setOutput setPermission setPlaceholder setPrimary setRelation setTemplate setTheme setTitle setTooltip setUploadPath setValidation sortable table unsetColumn unsetDelete unsetField unsetMethod unsetRead unsetSelect unsetToolbar unsetTruncate unsetUpdate unsetView updateData validToken validateForm verticalSchema viewOrder where whereIn whereNotIn