Jump to content
Martijn Geerts

Markup RSS Enhanced

Recommended Posts

This Module didn't have it's real own thread, now it has :-)


Markup RSS Enhanced

This Module is the enhanced version of Ryan's Markup RSS Module and is completely compatible with it. In addition, this enhanced module supports the usage of enclosures a way of attaching multimedia content to RSS feeds. Give the RSS enhanced module a PageArray of pages and it will render a RSS feed from it. The Module should be used directly from your template file.

In the examples the $rss variable is used for as instance of the module.

$rss = $modules->get("MarkupRSSEnhanced");

Basic usage

In case you only need 1 feed for your site, you need to setup the defaults in the Modules config. then you can use the code below.

$items = $pages->find("limit=10, sort=-modified");  // $items, PageArray of Pages
$rss = $modules->get("MarkupRSSEnhanced");          // load the module
$rss->render($items);                               // render the feed 

Setup channel elements

The channel element describes the RSS feed. There are 3 required channel elements:

  1. title $rss->title
  2. link $rss->url
  3. description $rss->description
$rss->title = '';       // (string) Title of the feed.
$rss->url = '';         // (string) URL of the website this feed lives. Example: http://www.your-domain.com/
$rss->description = ''; // (string) Phrase or sentence describing the channel.
$rss->copyright = '';   // (string) Copyright notice for content in the channel.
$rss->ttl = '';         // (string/integer) Number of minutes that how long it can be cached.

Setup item elements

Every page from the PageArray use the item element.

$rss->itemTitleField = '';             // Fieldname to get value from
$rss->itemDescriptionField = '';       // Fieldname to get value from
$rss->itemDescriptionLength = '';      // Default 1024
$rss->itemEnclosureField = '';         // Fieldname to get file/image from
$rss->itemDateField = '';              // Fieldname to get data from
$rss->itemLinkField = '';              // Fieldname to get URL from or don't set to use $page->httpUrl
$rss->itemAuthorField = '';            // If email address is used, itemAuthorElement should be set to author
$rss->itemAuthorElement = 'dc:creator' // may be 'dc:creator' or 'author'

Item element enclosure

RSS enclosures are a way of attaching multimedia content to RSS feeds. All files with proper mime types are supported. If you asign an image field to the itemEnclosureField there are 3 extra options you could set.

  1. width The width of the image.
  2. height The height of the image.
  3. boundingbox Checking boundingbox will scale the image so that the whole image will fit in the specified width & height. This prevents cropping the image
$rss->boundingbox = 1 // (integer) 1 or 0, on or off
$rss->width = 400;    // (integer) Max width of the image, 0 for proportional
$rss->height = 300;   // (integer) Max height of the image, 0 for proportional 

Prettify the feed

Prettifying the feed is not supported by all clients.

$rss->xsl = ''; // path to xls file
$rss->css = ''; // path to css

Download on GitHub

View on the modules directory

  • Like 9

Share this post


Link to post
Share on other sites

Hi, I'm trying using this module with latest PW release but I got this error:

Error: Call to undefined function finfo_open() (line 253 of /home/ilpepe/public_html/site/modules/MarkupRSSEnhanced.module)

Share this post


Link to post
Share on other sites

What kind of environment you're running this?

Edited by Martijn Geerts
(looked at the same link as Adrian... tnx Adrian)

Share this post


Link to post
Share on other sites

so it's question of php...ok I'll try to install this fileinfo.so extension, thanks

  • Like 1

Share this post


Link to post
Share on other sites

@Martijn: maybe a check on install of the module or in the config-screen?

if( !extension_loaded('fileinfo') && !@dl('fileinfo') ) {
    // missing PHP extension
    ...
}
  • Like 3

Share this post


Link to post
Share on other sites

@Sevarf2, would you mind to try the following ?

Add a new method somewhere in the module:

    /**
     * Return Mimetype
     *
     */
    protected function mimetype($filename) {

        if (function_exists('finfo_open')) {
            $info = finfo_open(FILEINFO_MIME_TYPE);
            $mime = finfo_file($info, $filename);
            finfo_close($info);
        } else if (function_exists('mime_content_type')) {
            $mime = mime_content_type($filename);
        } else {
            $mime = 'application/octet-stream';
        }

        return $mime;
    }
