Jump to content

Recommended Posts

4 hours ago, LuisM said:

Adding the panels and groups worked fine but I cant get the colors on the Pie Chart Panel to work. 
All I get is a Pie with grey segments 😞

Just had a look. Your syntax for the dataset options is off: you need the remove the outer array around backgroundColor. Then it works as expected.

'data' => [
  'datasets' => [
    [
      'data' => [
        floor($normalTotal),
        floor($recurringTotal)
      ],
      'backgroundColor' => [
        'rgba(193, 66, 66, 1)',
        'rgba(193, 66, 66, 1)'
      ]
    ]
  ]
]

You're right though about the default colors not being applied to pie charts. I pushed release v0.6.12 that fixes that.

  • Like 1

Share this post


Link to post
Share on other sites
On 3/1/2020 at 9:04 AM, Sevarf2 said:

Since we are in the matter, the actions on each page, like "lock", "unpub" or "trash"... don't work, I got an alert with "undefined"

I pushed release v0.6.13 which fixes the page list action buttons (unpublish, hide, etc.)

  • Like 2

Share this post


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

Just had a look. Your syntax for the dataset options is off: you need the remove the outer array around backgroundColor. Then it works as expected.


'data' => [
  'datasets' => [
    [
      'data' => [
        floor($normalTotal),
        floor($recurringTotal)
      ],
      'backgroundColor' => [
        'rgba(193, 66, 66, 1)',
        'rgba(193, 66, 66, 1)'
      ]
    ]
  ]
]

You're right though about the default colors not being applied to pie charts. I pushed release v0.6.12 that fixes that.

🤦‍♂️

thanks...

Share this post


Link to post
Share on other sites

Thank you for a very nice module.

I am using a panel-list like this:

   $panels->add([
        'panel' => 'collection',
        'title' => 'Clients',
        'data' => [
            'collection' => 'template=client, limit=10',
            'sortable' => true,
            'pagination' => true,
            'columns' => [
                'title' => 'Title',
                'url' => 'URL',
                'modified' => 'Modified'
            ]
        ]
    ]);

 

There are 50 client-pages, but the limits it to 10 records.

The pagination shows like this:

image.png.09a6b0b8a4b2f77e6bc2bff7d9d6fcb0.png

Is it possible to have the pagination show "forward" and "back" links to navigate to next 10 records?

 

 

Share this post


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

Is it possible to have the pagination show "forward" and "back" links to navigate to next 10 records?

Actual pagination buttons aren't implemented at the moment. That footer is meant to provide clarity for editors that there's more records than the ones currently displayed.

I'd consider the dashboard more a jumping-off point for editors than a replacement for other admin views better suited to browsing pages (like the page tree or listers). Ideally, they'd spend as little time as necessary on the dashboard and then go off to do whatever needs to get done in other parts of the admin.

While I'm pondering whether adding this is a good idea (it is a useful feature!), there's two options:

1. Create a copy of the included collection panel and give it a stab yourself. It shouldn't be too difficult — the module supports reloading panels via AJAX and provides the necessary JS events. Have a look at the documentation section on creating custom panels or crack open the chart panel to see an example. Let me know how it goes or if the module is missing anything to get this working.

2. There is a (currently) undocumented parameter you can supply to display a ›View All‹ button next to the pagination info. The parameter name is list and it takes a page, page ID or selector. If it's an admin page (ProcessLister), it will link to that page. If it's a content page (e.g. your Clients parent page), it will open the page tree at that page.

$panels->add([
  'panel' => 'collection',
  'title' => 'Clients',
  'data' => [
    'collection' => 'template=client, limit=10',
    'sortable' => true,
    'pagination' => true,
    'columns' => [
      'title' => 'Title',
      'url' => 'URL',
      'modified' => 'Modified',

      // Display "View All" button in footer
      'list' => 1184, // ID of lister page
    ]
  ]
]);

 

  • Like 1
  • Thanks 1

Share this post


Link to post
Share on other sites

Hi @d'Hinnisdaël , thanks for this module! I'm trying it out now and collecting a couple of suggestions. I have encountered two small-ish bugs so far:

