Module Class Autoloading - Revision history

John at 19:45, 5 April 2021

2021-04-05T19:45:06Z

DanR: Replaced content with "This page has moved to https://developers.whmcs.com/modules/module-class-autoloading/"

2021-03-09T20:29:52Z

Replaced content with "This page has moved to https://developers.whmcs.com/modules/module-class-autoloading/"

Matt at 20:49, 28 July 2016

2016-07-28T20:49:48Z

Matt: /* Usage */

2016-07-28T20:45:03Z

‎Usage

Matt: Created page with "Module class autoloading enables the automatic loading of classes when stored in a prescribed way within WHMCS modules. It is provided as a tool that makes it easier for modu..."

2016-07-28T20:44:40Z

Created page with "Module class autoloading enables the automatic loading of classes when stored in a prescribed way within WHMCS modules. It is provided as a tool that makes it easier for modu..."

New page

Module class autoloading enables the automatic loading of classes when stored in a prescribed way within WHMCS modules.

It is provided as a tool that makes it easier for module developers to create helper classes that they can call on and load throughout the WHMCS product from modules, hooks and other custom integration code.

<div class="docs-alert-info">This is not intended to be a replacement for modern PHP development practices, (ie. use of Composer or more complex custom-made autoloaders).</div>

==Supported Module Types==

The following module types support autoloading.

* Addon
* Fraud
* Gateway
* Registrar
* Report
* Server
* Widget

==Usage==

Locate your class file(s) in a sub-directory named 'lib' relative to the deployed module. For example:

/path/to/whmcs/modules/{ModuleType}/{ModuleName}/lib/{ClassName}.php

Add the module namespace to the top of your class file(s):

{source lang="php"}
namespace WHMCS\Module\{ModuleType}\{ModuleName};
{/source}

To invoke the class, simply add the use statement and invoke as normal:

<source lang="php">
use WHMCS\Module\{ModuleType}\{ModuleName}\{ClassName};

$hello = new {ClassName}();
</source>

<div class="docs-alert-warning">For module types that do not have a directory per module by default (for example gateways and reports), you will need to create the directory and sub-directory 'lib' to utilise autoloading.</div>

==Example Usage==

The following example demonstrates use of the module namespace autoloading for a class named 'HelloWorld' within the addon module 'Sample Provisioning Module':

Filename: '''/modules/addons/sample-provisioning-module/lib/HelloWorld.php'''
<source lang="php">
namespace WHMCS\Module\Addon\SampleProvisioningModule;

/**
* Hello World Class
*
* @copyright Copyright (c)
* @license http://www.whmcs.com/license/ WHMCS Eula
*/
class HelloWorld {

public function printHello()
{
print 'Hello World';
}

}
</source>

Filename: '''/modules/addons/sample-provisioning-module/sample-provisioning-module.php'''

<source lang="php">
use WHMCS\Module\Addon\SampleProvisioningModule\HelloWorld;

$hello = new HelloWorld();
$hello->printHello();
</source>

