XOOPS  2.6.0
Public Member Functions | Static Public Member Functions | Public Attributes | Private Member Functions | Private Attributes | List of all members
Xoops Class Reference

Public Member Functions

 addConfigs ($configs, $dirname= 'system')
 
 alert ($type, $msg, $title= '/')
 
 appendConfig ($key, array $values, $appendWithKey=false, $dirname= 'system')
 
 assets ()
 
 buildUrl ($url, $params=array())
 
 cache ($cacheName= 'default')
 
 checkEmail ($email, $antispam=false)
 
 confirm ($hiddens, $action, $msg, $submit= '', $addtoken=true)
 
 db ()
 
 deprecated ($message)
 
 disableErrorReporting ()
 
 disableModuleCache ()
 
 events ()
 
 footer ()
 
 formatURL ($url)
 
 getActiveModules ()
 
 getBanner ()
 
 getBaseDomain ($url, $includeSubdomain=false, $returnObject=false)
 
 getConfig ($key)
 
 getConfigs ()
 
 getCss ($theme= '')
 
 getEnv ($key)
 
 getHandler ($name, $optional=false)
 
 getHandlerBlock ($optional=false)
 
 getHandlerBlockmodulelink ($optional=false)
 
 getHandlerConfig ($optional=false)
 
 getHandlerConfigitem ($optional=false)
 
 getHandlerConfigoption ($optional=false)
 
 getHandlerGroup ($optional=false)
 
 getHandlerGroupperm ($optional=false)
 
 getHandlerMember ($optional=false)
 
 getHandlerMembership ($optional=false)
 
 getHandlerModule ($optional=false)
 
 getHandlerOnline ($optional=false)
 
 getHandlerPrivmessage ($optional=false)
 
 getHandlerRanks ($optional=false)
 
 getHandlerTplfile ($optional=false)
 
 getHandlerTplset ($optional=false)
 
 getHandlerUser ($optional=false)
 
 getMailer ()
 
 getModuleByDirname ($dirname)
 
 getModuleById ($id)
 
 getModuleConfig ($key, $dirname= '')
 
 getModuleConfigs ($dirname= '')
 
 getModuleForm ($obj, $name, $module_dir=null)
 
 getModuleHandler ($name=null, $module_dir=null, $optional=false)
 
 getModuleHelper ($dirname)
 
 getOption ($key)
 
 getRank ($rank_id=0, $posts=0)
 
 getTplInfo ($tpl_name)
 
 getUserGroups ()
 
 getUserTimestamp ($time, $timeoffset= '')
 
 gzipCompression ()
 
 header ($tpl_name=null)
 
 isActiveModule ($dirname)
 
 isAdmin ()
 
 isModule ()
 
 isUser ()
 
 loadLanguage ($name, $domain= '', $language=null)
 
 logger ()
 
 makePass ()
 
 normalizePath ($path)
 
 path ($url, $virtual =false)
 
 pathExists ($path, $error_type)
 
 pathTranslation ()
 
 preload ()
 
 redirect ($url, $time=3, $message= '', $addredirect=true, $allowExternalLink=false)
 
 registry ()
 
 security ()
 
 service ($service)
 
 session ()
 
 setActiveModules ()
 
 setConfig ($key, $value=null, $dirname= 'system')
 
 setOption ($key, $value=null)
 
 setTheme (XoopsTheme $theme)
 
 setTpl (XoopsTpl $tpl)
 
 simpleFooter ()
 
 simpleHeader ($closehead=true)
 
 templateClearModuleCache ($mid)
 
 templateTouch ($tpl_id)
 
 theme ($tpl_name=null)
 
 themeSelect ()
 
 tpl ()
 
 translate ($key, $dirname= 'xoops')
 
 url ($url)
 
 userTimeToServerTime ($timestamp, $userTZ=null)
 

Static Public Member Functions

static getInstance ()
 
static loadLocale ($domain= 'xoops', $locale=null)
 

Public Attributes

 $config = array()
 
 $isAdminSide = false
 
 $module = null
 
 $moduleConfig = array()
 
 $moduleDirname = ''
 
 $option = array()
 
 $paths
 
 $sessionManager = null
 
 $tpl_name = ''
 
 $user = ''
 
 $userIsAdmin = false
 
const VERSION = 'XOOPS 2.6.0-Alpha 3'
 

Private Member Functions

 __construct ()
 

Private Attributes

 $activeModules = null
 
 $kernelHandlers = array()
 
 $moduleConfigs = array()
 
 $moduleHandlers = array()
 
 $theme = null
 
 $tpl = null
 

Detailed Description

Definition at line 26 of file Xoops.php.

Constructor & Destructor Documentation

Xoops::__construct ( )
private

Actual Xoops OS

Definition at line 121 of file Xoops.php.

References $root, $url, $var, XoopsBaseConfig\get(), and pathTranslation().

Here is the call graph for this function:

Member Function Documentation

Xoops::addConfigs (   $configs,
  $dirname = 'system' 
)

Add Config Values

Parameters
array$configsarray of configs
string$dirnamemodule name
Returns
void

Definition at line 1745 of file Xoops.php.

References $configs, $dirname, and isModule().

Here is the call graph for this function:

Xoops::alert (   $type,
  $msg,
  $title = '/' 
)

render an alert message to a string

Parameters
string$typealert type, one of 'info', 'error', 'success' or 'warning'
mixed$msgstring or array of strings
string$titletitle for alert
Returns
string

Definition at line 1278 of file Xoops.php.

References $msg, $tpl, $type, XoopsLocaleEn_US\ERROR, XoopsLocaleEn_US\INFORMATION, XoopsLocaleEn_US\SUCCESS, and XoopsLocaleEn_US\WARNING.

Xoops::appendConfig (   $key,
array  $values,
  $appendWithKey = false,
  $dirname = 'system' 
)

Append Config Value

Parameters
string$key
array$values
bool$appendWithKey
string$dirname
Returns
void

Definition at line 1786 of file Xoops.php.

References $dirname, and isModule().

Referenced by disableModuleCache().

Here is the call graph for this function:

