Jump to content

Recommended Posts

I found the solution, I have to include the hook before the require in admin.php

Share this post


Link to post
Share on other sites

@zoeck I implemented modal editing for the collection panels. See the latest release. You can set the mode to modal or blank for edit or view links.

The modal auto-closes on page save and the panel reloads via AJAX when an edit modal closes.

/* Open edit links in modal, view links in new tab */

$panels->add([
  'panel' => 'collection',
  'data' => [
    'editMode' => 'modal',
    'viewMode' => 'blank',
  ],
]);

 

  • Like 2

Share this post


Link to post
Share on other sites
5 minutes ago, Jens Martsch - dotnetic said:

I found the solution, I have to include the hook before the require in admin.php

I could make that a bit more obvious in the documentation 🥂

  • Like 1

Share this post


Link to post
Share on other sites

It would also be nice, if you provide a complete copy and paste solution for the admin.php, so one could directly see a working example. This requires of course to install all submodules.

Share this post


Link to post
Share on other sites

Anyways, this is a really nice module. Thank you for releasing it.

Share this post


Link to post
Share on other sites

@gmclelland There's a few good ideas in there! I do have an at-a-glance/counter panel on the roadmap, but I'm not sure how to exactly build that since ProcessWire — as opposed to Wordpress — doesn't have any pre-configured content types, so I would have to make it a bit more configurable.

I also like the idea of having different tabs, although it's not a requirement I see many pages having. It should be relatively simple to implement, though (apart from the permissions stuff).

Share this post


Link to post
Share on other sites
6 minutes ago, Jens Martsch - dotnetic said:

It would also be nice, if you provide a complete copy and paste solution for the admin.php, so one could directly see a working example.

I'm planning on revamping the documentation at some point — split it into sub-pages and make it more navigable. Next on the list is an example section with code snippets for all panels, as you suggested.

  • Like 1

Share this post


Link to post
Share on other sites

It would also be nice, if I could add panels as an array of arrays (or objects) like

$panels->add([
        [
            'panel' => 'number',
            'title' => 'Neue Seiten',
            'data' => [
                'number' => 484,
                'detail' => '100 mehr als im vorigen Monat',
                'trend' => 'up',
            ]
        ],
        [

            'panel' => 'page-list',
            'title' => 'zuletzt bearbeitete Seiten',
            'data' => [
                'collection' => 'template=basic-page, limit=10',
                'sortable' => true,
            ],
        ]
    ]);

Right now, it seems, that I have to use $panels->add for every single panel, is that correct?

Share this post


Link to post
Share on other sites
7 minutes ago, Jens Martsch - dotnetic said:

Right now, it seems, that I have to use $panels->add for every single panel, is that correct?

i agree here with this – i actually tried to add an array of panels first before I realized you had to do each panel on a different call..

  • Like 1

Share this post


Link to post
Share on other sites
1 hour ago, Jens Martsch - dotnetic said:

Right now, it seems, that I have to use $panels->add for every single panel, is that correct?

@Jens Martsch - dotnetic @Macrura Correct. The problem here is that the config object is an array, and the outer array is also an array. There's no way of telling if it's a config array or a collection of config arrays without it getting ugly.

Luckily, WireArray has an import() method for that exact purpose. I added a release on GitHub that supports adding an array of panels via $panels->import([]);

  • Like 2

Share this post


Link to post
Share on other sites
4 hours ago, d'Hinnisdaël said:

I do have an at-a-glance/counter panel on the roadmap, but I'm not sure how to exactly build that since ProcessWire — as opposed to Wordpress — doesn't have any pre-configured content types, so I would have to make it a bit more configurable.

Couldn't you loop over all templates(excluding system templates) and use the template's name along with a count?

For example:

  • Basic Page (55)
  • Calendar Postings (77)
  • Job Postings (88)
  • community-event (55)  <- this one doesn't have a friendly template name, the others above do
  • Total Pages (400)

It would probably be helpful to show file information as well.  Like:

  • Documents (1,000)
  • Images (2,000)
  • Audio (30)
  • Videos (40)
  • Total Files (3,000)