And then change the code for the mime type:
/* Disable this: */
// $info = finfo_open(FILEINFO_MIME_TYPE);
// $mime = finfo_file($info, $field->filename);
// finfo_close($info);

/* add this: */
$mime = $this->mimetype($field->filename);

  • Like 2

Share this post


Link to post
Share on other sites
The Module should be used directly from your template file.

What template file? I have rss.php in my templates directory. How is the feed accessed? I need to make a blank RSS template in PW?

Never mind that worked

Share this post


Link to post
Share on other sites

Is there a way to append $rss->itemLinkField = ''; ? For use with campaign url or other tracking methods.

E.g. such as this:

$rss->itemLinkField = 'httpUrl' . '?utm_source=RSS_Feed&utm_medium=RSS&utm_campaign=RSS_Syndication';

Except that this wont work … I have also tried:

$rss->itemLinkField = 'httpUrl';
$rss->itemLinkField .= '?utm_source=RSS_Feed&utm_medium=RSS&utm_campaign=RSS_Syndication';

Just to show what is not working, and what I am trying to achieve.

Share this post


Link to post
Share on other sites

Hey, I sent a pull request to fix parsing error with message 'unicode entity not defined' when using author field that contains unicode (Turkish) characters. I also added atom namespace and atom:link property under channel to pass W3C validation.

Share this post


Link to post
Share on other sites

I was just using this module "MarkupRSSEnhanced" to generate my rss feed.
My RSS feed specifically pulls data from 2 different templates.

Though both these templates have the same title field called 'Title', their description field varies (one has r_desc and the other has e_desc)

Is there a way where I can configure the model in such a way to pick up either of r_desc or e_desc (whichever is present on the template)
I also have the same problem with adding the image to rss also since one has field name r_pic and the other has e_pic.
PS-I cannot change the field names since I recently took over the project I am working on and it has been implemented by many others before me.
 

Edited by kongondo
Moderator Note: Moved your post to the module's support forum

Share this post


Link to post
Share on other sites

@Alex CA you can change those fields when you instantiate the module:

$rss = $modules->get("MarkupRSSEnhanced");
$rss->title = 'Title for this feed';
$rss->description = 'Description for this feed';
$rss->itemDescriptionField = 'r_desc'; // set your specific field here, e.g. r_desc or e_desc
$rss->itemEnclosureField = 'r_pic'; // or e_pic

$limit = 8;
$items = $page->children("limit={$limit}, sort=-publish_start");
$rss->render($items);

 

  • Like 1

Share this post


Link to post
Share on other sites

@Macrura
I did see how to instantiate the module. But how do I make module pick up r_desc and r_pic when it's generating the RSS feed when I select pages with template='Template1'  and then make it pick e_desc and e_pic when the template is='Template2'.
My condition for the page selector for my RSS feed is $pages->find("template=". $template1 ."|". $template2.", sort=-modified,limit=20");

Share this post


Link to post
Share on other sites

I think if i was faced with your situation, the first thing i would do (after cursing out the developer who setup that field structure) would be to add a runtime field and see if the module is able to pick up that: (in ready.php for example):

wire()->addHookProperty('Page(template=Template1)::rss_desc', function($event) {
    $page = $event->object;
    $event->return =  $page->r_desc;
});

wire()->addHookProperty('Page(template=Template2)::rss_desc', function($event) {
    $page = $event->object;
    $event->return =  $page->e_desc;
});

wire()->addHookProperty('Page(template=Template1)::rss_pic', function($event) {
    $page = $event->object;
    $event->return =  $page->r_pic;
});

wire()->addHookProperty('Page(template=Template2)::rss_pic', function($event) {
    $page = $event->object;
    $event->return =  $page->e_pic;
});

Or I would just roll my own RSS feed using a class..

Share this post


Link to post
Share on other sites

