Skip to content

dev docs on using filemanager with fieldtypes #568

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 2, 2023
Merged

dev docs on using filemanager with fieldtypes #568

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
901eafe
dev docs on using filemanager with fieldtypes
intoeetive Jan 18, 2023
e005458
Update enhanced.md
TomJaeger Feb 3, 2023
1167ab2
Update enhanced.md
matthewjohns0n Feb 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/development/fieldtypes/enhanced.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,6 +239,16 @@ Possible return values are:
- `'text'` - shows text input
- `'select'` - shows select input populated with the field options (for fieldtypes that extend `OptionFieldtype`)

## File Manager support

When a file is referenced inside content, it can be in two different forms depending on if the file manager is running in compatibility mode or not. An example of this is when a file is chosen inside an RTE field via the filepicker. If the file manager is not running in [compatibility mode](control-panel/file-manager/file-manager.md#compatibility-mode), the file references in content will contain a file ID (e.g. `{file:123:url}` where 123 is the file ID). The file can also be referenced in content with a directory ID and file name (e.g. `{filedir_2}filename.jpg`) when in compatibility mode.

To parse both cases correctly, please use the `ee()->file_field->parse_string()` function.

ee()->load->library('file_field');
$data = ee()->file_field->parse_string($data);

If the fieldtype is using custom JavaScript for manipulating the files, be sure to make the code aware of the [`EE.fileManagerCompatibilityMode`](development/control-panel-js/globals.md#filemanagercompatibilitymode) variable.

## Implementing Filepicker for Rich Text Editor

Expand Down