Have you seen our new video tutorials? Check it out!

State Field Type

The state field type provides a versatile state/region input.

Introduction

anomaly.field_type.state

The state field type provides a customizable input that ties into the state support in the Streams Platform.

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"          => "text",
        "handler"       => "Anomaly\StateFieldType\Handler\[email protected]"
    ]
]
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 input and dropdown.

handler

App\Example\[email protected]

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

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 [email protected] will be assumed if no method is provided:

"handler" => "[email protected]"

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" => "[email protected]"

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")
            ]
        );
    }
}

Usage

This section will show you how to use the field type via API and in the view layer.

Setting Values

You must set the country field type value with a valid ISO-2 state code from the available options.

$entry->example = "IL";
Note: The value is case insensitive and is uppercased when set.

Basic Output

The state field type returns null or the selected ISO-2 state code.

$entry->example; // IL

Presenter Output

This section will show you how to use the decorated value provided by the \Anomaly\StateFieldType\StateFieldTypePresenter class.

StateFieldTypePresenter::code()

The code method returns the selected state's ISO code.

Returns: string
Example
$decorated->example->code();
Twig
{{ decorated.example.code() }}

StateFieldTypePresenter::name()

The name method returns the name of the selected state.

Returns: string
Example
$decorated->example->name();
Twig
{{ decorated.example.name() }}