The number of users would be helpful per role

  • Editors (20)
  • Contributors (25)
  • Vendors (22)
  • System Admins (2)
  • Total Users (60)

All of that would probably need to be cached so isn't too taxing on the server.  Maybe only displayed to admins as well?  I thought I remembered a module that already provides similar counts?  I can't remember the name. Maybe I'll remember it later?

  • Like 3

Share this post


Link to post
Share on other sites
15 hours ago, d'Hinnisdaël said:

@zoeck I implemented modal editing for the collection panels. See the latest release. You can set the mode to modal or blank for edit or view links.

The modal auto-closes on page save and the panel reloads via AJAX when an edit modal closes.


/* Open edit links in modal, view links in new tab */

$panels->add([
  'panel' => 'collection',
  'data' => [
    'editMode' => 'modal',
    'viewMode' => 'blank',
  ],
]);

 

This does not work directly, only after I have written the following code into the admin.php file

wire('modules')->get('JqueryUI')->use('modal');

But after that, it work likes a charm 😉 Thanks!

 

 

and I still have a few ideas for the PageList:

  • open collapsed
  • edit in modal, too 😉 

and one little design bug in the PageList:

  • showRootPage => false -> no margin/padding left/right/bottom

Share this post


Link to post
Share on other sites

@gmclelland I can see this getting a bit out of hand with a CMF like ProcessWire that doesn't set any boundaries on the shape content can take.

The most versatile solution would be to create an at-a-glance panel, but to rely on the programmer to supply the counts that are relevant to their site.

I can see the template and role counts working the way you suggested. Still, not all templates are meaningful units of content, e.g. a `country` template for populating forms is really not that interesting to site editors. The role naming / pluralization would only work in English here (e.g. vendor becomes Vendors), so there'd need to be a way of naming them in other languages.

The documents and images are a bit more complicated, however. ProcessWire doesn't have a central media or file library to get a count from. So you need to run a cronjob to scan the site for images across all pages. You'd also need to figure out which images are meaningful content (photos) and which are e.g. system-created QR codes for event invitations.

How do you count videos? I have a file field called videos, and a repeater field with a video_url field. There's no way of counting that without doing it yourself.

Don't get me wrong, I like the idea, but I don't think automating it is feasible or the right solution in ProcessWire. I'll be happy to be convinced otherwise 🌝

  • Like 1

Share this post


Link to post
Share on other sites
6 minutes ago, zoeck said:

This does not work directly, only after I have written the following code into the admin.php file


wire('modules')->get('JqueryUI')->use('modal');

Strange. I added that to the module itself and it only worked for me after I added it:

protected function includeModalScripts() {
  $this->modules->get('JqueryUI')->use('modal');
}

/* And then later */

if ($modal) {
  $this->includeModalScripts();
  $button->class .= ' pw-modal pw-modal-large';
}

 

Share this post


Link to post
Share on other sites
24 minutes ago, d'Hinnisdaël said:

Strange. I added that to the module itself and it only worked for me after I added it:


protected function includeModalScripts() {
  $this->modules->get('JqueryUI')->use('modal');
}

/* And then later */

if ($modal) {
  $this->includeModalScripts();
  $button->class .= ' pw-modal pw-modal-large';
}

 

