Version 6 pre-stable
This version of Silverstripe CMS has not yet been given a stable release. See the release roadmap for more information. Go to documentation for the most recent stable version.

Read-only and disabled forms

Form and FormField instances can be turned into a read-only version for things like confirmation pages or when certain fields cannot be edited due to permissions. Creating the form is done the same way and markup is similar, readonly mode converts the input, select and textarea tags to static HTML elements like span.

To make an entire Form read-only:

use SilverStripe\Forms\Form;

$form = Form::create(/* ... */);
$form->makeReadonly();

To make all the fields within a FieldList read-only (i.e.to make fields read-only but not buttons):

use SilverStripe\Forms\FieldList;

$fields = FieldList::create(/* ... */);
$fields = $fields->makeReadonly();

To make an individual FormField read-only you need to know the name of the form field or call it directly on the object:

use SilverStripe\Forms\FieldList;
use SilverStripe\Forms\TextField;

$field = TextField::create(/* ... */);
$field = $field->performReadonlyTransformation();

$fields = FieldList::create(
    $field
);

// Or,
$field = TextField::create(/* ... */);
$field->setReadonly(true);

$fields = FieldList::create(
    $field
);

// Or,
$fields->dataFieldByName('myField')->setReadonly(true);

Disabled formFields

Disabling FormField instances, sets the disabled property on the class. This will use the same HTML markup as a normal form, but set the disabled attribute on the input tag.

$field = TextField::create(/* ... */);
$field->setDisabled(true);

// prints '<input type="text" class="text" .. disabled="disabled" />'
echo $field->forTemplate();