Jump to content

Recommended Posts

Hi Adrian,

If in an action I try and get a page using the short $pages($id) form of selector then I get a compile error:

2018-07-03_140111.thumb.png.e9507775fea93207e8ac7dda91a20f13.png

My demo action:

protected function executeAction($options) {
    $p = $this->pages(1);
}

If I use get() then it works okay:

protected function executeAction($options) {
    $p = $this->pages->get(1);
}

Any ideas why the error is happening?

Link to post
Share on other sites

Hey @Robin S 

I think it's all because you are using $this

If you try it with just:

$p = pages(1)

it will be fine.

Take a look at: https://github.com/processwire/processwire/blob/341342dc5b1c58012ae7cb26cffe2c57cd915552/wire/core/FunctionsAPI.php#L50-L52

Note that the pages function is not a class method, but rather a global function.

All that said, you did highlight an issue with my __call() method which is why the error message is so confusing. I think I have a fix in place - I might PM it to you and see what you think before I commit.

Link to post
Share on other sites

Actually, I just decided to commit the changes - there were issues with calling an action via the API which this change fixes, so wanted to get it committed.

Let me know if you notice any issues.

Link to post
Share on other sites
6 hours ago, adrian said:

I think it's all because you are using $this

6 hours ago, adrian said:

Note that the pages function is not a class method, but rather a global function.

Thanks Adrian, but I don't think that's it. I'm not using the Functions API in that line but rather the shorter selector syntax that was introduced here: https://processwire.com/blog/posts/processwires-roadmap-in-2015/

$this->pages is the API $pages object - what Ryan calls "a Wire-derived object (alternate syntax)" in the blog post linked to above. And that should work because ultimately a custom action for AdminActions extends Wire.

It all looks right when I do some debugging dumps:

protected function executeAction($options) {
    $is_wire = $this instanceof Wire;
    bd($is_wire, 'is_wire');
    bd($this->pages, 'this->pages');
    //$p = $this->pages(1);
}

2018-07-04_101802.png.1c62607d8d3e605563657bb8de698de5.png

But when I uncomment the last line with the latest module update I get a different error:

2018-07-04_101910.png.dee7826e980c26852f59db75e818acb2.png

So somehow $this->pages($selector) is interpreted as being a (missing) method of Test. But I can use the same line in methods of other modules without a problem. Weird.

  • Like 1
Link to post
Share on other sites

I was wondering about that short syntax vs the functions API - I think it's actually a bit confusing because:

$pages(1) is obviously the short syntax and pages(1) is obviously the functions API, but $this->pages(1) seems a like it could be interpreted as either. I don't really understand why it's not working either though because as you say, an AA action does extend Wire. 

I just checked this: 

bd($this->wire()->pages(1)); 

which does work without error. I don't know whether this is somehow a bug in my module, or an issue with PW?

Any thoughts?

Link to post
Share on other sites
3 minutes ago, adrian said:

$pages(1) is obviously the short syntax and pages(1) is obviously the functions API, but $this->pages(1) seems a like it could be interpreted as either.

It does seem like PW could get confused with this, but I don't think that's what's happening in this case because the Functions API is only used when enabled in config.php and I don't have it enabled. I also noticed that the PhpStorm code completer thinks that everything is hunky dory - see how it marks the string within the parentheses as a selector:

2018-07-04_095607.png.7cea31ebb9cc16c704c784effcbc375f.png

My gut feeling is that it's something to do with the File Compiler. It would be interesting to test that by declaring the ProcessWire namespace in the module so the File Compiler isn't used (plus maybe the FileCompiler=0 line to be sure). But I've experimented with that a couple of times (I raised the idea of including the namespace by default here) and I can't get AdminActions to work when the namespace is declared. No doubt because I haven't studied the module closely enough - maybe you can see more easily how to get the module working with the namespace?

 

Link to post
Share on other sites

I have played with namespacing it and had no luck with this issue. I have to head out in a minute, but if you are interested, you can get the module working with namespace with these lines around line #134 in the main module file:

                $actionName = $this->wire('input')->get->action;
                $fullclass = __NAMESPACE__ . '\\' . $actionName;
                $this->action = new $fullclass;

