Jump to content

Recommended Posts

Hi @adrian,

Have you given any thought to the idea of making some of your modules PW3-only?

For most modules I think it's nice to keep PW2 support (I have been doing that for my modules so far) but in the case of Admin Actions where the idea is that users can code their own actions it would be good to be able to declare the ProcessWire namespace in the action files, for the sake of code completion and avoiding false code warnings in an IDE.

I could add the namespace to ProcessAdminActions.module manually (to avoid fatal PHP errors), but then it will get lost when the module is upgraded.

This isn't a big issue and I can just comment out the namespace declaration in my action files after I've finished working on them. Just thought I'd ask for your view on things.

  • Like 1
Link to post
Share on other sites
5 hours ago, Robin S said:

Have you given any thought to the idea of making some of your modules PW3-only?

Not yet - I haven't come across any issues that the file compiler (or some small minor conditional) doesn't take care of.

Not sure I am ready to ditch 2.x support just yet, but I'll definitely keep in mind your argument re this module.

Maybe I should just ask here - anyone using this module on 2.x? Would anyone mind if it was made 3.x only?

 

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

Hi @OllieMackJames - I'm afraid I don't have the time to do this at the moment, but I am sure you can extend the "Copy Repeater Items to Other Page" action to support RepeaterMatrix fields - probably just a matter of another loop. If you make those changes, I'd really appreciate a PR :)

Let me know if you have any questions.

  • Like 1
Link to post
Share on other sites

@adrian, I created a pull request for adding support for Repeater Matrix to the "Copy Repeater Items to Other Page" action.

It only required a small modification to the field select options so I thought it best to keep this within the existing action rather than create a new action just for copying Repeater Matrix fields. I thought about allowing all fieldtypes that extend FieldtypeRepeater but decided it would be better to add fieldtypes on a case-by-case basis just in case someone has a custom fieldtype that extends FieldtypeRepeater in some weird and wonderful way that wouldn't be compatible with the action.

I also added a couple of other enhancements to the action - failure conditions for if the selected repeater field doesn't exist on the source or destination pages (previously the action reported a success in those cases). And copying repeater items now also copies any files or images included in the repeater items.

One last thing I added, to the module itself this time, is a link to the module config settings in the notice that advises that new actions are available.

I think it would also be handy to have a link the config settings in the process page - I often want to jump there to adjust allowed roles and the "in menu" option. I didn't include this in the pull request though - just something for you to consider.

  • Like 4
Link to post
Share on other sites

Thanks @Robin S - looks like it is was much easier than I expected.

I also added your request for a link to the module settings from the Process page.

Really appreciate all the other tweaks and fixes - mucho appreciado!

Thanks again!

  • Like 3
Link to post
Share on other sites

@Robin S wow! @adrian thanks for your answer.

I feel privileged to stand on the shoulders of all you coding giants.

I am just a user who runs into stuff and here I am within a day this wonderful community makes things happen.

What I am doing with my sites would not be possible without you coding giants.

So processwire coding giants, hats off to all of you and a big heartfelt thanks.

To all processwire coding giants: may your days be blessed with incredible coding insights that make things happen for all  of your personal and business endeavors and may this result in joy and whatever results you wish for in your lives!

THANKS!!!

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

Hello

Suggestion for a new one if anyone thinks it would be useful : change values of a checkbox.

For now, unless I'm wrong, only text fields could be setORreplace.

Thanks!!

Hi @mel47 - contributions are very welcome!

Link to post
Share on other sites
  • 4 weeks later...

I did a search to see if this had been requested before. If it has sorry, for double posting, but I was wondering whether it would be possible to save actions. For instance with the EmailBatcher, I might want certain fields to always be the same and not have to fill them in each time I run the action.

Link to post
Share on other sites

I want to update the Email Batcher action to use pageListSelect instead of selector. Everything seems to work fine in that when I choose my page, the email field then shows the email field attached to the template I've chosen but on submission I get "The Email Batcher action was completed successfully" and no emails sent, whereas if I use 'type' => 'selector' I get "X emails were sent successfully" and the emails are received.

