Configuration

Below is the full configuration available with defaults values:

"example" => [
    "type"   => "anomaly.field_type.state",
    "config" => [
        "default_value" => null,
        "top_options"   => null,
        "countries"     => null,
        "mode"          => "input",
        "handler"       => "Anomaly\StateFieldType\Handler\DefaultHandler@handle"
    ]
]

Configuration

Key	Example	Description
default_value	IL	The default value.
countries	`["US", "CA", "MX"]`	The countries to display options for.
top_options	`["IL", "IA", "WI"]`	The top `dropdown` options.
mode	dropdown	The input mode. Valid options are `text`, `dropdown`, and `search`.
handler	`App\Example\MyStates@handle`	The options handler.

Addon Configuration

The state options are controlled by the Streams Platform states/* configuration files. State configuration files are named by country code.

You can override these options by publishing the Streams Platform with:

php artisan streams:publish

**Contribute:** If you have states to add or have found an error, submit a pull request to [https://github.com/anomalylabs/streams-platform](https://github.com/anomalylabs/streams-platform)

Option Handlers

Option handlers are responsible for setting the available state options on the field type. You can define your own option handler to add your own logic to available options.

You can define custom handlers as a callable string where `@handle will be assumed if no method is provided:

"handler" => "App/Example/MyStates@handle"

Option handlers can also a handler with a closure:

"example" => [
    "config" => [
        "handler" => function (StateFieldType $fieldType) {
            $fieldType->setOptions(
                [
                    "IL" => config("streams::states/US.available.IL.name"),
                    "IA" => config("streams::states/US.available.IA.name")
                ]
            );
        }
    ]
]

**Remember:** Closures can not be stored in the database so your closure type handlers must be set / overridden from the form builder.

Writing Option Handlers

Writing custom option handlers is easy. To begin create a class with the method you defined in the config option.

"handler" => "App/Example/MyStates@handle"

The handler string is called via Laravel's service container. The StateFieldType $fieldType is passed as an argument.

**Pro Tip:** Handlers are called through Laravel's service container so method and class injection is supported.

<?php namespace App\Example;

class MyStates
{
    public function handle(StateFieldType $fieldType)
    {
        $fieldType->setOptions(
            [
                "IL" => config("streams::states/US.available.IL.name"),
                "IA" => config("streams::states/US.available.IA.name")
            ]
        );
    }
}