Jump to content
ryan

Hanna Code

Recommended Posts

i tried using the shortcode module, and it is promising, and quite different than hanna codes; shortcodes allow you to have an opening and closing tag so you can enclose things within, which allows you to use them for things like tabs and accordions;

hanna code is very usable/flexible, but it doesn't know about things between each instance of itself (no opening/closing)...

also the shortcodes module doesn't allow for using more than 1 shortcode on a page.. i think it needs more work;

but it would be good if we could have a shortcodes module that works as well as the wordpress shortcodes, since there are still some rare use cases where shortcodes can be useful...

custom fields replaces and is superior for the most part to the concept of shortcodes, which is probably why the need has not come up much on PW.

And end users always mess up with shortcodes, like putting them in the wrong place in the RTE (like inside a heading), or forgetting to use the closing tag, and consequently break the layout on pages too easily...

  • Like 1

Share this post


Link to post
Share on other sites

I have never even considered using anything like Hanna code or shortcodes for our clients. I think what would make them usable would be making them appear as a block in editor, instead of plain text.

  • Like 1

Share this post


Link to post
Share on other sites

I have never even considered using anything like Hanna code or shortcodes for our clients. I think what would make them usable would be making them appear as a block in editor, instead of plain text.

Actuall in my testing phase of PW - there are much less usecases for such little snippets because you could use simple a extra field or do prefered PHP direkt in the page template....but in other systems you only had some blocks or one Wysiwyg per pages and such snippets catch up some content or bring some logic to a wysiwyg the user doesn't have to think about it.

For example you could easy setup some Hanna codes and implement it fast via import on new different websites....reusable codesnippets are the usecase.

Iportant question if i wanna make them work in the template i have to call the process i think??

Next HannaCode from my testings is a simple sitemap:

//:Sitemap: creates a simple sitemap (Snippet find in the forum from soma)
//:Use: [[sitemap]]

Just import this one:

!HannaCode:sitemap:eyJuYW1lIjoic2l0ZW1hcCIsInR5cGUiOiIyIiwiY29kZSI6Ijw/cGhwXHJcblxyXG5cclxuZnVuY3Rpb24gc2l0ZU1hcCgkcGFnZSwgJG91dHB1dD0nJykge1xyXG4gICAgJG91dHB1dCAuPSBcIlxcblxcdDxsaT48YSBocmVmPSd7JHBhZ2UtPnVybH0nPnskcGFnZS0+dGl0bGV9PFwvYT5cIjtcclxuICAgIGlmKCRwYWdlLT5udW1DaGlsZHJlbikge1xyXG4gICAgICAgICRvdXRwdXQgLj0gXCJcXG5cXHRcXHQ8dWw+XCI7XHJcbiAgICAgICAgZm9yZWFjaCgkcGFnZS0+Y2hpbGRyZW4gYXMgJGNoaWxkKSAkb3V0cHV0IC49IHN0cl9yZXBsYWNlKFwiXFxuXCIsIFwiXFxuXFx0XFx0XCIsIHNpdGVNYXAoJGNoaWxkKSk7XHJcbiAgICAgICAgJG91dHB1dCAuPSBcIlxcblxcdFxcdDxcL3VsPlwiO1xyXG4gICAgfVxyXG4gICAgJG91dHB1dCAuPSBcIlxcblxcdDxcL2xpPlwiO1xyXG4gICAgcmV0dXJuICRvdXRwdXQ7XHJcbn1cclxuXHJcbiRob21lcGFnZSA9ICRwYWdlcy0+Z2V0KFwiXC9cIik7XHJcbiRzaXRlTWFwID0gc2l0ZU1hcCgkaG9tZXBhZ2UpO1xyXG5lY2hvIFwiPHVsPlwiLiRzaXRlTWFwLlwiPFwvdWw+XCI7In0=/!HannaCode

Have Fun - mr-fan

  • Like 2

Share this post