Here is the caller graph for this function:

Xoops::assets ( )

get the asset utility

Returns
Xoops instance

Definition at line 234 of file Xoops.php.

Xoops::buildUrl (   $url,
  $params = array() 
)

Build an URL with the specified request params

Parameters
string$url
array$params
Returns
string

Definition at line 431 of file Xoops.php.

References $_SERVER, $query, and $url.

Xoops::cache (   $cacheName = 'default')

get a object for a named cache

Parameters
string$cacheNamea named cached pool
Returns

Definition at line 187 of file Xoops.php.

Referenced by getActiveModules(), getModuleByDirname(), getModuleById(), getModuleConfigs(), and setActiveModules().

Here is the caller graph for this function:

Xoops::checkEmail (   $email,
  $antispam = false 
)

Check Email

Parameters
string$email
bool$antispam
Returns
false|string

Definition at line 1450 of file Xoops.php.

References $email.

Xoops::confirm (   $hiddens,
  $action,
  $msg,
  $submit = '',
  $addtoken = true 
)

Render a confirmation form to a string

Parameters
array$hiddensassociative array of values used to complete confirmed action
string$actionform action (URL)
string$msgmessage to display
string$submitsubmit button message
boolean$addtokentrue to add CSRF token
Returns
string rendered confirm message

Definition at line 1345 of file Xoops.php.

References $action, $msg, $name, $tpl, XoopsLocaleEn_US\A_SUBMIT, and security().

Here is the call graph for this function:

Xoops::db ( )

get database connection instance

Returns
Xoops

Definition at line 175 of file Xoops.php.

Referenced by Xoops\Core\Session\Handler\__construct(), Xoops\Core\Kernel\Dtype\DtypeUrl\cleanVar(), Xoops\Core\Kernel\Dtype\DtypeEmail\cleanVar(), Xoops\Core\Kernel\Dtype\DtypeEnumeration\cleanVar(), Xoops\Core\Kernel\Dtype\DtypeAbstract\cleanVar(), Xoops\Core\Kernel\Dtype\DtypeTextbox\cleanVar(), Xoops\Core\Kernel\Dtype\DtypeSource\cleanVar(), Xoops\Core\Kernel\Dtype\DtypeTextarea\cleanVar(), Xoops\Core\Session\Handler\destroy(), Xoops\Core\Session\Handler\gc(), getHandler(), getModuleHandler(), getRank(), Xoops\Core\Kernel\Dtype\DtypeAbstract\init(), Xoops\Core\Session\Handler\read(), and Xoops\Core\Session\Handler\write().

Here is the caller graph for this function:

Xoops::deprecated (   $message)

Support for deprecated messages events

Parameters
string$messagemessage
Returns
void

Definition at line 1977 of file Xoops.php.

References events(), and logger().

Referenced by header().

Here is the call graph for this function:

Here is the caller graph for this function:

Xoops::disableErrorReporting ( )

Support for disabling error reporting

Returns
void

Definition at line 1988 of file Xoops.php.

References events().

Here is the call graph for this function:

Xoops::disableModuleCache ( )

Disables page cache by overriding module cache settings

Returns
void

Definition at line 1875 of file Xoops.php.

References appendConfig(), and isModule().

Here is the call graph for this function:

Xoops::events ( )

get the event processor

Returns
instance

Definition at line 214 of file Xoops.php.

Referenced by deprecated(), disableErrorReporting(), footer(), getBanner(), getBaseDomain(), getTplInfo(), header(), preload(), redirect(), simpleFooter(), and simpleHeader().

Here is the caller graph for this function:

Xoops::footer ( )

Render Footer

Returns
false|null

Definition at line 681 of file Xoops.php.

References $tpl_name, events(), exit, Xoops_Locale_Abstract\getCharset(), header(), option, and theme().

Here is the call graph for this function:

Xoops::formatURL (   $url)

formatURL - add default http:// if no valid protocol specified

Parameters
string$urlfull or partial url
Returns
string

Definition at line 1469 of file Xoops.php.

References $url.

Xoops::getActiveModules ( )

Get active modules from cache file

Returns
array

Definition at line 1125 of file Xoops.php.

References $activeModules, cache(), and setActiveModules().

Referenced by isActiveModule().

Here is the call graph for this function:

Here is the caller graph for this function:

Xoops::getBanner ( )

Function to get banner html tags for use in templates

Returns
string

Definition at line 1485 of file Xoops.php.

References $options, and events().

Here is the call graph for this function:

Xoops::getBaseDomain (   $url,
  $includeSubdomain = false,
  $returnObject = false 
)

getBaseDomain

Get domain name from a URL. This will check that the domain is valid for registering, preventing return of constructs like 'co.uk' as the domain. See https://publicsuffix.org/

Parameters
string$urlURL
boolean$includeSubdomaintrue to include include subdomains, default is false registerable domain only
boolean$returnObjecttrue to return Pdp object false returns domain as string
Returns
Pdp|string|null domain, or null if domain is invalid

Definition at line 1896 of file Xoops.php.

References $url, and events().

Here is the call graph for this function:

Xoops::getConfig (   $key)

Get Config value

Parameters
string$key
Returns
mixed

Definition at line 1722 of file Xoops.php.

References getModuleConfig().

Referenced by getCss(), getUserTimestamp(), gzipCompression(), header(), redirect(), simpleHeader(), theme(), themeSelect(), and userTimeToServerTime().

Here is the call graph for this function:

Here is the caller graph for this function:

Xoops::getConfigs ( )

Get all Config Values

Returns
array

Definition at line 1732 of file Xoops.php.

References getModuleConfigs().

Referenced by simpleHeader().

Here is the call graph for this function:

Here is the caller graph for this function:

Xoops::getCss (   $theme = '')

Function to get css file for a certain themeset

Parameters
string$theme
Returns
string

Definition at line 1595 of file Xoops.php.

References $theme, XoopsLoad\fileExists(), XoopsBaseConfig\get(), getConfig(), and getEnv().

Referenced by redirect(), and simpleHeader().

Here is the call graph for this function:

Here is the caller graph for this function:

Xoops::getEnv (   $key)

Get Environment Value

Parameters
string$key
Returns
string

Definition at line 1574 of file Xoops.php.

References $_SERVER.

Referenced by getCss().

Here is the caller graph for this function:

Xoops::getHandler (   $name,
  $optional = false 
)

Get handler

Parameters
string$name
mixed$optional
Returns
XoopsObjectHandler|XoopsPersistableObjectHandler|null

Definition at line 950 of file Xoops.php.

References $name, db(), logger(), and WARNING.

Referenced by getHandlerBlock(), getHandlerBlockmodulelink(), getHandlerConfig(), getHandlerConfigitem(), getHandlerConfigoption(), getHandlerGroup(), getHandlerGroupperm(), getHandlerMember(), getHandlerMembership(), getHandlerModule(), getHandlerOnline(), getHandlerPrivmessage(), getHandlerRanks(), getHandlerTplfile(), getHandlerTplset(), and getHandlerUser().

Here is the call graph for this function:

Here is the caller graph for this function:

Xoops::getHandlerBlock (   $optional = false)

Get handler of Block

Parameters
mixed$optional
Returns
XoopsBlockHandler

Definition at line 744 of file Xoops.php.

References getHandler().

Here is the call graph for this function:

Xoops::getHandlerBlockmodulelink (   $optional = false)

Get handler of Block Module Link

Parameters
mixed$optional
Returns
XoopsBlockmodulelinkHandler

Definition at line 756 of file Xoops.php.

References getHandler().

Here is the call graph for this function:

Xoops::getHandlerConfig (   $optional = false)

Get handler of Config

Parameters
mixed$optional
Returns
XoopsConfigHandler

Definition at line 768 of file Xoops.php.

References getHandler().

Referenced by getModuleConfigs().

Here is the call graph for this function:

Here is the caller graph for this function:

Xoops::getHandlerConfigitem (   $optional = false)

Get handler of Config Item

Parameters
mixed$optional
Returns
XoopsConfigitemHandler

Definition at line 780 of file Xoops.php.

References getHandler().

Here is the call graph for this function:

Xoops::getHandlerConfigoption (   $optional = false)

Get handler of Config Option

Parameters
mixed$optional
Returns
XoopsConfigoptionHandler

Definition at line 792 of file Xoops.php.

References getHandler().

Here is the call graph for this function:

Xoops::getHandlerGroup (   $optional = false)

Get handler of Group

Parameters
mixed$optional
Returns
XoopsGroupHandler

Definition at line 804 of file Xoops.php.

References getHandler().

Here is the call graph for this function:

Xoops::getHandlerGroupperm (   $optional = false)

Get handler of Group Permission

Parameters
mixed$optional
Returns
XoopsGrouppermHandler

Definition at line 816 of file Xoops.php.

References getHandler().

Here is the call graph for this function:

Xoops::getHandlerMember (   $optional = false)

Get handler of Member

Parameters
mixed$optional
Returns
XoopsMemberHandler

Definition at line 828 of file Xoops.php.

References getHandler().

Here is the call graph for this function:

Xoops::getHandlerMembership (   $optional = false)

Get handler of Membership

Parameters
mixed$optional
Returns
XoopsMembershipHandler

Definition at line 840 of file Xoops.php.

References getHandler().

Here is the call graph for this function:

Xoops::getHandlerModule (   $optional = false)

Get handler of Module

Parameters
mixed$optional
Returns
XoopsModuleHandler

Definition at line 852 of file Xoops.php.

References getHandler().

Referenced by getModuleByDirname(), getModuleById(), and setActiveModules().

Here is the call graph for this function:

Here is the caller graph for this function:

Xoops::getHandlerOnline (   $optional = false)

Get handler of Online

Parameters
mixed$optional
Returns
XoopsOnlineHandler

Definition at line 864 of file Xoops.php.

References getHandler().

Here is the call graph for this function:

Xoops::getHandlerPrivmessage (   $optional = false)

Get handler of Private Message

Parameters
mixed$optional
Returns
XoopsPrivmessageHandler

Definition at line 876 of file Xoops.php.

References getHandler().

Here is the call graph for this function:

Xoops::getHandlerRanks (   $optional = false)

Get handler of Ranks

Parameters
mixed$optional
Returns
XoopsRanksHandler

Definition at line 888 of file Xoops.php.

References getHandler().

Here is the call graph for this function:

Xoops::getHandlerTplfile (   $optional = false)

Get handler of Template File

Parameters
mixed$optional
Returns
XoopsTplfileHandler

Definition at line 913 of file Xoops.php.

References getHandler().

Referenced by templateTouch().

Here is the call graph for this function:

Here is the caller graph for this function:

Xoops::getHandlerTplset (   $optional = false)

Get handler of Template Set

Parameters
mixed$optional
Returns
XoopsTplsetHandler

Definition at line 925 of file Xoops.php.

References getHandler().

Here is the call graph for this function:

Xoops::getHandlerUser (   $optional = false)

Get handler of User

Parameters
mixed$optional
Returns
XoopsUserHandler

Definition at line 937 of file Xoops.php.

References getHandler().

Here is the call graph for this function:

static Xoops::getInstance ( )
static

Access the only instance of this class

Returns
Xoops

Definition at line 160 of file Xoops.php.

Referenced by AvatarsAvatar_userForm\__construct(), ImagesImageForm\__construct(), XcaptchaTextForm\__construct(), XcaptchaImageForm\__construct(), XcaptchaRecaptchaForm\__construct(), XcaptchaCaptchaForm\__construct(), ImagesCategoryselectForm\__construct(), CommentsCommentForm\__construct(), ImagesCategoryForm\__construct(), SmiliesSmiliesForm\__construct(), Xoops\Module\Plugin\PluginAbstract\__construct(), ImagesCategory_imagemanagerForm\__construct(), MenusMenus_menuForm\__construct(), MenusMenus_menusForm\__construct(), ImagesImage_imagemanagerForm\__construct(), SystemUserForm\__construct(), Xoops\Form\Token\__construct(), SystemGroupForm\__construct(), XoopsBlock\__construct(), Xoops\Form\GroupCheckbox\__construct(), System\__construct(), SystemMenuHandler\__construct(), XoopsTpl\__construct(), Xoops\Form\SelectGroup\__construct(), Xoops\Core\Session\Handler\__construct(), Xoops\Core\Kernel\XoopsObjectHandler\__construct(), Xoops\Core\Session\SessionUser\__construct(), Xoops\Form\SelectUser\__construct(), Xmf\Module\Helper\AbstractHelper\__construct(), Xoops\Core\Session\Manager\__construct(), XoopsUser\__construct(), Xoops\Core\Cache\CacheManager\__construct(), XoopsDatabaseManager\__construct(), SystemModule\__construct(), XoopsConfigHandler\__construct(), XoopsMemberHandler\__construct(), Xoops\Auth\Provisioning\__construct(), Xoops\Core\Session\RememberMe\__construct(), Xoops\Module\Admin\__construct(), Xoops\Form\DhtmlTextArea\__construct(), Xoops\Auth\Ldap\__construct(), XoopsMultiMailer\__construct(), XoopsXmlRpcApi\_checkUser(), MenusSmartyDecorator\_doDecoration(), CommentsCommentRenderer\_getPosterArray(), CommentsCommentRenderer\_getPosterName(), CommentsCommentRenderer\_getTitleIcon(), XoopsEditorHandler\_loadEditor(), Xoops\Auth\Provisioning\add(), Xoops\Module\Admin\addConfigBoxLine(), Xmf\Module\Helper\AbstractHelper\addLog(), Xmf\Module\Helper\GenericHelper\addLog(), XoopsTheme\addScript(), Xoops\Core\Database\Schema\PrefixStripper\addSequence(), DebugbarLogger\addSmarty(), XoopsTheme\addStylesheet(), Xoops\Core\Database\Schema\PrefixStripper\addTable(), DebugbarLogger\addToTheme(), Smarty_Resource_Admin\adminTplInfo(), System\adminVersion(), Xoops\Auth\Xoops\authenticate(), b_comments_show(), b_notification_show(), b_system_info_show(), b_system_login_show(), b_system_main_edit(), b_system_main_show(), b_system_newmembers_show(), b_system_online_show(), b_system_themes_show(), b_system_topposters_show(), b_system_user_show(), Xmf\Debug\backtrace(), Smarty_Resource_Block\blockTplInfo(), SystemMenuHandler\breadcrumb_nav(), XoopsThemeBlocksPlugin\buildBlock(), XoopsBlock\buildBlock(), Xoops\Auth\Provisioning\change(), XoopsInstallWizard\checkAccess(), Xoops\Core\Security\checkBadips(), XoopsTheme\checkCache(), Xoops\Core\Security\checkReferer(), System\cleanCache(), XoopsTpl\clearCache(), Xoops\Form\DhtmlTextArea\codeIcon(), Xoops_Locale_Abstract\convert_encoding(), Xoops\Core\Assets\copyFileAssets(), createConfigform(), XoopsThemeFactory\createInstance(), XoopsAdminThemeFactory\createInstance(), Smarty_Resource_Db\dbTplInfo(), SystemModule\deleteBlocks(), CommentsCommentHandler\deleteByItemId(), SystemModule\deleteConfigs(), XoopsModuleHandler\deleteModule(), Notifications\deleteModuleRelations(), Comments\deleteModuleRelations(), SystemModule\deleteTemplates(), Xoops\Core\Cache\Legacy\deprecated(), XoopsMySQLDatabase\deprecated(), Xoops\Core\Logger\deprecatedMessage(), XoopsLogger\deprecatedWarning(), Xmf\Template\AbstractTemplate\disableLogger(), Comments\displayDelete(), Comments\displayEdit(), Comments\displayNew(), Comments\displayPost(), Comments\displayReply(), Xoops\Core\Yaml\dump(), Xmf\Debug\dump(), LegacyLogger\dump(), Xoops\Core\Yaml\dumpWrapped(), DebugbarLogger\enable(), LegacyLogger\enable(), Notifications\enabled(), NotificationsPreload\eventCoreFooterStart(), SystemPreload\eventCoreHeaderAddmeta(), SystemPreload\eventCoreHeaderCheckcache(), ImagesPreload\eventCoreImage(), ImagesPreload\eventCoreImagemanager(), NotificationsPreload\eventCoreIncludeCheckloginSuccess(), DebugbarPreload\eventCoreIncludeCommonAuthSuccess(), LoggerPreload\eventCoreIncludeCommonAuthSuccess(), MonologPreload\eventCoreIncludeCommonConfigsSuccess(), MonologPreload\eventCoreIncludeCommonSecurity(), SystemPreload\eventCoreIncludeFunctionsRedirectheader(), LoggerPreload\eventCoreIncludeFunctionsRedirectheaderEnd(), Notifications\eventEnabled(), SystemPreload\eventSystemClassGuiHeader(), MonologPreload\eventSystemPreferencesSave(), Xoops\Core\Database\Connection\executeUpdate(), Xoops_Locale_Abstract\formatTimestamp(), XoopsTheme\generateCacheId(), Xoops\Auth\Factory\getAuthConnection(), XoopsModule\getByDirName(), Notifications\getCategory(), LoggerPreload\getConfigs(), DebugbarPreload\getConfigs(), MonologPreload\getConfigs(), Xoops\Core\Database\Factory\getConnection(), Xoops\Core\Kernel\Model\Stats\getCount(), Xoops\Core\Kernel\Model\Stats\getCounts(), Xoops\Core\HttpRequest\getDomain(), MaintenanceMaintenanceForm\getDump(), Xoops\Core\HttpRequest\getEnv(), Notifications\getEvents(), SystemExtension\getExtensionList(), MenusDefaultDecorator\getExtraValue(), CountryFlagProvider\getFlagUrl(), UserconfigsConfigsForm\getForm(), SystemPreferencesForm\getForm(), SystemBlockForm\getForm(), XoopsUser\getGroups(), Xoops\Module\Helper\getHelper(), Xoops\Auth\AuthAbstract\getHtmlErrors(), SystemExtension\getInstalledExtensions(), SystemModule\getInstalledModules(), Xoops\Module\Helper\HelperAbstract\getInstance(), Notifications\getItem(), XoopsEditorHandler\getList(), ImagesCategoryHandler\getListByPermission(), XoopsTheme\getLocalizationAssets(), SystemModule\getModuleList(), MenusDynamicDecorator\getModuleMenus(), UserconfigsModulesForm\getModulesForm(), XoopsBlock\getOptions(), Xoops\Module\Plugin\getPlugins(), QrcodeProvider\getQRUrl(), XoopsMySQLDatabase\getRowsNum(), SearchSearchForm\getSearchFrom(), Xoops\Core\HttpRequest\getSubdomains(), Notifications\getTags(), SystemModule\getTemplate(), XoopsMailer\getTemplatePath(), Xoops_Locale\getThemeClassFromDirname(), ThumbsProvider\getThumbnailUrl(), XoopsUserUtility\getUnameFromId(), XoopsUserUtility\getUnameFromIds(), Xoops\Core\Assets\getUrlToAssets(), AvatarsProvider\getUserById(), GravatarsProvider\getUserById(), Xoops_Locale\getUserLocales(), xoopslists\getUserRankList(), Xoops\Auth\Provisioning\getXoopsUser(), XoopsGuiDefault\header(), XoopsUser\incrementPost(), Xoops\Core\Kernel\Dtype\DtypeAbstract\init(), Xmf\Module\Cache\init(), Xmf\Module\Permission\init(), TinyMCE\init(), Notifications\insertModuleRelations(), Comments\insertModuleRelations(), SystemModule\install(), install_acceptUser(), SystemModule\installBlocks(), SystemModule\installconfigs(), SystemModule\installTemplates(), XoopsCaptcha\isActive(), XoopsUser\isOnline(), MytsImage\load(), MytsTextfilter\load(), MytsCensor\load(), Xoops\Core\Yaml\load(), XoopsLoad\loadConfig(), TinyMCE\loadCss(), Xoops\Core\Kernel\XoopsObject\loadFilters(), Xoops_Locale\loadLanguage(), System\loadLanguage(), Xoops_Locale\loadLocale(), Xoops_Locale\loadMailerLocale(), loadModuleAdminMenu(), Xmf\Database\TableLoad\loadTableFromArray(), Xoops_Locale\loadThemeLocale(), Xoops\Core\Yaml\loadWrapped(), Xoops\Core\Service\Manager\locate(), menus_block_show(), menus_mainmenu_show(), mod_clearFile(), mod_clearSmartyCache(), mod_createFile(), mod_fetchConfig(), mod_generateCacheId_byGroup(), mod_isModuleAction(), mod_loadConfig(), mod_loadFile(), mod_loadFunctions(), mod_loadRenderer(), mod_message(), Smarty_Resource_Module\moduleTplInfo(), Xoops\Core\Database\Connection\query(), XoopsUser\rank(), Xoops\Core\Yaml\read(), Xoops\Core\Assets\readAssetsPrefs(), Xoops\Core\Service\Manager\readProviderPrefs(), Xoops\Core\Yaml\readWrapped(), Xoops\Core\Service\Manager\readYamlProviderPrefs(), Xoops\Core\Assets\registerAssetReference(), Xoops\Form\ColorPicker\render(), Xoops\Form\DateSelect\render(), Xoops\Form\TabTray\render(), Xoops\Form\ThemeForm\render(), SystemBreadcrumb\render(), SystemMenuHandler\render(), Xoops\Form\GroupPermissionForm\render(), Xoops\Form\DhtmlTextArea\render(), DebugbarLogger\render(), XoopsTheme\render(), Xoops\Module\Admin\renderAbout(), Xoops\Module\Admin\renderBreadcrumb(), Xoops\Module\Admin\renderButton(), XoopsPageNav\renderImageNav(), Xoops\Module\Admin\renderIndex(), Xoops\Module\Admin\renderInfoBox(), XoopsPageNav\renderNav(), Xoops\Module\Admin\renderNavigation(), Xoops\Core\Kernel\CriteriaCompo\renderQb(), Xoops\Core\Kernel\Criteria\renderQb(), XoopsPageNav\renderSelect(), Xoops\Module\Admin\renderTips(), Comments\renderView(), HtmlToPdfProvider\resetPdf(), Xmf\Database\TableLoad\rowCount(), Xoops\Core\Yaml\save(), Xoops\Core\Assets\saveAssetsPrefs(), Xoops\Core\Service\Manager\saveProviderPrefs(), Xoops\Core\Yaml\saveWrapped(), XoopsMailer\send(), XoopsMailer\sendPM(), XoopsUserUtility\sendWelcome(), XoopsTpl\setCompileId(), Xoops\Core\Events\setPreloads(), XoopsMailer\setTemplateDir(), XoopsMailer\setToEmails(), XoopsMailer\setToGroups(), simpleHeader(), smarty_block_assets(), smarty_compiler_xoAdminIcons(), smarty_compiler_xoAdminNav(), smarty_compiler_xoAppUrl(), smarty_compiler_xoImgUrl(), smarty_compiler_xoModuleIcons16(), smarty_compiler_xoModuleIcons32(), smarty_compiler_xoModuleIconsBookmarks(), smarty_function_xoblock(), smarty_function_xoInboxCount(), smarty_function_xoMemberInfo(), smarty_function_xoops_link(), smarty_function_xoPageNav(), MenusDefaultDecorator\start(), Xmf\Debug\startTimer(), Xoops\Core\Database\Logging\XoopsDebugStack\stopQuery(), Xmf\Debug\stopTimer(), UserconfigsMenusPlugin\subMenus(), NotificationsNotificationHandler\subscribe(), synchronize(), system_AdminIcons(), system_adminVersion(), system_loadLanguage(), system_loadTemplate(), Xmf\Database\TableLoad\truncateTable(), SystemModule\uninstall(), NotificationsNotificationHandler\unsubscribe(), SystemModule\update(), XoopsUserUtility\validate(), Xoops\Core\Security\validateToken(), XoopsCaptcha\verify(), XcaptchaRecaptcha\VerifyData(), CommentsSystemPlugin\waiting(), XoopsTheme\xoInit(), xoops_cp_footer(), xoops_cp_header(), xoops_getHandler(), xoops_module_install_comments(), xoops_module_install_debugbar(), xoops_module_install_notifications(), xoops_module_install_smilies(), xoops_module_install_system(), xoops_module_install_userrank(), xoops_module_pre_uninstall_comments(), xoops_module_pre_uninstall_notifications(), xoops_module_update_search(), xoops_module_update_system(), and MonologLogger\xoopsDataProcessor().