Let me know if you get anywhere, otherwise I can investigate further later and if no luck we can ask Ryan.

  • Like 1
Link to post
Share on other sites
8 hours ago, adrian said:

I have played with namespacing it and had no luck with this issue.

Me neither - still getting the same error without the File Compiler involved.

I found that this works...

protected function executeAction($options) {
    $pages = $this->pages;
    $p = $pages(1);
}

So it's not a difficult thing to work around, just puzzling is all.

  • Like 1
Link to post
Share on other sites
  • 3 weeks later...

Hello!

Do you think it's easy to convert a Repeater -> PageTable ? I don't know enough to see if the existing action PageTable->repeater could be inverted.

Thanks!

Link to post
Share on other sites
2 hours ago, mel47 said:

Hello!

Do you think it's easy to convert a Repeater -> PageTable ? I don't know enough to see if the existing action PageTable->repeater could be inverted.

Thanks!

I'd say it will be a moderate amount of work to convert that PageTable>Repeater action to a Repeater>PageTable action. I don't have time to do this, but would be happy to accept a PR if you or someone else wants to do it.

Link to post
Share on other sites
20 hours ago, adrian said:

I'd say it will be a moderate amount of work to convert that PageTable>Repeater action to a Repeater>PageTable action. I don't have time to do this, but would be happy to accept a PR if you or someone else wants to do it.

ok thanks for answer. I will think if I should or not change my structure.

Link to post
Share on other sites
  • 1 month later...

An action that I made for my own convenience but that others might find useful too:

Unordered List to Pages

An action for the Admin Actions module for ProcessWire CMS/CMF. Creates a structure of new pages from an unordered list entered into a CKEditor field. The nesting of further unordered lists within the list will determine the nesting of the created pages.

This can be useful to quickly create a page structure; especially so if you are rebuilding an existing non-ProcessWire site that has a Sitemap page that you can copy and paste from. All the created pages get the same template - for any pages that should use a different template you can easily change this as you edit the page to add content, or use the Page Manipulator action for bulk template changes.

Usage

Install the action by copying the "UnorderedListToPages" folder to /site/templates/AdminActions/, and then visiting the Admin Actions config screen and enabling the "Unordered List to Pages" action for the roles who are allowed to use it.

Navigate to Admin Actions > Unordered List to Pages and fill out the config fields:

  • Enter/paste an unordered list in the Source field.
  • Select a parent page that the new pages will be created under.
  • Select the template to use for the new pages.

Execute the action.

Screenshots

Action config:

2018-09-21_221024

Result:

2018-09-21_191234

 

https://github.com/Toutouwai/UnorderedListToPages

Update:

https://github.com/Toutouwai/AdminActionsUnorderedListToPages

This action module now has its own support topic: 

 

  • Like 8
Link to post
Share on other sites

I freaking love this!

It is like the Add mode from BatchChildEditor, but on steroids!

I'd be keen to include this as a core action if you're ok with that and you'd like to submit a PR.

I can see using this for kickstarting many new sites.

If you do want to include, maybe move simple_html_dom.php into the libraries folder under actions, unless you feel like removing this need and coming up with a DOMDocument solution?

  • Like 5
Link to post
Share on other sites

Given that no-one else has submitted any actions yet, I wonder whether you guys would prefer to maintain themselves in your own repos. Perhaps the best approach might be to add a list of 3rd party actions to the AdminActions Readme.

Would you guys prefer that?

  • Thanks 1
Link to post
Share on other sites

Hey @Robin S - what do you think about extending this to support pasting in an actual XML sitemap from an existing site?

For this you'd obviously want a plain textarea field rather than an RTE.

I think it would be relatively simple to parse the xml and the number of segments in each url to determine what pages are children of which pages, etc.

What do you think: a) of the idea in general? and b) are you interested in doing it?

Link to post
Share on other sites
4 hours ago, adrian said:

Given that no-one else has submitted any actions yet, I wonder whether you guys would prefer to maintain themselves in your own repos. Perhaps the best approach might be to add a list of 3rd party actions to the AdminActions Readme.

I've just not created any yet 😉

Link to post
Share on other sites

Another idea that is probably taking something that is currently simple and effective and overly complicating it - I have a habit of that 🙂, but what about:

  • About | basic-page
    • Contact | contact
    • History | basic-page
    • People | people
      • John Smith | person
      • Jane Doe | person
  • Blog | blogs
  • Events | events

as a way of specifying the template to be assigned to each page?

There could even be a selected default template so only when one is specified will that default be overridden.

Maybe it is too much, but I just wanted to throw it out there 🙂

  • Like 4
Link to post
Share on other sites
6 hours ago, adrian said:

Given that no-one else has submitted any actions yet, I wonder whether you guys would prefer to maintain themselves in your own repos. Perhaps the best approach might be to add a list of 3rd party actions to the AdminActions Readme.

I think authors maintaining actions in their own repos is the way to go. I know from past experience that when tinkering around I often do several commits after I think I've done my "final commit" for a version as I spot little errors or think of new ideas. I wouldn't want to have to bother you or me with pull requests for these.

Having a list of third-party actions in the readme sounds like a good idea, but I have another idea too. I think it would be cool if we could leverage the power of the modules directory and ProcessWireUpgrade for actions, so users can see when updates are available and easily pull those updates in. So the idea is that each third-party action that extends ProcessAdminActions would have its own "pseudo-module" - a module file containing just the required getModuleInfo() method. So for my action above the module folder would look like this:

2018-09-22_103615.png.114dc4507b383d5458749d5e49e2a06c.png

And ActionUnorderedListToPages.module would consist of this:

<?php namespace ProcessWire;

class ActionUnorderedListToPages extends WireData implements Module {

    public static function getModuleInfo() {
        return array(
            'title' => 'Unordered List to Pages',
            'description' => 'Creates a structure of new pages from an unordered list.',
            'version' => '0.1.0',
            'author' => 'Robin Sallis',
            'href' => 'https://github.com/Toutouwai/ActionUnorderedListToPages',
            'extends' => 'ProcessAdminActions'
        );
    }

}

ProcessAdminActions would look for third-party actions like this...

$third_party_actions = $this->wire('modules')->findByInfo('extends=ProcessAdminActions');

...and then get the action by looking for an ".action.php" file in the module directory.

ProcessAdminActions could hopefully grab the action title/description from getModuleInfo() rather than this needing to be duplicated inside the action file (but no big deal if that wont fly).

So this would require coding some extra features in ProcessAdminActions but I think being able to use the modules directory would be really cool. And the exact details of how all this would work is up for discussion of course - this is just me brainstorming here. What do you think?

 

4 hours ago, adrian said:

what do you think about extending this to support pasting in an actual XML sitemap from an existing site?

I might be wrong but this sounds like it wouldn't work very reliably. Sitemaps generally just have the URL to the resource and that seems like it would problematic to parse into the desired page structure in many cases:

  • There is no page title in an XML sitemap so pages would have to use the slug name as page title, which may not be that close to the desired title - so potentially  requiring a lot of manual fixes later and not making the action much of a time-saver.
  • Many sites don't have the tidy connection between URL and page structure that PW has - worst are ones like /index.php?id=1234&view=detail&foo=bar. I'm not sure what the action would be able to do with this.
  • XML sitemaps often include entries for non-page resources such as PDF files.

If you think the XML sitemap idea can work I'm happy to be proved wrong. 🙂 Maybe you want to have a play around with it?

  • Like 4
Link to post
Share on other sites

Yeah, you might be right about the XML sitemap idea. I think for some sites it could be ok to convert slugs to titles etc, but obviously some would be less useful. I might still have a play on a rainy day though 🙂

I really love the idea of using the PW modules directory as a way to install these action pseudo modules. I'll make the adjustments to AdminActions to support this. Thanks for a great idea!

  • Like 3
Link to post
Share on other sites

Just a quick note to say that AdminActions now supports installable custom actions like @Robin S suggested above.

He has posted his new Unordered List to Pages action over here: 

If you have any ideas for custom actions, please take a look at Robin's example, but the key things to note is that you need to include a .module file named like:

There are two requirements:

  • The classname must start with "AdminActions"
  • It must have 'requires' => 'ProcessAdminActions'

