Autocomplete Inspector Type

Autocomplete Inspector Type

Inspector Type

The autocomplete inspector type works like the string editor, except it includes auto competion features. Available options can be specified statically with the options parameter or loaded dynamically.

public function defineProperties()
{
    return [
        'condition' => [
            'title' => 'Condition',
            'type' => 'autocomplete',
            'options' => ['start' => 'Start', 'end' => 'End']
        ]
    ];
}

The generated output is an array value corresponding to the selected options, for example:

"condition": "start"

The following configuration values are commonly used.

Property Description
title title for the property.
description a brief description of the property, optional.
default specifies a default string value, optional.
options array of options for dropdown properties, optional if defining a get*PropertyName*Options method.
showExternalParam unsupported, and should be set to false.

This type does not support the external parameter editor as specified by the showExternalParam property.

# Dynamic Options

The autocomplete inspector type support the same methods for defining the options as the dropdown inspector type.

public function defineProperties()
{
    return [
        'sortColumn' => [
            'title' => 'Sort by Column',
            'type' => 'autocomplete',
            // ...
        ],
    ];
}

public function getSortColumnOptions()
{
    return [
        'create' => 'Create',
        'update' => 'Update',
        'delete' => 'Delete',
    ];
}

# See Also

On This Page