Class Xoops

XOOPS

Package: Xoops
Category: Xoops
Copyright: 2011-2015 XOOPS Project (http://xoops.org)
License: GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
Author: trabis lusopoemas@gmail.com
Author: formuss
Author: Richard Griffith richard@geekwright.com
Link: http://xoops.org
Located at oops_lib/Xoops.php

Methods summary
`public static Xoops`	# `getInstance( )` Access the only instance of this class Access the only instance of this class Returns `Xoops`
`public Xoops\Core\Database\Connection`	# `db( )` get database connection instance get database connection instance Returns `Xoops\Core\Database\Connection`
`public Xoops\Core\Cache\Access`	# `cache( string $cacheName = 'default' )` get a \Xoops\Core\Cache\Access object for a named cache get a \Xoops\Core\Cache\Access object for a named cache Parameters `$cacheName` a named cached pool Returns `Xoops\Core\Cache\Access`
`public Xoops\Core\Logger`	# `logger( )` get the system logger instance get the system logger instance Returns `Xoops\Core\Logger`
`public Xoops\Core\Events`	# `events( )` get the event processor get the event processor Returns `Xoops\Core\Events` instance
`public Xoops\Core\Assets`	# `assets( )` get the asset utility get the asset utility Returns `Xoops\Core\Assets` instance
`public Xoops\Core\Service\Provider`	# `service( string $service )` get the service manager get the service manager Parameters `$service` service name Returns `Xoops\Core\Service\Provider` instance
`public Xoops\Core\Registry`	# `registry( )` provide a common registry instance provide a common registry instance Returns `Xoops\Core\Registry`
`public XoopsSecurity`	# `security( )` get security instance get security instance Returns `XoopsSecurity`
`public null\|XoopsTpl`	# `tpl( )` get current template engine get current template engine Returns null\|`XoopsTpl`
`public XoopsTpl`	# `setTpl( Xoops\Core\XoopsTpl $tpl )` set current template engine set current template engine Parameters `$tpl` template engine Returns `XoopsTpl`
`public null\|XoopsTheme`	# `theme( null\|string $tpl_name = null )` establish the theme establish the theme Parameters `$tpl_name` base template Returns null\|`XoopsTheme`
`public XoopsTheme`	# `setTheme( Xoops\Core\Theme\XoopsTheme $theme )` set theme set theme Parameters `$theme` theme Returns `XoopsTheme`
`public string`	# `path( string $url, boolean $virtual = false )` Convert a XOOPS path to a physical one Convert a XOOPS path to a physical one Parameters `$url` url to derive path from `$virtual` virtual Returns string
`public string`	# `normalizePath( string $path )` Convert path separators to unix style Convert path separators to unix style Parameters `$path` path to normalize Returns string normalized path
`public string`	# `url( string $url )` Convert a XOOPS path to an URL Convert a XOOPS path to an URL Parameters `$url` path (or url) Returns string
`public string`	# `buildUrl( string $url, array $params = array() )` Build an URL with the specified request params Build an URL with the specified request params Parameters `$url` base url `$params` parameters to add to the url Returns string
`public string\|false`	# `pathExists( string $path, string $error_type )` Check if a path exists Check if a path exists Parameters `$path` filesystem path `$error_type` error level i.e. Psr\Log\LogLevel Returns string\|false
`public`	# `gzipCompression( )` Start gzipCompression output buffer Start gzipCompression output buffer
`public`	# `pathTranslation( )` Translate a path Translate a path
`public`	# `themeSelect( )` Select Theme Select Theme
`public array\|false`	# `getTplInfo( string $tpl_name )` Gets module, type and file from a tpl name Gets module, type and file from a tpl name Parameters `$tpl_name` in form type:module/filename.tpl Returns array\|false associative array of 'tpl_name', 'type', 'module', 'file' or false on error
`public null\|boolean`	# `header( string\|null $tpl_name = null )` Render Header Render Header Parameters `$tpl_name` template name Returns null\|boolean
`public false\|null`	# `footer( )` Render Footer Render Footer Returns false\|null
`public boolean`	# `isModule( )` Check if a module is set Check if a module is set Returns boolean
`public boolean`	# `isUser( )` Check if a user is set Check if a user is set Returns boolean
`public boolean`	# `isAdmin( )` Check if user is admin Check if user is admin Returns boolean
`public Xoops\Core\Kernel\Handlers\XoopsBlockHandler`	# `getHandlerBlock( boolean $optional = false )` Get handler of Block Get handler of Block Parameters `$optional` true if failure to load handler should be considered a warning, not an error Returns `Xoops\Core\Kernel\Handlers\XoopsBlockHandler`
`public Xoops\Core\Kernel\Handlers\XoopsBlockModuleLinkHandler`	# `getHandlerBlockModuleLink( boolean $optional = false )` Get handler of Block Module Link Get handler of Block Module Link Parameters `$optional` true if failure to load handler should be considered a warning, not an error Returns `Xoops\Core\Kernel\Handlers\XoopsBlockModuleLinkHandler`
`public Xoops\Core\Kernel\Handlers\XoopsConfigHandler`	# `getHandlerConfig( boolean $optional = false )` Get handler of Config Get handler of Config Parameters `$optional` true if failure to load handler should be considered a warning, not an error Returns `Xoops\Core\Kernel\Handlers\XoopsConfigHandler`
`public Xoops\Core\Kernel\Handlers\XoopsConfigItemHandler`	# `getHandlerConfigItem( boolean $optional = false )` Get handler of Config Item Get handler of Config Item Parameters `$optional` true if failure to load handler should be considered a warning, not an error Returns `Xoops\Core\Kernel\Handlers\XoopsConfigItemHandler`
`public Xoops\Core\Kernel\Handlers\XoopsConfigOptionHandler`	# `getHandlerConfigOption( boolean $optional = false )` Get handler of Config Option Get handler of Config Option Parameters `$optional` true if failure to load handler should be considered a warning, not an error Returns `Xoops\Core\Kernel\Handlers\XoopsConfigOptionHandler`
`public Xoops\Core\Kernel\Handlers\XoopsGroupHandler`	# `getHandlerGroup( boolean $optional = false )` Get handler of Group Get handler of Group Parameters `$optional` true if failure to load handler should be considered a warning, not an error Returns `Xoops\Core\Kernel\Handlers\XoopsGroupHandler`
`public Xoops\Core\Kernel\Handlers\XoopsGroupPermHandler`	# `getHandlerGroupPermission( boolean $optional = false )` Get handler of Group Permission Get handler of Group Permission Parameters `$optional` true if failure to load handler should be considered a warning, not an error Returns `Xoops\Core\Kernel\Handlers\XoopsGroupPermHandler`
`public Xoops\Core\Kernel\Handlers\XoopsMemberHandler`	# `getHandlerMember( boolean $optional = false )` Get handler of Member Get handler of Member Parameters `$optional` true if failure to load handler should be considered a warning, not an error Returns `Xoops\Core\Kernel\Handlers\XoopsMemberHandler`
`public Xoops\Core\Kernel\Handlers\XoopsMembershipHandler`	# `getHandlerMembership( boolean $optional = false )` Get handler of Membership Get handler of Membership Parameters `$optional` true if failure to load handler should be considered a warning, not an error Returns `Xoops\Core\Kernel\Handlers\XoopsMembershipHandler`
`public Xoops\Core\Kernel\Handlers\XoopsModuleHandler`	# `getHandlerModule( boolean $optional = false )` Get handler of Module Get handler of Module Parameters `$optional` true if failure to load handler should be considered a warning, not an error Returns `Xoops\Core\Kernel\Handlers\XoopsModuleHandler`
`public Xoops\Core\Kernel\Handlers\XoopsOnlineHandler`	# `getHandlerOnline( boolean $optional = false )` Get handler of Online Get handler of Online Parameters `$optional` true if failure to load handler should be considered a warning, not an error Returns `Xoops\Core\Kernel\Handlers\XoopsOnlineHandler`
`public Xoops\Core\Kernel\Handlers\XoopsPrivateMessageHandler`	# `getHandlerPrivateMessage( boolean $optional = false )` Get handler of Private Message Get handler of Private Message Parameters `$optional` true if failure to load handler should be considered a warning, not an error Returns `Xoops\Core\Kernel\Handlers\XoopsPrivateMessageHandler`
`public Xoops\Core\Session\Manager`	# `session( )` Get the session manager Get the session manager Returns `Xoops\Core\Session\Manager`
`public Xoops\Core\Kernel\Handlers\XoopsTplFileHandler`	# `getHandlerTplFile( boolean $optional = false )` Get handler of Template File Get handler of Template File Parameters `$optional` true if failure to load handler should be considered a warning, not an error Returns `Xoops\Core\Kernel\Handlers\XoopsTplFileHandler`
`public Xoops\Core\Kernel\Handlers\XoopsTplSetHandler`	# `getHandlerTplSet( boolean $optional = false )` Get handler of Template Set Get handler of Template Set Parameters `$optional` true if failure to load handler should be considered a warning, not an error Returns `Xoops\Core\Kernel\Handlers\XoopsTplSetHandler`
`public Xoops\Core\Kernel\Handlers\XoopsUserHandler`	# `getHandlerUser( boolean $optional = false )` Get handler of User Get handler of User Parameters `$optional` true if failure to load handler should be considered a warning, not an error Returns `Xoops\Core\Kernel\Handlers\XoopsUserHandler`
`protected XoopsObjectHandler\|XoopsPersistableObjectHandler\|null`	# `getHandler( string $name, boolean $optional = false )` Get handler Get handler Parameters `$name` name of handler `$optional` true if failure to load handler should be considered a warning, not an error Returns `XoopsObjectHandler`\|`XoopsPersistableObjectHandler`\|null
`public XoopsObjectHandler\|XoopsPersistableObjectHandler\|boolean`	# `getModuleHandler( string\|null $name = null, string\|null $module_dir = null, boolean $optional = false )` Get Module Handler Get Module Handler Parameters `$name` name of handler `$module_dir` dirname of module `$optional` true if failure to load handler should be considered a warning, not an error Returns `XoopsObjectHandler`\|`XoopsPersistableObjectHandler`\|boolean
`public Xoops\Form\Form\|boolean`	# `getModuleForm( XoopsObject $obj, string $name, string $module_dir = null )` Get Module Form Get Module Form Parameters `$obj` object to populate form `$name` name of form `$module_dir` dirname of associated module Returns `Xoops\Form\Form`\|boolean
`public static boolean\|Xoops\Module\Helper\HelperAbstract`	# `getModuleHelper( string $dirname )` Get Module Helper Get Module Helper Parameters `$dirname` dirname of module Returns boolean\|`Xoops\Module\Helper\HelperAbstract`
`public boolean`	# `loadLanguage( string $name, mixed $domain = '', string $language = null )` XOOPS language loader wrapper Temporary solution, not encouraged to use XOOPS language loader wrapper Temporary solution, not encouraged to use Parameters `$name` Name of language file to be loaded, without extension `$domain` string: Module dirname; global language file will be loaded if $domain is set to 'global' or not specified array: example; array('Frameworks/moduleclasses/moduleadmin') `$language` Language to be loaded, current language content will be loaded if not specified Returns boolean
`public static boolean`	# `loadLocale( string $domain = null, string $locale = null )` loadLocale loadLocale Parameters `$domain` Module dirname; global language file will be loaded if set to 'global' or not specified `$locale` Locale to be loaded, current language content will be loaded if not specified Returns boolean
`public string`	# `translate( string $key, string $dirname = 'xoops' )` Translate a key value Translate a key value Parameters `$key` constant name `$dirname` dirname of module (domain) Returns string
`public array`	# `getActiveModules( )` Get active modules from cache file Get active modules from cache file Returns array
`public array`	# `setActiveModules( )` Write active modules to cache file Write active modules to cache file Returns array
`public boolean`	# `isActiveModule( string $dirname )` Checks is module is installed and active Checks is module is installed and active Parameters `$dirname` module directory Returns boolean
`public boolean\|XoopsModule`	# `getModuleByDirname( string $dirname )` get module object from module name (dirname) get module object from module name (dirname) Parameters `$dirname` dirname of the module Returns boolean\|`XoopsModule`
`public boolean\|XoopsModule`	# `getModuleById( integer $id )` Get Module By Id Get Module By Id Parameters `$id` Id of the module Returns boolean\|`XoopsModule`
`public`	# `simpleHeader( boolean $closehead = true )` Render Simple Header Render Simple Header Parameters `$closehead` true to close the HTML head element
`public`	# `simpleFooter( )` Render simpleFooter Render simpleFooter
`public string`	# `alert( string $type, mixed $msg, string $title = '/' )` render an alert message to a string render an alert message to a string Parameters `$type` alert type, one of 'info', 'error', 'success' or 'warning' `$msg` string or array of strings `$title` title for alert Returns string
`public string`	# `confirm( array $hiddens, string $action, string $msg, string $submit = '', boolean $addtoken = true )` Render a confirmation form to a string Render a confirmation form to a string Parameters `$hiddens` associative array of values used to complete confirmed action `$action` form action (URL) `$msg` message to display `$submit` submit button message `$addtoken` true to add CSRF token Returns string rendered confirm message
`public integer`	# `getUserTimestamp( DateTime\|integer $time )` Get User Timestamp (kind of pointless, since timestamps are UTC?) Get User Timestamp (kind of pointless, since timestamps are UTC?) Parameters `$time` DateTime object or unix timestamp Returns integer unix timestamp
`public integer`	# `userTimeToServerTime( integer $timestamp, null $userTZ = null )` Function to calculate server timestamp from user entered time (timestamp) Function to calculate server timestamp from user entered time (timestamp) Parameters `$timestamp` time stamp `$userTZ` timezone Returns integer
`public int[]`	# `getUserGroups( )` get the groups associated with the current user get the groups associated with the current user Returns int[]
`public string`	# `makePass( )` generate a temporary password generate a temporary password Returns string
`public false\|string`	# `checkEmail( string $email, boolean $antispam = false )` Check Email Check Email Parameters `$email` check email `$antispam` true if returned email should be have anti-SPAM measures applied Returns false\|string email address if valid, otherwise false
`public string`	# `formatURL( string $url )` formatURL - add default http:// if no valid protocol specified formatURL - add default http:// if no valid protocol specified Parameters `$url` full or partial url Returns string
`public string`	# `getBanner( )` Function to get banner html tags for use in templates Function to get banner html tags for use in templates Returns string
`public`	# `redirect( string $url, integer $time = 3, string $message = '', boolean $addredirect = true, boolean $allowExternalLink = false )` Function to redirect a user to certain pages Function to redirect a user to certain pages Parameters `$url` URL to redirect to `$time` time to wait (to allow reading message display) `$message` message to display `$addredirect` add xoops_redirect parameter with current URL to the redirect URL - used for return from login redirect `$allowExternalLink` allow redirect to external URL
`public static`	# `simpleRedirect( string $url )` Do an immediate redirect to the specified url. Use this instead of using PHP's header() directly so that a core.redirect.start event is triggered. An example is debugbar, that stacks data so the details for both original and redirected scripts data are available. Do an immediate redirect to the specified url. Use this instead of using PHP's header() directly so that a core.redirect.start event is triggered. An example is debugbar, that stacks data so the details for both original and redirected scripts data are available. Parameters `$url` URL to redirect to
`public string`	# `getEnv( string $key )` Get Environment Value Get Environment Value Parameters `$key` key (name) in the environment Returns string
`public string`	# `getCss( string $theme = '' )` Function to get css file for a certain themeset Function to get css file for a certain themeset Parameters `$theme` theme name Returns string
`public XoopsMailer\|XoopsMailerLocale`	# `getMailer( )` Get Mailer Get Mailer Returns `XoopsMailer`\|`XoopsMailerLocale`
`public string`	# `getOption( string $key )` Get Option Get Option Parameters `$key` key (name) of option Returns string
`public`	# `setOption( string $key, null $value = null )` Set Option Set Option Parameters `$key` key (name) of option `$value` value for option
`public mixed`	# `getConfig( string $key )` Get Config value Get Config value Parameters `$key` key (name) of configuration Returns mixed
`public array`	# `getConfigs( )` Get all Config Values Get all Config Values Returns array
`public`	# `addConfigs( array $configs, string $dirname = 'system' )` Add Config Values Add Config Values Parameters `$configs` array of configs `$dirname` module name
`public`	# `setConfig( string $key, mixed $value = null, string $dirname = 'system' )` Set Config Value Set Config Value Parameters `$key` key (name) of the configuration item `$value` configuration value `$dirname` dirname of module
`public`	# `unsetConfig( string $key, string $dirname = 'system' )` Unset Config Value Unset Config Value Parameters `$key` key (name) of the configuration item `$dirname` dirname of module
`public`	# `clearModuleConfigsCache( )` Unset all module configs Unset all module configs
`public mixed`	# `getModuleConfig( string $key, string $dirname = '' )` getModuleConfig getModuleConfig Parameters `$key` config name `$dirname` module directory Returns mixed the value for the named config
`public array`	# `getModuleConfigs( string $dirname = '' )` Get Module Configs Get Module Configs Parameters `$dirname` dirname of module Returns array
`public`	# `appendConfig( string $key, array $values, boolean $appendWithKey = false, string $dirname = 'system' )` Append Config Value Append Config Value Parameters `$key` key (name) of the configuration item `$values` array of configuration value `$appendWithKey` true to add each $value element with associative value false to add $values as a single index element `$dirname` dirname of module
`public`	# `disableModuleCache( )` Disables page cache by overriding module cache settings Disables page cache by overriding module cache settings
`public Pdp\Uri\Url\Host\|string\|null`	# `getBaseDomain( string $url, boolean $includeSubdomain = false, boolean $returnObject = false )` getBaseDomain 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 `$url` URL `$includeSubdomain` true to include include subdomains, default is false registerable domain only `$returnObject` true to return Pdp\Uri\Url\Host object false returns domain as string Returns Pdp\Uri\Url\Host\|string\|null domain, or null if domain is invalid
`public boolean`	# `templateTouch( string $tpl_id )` function to update compiled template file in cache folder function to update compiled template file in cache folder Parameters `$tpl_id` template id Returns boolean
`public`	# `templateClearModuleCache( integer $mid )` Clear the module cache Clear the module cache Parameters `$mid` Module ID
`public`	# `deprecated( string $message )` Support for deprecated messages events Support for deprecated messages events Parameters `$message` message
`public`	# `disableErrorReporting( )` Support for disabling error reporting Support for disabling error reporting

Constants summary
`string`	`VERSION`	# `'XOOPS 2.6.0-Alpha 3'`

Properties summary
`public null\|Xoops\Core\Session\Manager`	`$sessionManager`	# `null`
`public null\|XoopsModule`	`$module`	# `null`
`public array`	`$config`	# `array()`
`public array`	`$moduleConfig`	# `array()`
`public array`	`$moduleDirname`	# `''`
`public XoopsUser\|string`	`$user`	# `''`
`public boolean`	`$userIsAdmin`	# `false`
`public array`	`$option`	# `array()`
`public array`	`$paths`	# `array( 'XOOPS' => array(), 'www' => array(), 'var' => array(), 'lib' => array(), 'modules' => array(), 'themes' => array(), 'media' => array() )`
`public string`	`$tpl_name`	# `''`
`public boolean`	`$isAdminSide`	# `false`

Namespaces

Classes

Interfaces

Functions

Class Xoops

Returns

Returns

Parameters

Returns

Returns

Returns

Returns

Parameters

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns