SettingsManager Class Reference

Public Member Functions
	SettingsManager ()

Static Public Member Functions
static	registerExtension ($component, $handler)
static	getExtension ($component)
static	setDefaults ()
static	configurationBootstrap ()
	Sets the Fakoli framework configuration variables according to the settings stored in the database. More...
static	getSubTabs ($component)
static	upgradeComponent ($version)
static	registerSerializationHandler ()

Static Public Attributes
static	$extensionMap = array()

Detailed Description

Definition at line 59 of file settings_manager.inc.

Member Function Documentation

configurationBootstrap()

static SettingsManager::configurationBootstrap ( )

static

Sets the Fakoli framework configuration variables according to the settings stored in the database.

If a configuration variable already has a value (i.e. manually specified in the config.inc file) then the value is not overwritten.

The goal of this function is to aid with the migration of application-specific settings out of configuration files and into the application settings in the database.

Definition at line 152 of file settings_manager.inc.

     {
          global $auto_form_defaults;
          global $fontawesome;
          
          $afDefaults = Cache::get("auto_form_defaults");
          if (!$afDefaults)
          {
               $afDefaults = array();
               $autoFormSettings = Query::create(Settings, "WHERE component='settings' AND category='AutoForm'")
                                              ->filter(new InclusionFilter("name", "value"))
                                              ->execute();
               
               foreach($autoFormSettings as $setting)
               {
                    $afDefaults[$setting->name] = $setting->value;
               }
               
               Cache::put("auto_form_defaults", $afDefaults);
          }
          
          foreach($afDefaults as $name => $value)
          {
               if (!isset($auto_form_defaults[$name])) $auto_form_defaults[$name] = $value;
          }
          
          $fontawesomeURL = Cache::get("font_awesome_URL");
          if (!$fontawesomeURL)
          {
               $fontawesomeURL = Settings::getValue("settings", "font_awesome_URL");
               if (!$fontawesomeURL) $fontawesomeURL = $fontawesome;
               Cache::put("font_awesome_URL", $fontawesomeURL);
          }
          
          $fontawesome = $fontawesomeURL;
     }

getExtension()

static SettingsManager::getExtension (   $component )

static

Definition at line 68 of file settings_manager.inc.

     {
          return isset(SettingsManager::$extensionMap[$component]) ? SettingsManager::$extensionMap[$component] : null;
     }

getSubTabs()

static SettingsManager::getSubTabs (   $component )

static

Definition at line 189 of file settings_manager.inc.

     {
          $tabs = null;
          $settingCategories = array();
          
          $categories = Query::create(Settings, "WHERE component = :component && (category != '' OR category != null)")
               ->bind("component", $component->name)
               ->execute();
               
          if(count($categories) > 0)
          {
               $categories = removeDuplicates($categories, "category");
               if(count($categories) > 1)
               {
                    $idx = 1;
                    foreach($categories as $category)
                    {
                         $settingCategory = new SettingsCategory();
                         $settingCategory->component_id = $component->component_id;
                         $settingCategory->category_id = $idx;
                         $settingCategory->component = $component->name;
                         $settingCategory->category = $category->category;
                         $settingCategories[] = $settingCategory;
                         $idx++;
                    }
 
                    $tabs = new DataItemTabBar("subtabs", $settingCategories);
               }
          }    
          return $tabs;
     }

registerExtension()

static SettingsManager::registerExtension (   $component,   $handler  )

static

Definition at line 63 of file settings_manager.inc.

     {
          SettingsManager::$extensionMap[$component] = $handler;
     }

registerSerializationHandler()

static SettingsManager::registerSerializationHandler ( )

static

Definition at line 227 of file settings_manager.inc.

     {
          SerializationManager::registerHandler("settings", "Settings and Permissions", new SettingsSerializationHandler());
          return true;
     }         

setDefaults()

static SettingsManager::setDefaults ( )

static

