Enhanced ToDo List Admin Widget

[brian!]

the idea for this widget was started in the feedback thread below, but rather than hijack that thread with this project, it was easier to start a new thread in Third Party Addons.

this "Enhanced ToDo List" admin widget, expands on the default widget by showing client names (or Company Name), service details (name/domain) and domain names as mouseover tooltips (I could put them in the body, but then space might become an issue)...

for those that want to use this widget, i've attached it to this post - simply upload to /modules/widgets and the next time you go to the admin homepage, it should be there (assuming your admin role allows viewing of the ToDo List).

i've called the file "EnhancedToDo.php", so you'll end up with two ToDo widgets on your homepage, just disable the default one using the Show/Hide widgets option top right... I could have called it ToDo.php, but then the WHMCS auto-updater would have overwritten it during the next update - so it's easier to keep it separate until WHMCS improve how they handle ToDo's.

it's written for WHMCS v7.6, but will work on v7.5.x too... it might work on earlier v7 versions, but I haven't tested it on them - there is a WHMCS version check inside the widget that chooses FontAwesome 5 icons if using v7.6 or later, or FA4 if using an earlier WHMCS version.

if you spot any ToDo's that don't behave correctly (e.g a third-party addon might add a ToDo that doesn't follow the WHMCS convention), then feel free to reply about it (or PM me) - it shouldn't break the output, it will likely just not show the icon(s) for that ToDo.

EnhancedToDo.php

Edited June 19, 2019 by brian!

[Nicky]

Thanks for this. Any idea how to make it sort by due date, rather than date created?

[PixieLinxie]

Hi @brian!

I tried downloaded the EnhancedToDo php, however it appears it is either no longer available for download, or I do not have sufficient permissions to download the file.

Is it still available for download? This is exactly what I need for our addons.

I am currently using a customized ticket hook (downloaded) but would ideally like to create a To Do item instead.

I'm not a developer so have no idea how to go about creating something like this LOL

[brian!]

Hi @PixieLinxie

14 hours ago, PixieLinxie said:

I tried downloaded the EnhancedToDo php, however it appears it is either no longer available for download, or I do not have sufficient permissions to download the file.

Is it still available for download? This is exactly what I need for our addons. 

i've just uploaded the file again - can you try the link to see if it works now...

[PixieLinxie]

1 hour ago, brian! said:

Hi @PixieLinxie

i've just uploaded the file again - can you try the link to see if it works now...

Fantastic! It's works now. Thank you very much 🙂

[m8internet]

On 4/30/2019 at 5:43 AM, Nicky said:

Thanks for this. Any idea how to make it sort by due date, rather than date created?

I too have downloaded this to compare
However in 8.0.4 it looks identical
 

When I amend the line to
$toDo = Capsule::table('tbltodolist')->whereIn('status', ['Incomplete', 'New', 'Pending'])->orderBy('duedate', 'asc')->take(11)->get();
All I get is 
No Incomplete Items
Add To Do Item

[brian!]

5 hours ago, m8internet said:

I too have downloaded this to compare
However in 8.0.4 it looks identical

they won't be identical, but similar - the difference should be the icon to show which domain/service it is referencing...

and you would never need to enable both widgets - only one of them.

5 hours ago, m8internet said:

When I amend the line to
$toDo = Capsule::table('tbltodolist')->whereIn('status', ['Incomplete', 'New', 'Pending'])->orderBy('duedate', 'asc')->take(11)->get();
All I get is 
No Incomplete Items
Add To Do Item

that makes sense because the function would then be returning an empty array - it's written to use the API to get the ToDo List, so if you're going to change it to use Capsule, then many other changes to the widget code would need to be added... which would likely be along the lines of Steph's changes to the original default ToDo widget code.

[m8internet]

On 12/6/2020 at 3:01 PM, brian! said:

they won't be identical, but similar - the difference should be the icon to show which domain/service it is referencing...

and you would never need to enable both widgets - only one of them.

I have disabled, enabled, and replaced
There is no change, they are both identical

[brian!]

4 hours ago, m8internet said:

There is no change, they are both identical

then you only need to use one of them! 😎

i've had to see what you're seeing, but if the list only contained items that the enhanced version wasn't filtering on, then under those circumstances, they would looks the same.

[m8internet]

1 hour ago, brian! said:

i've had to see what you're seeing, but if the list only contained items that the enhanced version wasn't filtering on, then under those circumstances, they would looks the same.

Downloaded again, no modifications, this is what I see; they are both identical

[brian!]

19 hours ago, m8internet said:

Downloaded again, no modifications, this is what I see; they are both identical

looking at that screenshot, it's working as intended - the widget wasn't originally coded to react to manual domain renewals...

you could change...

if ($title == 'Manual Domain Registration' || $title == 'Manual Domain Transfer' || $title == 'Domain Pending Transfer') {	

to...

if (in_array($title,array('Manual Domain Registration','Manual Domain Transfer','Domain Pending Transfer','Manual Domain Renewal'))) {

and that should fix it.

there's also a bug with the Client being displayed when there shouldn't be one, but that's easily fixable and i'll update the widget at some point.

[m8internet]

12 hours ago, brian! said:

looking at that screenshot, it's working as intended - the widget wasn't originally coded to react to manual domain renewals..

Yes, that has solved the issue and the difference is now clear to see

How do you modify the code so that the renewals are shown with the most recent first?

[brian!]

7 hours ago, m8internet said:

How do you modify the code so that the renewals are shown with the most recent first?

both widgets use the ToDo API to get the results - and those results are always returned in descending due date order.

if you wanted to show them by date added (though their due dates might not necessarily be in the same order), then I wouldn't use the API - I would just do a basic capsule query to the database by changing...

        $toDo = localAPI('GetToDoItems', array('status' => 'Incomplete', 'limitstart' => 0, 'limitnum' => 11));
        return (isset($toDo['items']['item'])) ? $toDo['items']['item'] : [];

to...

        $toDoQuery = Capsule::table('tbltodolist')->whereNotIn('status',['Completed'])->latest('date')->take(11)->get();
        $toDo = json_decode(json_encode($toDoQuery), true);
        return (isset($toDo)) ? $toDo : [];

[m8internet]

$toDoQuery = Capsule::table('tbltodolist')->whereNotIn('status',['Completed'])->take(11)->get();
        $toDo = json_decode(json_encode($toDoQuery), true);
        return (isset($toDo)) ? $toDo : [];

Amending as above, and now the items are in date order, soonest to latest
Removed :
->latest('date')

Edited December 13, 2020 by m8internet