- Description
-
Class trees
Index of elements
Todo List
Interfaces
Phpfox_Cache_Interface- Phpfox_Database_Interface
- Phpfox_Gateway_Interface
- Phpfox_Image_Interface
- Phpfox_Mail_Interface
- Classes
Database_Driver_Mssql- Database_Driver_Oracle
- Database_Driver_Postgres
- Database_Driver_Sqlite
- Phpfox
- Phpfox_Ajax
- Phpfox_Api
- Phpfox_Archive
- Phpfox_Archive_Export
- Phpfox_Archive_Extension_Tar
- Phpfox_Archive_Extension_Xml
- Phpfox_Archive_Extension_Zip
- Phpfox_Archive_Import
- Phpfox_Archive_Support
- Phpfox_Cache
Phpfox_Cache_Abstract- Phpfox_Cache_Storage_File
- Phpfox_Cache_Storage_Memcache
- Phpfox_Cdn
- Phpfox_Cdn_Abstract
- Phpfox_Cdn_Module_S3
- Phpfox_Component
- Phpfox_Cron
- Phpfox_Database
- Phpfox_Database_Dba
- Phpfox_Database_Driver_Mysql
- Phpfox_Database_Driver_Mysqli
- Phpfox_Database_Export
- Phpfox_Database_Support
- Phpfox_Date
- Phpfox_Debug
- Phpfox_Diff_Md5
- Phpfox_Editor
- Phpfox_Error
- Phpfox_File
- Phpfox_File_Minimize
- Phpfox_Ftp
- Phpfox_Gateway
- Phpfox_Gateway_Api_2checkout
- Phpfox_Gateway_Api_Paypal
- Phpfox_Hash
- Phpfox_Image
- Phpfox_Image_Abstract
- Phpfox_Image_Helper
- Phpfox_Image_Library_Gd
- Phpfox_Locale
- Phpfox_Mail
- Phpfox_Mail_Driver_Phpmailer_Mail
- Phpfox_Mail_Driver_Phpmailer_Smtp
- Phpfox_Module
- Phpfox_Pager
- Phpfox_Parse_Bbcode
- Phpfox_Parse_Css
- Phpfox_Parse_Format
- Phpfox_Parse_Input
- Phpfox_Parse_Output
- Phpfox_Parse_Wiki
- Phpfox_Plugin
- Phpfox_Process
- Phpfox_Request
- Phpfox_Search
- Phpfox_Search_Inline
- Phpfox_Server
- Phpfox_Service
- Phpfox_Session
- Phpfox_Session_Handler
- Phpfox_Session_Handler_Default
- Phpfox_Session_Handler_File
- Phpfox_Session_Handler_Memcache
- Phpfox_Session_Storage_Cookie
- Phpfox_Session_Storage_Session
- Phpfox_Setting
- Phpfox_Spam
- Phpfox_Spam_Hash
- Phpfox_Template
- Phpfox_Url
- Phpfox_Validator
- Phpfox_Xml_Builder
- Phpfox_Xml_Parser
Functions
d- e
- p
Files
2checkout.class.php- abstract.class.php
- abstract.class.php
- abstract.class.php
- ajax.class.php
- api.class.php
- archive.class.php
- bbcode.class.php
- builder.class.php
- cache.class.php
- cdn.class.php
- component.class.php
- cookie.class.php
- cron.class.php
- css.class.php
- database.class.php
- date.class.php
- dba.class.php
- debug.class.php
- default.class.php
- editor.class.php
- error.class.php
- export.class.php
- export.class.php
- file.class.php
- file.class.php
- file.class.php
- format.class.php
- ftp.class.php
- gateway.class.php
- gd.class.php
- handler.class.php
- hash.class.php
- hash.class.php
- helper.class.php
- image.class.php
- import.class.php
- inline.class.php
- input.class.php
- interface.class.php
- interface.class.php
- interface.class.php
- interface.class.php
- interface.class.php
- locale.class.php
- mail.class.php
- mail.class.php
- md5.class.php
- memcache.class.php
- memcache.class.php
- minimize.class.php
- module.class.php
- mssql.class.php
- mysql.class.php
- mysqli.class.php
- oracle.class.php
- output.class.php
- pager.class.php
- parser.class.php
- paypal.class.php
- phpfox.class.php
- plugin.class.php
- postgres.class.php
- process.class.php
- request.class.php
- s3.class.php
- search.class.php
- server.class.php
- service.class.php
- session.class.php
- session.class.php
- setting.class.php
- smtp.class.php
- spam.class.php
- sqlite.class.php
- support.class.php
- support.class.php
- tar.class.php
- template.class.php
- url.class.php
- validator.class.php
- wiki.class.php
- xml.class.php
- zip.class.php
Template-
- Classes
- Phpfox_Template_Cache
- Files
- cache.class.php
Phpfox_Setting
Description
Global Site Settings
Class is used to load and retrieve global settings, which are stored in the database table "setting". Admins can easily modify these settings direct from the AdminCP. The most common interaction with this class is to get a setting value and to do this we use our core static class.
Example:
Located in /include/library/phpfox/setting/setting.class.php (line 26)
Variable Summary
Method Summary
Variables
array
$_aDefaults
= array('core.session_prefix' => 'phpfox',
'core.title_delim' => '»',
'core.site_title' => 'phpFox',
'core.branding' => false,
'core.default_lang_id' => 'en',
'core.default_style_name' => 'konsort',
'core.default_theme_name' => 'default',
'language.lang_pack_helper' => false,
'core.cookie_path' => '/',
'core.cookie_domain' => '',
'core.use_gzip' => true,
'core.url_rewrite' => '2',
'core.is_installed' => false,
'user.profile_use_id' => false,
'user.disable_username_on_sign_up' => false,
'core.site_copyright' => '',
'db' => array(
'prefix' => 'phpfox_',
'host' => 'localhost',
'user' => '',
'pass' => '',
'name' => '',
'driver' => 'mysql',
'slave' => false
),'core.cache_skip'=>false,'balancer'=>array('enabled'=>false),'user.min_length_for_username'=>'5','user.max_length_for_username'=>'25','core.default_time_zone_offset'=>'0','core.identify_dst'=>'1','core.global_site_title'=>'phpFox') (line 42)
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.
array
$_aParams
= array() (line 33)
List of all the settings.
Methods
Constructor __construct (line 85)
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.
Phpfox_Setting
__construct
()
getParam (line 331)
Get a setting and its value.
nixed
getParam
(mixed $mVar, [string $sDef = ''])
- mixed $mVar: STRING name of the setting or ARRAY name of the setting.
- string $sDef: Default value in case the setting cannot be found.
isParam (line 361)
Checks to see if a setting exists or not.
bool
isParam
(string $mVar)
- string $mVar: Name of the setting.
set (line 175)
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.
void
set
()
setParam (line 161)
Creates a new setting.
void
setParam
(array $mParam, [string $mValue = null])
- array $mParam: ARRAY of settings and values.
- string $mValue: Value of setting if the 1st argument is a string.
Documentation generated on Tue, 28 Sep 2010 10:36:44 +0200 by phpDocumentor 1.4.0a2