themewizz/twz-plugin-manager-client-library

Plugin Manager Library

5.0.3 2024-01-17 12:29 UTC

MIT

• Steven Wagner

README

This class can be used in a PHP application to contact a WordPress based license server using the free Software License Manager Plugin.

Usage

• Install WordPress on your license server
• Install the Software License Manager Plugin on that server
• Configure the plugin, e.g. setting the secret key for validation
• Include my class in your PHP application
• Change the const variables in the class to match your license server settings
• Instantiate the class in your script, e.g. $LIC = new SoftwareLicenseManager();
• Set the license key property, e.g. $LIC->setKey('5766474b540');
• Load the details for that license from the license server, e.g. $LIC->load();
• Use other methods as needed, e.g.:
  • $LIC->activate();
  • $LIC->daysToExpiry();
  • $LIC->deactivate();
  • $LIC->domainRegistered();
  • $LIC->getKey();
  • $LIC->load();
  • $LIC->readKey();
  • $LIC->saveKey();
  • $LIC->setKey('5766474b540');
  • $LIC->show();
  • $LIC->status();

$LIC->activate()

This method will sumbit the license key in $this->key to the license server for activation plus domain registration. Example:

$LIC->setKey('5766474b540');
$LIC->activate();

$LIC->daysToExpiry()

This method will count and return the number of days from 'today' to the expiry date of the license. Example:

$LIC->setKey('5766474b540');
$LIC->load();
echo $LIC->daysToExpiry();

$LIC->deactivate()

This method will sumbit the license key in $this->key to the license server for deactivation. Example:

$LIC->setKey('5766474b540');
$LIC->deactivate();

$LIC->domainRegistered()

This method will check whether the current domain is registered for the license. Example:

$LIC->setKey('5766474b540');
$LIC->load();
if ($LIC->domainRegistered()) {
   echo "Domain is registered";
else {   
   echo "Domain is not registered";
}

$LIC->getKey()

This method will retrieve the class viarable 'key' that is supposed to hold the license key. Example:

$LIC->setKey('5766474b540');
echo $LIC->getKey();

$LIC->load()

This method will load the license details from the license server. Example:

$LIC->setKey('5766474b540');
$LIC->load();

$LIC->readKey()

This method is a placeholder for code you might want to add to read the license key from your own database.

$LIC->saveKey()

This method is a placeholder for code you might want to add to save the license key to your own database.

$LIC->setKey()

This method will set the class viarable 'key' that is supposed to hold the license key. Example:

$LIC->setKey('5766474b540');

$LIC->show()

This method assumes that you use Bootstrap 4 in your PHP application. It will display the license status in a Bootstrap 4 alert box. If you set the second parameter to 'true', a table with the license details will be shown as well inside that box. Example:

$LIC->setKey('5766474b540');
$LIC->load();
$LIC->show($LIC->details, true);

$LIC->status()

The status() method returns one of these these values:

• active (the license is active and registered for the domain the validation request came from)
• blocked (the license is blocked)
• expired (the license is expired)
• invalid (an empty or invalid license key was submitted)
• pending (the license is valid but not activated yet)
• unregisterd (the license is active but not registered for the domain the validation request came from) Example:

$LIC->setKey('5766474b540');
$LIC->load();
echo $LIC->status();

Credits

Thanks to Tips and Tricks HQ for the Software License Manager Plugin for WordPress