@Macrura
Thanks for all the help. The addHookProperty() did not work. Another simple solution (I should've tried it earlier ) is to directly use 

$rss->itemDescriptionField='e_desc|r_desc'

Share this post


Link to post
Share on other sites

I do have another task what I am trying to solve with the help of RSS module.

Suppose my rss feed is based on a page which uses template A and it is pulling data from all templates on the website which has template B (which is say b_title and b_description). Now, I have another field in template B which has a filed type Page(lets called this field b_page) which essentially is for pages of another template (let's call it template C).This template C consists of a field called c_img. Now I want my rss feed template(A.php) to pull the title and description from template B and the image for the rss feed from template C. How do I achieve the retrieval of the image? 
I have tried representing my problem with a picture below.
 

My current code looks similar to this:

<?php

// rss-feed.php template file
// retrieve the RSS module
$rss = $modules->get("MarkupRSSEnhanced");
// configure the feed. see the actual module file for more optional config options.
$rss->title = "Latest updates";
$rss->description = "The most recent pages ";



$items = $pages->find("tempalte=". $templateB .", sort=-modified,limit=20");
$rss->itemDescriptionField = 'b_Desc';
$rss->itemEnclosureField = 'b_page[0]->c_img'; // we take the first one since this field can consist an array of pages         
// send the output of the RSS feed, and you are done
$rss->render($items); 

?>


 

s.png

Share this post


Link to post
Share on other sites

If i were faced with your issue, i would change the structure of the pages and all of that, it doesn't make sense to me; i guess it must make complete sense to someone else, whoever set it up that way, but obviously the module author(s) never accounted for this sort of setup;

You can also just roll your own RSS feed, then you don't need to be straddled with module interactions; it's not that hard to just make your own RSS class that takes into account any arbitrary structure and outputs it how you want; you could also just extend the module itself and modify the Module Class to a new one, and work from there until it works...

  • Like 1

Share this post


Link to post
Share on other sites

Hi, I just installed the enhanced module on the latest version of PW, even though it is not strictly compatible.

I am trying to set up an image from an images field as enclosure like this:

$rss->itemEnclosureField = 'post_images';

I would like it to pick the first image from the field. However, the RSS feed is not changed and there are no errors in the error log. I made sure to call the rss with:

$rss = $modules->get("MarkupRSSEnhanced");

@Macrura any ideas?

Share this post


Link to post
Share on other sites

did you set the enclosure field in the module settings; i know the module says you can set it from the api, just wondering what effect that has; also make sure the feed is not cached...

  • Like 1

Share this post


Link to post
Share on other sites

@Macrura thanks for the help. Turns out it does work, but I was doing some images substitutions in another file which made me think I was getting incorrect results (was substituting for default picture when there was none, and RSS omits the enclosure tag if there aren't any). 

Share this post


Link to post
Share on other sites
1 hour ago, Martijn Geerts said:

Have not used it with PW3, now-a-days I use DomDocument

 

Could you please share a bit more. A simple gist would be perfect))

Share this post


Link to post
Share on other sites

Hi @Ivan Gretsky

The code I gonna paste here is a copy/paste from other work so there might be glitches. And you should use your own fieldnames etc.
What you can do is:

  • Create a template and template file for RSS name it rss.
    • Template not ending with slash. (Name a the page that uses this template should end with .rss
  • In the template file something like:
<?php namespace ProcessWire;

use DomDocument;
use DOMElement;
use DateTime;

header('Content-Type: application/xml; charset=utf-8', true);
date_default_timezone_set("Europe/Amsterdam");
setlocale(LC_MONETARY, 'nl_NL');

/** @var \DateTime */
$date = new DateTime('today midnight');

$items = $pages->find("YOUR SEARCH SELECTOR DON'T FORGET TO SET LIMIT");

/**
 * Start XML Object
 *
 * @var DOMDocument
 */
$dom = new DOMDocument("1.0", "UTF-8");

$root = $dom->appendChild($dom->createElement("rss"));
$root->setAttribute("version","2.0");
$root->setAttribute("xmlns:dc","http://purl.org/dc/elements/1.1/");
$root->setAttribute("xmlns:content","http://purl.org/rss/1.0/modules/content/");
$root->setAttribute("xmlns:atom","http://www.w3.org/2005/Atom");

$link = $dom->createElement("atom:link");
$link->setAttribute("href", $page->httpUrl());
$link->setAttribute("rel","self");
$link->setAttribute("type","application/rss+xml");

$channel = $root->appendChild($dom->createElement("channel"));
$channel->appendChild($link);
$channel->appendChild($dom->createElement("title", $page->title));
$channel->appendChild($dom->createElement("description", $page->description));
$channel->appendChild($dom->createElement("link", $page->httpUrl));
$channel->appendChild($dom->createElement("language", "nl"));
$channel->appendChild($dom->createElement("lastBuildDate", $date->format(DateTime::RFC2822)));
$channel->appendChild($dom->createElement("generator", "DomDocument, ProcessWire"));

foreach ($items as $item) {
	$dateInt = (int) $item->getUnformatted("date_start");
	if (!$dateInt) $dateInt = (int) $item->modified;

	/** @var DateTime $date */
	$date = new DateTime(date("Y-m-d", $dateInt));
	/** @var DOMElement $parent */
	$itemParent = $dom->createElement("item");

	// Plain tags
	$elements = array(
		$dom->createElement("title", $item->title),
		$dom->createElement("description", htmlspecialchars($item->description)),
		$dom->createElement("link", $item->httpUrl()),
	);

	// For closure
	$image = $images->first();
	$image = $image->size(600, round(600 * 9 / 16));
	$mime = $image->ext === 'jpg'
		? "image/jpeg"
		: "image/png";

	$enclosure = $dom->createElement("enclosure");
	$enclosure->setAttribute('url', $image->httpUrl());
	$enclosure->setAttribute('type', $mime);
	$enclosure->setAttribute('length', $image->filesize);
	$elements[] = $enclosure;

	foreach ($elements as $element) $itemParent->appendChild($element);

	$channel->appendChild($itemParent);
}

echo $dom->saveXML();

When you want to place the RSS in the root you could hide it for non superusers:

/**
 * Hide RSS page
 *
 * Hide RSS page int pagelist for NON superusers
 *
 */
$wire->addHookBefore("ProcessPageList::find", function (HookEvent $event) {
	/** @var User $user */
	$user = $this->wire("user");

	if ($user->isSuperuser()) return;

	/** @var Page $page */
	$page = $event->arguments(1);
	/** @var string $baseSelector */
	$baseSelector = $event->arguments(0);

	$selector = $baseSelector . ", template!=rss";
	$event->arguments(0, $selector);
});

Hope this could be a good starting point for you.

  • Like 1

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By jploch
      Fieldtype Page Table Grid
      This is a sneak preview of a side project I've been working on for quite some time now. A lot of work and thought has gone into this, so I will most likely release this as a commercial module at some point in the near future. 

      As a designer (and developer) I get the appeal of a WYSIWYG editor. After playing around with some WYSIWYG page builder tools, I always felt something was wrong about them. So I decided to build my own PW version based on PageTable.

      Here is a small demo (using AdminThemeCanvas, but its working with other admin themes as well) :
      There is also a complete website that I built for a friend of mine using this module and some custom blocks.
      Concept
      This fieldtype shares a lot of features with PageTableExtended: it's also an extension of PageTable and renders the block templates in the backend and frontend (native PW templates and fields). You can also add your own css via module settings.
      The difference is, this fieldtype also gives you the ability to rearrange and resize elements in a visual way as well as enable inline editing for text, ckeditor and file fields. Similar (and promising) attempts have been made, but I wanted something based on native CSS grid instead of a CSS framework...so I built my own version. Most CSS frameworks are based on flexbox, which is great for layouting elements horizontally. With CSS grid, you can place elements horizontally and vertically, allowing for layouts that were not previously possible with CSS. Similar to webflow, this fieldtype uses javascript (in the backend) to let you manipulate CSS grid in a visual way to design fully responsive websites (or parts of them). It should still be possible to include a CSS framework if you like (just add the classes to your block markup and include the CSS via module settings).
      The CSS grid layout manipulations are saved in a single field as a JSON array and used to generate a dynamic stylesheet that you simply include in your main template (no inline styles). The styles are saved within the breakpoint you select and cascade down to smaller breakpoints. That means you can specify just the basic breakpoint and adjust other breakpoints if needed. The exception is the mobile breakpoint which will display everything in one column as a default (you can change the layout here too).
      The fieldtype also comes with an optional style panel to manipulate some additional CSS properties directly on the page. You can customize the panel or disable it completely from the module settings (and just use a CSS file that you include via module settings). The style panel is based on inputfields (nothing is saved to the database). This means that you just have to install the module and all fields are available to all blocks automatically (this can be customized). It also has the benefit that your installation is not flooded with fields; this module only installs one field.
      Don't want to give your customer all that power? Design features can be disabled for certain roles. The grid editor role can just edit the content and use the inline editing feature to edit content quickly. You can then also grant access individually to the style panel, resize or drag functionality.
      Features
      Blocks are just pages Blocks are defined by native PW templates and fields Manipulate CSS grid in a visual way to design fully responsive websites (or parts of them) Design features can be disabled for certain roles Inline editing of text, ckeditor and file fields The layout is 100% CSS grid (very small css file size) Simply drag and resize to manipulate grid items directly inside the backend Manipulate grid columns and rows directly on the page (use any number of columns you want) All style manipulations are saved as JSON and used to generate a dynamic stylesheet that you just include in your main template (no inline styles) Nested groups/grids (child pages of nested blocks are created under group parent) Global blocks work with page reference field (changes on one page, changes all blocks on all pages) Manual and auto placement of grid items Define custom icons for your blocks via native template settings (template -> advanced -> icon) Option to load lazysizes in the backend to enable lazy loading of assets with class lazyload Works with all default and ui-kit based admin themes If you have any questions or feedback, let me know.
    • By bernhard
      I built this module because I needed a versatile solution to replace tags and simple if-blocks in some E-Mails and PDF documents.
      If you only need to replace static tags (no if-conditions), then you can use default PW api and need no module:
      $str = "My favourite color is {color}."; $texttools = $sanitizer->getTextTools(); echo $texttools->populatePlaceholders($str, ['color' => 'red']); // output: My favourite color is red. Usage:
      See the two example Files in the folder /replacements

       
      Methods:
      replacementsTable()
      Renders an overview of all available replacements (see the example in the Module's config file:
       
      Create new Replacements:
      Simply copy the sample file and adopt to your needs.
       
      Download:
      https://gitlab.com/baumrock/RockReplacer
    • By bernhard
      DEPRECATED
      I'm using this module in several projects, but it will likely not see any updates in the future. I'm not happy with it and I'm looking for ways to develop better solutions. RockTabulator was my first try, but I'm also not 100% happy with that. The tabulator library is great, but my module implementation is not. I hope to get a good solution soon, but it will be a lot of work...
      ---
      Some of you might have followed the development of this module here: https://processwire.com/talk/topic/15524-previewdiscussion-rockdatatables/ . It is the successor of "RockDataTables" and requires RockFinder to get the data for the grid easily and efficiently. It uses the open source part of agGrid for grid rendering.
       
      WHY?
      ProcessWire is awesome for creating all kinds of custom backend applications, but where it is not so awesome in my opinion is when it comes to listing this data. Of course we have the built in page lister and we have ListerPro, but none of that solutions is capable of properly displaying large amounts of data, for example lists of revenues, aggregations, quick and easy sorts by the user, instant filter and those kind of features. RockGrid to the rescue 😉 
       
      Features/Highlights:
      100k+ rows Instant (client side) filter, search, sort (different sort based on data type, eg "lower/greater than" for numbers, "contains" for strings) extendable via plugins (available plugins at the moment: fullscreen, csv export, reload, batch-processing of data, column sum/statistics, row selection) all the agGrid features (cell renderers, cell styling, pagination, column grouping etc) vanilla javascript, backend and frontend support (though not all plugins are working on the frontend yet and I don't plan to support it as long as I don't need it myself)  
      Limitations:
      While there is an option to retrieve data via AJAX the actual processing of the grid (displaying, filtering, sorting) is done on the client side, meaning that you can get into troubles when handling really large datasets of several thousands of rows. agGrid should be one of the most performant grid options in the world (see the official example page with a 100k row example) and does a lot to prevent problems (such as virtual row rendering), but you should always have this limitation in mind as this is a major difference to the available lister options that do not have this limitation.
      Currently it only supports AdminThemeUikit and I don't plan to support any other admin theme.
       
      Download: https://gitlab.com/baumrock/FieldtypeRockGrid
      Installation: https://gitlab.com/baumrock/RockGrid/wikis/Installation
      Quikckstart: https://gitlab.com/baumrock/RockGrid/wikis/quickstart
      Further instructions: https://gitlab.com/baumrock/RockGrid/wikis/quickstart#further-instructions
      German Translation File: site--modules--fieldtyperockgrid--fieldtyperockgrid-module-php.json
      Changelog: https://gitlab.com/baumrock/FieldtypeRockGrid/raw/master/changelog.md
       
      Module status: alpha, License: MIT
      Note that every installation and uninstallation sends an anonymous google analytics event to my google analytics account. If you don't want that feel free to remove the appropriate lines of code before installation/uninstallation.
       
      Contribute:
      You can contribute to the development of this and other modules or just say thank you by
      testing, reporting issues and making PRs at gitlab liking this post buying me a drink: paypal.me/baumrock/5 liking my facebook page: facebook.com/baumrock hiring me for pw work: baumrock.com  
      Support: Please note that this module might not be as easy and plug&play as many other modules. It needs a good understanding of agGrid (and JavaScript in general) and it likely needs some looks into the code to get all the options. Please understand that I can not provide free support for every request here in the forum. I try to answer all questions that might also help others or that might improve the module but for individual requests I offer paid support (please contact me via PM).
       
      Use Cases / Examples:
      Colored grid cells, Icons, Links etc. The Grid also has a "batcher" feature built in that helps communicating with the server via AJAX and managing resource intensive tasks in batches:

      Filters, PW panel links and instant reload on panel close:

      You can combine the grid with a chart library like I did with the (outdated) RockDataTables module:

    • By Paul Greinke
      Hi there. I wrote a custom module for one of my projects. In fact I maybe want to use my module in other projects too. In order to be variable and customizable  I need to implement some custom hooks into my module. So I can afterwards hook into the my functions in order to modify them to match the needs of the new project.
      I tried simply defining functions with the '__' prefix. But that did not work. I'm imagining something like the following:
      <?php class MyClass { public function ___someFunction() { // Do something } } // ready.php $this->addHookBefore('MyClass::someFunction', function($event) { // some customization }); Is there a way to accomplish that? 
    • By adrian
      Hi everyone,
      Here's a new module that I have been meaning to build for a long time.
      http://modules.processwire.com/modules/process-admin-actions/
      https://github.com/adrianbj/ProcessAdminActions
       
      What does it do?
      Do you have a bunch of admin snippets laying around, or do you recreate from them from scratch every time you need them, or do you try to find where you saw them in the forums, or on the ProcessWire Recipes site?
      Admin Actions lets you quickly create actions in the admin that you can use over and over and even make available to your site editors (permissions for each action are assigned to roles separately so you have full control over who has access to which actions).
       
      Included Actions
      It comes bundled with several actions and I will be adding more over time (and hopefully I'll get some PRs from you guys too). You can browse and sort and if you have @tpr's Admin on Steroid's datatables filter feature, you can even filter based on the content of all columns. 

      The headliner action included with the module is: PageTable To RepeaterMatrix which fully converts an existing (and populated) PageTable field to either a Repeater or RepeaterMatrix field. This is a huge timesaver if you have an existing site that makes heavy use of PageTable fields and you would like to give the clients the improved interface of RepeaterMatrix.
      Copy Content To Other Field
      This action copies the content from one field to another field on all pages that use the selected template.
      Copy Field Content To Other Page
      Copies the content from a field on one page to the same field on another page.
      Copy Repeater Items To Other Page
      Add the items from a Repeater field on one page to the same field on another page.
      Copy Table Field Rows To Other Page
      Add the rows from a Table field on one page to the same field on another page.
      Create Users Batcher
      Allows you to batch create users. This module requires the Email New User module and it should be configured to generate a password automatically.
      Delete Unused Fields
      Deletes fields that are not used by any templates.
      Delete Unused Templates
      Deletes templates that are not used by any pages.
      Email Batcher
      Lets you email multiple addresses at once.
      Field Set Or Search And Replace
      Set field values, or search and replace text in field values from a filtered selection of pages and fields.
      FTP Files to Page
      Add files/images from a folder to a selected page.
      Page Active Languages Batcher
      Lets you enable or disable active status of multiple languages on multiple pages at once.
      Page Manipulator
      Uses an InputfieldSelector to query pages and then allows batch actions on the matched pages.
      Page Table To Repeater Matrix
      Fully converts an existing (and populated) PageTable field to either a Repeater or RepeaterMatrix field.
      Template Fields Batcher
      Lets you add or remove multiple fields from multiple templates at once.
      Template Roles Batcher
      Lets you add or remove access permissions, for multiple roles and multiple templates at once.
      User Roles Permissions Batcher
      Lets you add or remove permissions for multiple roles, or roles for multiple users at once.
       
      Creating a New Action
      If you create a new action that you think others would find useful, please add it to the actions subfolder of this module and submit a PR. If you think it is only useful for you, place it in /site/templates/AdminActions/ so that it doesn't get lost on module updates.
      A new action file can be as simple as this:
      class UnpublishAboutPage extends ProcessAdminActions { protected function executeAction() { $p = $this->pages->get('/about/'); $p->addStatus(Page::statusUnpublished); $p->save(); return true; } } Each action:
      class must extend "ProcessAdminActions" and the filename must match the class name and end in ".action.php" like: UnpublishAboutPage.action.php the action method must be: executeAction() As you can see there are only a few lines needed to wrap the actual API call, so it's really worth the small extra effort to make an action.
      Obviously that example action is not very useful. Here is another more useful one that is included with the module. It includes $description, $notes, and $author variables which are used in the module table selector interface. It also makes use of the defineOptions() method which builds the input fields used to gather the required options before running the action.
      class DeleteUnusedFields extends ProcessAdminActions { protected $description = 'Deletes fields that are not used by any templates.'; protected $notes = 'Shows a list of unused fields with checkboxes to select those to delete.'; protected $author = 'Adrian Jones'; protected $authorLinks = array( 'pwforum' => '985-adrian', 'pwdirectory' => 'adrian-jones', 'github' => 'adrianbj', ); protected function defineOptions() { $fieldOptions = array(); foreach($this->fields as $field) { if ($field->flags & Field::flagSystem || $field->flags & Field::flagPermanent) continue; if(count($field->getFieldgroups()) === 0) $fieldOptions[$field->id] = $field->label ? $field->label . ' (' . $field->name . ')' : $field->name; } return array( array( 'name' => 'fields', 'label' => 'Fields', 'description' => 'Select the fields you want to delete', 'notes' => 'Note that all fields listed are not used by any templates and should therefore be safe to delete', 'type' => 'checkboxes', 'options' => $fieldOptions, 'required' => true ) ); } protected function executeAction($options) { $count = 0; foreach($options['fields'] as $field) { $f = $this->fields->get($field); $this->fields->delete($f); $count++; } $this->successMessage = $count . ' field' . _n('', 's', $count) . ' ' . _n('was', 'were', $count) . ' successfully deleted'; return true; } }  
      This defineOptions() method builds input fields that look like this:

      Finally we use $options array in the executeAction() method to get the values entered into those options fields to run the API script to remove the checked fields.
      There is one additional method that I didn't outline called: checkRequirements() - you can see it in action in the PageTableToRepeaterMatrix action. You can use this to prevent the action from running if certain requirements are not met.
      At the end of the executeAction() method you can populate $this->successMessage, or $this->failureMessage which will be returned after the action has finished.
       
      Populating options via URL parameters
      You can also populate the option parameters via URL parameters. You should split multiple values with a “|” character.
      You can either just pre-populate options:
      http://mysite.dev/processwire/setup/admin-actions/options?action=TemplateFieldsBatcher&templates=29|56&fields=219&addOrRemove=add
      or you can execute immediately:
      http://mysite.dev/processwire/setup/admin-actions/execute?action=TemplateFieldsBatcher&templates=29|56&fields=219&addOrRemove=add

      Note the “options” vs “execute” as the last path before the parameters.
       
      Automatic Backup / Restore
      Before any action is executed, a full database backup is automatically made. You have a few options to run a restore if needed:
      Follow the Restore link that is presented after an action completes Use the "Restore" submenu: Setup > Admin Actions > Restore Move the restoredb.php file from the /site/assets/cache/AdminActions/ folder to the root of your site and load in the browser Manually restore using the AdminActionsBackup.sql file in the /site/assets/cache/AdminActions/ folder I think all these features make it very easy to create custom admin data manipulation methods that can be shared with others and executed using a simple interface without needing to build a full Process Module custom interface from scratch. I also hope it will reduce the barriers for new ProcessWire users to create custom admin functionality.
      Please let me know what you think, especially if you have ideas for improving the interface, or the way actions are defined.
       
       
×
×
  • Create New...