TextformatterFileInfo by Robin S

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

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.

Advanced

File attributes

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;
});
Dynamic settings

If needed you can adjust the module settings depending on link attributes by hooking after TextformatterFileInfo::getSettings(). This method receives each eligible link element as a simple_html_dom_node object (documentation) and returns an array of settings. By default the settings are those from the module config, and the return array looks like this:

[
    'add_markup' => $this->add_markup, // 1 or '' (true/false also works)
    'add_data_attributes' => $this->add_data_attributes, // 1 or '' (true/false also works)
    'class_string' => $this->class_string, // string
    'filesize_decimals' => $this->filesize_decimals, // integer
    'date_format' => $this->date_format, // string
    'markup' => $this->markup, // string
    'markup_position' => $this->markup_position, // 'prepend', 'append', 'before' or 'after'
    'skip_image_links' => $this->skip_image_links, // 1 or '' (true/false also works)
]

Example hook to prevent markup being added to links with the "button-link" class:

$wire->addHookAfter('TextformatterFileInfo::getSettings', function(HookEvent $event) {
    $link = $event->arguments(0);
    $settings = $event->return;
    $class_string = $link->getAttribute('class');
    $classes = explode(' ', $class_string);
    if(in_array('button-link', $classes)) {
        $settings['add_markup'] = false;
        $event->return = $settings;
    }
});

Install and use modules at your own risk. Always have a site and database backup before installing new modules.

Twitter updates

  • New main/master version of ProcessWire that has more than 220 commits, resolves more than 80 issues, adds numerous new features, performance improvements and optimizations, and consumes HALF the disk space of our previous release— More
    13 May 2022
  • Summary of weekly core updates for 22 April 2022 More
    22 April 2022
  • ProcessWire 3.0.198 core updates: in this post we take a closer look at 3 useful new features added in this version— More
    15 April 2022

Latest news

  • ProcessWire Weekly #418
    In the 418th issue of ProcessWire Weekly we'll cover recent highlights, share some tips and tricks, and check out the new master version of ProcessWire, 3.0.200. Read on!
    Weekly.pw / 14 May 2022
  • ProcessWire 3.0.200 new master/main version
    This new main/master version has more than 220 commits, resolves more than 80 issues, adds numerous new features, performance improvements and optimizations, and consumes HALF the disk space of our previous release. This post covers all the details.
    Blog / 13 May 2022
  • Subscribe to weekly ProcessWire news

“I am currently managing a ProcessWire site with 2 million+ pages. It’s admirably fast, and much, much faster than any other CMS we tested.” —Nickie, Web developer