Xoops::getMailer ( )

Get Mailer

Returns
XoopsMailer|XoopsMailerLocale

Definition at line 1632 of file Xoops.php.

References Xoops_Locale\loadMailerLocale().

Here is the call graph for this function:

Xoops::getModuleByDirname (   $dirname)
Parameters
string$dirnamedirname of the module
Returns
bool|XoopsModule

Definition at line 1178 of file Xoops.php.

References $dirname, $module, cache(), and getHandlerModule().

Referenced by getModuleConfigs().

Here is the call graph for this function:

Here is the caller graph for this function:

Xoops::getModuleById (   $id)

Get Module By Id

Parameters
int$idId of the module
Returns
bool|XoopsModule

Definition at line 1195 of file Xoops.php.

References $id, $module, cache(), and getHandlerModule().

Referenced by templateClearModuleCache().

Here is the call graph for this function:

Here is the caller graph for this function:

Xoops::getModuleConfig (   $key,
  $dirname = '' 
)

getModuleConfig

Parameters
string$keyconfig name
string$dirnamemodule directory
Returns
mixed the value for the amed config

Definition at line 1812 of file Xoops.php.

References $dirname, getModuleConfigs(), and isModule().

Referenced by getConfig().

Here is the call graph for this function:

Here is the caller graph for this function:

Xoops::getModuleConfigs (   $dirname = '')

Get Module Configs

Parameters
string$dirname
Returns
array

Definition at line 1838 of file Xoops.php.

References $configs, $dirname, $module, cache(), getHandlerConfig(), getModuleByDirname(), and isModule().

Referenced by getConfigs(), and getModuleConfig().

Here is the call graph for this function:

Here is the caller graph for this function:

Xoops::getModuleForm (   $obj,
  $name,
  $module_dir = null 
)

Get Module Form

Parameters
XoopsObject$obj
string$name
string$module_dir
Returns
Xoops|bool

Definition at line 1021 of file Xoops.php.

References $name, XoopsLoad\fileExists(), XoopsBaseConfig\get(), and isModule().

Here is the call graph for this function:

Xoops::getModuleHandler (   $name = null,
  $module_dir = null,
  $optional = false 
)

Get Module Handler

Parameters
string | null$name
string | null$module_dir
bool$optional
Returns
XoopsObjectHandler|XoopsPersistableObjectHandler|bool

Definition at line 980 of file Xoops.php.

References $name, db(), XoopsLoad\fileExists(), and XoopsBaseConfig\get().

Here is the call graph for this function:

Xoops::getModuleHelper (   $dirname)

Get Module Helper

Parameters
string$dirname
Returns
bool|Xoops

Definition at line 1053 of file Xoops.php.

References $dirname.

Xoops::getOption (   $key)

Get Option

Parameters
string$key
Returns
string

Definition at line 1691 of file Xoops.php.

References option.

Xoops::getRank (   $rank_id = 0,
  $posts = 0 
)

getRank - retrieve user rank

Parameters
integer$rank_idspecified rank for user
int$postsnumber of posts for user
Returns
array

Definition at line 1655 of file Xoops.php.

References $myts, $sql, db(), and MyTextSanitizer\getInstance().

Here is the call graph for this function:

Xoops::getTplInfo (   $tpl_name)

Gets module, type and file from a tpl name

Parameters
string$tpl_namein form type:module/filename.tpl
Returns
array|false associative array of 'tpl_name', 'type', 'module', 'file' or false on error

Definition at line 555 of file Xoops.php.

References $i, $info, $tpl_name, events(), isAdminSide, and isModule().

Referenced by theme().

Here is the call graph for this function:

Here is the caller graph for this function:

Xoops::getUserGroups ( )
Returns
array of groups the current user is associted with

Definition at line 1411 of file Xoops.php.

References $groups, and isUser().

Here is the call graph for this function:

Xoops::getUserTimestamp (   $time,
  $timeoffset = '' 
)

Get User Timestamp

Parameters
mixed$time
string$timeoffset
Returns
int

Definition at line 1378 of file Xoops.php.

References getConfig(), and isUser().

Here is the call graph for this function:

Xoops::gzipCompression ( )

Start gzipCompression output buffer

Returns
void

Disable gzip compression if PHP is run under CLI mode and needs refactored to work correctly

Definition at line 480 of file Xoops.php.

References $_SERVER, getConfig(), and setConfig().

Here is the call graph for this function:

Xoops::header (   $tpl_name = null)

Render Header

Parameters
string | null$tpl_name
Returns
null|boolean

Definition at line 606 of file Xoops.php.

References $tpl_name, deprecated(), events(), exit, XoopsBaseConfig\get(), getConfig(), isAdminSide, isModule(), option, path(), theme(), and tpl().

Referenced by footer(), and simpleHeader().

Here is the call graph for this function:

Here is the caller graph for this function:

Xoops::isActiveModule (   $dirname)

Checks is module is installed and active

Parameters
string$dirnamemodule directory
Returns
bool

Definition at line 1165 of file Xoops.php.

References $dirname, and getActiveModules().

Here is the call graph for this function:

Xoops::isAdmin ( )

Check if user is admin

Returns
bool

Definition at line 732 of file Xoops.php.

References $userIsAdmin.

Xoops::isModule ( )

Check if a module is set

Returns
bool

Definition at line 712 of file Xoops.php.

Referenced by addConfigs(), appendConfig(), disableModuleCache(), getModuleConfig(), getModuleConfigs(), getModuleForm(), getTplInfo(), header(), redirect(), and setConfig().

Here is the caller graph for this function:

Xoops::isUser ( )

Check if a user is set

Returns
bool

Definition at line 722 of file Xoops.php.

Referenced by getUserGroups(), getUserTimestamp(), and Xoops\Module\Helper\HelperAbstract\isUserAdmin().

Here is the caller graph for this function:

Xoops::loadLanguage (   $name,
  $domain = '',
  $language = null 
)

XOOPS language loader wrapper Temporary solution, not encouraged to use

Parameters
string$nameName of language file to be loaded, without extension
mixed$domainstring: Module dirname; global language file will be loaded if $domain is set to 'global' or not specified array: example; array('Frameworks/moduleclasses/moduleadmin')
string$languageLanguage to be loaded, current language content will be loaded if not specified
Returns
boolean

Definition at line 1070 of file Xoops.php.

References $file, $language, $name, $path, XoopsLoad\fileExists(), Xoops_Locale_Abstract\getLegacyLanguage(), and path().

Here is the call graph for this function:

static Xoops::loadLocale (   $domain = 'xoops',
  $locale = null 
)
static

loadLocale

Parameters
string$domainModule dirname; global language file will be loaded if set to 'global' or not specified
string$localeLocale to be loaded, current language content will be loaded if not specified
Returns
boolean

Definition at line 1102 of file Xoops.php.

References Xoops_Locale\loadLocale().

Here is the call graph for this function:

Xoops::logger ( )

get the system logger instance

Returns

Definition at line 203 of file Xoops.php.

Referenced by deprecated(), getHandler(), and pathExists().

Here is the caller graph for this function:

Xoops::makePass ( )
Returns
string

Definition at line 1421 of file Xoops.php.

References $count.

Xoops::normalizePath (   $path)

Convert path separators to unix style

Parameters
string$pathpath to normalize
Returns
string normalized path

Definition at line 406 of file Xoops.php.

References $path.

Referenced by path().

Here is the caller graph for this function:

Xoops::path (   $url,
  $virtual = false 
)

Convert a XOOPS path to a physical one

Parameters
string$url
bool$virtual
Returns
string

Definition at line 377 of file Xoops.php.

References $path, $root, $url, XoopsBaseConfig\get(), and normalizePath().

Referenced by header(), loadLanguage(), simpleHeader(), and url().

Here is the call graph for this function:

Here is the caller graph for this function:

Xoops::pathExists (   $path,
  $error_type 
)

Check if a path exists

Parameters
string$path
string$error_type
Returns
string|false

Definition at line 459 of file Xoops.php.

References $path, XoopsLocaleEn_US\E_FILE_NOT_FOUND, XoopsLoad\fileExists(), logger(), and WARNING.

Here is the call graph for this function:

Xoops::pathTranslation ( )

Translate a path

Returns
void

*#@+ Host abstraction layer

User Mulitbytes

Definition at line 502 of file Xoops.php.

References $_SERVER.

Referenced by __construct().

Here is the caller graph for this function:

Xoops::preload ( )

Deprecated - use events() instead

Returns
XoopsPreload

Definition at line 224 of file Xoops.php.

References events().

Here is the call graph for this function:

Xoops::redirect (   $url,
  $time = 3,
  $message = '',
  $addredirect = true,
  $allowExternalLink = false 
)

Function to redirect a user to certain pages

Parameters
string$url
int$time
string$message
bool$addredirect
bool$allowExternalLink
Returns
void

Definition at line 1503 of file Xoops.php.

References $_SERVER, $theme, $url, $xoops_url, XoopsLocaleEn_US\E_TAKING_YOU_BACK, events(), exit, XoopsLocaleEn_US\F_IF_PAGE_NOT_RELOAD_CLICK_HERE, XoopsBaseConfig\get(), getConfig(), getCss(), isModule(), setTheme(), setTpl(), theme(), and tpl().

Here is the call graph for this function:

Xoops::registry ( )

provide a common registry instance

Returns
Xoops

Definition at line 264 of file Xoops.php.

Xoops::security ( )

get security instance

Returns
XoopsSecurity

Definition at line 278 of file Xoops.php.

Referenced by confirm().

Here is the caller graph for this function:

Xoops::service (   $service)

get the service manager

Parameters
string$service- service name
Returns
Xoops instance

Definition at line 250 of file Xoops.php.

Referenced by Xoops\Core\Service\Provider\__construct(), and Xoops\Core\Service\Provider\register().

Here is the caller graph for this function:

Xoops::session ( )

Get the session manager

Returns
Xoops

Definition at line 898 of file Xoops.php.

References $sessionManager.

Referenced by Xoops\Core\Session\SessionUser\__construct(), Xoops\Core\Session\SessionUser\checkConfirmed(), Xoops\Core\Session\SessionUser\recordUserLogout(), Xoops\Core\Session\SessionUser\setConfirmed(), and Xoops\Core\Session\SessionUser\setNeedsConfirmed().

Here is the caller graph for this function:

Xoops::setActiveModules ( )

Write active modules to cache file

Returns
array

Definition at line 1146 of file Xoops.php.

References $module, $module_handler, $modules_active, $modules_array, cache(), and getHandlerModule().

Referenced by getActiveModules().

Here is the call graph for this function:

Here is the caller graph for this function:

Xoops::setConfig (   $key,
  $value = null,
  $dirname = 'system' 
)

Set Config Value

Parameters
string$key
mixed$value
string$dirname
Returns
void

Definition at line 1765 of file Xoops.php.

References $dirname, and isModule().

Referenced by gzipCompression(), and themeSelect().

Here is the call graph for this function:

Here is the caller graph for this function:

Xoops::setOption (   $key,
  $value = null 
)

Set Option

Parameters
string$key
null$value
Returns
void

Definition at line 1708 of file Xoops.php.

References option.

Xoops::setTheme ( XoopsTheme  $theme)

set theme

Parameters
XoopsTheme$themetheme
Returns
XoopsTheme

