Skip to content

Commit ad7bd3d

Browse files
TomJaegerTomJaeger
authored
Merge pull request #951 from swierczek/tab-files-broken-table-formatting
Fix table formatting
2 parents 2e39c76 + a1884de commit ad7bd3d

File tree

1 file changed

+29
-29
lines changed

1 file changed

+29
-29
lines changed

‎docs/development/tab-files.md

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -98,11 +98,11 @@ NOTE: **Note:** if your module includes a tab, do not forget to indicate this in
9898

9999
### `display($channel_id, $entry_id = '')`
100100

101-
| Parameter | Type | Description |
102-
| ------------ | ------- | ----------------------------------------------------- |
103-
| \$channel_id | `int` | Channel ID where the entry is being created or edited |
104-
| \$entry_id | `int` | Entry ID if this is an edit, empty otherwise |
105-
| Returns | `Array` | Settings (see below) |
101+
| Parameter | Type | Description |
102+
| --------- | ---- | ----------- |
103+
| \$channel_id | `int` | Channel ID where the entry is being created or edited |
104+
| \$entry_id | `int` | Entry ID if this is an edit, empty otherwise |
105+
| Returns | `Array` | Settings (see below) |
106106

107107
This function creates the fields that will be displayed on the publish page. It must return `$settings`, an associative array specifying the display settings and values associated with each of your fields.
108108

@@ -128,11 +128,11 @@ The settings array elements:
128128

129129
### `validate($entry, $values)`
130130

131-
| Parameter | Type | Description |
132-
| --------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
133-
| \$entry | <small>`ExpressionEngine\Module\Channel\Model\ChannelEntry`</small> | The channel entry entity |
134-
| \$values | `array` | an associative array with field names as keys and form submission data as the value (i.e. `array('fortune' => 'All your hard work will soon pay off.'))`. The keys are derived from the data returned by `display()`. |
135-
| Returns | <small>`ExpressionEngine\Service\Validation\Result`</small> | A result object |
131+
| Parameter | Type | Description |
132+
| --------- | ---- | ----------- |
133+
| \$entry | <small>`ExpressionEngine\Module\Channel\Model\ChannelEntry`</small> | The channel entry entity |
134+
| \$values | `array` | an associative array with field names as keys and form submission data as the value (i.e. `array('fortune' => 'All your hard work will soon pay off.'))`. The keys are derived from the data returned by `display()`. |
135+
| Returns | <small>`ExpressionEngine\Service\Validation\Result`</small> | A result object |
136136

137137
Allows you to validate the data after the publish form has been submitted but before any additions to the database:
138138

@@ -148,11 +148,11 @@ Allows you to validate the data after the publish form has been submitted but be
148148

149149
### `cloneData($entry, $values)`
150150

151-
| Parameter | Type | Description |
152-
| --------- | ------------------------------------------------------------------- | ------ ----------------------------- |
153-
| \$entry | <small>`ExpressionEngine\Module\Channel\Model\ChannelEntry`</small> | The channel entry entity |
154-
| \$values | `array` | an associative array with field names as keys and form submission data as the value (i.e. `array('fortune' => 'All your hard work will soon pay off.'))`. The keys are derived from the data returned by `display()`. |
155-
| Returns | `array` | $values modified array of values |
151+
| Parameter | Type | Description |
152+
| --------- | ---- | ----------- |
153+
| \$entry | <small>`ExpressionEngine\Module\Channel\Model\ChannelEntry`</small> | The channel entry entity |
154+
| \$values | `array` | an associative array with field names as keys and form submission data as the value (i.e. `array('fortune' => 'All your hard work will soon pay off.'))`. The keys are derived from the data returned by `display()`. |
155+
| Returns | `array` | $values modified array of values |
156156

157157
Code that needs to be executed when an entry is being [cloned](/channels/entry_cloning.md). This function is called before `validate`, so if you need to modify the data that will be passed to validation service (as well as `$_POST` array), this is the place to do it.
158158

@@ -182,11 +182,11 @@ Code that needs to be executed when an entry is being [cloned](/channels/entry_c
182182

183183
### `save($entry, $values)`
184184

185-
| Parameter | Type | Description |
186-
| --------- | ---------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
187-
| \$entry | <small>`ExpressionEngine\Module\Channel\Model\ChannelEntry`</small> | The channel entry entity |
188-
| \$values | `array` | an associative array with field names as keys and form submission data as the value (i.e. `array('fortune' => 'Do not make extra work for yourself.'))`. The keys are derived from the data returned by `display()`. |
189-
| Returns | `Void` | |
185+
| Parameter | Type | Description |
186+
| --------- | ---- | ----------- |
187+
| \$entry | <small>`ExpressionEngine\Module\Channel\Model\ChannelEntry`</small> | The channel entry entity |
188+
| \$values | `array` | an associative array with field names as keys and form submission data as the value (i.e. `array('fortune' => 'Do not make extra work for yourself.'))`. The keys are derived from the data returned by `display()`. |
189+
| Returns | `Void` | |
190190

191191
Called during a `ChannelEntry` entity's `afterSave` event, this allows you to insert data/update data:
192192

@@ -207,23 +207,23 @@ Called during a `ChannelEntry` entity's `afterSave` event, this allows you to in
207207

208208
### `delete($entry_ids)`
209209

210-
| Parameter | Type | Description |
211-
| ----------- | ------- | ----------------------------------------------------- |
210+
| Parameter | Type | Description |
211+
| --------- | ---- | ----------------------------------------------------- |
212212
| \$entry_ids | `array` | Channel ID where the entry is being created or edited |
213-
| Returns | `Void` | |
213+
| Returns | `Void` | |
214214

215215
Called during a `ChannelEntry` entity's `beforeDelete` event, this allows you to sync your records if any are tied to channel entry_ids.
216216

217217
### `renderTableCell($data, $field_id, $entry)`
218218

219219
Display the tab data as column in the Entry Manager
220220

221-
| Parameter | Type | Description |
222-
| --------- | -------- | ----------------------------------------- |
223-
| \$data | `Array` | Ignored by tab files |
224-
| \$field_id| `Int` | Ignored by tab files |
225-
| \$entry | `Array` | Current `ChannelEntry` object |
226-
| Returns | `String` | The string to display in Entry Manager column |
221+
| Parameter | Type | Description |
222+
| --------- | ---- | ----------- |
223+
| \$data | `Array` | Ignored by tab files |
224+
| \$field_id | `Int` | Ignored by tab files |
225+
| \$entry | `Array` | Current `ChannelEntry` object |
226+
| Returns | `String` | The string to display in Entry Manager column |
227227

228228
#### `getTableColumnConfig()`
229229

0 commit comments

Comments
 (0)