Link to post
Share on other sites
I have never even considered using anything like Hanna code or shortcodes for our clients. I think what would make them usable would be making them appear as a block in editor, instead of plain text.

 Exactly my thought. And loaded/configurable per template, so that only hanna codes are shown that makes sence in that template. 

  • Like 1

Share this post


Link to post
Share on other sites

Hi all

I hope there's someone here that can help me.. I've set up this site (www.sejero-festival.dk) on my localhost and Hanna Code works excellent.

However, and I've tried two different hosts now, when I deploy the site, the Hanna Code module fails miserably when I try to go to the setup part :

Screenshot%202014-06-16%2014.08.42.png

One of the hosts has the following specs:

PHP: 5.3.28

MySQL: 5.5.37

Does anyone have a clue what might cause this error?

Share this post


Link to post
Share on other sites

For some reason I cannot get hanna code to work with php. I can get html to work just pine but php will not.

Here is my code

<?php
 
foreach($page->children as $product) {
 
    if($product->image) {
       // $image = $product->image->width(150);
        $img = "<img src='{$image->url}' alt='{$product->title}' class='flt-left-img' />";
    } 
    
    else {
     
        $img = "<span class='image_placeholder'>Image not available</span>";
    } 
 
    echo "
        $img
        <h3>{$product->title}</h3>
        <p>{$product->product_description}</p>
        <hr />
        ";
}
?>
 
 
 
The only thing that will output on the page is the product description but all other content from the body disappears.
 
Driving me nuts so any help would be great.

Share this post


Link to post
Share on other sites

I hope there's someone here that can help me.. I've set up this site (www.sejero-festival.dk) on my localhost and Hanna Code works excellent.

However, and I've tried two different hosts now, when I deploy the site, the Hanna Code module fails miserably when I try to go to the setup part :

One of the hosts has the following specs:

PHP: 5.3.28

MySQL: 5.5.37

Does anyone have a clue what might cause this error?

Is this still a problem? Does anything else work, i.e. is this the only place that's broken on this site?

Sounds like your database wasn't reachable at this point, but I'd imagine that causing issues elsewhere too. Unless, perhaps, it's somehow related to PHP's mysqli extension on that server (just about all core features have already been migrated to PDO instead).

For some reason I cannot get hanna code to work with php. I can get html to work just pine but php will not.

Here is my code

<?php
 
foreach($page->children as $product) {
 
    if($product->image) {
       // $image = $product->image->width(150);
        $img = "<img src='{$image->url}' alt='{$product->title}' class='flt-left-img' />";
    } 
    
    else {
     
        $img = "<span class='image_placeholder'>Image not available</span>";
    } 
 
    echo "
        $img
        <h3>{$product->title}</h3>
        <p>{$product->product_description}</p>
        <hr />
        ";
}
?>
 
 
 
The only thing that will output on the page is the product description but all other content from the body disappears.

Only weird thing I can spot in your code right away is that you've got $image = ... commented out, yet on the next line you try to use $image->url, which obviously won't be available here. I'm assuming that this was just something you did for testing and forgot there.

When you're saying that only output is the product description, it's coming from this Hanna Code snippet, right? Are you seeing empty <h3></h3> tags and then <p></p> tags with product description inside them and nothing else, or..?

I'm not really sure what you're referring to when you say that all other content from the "body" disappears; <body> element of your page, $page->body, or something entirely different? If you view the source of the page, is there anything weird there -- or in your log files, either in site/assets/logs/errors.txt or Apache logs?

Share this post


Link to post
Share on other sites

oops I didn't mean to have that commented out. Its not in my code, but that was a copy that I forgot to uncomment. 

I am not seeing empty <h3> tags or <p> tags and yes the product description is coming from the hanna code. In fact the only thing that showing on the page is the product description from the hanna code. Everything else disappears including all paragraphs and everything else in the textarea $page->body. There is nothing weird in the source. It has to be the way this php is whitten I think because I am using other php for another hanna code and it works.  

this is the other code that works

<?php foreach ($page->children() as $c): ?>