This is the entire contents needed in a file named AdminActionsMySharedAction.module

class AdminActionsMySharedAction extends WireData implements Module {

    public static function getModuleInfo() {
        return array(
            'title' => 'Admin Actions My Shared Action',
            'summary' => 'My new action does really cool stuff',
            'version' => '0.1.0',
            'author' => 'John Doe',
            'href' => 'https://github.com/JohnDoe/AdminActionsMySharedAction',
            'requires' => 'ProcessAdminActions'
        );
    }

}

Once the module is installed on a site, AdminActions will detect it and allow users to configure and use it like any other action.

A big thanks to Robin for his ideas and significant feedback on getting this implemented!

  • Like 3
Link to post
Share on other sites

One more thing - the new version of Admin Actions now automatically "installs" new actions for superusers without needing to first visit the module settings page. 

Of course you can still go there to adjust the authorized roles and checking "In menu" if you want.

Thanks to Robin for pushing me to make this happen 🙂

  • Like 4
Link to post
Share on other sites

Just a quick not to mention that Admin Actions now supports two additional properties:

$executeButtonLabel
$icon

I am sure both are self-explanatory, especially when you see them in action.

I think both are useful additions for your custom actions.

 

 

  • Like 1
Link to post
Share on other sites

It's not a cache. I checked css file, no other site css file is loaded, just from wire and from the module itself. For the Core tab, it's .WireTabs top position in main-classic.css, and for the link it's div#links top position in ProcessAdminActions.css. I'm testing in Chrome. It's looking good in uikit and reno theme.

  • Like 1
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 monollonom
      (once again I was surprised to see a work of mine pop up in the newsletter, this time without even listing the module on PW modules website 😅. Thx @teppo !)
      Github: https://github.com/romaincazier/FieldtypeQRCode
      Modules directory: https://processwire.com/modules/fieldtype-qrcode/
      This is a simple module I made so a client could quickly grab a QR Code of the page's url in the admin.
      There's not much to it for now, but if need be you can output anything using a hook:
      $wire->addHookAfter("FieldtypeQRCode::getQRText", function($event) { $event->return = "Your custom text"; }) You can also output the QR code on your front-end by calling the field:
      echo $page->qr_code_field; The module uses the PHP library QR Code Generator by Kazuhiko Arase. When looking for a way to generate a QR Code in PW I came across @ryan's integration in his TFA module. I'm not very familiar with fieldtype/inputfield module development so I blindly followed @bernhard (great) tutorial and his BaseFieldtypeRuntime. At some point I'll take a deeper look to make a module on my own.
      Some ideas for improvements :
      add the ability to choose what to ouput : page's url / editUrl / file(s) / image(s) / ... allow to output multiple QR codes ?
    • By Chris Bennett
      https://github.com/chrisbennett-Bene/AdminThemeTweaker
      Inspired by @bernhard's excellent work on the new customisable LESS CSS getting rolled into the core soon, I thought I would offer up the module for beta testing, if it is of interest to anyone.

      It takes a different approach to admin styling, basically using the Cascade part of CSS to over-ride default UiKit values.
      Values are stored in ModuleConfig Module creates a separate AdminThemeTweaker Folder at root, so it can link to AdminThemeTweaker.php as CSS AdminThemeTweaker.php reads the module values, constructs the CSS variables then includes the CSS framework Can be switched on and off with a click. Uninstall removes everything, thanks to bernhard's wonderful remove dir & contents function.
      It won't touch your core. It won't care if stuff is upgraded. You won't need to compile anything and you don't need to touch CSS unless you want to.

      It won't do much at all apart from read some values from your module config, work out the right CSS variables to use (auto contrast based on selected backgrounds) and throw it on your screen.
      You can configure a lot of stuff, leave it as it comes (dark and curvy), change two main colors (background and content background) or delve deep to configure custom margins, height of mastheads, and all manner of silly stuff I never use.

      Have been developing it for somewhere around 2 years now. It has been (and will continue to be) constantly tweaked over that time, as I click on something and find something else to do.
      That said, it is pretty solid and has been in constant use as my sole Admin styling option for all of those 2 years.

      If nothing else, it would be great if it can provide any assistance to @bernhard or other contributor's who may be looking to solve some of the quirkier UiKit behavior.
      Has (in my opinion) more robust and predictable handling of hidden Inputfields, data-colwidths and showIf wrappers.
      I am very keen to help out with that stuff in any way I can, though LESS (and any css frameworks/tools basically) are not my go.
      I love CSS variables and banging-rocks-together, no-dependency CSS you can write with notepad.



       

    • By opalepatrick
      I see old posts saying that repeaters are not the way to go in Custom Process Modules. If that is the case, when using forms (as I am trying to do) how would one tackle things like repeat contact fields where there can be multiple requirements for contact details with different parameters? (Like point of contact, director, etc) or even telephone numbers that have different uses?
      Just for background I am creating a process module that allows me to create types of financial applications in the admin area (no need to publish any of this, pure admin) that require a lot of personal or company information.
      Maybe I am thinking about this incorrectly?
    • By HMCB
      I ran across a reference to IftRunner module. The post was 6 years ago. I cant find it in available modules. Has it been pulled?
    • By tcnet
      PageViewStatistic for ProcessWire is a module to log page visits of the CMS. The records including some basic information like IP-address, browser, operating system, requested page and originate page. Please note that this module doesn't claim to be the best or most accurate.
      Advantages
      One of the biggest advantage is that this module doesn't require any external service like Google Analytics or similar. You don't have to modify your templates either. There is also no Javascript or image required.
      Disadvantages
      There is only one disadvantage. This module doesn't record visits if the browser loads the page from its browser cache. To prevent the browser from loading the page from its cache, add the following meta tags to the header of your page:
      <meta http-equiv="Cache-Control" content="no-cache, no-store, must-revalidate" /> <meta http-equiv="Pragma" content="no-cache" /> <meta http-equiv="Expires" content="0" /> How to use
      The records can be accessed via the Setup-menu of the CMS backend. The first dropdown control changes the view mode.

      Detailed records
      View mode "Detailed records" shows all visits of the selected day individually with IP-address, browser, operating system, requested page and originate page. Click the update button to see new added records.

      Cached visitor records
      View modes other than "Detailed records" are cached visitor counts which will be collected on a daily basis from the detailed records. This procedure ensures a faster display even with a large number of data records. Another advantage is that the detailed records can be deleted while the cache remains. The cache can be updated manually or automatically in a specified time period. Multiple visits from the same IP address on the same day are counted as a single visitor.

      Upgrade from older versions
      Cached visitor counts is new in version 1.0.8. If you just upgraded from an older version you might expire a delay or even an error 500 if you display cached visitor counts. The reason for this is that the cache has to be created from the records. This can take longer if your database contains many records. Sometimes it might hit the maximally execution time. Don't worry about that and keep reloading the page until the cache is completely created.
      Special Feature
      PageViewStatistic for ProcessWire can record the time a visitor viewed the page. This feature is deactivated by default. To activate open the module configuration page and activate "Record view time". If activated you will find a new column "S." in the records which means the time of view in seconds. With every page request, a Javascript code is inserted directly after the <body> tag. Every time the visitor switches to another tab or closes the tab, this script reports the number of seconds the tab was visible. The initial page request is recorded only as a hyphen (-).

      Settings
      You can access the module settings by clicking the Configuration button at the bottom of the records page. The settings page is also available in the menu: Modules->Configure->ProcessPageViewStat.
      IP2Location
      This module uses the IP2Location database from: http://www.ip2location.com. This database is required to obtain the country from the IP address. IP2Location updates this database at the begin of every month. The settings of ProcessPageViewStat offers the ability to automatically download the database monthly. Please note, that automatically download will not work if your webspace doesn't allow allow_url_fopen.
      Dragscroll
      This module uses DragScroll. A JavaScript available from: http://github.com/asvd/dragscroll. Dragscroll adds the ability in view mode "Day" to drag the records horizontally with the mouse pointer.
      parseUserAgentStringClass
      This module uses the PHP class parseUserAgentStringClass available from: http://www.toms-world.org/blog/parseuseragentstring/. This class is required to filter out the browser type and operating system from the server request.
×
×
  • Create New...