XOOPS Docs - XOOPS
[ class tree: XOOPS ] [ index: XOOPS ] [ all elements ]
Packages:
XOOPS
class
kernal
kernel
PHPMailer
Smarty
xoops
xoops20
xos_kernel
xos_logos
xos_opal


Files:
admin.php
admin.php
admin.php
admin.php
admin_header.php
auth.php
avatar.php
avatars.php
backend.php
banners.php
banners.php
banners.php
blockform.php
blocks.php
blocksadmin.php
blocksadmin.php
bloggerapi.php
cachemanager.php
calendar.php
calendarjs.php
checklogin.php
class.zipfile.php
comment.php
commentform.inc.php
comments.php
comment_constants.php
comment_delete.php
comment_delete.php
comment_edit.php
comment_edit.php
comment_form.php
comment_new.php
comment_post.php
comment_post.php
comment_reply.php
comment_view.php
common.php
config.php
constants.php
cp_functions.php
cp_header.php
databasefactory.php
dbmanager.php
edituser.php
errorhandler.php
findusers.php
findusers.php
findusers.php
finish.php
footer.php
formhiddentoken.php
function.xoInboxCount.php
function.xoops_link.php
functions.php
global.php
groupform.php
groupperm.php
groups.php
groups.php
header.php
image.php
imagecategory.php
imagemanager.php
images.php
imageset.php
imagesetimg.php
index.php
index.php
install.php
install2.php
install_tpl.php
logger_render.php
login.php
lostpass.php
mail.php
mailform.php
mailusers.php
mailusers.php
main.php
main.php
main.php
main.php
main.php
main.php
main.php
main.php
main.php
main.php
main.php
main.php
main.php
main.php
main.php
mainfile.dist.php
mainfile.php
mainfilemanager.php
makedata.php
menu.php
metaweblogapi.php
mimetypes.inc.php
misc.php
misc.php
modinfo.php
modulesadmin.php
modulesadmin.php
movabletypeapi.php
notification.php
notifications.php
notification_constants.php
notification_functions.php
notification_select.php
notification_update.php
old_functions.php
old_theme_functions.php
passwd.php
pda.php
phpmailer.lang-en.php
pmlite.php
pmsg.php
preferences.php
rankform.php
readpmsg.php
register.php
registerform.php
resource.db.php
saxparser.php
search.php
search.php
searchform.php
settingmanager.php
site-closed.php
smileform.php
smilies.php
smilies.php
snoopy.php
system_blocks.php
textsanitizer.php
themeimgform.php
themesetparser.php
timezone.php
tplfile.php
tplform.php
tplset.php
tplsets.php
update.php
uploader.php
user.php
user.php
userform.php
userinfo.php
userrank.php
userrank.php
users.php
users.php
version.php
version.php
viewpmsg.php
welcome.php
xmlrpc.php
xmlrpcapi.php
xmlrpcparser.php
xmlrpctag.php
xmlrss2parser.php
xmltaghandler.php
xoopsapi.php
xoopsblock.php
xoopscodes.php
xoopscomments.php
xoopsformloader.php
xoopslists.php
xoopsmailerlocal.php
xoopsmodule.php
xoopssecurity.php
xoopsstory.php
xoopstopic.php
xoopstree.php
xoopsuser.php
xoops_version.php
xoops_version.php
xoops_version.php
xoops_version.php
xoops_version.php
xoops_version.php
xoops_version.php
xoops_version.php
xoops_version.php
xoops_version.php
xoops_version.php
xoops_version.php
xoops_version.php
xoops_version.php
xoops_version.php
xoops_version.php
zipdownloader.php

Classes:
BloggerApi
cache_manager
db_manager
mainfile_manager
MetaWeblogApi
MovableTypeApi
RpcArrayHandler
RpcBase64Handler
RpcBooleanHandler
RpcDateTimeHandler
RpcDoubleHandler
RpcIntHandler
RpcMemberHandler
RpcMethodNameHandler
RpcNameHandler
RpcStringHandler
RpcStructHandler
RpcValueHandler
RssAuthorHandler
RssCategoryHandler
RssChannelHandler
RssCommentsHandler
RssCopyrightHandler
RssDescriptionHandler
RssDocsHandler
RssGeneratorHandler
RssGuidHandler
RssHeightHandler
RssImageHandler
RssItemHandler
RssLanguageHandler
RssLastBuildDateHandler
RssLinkHandler
RssManagingEditorHandler
RssNameHandler
RssPubDateHandler
RssSourceHandler
RssTextInputHandler
RssTitleHandler
RssTtlHandler
RssUrlHandler
RssWebMasterHandler
RssWidthHandler
SaxParser
setting_manager
Snoopy
TextSanitizer
ThemeSetAuthorHandler
ThemeSetDateCreatedHandler
ThemeSetDescriptionHandler
ThemeSetEmailHandler
ThemeSetFileTypeHandler
ThemeSetGeneratorHandler
ThemeSetImageHandler
ThemeSetLinkHandler
ThemeSetModuleHandler
ThemeSetNameHandler
ThemeSetTagHandler
ThemeSetTemplateHandler
XmlTagHandler
XoopsApi
XoopsConfigHandler
XoopsDatabaseFactory
XoopsLists
XoopsSecurity
XoopsStory
XoopsThemeSetParser
XoopsTopic
XoopsTree
XoopsXmlRpcApi
XoopsXmlRpcArray
XoopsXmlRpcBase64
XoopsXmlRpcBoolean
XoopsXmlRpcDatetime
XoopsXmlRpcDocument
XoopsXmlRpcDouble
XoopsXmlRpcFault
XoopsXmlRpcInt
XoopsXmlRpcParser
XoopsXmlRpcRequest
XoopsXmlRpcResponse
XoopsXmlRpcString
XoopsXmlRpcStruct
XoopsXmlRpcTag
XoopsXmlRss2Parser
xos_kernel_Xoops2
zipfile

