Clean up To Do list: Automatically complete 'Pending Domain Transfers' when domain is transferred

[DennisHermannsen]

I simply can't comprehend why WHMCS doesn't do this automatically. Dealing with multiple transfers each day, the To Do list becomes cluttered really fast.

The following hook will execute on 'DomainTransferCompleted', look for Pending Domain Transfers that are In Progress containing the domain name and set all of them to Completed (in case there are multiple entries).

<?php
use WHMCS\Database\Capsule;
add_hook('DomainTransferCompleted', 1, function($vars) {
    //This hook will complete to do items for transfers when the transfer is completed.
	$toDoID = Capsule::table('tbltodolist')
		->where('status', 'In Progress')
		->where('title', 'Domain Pending Transfer')
		->where('description', 'LIKE', '% ' . $vars["domain"] . ' %')
		->get();
	
	//Loop through the ID's and set them as completed.
	foreach ($toDoID as $entry) {
		$command = 'UpdateToDoItem';
		$postData = array(
		'itemid' => $entry->id,
		'adminid' => '1',
		'status' => 'Completed',
	);

	$results = localAPI($command, $postData);
	print_r($results);
	}

});

Place the file in /includes/hooks/.

UpdateToDo.php

Edited September 5, 2019 by DennisMidjord

[DennisHermannsen]

Made a very small typo in the first. Use this instead:

<?php
use WHMCS\Database\Capsule;
add_hook('DomainTransferCompleted', 1, function($vars) {
    //This hook will complete to do items for transfers when the transfer is completed.
	$toDoID = Capsule::table('tbltodolist')
		->where('status', 'In Progress')
		->where('title', 'Domain Pending Transfer')
		->where('description', 'LIKE', '% ' . $vars["domain"] . '%')
		->get();
	
	//Loop through the ID's and set them as completed.
	foreach ($toDoID as $entry) {
		$command = 'UpdateToDoItem';
		$postData = array(
		'itemid' => $entry->id,
		'adminid' => '1',
		'status' => 'Completed',
	);

	$results = localAPI($command, $postData);
	}

});

Remember to update 'adminid' with the actual ID of an admin.

UpdateToDo.php

[DennisHermannsen]

I've expanded this hook a bit to also cover failed transfers and log everything it does to the activity log.

<?php
use WHMCS\Database\Capsule;
add_hook('DomainTransferCompleted', 1, function($vars) {
    //This hook will complete to-do items for transfers when the transfer is completed.
	$toDoID = Capsule::table('tbltodolist')
		->where('status', 'In Progress')
		->where('title', 'Domain Pending Transfer')
		->where('description', 'LIKE', '% ' . $vars['domain'] . '%')
		->get();
	
	//Loop through the ID's and set them as completed.
	foreach ($toDoID as $entry) {
		$command = 'UpdateToDoItem';
		$postData = array(
		'itemid' => $entry->id,
		'adminid' => '1', //Update this ID to an admin ID
		'status' => 'Completed', 
		);
		
		localAPI($command, $postData);
		logActivity('Clean-up To-do List: ID ' . $entry->id . ' has been set as complete as the transfer completed successfully - Domain ID: ' . $vars['domainid'] . ' - Domain: ' . $vars['domain']);
	}

});

add_hook('DomainTransferFailed', 1, function($vars) {
    //This hook will update to-do items for ttransfer that fails.
	$toDoID = Capsule::table('tbltodolist')
		->where('status', 'In Progress')
		->where('title', 'Domain Pending Transfer')
		->where('description', 'LIKE', '% ' . $vars['domain'] . '%')
		->get();

	foreach ($toDoID as $entry) {
		$description = Capsule::table('tbltodolist')
		->where('id', $entry->id)
		->value('description');
		
		$command = 'UpdateToDoItem';
		$postData = array(
		'itemid' => $entry->id,
		'adminid' => '1', //Update this ID to an admin ID
		'status' => 'Incomplete', 
		'description' => '*FAILED* '.$description,
		);
		localAPI($command, $postData);
		logActivity('Clean-up To-do List: ID ' . $entry->id . ' has been set as incomplete as the transfer has failed - Domain ID: ' . $vars['domainid'] . ' - Domain: ' . $vars['domain']);
	}
});

 

Edited October 10, 2019 by DennisHermannsen
Typos

[weelow]

Impressive and useful, i will be testing it soon.
Thanks for sharing

[WevrLabs]

Thanks a lot for sharing this, @DennisHermannsen 🥰!

[AzeDK]

Thank you very much @DennisHermannsen !

This has been driving me crazy for years 🙂

[PapaKai]

Hi Dennis,

Thanks for this idea, noting it down 🙂

Kai