Definition at line 95 of file settings_manager.inc.

     {
          trace("SettingsManager::setDefaults", 3);
          
          global $config;
          
          preg_match_all("/([\\w\\d_]+)\.?([^}]*)/", $config["http_host"], $matches, PREG_SET_ORDER);
          if(count($matches) > 0)
          {
               $matches = $matches[0];
               if(count($matches) > 1)
               {
                    $path = $matches[1];
                    $sitename = prettify($path);
               }
          }
 
          Settings::setDefaultValue("settings", "prettyUrls", true, "Boolean", "Whether urls are translated to CMS identifiers", "General");          
          Settings::setDefaultValue("settings", "allow_pdf_download", true, "Boolean", "", "General");
          Settings::setDefaultValue("settings", "sitename", $sitename, "String", "", "General");
          Settings::setDefaultValue("settings", "wrap_modules", true, Boolean, "Specifies whether to wrap module output in a div tag, or render them bare", "General");
          Settings::setDefaultValue("settings", "system_notification_email", $config["email_contact"], String, "The email address to which system notifications should be sent", "General");
          Settings::setDefaultValue("settings", "local_IP_address", "", String, "Specifies the server's local IP address for environments (such as Microsoft Azure) where this cannot be determined automatically", "General");
          
          Settings::setDefaultValue("settings", "formCSS", "form", "String", "", "AutoForm");
          Settings::setDefaultValue("settings", "labelCSS", "label", "String", "", "AutoForm");
          Settings::setDefaultValue("settings", "valueCSS", "value", "String", "", "AutoForm");
          Settings::setDefaultValue("settings", "buttonCSS", "button", "String", "", "AutoForm");
          Settings::setDefaultValue("settings", "buttonAlignment", "left", "String", "", "AutoForm");
          Settings::setDefaultValue("settings", "buttonLineCSS", "submit", "String", "", "AutoForm");
          
          Settings::setDefaultValue("settings", "componentPath", "/fakoli", "String", "", "AutoForm");
          Settings::setDefaultValue("settings", "HTMLEditorHideStyleBar", true, "Boolean", "", "AutoForm");
          Settings::setDefaultValue("settings", "HTMLEditorDefaultWidth", "540px", "String", "", "AutoForm");
          Settings::setDefaultValue("settings", "HTMLEditorDefaultHeight", "200px", "String", "", "AutoForm");
          Settings::setDefaultValue("settings", "javascriptEnabled", true, "Boolean", "", "AutoForm");
          Settings::setDefaultValue("settings", "markRequiredFields", true, "Boolean", "", "AutoForm");
          Settings::setDefaultValue("settings", "onFormatLabel", "addContextHelp", "String", "Callback function for start of field label", "AutoForm");
          Settings::setDefaultValue("settings", "requiredFieldsText", "* indicates required field", "String", "", "AutoForm");
          Settings::setDefaultValue("settings", "passwordEnterLabel", "Enter", "String", "The text of the password entry field label", "AutoForm");
          Settings::setDefaultValue("settings", "passwordEnterLabel", "Confirm", "String", "The text of the password confirmation field label", "AutoForm");
          Settings::setDefaultValue("settings", "buttons_at_top", false, "Boolean", "Whether the form's save/cancel buttons appear at the top of the form in addition to the bottom.", "AutoForm");
          Settings::setDefaultValue("settings", "default_layout", "table", String, "Specifies the default layout manager to use when rendering forms", "AutoForm", "table\nsimple\nmobile");
          Settings::setDefaultValue("settings", "interstitialSpinner", "/fakoli/images/spinner.gif", String, "Specifies the default spinner animation to use with interstitials", "AutoForm");
 
          Settings::setDefaultValue("settings", "font_awesome_URL", "", 'String', "If you want to use a specific version of Font Awesome (for instance if you have a Pro subscription) enter the URL here", "Font Awesome");     
     }

SettingsManager()

SettingsManager::SettingsManager

(

)

Definition at line 73 of file settings_manager.inc.

     {
          
     }

upgradeComponent()

static SettingsManager::upgradeComponent (   $version )

static

Definition at line 221 of file settings_manager.inc.

     {
          $mgr = new SettingsUpgradeManager();
          $mgr->upgrade($version);
     }    

Member Data Documentation

$extensionMap

SettingsManager::$extensionMap = array()

static

Definition at line 61 of file settings_manager.inc.

---

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

• C:/code/cms.sonjara.com/cms/components/settings/settings_manager.inc