Class: XoopsSecurity

Source Location: /class/xoopssecurity.php

Class Overview










Variables





Methods















Class Details



[line 41]






[ Top ]






Class Variables



 
 

 
$errors = array()

 
[line 42]

 

 

 

 

 Type:  
 mixed
 

 

 



 
[ Top ]









Class Methods



 

 
 
constructor XoopsSecurity [line 47]

 

 

 

 XoopsSecurity XoopsSecurity(
)
 

 


 Constructor




 
[ Top ]

 

 

 
 
method check [line 58]

 

 

 

 bool check(
[bool
$clearIfValid = true], [string
$token = false])
 

 


 Check if there is a valid token in $_REQUEST['XOOPS_TOKEN_REQUEST'] - can be expanded for more wide use, later (Mith)




 
Parameters:

 

 

 

 bool  
 $clearIfValid  
 whether to clear the token after validation
 

 

 string  
 $token  
 token to validate
 

 

 


 
[ Top ]

 

 

 
 
method checkBadips [line 199]

 

 

 

 void checkBadips(
)
 

 


 Check if visitor's IP address is banned Should be changed to return bool and let the action be up to the calling script




 
[ Top ]

 

 

 
 
method checkReferer [line 164]

 

 

 

 bool checkReferer(
[int
$docheck = 1])
 

 


 Check the user agent's HTTP REFERER against XOOPS_URL




 
Parameters:

 

 

 

 int  
 $docheck  
 0 to not check the referer (used with XML-RPC), 1 to actively check it
 

 

 


 
[ Top ]

 

 

 
 
method checkSuperglobals [line 184]

 

 

 

 void checkSuperglobals(
)
 

 


 Check superglobals for contamination




 
[ Top ]

 

 

 
 
method clearTokens [line 130]

 

 

 

 void clearTokens(
)
 

 


 Clear all token values from user's session




 
[ Top ]

 

 

 
 
method createToken [line 69]

 

 

 

 string createToken(
[int
$timeout = 0])
 

 


 Create a token in the user's session





Tags:





 

 return:  token value
 








 
Parameters:

 

 

 

 int  
 $timeout  
 time in seconds the token should be valid
 

 

 


 
[ Top ]

 

 

 
 
method filterToken [line 142]

 

 

 

 bool filterToken(
string
$token)
 

 


 Check whether a token value is expired or not




 
Parameters:

 

 

 

 string  
 $token  
 
 

 

 


 
[ Top ]

 

 

 
 
method garbageCollection [line 152]

 

 

 

 void garbageCollection(
)
 

 


 Perform garbage collection, clearing expired tokens




 
[ Top ]

 

 

 
 
method getErrors [line 241]

 

 

 

 array|string &getErrors(
[bool
$ashtml = false])
 

 


 Get generated errors





Tags:





 

 return:  Array of array messages OR HTML string
 








 
Parameters:

 

 

 

 bool  
 $ashtml  
 Format using HTML?
 

 

 


 
[ Top ]

 

 

 
 
method getTokenHTML [line 218]

 

 

 

 string getTokenHTML(
)
 

 


 Get the HTML code for a XoopsFormHiddenToken object - used in forms that do not use XoopsForm elements




 
[ Top ]

 

 

 
 
method setErrors [line 229]

 

 

 

 void setErrors(
string
$error)
 

 


 Add an error




 
Parameters:

 

 

 

 string  
 $error  
 
 

 

 


 
[ Top ]

 

 

 
 
method validateToken [line 93]

 

 

 

 bool validateToken(
[string
$token = false], [bool
$clearIfValid = true])
 

 


 Check if a token is valid. If no token is specified, $_REQUEST['XOOPS_TOKEN_REQUEST'] is checked




 
Parameters:

 

 

 

 string  
 $token  
 token to validate
 

 

 bool  
 $clearIfValid  
 whether to clear the token value if valid
 

 

 


 
[ Top ]

 




 

 

 XOOPS Docs generated by phpDocumentor