phpFox API Documentation

[Phpfox] element index

Package indexes

All elements
2 a b c d e f g h i j l m n o p q r s t u v w x z _
_
Variable $_aAllHooks
Phpfox_Plugin::$_aAllHooks in plugin.class.php
List of all the hooks stored in the system.
Variable $_aAllowedTags
HTML tags we allow.
Variable $_aArchives
Supported methods of download for the specific data we plan on passing to the user
Variable $_aArchives
Variable $_aArgs
Phpfox_Request::$_aArgs in request.class.php
List of all the requests ($_GET, $_POST, $_FILES etc...)
Variable $_aAscii
Phpfox_Locale::$_aAscii in locale.class.php
ASCII conversion for URL strings (non-latin character support)
Variable $_aAttachment
Background Attachment (background-attachment)
Variable $_aAttachments
Array of attachments we are going to pull from the db a little later.
Variable $_aAvailablePlugins
List of all the plug-in names.
Variable $_aBlockLocations
List of all the block locations on the site.
Variable $_aBlockWithSource
ARRAY of blocks that has source code in the database, instead of PHP files.
Variable $_aBorderStyles
Border Styles (border-style)
Variable $_aBorderWidths
Border Widths (border-width)
Variable $_aBreadCrumbs
Phpfox_Template::$_aBreadCrumbs in template.class.php
List of breadcrumbs.
Variable $_aBreadCrumbTitle
Information about the title of the current page, which is part of the breadcrumb.
Variable $_aBrowser
Phpfox_Request::$_aBrowser in request.class.php
List of browsers.
Variable $_aCache
Phpfox_Locale::$_aCache in locale.class.php
ARRAY of phrases to be cached on a specific page
Variable $_aCacheBlockData
If a user has dragged/dropped blocks this variable will store such information in an ARRAY.
Variable $_aCacheBlockId
Phpfox_Module::$_aCacheBlockId in module.class.php
List of cached block IDs.
Variable $_aCached
Array of all the cache data we have saved.
Variable $_aCachedData
Phpfox_Module::$_aCachedData in module.class.php
Holds all the HTML output of a controller so it can later be displayed in a specific position on the site.
Variable $_aCachedItemData
If a user has dragged/dropped blocks this variable will store such information of the position ID (INT).
Variable $_aCachedItemDataBlock
If a user has dragged/dropped blocks this variable will store such information of the block ID (INT).
Variable $_aCacheHeaders
Phpfox_Template::$_aCacheHeaders in template.class.php
Cache of all the <head></head> content being loaded.
Variable $_aCallbackBlock
ARRAY can add extra blocks that are not loaded by normal means (via AdminCP).
Variable $_aCalls
Phpfox_Ajax::$_aCalls in ajax.class.php
Stores all the AJAX calls.
Variable $_aCmd
Holds an array of all the MySQL functions we use. We store it here because we also provide support for MySQLi, which extends this class when it use.
Variable $_aCmd
Array of all the MySQLi functions we use. This variable overwrites the parent MySQL variable.
Variable $_aCodes
Phpfox_Parse_Bbcode::$_aCodes in bbcode.class.php
Holds an ARRAY of CODE. (eg. [php], [html], [code])
Variable $_aComponent
Phpfox_Module::$_aComponent in module.class.php
List of all the active components part of active modules.
Variable $_aComponents
Phpfox_Module::$_aComponents in module.class.php
Cached array of all the components. Only stored during debug mode.
Variable $_aConditions
Phpfox_Search::$_aConditions in search.class.php
SQL conditions.
Variable $_aConds
Phpfox_Search::$_aConds in search.class.php
SQL conditions.
Variable $_aCookie
Not in use.
Variable $_aCrons
Phpfox_Cron::$_aCrons in cron.class.php
Array of all the cron jobs we save into memory
Variable $_aCss
Phpfox_Parse_Css::$_aCss in css.class.php
ARRAY of CSS code to parse.
Variable $_aCurrency
Holds an ARRAY of supported currencies for this payment gateway
Variable $_aCurrency
Holds an ARRAY of supported currencies for this payment gateway
Variable $_aData
Holds all the data that has been filtered when inserting or updating information directly from a from posted by an end user.
Variable $_aData
Phpfox_Xml_Parser::$_aData in parser.class.php
ARRAY of data we picked up and parsed from the XML string.
Variable $_aDbs
Phpfox_Database_Support::$_aDbs in support.class.php
Array of all the drivers we are testing but also the ones we just support at the moment.
Variable $_aDebug
Phpfox_Debug::$_aDebug in debug.class.php
Holds a history of all the debug tests being executed
Variable $_aDebugHistory
Holds a history of all the completed debug tests that were ran
Variable $_aDefault
List of parsing rules to convert BBCOde into HTML.
Variable $_aDefaults
Phpfox_Validator::$_aDefaults in validator.class.php
List of default regex rules.
Variable $_aDefaults
Phpfox_Setting::$_aDefaults in setting.class.php
Default settings we load and their values. We only use this when installing the script the first time since the database hasn't been installed yet.
Variable $_aEditor
Phpfox_Template::$_aEditor in template.class.php
Information about the text editor.
Variable $_aEmbedParams
Parsing settings for video embeds.
Variable $_aEmphasis
ARRAY of emphasis tags.
Variable $_aEvilCss
Invalid CSS properties we need to remove.
Variable $_aEvilEvents
Invalid events we need to remove.
Variable $_aFields
Array of fields in a table which we later use to identify what has been changed from a previous version.
Variable $_aFile
Phpfox_File::$_aFile in file.class.php
Holds meta information about a file that was uploaded. Information includes $_FORM
Variable $_aFileCheck
Phpfox_File::$_aFileCheck in file.class.php
Foruce a special file check on meta data. This feature is not being used at the moment as it was designed for MP3s
Variable $_aFonts
Fonts (font-family)
Variable $_aFontSizes
Font Sizes (font-size)
Variable $_aFontStyles
Font Styles (font-style)
Variable $_aFontWeights
Font Weight (font-weight)
Variable $_aFrames
Phpfox_Module::$_aFrames in module.class.php
List of controllers that are within iframes and require special rules to be loaded.
Variable $_aHeaders
Phpfox_Template::$_aHeaders in template.class.php
List of data to add within the templates HTML <head></head>.
Variable $_aHtml
Phpfox_Search::$_aHtml in search.class.php
Holds HTML form.
Variable $_aImageParams
Parsing settings for images.
Variable $_aImages
Phpfox_Template::$_aImages in template.class.php
List of images to be loaded and converted into a JavaScript object.
Variable $_aInfo
Phpfox_Image_Abstract::$_aInfo in abstract.class.php
Holds an ARRAY of meta information about an image
Variable $_aItemDataCache
If a user has dragged/dropped blocks this variable will store the blocks information in an ARRAY.
Variable $_aJquery
Phpfox_Ajax::$_aJquery in ajax.class.php
These are jQuery functions we support, which can be called via this class
Variable $_aLanguage
Phpfox_Locale::$_aLanguage in locale.class.php
ARRAY of the current language package being used
Variable $_aLanguages
Phpfox_Locale::$_aLanguages in locale.class.php
ARRAY of all the language packages
Variable $_aLibs
Phpfox::$_aLibs in phpfox.class.php
ARRAY of libraries being loaded.
Variable $_aListLevelTypes
Variable $_aLogs
Phpfox::$_aLogs in phpfox.class.php
History of any logs we save for debug purposes.
Variable $_aMap
Phpfox_Database_Export::$_aMap in export.class.php
Mapping of all the tested SQL drivers and the fields it supports.
Variable $_aMessage
Phpfox_Mail::$_aMessage in mail.class.php
ARRAY of loading a phrase or STRING of we are passing the message directly.
Variable $_aMessagePlain
ARRAY of loading a phrase or STRING of we are passing the message directly.
Variable $_aMeta
Phpfox_Template::$_aMeta in template.class.php
List of meta data.
Variable $_aMethod
Phpfox_Request::$_aMethod in request.class.php
Variable is deprecated.
Variable $_aMobileHeaders
Phpfox_Template::$_aMobileHeaders in template.class.php
Mobile headers.
Variable $_aModuleBlocks
Phpfox_Module::$_aModuleBlocks in module.class.php
List of all the active blocks part of active modules.
Variable $_aModules
Phpfox_Module::$_aModules in module.class.php
List of all the active modules.
Variable $_aMonthTable
Phpfox_Date::$_aMonthTable in date.class.php
Array of all the last days for each of the months starting with January
Variable $_aMoveBlocks
Phpfox_Module::$_aMoveBlocks in module.class.php
Holds an ARRAY of all the blocks that were moved by the end user.
Variable $_aName
Array of all the cache files we have saved.
Variable $_aName
Array of all the cache files we have saved.
Variable $_aName
Phpfox_Request::$_aName in request.class.php
List of requests being checked.
Variable $_aNewUrl
Phpfox_Template::$_aNewUrl in template.class.php
Rebuild URL brought from cache.
Variable $_aNoWikis
ARRAY of support nowiki tags.
Variable $_aObject
Phpfox_Gateway::$_aObject in gateway.class.php
Holds an ARRAY of API objects
Variable $_aObject
Phpfox::$_aObject in phpfox.class.php
ARRAY of objects initiated. Used to keep a static history so we don't call the same class more then once.
Variable $_aOpenTags
Phpfox_Xml_Builder::$_aOpenTags in builder.class.php
History of open tags.
Variable $_aPaddingSizes
Padding (padding)
Variable $_aPages
Phpfox::$_aPages in phpfox.class.php
ARRAY of custom pages the site admins have created.
Variable $_aPages
Phpfox_Module::$_aPages in module.class.php
Cache ARRAY of all the custom pages the site has, which are created by admins.
Variable $_aParam
Holds an ARRAY of settings to pass to the form
Variable $_aParam
Holds an ARRAY of settings to pass to the form
Variable $_aParams
Phpfox_Cache_Abstract::$_aParams in abstract.class.php
Array of any special params we pass in case we need to do something.
Variable $_aParams
Phpfox_Component::$_aParams in component.class.php
Params that can be passed to a component other then request methods.
Variable $_aParams
Phpfox_Pager::$_aParams in pager.class.php
Params to pass along with the pagination request.
Variable $_aParams
Phpfox_Setting::$_aParams in setting.class.php
List of all the settings.
Variable $_aParams
Phpfox_Spam::$_aParams in spam.class.php
Params passed via the check() method
Variable $_aParams
Phpfox_Ajax::$_aParams in ajax.class.php
Holds all the $_POST data when sending information via AJAX.
Variable $_aParams
Phpfox_Url::$_aParams in url.class.php
List of all the requests.
Variable $_aParams
Phpfox_Spam_Hash::$_aParams in hash.class.php
Params we pass on how the SPAM check should behave.
Variable $_aParams
Phpfox_Search::$_aParams in search.class.php
Search settings.
Variable $_aPhrases
Phpfox_Template::$_aPhrases in template.class.php
List of phrases to load and create JavaScript variables for.
Variable $_aPhrases
Phpfox_Locale::$_aPhrases in locale.class.php
ARRAY of all the phrases
Variable $_aPlugins
Phpfox_Plugin::$_aPlugins in plugin.class.php
ARRAY of plug-ins to be used.
Variable $_aPlugins
Phpfox_Template::$_aPlugins in template.class.php
List of plugins.
Variable $_aPositions
Positions (position)
Variable $_aQuery
Variable $_aQuery
Array of all the parts of a query we are going to execute
Variable $_aRegEx
Phpfox_Parse_Output::$_aRegEx in output.class.php
Regex used to convert URL and emails.
Variable $_aRegex
Phpfox_Validator::$_aRegex in validator.class.php
Default regex rules.
Variable $_aRegex
Regex for CSS hex and image links.
Variable $_aRemoveProperties
Evil CSS properties we need to remove.
Variable $_aRemoveUrl
Phpfox_Template::$_aRemoveUrl in template.class.php
Remove URL brought from cache.
Variable $_aRepeat
Background Repaat (background-repeat)
Variable $_aRequest
Phpfox_Ajax::$_aRequest in ajax.class.php
Holds the default 'phpfox' parameters being passed by the post request.
Variable $_aReturn
Phpfox_Module::$_aReturn in module.class.php
Cache and store all the return values from components being loaded.
Variable $_aRules
Phpfox_Locale::$_aRules in locale.class.php
Regex rules to manipulate phrases
Variable $_aSearch
Phpfox_Search::$_aSearch in search.class.php
Search results.
Variable $_aSections
Phpfox_Template::$_aSections in template.class.php
List of sections.
Variable $_aServices
Phpfox_Module::$_aServices in module.class.php
List of all the active services part of active modules.
Variable $_aStack
Phpfox_Xml_Parser::$_aStack in parser.class.php
Stack XML.
Variable $_aStats
Phpfox_Cache_Abstract::$_aStats in abstract.class.php
Array of stats holding the information about the cache files
Variable $_aSubject
Phpfox_Mail::$_aSubject in mail.class.php
ARRAY if loading a phrase or STRING if we are passing a subject.
Variable $_aSupported
Variable $_aSupported
Array of all the supported file extensions.
Variable $_aSupported
Phpfox_File::$_aSupported in file.class.php
Holds an ARRAY of all the supported file types identified by the routine
Variable $_aTextDecorations
Text Decoration (text-decoration)
Variable $_aTextTransforms
Text Transforms (text-transform)
Variable $_aTheme
Phpfox_Template::$_aTheme in template.class.php
Information about the current theme we are using.
Variable $_aTitles
Phpfox_Template::$_aTitles in template.class.php
List of titles assigned to a page.
Variable $_aTypes
Phpfox_Image_Abstract::$_aTypes in abstract.class.php
Supported file types
Variable $_aTypes
Variable $_aUsers
Phpfox_Mail::$_aUsers in mail.class.php
ARRAY of users to email and their information.
Variable $_aUsers
Phpfox_Parse_Bbcode::$_aUsers in bbcode.class.php
ARRAY of all the user BBCode calls.
Variable $_aVars
Phpfox_Template::$_aVars in template.class.php
List of all the variables assigned to templates.
Variable $_aVideos
Phpfox_Parse_Bbcode::$_aVideos in bbcode.class.php
ARRAY of all the video BBCode calls.
Variable $_aWords
Array of all the words that cannot be used when creating a database table or field. This is only used in development mode.
Variable $_aXml
Phpfox_Xml_Builder::$_aXml in builder.class.php
XML settings.
Variable $_bCache
Phpfox_Search::$_bCache in search.class.php
Define if we should cache the search results.
Variable $_bDefList
Support for <dl>.
Variable $_bDisplay
Phpfox_Error::$_bDisplay in error.class.php
Holds a BOOL value if we should display the error messages or not
Variable $_bFromMemory
Set this to true and we will force the system to get the information from a memory based caching system (eg. memcached)
Variable $_bFromMemory
Set this to true and we will force the system to get the information from a memory based caching system (eg. memcached)
Variable $_bHasBucket
Bool value if the bucket has already been created or not.
Variable $_bIgnoreImages
BOOL to ignore images or not.
Variable $_bIncludeFirstTag
Check to include the first tag.
Variable $_bIsAdminCp
Phpfox::$_bIsAdminCp in phpfox.class.php
Used to keep a static variable to see if we are within the AdminCP.
Variable $_bIsAdminCp
Phpfox_Template::$_bIsAdminCp in template.class.php
Check to see if a template is part of the AdminCP.
Variable $_bIsCached
Phpfox_Locale::$_bIsCached in locale.class.php
Check to see if we already cached this page
Variable $_bIsMobile
Phpfox_Request::$_bIsMobile in request.class.php
Check to see if we are using a mobile device.
Variable $_bIsSearch
Phpfox_Search::$_bIsSearch in search.class.php
Check if a search has been performed.
Variable $_bIsSlave
Check to see if we are using slave servers
Variable $_bIsTestMode
Phpfox_Template::$_bIsTestMode in template.class.php
Check to see if we are currently in test mode.
Variable $_bIsUploaded
Bool value if we were able to upload the file or not.
Variable $_bIsUsed
Phpfox_Url::$_bIsUsed in url.class.php
Not being used.
Variable $_bLiveQuery
Phpfox_Search::$_bLiveQuery in search.class.php
Perform a live search with no caching or storage.
Variable $_bMessageHeader
Controlls if we should include the default header in the message. Default is TRUE.
Variable $_bNoTemplate
Phpfox_Module::$_bNoTemplate in module.class.php
Defines if a template should not be loaded when calling a controller.
Variable $_bParent
Phpfox_Validator::$_bParent in validator.class.php
Check to see if we should load a parent check.
Variable $_bPreformat
Format
Variable $_bRedirect
Redirect links.
Variable $_bSendToSelf
Phpfox_Mail::$_bSendToSelf in mail.class.php
TRUE to send the message to ourself and FALSE to not.
Variable $_bShowErrors
Phpfox_Ajax::$_bShowErrors in ajax.class.php
During an AJAX call you can use "Phpfox_Error::set();" to set error messages and
Variable $_bSkipClose
By default we always close a cache call automatically, however at times you may need to close it at a later time and setting this to true will skip closing the closing of the cache reference.
Variable $_bSkipClose
By default we always close a cache call automatically, however at times you may need to close it at a later time and setting this to true will skip closing the closing of the cache reference.
Variable $_bSkipError
Phpfox_Error::$_bSkipError in error.class.php
Holds a BOOL value if we should skip the error reporting or not
Variable $_bStop
Phpfox_Parse_Wiki::$_bStop in wiki.class.php
Create a link break.
Variable $_bSuppressLinebreaks
Supress link breaks.
Variable $_bUseVideoImage
Identify if we should use the videos image instead of loading the actual video when replacing the video BBCode.
Variable $_hImg
Resource for the image we are creating
Variable $_hMaster
Variable $_hMaster
Variable $_hMaster
Variable $_hMaster
Variable $_hMaster
Resource for the MySQL master server
Variable $_hSlave
Variable $_hSlave
Variable $_hSlave
Resource for the MySQL salve server
Variable $_hSlave
Variable $_hSlave
Variable $_iCacheTime
Phpfox_Template::$_iCacheTime in template.class.php
Default file cache time.
Variable $_iError
Phpfox_Xml_Parser::$_iError in parser.class.php
Error ID#.
Variable $_iErrorCode
Error code.
Variable $_iErrorLine
Error line.
Variable $_iFirstRow
Phpfox_Pager::$_iFirstRow in pager.class.php
From page number.
Variable $_iFrameSize
Phpfox_Pager::$_iFrameSize in pager.class.php
Numbers to display in the pagination frame.
Variable $_iLastRow
Phpfox_Pager::$_iLastRow in pager.class.php
Last page number.
Variable $_iLinkNumber
Link number.
Variable $_iListLevel
Define how many levels a list has.
Variable $_iMaxSize
Phpfox_File::$_iMaxSize in file.class.php
Holds the max size of what is allowed by the routine in bytes. Note that this is also checked by the system to make sure it can handle such a size.
Variable $_iPage
Phpfox_Pager::$_iPage in pager.class.php
Current page we are on.
Variable $_iPagesCount
Phpfox_Pager::$_iPagesCount in pager.class.php
Total pages.
Variable $_iPageSize
Phpfox_Pager::$_iPageSize in pager.class.php
Total items per page.
Variable $_iSearchPage
Phpfox_Search::$_iSearchPage in search.class.php
Current page the search is on.
Variable $_iSearchTotal
Phpfox_Search::$_iSearchTotal in search.class.php
Total search results.
Variable $_isMobile
Phpfox_Url::$_isMobile in url.class.php
Check to see if we are using a mobile device.
Variable $_iTagCnt
Phpfox_Xml_Parser::$_iTagCnt in parser.class.php
Total number of tags.
Variable $_mTo
Phpfox_Mail::$_mTo in mail.class.php
STRING or ARRAY of emails or users to send the emai to.
Variable $_oCache
Phpfox_Cron::$_oCache in cron.class.php
Cache object
Variable $_oCache
Phpfox_Locale::$_oCache in locale.class.php
Cache object
Variable $_oController
Phpfox_Module::$_oController in module.class.php
Object of the class loaded by the current controller being used.
Variable $_oDb
Phpfox_Spam::$_oDb in spam.class.php
Database object
Variable $_oDb
Memcached object
Variable $_oDb
Memcached object.
Variable $_oFtp
Phpfox_Ftp::$_oFtp in ftp.class.php
Holds FTP resource
Variable $_oMail
Phpfox_Mail::$_oMail in mail.class.php
Object of the 3rd party library we are using to send the actual image.
Variable $_oMail
PHPMailer Object
Variable $_oMail
PHPMailer Object
Variable $_oObject
Phpfox_Session::$_oObject in session.class.php
Session object.
Variable $_oObject
Phpfox_Archive::$_oObject in archive.class.php
Holds the object of the extension class depending on what sort of archive we are working with.
Variable $_oObject
Phpfox_Image::$_oObject in image.class.php
Object for the image library
Variable $_oObject
Phpfox_Cache::$_oObject in cache.class.php
Object of the storage class.
Variable $_oObject
Session object.
Variable $_oObject
Phpfox_Database::$_oObject in database.class.php
Holds the drivers object
Variable $_oObject
Object for the amazon s3 class
Variable $_oObject
Phpfox_Cdn::$_oObject in cdn.class.php
Object of the CDN module.
Variable $_oReq
Phpfox_Ajax::$_oReq in ajax.class.php
Holds the Request object
Variable $_oReq
Phpfox_Search::$_oReq in search.class.php
Request object.
Variable $_oUrl
Phpfox_Search::$_oUrl in search.class.php
URL object.
Variable $_oXml
Phpfox_Xml_Parser::$_oXml in parser.class.php
XML object.
Variable $_oZip
Object of the PHP class ZipArchive
Variable $_sAjax
Phpfox_Pager::$_sAjax in pager.class.php
AJAX request call.
Variable $_sBucket
Name of the bucket we plan to store all the uploaded data
Variable $_sCacheId
Phpfox_Locale::$_sCacheId in locale.class.php
Cache ID associated with the caching of phrases for a specific page
Variable $_sCacheName
Phpfox_Plugin::$_sCacheName in plugin.class.php
Variable is deprecated.
Variable $_sCacheVar
Phpfox_Component::$_sCacheVar in component.class.php
Groups params based on unique cache ID for the component.
Variable $_sCdata
Phpfox_Xml_Parser::$_sCdata in parser.class.php
CDATA string.
Variable $_sCharRegexes
Common character regex.
Variable $_sComponent
Phpfox_Component::$_sComponent in component.class.php
Holds the current component being loaded.
Variable $_sController
Phpfox_Module::$_sController in module.class.php
Holds the value of the default controller to execute.
Variable $_sDbQstrRegexp
REGEX used to get params from within {}
Variable $_sDestination
Phpfox_File::$_sDestination in file.class.php
Holds the final path of a file that was uploaded
Variable $_sDoc
Phpfox_Xml_Builder::$_sDoc in builder.class.php
XML code we are building.
Variable $_sError
Phpfox_Api::$_sError in api.class.php
Error message.
Variable $_sErrorHolder
Phpfox_Ajax::$_sErrorHolder in ajax.class.php
This is the HTML div ID that holds error messages
Variable $_sExt
Phpfox_File::$_sExt in file.class.php
Holds the file extension of the file that was uploaded.
Variable $_sFromEmail
Phpfox_Mail::$_sFromEmail in mail.class.php
The email of the person sending the email.
Variable $_sFromName
Phpfox_Mail::$_sFromName in mail.class.php
The name of the person sending the email.
Variable $_sImageUri
Image URI.
Variable $_sIsSlave
Variable $_sIsSlave
Variable $_sIsSlave
Variable $_sIsSlave
Variable $_sLastQuery
Variable $_sLastQuery
Variable $_sLineRegexes
Common regex for HTML.
Variable $_sMenuName
Phpfox_Component::$_sMenuName in component.class.php
Holds the current menu for the page we are on.
Variable $_sModule
Phpfox_Component::$_sModule in component.class.php
Holds the current module that component belongs to.
Variable $_sModule
Phpfox_Module::$_sModule in module.class.php
Holds the value of the default module to execute.
Variable $_sName
Name of the current cache file we are saving
Variable $_sName
Phpfox_Validator::$_sName in validator.class.php
Name of the validation.
Variable $_sName
Phpfox_Request::$_sName in request.class.php
Last name being checked.
Variable $_sNotification
Notification ID to be used to check if a user has privacy settings on receiving an email.
Variable $_sOverride
Phpfox_Locale::$_sOverride in locale.class.php
Use this variable to override the default language ID
Variable $_sPrefix
Prefix of the session name.
Variable $_sPrefix
Session prefix.
Variable $_sPrefix
Prefix of the session name.
Variable $_sPrefix
Session prefix.
Variable $_sReferenceWiki
Reference within links.
Variable $_sSavePath
Path to save a session.
Variable $_sSavePath
Path to save a session.
Variable $_sSearchResults
Search results as a string.
Variable $_sSetLayout
Phpfox_Template::$_sSetLayout in template.class.php
Override the layout of the current theme being used.
Variable $_sSiQstrRegexp
REGEX used to get params from within {}
Variable $_sStaticThemeFolder
Static variable of the current theme folder.
Variable $_sStyleFolder
Phpfox_Template::$_sStyleFolder in template.class.php
Folder of the style being used.
Variable $_sTable
Phpfox_Service::$_sTable in service.class.php
Holds the default database table we are working with in this service.
Variable $_sTabs
Phpfox_Xml_Builder::$_sTabs in builder.class.php
Current tab.
Variable $_sText
Phpfox_Parse_Input::$_sText in input.class.php
Store text we are parsing temp.
Variable $_sThemeFolder
Phpfox_Template::$_sThemeFolder in template.class.php
Folder of the theme being used.
Variable $_sThemeLayout
Phpfox_Template::$_sThemeLayout in template.class.php
Theme layout to load.
Variable $_sType
Phpfox_Search::$_sType in search.class.php
Type of search we are performing.
Variable $_sUrl
Phpfox_Template::$_sUrl in template.class.php
URL of the current page we are on.
Variable $_sUrlKey
Phpfox_Pager::$_sUrlKey in pager.class.php
URL key for page param e.g. in http://example.com/?page=3 it is 'page'
Variable $_sXml
Phpfox_Xml_Parser::$_sXml in parser.class.php
XML string to parse.
Method _addBreak
Add a line break.
Method _addKeyworSyntax
We want to identify special SQL functions like ON() or USING()
Method _addNode
Phpfox_Xml_Parser::_addNode() in parser.class.php
Add children.
Method _ajaxSafe
Phpfox_Ajax::_ajaxSafe() in ajax.class.php
Safe AJAX Code
Method _attachment
Parse attachments and create the new ID.
Method _build
Build javascript code.
Method _buildDir
Phpfox_File::_buildDir() in file.class.php
Builds a directory structure for items being uploaded based on
Method _buildFile
Phpfox_File::_buildFile() in file.class.php
We build an ARRAY of information about the file based on information passed by $_FORM or $_FORM['FOO'][] with the latter being a multiple uploade routine.
Method _buildTag
Phpfox_Xml_Builder::_buildTag() in builder.class.php
Build an XML tag.
Method _cache
Phpfox_Mail::_cache() in mail.class.php
Method _cacheHtml
Part of the method _stripTags() to remove unwanted HTML tags.
Method _cacheModuleBlocks
Cache all module blocks.
Method _cacheModules
Phpfox_Module::_cacheModules() in module.class.php
Cache all the active modules based on the package the client is using.
Method _calcSize
Calculates size for resizing.
Method _checkEmail
Phpfox_Mail::_checkEmail() in mail.class.php
Checks to validate an email.
Method _checkIfEmpty
Check done via a callback within the isEmpty() method to see if a string is empty or not.
Method _checkRoutine
Phpfox_Validator::_checkRoutine() in validator.class.php
Method is used to check if POST data fields is valid for either PHP or Javascript.
Method _cleanHtml
Common routine we run when using the prepare() method to clean HTML to make sure it is safe.
Method _cleanObject
Cleans HTML object to make it XHTML valid
Method _cleanPhp
Phpfox_Plugin::_cleanPhp() in plugin.class.php
Clean out any PHP that is causing problems when we eval the code.
Method _cleanSpan
Clean html <span>.
Method _cleanTitle
Cleans the title of an item.
Method _cmp
Phpfox_Image_Helper::_cmp() in helper.class.php
Runs a check on two variables if they are equal, less then or greater then
Method _code
Phpfox_Parse_Bbcode::_code() in bbcode.class.php
Parse code blocks (eg. code, html, php)
Method _connect
Method _connect
Makes a connection to the MySQL database
Method _convert
Phpfox_Locale::_convert() in locale.class.php
Converts HTML template code in phrases into actual phrases.
Method _createIfJS
Phpfox_Validator::_createIfJS() in validator.class.php
Creates a JS IF statment
Method _destroy
Phpfox_Image_Abstract::_destroy() in abstract.class.php
Destory all the variables associated with the current image in preperation to manipulate another image.
Method _embedWmode
Converts flash embedded videos to include "wmode".
Method _escapeCdata
Phpfox_Error::_escapeCdata() in error.class.php
Removes any CDATA from a string.
Method _escapeCdata
Escapes CDATA.
Method _fixEmbedWidth
Fixes the width of embedded videos.
Method _fixImageWidth
Fixes image widths.
Method _getBlockHeight
Block height.
Method _getCachedName
Phpfox_Template::_getCachedName() in template.class.php
Gets the full path of the cached template file
Method _getDomain
Phpfox_Api::_getDomain() in api.class.php
Get the current domain name being used.
Method _getField
Returns one field from a row
Method _getField
Returns one field from a row
Method _getField
Returns one field from a row
Method _getField
Returns one field from a row
Method _getField
Returns one field from a row
Method _getFiles
Gets all the files found in the root directory of the script or based on the 1st arg..
Method _getFileType
Phpfox_File::_getFileType() in file.class.php
We find out a files extension based on information passed along with $_FILE
Method _getFromCache
Phpfox_Template::_getFromCache() in template.class.php
Gets a template file from cache. If the file does not exist we re-cache the template.
Method _getHtmlColors
Color code.
Method _getInfo
Phpfox_Pager::_getInfo() in pager.class.php
Returns paging info: 'totalPages', 'totalRows', 'current', 'fromRow','toRow', 'firstUrl', 'prevUrl', 'nextUrl', 'lastUrl', 'urls' (url=>page)
Method _getItemCacheData
Get all the drag/drop information from a specific table for a specific user.
Method _getMenu
Phpfox_Template::_getMenu() in template.class.php
Get a menu.
Method _getMenuName
Phpfox_Component::_getMenuName() in component.class.php
Get the current menu name of the page we are on.
Method _getModuleLanguage
Loads and caches phrases for a specific module.
Method _getName
Returns the name of the cache file. Memcached does nothing special here so we just return the file name.
Method _getName
Returns the full path to the cache file.
Method _getNextRun
Phpfox_Cron::_getNextRun() in cron.class.php
Get the next time a cron job must be executed
Method _getParam
Phpfox_Search::_getParam() in search.class.php
Get a search param.
Method _getParam
Get a params value in case we pass any information to this class when it was first constructed.
Method _getPhrase
Gets a pharse from the language package.
Method _getPhrases
Phpfox_Locale::_getPhrases() in locale.class.php
Get all the phrases for a specific language package.
Method _getPos
Phpfox_Pager::_getPos() in pager.class.php
Calculates first/last page in a current frame
Method _getQueries
Phpfox_Search::_getQueries() in search.class.php
Process the search routine.
Method _getRow
Returns exactly one row as array. If there is number of rows satisfying the condition then the first one will be returned.
Method _getRow
Returns exactly one row as array. If there is number of rows satisfying the condition then the first one will be returned.
Method _getRow
Returns exactly one row as array. If there is number of rows satisfying the condition then the first one will be returned.
Method _getRow
Returns exactly one row as array. If there is number of rows satisfying the condition then the first one will be returned.
Method _getRow
Returns exactly one row as array. If there is number of rows satisfying the condition then the first one will be returned.
Method _getRows
Gets data returned by sql query
Method _getRows
Gets data returned by sql query
Method _getRows
Gets data returned by sql query
Method _getRows
Gets data returned by sql query
Method _getRows
Gets data returned by sql query
Method _getUsableMemory
Gets the total memory that can be used by the script based on what the server has.
Method _getVar
Phpfox_Search::_getVar() in search.class.php
Get a search value.
Method _handleCdata
Handle CDATA by storing it in a variable.
Method _handleDefinitionList
Handle <dl>.
Method _handleElementEnd
Handle the end of an element.
Method _handleElementStart
Handle the start of an element.
Method _handleEliminate
Adds empty string.
Method _handleEmphasize
Handles emphasize blocks (em, strong).
Method _handleExternalLink
Handles external links.
Method _handleHorizontalRule
Handle <hr />
Method _handleImage
Handle images (<img>).
Method _handleInternalLink
Handles internal links.
Method _handleList
Handles lists (
Method _handleNewline
Handler for new lines (
).
Method _handlePreFormat
Handle
Method _handleRestoreNoWiki
Restores wiki.
Method _handleSaveNoWiki
Handles <nowiki>.
Method _handleSections
Handles sections (h1, h2, h3 etc...)
Method _handleVariable
Converts WIKI variables.
Method _hex2rgb
Phpfox_Image_Abstract::_hex2rgb() in abstract.class.php
Transform a HEX to RGB
Method _htmlSpecialcharsUni
Convert HTML characters.
Method _htmlTags
Handles an individual HTML tag in a [html] tag.
Method _image
Phpfox_Parse_Bbcode::_image() in bbcode.class.php
Parse images from BBCode [image]
Method _insert
Insert data into the database
Method _insert
Method _isCached
Phpfox_Template::_isCached() in template.class.php
Checks to see if a template has already been cached or not.
Method _isDst
Phpfox_Date::_isDst() in date.class.php
Check to see if we are to use DST support.
Method _isSpam
Phpfox_Spam::_isSpam() in spam.class.php
Check to see if the content being passed is considered as SPAM.
Method _isUrl
Phpfox_Url::_isUrl() in url.class.php
Checks to see if a URL exists or not within the rewrite rules.
Method _join
Database_Driver_Postgres::_join() in postgres.class.php
Method _join
Method _join
Performs all the joins based on information passed from JOIN methods within this class.
Method _join
Method _join
Method _lastPost
Phpfox_Spam::_lastPost() in spam.class.php
SPAM control that checks the last time a user posted an item.
Method _load
Phpfox_Image_Abstract::_load() in abstract.class.php
Load an image and attempt to get as much meta information about the image
Method _loadData
Phpfox_Debug::_loadData() in debug.class.php
Parses ARRAYS and makes it readable for browsers.
Method _makeUrl
Phpfox_Url::_makeUrl() in url.class.php
Build a URL based on the apache rewrite rules.
Method _parse
Phpfox_Locale::_parse() in locale.class.php
Parses a phrase to convert ASCII rules.
Method _parseAttachment
Parse BBCode attachments.
Method _parseBbCode
Parse BBCode with contents within it.
Method _parseBbCodeOption
Parse BBCode with options.
Method _parseBbCodeSingle
Parse a specific BBCode.
Method _parseLine
Parses each line of the string and creates handles.
Method _parseMember
Holds in memory all the memers we need to parse.
Method _parseOption
Clean BBCode option.
Method _parseSQL
Phpfox_Debug::_parseSQL() in debug.class.php
Parse SQL code so when outputed to the browser it is easier to read and understand.
Method _parseTable
Parse BBCode [table][/table]
Method _parseUrl
Phpfox_Url::_parseUrl() in url.class.php
Parse a URL string and convert it into an ARRAY.
Method _parseUser
Parse user BBCode that creates a link to their profile.
Method _parseValue
Clean BBCode value.
Method _parseVideo
Parse videos.
Method _passLimit
Phpfox_File::_passLimit() in file.class.php
Runs a check to make sure the item being uploaded is allowed to be uploaded based on the server requirements.
Method _prepare
Phpfox_Search::_prepare() in search.class.php
Prepare and build the search form.
Method _quote
Phpfox_Parse_Bbcode::_quote() in bbcode.class.php
Parse and convert [quote][/quote] BBCode.
Method _register
Phpfox_Template::_register() in template.class.php
Method _removeEvilAttributes
Removes all evil attributes in a string to make sure the data returned is safe to output on the site.
Method _replaceBbCode
Replace default BBCode with HTML.
Method _replaceEmails
Replace unwanted emails on the site. We also take into account emails that are added into the "white" list.
Method _replaceLinks
Replace unwanted links on the site. We also take into account links that are added into the "white" list.
Method _reset
Phpfox_Search::_reset() in search.class.php
Reset a search.
Method _returnLayout
Phpfox_Template::_returnLayout() in template.class.php
Returns the content of a template that has already been echoed.
Method _send
Phpfox_Url::_send() in url.class.php
Send the user to a new location.
Method _setMenuName
Phpfox_Component::_setMenuName() in component.class.php
Set the menu name for the current page we are on.
Method _setParams
Phpfox_Url::_setParams() in url.class.php
Prepare the main requests.
Method _shorten
Shortens a string respecting non english characters
Method _sqlError
Method _sqlError
Method _sqlError
Method _sqlError
Returns any SQL errors.
Method _sqlError
Method _stripInnerHtml
Removes HTML found within HTML.
Method _stripTags
Our method of PHP strip_tags().
Method _trim
Phpfox_Parse_Bbcode::_trim() in bbcode.class.php
Trim BBCode.
Method _trimData
Phpfox_Request::_trimData() in request.class.php
Trims params and strip slashes if magic_quotes_gpc is set.
Method _unescapeCdata
Unescape CDATA.
Method _unicodeToEntitiesPreservingAscii
Converts a string with non-latin characters into UNICODE. This method is used with the method _utf8ToUnicode().
Method _update
Phpfox_Cron::_update() in cron.class.php
Update the cron job with the last time it was ran and the next time we need to run the cron.
Method _update
Method _update
Updates data in a specific table
Method _urlToLink
Converts a URL into a HTML anchor.
Method _utf8ToUnicode
Converts a string with non-latin characters into UNICODE. We convert all strings before we enter them into the database so clients do not have to worry about database collations and website encoding as all common browsers have no problems displaying UNICODE.
Method _verify
Phpfox_File::_verify() in file.class.php
If this feature is enabled we use getID3 to try to find the mime type by trying to extract meta information. Note that since this is based off a 3rd party library this method has been known to have it share of problems. We are not using this by default until it is fully stable.
Method _video
Phpfox_Parse_Bbcode::_video() in bbcode.class.php
Create an ID and store the parsed video ID in memory.
Method __call
Phpfox_Spam::__call() in spam.class.php
If a call is made to an unknown method attempt to connect it to a specific plug-in with the same name thus allowing plug-in developers the ability to extend classes.
Method __call
Phpfox_Ajax::__call() in ajax.class.php
Emulate jQuery calls.
Method __construct
Constructor
Method __construct
Class constructor.
Method __construct
Phpfox_Validator::__construct() in validator.class.php
Class constructor used to load default validator rules.
Method __construct
Class constructor
Method __construct
Phpfox_Url::__construct() in url.class.php
Class constructor is used to build the current URL and all the custom rewrite rules.
Method __construct
Load all the custom params in a protected variable array.
Method __construct
Method __construct
Class constructor
Method __construct
Phpfox_Pager::__construct() in pager.class.php
Class constructor.
Method __construct
Phpfox_Database::__construct() in database.class.php
Loads and initiates the SQL driver that we need to use.
Method __construct
Class constructor. Prepare regex for usgae a little later on in the script.
Method __construct
Phpfox_Date::__construct() in date.class.php
Class constructor
Method __construct
Class constructor.
Method __construct
Method __construct
Class constructor.
Method __construct
Phpfox_Locale::__construct() in locale.class.php
Class constructor used to load the default language package and all the phrases that are part of that language package. Also loads languag rules for that specific language package. All this information is cached and database queries are only executed the first time the site is loaded after a hard re-cache.
Method __construct
Class constructor
Method __construct
Phpfox_Mail::__construct() in mail.class.php
Class constructor that loads a specific method of sending emails (sendmail or smtp)
Method __construct
Phpfox_Cron::__construct() in cron.class.php
Class Constructor
Method __construct
Class constructor that loads PHPMailer class and sets all the needed variables.
Method __construct
Phpfox_Image::__construct() in image.class.php
Class constructor. We load the image library the admin decided to use on their site.
Method __construct
Class constructor
Method __construct
Phpfox_File::__construct() in file.class.php
Class constructor
Method __construct
Phpfox_Ftp::__construct() in ftp.class.php
Class constructor. Connects to FTP server.
Method __construct
Class constructor
Method __construct
Constructor
Method __construct
Phpfox_Editor::__construct() in editor.class.php
Class constructor
Method __construct
Class constructor. If we are in development mode we store all the words that cannot be used when creating tables or fields.
Method __construct
Phpfox_Gateway::__construct() in gateway.class.php
Class constructor
Method __construct
Class constructor. Load all the params on how the SPAM check should behave.
Method __construct
Phpfox_Hash::__construct() in hash.class.php
Class constructor
Method __construct
Class constructor which loads the session hanlder we should use.
Method __construct
Class constructor
Method __construct
Class constructor. Gets the new prefix from the global settings.
Method __construct
We open up a connection to each of the memcached servers.
Method __construct
Phpfox_Setting::__construct() in setting.class.php
Class constructor. We run checks here to make sure the server setting file is in place and this is where we can judge if the script has been installed or not.
Method __construct
Class constructor that loads PHPMailer class and sets all the needed variables.
Method __construct
Class constructor. Gets the new prefix from the global settings.
Method __construct
Phpfox_Session::__construct() in session.class.php
Class constructor which loads the session hanlder we should use.
Method __construct
Phpfox_Search::__construct() in search.class.php
Class constructor that loads request and url objects.
Method __construct
Phpfox_Archive::__construct() in archive.class.php
Constructor
Method __construct
Phpfox_Spam::__construct() in spam.class.php
Class constructor
Method __construct
Phpfox_Ajax::__construct() in ajax.class.php
Class Constructor
Method __construct
Constructor
Method __construct
Class constructor
Method __construct
Constructor
Method __construct
Class constructor is used to load any hooks developers have in case they want to extend BBCode support.
Method __construct
Loads the amazons3 library developed by another group.
Method __construct
Phpfox_Cache::__construct() in cache.class.php
Based on what storage system is set within the global settings this is where we load the file.
Method __construct
Phpfox_Cdn::__construct() in cdn.class.php
Based on what CDN module is selected here is where we load the CDN class and initiat the object.
Method __construct
Phpfox_Component::__construct() in component.class.php
Class constructor that sets all the variables to identify what component we are loading, module it is a part of and any custom params we are passing.
Method __construct
Method __construct
Class constructor.
Method __construct
Phpfox_Module::__construct() in module.class.php
Class constructor that caches all the modules, components (blocks/controllers) and drag/drop information.
Method __construct
Phpfox_Request::__construct() in request.class.php
Class Constructor used to build the variable $this->_aArgs.
Method __construct
Class constructor
Method __construct
Class constructor.
Method __construct
Phpfox_Template::__construct() in template.class.php
Class constructor we use to build the current theme and style we are using.
Method __construct
Class Constructor.
Method __get
Phpfox_Component::__get() in component.class.php
Gets a param that is part of this component group.
Variable $_aForeachElseStack
Foreach stack.
Variable $_aLiterals
Literal blocks. {literal}{/literal}
Variable $_aModuleBlocks
Module blocks.
Variable $_aPhpBlocks
PHP blocks. {php}{/php}
Variable $_aRequireStack
Require stack.
Variable $_aSectionelseStack
Section blocks. {section}{/section}
Variable $_sDbQstrRegexp
String regex.
Variable $_sFuncRegexp
Function regex.
Variable $_sSiQstrRegexp
String regex.
Variable $_sSvarRegexp
Variable regex.
Variable $_sVarBracketRegexp
Bracket regex.
Method _compileCustomFunction
Compile custom function into the template it is loaded in.
Method _compileIf
Compile IF statments.
Method _compileParseIsExpr
Compile IF statment expressions.
Method _compileSectionStart
Complie sections {section}{/section}
Method _compileTag
Compile custom tags. (eg. {literal})
Method _compileVariable
Compile all variables.
Method _parse
Parse a templates content and convert it into PHP.
Method _parseArgs
Parse arguments. (eg. {for bar1=sample1 bar2=sample2}
Method _parseForm
Parse HTML forms. This is where we automatically add our security token.
Method _parseFunction
Parse all the custom tags used within templates. In templates we do not use conventional PHP code as we seperate PHP logic from the template. The tags we use work similar to that off SMARTY.
Method _parseModifier
Parse modifiers.
Method _parseVariable
Parse a specific variable.
Method _parseVariables
Parse variables.
Method _plugin
Load custom plug-ins.
Method _removeQuote
Remove quotes from PHP variables.
Method __construct
Class constructor. Build all the regex we will be using with this class.
a
Variable $aErrors
Phpfox_Validator::$aErrors in validator.class.php
List of all the errors.
Variable $aErrors
Phpfox_Error::$aErrors in error.class.php
Holds an ARRAY of all the error messages we set
Variable $aRewrite
Phpfox_Url::$aRewrite in url.class.php
List of rewrite rules.
Method addBreak
Add line breaks. Unlike the PHP version of this function it looks into not adding line breaks within HTML and PHP code.
Method addCss
Adds a CSS property and value to the global CSS ARRAY that will later be converted into CSS code.
Method addField
Adds fields to a database table.
Method addGroup
Phpfox_Xml_Builder::addGroup() in builder.class.php
Creates an XML group.
Method addIndex
Adds an index to a table.
Method addMark
Adds a image or text watermark depending on the settings provided by admins.
Method addMessage
Phpfox::addMessage() in phpfox.class.php
Add a public message which can be used later on to display information to a user.
Method addModuleBlock
Module blocks are loaded via the AdminCP, however it can manually be loaded with this method.
Method addRow
Phpfox_Debug::addRow() in debug.class.php
Used to create a table based on content being passed.
Method addTag
Phpfox_Xml_Builder::addTag() in builder.class.php
Create an XML tag.
Method addText
Adds a watermark text on an image.
Method addWatermark
Adds an image watermark on an image.
Method affectedRows
Returns the affected rows.
Method affectedRows
Method affectedRows
Method affectedRows
Method affectedRows
Method ajax
Phpfox_Parse_Output::ajax() in output.class.php
Clean text when being sent back via AJAX.
Method alert
Phpfox_Ajax::alert() in ajax.class.php
At times you may want to notify your users and instead of using the default JavaScript alert() we provide a AJAX popup version that works well with the sites theme.
Method allowTitle
Checks if a title of the item can be used in the sites root. This is mainly used
Method amToPm
Phpfox_Date::amToPm() in date.class.php
Converts PM time stamp into military time.
Method append
Phpfox_Ajax::append() in ajax.class.php
jQuery has support for append() and we use that method, however we add a little extra protection with our routine.
Method assign
Phpfox_Template::assign() in template.class.php
Assign a variable so we can use it within an HTML template.
Method aUser
Phpfox_Mail::aUser() in mail.class.php
We load users information in our send() method, however you can also load users by passing an array of their information with this method.
Page ajax.class.php
ajax.class.php in ajax.class.php
Page archive.class.php
archive.class.php in archive.class.php
Page abstract.class.php
abstract.class.php in abstract.class.php
Page abstract.class.php
abstract.class.php in abstract.class.php
Page abstract.class.php
abstract.class.php in abstract.class.php
Page api.class.php
api.class.php in api.class.php
b
Variable $bIsSample
Phpfox_Template::$bIsSample in template.class.php
Check to see if we are displaying a sample page.
Method backup
Performs a backup of the database and places the backup in a specific area on the server based on what the admins decide.
Method blockIsHidden
Phpfox_Module::blockIsHidden() in module.class.php
Checks if a block is hidden.
Class Constant BROWSER_AGENT
Phpfox::BROWSER_AGENT in phpfox.class.php
Browser agent used with API curl requests.
Page bbcode.class.php
bbcode.class.php in bbcode.class.php
Page builder.class.php
builder.class.php in builder.class.php
c
Method cache
Phpfox_Service::cache() in service.class.php
Extends the cache object
Method cache
Phpfox_Locale::cache() in locale.class.php
Caches all the phrases being used on a specific page.
Method cacheResults
Phpfox_Search::cacheResults() in search.class.php
Cache a search into the database.
Method call
Phpfox_Ajax::call() in ajax.class.php
Used to call any JavaScript back to the browser once the AJAX routine is complete.
Method callback
Performs the callback routine when the 3rd party payment gateway sends back a request to the server, which we must then back and verify that it is a valid request. This then connects to a specific module based on the information passed when posting the form to the server.
Method callback
Phpfox::callback() in phpfox.class.php
Method callback
Performs the callback routine when the 3rd party payment gateway sends back a request to the server, which we must then back and verify that it is a valid request. This then connects to a specific module based on the information passed when posting the form to the server.
Method callback
Phpfox_Module::callback() in module.class.php
Execute a callback on a specific module based on the 1st argument.
Method callback
Performs the callback routine when the 3rd party payment gateway sends back a request to the server, which we must then back and verify that it is a valid request. This then connects to a specific module based on the information passed when posting the form to the server.
Method canBackup
Checks if we can backup the database or not. This depends on the server itself.
Method check
Phpfox_Spam::check() in spam.class.php
Method used to call other private methods which control the spam/flood methods.
Method check
Phpfox_Validator::check() in validator.class.php
Check a string value against multiple regex checks.
Method checkEmail
Phpfox_Mail::checkEmail() in mail.class.php
Email address validator based on http://www.linuxjournal.com/article/9585 and RFC 2821 Uses recursion for arrays
Method chmod
Phpfox_Ftp::chmod() in ftp.class.php
Changes permission on a file/folder
Method clean
Phpfox_Parse_Output::clean() in output.class.php
Clean input text, usually used within HTML <input>
Method clean
Phpfox_Parse_Input::clean() in input.class.php
Parse and clean a string. We mainly use this for a title of an item, which does not allow any HTML. It can also be used to shorten a string bassed on the numerical value passed by the 2nd argument.
Method clean
We clean out the query we just ran so another query can be built
Method clean
Phpfox_Template::clean() in template.class.php
Clean all or a specific variable from memory.
Method cleanCode
Remove BBCode from a block of text.
Method cleanCss
Clean out the css by running the method parseCss().
Method cleanFileName
Cleans a file name and removes any non-latin characters.
Method cleanTitle
Parse and clean a title of an item and convert it into a URL title string.
Method clear
Phpfox_Search::clear() in search.class.php
Clear the current search form.
Method clearBreadCrumb
Clear the breadcrumb information.
Method clearMessage
Phpfox::clearMessage() in phpfox.class.php
Clear the public message we set earlier
Method clearParam
Phpfox_Url::clearParam() in url.class.php
Clears all params or a single parameter
Method close
Close the cache connection.
Method close
Close a session file.
Method close
Close a session file.
Method close
Close the cache connection.
Method closeGroup
Close an open XML group.
Class Constant CODE_NAME
Phpfox::CODE_NAME in phpfox.class.php
Product Code Name
Method compress
Compress data into the archive
Method compress
Compress data into the archive
Method compress
Method connect
Makes a connection to the MySQL database
Method connect
Method connect
Makes a connection to the SQL database
Method connect
Phpfox_Ftp::connect() in ftp.class.php
Performs a connection to a FTP server
Method connect
Method connect
Method connect
Method convert
Phpfox_Locale::convert() in locale.class.php
Converts HTML template code in phrases into actual phrases.
Method convert
Converts a string that contains non-latin characters into UNICODE.
Method convertFromGmt
Converts the time passed based on the offset passed from GMT
Method convertTime
Phpfox_Date::convertTime() in date.class.php
Converts a time stamp into a human readable phrase.
Method convertToGmt
Phpfox_Date::convertToGmt() in date.class.php
Converts the time passed based on the offset passed into GMT
Method copy
Phpfox_File::copy() in file.class.php
Copy a file from one location to another.
Method createJS
Phpfox_Validator::createJS() in validator.class.php
Client side check
Method createThumbnail
Create a thumbnail for an image
Method createThumbnail
Create a thumbnail for an image
Method cropImage
Crop an image
Method css
Phpfox_File_Minimize::css() in minimize.class.php
Page cache.class.php
cache.class.php in cache.class.php
Page cdn.class.php
cdn.class.php in cdn.class.php
Page cron.class.php
cron.class.php in cron.class.php
Page component.class.php
component.class.php in component.class.php
Page css.class.php
css.class.php in css.class.php
Page cookie.class.php
cookie.class.php in cookie.class.php
Method compile
Compile a template file and cache it to a PHP flat file.
Page cache.class.php
cache.class.php in cache.class.php
d
Function d
d() in error.class.php
PHP print_r Data so its readable
Method database
Phpfox_Service::database() in service.class.php
Extends the database object.
Class Database_Driver_Mssql
Database_Driver_Mssql in mssql.class.php
MSSQL Database Driver NOTE: This driver is not in use and is still being tested thus no documentation was done for it just yet.
Class Database_Driver_Oracle
Database_Driver_Oracle in oracle.class.php
Oracle Database Driver NOTE: This driver is not in use and is still being tested thus no documentation was done for it just yet.
Class Database_Driver_Postgres
Database_Driver_Postgres in postgres.class.php
Postgres Database Driver NOTE: This driver is not in use and is still being tested thus no documentation was done for it just yet.
Class Database_Driver_Sqlite
Database_Driver_Sqlite in sqlite.class.php
SQLite Database Driver NOTE: This driver is not in use and is still being tested thus no documentation was done for it just yet.
Method daysToDate
Phpfox_Date::daysToDate() in date.class.php
Calculates how many days there are between 2 specific dates.
Method debug
Phpfox_Ajax::debug() in ajax.class.php
Set debug information which can be picked up with Firebug.
Method decode
Phpfox_Url::decode() in url.class.php
Decodes a URL string encoded with the method encode().
Method delete
Delete entry from the database
Method delete
Delete entry from the database
Method delete
Delete entry from the database
Method delete
Delete entry from the database
Method delete
Delete entry from the database
Method delete_directory
Deletes a directory and all the files and folders in it (recursive)
Method destroy
Remove session file.
Method destroy
Remove session file.
Method display
Phpfox_Error::display() in error.class.php
Displays the error message and directly creates a variable for the template engine
Method display
Phpfox_Image_Helper::display() in helper.class.php
Displays an image on the site based on params passed
Method doRewrite
Phpfox_Url::doRewrite() in url.class.php
Perform a URL rewrite if it exists.
Method download
Method used to compress data and then send it to the user to download on the spot.
Method dropField
Drops a specific field from a table.
Method dropTables
Drops tables from the database
Method dropTables
Method dropTables
Method dropTables
Method dropTables
Page database.class.php
database.class.php in database.class.php
Page dba.class.php
dba.class.php in dba.class.php
Page date.class.php
date.class.php in date.class.php
Page debug.class.php
debug.class.php in debug.class.php
Page default.class.php
default.class.php in default.class.php
e
Function e
e() in error.class.php
Prints error messages. Used with AJAX calls
Method emphasize
Handles emphasize blocks (em, strong).
Method emphasize_off
Checks emphasize diff.
Method encode
Phpfox_Url::encode() in url.class.php
Encodes a URL string.
Method end
Phpfox_Debug::end() in debug.class.php
Ends a debug test and stores it into memory so it can be disabled in our debug table or picked up at a later time for debug purposes.
Method endLog
Phpfox::endLog() in phpfox.class.php
End the log and get it.
Method error
Phpfox_Ajax::error() in ajax.class.php
Controlls if you want to use our default error system or create your own.
Method errorCode
Phpfox_Xml_Parser::errorCode() in parser.class.php
Error code.
Method errorHandler
Phpfox_Error::errorHandler() in error.class.php
This method handles the output of the error message PHP returns. We extend the PHP error reporting with providing more information on the error and where in the source code it can be found.
Method errorLine
Phpfox_Xml_Parser::errorLine() in parser.class.php
Error line.
Method errorSet
Phpfox_Ajax::errorSet() in ajax.class.php
We have our own default error div with a specific ID, however you can use this with this function.
Method errorString
Error phrase.
Method escape
Prepares string to store in db (performs addslashes() )
Method escape
Prepares string to store in db (performs addslashes() )
Method escape
Prepares string to store in db (performs addslashes() )
Method escape
Prepares string to store in db (performs addslashes() )
Method escape
Prepares string to store in db (performs addslashes() )
Method exec
Phpfox_Cron::exec() in cron.class.php
Run cron jobs
Method execute
Method execute
Method execute
Performs the final SQL query with all the information we have gathered from various other methods in this class. Via this method you can perform all tasks from getting a single field from a row, to just one row or a list of rows.
Method execute
Method execute
Method export
Phpfox_Process::export() in process.class.php
Exports phpFox XML data.
Method export
Phpfox_Diff_Md5::export() in md5.class.php
Creates an XML export of all the files in the product and includes an MD5 hash that identifies each of the files content
Method extract
Extracts data from the archive
Method extract
Extracts data from the archive
Method extract
Page export.class.php
export.class.php in export.class.php
Page export.class.php
export.class.php in export.class.php
Page editor.class.php
editor.class.php in editor.class.php
Page error.class.php
error.class.php in error.class.php
f
Method filesize
Phpfox_File::filesize() in file.class.php
Gets the filesize of a file and returns the best human readable output.
Method fixHtml
Fixes any odd HTML, mainly dealing with HTML output from TinyMCE (WYSIWYG Editor).
Method forceDownload
Forces a file to be downloaded by the end-user and at the same time try to hide the location of the file.
Method forward
Phpfox_Url::forward() in url.class.php
Send the user to a new page. Works similar to PHP "header('Location: ...');".
Method freeResult
Method freeResult
Frees the MySQL results
Method freeResult
Method freeResult
Method freeResult
Method from
Database_Driver_Sqlite::from() in sqlite.class.php
Method from
Method from
Database_Driver_Postgres::from() in postgres.class.php
Method from
Database_Driver_Oracle::from() in oracle.class.php
Method from
Stores the FROM part of a query
Method fromEmail
Phpfox_Mail::fromEmail() in mail.class.php
Email of the person sending out this email.
Method fromName
Phpfox_Mail::fromName() in mail.class.php
The name of the person sending out the email.
Page file.class.php
file.class.php in file.class.php
Page file.class.php
file.class.php in file.class.php
Page ftp.class.php
ftp.class.php in ftp.class.php
Page format.class.php
format.class.php in format.class.php
Page file.class.php
file.class.php in file.class.php
g
Method gc
Garbage collecting.
Method gc
Garbage collecting.
Method get
Phpfox_Search_Inline::get() in inline.class.php
Get HTML form.
Method get
Phpfox_Request::get() in request.class.php
Retrieve parameter value from request.
Method get
Phpfox_Editor::get() in editor.class.php
Gets the HTML output of the current textarea editor.
Method get
Gets a session.
Method get
We attempt to get the cache file. Also used within an IF conditional statment to check if the file has already been cached.
Method get
Phpfox_Search::get() in search.class.php
Get a specific search value.
Method get
Phpfox_Error::get() in error.class.php
Get all the reported errors thus far set by the method set()
Method get
Phpfox_Plugin::get() in plugin.class.php
Get a specific plug-in.
Method get
Phpfox_Ajax::get() in ajax.class.php
Used to get $_POST requests send via an AJAX request
Method get
We attempt to get the cache file. Also used within an IF conditional statment to check if the file has already been cached.
Method get
Phpfox_Archive_Support::get() in support.class.php
Checks if a specific archive is supported by the phpFox class itself and by the server.
Method get
Gets a session.
Method getAll
Phpfox_Ajax::getAll() in ajax.class.php
Get all the $_POST params sent over via an AJAX request
Method getAll
Phpfox_Cache_Abstract::getAll() in abstract.class.php
List of all the cache files found within the "file/cache/" folder.
Method getAllFiles
Phpfox_File::getAllFiles() in file.class.php
Gets all files/folders in a give directory recursively.
Method getArray
Get a session ARRAY.
Method getArray
Get a session ARRAY.
Method getArray
Phpfox_Request::getArray() in request.class.php
Get a request and make sure it is an ARRAY.
Method getBlock
Phpfox::getBlock() in phpfox.class.php
Method getBlockLocation
Gets a blocks location.
Method getBorders
Get all borders.
Method getBorderStyles
Get all border styles.
Method getBorderWidths
Get all border widths.
Method getBreadCrumb
Phpfox_Template::getBreadCrumb() in template.class.php
Get all the breadcrumbs we have loaded so far.
Method getBrowser
Phpfox_Request::getBrowser() in request.class.php
Get the name of the browser being used.
Method getBuild
Phpfox::getBuild() in phpfox.class.php
Get the products build number.
Method getBuiltDir
Phpfox_File::getBuiltDir() in file.class.php
Gets the directory we just built to place an uploaded file.
Method getBuiltTemplate
Get a template that has already been built.
Method getCachedBlocks
Get all the cached blocks and display them in the correct order.
Method getCachedFiles
Gets all the cache files and returns information about the cache file to stats.
Method getCachedFiles
Gets all the cache files and returns information about the cache file to stats.
Method getCachedFiles
Gets all the cache files and returns information about the cache file to stats.
Method getCleanVersion
Phpfox::getCleanVersion() in phpfox.class.php
Get the clean numerical value of the phpFox version.
Method getCodeName
Phpfox::getCodeName() in phpfox.class.php
Get the products code name.
Method getColumns
Gets all the columns for a specific database table.
Method getComponent
Phpfox_Module::getComponent() in module.class.php
Loads a module component. Components are the building blocks of the site and include controllers which build up the pages we see and blocks that build up the controllers.
Method getComponent
Phpfox::getComponent() in phpfox.class.php
Method getComponentSetting
Phpfox::getComponentSetting() in phpfox.class.php
Method getComponentSetting
Gets any custom component settings for a specific user.
Method getConditions
Phpfox_Search::getConditions() in search.class.php
Get all SQL conditions.
Method getContent
Phpfox_Ajax::getContent() in ajax.class.php
Our product is designed to automatically echo data from components such as blocks and controllers and within an AJAX call we need to get that from the output buffer so we could possible place it within a specific HTML element.
Method getController
Phpfox_Module::getController() in module.class.php
Loads and outputs the current page based on the controller we loaded with the method setController().
Method getControllerName
Get the name of the current controller we are using.
Method getControllerTemplate
Gets the controllers template. We do this automatically since each controller has a specific template that it loads to output data to the site.
Method getCookie
Phpfox::getCookie() in phpfox.class.php
Gets a cookie set by the method self::setCookie().
Method getCss
Convert the ARRAY of CSS into CSS code.
Method getCurrentPage
Get the current page we are on.
Method getCustom
Phpfox_Search::getCustom() in search.class.php
Get custom search results.
Method getData
Phpfox_Ajax::getData() in ajax.class.php
This is the final output to the browser once the AJAX request is complete.
Method getData
Phpfox_Cache_Abstract::getData() in abstract.class.php
Get all the information of the cache file from the database to check if the file is cached.
Method getDetails
Phpfox_Debug::getDetails() in debug.class.php
Debug output found at the bottom of the site when debug mode is enabled.
Method getDisplay
Phpfox_Error::getDisplay() in error.class.php
Gets the current display status of error reporting
Method getDisplay
Phpfox_Search::getDisplay() in search.class.php
Get the display.
Method getDomain
Phpfox_Url::getDomain() in url.class.php
Get the domain mame of the site.
Method getDriver
Gets a specific driver and returns all the information about it.
Method getEditForm
Each gateway has a unique list of params that must be passed with the HTML form when posting it to their site. This method creates that set of custom fields.
Method getEditForm
Each gateway has a unique list of params that must be passed with the HTML form when posting it to their site. This method creates that set of custom fields.
Method getEditForm
Each gateway has a unique list of params that must be passed with the HTML form when posting it to their site. This method creates that set of custom fields.
Method getError
Phpfox_Api::getError() in api.class.php
Return any errors we may have found.
Method getField
Returns one field from a row
Method getField
Returns one field from a row
Method getField
Returns one field from a row
Method getField
Returns one field from a row
Method getField
Returns one field from a row
Method getFields
Returns all the fields for all the tables in our database so we can compare with past versions.
Method getFiles
Phpfox_File::getFiles() in file.class.php
Gets all the files/folders in a specified directory.
Method getFonts
Get all fonts.
Method getFontSizes
Get all font sizes.
Method getFontStyles
Get all font styles.
Method getFontWeights
Get all font weights.
Method getForm
Returns the actual HTML <form> used to post information to the 3rd party gateway when purchasing an item using this specific payment gateway
Method getForm
Returns the actual HTML <form> used to post information to the 3rd party gateway when purchasing an item using this specific payment gateway
Method getForm
Returns the actual HTML <form> used to post information to the 3rd party gateway when purchasing an item using this specific payment gateway
Method getFullControllerName
Gets the full name of the controller we are using including the module prefix.
Method getFullUrl
Phpfox_Url::getFullUrl() in url.class.php
Get the full URL of the current page.
Method getGmtOffset
Phpfox_Date::getGmtOffset() in date.class.php
Gets the offset from the current timezone being used to GMT.
Method getHeader
Phpfox_Template::getHeader() in template.class.php
Gets any data we plan to place within the HTML tags <head></head>.
Method getHeaderFile
Phpfox_Template::getHeaderFile() in template.class.php
Get the template header file if it exists.
Method getHistory
Phpfox_Debug::getHistory() in debug.class.php
Gets history on a specific debug test that was executed earlier
Method getId
Phpfox::getId() in phpfox.class.php
Get the current phpFox version ID.
Method getIdHash
Phpfox_Request::getIdHash() in request.class.php
Method getIndexes
Gets all the indexes for a specific database table.
Method getInstance
Phpfox_Cache::getInstance() in cache.class.php
Return the object of the storage object.
Method getInstance
Phpfox_Session::getInstance() in session.class.php
Get session object.
Method getInstance
Phpfox_Database::getInstance() in database.class.php
Return the object of the storage object.
Method getInstance
Get session object.
Method getInstance
Phpfox_Cdn::getInstance() in cdn.class.php
Return the object of the CDN module object.
Method getInstance
Phpfox_Archive::getInstance() in archive.class.php
Return the object of the extension class.
Method getInstance
Phpfox_Image::getInstance() in image.class.php
Returns the object of the image library we are using
Method getInt
Phpfox_Request::getInt() in request.class.php
Get a request and convert it into an INT.
Method getIp
Phpfox::getIp() in phpfox.class.php
Method getIp
Phpfox_Request::getIp() in request.class.php
Fetches an alternate IP address of the current visitor, attempting to detect proxies etc.
Method getJavaScript
Get JavaScript code used to verify the validity of a CSS property value.
Method getJsForm
Phpfox_Validator::getJsForm() in validator.class.php
Create the JS form onsubmit=""
Method getKeywords
Phpfox_Template::getKeywords() in template.class.php
Gets all the keywords from a string.
Method getLang
Phpfox_Locale::getLang() in locale.class.php
Get all the information provided on the current language package being used.
Method getLangBy
Phpfox_Locale::getLangBy() in locale.class.php
Get all the information for a specific language package
Method getLangId
Phpfox_Locale::getLangId() in locale.class.php
Return the language ID for the current language package in use. This value is based on several variables as specific users can select a language package they want to browse the site in and admins can also select the default language package for the site.
Method getLastId
Returns row id from last executed query
Method getLastId
Returns row id from last executed query
Method getLastId
Returns row id from last executed query
Method getLastId
Returns row id from last executed query
Method getLastId
Returns row id from last executed query
Method getLastPage
Phpfox_Pager::getLastPage() in pager.class.php
Get the number of the last page.
Method getLayout
Phpfox_Template::getLayout() in template.class.php
Loads the current template.
Method getLayoutFile
Phpfox_Template::getLayoutFile() in template.class.php
Get the full path of the current layout file.
Method getLib
Phpfox::getLib() in phpfox.class.php
Get a phpFox library. This includes the class file and creates the object for you.
Method getLibClass
Phpfox::getLibClass() in phpfox.class.php
Fine and load a library class and make sure it exists.
Method getLimit
Phpfox_File::getLimit() in file.class.php
Gets the servers limit on uploading files.
Method getMenu
Phpfox_Template::getMenu() in template.class.php
Gets all the sites custom menus, such as the Main, Header, Footer and Sub menus.
Method getMessage
Phpfox::getMessage() in phpfox.class.php
Get the public message we setup earlier
Method getMeta
Phpfox_File::getMeta() in file.class.php
Get meta information about a file using the getID3 library.
Method getMobileHeader
Gets any data we plan to place within the HTML tags <head></head> for mobile devices.
Method getModuleBlocks
Gets all the blocks for a specific location on a specific page.
Method getModuleFiles
Get all the modules found within the module folder.
Method getModuleId
Phpfox_Module::getModuleId() in module.class.php
Returns the module ID. Since Alpha versions of phpFox we changed modules to have unique string IDs so this function basically returns the same ID you are passing with the first argument.
Method getModuleName
Phpfox_Module::getModuleName() in module.class.php
Get the module name of the current controller we are using.
Method getModules
Phpfox_Module::getModules() in module.class.php
Get all the active modules.
Method getModuleTables
Get all the tables part of each of the active modules.
Method getMonth
Phpfox_Date::getMonth() in date.class.php
Gets a specific month and returns the phrase based on the language package being used
Method getNewSize
Returns a new width/height for an image based on the max arguments passed
Method getNextPage
Phpfox_Pager::getNextPage() in pager.class.php
Get the number of the next page.
Method getObject
Phpfox::getObject() in phpfox.class.php
Gets and creates an object for a class.
Method getOffset
Phpfox_Pager::getOffset() in pager.class.php
Get offset for given page (fix page number if needed)
Method getPaddings
Get all paddings.
Method getPaddingSizes
Get all padding sizes.
Method getPage
Phpfox_Search::getPage() in search.class.php
Get the current page we are on.
Method getParam
Phpfox::getParam() in phpfox.class.php
Method getParam
Phpfox_Component::getParam() in component.class.php
Get a param for any component loaded after it was set using the method setParam()
Method getParam
Phpfox_Setting::getParam() in setting.class.php
Get a setting and its value.
Method getParams
Get params within SMARTY {} tags.
Method getParams
Phpfox_Url::getParams() in url.class.php
Get all the requests.
Method getPath
Phpfox_Ftp::getPath() in ftp.class.php
Try to find the full path of where we are currently located based on the relative position we are allowed to access on the FTP server.
Method getPhrase
Phpfox_Locale::getPhrase() in locale.class.php
Gets a phrase from a language.
Method getPhrase
Phpfox::getPhrase() in phpfox.class.php
Method getPhraseT
Phpfox::getPhraseT() in phpfox.class.php
Method getPositions
Get all positions.
Method getRandomHash
Verifies if the hash we created earlier with the method setRandomHash() matches.
Method getRequests
Phpfox_Request::getRequests() in request.class.php
Get all the requests.
Method getResource
Method getRewrite
Phpfox_Url::getRewrite() in url.class.php
Get all the custom rewrite rules.
Method getRow
Method getRow
Method getRow
Returns one row
Method getRow
Method getRow
Method getRows
Method getRows
Method getRows
Method getRows
Method getRows
Returns several rows
Method getSaturday
Phpfox_Date::getSaturday() in date.class.php
Gets the first saturday of the coming week
Method getSchema
Returns an SQL schema for a specific driver. Only used in development mode when exporting our database before a release.
Method getSearch
Phpfox_Search::getSearch() in search.class.php
Get the search we cached in the database.
Method getSearchTotal
Get the search total.
Method getServer
Phpfox_Request::getServer() in request.class.php
Get specific server value. ($_SERVER)·
Method getServerId
Returns a server ID. We always run "1" (int) if the file was uploaded to the amazon server, if not return "0" (int) so we display the local file instead.
Method getServerInfo
Method getServerInfo
Method getServerInfo
Method getServerInfo
Returns MySQL server information. Here we only identify that it is MySQL and the version being used.
Method getServerInfo
Method getServerInfo
Returns SQL server information.
Method getServerUrl
Phpfox_Request::getServerUrl() in request.class.php
Get the servers URL based on the server ID you pass.
Method getServerUrl
Phpfox_Server::getServerUrl() in server.class.php
Return the server URL based on the server ID (load balancing).
Method getService
Phpfox::getService() in phpfox.class.php
Method getService
Phpfox_Module::getService() in module.class.php
Loads a service class. Service classes are module based class that interact with the database and runs general PHP logic that is not needed to be found with components.
Method getSessionHash
Fetches a valid sessionhash value, not necessarily the one tied to this session.
Method getSlaveField
Returns one field from a row
Method getSlaveField
Returns one field from a row
Method getSlaveField
Returns one field from a row
Method getSlaveField
Returns one field from a row using a slave connection
Method getSlaveField
Returns one field from a row
Method getSlaveRow
Method getSlaveRow
Returns one row using a slave connection
Method getSlaveRow
Method getSlaveRow
Method getSlaveRow
Method getSlaveRows
Method getSlaveRows
Returns several rows using a slave connection
Method getSlaveRows
Method getSlaveRows
Method getSlaveRows
Method getSort
Phpfox_Search::getSort() in search.class.php
Get the current sorting order.
Method getStatic
Returns all the static javascript and css files we have saved using the cache system.
Method getStats
Phpfox_Cache_Abstract::getStats() in abstract.class.php
Get all the stats about the cache storage system.
Method getStyle
Phpfox_Template::getStyle() in template.class.php
Gets the full path of a file based on the current style being used.
Method getStyleLogo
Phpfox_Template::getStyleLogo() in template.class.php
Get the logo for the site based on the style being used.
Method getSubstrIp
Phpfox_Request::getSubstrIp() in request.class.php
Returns the IP address with the specified number of octets removed
Method getSunday
Phpfox_Date::getSunday() in date.class.php
Gets the first sunday of the coming week
Method getSupported
Gets all the supported drivers by making sure the driver class exists and if the actual server has support for it.
Method getSupported
Based on the supported archives allowed with the set() method this returns all of them but based on what the server can actually support as well.
Method getSupported
Method getT
Phpfox::getT() in phpfox.class.php
Builds a database table prefix.
Method getTables
Gets all the tables from the database.
Method getTableStatus
Returns the status of the table.
Method getTempDir
Phpfox_File::getTempDir() in file.class.php
Get the temporary directory of the server based on the servers enviroment variables.
Method getTemplate
Phpfox_Template::getTemplate() in template.class.php
Get the current template data.
Method getTemplateFile
Get the full path to the modular template file we are loading.
Method getTextAlign
Get all text allignments.
Method getTextDecorations
Get all text decorations.
Method getTextTransforms
Get all text transformations.
Method getThemeCache
Phpfox_Template::getThemeCache() in template.class.php
Get the cached information about the theme we are using.
Method getThemeFolder
Phpfox_Template::getThemeFolder() in template.class.php
Get the theme folder being used.
Method getThemeLayout
Phpfox_Template::getThemeLayout() in template.class.php
Get the current theme we are using.
Method getTime
Phpfox::getTime() in phpfox.class.php
Gets a time stamp, Works similar to PHP date() function.
Method getTimeZone
Phpfox_Date::getTimeZone() in date.class.php
Gets the current time zone for a person browsing the site. If they have selected a time zone it will return their value, if not it will return the sites default time zone.
Method getTimeZone
Phpfox::getTimeZone() in phpfox.class.php
Method getTitle
Phpfox_Template::getTitle() in template.class.php
Get the title for the current page beind displayed.
Method getTotalPages
Get the number of total pages.
Method getUrl
Get the full URL to the amazon bucket with support to load a CDN CNAME URL.
Method getUrl
Phpfox_Url::getUrl() in url.class.php
Get the URL of the current page.
Method getUserBy
Phpfox::getUserBy() in phpfox.class.php
Method getUserField
Phpfox::getUserField() in phpfox.class.php
Get all the user fields when joining with the user database table.
Method getUserGroupParam
Phpfox::getUserGroupParam() in phpfox.class.php
Method getUserId
Phpfox::getUserId() in phpfox.class.php
Method getUserParam
Phpfox::getUserParam() in phpfox.class.php
Get a user group setting.
Method getValue
Phpfox_Editor::getValue() in editor.class.php
Gets the $_POST form value based on the ID passed.
Method getVar
Phpfox_Template::getVar() in template.class.php
Get a variable we assigned with the method assign().
Method getVersion
Method getVersion
Returns the MySQL version
Method getVersion
Returns the SQL version
Method getVersion
Phpfox::getVersion() in phpfox.class.php
Get the current phpFox version.
Method getVersion
Method getVersion
Method getVersion
Method getWaitTime
Phpfox_Spam::getWaitTime() in spam.class.php
Gets the time phrase of how long a user must wait before they can repost on the same section.
Method getWeekEnd
Phpfox_Date::getWeekEnd() in date.class.php
Finds the upcoming weekend
Method getXml
Phpfox_Xml_Parser::getXml() in parser.class.php
Get the XML content.
Method getXml
Phpfox_Template::getXml() in template.class.php
Load and get the XML information about the theme used when custom designing a profile.
Method group
Stores the GROUP BY part of a query
Method group
Database_Driver_Postgres::group() in postgres.class.php
Method group
Method group
Method group
Page gateway.class.php
gateway.class.php in gateway.class.php
Page gd.class.php
gd.class.php in gd.class.php
Method getAll
Get all the template files that have been cached.
h
Method hasCallback
Phpfox::hasCallback() in phpfox.class.php
Method hasCallback
Phpfox_Module::hasCallback() in module.class.php
Checks if a specific module has a specific callback method.
Method having
Stores the HAVING part of a query
Method having
Method having
Method having
Method having
Method hideEmail
Hide the email service that is part of an email.
Method highlight
Phpfox_Search::highlight() in search.class.php
Highlight a search string.
Method html
Phpfox_Ajax::html() in ajax.class.php
jQuery has support for innerHTML and we use that method, however we add a little extra protection with our routine.
Method htmlspecialchars
Our method of PHP htmlspecialchars().
Page hash.class.php
hash.class.php in hash.class.php
Page helper.class.php
helper.class.php in helper.class.php
Page handler.class.php
handler.class.php in handler.class.php
Page hash.class.php
hash.class.php in hash.class.php
i
Variable $iThemeId
Phpfox_Template::$iThemeId in template.class.php
Theme ID#
Method import
Phpfox_Process::import() in process.class.php
Import XML data.
Page import.class.php
import.class.php in import.class.php
Page interface.class.php
interface.class.php in interface.class.php
Page interface.class.php
interface.class.php in interface.class.php
Page interface.class.php
interface.class.php in interface.class.php
Page image.class.php
image.class.php in image.class.php
Page interface.class.php
interface.class.php in interface.class.php
Page interface.class.php
interface.class.php in interface.class.php
Page input.class.php
input.class.php in input.class.php
Page inline.class.php
inline.class.php in inline.class.php
Method init
Start the session.
Method init
Phpfox_Module::init() in module.class.php
Loads a init class file that each module has and returns a specified property which has information about the module.
Method init
Loads session handler. All we do here is start a session.
Method init
Start the session.
Method initMethod
Phpfox_Module::initMethod() in module.class.php
Loads a init class file that each module has and executes a specific method.
Method innerJoin
Method innerJoin
Method innerJoin
Method innerJoin
Method innerJoin
Creates a INNER JOIN for an SQL query.
Method insert
Performs insert of one row. Accepts values to insert as an array: 'column1' => 'value1' 'column2' => 'value2'
Method insert
Performs insert of one row. Accepts values to insert as an array: 'column1' => 'value1' 'column2' => 'value2'
Method insert
Performs insert of one row. Accepts values to insert as an array: 'column1' => 'value1' 'column2' => 'value2'
Method insert
Performs insert of one row. Accepts values to insert as an array: 'column1' => 'value1' 'column2' => 'value2'
Method is
Phpfox_Request::is() in request.class.php
Checks to see if a request exists.
Method isAdmin
Phpfox::isAdmin() in phpfox.class.php
Used to see if a user is an Admin. By passing the first argument as TRUE we can also do an auto redirect to guide the user to login first before using a feature in the AdminCP.
Method isAdminPanel
Phpfox::isAdminPanel() in phpfox.class.php
Check to see if we are in the AdminCP or not.
Method isBrowser
Phpfox_Request::isBrowser() in request.class.php
Check if the user is using a specific browser and browser version.
Method isCached
Checks if a file is cached or not.
Method isCached
Checks if a file is cached or not.
Method isEmpty
Phpfox_Parse_Format::isEmpty() in format.class.php
Does a check to make sure a string is really not empty. This takes the PHP function empty a little further.
Method isField
Checks if a field already exists or not.
Method isHex
Phpfox_Parse_Css::isHex() in css.class.php
Check if a color is a valid HEX.
Method isImage
Phpfox_Image_Abstract::isImage() in abstract.class.php
Verification to check if an image is well an image when it is first being uploaded
Method isImageExtension
Check to make sure the image being uploaded is a valid image extension that we support
Method isImageLink
Make sure images added to CSS are really images.
Method isIP
Phpfox_Request::isIP() in request.class.php
Check to see if an IP is really an IP.
Method isLeapYear
Phpfox_Date::isLeapYear() in date.class.php
Checks if the current year passed is a leap year.
Method isMobile
Phpfox_Url::isMobile() in url.class.php
Check to see if we are using a mobile device.
Method isMobile
Phpfox_Request::isMobile() in request.class.php
Check to see if we are using a mobile device.
Method isMobile
Phpfox::isMobile() in phpfox.class.php
Method isModule
Phpfox::isModule() in phpfox.class.php
Method isModule
Phpfox_Module::isModule() in module.class.php
Checks if a module is valid or not (IF EXISTS OR IF EXISTS AND IS VALUE)
Method isNotNull
Check if a field in the database is set not null
Method isNull
Check if a field in the database is set to null
Method isPackage
Phpfox::isPackage() in phpfox.class.php
Check if a feature can be used based on the package the client has installed.
Method isParam
Phpfox_Setting::isParam() in setting.class.php
Checks to see if a setting exists or not.
Method isPassed
Phpfox_Error::isPassed() in error.class.php
Returns if an error has accured up to this point. This is bassed on anything set by the method set(). This is used with IF conditional statments to see if we can continue with a routine or if an error has occured.
Method isPhrase
Phpfox_Locale::isPhrase() in locale.class.php
Checks if a phrase exists in the language package or not
Method isPublicView
Phpfox::isPublicView() in phpfox.class.php
Check to see if items are to be displayed in a public manner or within a persons profile.
Method isRegistration
Check if the controller we are on has a registration step.
Method isSearch
Phpfox_Search::isSearch() in search.class.php
Check if we submitted the search form.
Method isSearching
Phpfox_Search::isSearching() in search.class.php
Check to see if we are currently trying to perform a search.
Method isSerialized
Checks if a given string is serialized or not.
Method isSpam
Phpfox_Spam_Hash::isSpam() in hash.class.php
Checks to see if the content being passed is considered as SPAM.
Method isSpammer
Phpfox::isSpammer() in phpfox.class.php
Checks to see if the user that is logged in has been marked as a spammer.
Method isUrl
Phpfox_Url::isUrl() in url.class.php
Checks to see if a URL exists.
Method isUser
Phpfox::isUser() in phpfox.class.php
Used to see if a user is logged in or not. By passing the first argument as TRUE we can also do an auto redirect to guide the user to login first before using a feature.
Method isUser
Phpfox_Ajax::isUser() in ajax.class.php
Quick function that can be used to identify if a user is logged it or not and if not they will not be able to use the specific feature and display a login form.
Method isValid
Phpfox_Validator::isValid() in validator.class.php
Server Side check
Method isWindows
Phpfox_Server::isWindows() in server.class.php
Check to see if we are on a windows server.
Method isWritable
Phpfox_File::isWritable() in file.class.php
Checks if path is writable
Method itemUrl
Phpfox::itemUrl() in phpfox.class.php
Creates a URL for an item that is connected with a users profile.
j
Method join
Database_Driver_Postgres::join() in postgres.class.php
Method join
Database_Driver_Sqlite::join() in sqlite.class.php
Method join
Database_Driver_Oracle::join() in oracle.class.php
Method join
Method join
Creates a JOIN for an SQL query.
Method js
Phpfox_File_Minimize::js() in minimize.class.php
Method jsClean
Remove evil attributes from JavaScript.
l
Page locale.class.php
locale.class.php in locale.class.php
Method lastDayOfMonth
Gets the last day of month.
Method leftJoin
Method leftJoin
Method leftJoin
Method leftJoin
Creates a LEFT JOIN for an SQL query.
Method leftJoin
Method limit
Method limit
Method limit
Database_Driver_Postgres::limit() in postgres.class.php
Method limit
Method limit
Stores the LIMIT/OFFSET part of a query. It can also be used to create a pagination if params 2 and 3 and filled otherwise it bahaves just as a limit on the SQL query.
Method link
Phpfox::link() in phpfox.class.php
Provide "powered by" link.
Method live
Phpfox_Search::live() in search.class.php
Define that this is a live search.
Method load
Phpfox_File::load() in file.class.php
Loads an uploaded file and performs checks to make sure it was allowed
Method load
Phpfox_Gateway::load() in gateway.class.php
Loads a specific payment gateway API class
Method lock
Phpfox_Cache_Abstract::lock() in abstract.class.php
Lock the cache system. When the cache system is locked you will not be able to cache anything new until it is unlocked.
Method log
Phpfox::log() in phpfox.class.php
Log a message.
Method log
Phpfox_Error::log() in error.class.php
Error messages can also be logged into a flat file on the server. The reason for this certain AJAX request or API callbacks may be hard to find error reports and by adding all error reports to a flat file it will help with debugging. This is automatically used with our error handler.
m
Page memcache.class.php
memcache.class.php in memcache.class.php
Page mssql.class.php
mssql.class.php in mssql.class.php
Page mysql.class.php
mysql.class.php in mysql.class.php
Page mysqli.class.php
mysqli.class.php in mysqli.class.php
Page md5.class.php
md5.class.php in md5.class.php
Page minimize.class.php
minimize.class.php in minimize.class.php
Page mail.class.php
mail.class.php in mail.class.php
Page mail.class.php
mail.class.php in mail.class.php
Page module.class.php
module.class.php in module.class.php
Page memcache.class.php
memcache.class.php in memcache.class.php
Method makeReverseUrl
Reverse rewrite URLs.
Method makeUrl
Phpfox_Url::makeUrl() in url.class.php
Make an internal link.
Method massCallback
Phpfox_Module::massCallback() in module.class.php
Performs a callback on all the modules that have the method being executed.
Method massCallback
Phpfox::massCallback() in phpfox.class.php
Method message
Phpfox_Mail::message() in mail.class.php
Message of the email.
Method message
Phpfox_Debug::message() in debug.class.php
Store any debug messages that will later be outputed in the global debug table
Method message
Phpfox_Api::message() in api.class.php
Echo a public message. Used when the site is being upgraded or hasn't been installed.
Method messageHeader
Identify if we should load the message header we include by default.
Method messagePlain
Phpfox_Mail::messagePlain() in mail.class.php
Message of the email (Plain Text).
Method mkdir
Phpfox_Ftp::mkdir() in ftp.class.php
Makes a directory on the server. There is also support to make directories recursively.
Method mkdir
Phpfox_File::mkdir() in file.class.php
Creates a directory. Unlike mkdir() it can also create recursive directories based on the full path that is being passed.
Method mktime
Phpfox_Date::mktime() in date.class.php
PHP has their own mktime() function, however there are issues related to dates before the year 1901 and the year 2038. This function extends the PHP mktime() function to help resolve those issues. The logic and outcome is still the same as mktime()
Method modifyHours
Phpfox_Date::modifyHours() in date.class.php
Modify the current hour of a time stamp based on DST settings
Method move
Phpfox_Ftp::move() in ftp.class.php
Moves a file from one location to another on the FTP server.
Method multiInsert
Method multiInsert
Runs an SQL query to run one SQL query and insert multiple rows. The 2nd and 3rd params much match in order to inser the data correctly.
Method multiInsert
Method multiInsert
Method multiInsert
n
Method notification
Phpfox_Mail::notification() in mail.class.php
Notification param for this specific email to check a users privacy settings.
o
Page oracle.class.php
oracle.class.php in oracle.class.php
Page output.class.php
output.class.php in output.class.php
Method open
Open a session file.
Method open
Open a session file.
Method optimizeTable
Optimizes a table
Method order
Database_Driver_Postgres::order() in postgres.class.php
Method order
Method order
Stores the ORDER part of a query
Method order
Method order
Method output
Phpfox_Xml_Builder::output() in builder.class.php
Return XML data we have built so far.
p
Page postgres.class.php
postgres.class.php in postgres.class.php
Page paypal.class.php
paypal.class.php in paypal.class.php
Page pager.class.php
pager.class.php in pager.class.php
Page phpfox.class.php
phpfox.class.php in phpfox.class.php
Page process.class.php
process.class.php in process.class.php
Page plugin.class.php
plugin.class.php in plugin.class.php
Page parser.class.php
parser.class.php in parser.class.php
Function p
p() in error.class.php
Print DATA
Method param
Phpfox_Component::param() in component.class.php
Creates a groupig for a param.
Method parse
Phpfox_Parse_Output::parse() in output.class.php
Text we need to parse, usually text added via a <textarea>.
Method parse
Phpfox_Xml_Parser::parse() in parser.class.php
Parse XML code and convert into an ARRAY.
Method parse
Phpfox_Parse_Wiki::parse() in wiki.class.php
Parse string and converts WIKI code into HTML.
Method parse
Phpfox_Parse_Bbcode::parse() in bbcode.class.php
2nd run to parse BBCode into HTML. This is the final run and after this all BBCode will have been converted into HTML.
Method parse
Phpfox_Locale::parse() in locale.class.php
Parses a phrase to convert ASCII rules.
Method parseCss
Parse CSS code and remove evil tags, comments.
Method parseUrl
Phpfox_Url::parseUrl() in url.class.php
Parse a URL string.
Method phpCode
Phpfox_Parse_Format::phpCode() in format.class.php
Parse PHP code with the correct amount of backslashes when storing it in a flat file.
Class Phpfox
Phpfox in phpfox.class.php
phpFox Engine All interactions with anything phpFox related is executed via this class.
Class Phpfox_Ajax
Phpfox_Ajax in ajax.class.php
Handles AJAX Requests and returns data outputed
Class Constant PHPFOX_API
Phpfox::PHPFOX_API in phpfox.class.php
phpFox API server.
Class Phpfox_Api
Phpfox_Api in api.class.php
phpFox API Class is used to interact with our API server.
Class Phpfox_Archive
Phpfox_Archive in archive.class.php
Handles archives such as zip and tar.gz.
Class Phpfox_Archive_Export
Phpfox_Archive_Export in export.class.php
Used to export data such as a 3rd party product or language package and compress it into a ZIP archive and force the user to download the package on the spot.
Class Phpfox_Archive_Extension_Tar
Handle archive with tar.gz file extensions.
Class Phpfox_Archive_Extension_Xml
Handle XML data in instead of storing data in conventional archives. Note that this class is not in use so no further documenation was done to further explain this class. We reserved this file in case we plan on using it in the future.
Class Phpfox_Archive_Extension_Zip
Handle archive with zip file extensions.
Class Phpfox_Archive_Import
Phpfox_Archive_Import in import.class.php
Used to import data from a archive like a ZIP or tar.gz. This class however is not being used and is currently on hold to be removed or replaced by a new routine.
Class Phpfox_Archive_Support
Phpfox_Archive_Support in support.class.php
Runs a check on the server to fully check what extensions are supported by the server.
Class Phpfox_Cache
Phpfox_Cache in cache.class.php
Class is used to cache any sort of data that is passed via PHP.
Class Phpfox_Cache_Abstract
Phpfox_Cache_Abstract in abstract.class.php
Abstract class for cache storage classes. This class is used to work with the cache system and certain methods do not require to work with a specific storage.
Class Phpfox_Cache_Interface
Phpfox_Cache_Interface in interface.class.php
Template for cache storage classes.
Class Phpfox_Cache_Storage_File
Phpfox_Cache_Storage_File in file.class.php
File Cache Layer - This class handles the cache routine for phpFox and can store arrays, strings and objects. All the data is stored in a flat file which has a unique id. Data is also serilazed before its stored in the flat file.
Class Phpfox_Cache_Storage_Memcache
Phpfox_Cache_Storage_Memcache in memcache.class.php
Memcached Cache Layer - This class handles the cache routine for phpFox and can store arrays, strings and objects. All the data is stored in memcached which has a unique id. Data is also serilazed before its stored.
Class Phpfox_Cdn
Phpfox_Cdn in cdn.class.php
We use this class to store data on CDN services like Amazon S3. This can be items from photos, videos, songs, CSS files etc...
Class Phpfox_Cdn_Abstract
Phpfox_Cdn_Abstract in abstract.class.php
Abstract layer for CDN.
Class Phpfox_Cdn_Module_S3
Phpfox_Cdn_Module_S3 in s3.class.php
Class to work with Amazons S3 CDN
Class Phpfox_Component
Phpfox_Component in component.class.php
Module Component Parent Class is parent with all block/controller components that control each page on the site as well as blocks found on this pages.
Class Phpfox_Cron
Phpfox_Cron in cron.class.php
Run cron jobs and store a log of all the cron jobs being executed. All cron jobs are executed via the file "include/cron/exec.php". The actual PHP code that is being executed with each cron job is stored in the database in the table "cron".
Class Phpfox_Database
Phpfox_Database in database.class.php
Database layer for phpFox. All interactions with a database is done via this class.
Class Phpfox_Database_Dba
Phpfox_Database_Dba in dba.class.php
Parent class for all SQL drivers. Each driver needs to interact with this class in case any modifications need to be done to a query.
Class Phpfox_Database_Driver_Mysql
Phpfox_Database_Driver_Mysql in mysql.class.php
Database driver for MySQL.
Class Phpfox_Database_Driver_Mysqli
Phpfox_Database_Driver_Mysqli in mysqli.class.php
Database driver for MySQLi. This class extends the MySQL driver we provide since both function in the same way there was no need to make an extra class for MySQLi.
Class Phpfox_Database_Export
Phpfox_Database_Export in export.class.php
Exports database structure into SQL code based on the driver. Mainly used when exporting a new version that will be released to our clients to keep a schema of a database structure for each SQL driver.
Class Phpfox_Database_Interface
Phpfox_Database_Interface in interface.class.php
Template for all database drivers found in: library/phpfox/database/driver/
Class Phpfox_Database_Support
Phpfox_Database_Support in support.class.php
Works with all the supported database drivers we support and what the actual
Class Phpfox_Date
Phpfox_Date in date.class.php
Handles all time/date related logic for phpFox.
Class Phpfox_Debug
Phpfox_Debug in debug.class.php
Handles the debugging of the script when in development mode. Mainly used by developers when testing the product itself or their own product.
Class Phpfox_Diff_Md5
Phpfox_Diff_Md5 in md5.class.php
Exports all the files used by the product and creates an MD5 identification for the file. This is mainly used to idenify if a script has been modified in comparison to the default script provided by us.
Class Phpfox_Editor
Phpfox_Editor in editor.class.php
Handles the output of the text editor used on many sections of the site. This allows the easy integration of other text editors with WYSIWYG features.
Class Phpfox_Error
Phpfox_Error in error.class.php
Error handling for phpFox.
Class Phpfox_File
Phpfox_File in file.class.php
Handles anything related to files and/or folders on the server.
Class Phpfox_File_Minimize
Phpfox_File_Minimize in minimize.class.php
Class Phpfox_Ftp
Phpfox_Ftp in ftp.class.php
Handles FTP (File Transfer Protocol).
Class Phpfox_Gateway
Phpfox_Gateway in gateway.class.php
API Gateway Layer Handles all API requests to interact with 3rd party payment gateway sites like PayPal, 2checkout.
Class Phpfox_Gateway_Api_2checkout
Phpfox_Gateway_Api_2checkout in 2checkout.class.php
2checkout Payment Gateway API
Class Phpfox_Gateway_Api_Paypal
Phpfox_Gateway_Api_Paypal in paypal.class.php
PayPal Payment Gateway API
Class Phpfox_Gateway_Interface
Phpfox_Gateway_Interface in interface.class.php
Payment Gateway API Template
Class Phpfox_Hash
Phpfox_Hash in hash.class.php
Random Hash Creator Creates a random hash for passwords as well as create a random hash for cookies were X will always have a different hash value due to a random prefix.
Class Phpfox_Image
Phpfox_Image in image.class.php
Image Manipulation Library Loader Loads the specified image manipulation library to be used based on admin settings.
Class Phpfox_Image_Abstract
Phpfox_Image_Abstract in abstract.class.php
Abstract Layer for Image Libraries Common methods that can be used on all the image libraries are packed into this class.
Class Phpfox_Image_Helper
Phpfox_Image_Helper in helper.class.php
Image Helper Displays all the images we see on a phpFox site. Each image runs thru this class where we perform many sanity and file size checks before they are displayed on a site.
Class Phpfox_Image_Interface
Phpfox_Image_Interface in interface.class.php
Image Manipulation Library Template
Class Phpfox_Image_Library_Gd
Phpfox_Image_Library_Gd in gd.class.php
GD Image Layer Class is used to create/manipulate images using GD
Class Phpfox_Locale
Phpfox_Locale in locale.class.php
Language Localization Class is used to display all the phrases on the site allowing phpFox to support multiple languages
Class Phpfox_Mail
Phpfox_Mail in mail.class.php
Email Driver Layer Our email loads a 3rd party email class that usually has support for both sendmail and smtp.
Class Phpfox_Mail_Driver_Phpmailer_Mail
PHPMailer Sendmail
Class Phpfox_Mail_Driver_Phpmailer_Smtp
PHPMailer SMTP
Class Phpfox_Mail_Interface
Phpfox_Mail_Interface in interface.class.php
Email Driver Template
Class Phpfox_Module
Phpfox_Module in module.class.php
Module Handler This class is used to call and interact with all the modules. Modules are used to power all the pages and blocks found on those pages.
Class Constant PHPFOX_PACKAGE
Phpfox::PHPFOX_PACKAGE in phpfox.class.php
phpFox package ID.
Class Phpfox_Pager
Phpfox_Pager in pager.class.php
Pagination This class handles all the pagination on the site and creates a template variable that is automatically picked up with a simple HTML variable call.
Class Phpfox_Parse_Bbcode
Phpfox_Parse_Bbcode in bbcode.class.php
BBCode Parser This class parses common BBCode into HTML. This class is fully part of the parsing system we have in place when parsing incoming data before entering it into the database.
Class Phpfox_Parse_Css
Phpfox_Parse_Css in css.class.php
CSS Code Parser Parses CSS code passed on by end-users and make sure the data being passed is valid.
Class Phpfox_Parse_Format
Phpfox_Parse_Format in format.class.php
Common String Handling This class is used to run common methods on strings or do sanity checks on a string.
Class Phpfox_Parse_Input
Phpfox_Parse_Input in input.class.php
Input Parser Class is used to parse all incoming data sent by end users via HTML forms.
Class Phpfox_Parse_Output
Phpfox_Parse_Output in output.class.php
Cleans text added to the database and already parsed/cleaned via Parse_Input.
Class Phpfox_Parse_Wiki
Phpfox_Parse_Wiki in wiki.class.php
WIKI Parser Clones how a common WIKI works and allows the ability for users to use WIKI code to create pages.
Class Phpfox_Plugin
Phpfox_Plugin in plugin.class.php
Plugins
Class Phpfox_Process
Phpfox_Process in process.class.php
phpFox Process Class is used to import/export modules. Used mainly in development.
Class Phpfox_Request
Phpfox_Request in request.class.php
Creates a special request method which is used in the script instead of calling the default $_REQUEST methods. All requests are parsed and trimmed.
Class Phpfox_Search
Phpfox_Search in search.class.php
Search Class is used to perform searches on all sections on the site.
Class Phpfox_Search_Inline
Phpfox_Search_Inline in inline.class.php
Inline Search Search used with AJAX request to create a drop down box.
Class Phpfox_Server
Phpfox_Server in server.class.php
Server Class is used to check on server enviroment.
Class Phpfox_Service
Phpfox_Service in service.class.php
Module Service Parent This class is the parent class for all module services. Services handle all database interactions and any PHP logic outside the scope of a component (block/controller).
Class Phpfox_Session
Phpfox_Session in session.class.php
Storage Hanlder Loader Loads storage hanlders found: include/library/phpfox/session/storage/
Class Phpfox_Session_Handler
Phpfox_Session_Handler in handler.class.php
Session Handler Loader Loads session handlers: include/library/phpfox/session/handler/
Class Phpfox_Session_Handler_Default
Phpfox_Session_Handler_Default in default.class.php
Default Server Handler Not much done in this class since we use the default PHP $_SESSION handling.
Class Phpfox_Session_Handler_File
Phpfox_Session_Handler_File in file.class.php
File Based Session Hanlder
Class Phpfox_Session_Handler_Memcache
Phpfox_Session_Handler_Memcache in memcache.class.php
Memcached Session Handler
Class Phpfox_Session_Storage_Cookie
Phpfox_Session_Storage_Cookie in cookie.class.php
Cookie Storage Store information about the user using $_COOKIE.
Class Phpfox_Session_Storage_Session
Phpfox_Session_Storage_Session in session.class.php
Session Storage Store information about the users using PHP sessions.
Class Phpfox_Setting
Phpfox_Setting in setting.class.php
Global Site Settings
Class Phpfox_Spam
Phpfox_Spam in spam.class.php
SPAM/Flood Control Class Handles global SPAM & Flood control checks with support for plugins.
Class Phpfox_Spam_Hash
Phpfox_Spam_Hash in hash.class.php
SPAM Hash Check Checks content being added to the site and looks over if it has been added in the past.
Class Phpfox_Template
Phpfox_Template in template.class.php
Template Loads all templates and converts it into PHP code and then caches it.
Class Phpfox_Url
Phpfox_Url in url.class.php
URL Class is used to build the URL structure of the site.
Class Phpfox_Validator
Phpfox_Validator in validator.class.php
Validatior Used for site wide validation of POST forms. Includes the feature to validate forms using JavaScript and PHP as a failsafe.
Class Phpfox_Xml_Builder
Phpfox_Xml_Builder in builder.class.php
XML Builder Class is used to create and build XML files.
Class Phpfox_Xml_Parser
Phpfox_Xml_Parser in parser.class.php
XML Parser Class is used to convert an XML STRING into a ARRAY.
Method prepare
Prepare text strings. Used to prepare all data that can contain HTML. Not only does it protect against harmful HTML and CSS, it also has support for emoticon and BBCode conversion.
Method prepareSchema
Prepares SQL code to be transformed into PHP logic to later be used during an upgrade of the script.
Method prepareTitle
Preparing a URL title. Will be used to replace a title "this is a TITLE" to "this-is-a-title".
Method preParse
Phpfox_Service::preParse() in service.class.php
Extends the pre-parsing object.
Method preParse
Run the first round of parsing of CODE related BBCode since we need to save them in memory.
Method prepend
Phpfox_Ajax::prepend() in ajax.class.php
jQuery has support for prepend() and we use that method, however we add a little extra protection with our routine.
Method process
Phpfox_Validator::process() in validator.class.php
Process a form and perform regex checks on all the values.
Method process
Phpfox_Ajax::process() in ajax.class.php
Process the AJAX request
Method process
Process data from a form a end-user posted and prepare it to be used when inserting/updating records
Method process
Process an array of SQL logic and transform it into SQL code that can be executed.
Method process
Run sanity checks on a CSS property and value to make sure they are valid.
Method process
Method processAlter
During each upgrade of the product we run this method to check if any new fields need to be update or updated.
Class Constant PRODUCT_BUILD
Phpfox::PRODUCT_BUILD in phpfox.class.php
Product build number.
Method put
Phpfox_Ftp::put() in ftp.class.php
Uploads a file from your computer to the server.
Method put
Uploads the file to amazons server.
Method parse
Parse a templates content and convert it into PHP.
Class Phpfox_Template_Cache
Phpfox_Template_Cache in cache.class.php
Template Cache Class handles the caching of a template file and converts any custom code into PHP code. Class is only loaded if the template cache file does not exist.
q
Method query
Database_Driver_Postgres::query() in postgres.class.php
Performs sql query with error reporting and logging.
Method query
Performs sql query with error reporting and logging.
Method query
Performs sql query with error reporting and logging.
Method query
Performs sql query with error reporting and logging.
Method query
Performs sql query with error reporting and logging.
Method query
Phpfox_Database_Interface::query() in interface.class.php
Performs sql query with error reporting and logging.
r
Page request.class.php
request.class.php in request.class.php
Method read
Read a session file.
Method read
Read a session file.
Method rebuildMenu
Phpfox_Template::rebuildMenu() in template.class.php
Rebuild a cached menu.
Method remove
Removes cache file(s).
Method remove
Removes cache file(s).
Method remove
Removes a session.
Method remove
Removes a session.
Method removeComments
Remove any SQL comments from the output
Method removeEvilAttributes
Removes evit attributes within HTML.
Method removeInfo
Removes information from the database that the cache file is not cached any longer.
Method removeRemarks
Remove any SQL remarks from the output
Method removeStatic
Removes a static javascript or css file.
Method removeUrl
Phpfox_Template::removeUrl() in template.class.php
Remove a URL from a built cached menu.
Method rename
Phpfox_File::rename() in file.class.php
Renames a file
Method repairTable
Repairs a table
Method request
Phpfox_Component::request() in component.class.php
Extends the request class and returns its class object.
Method reset
Phpfox_Debug::reset() in debug.class.php
Reset a debug test for a specific routine
Method reset
Phpfox_Error::reset() in error.class.php
Reset the error messages. We do this automatically at the end of the entire routine to display a page, however if you need to reset it earlier it can be done with this method.
Method reversePrepare
Reverse prepares strings based on what we converted with the method prepare().
Method rmdir
Phpfox_Ftp::rmdir() in ftp.class.php
Removes a directory from the FTP server
Method rotate
Rotate an image (left or right)
Method run
Phpfox::run() in phpfox.class.php
Starts the phpFox engine. Used to get and display the pages controller.
Method remove
Remove a cache file or the entire directory.
s
Variable $sDisplayLayout
Phpfox_Template::$sDisplayLayout in template.class.php
Default template name.
Variable $sFormName
Phpfox_Validator::$sFormName in validator.class.php
Name of the curremt HTML form.
Variable $sLeftDelim
Phpfox_Template::$sLeftDelim in template.class.php
Left delimiter for custom functions. It is: {
Variable $sReservedVarname
Reserved variable name. Which is $phpfox.
Variable $sRightDelim
Phpfox_Template::$sRightDelim in template.class.php
Right delimiter for custom functions. It is: }
Variable $sSlaveServer
Variable $sSlaveServer
Variable $sSlaveServer
IP/Host of the slave server we are currently using.
Variable $sSlaveServer
Variable $sSlaveServer
Page support.class.php
support.class.php in support.class.php
Page s3.class.php
s3.class.php in s3.class.php
Page sqlite.class.php
sqlite.class.php in sqlite.class.php
Page support.class.php
support.class.php in support.class.php
Page smtp.class.php
smtp.class.php in smtp.class.php
Page service.class.php
service.class.php in service.class.php
Page search.class.php
search.class.php in search.class.php
Page server.class.php
server.class.php in server.class.php
Page session.class.php
session.class.php in session.class.php
Page session.class.php
session.class.php in session.class.php
Page setting.class.php
setting.class.php in setting.class.php
Page spam.class.php
spam.class.php in spam.class.php
Method save
Save data to the cache.
Method save
Save data to the cache.
Method saveInfo
Phpfox_Cache_Abstract::saveInfo() in abstract.class.php
Stores all the cache information in the database for stats.
Method search
Method search
MySQL has special search functions, so we try to use that here.
Method search
Method search
Method search
Phpfox_Search::search() in search.class.php
Build a search ARRAY based on the SQL driver.
Method search
Method select
Method select
Method select
Method select
Stores the SELECT part of a query
Method select
Method send
Phpfox_Url::send() in url.class.php
Send a user to a new page using the URL method we use.
Method send
Phpfox_Mail_Interface::send() in interface.class.php
Sends out an email.
Method send
Phpfox_Mail::send() in mail.class.php
Method to send out the email.
Method send
Sends out an email.
Method send
Phpfox_Request::send() in request.class.php
Send a request to another server. Usually using CURL.
Method send
Phpfox_Api::send() in api.class.php
Send a request to our API server.
Method send
Sends out an email.
Method sendToSelf
Phpfox_Mail::sendToSelf() in mail.class.php
Send a copy to our own email.
Method set
Phpfox_Plugin::set() in plugin.class.php
Build and cache all the plug-ins for future use.
Method set
Set the settings to be used with this class and prepare them so they are in an array
Method set
Phpfox_Pager::set() in pager.class.php
Set all variables and build the pagination enviroment for this specific page.
Method set
Phpfox_Request::set() in request.class.php
Set a request manually.
Method set
Phpfox_Search::set() in search.class.php
Build the search form.
Method set
Sets a session.
Method set
Phpfox_Setting::set() in setting.class.php
Build the setting cache by getting all the settings from the database and then caching it. This way we only load it from the database the one time.
Method set
Set the settings to be used with this class and prepare them so they are in an array
Method set
Phpfox_Gateway_Interface::set() in interface.class.php
Set the settings to be used with this class and prepare them so they are in an array
Method set
Phpfox_Error::set() in error.class.php
Set an error message that can be displayed at a later time
Method set
Phpfox_Cache_Interface::set() in interface.class.php
Sets the name of the cache.
Method set
Phpfox_Ajax::set() in ajax.class.php
Manually set $_POST information if it was not sent via an AJAX request
Method set
Sets the name of the cache.
Method set
Phpfox_Validator::set() in validator.class.php
Build a form validation check.
Method set
Phpfox_Archive_Import::set() in import.class.php
Method set
Phpfox_Archive_Export::set() in export.class.php
Set all the support archives you want to allow the user to download the data
Method set
Sets the name of the cache.
Method set
Sets a session.
Method setArray
Set an ARRAY session.
Method setArray
Set an ARRAY session.
Method setBreadCrumb
Phpfox_Template::setBreadCrumb() in template.class.php
Sets the breadcrumb structure for the site.
Method setCache
Phpfox_Locale::setCache() in locale.class.php
Sets the cache ID when caching phrases for a specific page.
Method setCacheBlockData
Sets the cache blocks data.
Method setCondition
Phpfox_Search::setCondition() in search.class.php
Set an SQL condition.
Method setController
Phpfox_Module::setController() in module.class.php
Sets the controller for the page we are on. This method controlls what component to load, which will be used to display the content on that page.
Method setCookie
Phpfox::setCookie() in phpfox.class.php
Set a cookie with PHP setcookie()
Method setDisplay
Phpfox_Error::setDisplay() in error.class.php
Sets the display status of error reporting.
Method setEditor
Phpfox_Template::setEditor() in template.class.php
Set settings for the text editor in use.
Method setEmbedParser
Set video embed settings.
Method setFullSite
Phpfox_Template::setFullSite() in template.class.php
Force the page to use its full width and not display anything within the sidepanel.
Method setHash
Phpfox_Hash::setHash() in hash.class.php
Creates an MD5 hash with the password itself wrapped in MD5 as well as support for a random salt that is also wrapped in MD5
Method setHeader
Phpfox_Template::setHeader() in template.class.php
All data placed between the HTML tags <head></head> can be added with this method.
Method setImage
Phpfox_Template::setImage() in template.class.php
Sets all the images we plan on using within JavaScript.
Method setImageParser
Set image parser settings.
Method setLayout
Phpfox_Template::setLayout() in template.class.php
Override the layout of the site.
Method setMessage
Phpfox_Ajax::setMessage() in ajax.class.php
Sets a public message on the site for the user to see and closes the AJAX popup box for you.
Method setMeta
Phpfox_Template::setMeta() in template.class.php
Set all the meta tags to be used on the site.
Method setMobileHeader
All data placed between the HTML tags <head></head> can be added with this method for mobile devices.
Method setNoTemplate
Phpfox_Module::setNoTemplate() in module.class.php
Identify that the controller we are loading is not to load its template.
Method setParam
Phpfox_Component::setParam() in component.class.php
Set a param that can be used in other component so we don't pass information via get/post requests.
Method setParam
Phpfox_Setting::setParam() in setting.class.php
Creates a new setting.
Method setParam
Phpfox_Url::setParam() in url.class.php
Set a request.
Method setPhrase
Phpfox_Template::setPhrase() in template.class.php
Sets phrases we can later use in JavaScript.
Method setRandomHash
Creates a random hash for a password that needs to be set in a public state, usually a session or a cookie
Method setRequests
Phpfox_Search::setRequests() in search.class.php
Force to set search requests.
Method setSort
Phpfox_Search::setSort() in search.class.php
Set the sorting order of the search.
Method setStyle
Phpfox_Template::setStyle() in template.class.php
Override the current theme.
Method setTemplate
Phpfox_Template::setTemplate() in template.class.php
Set the current template for the site.
Method setTitle
Phpfox_Template::setTitle() in template.class.php
Set the page title in a public array so we can get it later and display within the template.
Method setUrl
Phpfox_Template::setUrl() in template.class.php
Set the current URL for the site.
Method setXml
Phpfox_Xml_Builder::setXml() in builder.class.php
Set XML settings.
Method shorten
Phpfox_Parse_Output::shorten() in output.class.php
Method shorten
Phpfox_Search::shorten() in search.class.php
Shorten a search result.
Method skip
Phpfox_Error::skip() in error.class.php
If debug mode is enabled and you want to make sure to skip error reporting
Method skipClose
By default we always close a cache call automatically, however at times you may need to close it at a later time and setting this to true will skip closing the closing of the cache reference.
Method skipClose
By default we always close a cache call automatically, however at times you may need to close it at a later time and setting this to true will skip closing the closing of the cache reference.
Method split
Phpfox_Parse_Output::split() in output.class.php
Split a string at a specified location. This allows for browsers to automatically add breaks or wrap long text strings.
Method splitSqlFile
Split an SQL schema or string based on the delimiter used by the specific database driver.
Method sqlReport
Method sqlReport
Method sqlReport
Method sqlReport
During development you may need to check how your queries are being executed and how long they are taking. This routine uses MySQL's EXPLAIN to return useful information.
Method sqlReport
Method start
Phpfox_Debug::start() in debug.class.php
Starts a debug test on a specific routine
Method startLog
Phpfox::startLog() in phpfox.class.php
Start a new log.
Method stripCode
Removes any BBCode and any content found within a BBCode call.
Method stripInnerHtml
Removes HTML found within HTML.
Method subject
Phpfox_Mail::subject() in mail.class.php
Subject of the email.
t
Variable $thumbLargeThenPic
Check to identify if a thumnail is larger then the actual image being uploaded
Page tar.class.php
tar.class.php in tar.class.php
Page template.class.php
template.class.php in template.class.php
Method tableExists
Checks if a database table exists.
Method template
Phpfox_Component::template() in component.class.php
Extends the template class and returns its class object.
Method template
Phpfox_Ajax::template() in ajax.class.php
Extend template
Method test
Test if the server has support for working with tar.gz files
Method test
Run a test to make sure the admin provides the correct SMTP information.
Method test
Phpfox_Mail::test() in mail.class.php
Run a test if we are able to send out an email using the default method being loaded.
Method test
Test if the server has support for working with tar.gz files
Method test
Phpfox_Ftp::test() in ftp.class.php
Tests the current directory if this is where phpFox is installed.
Method test
Method testStyle
Phpfox_Template::testStyle() in template.class.php
Test a style by attempting to load and display it for the user.
Method to
Phpfox_Mail::to() in mail.class.php
Identify who this email will be sent to. Can be an actual email or a user ID or an array of emails or user IDs.
Method translate
Phpfox_Locale::translate() in locale.class.php
Translates a phrase from one language to another, if the translation exists; otherwise we return the default phrase.
Method trigger
Phpfox_Error::trigger() in error.class.php
Display a warning or error message
u
Page url.class.php
url.class.php in url.class.php
Method unhtmlspecialchars
Converting PHP htmlspecialchars()
Method unlink
Phpfox_File::unlink() in file.class.php
Delete a file from the server.
Method unlink
Phpfox_Ftp::unlink() in ftp.class.php
Deletes a file on the FTP server
Method unlock
Phpfox_Cache_Abstract::unlock() in abstract.class.php
Unlock the cache system.
Method update
Performs update of rows.
Method update
Performs update of rows.
Method update
Performs update of rows.
Method update
Performs update of rows.
Method updateCount
This in practice works similar to our previous method self::updateCounter(), however instead of increasing or decreasing a field it checks the table to see how many rows there are and updates the static field with that count. This is usually only used in the AdminCP to fix broken counters.
Method updateCounter
Updates a int field in the database to increase or decrease its count.
Method upload
Phpfox_File::upload() in file.class.php
Method is named "upload", however due to how PHP works the file has already been uploaded and this simply moves the uploaded file to the final location since it passed all the tests done by the load() method.
Method url
Phpfox_Gateway::url() in gateway.class.php
Creates the API callback URL for a specific gateway.
Method url
Phpfox_Component::url() in component.class.php
Extends the url class and returns its class object.
Method useVideoImage
Identify if we should use the videos image instead of loading the actual video when replacing the video BBCode.
v
Page validator.class.php
validator.class.php in validator.class.php
Method validator
Phpfox_Service::validator() in service.class.php
Extends the validation/sanity check object.
Method validXhtml
Uses the class DOMDocument to clean HTML and make it valid XHTML.
Method verify
Phpfox_Diff_Md5::verify() in md5.class.php
Checks if there are any modified files in the product.
Method verify
Phpfox_Validator::verify() in validator.class.php
Verify a regex pattern against a string value.
Class Constant VERSION
Phpfox::VERSION in phpfox.class.php
Product Version : major.minor.maintenance [alphaX, betaX or rcX]
w
Page wiki.class.php
wiki.class.php in wiki.class.php
Method where
Method where
Stores the WHERE part of a query
Method where
Method where
Method where
Database_Driver_Postgres::where() in postgres.class.php
Method write
Write to session file.
Method write
Write to session file.
Method write
Phpfox_File::write() in file.class.php
Writes to a file on the server. Always removes files if it exists.
Method writeToCache
Phpfox_File::writeToCache() in file.class.php
Writes to a cache file. Overwrites old files and if it does not exist it creates a new one.
x
Page xml.class.php
xml.class.php in xml.class.php
z
Page zip.class.php
zip.class.php in zip.class.php
2
Page 2checkout.class.php
2checkout.class.php in 2checkout.class.php
2 a b c d e f g h i j l m n o p q r s t u v w x z _