What else do I need to do to be able to use pageListSelect?

Edited by kongondo
Moved post here to the module's support forum. Also, please, no double posting.
Link to post
Share on other sites
2 hours ago, Tyssen said:

I did a search to see if this had been requested before. If it has sorry, for double posting, but I was wondering whether it would be possible to save actions. For instance with the EmailBatcher, I might want certain fields to always be the same and not have to fill them in each time I run the action.

Not quite sure how a save feature would work at the moment without a significant change to the interface. One possibility might be to store the last used options in a cookie and load those again if available. Would that suit your needs, or do you want something more permanent?

If we can come up with an approach that works, I'd be happy to implement at some point though - any thoughts?

The quickest option for you might be to simply clone the action into /site/templates/AdminActions and edit the defineOptions() method to hardcode the values you need. Or you could remove that method entirely and hardcode them into the executeAction() method so you wouldn't even get the option to change anything - this would be a good option if you have site editors using this - prevents them from breaking anything. Let me know if this works for your needs and if you need any help implementing.

  • Like 1
Link to post
Share on other sites
19 hours ago, Tyssen said:

Edited 11 hours ago by kongondo
Moved post here to the module's support forum. Also, please, no double posting.

Sorry, whenever I've posted similar questions on other forums, I've always been told to not hijack threads and to start new ones.

Link to post
Share on other sites
7 minutes ago, Tyssen said:

Sorry, whenever I've posted similar questions on other forums, I've always been told to not hijack threads and to start new ones.

No worries. I get your point . In this case, though, the module in question has its own support forum, hence, all questions regarding it should be directed to its support forum.

Edit: I think our forum guidelines could be clearer in this regard, though. I'll have a word with the other mods.

Edited by kongondo
  • Like 1
Link to post
Share on other sites
19 hours ago, Tyssen said:

What else do I need to do to be able to use pageListSelect?

Thanks @kongondo for moving here - I wouldn't have seen that post otherwise!

@Tyssen - I just changed the email batcher to use pageListSelect and the email came through just fine. Not sure what might have gone wrong, but can you try again please?

If it still doesn't work, then you should try to debug the executeAction() method in that action to see if the recipients are being populated correctly. 

I would ask though how you are using this because a single page with one email field will only have one recipient - I don't really understand your use case - can you explain in a little more detail how a single selected page can work for your needs?

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

I would ask though how you are using this because a single page with one email field will only have one recipient - I don't really understand your use case - can you explain in a little more detail how a single selected page can work for your needs?

That's where I'm going wrong then. I'm choosing the parent page and assuming that it was going to work in the same way as it does when using selector, i.e. selecting all the parent's children. Not sure why it shows the email field though as there is no email field attached to the parent's template.

The reason I want to use pageListSelect is because even though this module is aimed at site admins, I'm hoping I can use the Batch Emailer at least for users with restricted access so that they can batch send emails to people assigned to pages that they can manage, and a pageListSelect is going to be more user-friendly for the less tech-savvy than them trying to work out what the page ID is etc.

Link to post
Share on other sites

@Tyssen - using a selector doesn't select the parent's children, it selects whatever matches. If you choose a "parent" selector then that's what you'll get, but it's not automatically behavior to get the children of a single selected page. 

The email field is shown because that dropdown just shows all defined email fields on the site - it's not limiting to the ones on a specific template. Remember that with the page selector approach we could be sending to pages with different templates.

Yes, it is meant as more of a site administrator tool, but you could easily make it simpler by cloning this and placing in /site/templates/AdminActions - just adjust this line:

            $recipients = $this->wire('pages')->find($options['pages']);

to:

            $recipients = $this->wire('pages')->find($options['pages'])->children();

and you'll get the children of the selected page.

You might also want to remove the email field from the options phase, and maybe also the Roles option. 

Basically pare it down to the bare minimum of options that your users will need - does that make sense?

