Skip to content

Commit 5e8d1df

Browse files
bryannielsenbryannielsen
authored
Merge pull request #778 from ExpressionEngine/feature/7.x/fluid-field-hooks-update
Fix Fluid Field hooks info
2 parents 497d101 + 8db42e5 commit 5e8d1df

File tree

2 files changed

+72
-25
lines changed

2 files changed

+72
-25
lines changed

‎docs/development/extension-hooks/model/fluid-field.md‎

Lines changed: 67 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -15,66 +15,109 @@ lang: php
1515

1616
[TOC=3]
1717

18-
### `fluid_field_get_all_data($data, $fluid_field_id)`
18+
### `fluid_field_get_all_data($data, $fluid_field_id, $fluid_field)`
1919

20-
| Parameter | Type | Description |
21-
| ---------------- | ------------ | ----------------------------------------------------------------------- |
22-
| \$data | `FluidField` | Current instance of ExpressionEngine\Addons\FluidField\Model\FluidField |
23-
| \$fluid_field_id | `Array` | The MemberField model object data as an array |
24-
| Returns | `FluidField` | Current instance of ExpressionEngine\Addons\FluidField\Model\FluidField |
20+
| Parameter | Type | Description |
21+
| ---------------- | ------------ | ------------------------------------------------------------------------- |
22+
| \$data | `FieldData` | Instance of ExpressionEngine\Model\Content\FieldData for fluid field |
23+
| \$fluid_field_id | `Int` | The ID of Fluid field being fetched |
24+
| \$fluid_field | `FluidField` | Current instance of [FluidField model](development/models/fluid-field.md) |
25+
| Returns | `FieldData` | Current instance of ExpressionEngine\Model\Content\FieldData |
2526

26-
Called before the fluid field field object is returned.
27+
Called after field data has been fetched and before the fluid field field object is returned.
2728

2829
How it's called:
2930

30-
ee()->extensions->call('fluid_field_get_all_data', $data, $fluid_field_id);
31+
ee()->extensions->call('fluid_field_get_all_data', $data, $fluid_field_id, $fluid_field);
3132

32-
TIP: **New in version 6.1.0.**
33+
### `fluid_field_get_field_data($data, $fluid_field_id, $field_data_id, $fluid_field)`
3334

34-
### `fluid_field_add_field($field_table_name, $values)`
35+
| Parameter | Type | Description |
36+
| ---------------- | ------------ | ------------------------------------------------------------------------- |
37+
| \$data | `FieldData` | Instance of ExpressionEngine\Model\Content\FieldData for fluid field |
38+
| \$fluid_field_id | `Int` | The ID of Fluid field being fetched |
39+
| \$field_data_id | `Int` | The ID of row of field data racord |
40+
| \$fluid_field | `FluidField` | Current instance of [FluidField model](development/models/fluid-field.md) |
41+
| Returns | `Array` | Data for the field in Fluid that's currently fetched |
42+
43+
Called before field data is fetched. When hook is present, the field data will not be fetched from the database.
44+
45+
How it's called:
46+
47+
ee()->extensions->call('fluid_field_get_all_data', $data, $fluid_field_id, $field_data_id, $fluid_field);
48+
49+
### `fluid_field_add_field($field_table_name, $values, $fluid_field)`
3550

3651
| Parameter | Type | Description |
3752
| ------------------ | ------------ | ----------------------------- |
3853
| \$field_table_name | `String` | Name of Fluid field table |
3954
| \$values | `Array` | The current field values |
55+
| \$fluid_field | `FluidField` | Current instance of [FluidField model](development/models/fluid-field.md) |
4056
| Returns | `Array` | Adjusted field values |
4157

4258
Called before the fluid field is inserted. Changes made to the object will be saved automatically.
4359

4460
How it's called:
4561

46-
ee()->extensions->call('fluid_field_add_field', $field_table_name, $values);
62+
ee()->extensions->call('fluid_field_add_field', $field_table_name, $values, $fluid_field);
63+
64+
### `fluid_field_after_add_field($fluid_field, $field_table_name, $values, $id)`
65+
66+
| Parameter | Type | Description |
67+
| ------------------ | ------------ | ----------------------------- |
68+
| \$fluid_field | `FluidField` | Current instance of [FluidField model](development/models/fluid-field.md) |
69+
| \$field_table_name | `String` | Name of table being changed |
70+
| \$values | `Array` | The current field values |
71+
| \$id | `Int` | The ID of field that was added |
72+
| Returns | `Void` | Does not return any data |
4773