← Older revision		Revision as of 19:45, 5 April 2021
Line 1:		Line 1:
−	This page has moved to https://developers.whmcs.com/modules/module-class-autoloading/	+	<div class="docs-alert-info">
		+	<span class="title">Note</span><br />
		+	This page has moved to [https://developers.whmcs.com/modules/module-class-autoloading/ https://developers.whmcs.com/modules/module-class-autoloading/]
		+	</div>

← Older revision		Revision as of 20:29, 9 March 2021
Line 1:		Line 1:
−	~~Module class autoloading enables the automatic loading of classes when stored in a prescribed way within WHMCS modules.~~	+	This page has moved to https://developers.whmcs.com/modules/module-class-autoloading/
−
−	It is provided as a tool that makes it easier for module developers to create helper classes that they can call on and load throughout the WHMCS product from modules, hooks and other custom integration code.
−
−	~~<div class="docs-alert-info">~~This ~~is not intended~~ to ~~be a replacement for modern PHP development practices, (ie. use of Composer or more complex custom-made autoloaders).</div>~~
−
−	~~==Supported Module Types==~~
−
−	~~The following module types support autoloading.~~
−
−	* Addon
−	* Fraud
−	* Gateway
−	* Registrar
−	* Report
−	* Server
−	* Widget
−
−	~~==Usage==~~
−
−	~~Locate your class file(s) in a sub-directory named 'lib' relative to the deployed module. For example~~:
−
−	/~~path/to~~/whmcs/modules/~~{ModuleType}/{ModuleName}/lib/{ClassName}.php~~
−
−	~~Add the~~ module ~~namespace to the top of your class file(s):~~
−
−	~~<source lang="php">~~
−	~~namespace WHMCS\Module\{ModuleType}\{ModuleName};~~
−	~~</source>~~
−
−	~~To invoke the~~ class~~, simply add the use statement and invoke as normal:~~
−
−	~~<source lang="php">~~
−	~~use WHMCS\Module\{ModuleType}\{ModuleName}\{ClassName};~~
−
−	~~$hello = new {ClassName}();~~
−	~~</source>~~
−
−	~~<div class="docs-alert-warning">For module types that do not have a directory per module by default (for example gateways and reports), you will need to create the directory and sub~~-~~directory 'lib' to utilise autoloading.</div>~~
−
−	~~==Example Usage==~~
−
−	~~The following example demonstrates use of the module namespace~~ autoloading ~~for a class named 'HelloWorld' within the addon module 'Sample Addon Module':~~
−
−	~~Filename: '''/modules/addons/sample_addon_module/lib/HelloWorld.php'''~~
−	~~<source lang="php">~~
−	~~namespace WHMCS\Module\Addon\SampleAddonModule;~~
−
−	/**
−	* Hello World Class
−	*
−	* @copyright Copyright (c)
−	* @license http://www.whmcs.com/license/ WHMCS Eula
−	*/
−	~~class HelloWorld {~~
−
−	/**
−	* Print hello world.
−	*/
−	~~public function printHello()~~
−	{
−	~~print 'Hello World';~~
−	}
−
−	}
−	~~</source>~~
−
−	~~Filename: '''/modules/addons/sample_addon_module/sample_addon_module.php'''~~
−
−	~~<source lang="php">~~
−	~~use WHMCS\Module\Addon\SampleAddonModule\HelloWorld;~~
−
−	~~// Other code goes here...~~
−
−	~~function sample_addon_module_output() {~~
−	~~$hello = new HelloWorld();~~
−	~~$hello->printHello();~~
−	}
−	</~~source>~~

@@ Line 41: / Line 41: @@
 ==Example Usage==
-The following example demonstrates use of the module namespace autoloading for a class named 'HelloWorld' within the addon module 'Sample Provisioning Module':
+The following example demonstrates use of the module namespace autoloading for a class named 'HelloWorld' within the addon module 'Sample Addon Module':
-Filename: '''/modules/addons/sample-provisioning-module/lib/HelloWorld.php'''
+Filename: '''/modules/addons/sample_addon_module/lib/HelloWorld.php'''
 <source lang="php">
-namespace WHMCS\Module\Addon\SampleProvisioningModule;
+namespace WHMCS\Module\Addon\SampleAddonModule;
 /**
@@ Line 55: / Line 55: @@
 class HelloWorld {
      public function printHello()
+     {
@@ Line 63: / Line 66: @@
 </source>
-Filename: '''/modules/addons/sample-provisioning-module/sample-provisioning-module.php'''
+Filename: '''/modules/addons/sample_addon_module/sample_addon_module.php'''
 <source lang="php">
-use WHMCS\Module\Addon\SampleProvisioningModule\HelloWorld;
+use WHMCS\Module\Addon\SampleAddonModule\HelloWorld;
-$hello = new HelloWorld();
+// Other code goes here...
 $hello->printHello();
 </source>

@@ Line 25: / Line 25: @@
 Add the module namespace to the top of your class file(s):
-{source lang="php"}
+<source lang="php">
 namespace WHMCS\Module\{ModuleType}\{ModuleName};
-{/source}
+</source>
 To invoke the class, simply add the use statement and invoke as normal: