From 71d482c0482a6b9cb8d6d454bb393996274e7d21 Mon Sep 17 00:00:00 2001 From: Yuri Salimovskiy Date: Tue, 5 Dec 2023 16:00:03 +0200 Subject: [PATCH 1/2] Fix Fluid Field hooks info coloses https://github.com/ExpressionEngine/ExpressionEngine/issues/1643 --- .../extension-hooks/model/fluid-field.md | 23 +++++++------------ docs/development/models/fluid-field.md | 6 ++++- 2 files changed, 13 insertions(+), 16 deletions(-) diff --git a/docs/development/extension-hooks/model/fluid-field.md b/docs/development/extension-hooks/model/fluid-field.md index a477b612c..dd98b1f60 100644 --- a/docs/development/extension-hooks/model/fluid-field.md +++ b/docs/development/extension-hooks/model/fluid-field.md @@ -19,9 +19,9 @@ lang: php | 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 | +| \$data | `FieldData` | Instance of ExpressionEngine\Model\Content\FieldData for fluid field | +| \$fluid_field_id | `Int` | The ID of Fluid field being fetched | +| Returns | `FieldData` | Current instance of ExpressionEngine\Model\Content\FieldData | Called before the fluid field field object is returned. @@ -29,29 +29,26 @@ How it's called: ee()->extensions->call('fluid_field_get_all_data', $data, $fluid_field_id); -TIP: **New in version 6.1.0.** - -### `fluid_field_add_field($field_table_name, $values)` +### `fluid_field_add_field($field_table_name, $values, $fluid_field)` | 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); - -TIP: **New in version 6.1.0.** + ee()->extensions->call('fluid_field_add_field', $field_table_name, $values, $fluid_field); ### `fluid_field_update_field($fluid_field, $field_table_name, $values)` | Parameter | Type | Description | | ------------------ | ------------ | ----------------------------------------------------------------------- | -| \$fluid_field | `FluidField` | Current instance of ExpressionEngine\Addons\FluidField\Model\FluidField | +| \$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 | @@ -62,13 +59,11 @@ How it's called: ee()->extensions->call('fluid_field_add_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 ExpressionEngine\Addons\FluidField\Model\FluidField | +| \$fluid_field | `FluidField` | Current instance of [FluidField model](development/models/fluid-field.md) | | Returns | `null` | | Called before the fluid field is deleted. Field will be deleted after hook is called @@ -76,5 +71,3 @@ Called before the fluid field is deleted. Field will be deleted after hook is ca 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 diff --git a/docs/development/models/fluid-field.md b/docs/development/models/fluid-field.md index 0430bb459..81f91e35a 100644 --- a/docs/development/models/fluid-field.md +++ b/docs/development/models/fluid-field.md @@ -15,6 +15,8 @@ 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 @@ -22,6 +24,7 @@ lang: php - `id` Key - `fluid_field_id` - `entry_id` +- `field_group_id` - `field_id` - `field_data_id` - `order` @@ -29,7 +32,8 @@ lang: php ## Relationships - `ChannelEntry` -- `ChannelFields` +- `ChannelField` +- `ChannelFieldGroup` - `FieldField` ## Methods From 69c8bf5625a420e96765960adbfefb8901f566e5 Mon Sep 17 00:00:00 2001 From: Yuri Salimovskiy Date: Tue, 12 Dec 2023 11:58:38 +0200 Subject: [PATCH 2/2] further modifications suggested by @litzinger --- .../extension-hooks/model/fluid-field.md | 80 +++++++++++++++---- 1 file changed, 64 insertions(+), 16 deletions(-) diff --git a/docs/development/extension-hooks/model/fluid-field.md b/docs/development/extension-hooks/model/fluid-field.md index dd98b1f60..00fd6c7c5 100644 --- a/docs/development/extension-hooks/model/fluid-field.md +++ b/docs/development/extension-hooks/model/fluid-field.md @@ -15,19 +15,36 @@ lang: php [TOC=3] -### `fluid_field_get_all_data($data, $fluid_field_id)` +### `fluid_field_get_all_data($data, $fluid_field_id, $fluid_field)` -| 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 | -| Returns | `FieldData` | Current instance of ExpressionEngine\Model\Content\FieldData | +| 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 | -Called before the fluid field field object is returned. +Called after field data has been fetched and before the fluid field field object is returned. How it's called: - ee()->extensions->call('fluid_field_get_all_data', $data, $fluid_field_id); + ee()->extensions->call('fluid_field_get_all_data', $data, $fluid_field_id, $fluid_field); + +### `fluid_field_get_field_data($data, $fluid_field_id, $field_data_id, $fluid_field)` + +| 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)` @@ -44,14 +61,30 @@ 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 | + +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); + ### `fluid_field_update_field($fluid_field, $field_table_name, $values)` -| Parameter | Type | Description | -| ------------------ | ------------ | ----------------------------------------------------------------------- | +| 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 | +| \$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. @@ -59,12 +92,27 @@ How it's called: ee()->extensions->call('fluid_field_add_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); + ### `fluid_field_remove_field($fluid_field)` -| Parameter | Type | Description | -| ------------------ | ------------ | ----------------------------------------------------------------------- | +| Parameter | Type | Description | +| ------------------ | ------------ | ------------------------------------------------------------------------- | | \$fluid_field | `FluidField` | Current instance of [FluidField model](development/models/fluid-field.md) | -| Returns | `null` | | +| Returns | `null` | | Called before the fluid field is deleted. Field will be deleted after hook is called