<li><a href="<?=$c->url;?>"><img src="<?=$c->listImage->url;?>" alt="<?=$c->listImage->description;?>" width="100" height="100"> <?=$c->listImage->description;?> <span>View More</span></a></li>
<? endforeach; ?>

Share this post


Link to post
Share on other sites

Is this still a problem? Does anything else work, i.e. is this the only place that's broken on this site?

Sounds like your database wasn't reachable at this point, but I'd imagine that causing issues elsewhere too. Unless, perhaps, it's somehow related to PHP's mysqli extension on that server (just about all core features have already been migrated to PDO instead).

Yeah it's still a problem. :-(

And now I've tried it on another host with same result. The only two places I've succesfully gotten the Hanna Code module to work were on localhost (yay) and on my Digital Ocean Droplet...

I guess I'll let the owner of the site know, that he can't get that module on the two host masters he wished for. :-)

Share this post


Link to post
Share on other sites

First problem I noticed, two people are asking two separate questions at the same time.

For @kasperwf,

 Hi all

 

I hope there's someone here that can help me.. I've set up this site (www.sejero-festival.dk) on my localhost and Hanna Code works excellent.

However, and I've tried two different hosts now, when I deploy the site, the Hanna Code module fails miserably when I try to go to the setup part :

  One of the hosts has the following specs:

 

PHP: 5.3.28

MySQL: 5.5.37

 

Does anyone have a clue what might cause this error?

 

On your localhost (that is working), what are the following:

ProcessWire version

PHP version

MySQL version

Apache version

Then, what are the same information for both hosts that you have have tried?  Having that information, will allow someone to truly be of help to you.  Thanks.

Share this post


Link to post
Share on other sites

On your localhost (that is working), what are the following:

ProcessWire version

PHP version

MySQL version

Apache version

Then, what are the same information for both hosts that you have have tried?  Having that information, will allow someone to truly be of help to you.  Thanks.

My localhost:

PHP version: 5.4.22

MySQL version: 5.6.10

Apache: Apache/2.2.26 (Unix)

The information for the hosts that doesn't work is the one I wrote earlier. Seems like they both use the exact same setup (as the other, not like mine, the working server). :-I

The info for my VPS that also work is:

PHP: 5.5.9-1ubuntu4

MySQL: I really don't know, because I obviously secured it too well, and I can't even mysql -v it. But it was last month, and it was the newest version, so, yeah. :-)

Apache: Apache/2.4.7 (Ubuntu)

Share this post


Link to post
Share on other sites

This turned out to be an issue with the order of variables returned by core TemplateFile::getArray. It was doing an array_merge which gave preference to API variables, preventing them from being overwritten. Maybe that's a good thing in general, but I don't think we want that limitation. I went ahead and changed it in dev. Now it gives preference to local variables, which enables Hanna Code to provide the behavior it was supposed to. 

Hello,

I fail to make it work. I'm using PW version 2.4.4. TemplateFile.php lines 156-158 are correctly updated:

	public function getArray() {
		return array_merge($this->fuel->getArray(), parent::getArray()); 
	}

My Hanna code is as simple as:

[[page-title]] :

<?php
echo $page->title;

The structure is as follows:

Page texts, with title "Texts" -> Field "Text 1" (Textareas ProField)-> "Some text... " . [[page-title]]

Page product name, with title "Product name"-> API reference to Field "Text 1"

Outputs "Some text... Texts"

Should be "Some text... Product name"

I think it should work, but can´t see the problem. The textareas field has Hanna Code Text Formatter applied.

Thanks,  :rolleyes:

Share this post


Link to post
Share on other sites

I think I am getting caught out by scope - well, I know I am.

I have some text on a page other than the one I am looking at, and I am drawing it in with get()

That text has a hanna code in it that simply echos the page title.

The problem is that it is echoing the page title of the page the code originates from and not from the page I am looking at.

How do I do this so that it gets my current page title, not the page where the text originates from?

Share this post


Link to post
Share on other sites

ummm ... I am halfway there.