Definition at line 364 of file Xoops.php.

References $theme, and theme().

Referenced by redirect(), and theme().

Here is the call graph for this function:

Here is the caller graph for this function:

Xoops::setTpl ( XoopsTpl  $tpl)

set curent template engine

Parameters
XoopsTpl$tpltemplate engine
Returns
XoopsTpl

Definition at line 304 of file Xoops.php.

References $tpl, and tpl().

Referenced by redirect().

Here is the call graph for this function:

Here is the caller graph for this function:

Xoops::simpleFooter ( )

Render simpleFooter

Returns
void

Definition at line 1263 of file Xoops.php.

References events().

Here is the call graph for this function:

Xoops::simpleHeader (   $closehead = true)

Render Simple Header

Parameters
bool$closehead
Returns
void

Definition at line 1212 of file Xoops.php.

References $xoops, $xoops_url, events(), XoopsLoad\fileExists(), XoopsBaseConfig\get(), Xoops_Locale_Abstract\getCharset(), getConfig(), getConfigs(), getCss(), getInstance(), Xoops_Locale_Abstract\getLangCode(), header(), path(), theme(), and url().

Here is the call graph for this function:

Xoops::templateClearModuleCache (   $mid)

Clear the module cache

Parameters
int$midModule ID
Returns
void

Definition at line 1963 of file Xoops.php.

References $mid, $module, $xoopsTpl, and getModuleById().

Here is the call graph for this function:

Xoops::templateTouch (   $tpl_id)

function to update compiled template file in cache folder

Parameters
string$tpl_id
Returns
boolean

Definition at line 1942 of file Xoops.php.

References $file, $module, $tpl, $type, and getHandlerTplfile().

Here is the call graph for this function:

Xoops::theme (   $tpl_name = null)
Parameters
null | string$tpl_namebase template
Returns
null|XoopsTheme

Definition at line 314 of file Xoops.php.

References $GLOBALS, $theme, $tpl_name, getConfig(), getTplInfo(), isAdminSide, and setTheme().

Referenced by footer(), header(), redirect(), setTheme(), and simpleHeader().

Here is the call graph for this function:

Here is the caller graph for this function:

Xoops::themeSelect ( )

Select Theme

Returns
void

Definition at line 534 of file Xoops.php.

References $_SESSION, getConfig(), and setConfig().

Here is the call graph for this function:

Xoops::tpl ( )

get current template engine

Returns
null|XoopsTpl

Definition at line 292 of file Xoops.php.

References $tpl.

Referenced by header(), redirect(), and setTpl().

Here is the caller graph for this function:

Xoops::translate (   $key,
  $dirname = 'xoops' 
)

Translate a key value

Parameters
string$key
string$dirname
Returns
string

Definition at line 1115 of file Xoops.php.

References $dirname, and Xoops_Locale\translate().

Here is the call graph for this function:

Xoops::url (   $url)

Convert a XOOPS path to an URL

Parameters
string$url
Returns
string

Definition at line 418 of file Xoops.php.

References $url, and path().

Referenced by simpleHeader().

Here is the call graph for this function:

Here is the caller graph for this function:

Xoops::userTimeToServerTime (   $timestamp,
  $userTZ = null 
)

Function to calculate server timestamp from user entered time (timestamp)

Parameters
int$timestamp
null$userTZ
Returns
int

Definition at line 1399 of file Xoops.php.

References getConfig().

Here is the call graph for this function:

Member Data Documentation

Xoops::$activeModules = null
private

Definition at line 106 of file Xoops.php.

Referenced by getActiveModules().

Xoops::$config = array()

Definition at line 43 of file Xoops.php.

Referenced by Xoops\Core\Database\Connection\__construct(), and Xoops\Core\Database\Factory\getConnection().

Xoops::$isAdminSide = false

Definition at line 116 of file Xoops.php.

Xoops::$kernelHandlers = array()
private

Definition at line 96 of file Xoops.php.

Xoops::$module = null

Definition at line 38 of file Xoops.php.

Referenced by getModuleByDirname(), getModuleById(), getModuleConfigs(), setActiveModules(), Xoops\Core\Events\setPreloads(), templateClearModuleCache(), and templateTouch().

Xoops::$moduleConfig = array()

Definition at line 48 of file Xoops.php.

Xoops::$moduleConfigs = array()
private

Definition at line 111 of file Xoops.php.

Xoops::$moduleDirname = ''

Definition at line 53 of file Xoops.php.

Xoops::$moduleHandlers = array()
private

Definition at line 101 of file Xoops.php.

Xoops::$option = array()

Definition at line 68 of file Xoops.php.

Referenced by Xoops\Form\Radio\getOptions(), and Xoops\Form\GroupFormCheckbox\renderOptionTree().

Xoops::$paths
Initial value:
= array(
'XOOPS' => array(), 'www' => array(), 'var' => array(), 'lib' => array(), 'modules' => array(),
'themes' => array(), 'media' => array()
)

Definition at line 83 of file Xoops.php.

Xoops::$sessionManager = null

Definition at line 33 of file Xoops.php.

Referenced by session().

Xoops::$theme = null
private

Definition at line 78 of file Xoops.php.

Referenced by getCss(), redirect(), setTheme(), and theme().

Xoops::$tpl = null
private

Definition at line 73 of file Xoops.php.

Referenced by alert(), confirm(), setTpl(), templateTouch(), and tpl().

Xoops::$tpl_name = ''

Definition at line 91 of file Xoops.php.

Referenced by footer(), getTplInfo(), header(), and theme().

Xoops::$user = ''

Definition at line 58 of file Xoops.php.

Referenced by Xoops\Core\Session\SessionUser\addUserToSession(), and Xoops\Auth\Xoops\authenticate().

Xoops::$userIsAdmin = false

Definition at line 63 of file Xoops.php.

Referenced by isAdmin().

const Xoops::VERSION = 'XOOPS 2.6.0-Alpha 3'

Definition at line 28 of file Xoops.php.

Referenced by XoopsTpl\__construct(), Xmf\Template\Feed\init(), and Xoops\Module\Admin\renderIndex().

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