Skip to content

Commit 48e512c

Browse files
bryannielsenbryannielsen
authored
Merge pull request #892 from ExpressionEngine/revert-778-feature/7.x/fluid-field-hooks-update
Revert "Fix Fluid Field hooks info"
2 parents 5e8d1df + b874737 commit 48e512c

File tree

2 files changed

+25
-72
lines changed

2 files changed

+25
-72
lines changed

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

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

1616
[TOC=3]
1717

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

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 |
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 |
2625

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

2928
How it's called:
3029

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

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

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)`
34+
### `fluid_field_add_field($field_table_name, $values)`
5035

5136
| Parameter | Type | Description |
5237
| ------------------ | ------------ | ----------------------------- |
5338
| \$field_table_name | `String` | Name of Fluid field table |
5439
| \$values | `Array` | The current field values |
55-
| \$fluid_field | `FluidField` | Current instance of [FluidField model](development/models/fluid-field.md) |
5640
| Returns | `Array` | Adjusted field values |
5741

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

6044
How it's called:
6145

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 |
46+
ee()->extensions->call('fluid_field_add_field', $field_table_name, $values);
7347

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);
48+
TIP: **New in version 6.1.0.**
7949

8050
### `fluid_field_update_field($fluid_field, $field_table_name, $values)`
8151

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 |
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 |
8858

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

9161
How it's called:
9262

9363
ee()->extensions->call('fluid_field_update_field', $field_table_name, $values);
9464

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);
65+
TIP: **New in version 6.1.0.**
10966

11067
### `fluid_field_remove_field($fluid_field)`
11168

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

11774
Called before the fluid field is deleted. Field will be deleted after hook is called
11875

11976
How it's called:
12077

12178
ee()->extensions->call('fluid_field_remove_field', $fluid_field);
12279

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

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

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,25 +15,21 @@ 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-
2018
[TOC]
2119

2220
## Properties
2321

2422
- `id` Key
2523
- `fluid_field_id`
2624
- `entry_id`
27-
- `field_group_id`
2825
- `field_id`
2926
- `field_data_id`
3027
- `order`
3128

3229
## Relationships
3330

3431
- `ChannelEntry`
35-
- `ChannelField`
36-
- `ChannelFieldGroup`
32+
- `ChannelFields`
3733
- `FieldField`
3834

3935
## Methods

0 commit comments

Comments
 (0)