by using this for the php for my hanna code <?php echo wire("page")->title; ?> I now get the current page title.

However, I am not getting the rest of the text.

So:

This is my [[pagetitle]] you can see

Is just printing out the page title, not the rest of the words.

Share this post


Link to post
Share on other sites

You don't happend to replace sorounding p tags and the hanna code is inside the text paragraph?

Share this post


Link to post
Share on other sites

Hi Soma, no, I have the replace bit turned off.

I think it is because the textarea that supplies the text, complete with the hanna code reference, is originating on another page.

I am calling it into my template with:

<? echo $pages->get("/servicing/")->service_model_default_text; ?>

Now, if I use a different code, one that pulls the info from a specified field in a specified page, that works fine.

For instance, a code that is:

echo "<span class='phonenumber'>Call {$pages->get("/settings/")->site_phone}</span>";

But if I try and call something from the current page, it goes wrong.

So if I used the code:

echo $page->title;

Simply prints out title of the page where the text originated, but not the rest of the text. if I use wire() it prints out the current page title, but again no text. Debug is not showing errors.

Share this post


Link to post
Share on other sites

Sorry can't really follow what you're doing. Mostly confused why you'd need hanna code at all just for a page title?

Share this post


Link to post
Share on other sites

Basically I have a huge lump of default text in a separate page that is pulled into about 100 pages or so.

The default text needs to pick up values from those pages - product name, price and so on - that will be part of that long default text. The page title is just one of those values.

The easiest way I could see to do it (and easy for the client to understand) was to use bits of hanna code within the text.

Share this post


Link to post
Share on other sites

I have hard time following what code is where and what doesn't work.

Share this post


Link to post
Share on other sites

Sorry, Soma, I should have explained it better.

I have a page called services that has a CKEditor field called service_model_default_text

It contains, for instance, "we can service your [[model-name]]"

The code for the [[model-name]] hanna code is 

<?php echo wire("page")->title; ?>

I have the replace surrounding tag set to "no" and it is type PHP

I have another page called Audi. In the template for that page I get the field from the services page.

<?php echo $pages->get("/servicing/")->service_model_default_text; ?>

The idea is that the hanna code is replace with the page title from the audi page so that the final result is:

We can service your Audi.

Unfortunately, the hanna code system does not seem to be able to do that, it prints out the page title fine, but not the rest of the text from the field.

However, if I change the hanna code to another one I have, [[phonenumber]], which takes its input from a field on a completely separate page, it works fine.

Confused!

Share this post


Link to post
Share on other sites

I tested something like this in latest dev and 2.4 installation, works fine. I can't see any text not outputting.

Default site. Added hanna code formatter to body field. In /templates/ page in the body I place a hanna code inside text [[model-name]] and output that text on the About page. 

Hanna code 

<?php
echo wire("page")->title;

In template basic-page.php

echo $pages->get("/templates/")->body;

The hanna tag gets replaced with the page title and the surrounding text is still there.

Share this post


Link to post
Share on other sites

Damn!

I wonder what I have got that is messing it up?

I think I will strip the entire template out apart from the get line and see what happens

Share this post


Link to post
Share on other sites

Do those two pages, the one you have the body field and the about page, use the same template?

I just emptied the template file, but it still is not working properly.

I noticed that when I save and test the hanna code, inside the dotted box it just says Hanna Code

No idea why.

Share this post


Link to post
Share on other sites

Yes those two pages have same template. It doesn't matter what template. I've never used the save and test. But I think you would see the current admin page title if anything at all.

Share this post


Link to post
Share on other sites

hmm ... so something is not right. 

With the other hanna code, the one that points to a telephone number, in test it shows the telephone number.

I have tried deleting the hanna code instance, and adding a new one and it is the same problem.

The only other thing is that they are on different tree levels - the page that has the text in it is a child of home, the other page, the Audi page, is its grandchild. But I dont think that should be a problem.

I am a bit lost on this, to be honest, and it has brought the project to a shuddering halt

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...