Class kartik\ipinfo\IpInfo

The default field keys and labels setting (@see initOptions method)

The api to fetch IP information. Note the token {ip} will be replaced with the source ip address.

Whether to cache ip information in the server cache for the session. If set to true, the Yii2 application cache component will be used for caching. If Yii2 caching component is not set or disabled, the caching will be ignored silently without any exceptions. Using caching, will optimize and reduce server api calls for ip addresses already parsed in the past.

The header title for content shown in the popover. Defaults to IP Position Details

The icon shown before the header title for content in the popover. Defaults to:

 `<i class="glyphicon glyphicon-map-marker"></i>` for bootstrap 3.x
 `<i class="fas fa-map-marker-alt"></i>` for bootstrap 4.x

The HTML attributes for each detail view row

The Detail View widget class used for rendering the ip details information in a tabular form.

The configuration for the yii\widgets\DetailView widget.

See also [[initOptions()]] method for the default configuration.

The markup to be displayed when any exception is faced during processing by the API (e.g. no connectivity). You can set this to a blank string to not display anything. The following tokens will be replaced:

• {errorIcon} - with the icon markup set in $errorIcon
• {message} - any error message returned by api

The HTML attributes for error data container. Defaults to: ['title' => 'IP fetch error']. The

following special tags are recognized:
- `tag`: string, the `tag` in which the content will be rendered. Defaults to `div`.

The error icon shown for any error in the IP fetch by API. Defaults to:

 `<i class="glyphicon glyphicon-exclamation-sign text-danger"></i>` for bootstrap 3.x
 `<i class="fas fa-exclamation-circle text-danger"></i>` for bootstrap 4.x

The list of names of fields/attributes to be shown in display. If this is not set all attributes from $modelClass will be shown (the $hideEmpty setting will control whether to hide attributes that have an empty value)

The HTML attributes for the flag image (rendered via flag-icon-css in kartik-v/yii2-icons).

The HTML attributes for the flag wrapper container.

Whether to flush cache for this IP before fetching. This basically will clear the cached data every time if set to true. It is recommended to use and configure this property as a conditional check cleaning of the cache.

Whether to hide / skip display of fields with empty values

The HTML attributes for container when rendering inline.

The ip address. If not set will default to current user IP address.

The model class used for rendering the ip information

The message to be displayed when no valid data is found. Defaults to:

'No data found for IP address {ip}.'

This can be referred as {noData} token in any of the templates.

The icon shown when no flag is found. Defaults to:

 `<i class="glyphicon glyphicon-question-sign text-warning"></i>` for bootstrap 3.x
 `<i class="fas fa-question-circle text-warning"></i>` for bootstrap 4.x

The HTML attributes for the widget container. The following special tags are recognized:

• tag: string, the tag in which the content will be rendered. Defaults to div.

Any additional query / request parameters to send

The widget configuration settings for kartik\popover\PopoverX widget that will show the details on button click / hover when $showPopover is set to true.

Default HTTP Client request configuration

Whether to show the flag

Whether to show details in a popover on click of flag. If set to false, the results will be rendered inline.

The list of names of fields/ attributes which will be skipped from display. Note that this setting will override the $fields setting.

The template configuration for rendering the popover button, popover content, or inline content. This

should be set as `$key => $value` pairs, where `$key` is one of:
- `popoverButton`: this is the template for popover button label (applied when `showPopover` is `true`)
- `popoverContent`: this is the template for popover content displayed on click of the button (applied when
`showPopover` is `true`)
- `inlineContent`: this is the template for inline content when `showPopover` is set to `false`
The `$value` is the template setting and can contain tags in braces, which will represent value of each IP
position field (set in [[fields]] property) fetched from the freegeoip.net API (for example `{country_code}`,
`{country_name}` etc.).  The following additional special tags will be replaced:
- '{flag}': Will be replaced with the flag icon rendered based on the `showFlag` setting.
- '{table}': Will render all fields configured via `fields` in a tabular format of labels and values.