GravityKit\GravityExport\Filters\Addon\FiltersFeedAddon
Filters add-on.
Since: 1.0
Source: add-ons/filters/src/Addon/FiltersFeedAddon.php:25
Details
- Kind:
class - Namespace:
GravityKit\GravityExport\Filters\Addon - Extends: GFFeedAddOn
- Implements:
AddonInterface,ActionAwareInterface,TemplateAwareInterface
Properties
| Property | Type | Description |
|---|---|---|
$_capabilities_form_settings | string | Feed settings permissions. |
$_path | string | Relative path to file from plugins directory. |
$_full_path | string | Full path to this file. |
Methods
| Method | Description |
|---|---|
__construct() | Creates the add-on instance. |
get_menu_icon() | Return the plugin's icon for the plugin/form settings menu. |
can_duplicate_feed() | |
duplicate_feed() | |
get_bulk_actions() | |
init() | |
feed_settings_fields() | |
settings_button() | |
settings_select() | |
feed_list_columns() | The columns to show on the list view. |
get_column_value_download() | Returns all available download add-ons links for this filter feed. |
save_feed_settings() | |
get_current_settings() | |
modify_current_settings() | Modify current settings that are used to render feed form. |
get_settings_renderer() | |
get_current_feed_id() | Overwritten to retrieve the feed ID when downloading the export. |
styles() | |
scripts() | |
get_current_feed() |
Method Reference
__construct()
public function __construct( FormRepositoryInterface $form_repository, HashGeneratorInterface $generator )
Creates the add-on instance.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$form_repository | FormRepositoryInterface | The form repository. | |
$generator | HashGeneratorInterface | The hash generator. |
Throws
\Exception
Since: 1.0
Source: add-ons/filters/src/Addon/FiltersFeedAddon.php:119
get_menu_icon()
public function get_menu_icon(): string
Return the plugin's icon for the plugin/form settings menu.
Returns
string
Since: 1.0
Source: add-ons/filters/src/Addon/FiltersFeedAddon.php:135
can_duplicate_feed()
public function can_duplicate_feed( $id ): bool
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$id |
Returns
bool
Since: 1.0.6
Source: add-ons/filters/src/Addon/FiltersFeedAddon.php:144
duplicate_feed()
public function duplicate_feed( $id, $new_form_id=false ): int
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$id | |||
$new_form_id | false |
Returns
int
Since: 1.0.6
Source: add-ons/filters/src/Addon/FiltersFeedAddon.php:155
get_bulk_actions()
public function get_bulk_actions(): array
Returns
array
Since: 1.0.6
Source: add-ons/filters/src/Addon/FiltersFeedAddon.php:170
init()
public function init(): void
Returns
void
Since: 1.0
Source: add-ons/filters/src/Addon/FiltersFeedAddon.php:180
feed_settings_fields()
public function feed_settings_fields(): array
Returns
array
Since: 1.0
Source: add-ons/filters/src/Addon/FiltersFeedAddon.php:265
settings_button()
public function settings_button( $field, bool $echo=true ): string
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$field | |||
$echo | bool | true |
Returns
string
Since: 1.0
Source: add-ons/filters/src/Addon/FiltersFeedAddon.php:547
settings_select()
public function settings_select( $field, $echo=true ): string
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$field | |||
$echo | true |
Returns
string
Since: 1.0
Source: add-ons/filters/src/Addon/FiltersFeedAddon.php:579
feed_list_columns()
public function feed_list_columns(): array
The columns to show on the list view.
Returns
array
Since: 1.0
Source: add-ons/filters/src/Addon/FiltersFeedAddon.php:666
get_column_value_download()
public function get_column_value_download( $item ): string
Returns all available download add-ons links for this filter feed.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$item | mixed[] | The feed item. |
Returns
string— The download links.
Since: 1.0
Source: add-ons/filters/src/Addon/FiltersFeedAddon.php:682
save_feed_settings()
public function save_feed_settings( $feed_id, $form_id, $settings )
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$feed_id | |||
$form_id | |||
$settings |
Since: 1.0
Source: add-ons/filters/src/Addon/FiltersFeedAddon.php:714
get_current_settings()
public function get_current_settings()
Since: 1.0
Source: add-ons/filters/src/Addon/FiltersFeedAddon.php:872
modify_current_settings()
public function modify_current_settings( array $settings ): array
Modify current settings that are used to render feed form.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$settings | array | Current settings. |
Returns
array— Modified settings.
Source: add-ons/filters/src/Addon/FiltersFeedAddon.php:885
get_settings_renderer()
public function get_settings_renderer()
Since: 1.0
Source: add-ons/filters/src/Addon/FiltersFeedAddon.php:922
get_current_feed_id()
public function get_current_feed_id(): ?int
Overwritten to retrieve the feed ID when downloading the export.
Returns
?int
Since: 1.0
Source: add-ons/filters/src/Addon/FiltersFeedAddon.php:1002
styles()
public function styles(): array
Returns
array
Since: 1.0
Source: add-ons/filters/src/Addon/FiltersFeedAddon.php:1027
scripts()
public function scripts(): array
Returns
array
Since: 1.0
Source: add-ons/filters/src/Addon/FiltersFeedAddon.php:1039
get_current_feed()
public function get_current_feed()
Since: 1.0
Source: add-ons/filters/src/Addon/FiltersFeedAddon.php:1267