From b874737b25e5c4d16b06d70947b46c970911950a Mon Sep 17 00:00:00 2001 From: Bryan Nielsen Date: Wed, 9 Oct 2024 14:00:31 -0400 Subject: [PATCH] Revert "Fix Fluid Field hooks info" --- .../extension-hooks/model/fluid-field.md | 91 +++++-------------- docs/development/models/fluid-field.md | 6 +- 2 files changed, 25 insertions(+), 72 deletions(-) diff --git a/docs/development/extension-hooks/model/fluid-field.md b/docs/development/extension-hooks/model/fluid-field.md index 4f65b0b5f..315274ff7 100644 --- a/docs/development/extension-hooks/model/fluid-field.md +++ b/docs/development/extension-hooks/model/fluid-field.md @@ -15,76 +15,46 @@ lang: php [TOC=3] -### `fluid_field_get_all_data($data, $fluid_field_id, $fluid_field)` +### `fluid_field_get_all_data($data, $fluid_field_id)` -| Parameter | Type | Description | -| ---------------- | ------------ | ------------------------------------------------------------------------- | -| \$data | `FieldData` | Instance of ExpressionEngine\Model\Content\FieldData for fluid field | -| \$fluid_field_id | `Int` | The ID of Fluid field being fetched | -| \$fluid_field | `FluidField` | Current instance of [FluidField model](development/models/fluid-field.md) | -| Returns | `FieldData` | Current instance of ExpressionEngine\Model\Content\FieldData | +| Parameter | Type | Description | +| ---------------- | ------------ | ----------------------------------------------------------------------- | +| \$data | `FluidField` | Current instance of ExpressionEngine\Addons\FluidField\Model\FluidField | +| \$fluid_field_id | `Array` | The MemberField model object data as an array | +| Returns | `FluidField` | Current instance of ExpressionEngine\Addons\FluidField\Model\FluidField | -Called after field data has been fetched and before the fluid field field object is returned. +Called before the fluid field field object is returned. How it's called: - ee()->extensions->call('fluid_field_get_all_data', $data, $fluid_field_id, $fluid_field); + ee()->extensions->call('fluid_field_get_all_data', $data, $fluid_field_id); -### `fluid_field_get_field_data($data, $fluid_field_id, $field_data_id, $fluid_field)` +TIP: **New in version 6.1.0.** -| Parameter | Type | Description | -| ---------------- | ------------ | ------------------------------------------------------------------------- | -| \$data | `FieldData` | Instance of ExpressionEngine\Model\Content\FieldData for fluid field | -| \$fluid_field_id | `Int` | The ID of Fluid field being fetched | -| \$field_data_id | `Int` | The ID of row of field data racord | -| \$fluid_field | `FluidField` | Current instance of [FluidField model](development/models/fluid-field.md) | -| Returns | `Array` | Data for the field in Fluid that's currently fetched | - -Called before field data is fetched. When hook is present, the field data will not be fetched from the database. - -How it's called: - - ee()->extensions->call('fluid_field_get_all_data', $data, $fluid_field_id, $field_data_id, $fluid_field); - -### `fluid_field_add_field($field_table_name, $values, $fluid_field)` +### `fluid_field_add_field($field_table_name, $values)` | Parameter | Type | Description | | ------------------ | ------------ | ----------------------------- | | \$field_table_name | `String` | Name of Fluid field table | | \$values | `Array` | The current field values | -| \$fluid_field | `FluidField` | Current instance of [FluidField model](development/models/fluid-field.md) | | Returns | `Array` | Adjusted field values | Called before the fluid field is inserted. Changes made to the object will be saved automatically. How it's called: - ee()->extensions->call('fluid_field_add_field', $field_table_name, $values, $fluid_field); - -### `fluid_field_after_add_field($fluid_field, $field_table_name, $values, $id)` - -| Parameter | Type | Description | -| ------------------ | ------------ | ----------------------------- | -| \$fluid_field | `FluidField` | Current instance of [FluidField model](development/models/fluid-field.md) | -| \$field_table_name | `String` | Name of table being changed | -| \$values | `Array` | The current field values | -| \$id | `Int` | The ID of field that was added | -| Returns | `Void` | Does not return any data | + ee()->extensions->call('fluid_field_add_field', $field_table_name, $values); -Called after the fluid field is inserted. - -How it's called: - - ee()->extensions->call('fluid_field_after_add_field', $fluid_field, $field_table_name, $values, $id); +TIP: **New in version 6.1.0.** ### `fluid_field_update_field($fluid_field, $field_table_name, $values)` -| Parameter | Type | Description | -| ------------------ | ------------ | ------------------------------------------------------------------------- | -| \$fluid_field | `FluidField` | Current instance of [FluidField model](development/models/fluid-field.md) | -| \$field_table_name | `String` | Name of table being changed | -| \$values | `Array` | The current field values | -| Returns | `Array` | Adjusted field values | +| Parameter | Type | Description | +| ------------------ | ------------ | ----------------------------------------------------------------------- | +| \$fluid_field | `FluidField` | Current instance of ExpressionEngine\Addons\FluidField\Model\FluidField | +| \$field_table_name | `String` | Name of table being changed | +| \$values | `Array` | The current field values | +| Returns | `Array` | Adjusted field values | Called before the fluid field is updated. Changes made to the object will be saved automatically. @@ -92,27 +62,14 @@ How it's called: ee()->extensions->call('fluid_field_update_field', $field_table_name, $values); -### `fluid_field_after_update_field($fluid_field, $field_table_name, $values)` - -| Parameter | Type | Description | -| ------------------ | ------------ | ------------------------------------------------------------------------- | -| \$fluid_field | `FluidField` | Current instance of [FluidField model](development/models/fluid-field.md) | -| \$field_table_name | `String` | Name of table being changed | -| \$values | `Array` | The current field values | -| Returns | `Void` | Does not return any data | - -Called after the fluid field has been updated. - -How it's called: - - ee()->extensions->call('fluid_field_add_field', $fluid_field, $field_table_name, $values); +TIP: **New in version 6.1.0.** ### `fluid_field_remove_field($fluid_field)` -| Parameter | Type | Description | -| ------------------ | ------------ | ------------------------------------------------------------------------- | -| \$fluid_field | `FluidField` | Current instance of [FluidField model](development/models/fluid-field.md) | -| Returns | `null` | | +| Parameter | Type | Description | +| ------------------ | ------------ | ----------------------------------------------------------------------- | +| \$fluid_field | `FluidField` | Current instance of ExpressionEngine\Addons\FluidField\Model\FluidField | +| Returns | `null` | | Called before the fluid field is deleted. Field will be deleted after hook is called @@ -120,4 +77,4 @@ How it's called: ee()->extensions->call('fluid_field_remove_field', $fluid_field); -TIP: **New in version 6.1.0.** \ No newline at end of file +TIP: **New in version 6.1.0.** diff --git a/docs/development/models/fluid-field.md b/docs/development/models/fluid-field.md index 81f91e35a..0430bb459 100644 --- a/docs/development/models/fluid-field.md +++ b/docs/development/models/fluid-field.md @@ -15,8 +15,6 @@ lang: php **class `ExpressionEngine\Addons\FluidField\Model\FluidField`** -This model is used to manipulate custom field which is being used inside a Fluid Field for certain Channel Entry. - [TOC] ## Properties @@ -24,7 +22,6 @@ This model is used to manipulate custom field which is being used inside a Fluid - `id` Key - `fluid_field_id` - `entry_id` -- `field_group_id` - `field_id` - `field_data_id` - `order` @@ -32,8 +29,7 @@ This model is used to manipulate custom field which is being used inside a Fluid ## Relationships - `ChannelEntry` -- `ChannelField` -- `ChannelFieldGroup` +- `ChannelFields` - `FieldField` ## Methods