On Firefox, I get a horizontal overflow in Firefox with the 'Shortcuts' panel in 'list' mode and 'small' size. Doesn't happen in Chrome.

1088570459_Screenshot2020-04-02at17_28_49.thumb.png.8f9dae1e3c7049083b3e6d0e550b89d7.png

The following CSS fixes it for me (even though I haven't checked if it has other unintended consequences yet):

.Dashboard__panel {
	max-width: 100%;
}

I'm also getting two warnings with the 'Collections' panel when I try to output some text from a Textareas field. Here's the input for the collection panel:

'columns' => [
  'title' => wire('fields')->get('title')->getLabel(),
  'c_campaign_parameters.utm_source' => 'Campaign source'
],

This results in warnings (even though the output still works):

1×    PHP Warning: class_parents(): Class InputfieldText does not exist and could not be loaded in .../FieldtypeTextareas.module:1071

1×    PHP Warning: in_array() expects parameter 2 to be array, bool given in .../FieldtypeTextareas.module:1072

I'm not sure if this is a bug in your module or in the Textareas field 🙂 Can you take a look? Thanks!

Share this post


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

On Firefox, I get a horizontal overflow in Firefox with the 'Shortcuts' panel in 'list' mode and 'small' size. Doesn't happen in Chrome.

Sure. Happy to merge your fix.

The other one seems to be an issue with the Textareas module. I hope 👽

The dashboard module uses PW's internal $page->getText() method to resolve the dot syntax field name:  $page->getText($markup, false, true) (where $markup would be 'c_campaign_parameters.utm_source') Haven't worked with the textarea module so far, but it either doesn't cast strings by default or it overwrites the getText method.

Suggested fix in your case: create a custom hook property that casts the textarea field into a string manually, and then use that property for display in the dashboard panel.

  • Like 1

Share this post


Link to post
Share on other sites

@d'Hinnisdaël Great, thanks for your support! I'll install the new version tomorrow, and I'll try your suggestions for the Textareas field 🙂

Share this post


Link to post
Share on other sites

Thanks for the update @d'Hinnisdaël, the new version fixes the issue 🙂

As for the warnings with the Textareas field, that was indeed a bug with the Textareas module. I fact, I encountered this bug a year ago and Ryan fixed it already. Now if only I'd remembered to actually use the updated module ... 😛 Thanks for your help!

Share this post


Link to post
Share on other sites

Hi @d'Hinnisdaël

First of all congrats to this beautiful module. I have some suggestions and remarks:

  1. The panels do not have proper dependencies set. All panels are installable (and throw an exception, when installed):
    UshLncZ.png
    IMHO the Dashboard master module should be the only installable module.
     
  2. https://philippdaun.github.io/processwire-dashboard/#/configuration?id=dashboard-as-entry-point
    Any reason why you chose this version over a module setting (eg checkbox) that adds a hook? 
    I was hoping that your way of doing it would solve the problem that when clicking "Save & Exit" one would be redirected to the dashboard. But still one gets to the page tree. This also happens when trashing a page. This is one thing annoying me for a long time, but I didn't try to find a solution for it yet. Maybe you can have a look, because imho when having a dashboard it's more likely that one wants to see the dashboard than the page tree 🙂 

    Edit: Just saw that changing the main admin page's process does at least help after trashing pages 🙂 I think I'll also redirect all user requests from the page tree to the dashboard...

     
  3. DashboardPanelChart uses jsdelivr CDN to load chart.js - this means that the panel will not work on offline applications (intranet). I think it would be better to ship chartjs with the module. This brings me to the next and more important point:
     
  4. Have you thought of making panels Inputfields?

 

The last point needs some more words 🙂 

I really wonder (not to say dislike) why you made the dasboard work on your own panel implementations rather than using regular PW Inputfields. Please don't take this as devaluation of your module, but after all it's just a ProcessModule like all the other admin pages (just really looking a lot better!).

I've created a very simple Inputfield and posted a thread in the tutorials section:

Take this screenshot of the Grid Dashboard demo:

XOnBJ8F.png

This is VERY similar to your Dashboard module - with the big difference that it is based on PW Inputfields that can be used everywhere in the PW ecosystem! Your panels can not. As I said your module does indeed look a lot better than a regular PW form. For example as far as I know grid spacing is not possible using InputfieldFieldset. Also the admin width settings are somewhat limited (see this old issue on github).

But this is my point: Instead of creating a new module that handles things in its own ways it would be a lot better to improve or extend the PW internal tools. This means we could either create nicer CSS for PW Inputfields (here the InputfieldFieldset) or we could create an Inputfield that wraps other inputfields in a Uikit grid (as Uikit is already on board). This approach would also make it possible to use the "panels" that you create for your dashboard in other places like PW page edit screens or in other ProcessModules.

I really like the look & feel of your panels, so it would be great to be able to use them all over the PW backend and not only in your module!

Thx for creating and sharing this - I hope you get my point and I'm looking forward to hearing what you think about converting panels to Inputfields 🙂 

  • Like 1

Share this post


Link to post
Share on other sites

Hi @bernhard, thanks for your feedback, really appreciated. There's a few things to unpack here:

Module dependencies

The panel modules need to inherit from an actual class from a separate PHP file which made things more difficult than I'd like to admit. So right now I'm happy it's working properly at all. I wouldn't dwell on this issue too long since all modules are within a single folder and the naming is quite obvious. Might revisit this in the future.

Exit on save

I'd always expect »Exit & Save« on a page edit form to get me back to the page tree, since that's the level above. I'm happy to make that configurable, though.

Admin home process

Can you think of a way to permanently and consistently re-route everything to the admin homepage instead of the page tree? And then still have the page tree clickable as a stand-alone view? That would be a better solution that the current one for sure. I've had a previous version that changes the admin parent's process manually and changes it back on uninstall, but that was buggy as hell and really scared me.

Asset CDN

Good point about the intranet. I'm really uncomfortable bundling dependencies in projects. There's something quite icky about it and using a CDN feels like sort of a happy middle ground, but your point is valid.

Panels as Inputfield

I get what you're saying about not re-inventing the wheel. I'm afraid I have to disagree here, though.

Input fields primarily serve the need to create complex forms, to arrange components for user input. In ProcessWire, it's become common to use them for everything under the sun since they're as close to a universal layout component as it gets. Might be a misnomer in hindsight, but I don't feel like every layout panel in the admin needs to be an input panel. It's useful for sure, but I don't see the need to have every container in the backend inherit from the base Inputfield class. They come with a lot of additional logic that doesn't apply to simple output panels, like the collapsing stuff and the conditional display logic.

For context, the initial version of the module was created the way you suggested, using ProcessWire's input fields and fieldsets. There was just no way to make them look nice and behave the way the module required. Laying them out in a grid with proper spacing and responsive sizing was plain horrible. You're not only fighting a hundred separate existing CSS rules for margins and outlines but ProcessWire's internal JS for collapsing/uncollapsing/calculating of field widths on top. One of the requirements for me was to have 'renderless' panels without border, background or margin to achieve floating panels for charts. Undoing all the internal inputfield styling just wasn't something I was comfortable spending my time on.

Out of curiosity: what's a possible scenario for re-using a dashboard panel in some other part of the admin?

 

 

  • Like 1

Share this post


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

Module dependencies

The panel modules need to inherit from an actual class from a separate PHP file which made things more difficult than I'd like to admit. So right now I'm happy it's working properly at all. I wouldn't dwell on this issue too long since all modules are within a single folder and the naming is quite obvious. Might revisit this in the future.

I've also had those problems, I know that it's not really straight forward and limiting sometimes...

2 hours ago, d'Hinnisdaël said:

Can you think of a way to permanently and consistently re-route everything to the admin homepage instead of the page tree? And then still have the page tree clickable as a stand-alone view? That would be a better solution that the current one for sure. I've had a previous version that changes the admin parent's process manually and changes it back on uninstall, but that was buggy as hell and really scared me.

At the moment I have this in place and need to test it over the next weeks 🙂

$this->addHookBefore('ProcessPageList::execute', $this, 'redirectPageList');

/**
 * Redirect all PageList requests to Dashboard
 */
public function redirectPageList(HookEvent $event) {
  if($this->config->ajax) return;
  if($this->page->id > 3) return;
  $this->session->redirect($this->pages->get('name=ear')->url);
}

Edit: Just added the page id check, then all requests to "pages" will be redirected but one can show the pagelist by going to "pages > tree" 🙂 

2 hours ago, d'Hinnisdaël said:

Panels as Inputfield

I get what you're saying about not re-inventing the wheel. I'm afraid I have to disagree here, though.

Input fields primarily serve the need to create complex forms, to arrange components for user input. In ProcessWire, it's become common to use them for everything under the sun since they're as close to a universal layout component as it gets. Might be a misnomer in hindsight, but I don't feel like every layout panel in the admin needs to be an input panel. It's useful for sure, but I don't see the need to have every container in the backend inherit from the base Inputfield class. They come with a lot of additional logic that doesn't apply to simple output panels, like the collapsing stuff and the conditional display logic.

I try to answer that by asking you a question 🙂 I have several custom Process Modules. They are great, because I can control where they live (menu) and who can see them (access control). How would I display one of your - I say it again - really nice looking dashboard panels in one of my modules?

2 hours ago, d'Hinnisdaël said:

For context, the initial version of the module was created the way you suggested, using ProcessWire's input fields and fieldsets. There was just no way to make them look nice and behave the way the module required. Laying them out in a grid with proper spacing and responsive sizing was plain horrible. You're not only fighting a hundred separate existing CSS rules for margins and outlines but ProcessWire's internal JS for collapsing/uncollapsing/calculating of field widths on top. One of the requirements for me was to have 'renderless' panels without border, background or margin to achieve floating panels for charts. Undoing all the internal inputfield styling just wasn't something I was comfortable spending my time on.

I've just added a commit to my example module: https://github.com/BernhardBaumrock/InputfieldChartDemo/commit/3efa4bd8355bfe6e7499254cad58e70d3f283147

jjY8vlE.png

US8picG.gif

IMHO this is really close to what you built on your dashboard (at least as far as I understood it until now), but it uses PW core features and only a little extra markup: https://github.com/BernhardBaumrock/InputfieldChartDemo/blob/3efa4bd8355bfe6e7499254cad58e70d3f283147/ProcessInputfieldChartDemo.module.php#L139-L146

I agree that it is not the nicest thing to layout pages using InputfieldForm elements, but I think it would be the better way to push PW in that regard than creating custom solutions. We all know the benefits of using existing components:

  • showIf would work out of the box
  • collapsing works out of the box (ajax loading fields)
  • development is the same for dashboard panels and regular inputfields
  • panels can be used everywhere
  • styling applies automatically (imagine a custom admin theme using your dashboard panel...

To name just a few 🙂 What I mean is for example we could have something like InputfieldGrid that could work like this:

$grid = $modules->get('InputfieldGrid');
$grid->addColumn([
  'class' => 'uk-width-1-4@m',
  'children' => [
    [
      'type' => 'markup',
      'label' => 'one foo',
      'value' => 'one bar',
    ],[
      'type' => 'markup',
      'label' => 'one foo',
      'value' => 'one bar',
    ],
  ],
]);
$grid->addColumn([
  'class' => 'uk-width-3-4@m',
  'children' => [
    [
      'type' => 'markup',
      'label' => 'two foo',
      'value' => 'two bar',
    ],[
      'type' => 'markup',
      'label' => 'two foo',
      'value' => 'two bar',
    ],
  ],
]);
$grid->render();

That would be really easy to build and could - same as everything else - also be used on page edit screens etc.

 

2 hours ago, d'Hinnisdaël said:

Out of curiosity: what's a possible scenario for re-using a dashboard panel in some other part of the admin?

Scenario from todays work: I'm building a custom CRM for myself where I manage invoices and documents. After import they get flagged as TODO. Then I see them on the Dashboard:

f4mMgkY.png

When editing one of those pages I have basically the same Inputfield showing a list of all other todos:

UtnZYFf.png

 

Share this post


Link to post
Share on other sites
On 4/3/2020 at 11:59 AM, bernhard said:

I was hoping that your way of doing it would solve the problem that when clicking "Save & Exit" one would be redirected to the dashboard. But still one gets to the page tree. This also happens when trashing a page. This is one thing annoying me for a long time, but I didn't try to find a solution for it yet.

You can use a hook to redirect after "Save & Exit":

// the hook in a location like _init.php or in a module's init function
$this->addHookBefore('ProcessPageEdit::processSaveRedirect', $this, 'redirectAfterSave');

/**
   * redirects to the main ListerPro "Raumdatenblätter" after saving a page with template raum
   * @param HookEvent $event
   * @throws WireException
   * @throws WirePermissionException
   */
  public function redirectAfterSave(HookEvent $event)
  {
    $url = $event->arguments(0);
    $page = $event->object->getPage();
    if ($page->template == "raum" && !$page->isTrash()) {
      if ($url == "../") {
        $goto = wire("pages")->get('/raumdatenblatt/raumdatenblaetter/')->url;
        $event->arguments = array($goto);
      }
    }
  }

 

  • Like 2

Share this post


Link to post
Share on other sites

There is also a config setting for the adminRootPageID, but I would not recommend to change it, as a config comment states: "Values in this section are not meant to be changed". And some modules even use this setting, to find a subpage, for example PageLister Pro, which then would not work as expected anymore:

$admin = $this->wire('pages')->get($this->wire('config')->adminRootPageID);
$parent = $admin->child('name=page, include=all');

 

Share this post


Link to post
Share on other sites
22 hours ago, bernhard said:

At the moment I have this in place and need to test it over the next weeks 🙂

  Looks great! Let me know how it's faring and I'm happy to use that instead of the page's process setting.

22 hours ago, bernhard said:

I agree that it is not the nicest thing to layout pages using InputfieldForm elements, but I think it would be the better way to push PW in that regard than creating custom solutions. We all know the benefits of using existing components.

You're doing a good job convincing me here. It does make sense conceptually and thinking about the module ecosystem as a whole. That said, the module is currently at a point where I'm not missing much in terms of functionality and am not that keen on re-writing the whole output layer with no new features to show for it. And it's not like I have the time, with everybody currently wanting to expand their online stores... If anything, I'd put that on the list for version 1.0 as a summer/fall project since it'd be a breaking change either way. If you definitely need this and need it soon, I'm happy to accept a pull request.

Quote

How would I display one of your - I say it again - really nice looking dashboard panels in one of my modules?

But why would you want to re-use a dashboard panel in another module? That doesn't make sense to me. The way I see a dashboard working is the other way around: it displays a condensed form of information found elsewhere, e.g. shortcuts from all possible admin views, a single chart from a whole host of data, the most recent news pages from a whole archive of them, and so on. If anything, you'd re-use a fieldset from one of your modules in the dashboard. Using markup from an existing module in a dashboard panel is working just fine — with the exception of granular access control and conditional visibility. Which to me seem minor but might be a deal-breaker for more corporate-y types of applications.

  • Like 2

Share this post


Link to post
Share on other sites

Would you consider adding an insert action to the collection panel?  That way people can add children?

I love this! Thank you for releasing it!

Share this post


Link to post
Share on other sites
23 hours ago, joer80 said:

Would you consider adding an insert action to the collection panel?  That way people can add children?

The collection panel does allow for an ›Add New‹ button. It's just not documented at the moment.

You can either specify the child page's template or the parent page and it'll figure it out. For the template option to work, the child template must have a default parent defined. This should work:

$panels->add([
  'panel' => 'collection',
  'title' => 'Widgets',
  'data' => [
    'collection' => 'template=widget, limit=6',

    // Option A: Add to child template's defined parent page
    'template' => 'widget',

    // Option B: Add to specific parent page (page, ID or selector)
    'parent' => 'template=widget-list',
  ]
]);

 

  • Like 2

Share this post


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

The collection panel does allow for an ›Add New‹ button. It's just not documented at the moment.

You can either specify the child page's template or the parent page and it'll figure it out. For the template option to work, the child template must have a default parent defined. This should work:


$panels->add([
  'panel' => 'collection',
  'title' => 'Widgets',
  'data' => [
    'collection' => 'template=widget, limit=6',

    // Option A: Add to child template's defined parent page
    'template' => 'widget',

    // Option B: Add to specific parent page (page, ID or selector)
    'parent' => 'template=widget-list',
  ]
]);

 

This is great!

Thanks!

Share this post


Link to post
Share on other sites

This is a nice module and I've added a number of panels successfully. However, I have a problem with the chart panel. My code is below (the data is just a test and will be replaced by integer variables):

    $reports->add([
        'panel' => 'chart',
        'title' => 'Contact bookings for ' . $property->title,
        'data' => [
            'chart' => [
                'type' => 'bar',
                'data' => [
                    'labels' => [4, 6],
                    'datasets' => [
                        'label' => 'count',
                        'data' => [1, 1],
                    ],
                ],
            ],
        ]
    ]);

I get a js error: 

DashboardPanelChart.js?v=0.6.14:121 Uncaught TypeError: e.data.datasets.forEach is not a function
    at Object.beforeUpdate (DashboardPanelChart.js?v=0.6.14:121)
    at Object.notify (chart.js@2.9.3:7)
    at Qe.update (chart.js@2.9.3:7)
    at Qe.construct (chart.js@2.9.3:7)
    at new Qe (chart.js@2.9.3:7)
    at n (DashboardPanelChart.js?v=0.6.14:123)
    at HTMLCanvasElement.<anonymous> (DashboardPanelChart.js?v=0.6.14:123)
    at Function.each (JqueryCore.js?v=1585265024:2)
    at init.each (JqueryCore.js?v=1585265024:2)
    at c (DashboardPanelChart.js?v=0.6.14:123)

 

Share this post


Link to post
Share on other sites
11 hours ago, MarkE said:

However, I have a problem with the chart panel. My code is below (the data is just a test and will be replaced by integer variables)

Chart.js expects an array at datasets, even if you just use a single one. It'll work once you wrap that in brackets again.

  • Like 1

Share this post


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

Chart.js expects an array at datasets, even if you just use a single one.

Many thanks - didn't spot that!

Share this post


Link to post
Share on other sites

Hi @d'Hinnisdaël, I have a couple more suggestions for the Shortcuts & Collection panels, hope you don't mind 🙂

Shortcuts: Warnings with array syntax
The documentation suggests this syntax for a shortcut with a custom icon (but without a summary):
[304, 'user'],                 // Override icon
This currently throws a warning because of this line which expects three array elements. Here's a quick fix to allow passing only the title, or the title and an icon:

list($shortcut, $icon, $summary) = array_pad($shortcut, 3, '');

Shortcuts: Summary should be removable
I would like to see an panel-wide option to not display a summary for any of the shortcuts. Currently the only way to remove the summary is to use the array syntax (see above). At least for my use-case, I don't really need the summaries and the default summaries are at best confusing, so I need to use the array syntax for every item.

Collection: Default to field label for headlines
Almost all the column definitions in my collection panel look like this:

'title' => wire('fields')->get('title')->getLabel(),

This is a minor nitpick and I appreciate the option to set a custom headline, but I feel like in most cases the field label (of the field the column displays) would be a sensible default for the headline. I think it would be a good idea to support a field-only syntax for the columns, where I only need to specificy a field and the headline gets automatically populated with the field label.

Again, thanks for the great module!

Share this post


Link to post
Share on other sites
On 5/4/2020 at 5:08 PM, MoritzLost said:

Hi @d'Hinnisdaël, I have a couple more suggestions for the Shortcuts & Collection panels, hope you don't mind 🙂

All of these are good points, actually. I'm surprised I missed the default field label thing, since it's kind of the standard behavior in most core modules and especially useful in multi-language environments. I'm currently short on time, but will tackle these as soon as things settle down.

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