ABCDEFGHIJKLMNOPQRSTUVWXYZ
1
XOOPS 2.5.10 Developers Cheatsheet 1.0 incl. XMF (www.xoops.org)
2
3
RootConfigurationGET / POSTXOOPS Theme Blocks Locations
4
How to get root object
How to get XOOPS configuration
How to get GET/POST valuepage_topleftpage_topright
5
$root =& XCube_Root::getSingleton();
$root->mContext->getXoopsConfig();
Xmf\Request::getInt('name');page_topcenter
6
Current User
How to get value of a specific configuration
canvas_left<{$xoops_contents}>canvas_right
7
How to get XoopsUser object
$root->mContext->getXoopsConfig(config_name);
Template variablespage_bottomleftpage_bottomright
8
$user =& $root->mContext->mXoopsUser;
How to get current module’s configuration
Path and URLConfiguresMetapage_bottomcenter
9
How to get user’s id numberHow to get groups
$root->mContext->mModuleConfig;
<{$SCRIPT_NAME}><{$xoops_charset}><{$xoops_meta_author}>footer_leftfooter_centerfooter_right
10
$user->uid();$user->getGroups();
How to get configure value of current module
<{$xoops_requesturi}><{$xoops_langcode}>
<{$xoops_meta_copyright}>
footer_all
11
How to get user’s login IDHow to add post count
$helper->getConfig(‘dirname’);
<{$xoops_imageurl}><{$xoops_sitename}>
<{$xoops_meta_description}>
12
$user->uname();$user->incrementPost();
How to get configures of a specific module by directory name
<{$xoops_upload_url}><{$xoops_slogan}>
<{$xoops_meta_keywords}>
<{$xoops_contents}> is usually the output after page_topcenter
13
User Roles
$ch=& xoops_gethandler('config');
<{$xoops_url}><{$xoops_version}><{$xoops_meta_rating}>
14
How to check if a user belongs to a specific role
$mconf = $ch->getConfigsByDirname(dirname);
<{$xoops_themecss}<{$xoops_theme}><{$xoops_meta_robots}>
15
$root->mContext->mUser->isInRole(role_name);
Language files<{$xoops_rootpath}><{$xoops_pagetitle}>
16
System roles
How to get current language?
HeadRole & UserOther
17
Site.GuestUserAnonymous users<{$xoops_module_header}><{$xoops_isadmin}><{$xoops_search}>
18
Site.RegisteredUserRegistered users
How to load a language file (main.php) in a specific module
<{$xoops_block_header}><{$xoops_isuser}><{$xoops_startpage}>
19
Site.AdministratorWho can access admin menu
$helper->loadLanguage(‘main’);
<{$xoops_js}><{$xoops_userid}><{$xoops_banner}>
20
Site.OwnerUsers who has all rightsDirname & Module Name<{$xoops_uname}><{$xoops_page}>
21
Module.dirname.AdminA specific module’s admin<{$xoops_name}><{$}>
22
Module.dirname.VisitorA specific module’s visitor<{$mytrustdirname}><{$xoops_avatar}><{$}>
23
Module Helpers<{$xoops_dirname}><{$xoops_usergroups}><{$}>
24
How to get Helper instance for a module?
Misc<{$xoops_modulename}><{$}>
25
$helper = \Xmf\Module\Helper::getHelper('bar');
How to redirectMisc<{$}>
26
How to get directory name for a module?
$helper->redirect(url, time, msg);
<{$legacy_buffertype}><{$themePath}>
27
$helper->getConfig(‘dirname’);<{$stdout_buffer}><{$themeUrl}>
28
How to get module nameHow to get module ID
How to prevent it from loading XOOPS Cube core
Smarty Flow Control / Block
29
$helper->getConfig(‘name’);
$helper->getModule()->getVar('mid');
define('_LEGACY_PREVENT_LOAD_CORE_', 1);
If ... Else
30
How to get a Handler for current module?
How to prevent it from executing Common
<{if $smarty_variable}>
$smarty_variable could be:
31
$handler =$helper->getHandler('module');
define('_LEGACY_PREVENT_EXEC_COMMON_', 1);
 ...$xoops_isuser
32
How to get a XoopsModule instance for current module?
Constants<{elseif}>$xoBlocks.canvas_left
33
$module =$helper->getModule();PathsGroups .....$xoops_contents
34
How to get an absolute URL for module's relative url?
XOOPS_ROOT_PATHXOOPS_GROUP_ADMIN<{/if}>
35
$absoluteUrl =$helper->url($url);XOOPS_CACHE_PATHXOOPS_GROUP_USERSForeach Loop
36
How to get an absolute Path for module's relative path?
XOOPS_MODULE_PATH
XOOPS_GROUP_ANONYMOUS
<{foreach item=block from=$xoBlocks.canvas_left}>
37
$absolutePath =$helper->getModule(string $path = '');
XOOPS_UPLOAD_PATHURLs .....
38
Debugging with Module HelpersXOOPS_THEME_PATHXOOPS_URL<{/foreach}>
39
How to set Debug On and Off with Module Helper?
XOOPS_COMPILE_PATHXOOPS_MODULE_URL
40
$helper->setDebug($bool);OthersXOOPS_UPLOAD_URL
41
How can I add a message to Module's log?
XOOPS_THEME_URL
XOOPS Resource Locators / Links
42
$helper->addLog($log);
Permissions with PermissionHelper
<{xoAppUrl backend.php}># XOOPS/backend.php
43
How to get do Permission Helper instance?
<{xoImgUrl style.css}>
# XOOPS/theme/yourtheme/style.css
44
$permHelper = new \Xmf\Module\Helper\Permission();
<{xoImgUrl assets/img/some.png}>
# XOOPS/theme/yourtheme/assets/img/some.png
45
Does the User Have Permission for an Item?
<{xoImgUrl assets/js/some.js}>
# XOOPS/theme/yourtheme/assets/js/some.js
46
Data Base
$permission = $permHelper->checkPermission('viewtopic', $id);
47
How to get database object
48
$db =& $root->mController->mDB;
49
$xoopsDB = XoopsDatabaseFactory::getDatabaseConnection();
50
How to prefix table name
51
$db->prefix(table_name);
52
How to send a SQL querySend a SQL query forcedly
53
$db->query(expression);$db->queryF(expression);
54
Is the user an Admin?
55
$isAdmin = $helper->isUserAdmin();
Template Tips
56
Metadata with XMF\Metagen
How to output user’s property by uid
57
SEO Slugs<{$uid|xoops_user:property_name}>
58
$title = 'xmf - the XOOPS Module Framework';
How to output user’s avatar image URL by uid
59
echo Metagen::generateSeoTitle($title);
<{$uid|xoops_user_avatarize}>
60
How to output date time which is adjusted to users time-zone
61
<{$timeStamp|xoops_formattimestamp:l}>
62
Mail Template Variables
63
{X_ADMINMAIL}{X_NAME}{X_UNAME}
64
{X_SITENAME}{X_UID}{X_UACTLINK}
65
{X_SITEURL}{X_UEMAIL}
66
Smarty Functions
67
xoops_dhtmltareaxoops_pagenavi
68
xoops_explaceholderxoops_textarea
69
xoops_inputsecurityToken
70
xoAdminIcons
71
xoAdminNav
72
xoAppUrl
73
xoModuleIcons16
74
xoModuleIcons32
75
xoModuleIconsBookmarks
76
xoInboxCount
77
78
Calling Icon with Admin Helper:
79
\Xmf\Module\Admin::iconUrl('delete.png', 16);
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100