48-
TIP: **New in version 6.1.0.**
74+
Called after the fluid field is inserted.
75+
76+
How it's called:
77+
78+
ee()->extensions->call('fluid_field_after_add_field', $fluid_field, $field_table_name, $values, $id);
4979

5080
### `fluid_field_update_field($fluid_field, $field_table_name, $values)`
5181

52-
| Parameter | Type | Description |
53-
| ------------------ | ------------ | ----------------------------------------------------------------------- |
54-
| \$fluid_field | `FluidField` | Current instance of ExpressionEngine\Addons\FluidField\Model\FluidField |
55-
| \$field_table_name | `String` | Name of table being changed |
56-
| \$values | `Array` | The current field values |
57-
| Returns | `Array` | Adjusted field values |
82+
| Parameter | Type | Description |
83+
| ------------------ | ------------ | ------------------------------------------------------------------------- |
84+
| \$fluid_field | `FluidField` | Current instance of [FluidField model](development/models/fluid-field.md) |
85+
| \$field_table_name | `String` | Name of table being changed |
86+
| \$values | `Array` | The current field values |
87+
| Returns | `Array` | Adjusted field values |
5888

5989
Called before the fluid field is updated. Changes made to the object will be saved automatically.
6090

6191
How it's called:
6292

6393
ee()->extensions->call('fluid_field_update_field', $field_table_name, $values);
6494

65-
TIP: **New in version 6.1.0.**
95+
### `fluid_field_after_update_field($fluid_field, $field_table_name, $values)`
96+
97+
| Parameter | Type | Description |
98+
| ------------------ | ------------ | ------------------------------------------------------------------------- |
99+
| \$fluid_field | `FluidField` | Current instance of [FluidField model](development/models/fluid-field.md) |
100+
| \$field_table_name | `String` | Name of table being changed |
101+
| \$values | `Array` | The current field values |
102+
| Returns | `Void` | Does not return any data |
103+
104+
Called after the fluid field has been updated.
105+
106+
How it's called:
107+
108+
ee()->extensions->call('fluid_field_add_field', $fluid_field, $field_table_name, $values);
66109

67110
### `fluid_field_remove_field($fluid_field)`
68111

69-
| Parameter | Type | Description |
70-
| ------------------ | ------------ | ----------------------------------------------------------------------- |
71-
| \$fluid_field | `FluidField` | Current instance of ExpressionEngine\Addons\FluidField\Model\FluidField |
72-
| Returns | `null` | |
112+
| Parameter | Type | Description |
113+
| ------------------ | ------------ | ------------------------------------------------------------------------- |
114+
| \$fluid_field | `FluidField` | Current instance of [FluidField model](development/models/fluid-field.md) |
115+
| Returns | `null` | |
73116

74117
Called before the fluid field is deleted. Field will be deleted after hook is called
75118

76119
How it's called:
77120

78121
ee()->extensions->call('fluid_field_remove_field', $fluid_field);
79122

80-
TIP: **New in version 6.1.0.**
123+
TIP: **New in version 6.1.0.**

‎docs/development/models/fluid-field.md‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,21 +15,25 @@ lang: php
1515

1616
**class `ExpressionEngine\Addons\FluidField\Model\FluidField`**
1717

18+
This model is used to manipulate custom field which is being used inside a Fluid Field for certain Channel Entry.
19+
1820
[TOC]
1921

2022
## Properties
2123

2224
- `id` Key
2325
- `fluid_field_id`
2426
- `entry_id`
27+
- `field_group_id`
2528
- `field_id`
2629
- `field_data_id`
2730
- `order`
2831

2932
## Relationships
3033

3134
- `ChannelEntry`
32-
- `ChannelFields`
35+
- `ChannelField`
36+
- `ChannelFieldGroup`
3337
- `FieldField`
3438

3539
## Methods

0 commit comments

Comments
 (0)