Jump to content
adrian

Admin Actions

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

Share this post


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

Share this post


Link to post
Share on other sites

Just installed your module, because I wanted to copy the contents of a repeater matrix field from one page to another.

It does not seem to work for repeater matrix fields though.

Could you add that as an option?

Thanks!

Share this post


Link to post
Share on other sites

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

Share this post


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

Share this post


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

Share this post


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

Share this post


Link to post
Share on other sites

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

Share this post


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!

Share this post


Link to post
Share on other sites

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.

Share this post


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.

Share this post


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

Share this post


Link to post
Share on other sites

Actually creating separate action files which have hard-coded values will probably be the easiest and quickest; didn't think of that!

  • Like 2

Share this post


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.

Share this post


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

Share this post


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?

Share this post


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.

Share this post


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

Share this post


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.

Share this post


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 :)

Share this post


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.

Share this post


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

Share this post


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

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 d'Hinnisdaël
      Format Datetime fields as Carbon instances.
      You can find the latest release and the complete readme on Github.
      Installation
      composer require daun/datetime-carbon-format Usage
      All Datetime fields will now be formatted as Carbon instances instead of strings. Some examples:
      // $page->date is a Datetime field // Output format: j/n/Y echo $page->date; // 20/10/2020 echo $page->date->add('7 days'); // 27/10/2020 echo $page->date->format('l, F j'); // Monday, October 20 echo $page->date->year; // 2020 echo $page->date->diffForHumans(); // 28 minutes ago Frontend only
      The ProcessWire admin seems to expect datetime fields to be strings. This module will only return Carbon instances on frontend page views.
      Date output format
      When casting a Carbon instance to a string (usually when outputting the field in a template), the field's date output format will be respected.
      Links
      GitHub • Readme • Carbon docs
       
       
      PS. I remember reading about a Carbon module in a recent newsletter, but couldn't find it anywhere. Was that you, @bernhard?
    • By MoritzLost
      TrelloWire
      This is a module that allows you to automatically create Trello cards for ProcessWire pages and update them when the pages are updated. This allows you to setup connected workflows. Card properties and change handling behaviour can be customized through the extensive module configuration. Every action the module performs is hookable, so you can modify when and how cards are created as much as you need to. The module also contains an API-component that makes it easy to make requests to the Trello API and build your own connected ProcessWire-Trello workflows.
      Warning: This module requires ProcessWire 3.0.167 which is above the current stable master release at the moment.
      Features
      All the things the module can do for you without any custom code: Create a new card on Trello whenever a page is added or published (you can select applicable templates). Configure the target board, target list, name and description for new cards. Add default labels and checklists to the card. Update the card whenever the page is updated (optional). When the status of the card changes (published / unpublished, hidden / unhidden, trashed / restored or deleted), move the card to a different list or archive or delete it (configurable). You can extend this through hooks in many ways: Modifiy when and how cards are created. Modify the card properties (Target board & list, title, description, et c.) before they are sent to Trello. Create your own workflows by utilizing an API helper class with many convenient utility methods to access the Trello API directly. Feedback & Future Plans
      Let me know what you think! In particular:
      If you find any bugs report them here or on Github, I'll try to fix them. This module was born out of a use-case for a client project where we manage new form submissions through Trello. I'm not sure how many use-cases there are for this module. If you do use it, tell me about it! The Trello API is pretty extensive, I'll try to add some more helper methods to the TrelloWireApi class (let me know if you need anything in particular). I'll think about how the module can support different workflows that include Twig – talk to me if you have a use-case! Next steps could be a dashboard to manage pages that are connected to a Trello card, or a new section in the settings tab to manage the Trello connection. But it depends on whether there is any interest in this 🙂 Links
      Repository on Github Complete module documentation (getting started, configuration & API documentation) TrelloWire in the modules directory Module configuration

    • By David Karich
      ProcessWire InputfieldRepeaterMatrixDuplicate
      Thanks to the great ProModule "RepeaterMatrix" I have the possibility to create complex repeater items. With it I have created a quite powerful page builder. Many different content modules, with many more possible design options. The RepeaterMatrix module supports the cloning of items, but only within the same page. Now I often have the case that very design-intensive pages and items are created. If you want to use a content module on a different page (e.g. in the same design), you have to rebuild each item manually every time.
      This module extends the commercial ProModule "RepeaterMatrix" by the function to duplicate repeater items from one page to another page. The condition is that the target field is the same matrix field from which the item is duplicated. This module is currently understood as proof of concept. There are a few limitations that need to be considered. The intention of the module is that this functionality is integrated into the core of RepeaterMatrix and does not require an extra module.
      Check out the screencast
      What the module can do
      Duplicate multible repeater items from one page to another No matter how complex the item is Full support for file and image fields Multilingual support Support of Min and Max settings Live synchronization of clipboard between multiple browser tabs. Copy an item and simply switch the browser tab to the target page and you will immediately see the past button Support of multiple RepeaterMatrix fields on one page Configurable which roles and fields are excluded Configurable dialogs for copy and paste Duplicated items are automatically pasted to the end of the target field and set to hidden status so that changes are not directly published Automatic clipboard update when other items are picked Automatically removes old clipboard data if it is not pasted within 6 hours Delete clipboard itself by clicking the selected item again Benefit: unbelievably fast workflow and content replication What the module can't do
      Before an item can be duplicated in its current version, the source page must be saved. This means that if you make changes to an item and copy this, the old saved state will be duplicated Dynamic loading is currently not possible. Means no AJAX. When pasting, the target page is saved completely No support for nested repeater items. Currently only first level items can be duplicated. Means a repeater field in a repeater field cannot be duplicated. Workaround: simply duplicate the parent item Dynamic reloading and adding of repeater items cannot be registered. Several interfaces and events from the core are missing. The initialization occurs only once after the page load event Attention, please note!
      Nested repeaters cannot be supported technically. Therefore a check is made to prevent this. However, a nested repeater can only be detected if the field name ends for example with "_repeater1234". For example, if your MatrixRepeater field is named like this: "content_repeater" or "content_repeater123", this field is identified as nested and the module does not load. In version 2.0.1 the identification has been changed so that a field ending with the name repeater is only detected as nested if at least a two-digit number sequence follows. But to avoid this problem completely, make sure that your repeater matrix field does NOT end with the name "repeater".
      Changelog
       
      2.0.1
      Bug fix: Thanks to @ngrmm I could discover a bug which causes that the module cannot be loaded if the MatrixRepeater field ends with the name "repeater". The code was adjusted and information about the problem was provided 2.0.0
      Feature: Copy multiple items at once! The fundament for copying multiple items was created by @Autofahrn - THX! Feature: Optionally you can disable the copy and/or paste dialog Bug fix: A fix suggestion when additional and normal repeater fields are present was contributed by @joshua - THX! 1.0.4
      Bug fix: Various bug fixes and improvements in live synchronization Bug fix: Items are no longer inserted when the normal save button is clicked. Only when the past button is explicitly clicked Feature: Support of multiple repeater fields in one page Feature: Support of repeater Min/Max settings Feature: Configurable roles and fields Enhancement: Improved clipboard management Enhancement: Documentation improvement Enhancement: Corrected few typos #1 1.0.3
      Feature: Live synchronization Enhancement: Load the module only in the backend Enhancement: Documentation improvement 1.0.2
      Bug fix: Various bug fixes and improvements in JS functions Enhancement: Documentation improvement Enhancement: Corrected few typos 1.0.1
      Bug fix: Various bug fixes and improvements in the duplication process 1.0.0
      Initial release Support this module
      If this module is useful for you, I am very thankful for your small donation: Donate 5,- Euro (via PayPal – or an amount of your choice. Thank you!)
      Download this module (Version 2.0.1)
      > Github: https://github.com/FlipZoomMedia/InputfieldRepeaterMatrixDuplicate
      > PW module directory: https://modules.processwire.com/modules/inputfield-repeater-matrix-duplicate/
      > Old stable version (1.0.4): https://github.com/FlipZoomMedia/InputfieldRepeaterMatrixDuplicate/releases/tag/1.0.4
    • By picarica
      so i am trying to put CustomHooksForVariations.module, a custom module, i am placing it into site/modules direcotry yet my modules page in admin panel gives me errors
      so this is the screen show when i refresh modules, i dont know why the shole hook is written on top of the page :||

      and this next image is when i try to install it, i saw that it is not defiuned modules.php but it shouldnt need to be ?, any ways i dont want to edit site's core just to make one moulde work there has to be a way

    • By Robin S
      A new module that hasn't had a lot of testing yet. Please do your own testing before deploying on any production website.
      Custom Paths
      Allows any page to have a custom path/URL.
      Note: Custom Paths is incompatible with the core LanguageSupportPageNames module. I have no experience working with LanguageSupportPageNames or multi-language sites in general so I'm not in a position to work out if a fix is possible. If anyone with multi-language experience can contribute a fix it would be much appreciated!
      Screenshot

      Usage
      The module creates a field named custom_path on install. Add the custom_path field to the template of any page you want to set a custom path for. Whatever path is entered into this field determines the path and URL of the page ($page->path and $page->url). Page numbers and URL segments are supported if these are enabled for the template, and previous custom paths are managed by PagePathHistory if that module is installed.
      The custom_path field appears on the Settings tab in Page Edit by default but there is an option in the module configuration to disable this if you want to position the field among the other template fields.
      If the custom_path field is populated for a page it should be a path that is relative to the site root and that starts with a forward slash. The module prevents the same custom path being set for more than one page.
      The custom_path value takes precedence over any ProcessWire path. You can even override the Home page by setting a custom path of "/" for a page.
      It is highly recommended to set access controls on the custom_path field so that only privileged roles can edit it: superuser-only is recommended.
      It is up to the user to set and maintain suitable custom paths for any pages where the module is in use. Make sure your custom paths are compatible with ProcessWire's $config and .htaccess settings, and if you are basing the custom path on the names of parent pages you will probably want to have a strategy for updating custom paths if parent pages are renamed or moved.
      Example hooks to Pages::saveReady
      You might want to use a Pages::saveReady hook to automatically set the custom path for some pages. Below are a couple of examples.
      1. In this example the start of the custom path is fixed but the end of the path will update dynamically according to the name of the page:
      $pages->addHookAfter('saveReady', function(HookEvent $event) { $page = $event->arguments(0); if($page->template == 'my_template') { $page->custom_path = "/some-custom/path-segments/$page->name/"; } }); 2. The Custom Paths module adds a new Page::realPath method/property that can be used to get the "real" ProcessWire path to a page that might have a custom path set. In this example the custom path for news items is derived from the real ProcessWire path but a parent named "news-items" is removed:
      $pages->addHookAfter('saveReady', function(HookEvent $event) { $page = $event->arguments(0); if($page->template == 'news_item') { $page->custom_path = str_replace('/news-items/', '/', $page->realPath); } }); Caveats
      The custom paths will be used automatically for links created in CKEditor fields, but if you have the "link abstraction" option enabled for CKEditor fields (Details > Markup/HTML (Content Type) > HTML Options) then you will see notices from MarkupQA warning you that it is unable to resolve the links.
      Installation
      Install the Custom Paths module.
      Uninstallation
      The custom_path field is not automatically deleted when the module is uninstalled. You can delete it manually if the field is no longer needed.
       
      https://github.com/Toutouwai/CustomPaths
      https://modules.processwire.com/modules/custom-paths/
×
×
  • Create New...