Moodle APIs 4.3
Moodle 4.3.6 (Build: 20240812)
tool_licensemanager\helper Class Reference

License manager helper class. More...

Static Public Member Functions

static convert_version_to_epoch (string $version)
 Convert a license version number string to a UNIX epoch.
 
static get_create_license_url ()
 Get the URL endpoint to create a new license.
 
static get_disable_license_url (string $licenseshortname)
 Get the URL for endpoint disabling a license.
 
static get_enable_license_url (string $licenseshortname)
 Get the URL for endpoint enabling a license.
 
static get_licensemanager_url ()
 Get the URL for viewing the license manager interface.
 
static get_movedown_license_url (string $licenseshortname)
 Get the URL endpoint to move a license down order.
 
static get_moveup_license_url (string $licenseshortname)
 Get the URL endpoint to move a license up order.
 
static get_update_license_url (string $licenseshortname)
 Get the URL endpoint to update an existing license.
 

Public Attributes

const MANAGER_PATH = '/admin/tool/licensemanager/index.php'
 Moodle relative path to the licenses manager.
 

Detailed Description

License manager helper class.

License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

◆ convert_version_to_epoch()

static tool_licensemanager\helper::convert_version_to_epoch ( string $version)
static

Convert a license version number string to a UNIX epoch.

Parameters
string$version
Return values
int\$epoch

◆ get_create_license_url()

static tool_licensemanager\helper::get_create_license_url ( )
static

Get the URL endpoint to create a new license.

Return values
moodle_url

◆ get_disable_license_url()

static tool_licensemanager\helper::get_disable_license_url ( string $licenseshortname)
static

Get the URL for endpoint disabling a license.

Parameters
string$licenseshortnamethe shortname of license to disable.
Return values
moodle_url

◆ get_enable_license_url()

static tool_licensemanager\helper::get_enable_license_url ( string $licenseshortname)
static

Get the URL for endpoint enabling a license.

Parameters
string$licenseshortnamethe shortname of license to enable.
Return values
moodle_url

◆ get_licensemanager_url()

static tool_licensemanager\helper::get_licensemanager_url ( )
static

Get the URL for viewing the license manager interface.

Return values
moodle_url

◆ get_movedown_license_url()

static tool_licensemanager\helper::get_movedown_license_url ( string $licenseshortname)
static

Get the URL endpoint to move a license down order.

Parameters
string$licenseshortnamethe shortname of license to move down.
Return values
moodle_url

◆ get_moveup_license_url()

static tool_licensemanager\helper::get_moveup_license_url ( string $licenseshortname)
static

Get the URL endpoint to move a license up order.

Parameters
string$licenseshortnamethe shortname of license to move up.
Return values
moodle_url

◆ get_update_license_url()

static tool_licensemanager\helper::get_update_license_url ( string $licenseshortname)
static

Get the URL endpoint to update an existing license.

Parameters
string$licenseshortnamethe shortname of license to update.
Return values
moodle_url

The documentation for this class was generated from the following file: