SettingAutoForm Class Reference

Inheritance diagram for SettingAutoForm:

Public Member Functions
	SettingAutoForm ($component, $filter=null)
	buildForm ($component_id=0)
	writeSettings ($settings)
	save ()

Public Attributes
	$settings
	$customSettings = array()
	$filter = null

Detailed Description

Definition at line 41 of file setting_auto_form.inc.

Member Function Documentation

buildForm()

SettingAutoForm::buildForm

(

$component_id = 0

)

Definition at line 62 of file setting_auto_form.inc.

     {
          $componentSettings = new ComponentSettings();
 
          $fields = array();
          
          foreach($this->settings as $setting)
          {
               if ($this->filter && $this->filter->isExcluded($setting->name)) continue;
               
               $fields[$setting->name] = ($setting->field_type) ? $setting->field_type : "String";
               if ($setting->weight < 0) $this->hide($setting->name);
               if ($setting->category) $this->group($setting->category, $setting->name);
          
          }
 
          $componentSettings->fields = $fields;
          parent::AutoForm($componentSettings, "POST", "?component_id={$component_id}");
 
          foreach($this->settings as $setting)
          {
               if ($this->filter && $this->filter->isExcluded($setting->name)) continue;
               
               $this->data->set($setting->name, $setting->value);
               if($setting->annotation)
                    $this->annotate($setting->name, $setting->annotation);
 
               /*
                * Create custom renderers. If option is not
                * a custom renderer name, then assume it is
                * a set of options for SelectFieldRenderer.
               */
               if($setting->options == "FileUploadFieldRenderer")
               {
                    $renderers[$setting->settings_id] = new FileUploadFieldRenderer($this, $setting->name, prettify($setting->name), uploadSettingFile);
                    $this->annotate($setting->name, "<a href='/action/settings/download?setting_id={$setting->settings_id}'>{$setting->value}</a>");
                    
               }
               else if ($setting->options == "Permissions")
               {
                    $renderer = new ChecklistFieldRenderer($this, $setting->name, $setting->annotation ? $setting->annotation : prettify($setting->name), SiteRole::getRolesArray());
                    if ($setting->annotation) $this->annotate($setting->name, "");
                    $renderer->dropdown = true;
                    $renderer->setSize(200, 100);
                    $renderer->dropdownMaxWidth = 500;
                    $renderer->dropdownMessage = "Select User Roles";
               }              
               else if($setting->options)
               {
                    $optionList = $setting->formatOptionList();
                    if(isset($optionList))
                         $renderers[$setting->settings_id] = new SelectFieldRenderer($this, $setting->name, prettify($setting->name), $optionList);
               }
          }
 
          $extension = SettingsManager::getExtension($this->component->name);
          if ($extension)
          {
               call_user_func($extension, $this);
          }
          
          $this->submitLabel = "Save Changes";                        
     }

save()

SettingAutoForm::save

(

)

Definition at line 144 of file setting_auto_form.inc.

     {
          $this->patchUpReferences();
 
          $this->configureValidators();
 
          $obj =& $this->data;
          $obj->fromPOST();
          
          if (isset($_POST["#FORMID#"]))
          {
               $this->id = $_POST["#FORMID#"];
          }
 
          $this->msg = $this->validator->validate();
          if ($this->msg != "") return false;
 
          $this->preProcessFields($pk, $filter);
     
          $indexedSettings = reindexList($this->settings, "name");
          
          foreach($obj->getFields() as $name => $type)
          {
               if(array_key_exists($name, $indexedSettings))
               {
                    $setting = $indexedSettings[$name];
                    $setting->value = $obj->$name;
                    $setting->filter = new InclusionFilter("value");
                    $setting->save();
                    Cache::put("setting_{$setting->component}_{$setting->name}", $setting->value);
                    
               }
          }
          Cache::invalidate("auto_form_defaults");
          Cache::invalidate("config");
          
          // onComplete event is fired once all processing has been completed
 
          if ($this->onSaveComplete)
          {
               call_user_func_array($this->onSaveComplete, array($this));
          }
          
          trace("Settings auto form returning true", 3);
          
          ComponentManager::fireEventTo($this->component->name, "ClearCache");
          
          return true;
     }

SettingAutoForm()

SettingAutoForm::SettingAutoForm	(		$component,
			$filter = null
	)

Definition at line 46 of file setting_auto_form.inc.

     {
          $this->filter = $filter;
          
          ComponentManager::fireEvent("RegisterSettingsFormExtension");
          
          $this->component = $component;
          
          $this->settings = Query::create(Settings, "WHERE component=:component ORDER BY category, weight, name")
                    ->bind(":component", $component->name)
                    ->execute();
 
          $this->buildForm($component->component_id);
          
     }

writeSettings()

SettingAutoForm::writeSettings

(

$settings

)

Definition at line 126 of file setting_auto_form.inc.

     {
          foreach($settings as $setting)
          {
               if(array_key_exists($setting->field_type, Settings::$customTypes))
               {
                    $type = Settings::$customTypes[$setting->field_type];
                    $customSettings[] = $setting;
               }
               else
                    $type = ($setting->field_type) ? $setting->field_type : "String";
                    
               $fields[$setting->name] = $type;
          }
          
          return $fields;
     }

Member Data Documentation

$customSettings

SettingAutoForm::$customSettings = array()

Definition at line 44 of file setting_auto_form.inc.

$filter

SettingAutoForm::$filter = null

Definition at line 45 of file setting_auto_form.inc.

$settings

SettingAutoForm::$settings

Definition at line 43 of file setting_auto_form.inc.

---

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

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