You Added it to "renderButton" in the "DashboardPanel" Class, but the Modal is used in the "renderPageActions" Function in the "DashboardPanelCollection.module" (The renderButton/renderFooterButton isn't used in the Collection)

When you add "$this->includeModalScripts();" to "if (self::windowModeModal === $mode) {" (Line 300) it works 😄 

  • Like 2

Share this post


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

When you add "$this->includeModalScripts();" to "if (self::windowModeModal === $mode) {" (Line 300) it works 😄 

You're right of course 👽 I have a custom panel that already includes the modal script, so I never noticed. I pushed a fix that should work.

Thanks for debugging!

  • Like 3

Share this post


Link to post
Share on other sites

@zoeck Slow day in the office — I added the editMode and viewMode options to the PageList panel as well. See the latest release.

$panels->add([
  'panel' => 'page-list',
  'title' => 'Information',
  'data' => [
    'parent' => 'template=basic-page, name=info',
    'editMode' => 'modal',
    'viewMode' => 'blank',
  ],
]);

 

  • Like 2

Share this post


Link to post
Share on other sites

When I add 'editMode' => 'modal' to the collection panel, this pops up: PHP Notice: Undefined index: host in ...\Dashboard\DashboardPanel.class.php:329 Perhaps you could use isset? 

if (isset($info['host']))

When modal is closed, there is an error in the console: Uncaught ReferenceError: UIkit is not defined Dashboard.js?v=0.5.0-1579071638:2 Can't debug this as js is minified.

Share this post


Link to post
Share on other sites

I guess "Add dashboard page to user dropdown navigation" isn't supported in AdminThemeDefault?

Share this post


Link to post
Share on other sites
19 minutes ago, matjazp said:

I guess "Add dashboard page to user dropdown navigation" isn't supported in AdminThemeDefault?

I'm using the standard AdminThemeFramework::getUserNavArray hook. Looks like that's a newer addition and not available on default.

Any particular reason you're still using the default theme? I switched all of my client sites over to UiKit and I don't regret it. The old one looks so... old.

  • Like 3

Share this post


Link to post
Share on other sites

This is amazing. Going to try this one out this week. I’m excited to see google analytics in the road map. Keep up the great work!!!!!!

Share this post


Link to post
Share on other sites

Some encoding problems, this is how it looks when dashboard is empty:

Learn how to add and configure panels reading the <a href="https://github.com/philippdaun/processwire-dashboard" target="_blank">documentation</a>.

I guess documentation should be a link.

 

EDIT: I see now it's multilanguage issue, 

 

Edited by matjazp

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 robert
      I often had the need for an overview of all used fields and their contents for a specific page/template while developing new websites without switching to the backend, so I made a small module which lists all the needed information in a readable manner (at least for me):
      Debug Page Fields
      https://github.com/robertweiss/ProcessDebugPageFields
      It adds two new properties to all pages:
      $page->debugFieldValues – returns an object with all (sub-)fields, their labels, fieldtypes and values $page->debugFieldTypes – returns an object with all fieldtypes and their corresponding fields // List all values of a pages $page->debugFieldValues // List a specific field $page->debugFieldValues->fieldname // List all used fieldtypes of a page $page->debugFieldTypes I recommend using it in combination with Tracy Debugger, Ray, Xdebug etc. as it returns an object and is only meant for developing/debugging uses. 
      For now, the fieldtype support includes mostly fieldtypes I use in my projects, but can easily be extended by adding a new FieldtypeFIELDNAME method to the module. I use it with five different client installations (all PW 3.0.*), but of course there might be some (or more) field configurations which are not covered correctly yet.
      Supported fieldtypes
      Button Checkbox Color Combo Datetime Email FieldsetPage * File FontIconPicker Functional Image ImageReference MapMarker Multiplier Mystique Options Page PageIDs PageTitle Radio Repeater * RepeaterMatrix * RockAwesome SeoMaestro Table Text Textarea Textareas Toggle URL * The fields with complete subfield-support also list their corresponding subfields.
      Installation
      Download the zip file at Github or clone the repo into your site/modules directory. If you downloaded the zip file, extract it in your sites/modules directory. In your admin, go to Modules > Refresh, then Modules > New, then click on the Install button for this module. As this is my first ›public‹ module, I hope I did not miss any important things to mention here.
    • By horst
      Wire Mail SMTP

      An extension to the (new) WireMail base class that uses SMTP-transport

      This module integrates EmailMessage, SMTP and SASL php-libraries from Manuel Lemos into ProcessWire. I use this continously evolved libraries for about 10 years now and there was never a reason or occasion not to do so. I use it nearly every day in my office for automated composing and sending personalized messages with attachments, requests for Disposition Notifications, etc. Also I have used it for sending personalized Bulkmails many times.

      The WireMailSmtp module extends the new email-related WireMail base class introduced in ProcessWire 2.4.1 (while this writing, the dev-branch only).
       
      Here are Ryans announcement.



      Current Version 0.6.0
      Changelog: https://github.com/horst-n/WireMailSmtp/blob/master/CHANGELOG.md
      get it from the Modules Directory Install and Configure

      Download the module into your site/modules/ directory and install it.

      In the config page you fill in settings for the SMTP server and optionaly the (default) sender, like email address, name and signature.
      You can test the smtp settings directly there. If it says "SUCCESS! SMTP settings appear to work correctly." you are ready to start using it in templates, modules or bootstrap scripts.


      Usage Examples
      The simplest way to use it:
      $numSent = wireMail($to, $from, $subject, $textBody); $numSent = wireMail($to, '', $subject, $textBody); // or with a default sender emailaddress on config page This will send a plain text message to each recipient.
       
      You may also use the object oriented style:
      $mail = wireMail(); // calling an empty wireMail() returns a wireMail object $mail->to($toEmail, $toName); $mail->from = $yourEmailaddress; // if you don't have set a default sender in config // or if you want to override that $mail->subject($subject); $mail->body($textBody); $numSent = $mail->send(); Or chained, like everywhere in ProcessWire:
      $mail = wireMail(); $numSent = $mail->to($toEmail)->subject($subject)->body($textBody)->send(); Additionaly to the basics there are more options available with WireMailSmtp. The main difference compared to the WireMail BaseClass is the sendSingle option. With it you can set only one To-Recipient but additional CC-Recipients.
      $mail = wireMail(); $mail->sendSingle(true)->to($toEmail, $toName)->cc(array('person1@example.com', 'person2@example.com', 'person3@example.com')); $numSent = $mail->subject($subject)->body($textBody)->send(); The same as function call with options array:
      $options = array( 'sendSingle' => true, 'cc' => array('person1@example.com', 'person2@example.com', 'person3@example.com') ); $numSent = wireMail($to, '', $subject, $textBody, $options); There are methods to your disposal to check if you have the right WireMail-Class and if the SMTP-settings are working:
      $mail = wireMail(); if($mail->className != 'WireMailSmtp') { // Uups, wrong WireMail-Class: do something to inform the user and quit echo "<p>Couldn't get the right WireMail-Module (WireMailSmtp). found: {$mail->className}</p>"; return; } if(!$mail->testConnection()) { // Connection not working: echo "<p>Couldn't connect to the SMTP server. Please check the {$mail->className} modules config settings!</p>"; return; }  
      A MORE ADVANCED DEBUG METHOD!
      You can add some debug code into a template file and call a page with it:
      $to = array('me@example.com'); $subject = 'Wiremail-SMTP Test ' . date('H:i:s') . ' äöü ÄÖÜ ß'; $mail = wireMail(); if($mail->className != 'WireMailSmtp') { echo "<p>Couldn't get the right WireMail-Module (WireMailSmtp). found: {$mail->className}</p>"; } else { $mail->from = '--INSERT YOUR SENDER ADDRESS HERE --'; // <--- !!!! $mail->to($to); $mail->subject($subject); $mail->sendSingle(true); $mail->body("Titel\n\ntext text TEXT text text\n"); $mail->bodyHTML("<h1>Titel</h1><p>text text <strong>TEXT</strong> text text</p>"); $dump = $mail->debugSend(1); } So, in short, instead of using $mail->send(), use $mail->debugSend(1) to get output on a frontend testpage.
      The output is PRE formatted and contains the areas: SETTINGS, RESULT, ERRORS and a complete debuglog of the server connection, like this one:
       
      Following are a ...


      List of all options and features


      testConnection () - returns true on success, false on failures


      sendSingle ( true | false ) - default is false

      sendBulk ( true | false ) - default is false, Set this to true if you have lots of recipients (50+)


      to ($recipients) - one emailaddress or array with multiple emailaddresses

      cc ($recipients) - only available with mode sendSingle, one emailaddress or array with multiple emailaddresses

      bcc ($recipients) - one emailaddress or array with multiple emailaddresses

       
      from = 'person@example.com' - emailaddress, can be set in module config (called Sender Emailaddress) but it can be overwritten here

      fromName = 'Name Surname' - optional, can be set in module config (called Sender Name) but it can be overwritten here


      priority (3) - 1 = Highest | 2 = High | 3 = Normal | 4 = Low | 5 = Lowest

      dispositionNotification () or notification () - request a Disposition Notification


      subject ($subject) - subject of the message

      body ($textBody) - use this one alone to create and send plainText emailmessages

      bodyHTML ($htmlBody) - use this to create a Multipart Alternative Emailmessage (containing a HTML-Part and a Plaintext-Part as fallback)

      addSignature ( true | false ) - the default-behave is selectable in config screen, this can be overridden here
      (only available if a signature is defined in the config screen)

      attachment ($filename, $alternativeBasename = "") - add attachment file, optionally alternative basename


      send () - send the message(s) and return number of successful sent messages


      debugSend(1) - returns and / or outputs a (pre formatted) dump that contains the areas: SETTINGS, RESULT, ERRORS and a complete debuglog of the server connection. (See above the example code under ADVANCED DEBUG METHOD for further instructions!)


      getResult () - returns a dump (array) with all recipients (to, cc, bcc) and settings you have selected with the message, the message subject and body, and lists of successfull addresses and failed addresses,


      logActivity ($logmessage) - you may log success if you want

      logError ($logmessage) - you may log warnings, too. - Errors are logged automaticaly
       
       
      useSentLog (true | false) - intended for usage with e.g. third party newsletter modules - tells the send() method to make usage of the sentLog-methods - the following three sentLog methods are hookable, e.g. if you don't want log into files you may provide your own storage, or add additional functionality here

      sentLogReset ()  - starts a new LogSession - Best usage would be interactively once when setting up a new Newsletter

      sentLogGet ()  - is called automaticly within the send() method - returns an array containing all previously used emailaddresses

      sentLogAdd ($emailaddress)  - is called automaticly within the send() method
      Changelog: https://github.com/horst-n/WireMailSmtp/blob/master/CHANGELOG.md
       
       
    • By Cybermano
      Food Allergens Module
      A simple List of Food Allergens
      My needs were to provide a simple list of food allergens for our clients with restaurant related activity.
      The idea was to simply output the list (to speed up the data entry) without leaving the food menu editing, eg. opening another page in new tab or window.
      This isn't a perfect solution, but it works fine for my needs and I decided to share the base idea.
      This could also be easily used to show little notes or short "vademecum", not only for the list of food allergens.
      ---
      Main features
      The basis
      All moves from a short editing of the module in this tutorial: How to create custom admin pages by @bernhard
      First of all it creates an empty admin page, with a dedicated permission to let safe-user to see it (this permission has to be created as a new ones, manually or by the module).
      Once the page is created, I have hooked its behaviour into the ready.php, to show the content (basically a list).
      A step further
      With the tips of  @bernhard, @Soma (and many others), see here , the magic happens. 
      The new page will be shown as a panel, so editors will not abandon their data entry to have a quick view to the list.
      A little further
      Why scroll to the top of the page to click a link?
      The next step was to create a sticky button only in the food menu pages.
      Again with a @bernhard tip I moved into the customization of this simple module and the related hook.
      ---
      How to use this module
      After installed, it creates the page /admin/page/allergens/ and the module is to be setted up. The first field is a CKEditor with multi-language. This is the place where to write the informations that will be shown into the page. The next field is a simply text-area where to place a bit of JS that will be appended to the markup of the text (omit the 'script' tags). I also putted a checkbox with a silly statement: this to think at least twice on the safety of the written JS. Now comes the first way to display the link to the page
      Field Note with Link. Enable and save it. The module will display a new row with 4 selects (1 standard and 3 ASM):
      View mode (to show the page as Panel or as Modal PopUp); Templates to select: select one or more and save before proceed, so the  asm-select of the pages will be populated showing all the pages of the selected templates. Pages to select: also here select at least one and save before proceed to populate the asm-select for fields only with the ones that belong to the selected pages. Select the fields where to place the note and save again. That's all: now you will find into the notes of the selected fields the link "See the List of Allergens".
      At the same way, the option for the sticky button, but with a plus
      The field select is obviously unnecessary, but you could play with the last row: the inline styles to fix your sticky button where you like. Here you could set the sticky position of the <div> and the absolute ones of the <a>.

      Video Explanation
      In these screencasts you could see a custom JS that show a "copy" button near a "hanna-code" call.
      This because I've set a specific one for each allergen to show up a tooltip in the front end.

      Registrazione #33.mp4  

      Registrazione #34.mp4 ---
      Last but not the least
      Actually it works fine for my needs, even if it's much improvable: I'm working on the permissions creation, the uninstall section, a separate configs and defaults and how to include the hook into the module leaving free the ready.php. According to a simpler uninstall. Also I would make the link text as a dynamic text field, so it will be more flexible.
      I always learn a lot here, so I would share my code for whom it could be interested.
      I removed the hanna code references, but I provide you the html list of the allergens, English and Italian too, so you can paste them into the "source" of the CKEditor field to have a ready to use module.
      Obviously you are free to modify the code as per your needs.
      Please, keep in mind that I'm not a pro coder and I beg your pardon for my verbosity (speaking and coding). 😉
      I hope be helpful or for inspiration.
      Bye
      ready.phpList-ITA.htmlList-ENG.htmlAllergens.module
      README.md
    • By Robin S
      This module is sort of an upgrade to my earlier ImageToMarkdown module, and might be useful to anyone working with Markdown in ProcessWire.
      Copy Markdown
      Adds icons to images and files that allow you to copy a Markdown string to the clipboard. When you click the icon a message at the top left of the screen notifies you that the copying has occurred.
      Screencast

      Note: in the screencast an EasyMDE inputfield is used to preview the Markdown. It's not required to use EasyMDE - an ordinary textarea field could be used.
      Usage: Images
      When you hover on an item in an Images field an asterisk icon appears on the thumbnail. Click the icon to copy an image Markdown string to clipboard. If the "Description" field is populated it is used as the alt text.
      You can also open the "Variations" modal for an image and click the asterisk icon to copy an image Markdown string for an individual variation.
      Usage: Files
      When you hover on an item in a Files field an asterisk icon appears next to the filename. Click the icon to copy a link Markdown string to the clipboard. If the "Description" field is populated it is used as the link text, otherwise the filename is used.
       
      https://github.com/Toutouwai/CopyMarkdown
      https://processwire.com/modules/copy-markdown/
    • By BitPoet
      I've realized that I've been jumping back and forth between the PW API docs and the source code for site modules far too much. The idea to hold all necessary documentation locally in one place has occurred to me before, but getting PHPDocumentor et al set up and running reliably (and producing readable output) as always been too much of a hassle. Today I was asked how I find the right hooks and their arguments, and that inspired me to finally get my backside down on the chair and whip something up, namely the
      Module Api Doc Viewer
      ProcessModuleApiDoc
      It lets you browse the inline documentation and public (optionally also protected) class/method/property information for all modules, core classes and template files in the ProcessWire instance. The documentation is generated on the fly, so you don't have to remember to update your docs whenever you update a module.
      The module is quite fresh, so expect some bugs there. Behind the scenes it uses PHP-Parser together with a custom class that extracts the information I needed, and the core TextformatterMarkdownExtra module for rendering the description part in the phpdoc style comments.
      This is not a replacement / competitor to the API Viewer included in the commercial ProDevTools package. There is quite some information included in the inline documentation that my module can't (and won't) parse, but which makes up parts of the official ProcessWire API docs.
      This, instead, is a kind of Swiss army knife to view PHPDoc style information and get a quick class or function reference.
      If you feel daring and want to give it a spin, or if you just want to read a bit more, visit the module's GitHub repository.
      This is the overview page under "Setup" -> "Module API Docs":

      And this is what the documentation for an individual class looks like:

      The core module documentation can of course be found online, but it didn't make sense not to include them.
      Let me know what you think!

×
×
  • Create New...