xPDO.loadClass
xPDO::loadClass
Include a class by fully qualified name. This is a handy way to perform an include_once
operation to include a .class.php
file. If the file is not found, false
is returned and a warning is logged. This only includes the class: it does not instantiate an instance of it.
Syntax
API Docs: http://api.modx.com/xpdo/xPDO.html#loadClass
string|boolean loadClass (string $fqn, [ $path = ''], [ $ignorePkg = false], [ $transient = false])
The $fqn (fully qualified name) should in the format:
dir_a.dir_b.dir_c.classname
which will translate to:
XPDO_CORE_PATH/om/dir_a/dir_b/dir_c/dbtype/classname.class.php
Hint
- The file name you are including must include .class.php as its extension.
- The path to your model must end in a trailing slash!
Example
Load a class from the path '/my/path/to/model/'.
$xpdo->loadClass('myBox','/my/path/to/model/');
Another example:
if (!$xpdo->loadClass('myBox','/my/path/to/model/',true,true)) { die('Could not load class myBox!'); } $Box = new myBox();
See Also
- xPDO
- modX.getService - this will include a class and instantiate it.
Suggest an edit to this page on GitHub (Requires GitHub account. Opens a new window/tab).