About File Info

Textformatter that adds information about linked files as extra markup, or as data attributes on the link.

Category Text Formatters
Textformatter modules that provide run-time formatting for blocks of text (typically used with Text/Textarea fields).
Release StateBeta
Close to stable, but users are advised to be cautious and test thoroughly.*
Authorrobin-s
Module Version0.1.1
Class NameTextformatterFileInfo
Compatibility3.0
Date AddedApril 12, 2019
Last UpdatedMay 11, 2019
Recommended ByNew recommendations may take up to 1 day to appear.

Instructions

This module's files should be placed in /site/modules/TextformatterFileInfo/
How to install or uninstall modules

README

File Info

A textformatter module for ProcessWire. The module can add information to local Pagefile links in two ways:

  1. As extra markup before, within or after the link
  2. As data attributes on the link (handy if you want to use a Javascript tooltip library, for instance)

Screenshots

Module config

file-info-config

Example of output

file-info-output

Installation

Install the File Info module.

Add the textformatter to one or more CKEditor fields.

Configuration

Add markup action (and general)

  • Select "Add markup to links"
  • Select the Pagefile attributes that will be retrieved. The attribute "filesizeStrCustom" is similar to the core "filesizeStr" attribute but allows for setting a custom number of decimal places.
  • If you select the "modified" or "created" attributes then you can define a date format for the value.
  • Enter a class string to add to the links if needed.
  • Define the markup that will be added to the links. Surround Pagefile attribute names in {brackets}. Attributes must be selected in the "Pagefile attributes" section in order to be available in the added markup. If you want include a space character at the start or end of the markup then you'll need >= PW 3.0.128.
  • Select where the markup should be added: prepended or appended within the link, before the link, or after the link.
  • There is an option to not add markup to links that contain images (because the markup might look out of place there).

Add data attributes action

  • Select "Add data attributes to links"
  • Select the Pagefile attributes that will be retrieved. These attributes will be added to the file links as data attributes. Attributes with camelcase names will be converted to data attribute names that are all lowercase, i.e. filesizeStrCustom becomes data-filesizestrcustom.

Hook

If you want to customise or add to the attributes that are retrieved from the Pagefile you can hook TextformatterFileInfo::getFileAttributes(). For example:

$wire->addHookAfter('TextformatterFileInfo::getFileAttributes', function(HookEvent $event) {
	$pagefile = $event->arguments(0);
	$page = $event->arguments(1);
	$field = $event->arguments(2);
	$attributes = $event->return;
	
	// Add a new attribute
	$attributes['sizeNote'] = $pagefile->filesize > 10000000 ? 'This file is pretty big' : 'This file is not so big';
	$event->return = $attributes;
});

Comments

No comments yet. Be the first to post!

Post a Comment

Your e-mail is kept confidential and not included with your comment. Website is optional.