Remember that AdminActions is more about the interface it provides for building and presenting an admin interface than the actual core actions that come with it. It's a tool to make your development of custom admin actions really easy - go forward and conquer :)

  • Like 2
Link to post
Share on other sites

I've decided to just use a select fieldtype for choosing the pages and pass in some options so that it starts from a certain parent (using pageListSelect means showing the whole tree which is overkill). But I'm having trouble with the sending of emails. This is what I have so far:

<?php

class EmailBatcherCoordinator extends ProcessAdminActions {

    protected function defineOptions() {

        $pagesOptions = array();
        foreach($this->wire('pages')->get(3767)->children() as $age) $pagesOptions[$age->id] = $age->name;

        return array(
            array(
                'name' => 'from',
                'label' => 'Who is sending',
                'description' => '',
                'notes' => '',
                'type' => 'email',
                'type' => 'select',
                'options' => array(
                    'user1@email.com'=>'User 1',
                    'user2@email.com'=>'User 2',
                ),
            ),
            array(
                'name' => 'pages',
                'label' => 'Pages',
                'description' => 'Select the parent of pages that contain the recipients\' email addresses.',
                'notes' => '',
                'type' => 'select',
                'options' => $pagesOptions,
                'columnWidth' => 50,
            ),
            // All the other options are the same
        );
    }

    protected function executeAction($options) {

        if($options['testAddress']) $testAddress = $options['testAddress'];

        $recipients = $this->wire('pages')->find($options['pages'])->children();
        $emailField = $options['email'];
        print_r($recipients);

        $i = 1;
        foreach($recipients as $recipient) {
            if(isset($testAddress)) {
                // if a test email, then only send first match from selected Pages or Users Roles
                if(isset($testAddress) && $i > 1) break;
                $toEmail = $testAddress;
            }
            else {
                $toEmail = isset($emailField) ? $recipient->$emailField : $recipient;
            }
            print_r($toEmail);

            //replace curly braces codes with matching PW field names
            $htmlBody = $options['body'];
            $htmlBody = $this->parseBody($htmlBody, $options['fromEmail'], $recipient);

            $sent = $this->sendNewUserEmail($toEmail, $options['from'], $options['from'], $options['subject'], $htmlBody);
            if($sent) {
                $this->successMessage = $i . ' email successfully sent.';
            }
            else {
                $this->failureMessage = 'Sorry, no emails could be sent.';
            }
            $i++;
        }
        return true;
    }

	// Everything else is the same
}

So essentially all I've done so far is change how the $recipients are selected and change the from values in sendNewUserEmail to come from a dropdown rather than text inputs. Everything else is the same.

When I print $recipients, it shows the correct child pages but $toEmail prints as NULL and no email gets sent and the success message is The Email Batcher action was completed successfully instead of X emails sent.

Link to post
Share on other sites

Hey @Tyssen - please install Tracy Debugger - there are several notices that will indicate to you what the problems are. The key one is:

PHP Notice: Undefined index: email in .../AdminActions/EmailBatcherCoordinator.action.php:42

but there are several others. Once you go through those I am sure you'll be able to get it working :)

Link to post
Share on other sites

I've got Tracy installed. Which tab are you seeing that error on? I'm seeing several relating to FileCompiler but they're not restricted to Admin Actions and one from Mailgun because the to parameter is incorrect.

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

I've got Tracy installed. Which tab are you seeing that error on? I'm seeing several relating to FileCompiler but they're not restricted to Admin Actions and one from Mailgun because the to parameter is incorrect.

image.png.523e239774165dbe35615d506ad02040.png

Link to post
Share on other sites

If you pasted the code I posted above into an action to test, it's probably because I removed all the bits I didn't change to make it shorter and easier to read. I added comments where I'd taken stuff out. So testAddress, email, body, etc. all exist in my version of the action.

I had missed one $options['fromEmail'] which I've now changed to $options['from'] but other than I'm not getting any other errors.

I've attached the action file if it helps.

EmailBatcherCoordinator.action.php

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