settings.inc

Go to the documentation of this file.

<?php
/**************************************************************
 
 Copyright (c) 2010 Sonjara, Inc
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation
 files (the "Software"), to deal in the Software without
 restriction, including without limitation the rights to use,
 copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the
 Software is furnished to do so, subject to the following
 conditions:
 
 The above copyright notice and this permission notice shall be
 included in all copies or substantial portions of the Software.
 
 Except as contained in this notice, the name(s) of the above 
 copyright holders shall not be used in advertising or otherwise 
 to promote the sale, use or other dealings in this Software 
 without prior written authorization.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 OTHER DEALINGS IN THE SOFTWARE.
 
*****************************************************************/
 
Fakoli::usingFeature("cache", "field_renderers");
 
class Settings extends DataItem
{
     var $primary_key = "settings_id";
     var  $table = "settings";
     
     // Fields
     var $fields = array("settings_id"  =>   Number,
                              "component"         =>   String,
                              "category"          =>   String,
                              "name"              =>   String,
                              "annotation"   =>   Text,
                              "options"      =>   Text,
                              "value"             =>   String,
                              "field_type"   =>   String,
                              "weight"       =>   Number
                         );
     
     // relationships
     var $relations = array();
     
     static $fieldTypes = array(
                    "String"  =>   "String",
                    "Number"  =>   "Number",
                    "Boolean" =>   "Boolean",
                    "Date"         =>   "Date",
                    "Currency"     =>   "Currency",
                    "Text"         =>   "Text"
     ); 
     
     function save()
     {
          Cache::invalidate("setting_{$this->component}_{$this->name}");
          parent::save();
     }
     
     static function getSetting($component, $name)
     {
          try
          {
               $setting = Query::create(Settings, "WHERE component=:component AND name=:name")
                                   ->bind(":component", $component, ":name", $name)
                                   ->executeSingle();
               Cache::put("setting_{$component}_{$name}", $setting->value);
               return $setting;
          }
          catch(DataNotFoundException $e)
          {
               return null;
          }         
     }
     
     static function getValue($component, $name)
     {
          $value = Cache::get("setting_{$component}_{$name}");
          if ($value !== null) return $value;
          
          try 
          {
               $setting = Query::create(Settings, "WHERE component=:c and name=:n")
                              ->filter(new InclusionFilter("value"))
                             ->bind(":c", $component, ":n", $name)
                              ->executeSingle();
               Cache::put("setting_{$component}_{$name}", $setting->value);
               return $setting->value;
          }
          catch (DataNotFoundException $e) 
          {
               trace("Setting not found for $component $name", 3);
               return null;
          }
     }
     
     static function setValue($component, $name, $value, $field_type, $annotation = "", $category = "", $options = "", $weight = 0)
     {
          $setting = Settings::getSetting($component, $name);
          if (!$setting)
          {
               $setting = new Settings();
               $setting->component = $component;
               $setting->name = $name;
               $setting->field_type = $field_type;
               $setting->annotation = $annotation;
               $setting->options = $options;
               $setting->category = $category;
               $setting->weight = $weight;
          }
          
          $setting->value = $value;
          $setting->save();
          Cache::put("setting_{$component}_{$name}", $setting->value);
     }
     
     static function setDefaultValue($component, $name, $value, $field_type = "String", $annotation = "", $category = "", $options = "", $weight = 0)
     {
          $setting = Settings::getSetting($component, $name);
          if ($setting) 
          {
               $setting->annotation = $annotation;
               $setting->category = $category;
               $setting->options = $options;
               $setting->weight = $weight;
               $setting->save();
               return;
          }
          
          Settings::setValue($component, $name, $value, $field_type, $annotation, $category, $options, $weight);
     }
     
     static function deleteValue($component, $name)
     {
          $settings = Query::create(Settings, "WHERE component=:c and name=:n")
                               ->bind(":c", $component, ":n", $name)
                               ->execute();
          
          foreach($settings as $s)
          {
               $s->delete();
          }
          
          Cache::invalidate("setting_{$component}_{$name}");
     }
     
     static function setPermission($component, $name, $annotation, $value, $weight)
     {
          Settings::setValue($component, $name, $value, "String", $annotation, "Permissions", "Permissions", $weight = 0);        
     }
     
     static function setDefaultPermission($component, $name, $annotation, $value, $weight = 0)
     {
          Settings::setDefaultValue($component, $name, $value, "String", $annotation, "Permissions", "Permissions", $weight);          
     } 
     
     static function checkPermission($component, $name, $account = null)
     {
          $roles = Settings::getValue($component, $name);
          
          return checkRole($roles, $account);
     }
     
     static function assertPermission($component, $name, $redirect = "", $message = "")
     {
          $roles = Settings::getValue($component, $name);
          
          Fakoli::assertRole($roles, $redirect, $message);
     }
 
     static function checkPermissions($permissions, $account = null)
     {
          if ($permissions == "") return true;
          
          $perms = explode(",", $permissions);
          
          foreach($perms as $perm)
          {
               list($component, $permission) = explode(":", $perm);
               if (Settings::checkPermission($component, $permission, $account)) return true;
          }
     
          return false;
     }
 
     static function deletePermission($component, $name)
     {
          Settings::deleteValue($component, $name);
          ComponentManager::fireEvent('PermissionDeleted', "{$component}:{$name}");
     }
     
     function permitsRole($role)
     {
          if (!$role)
          {
               throw new FakoliException("Missing role");
          }
          
          if ($this->options != 'Permissions')
          {
               throw new FakoliException("Role check on non-permissions settings");
          }
          
          $expr = "/\\b{$role}\\b/";
          return (preg_match($expr, $this->value) > 0) ? true : false;
     }
     
     function formatOptionList()
     {
          if(!$this->options)
               return null;
               
          $options = explode("\n", $this->options);
          
          $optionList = array();
          foreach($options as $option)
          {
               if (strpos($option, "=>") !== false)
               {
                    list($val, $text) = explode("=>", $option);
                    $val = trim($val);
                    $text = trim($text);
                    $optionList[$val] = $text;
               }
               else
               {
                    $optionList[$option] = $option;
               }
          }
          
          return $optionList;
     }
     
     static function getComponents()
     {
          return Query::create(Component, "WHERE name in (SELECT DISTINCT component FROM settings) ORDER BY name")->execute();
     }
 
     static function createPermissionsFieldRenderer($form, $field, $label = "")
     {
          $permissions = Query::create(Settings, "WHERE category='Permissions' ORDER BY component, annotation")->execute();
          
          if (count($permissions) == 0) 
          {
               $form->hide($field);               
               return null;
          }
          
          $options = array();
          
          foreach($permissions as $p)
          {
               $c = prettify($p->component);
               
               if (!array_key_exists($c, $options)) $options[$c] = array();
               $options[$c]["{$p->component}:{$p->name}"] = $p->annotation;
          }
          
          $renderer = new CheckListFieldRenderer($form, $field, $label, $options, true);
          $renderer->setSize(400, 150);
          return $renderer;             
     }
}
 
 
class ComponentSettings extends DataItem
{
     var $fields = array();
 
     var $primary_key = "settings_id";
     var $table = "settings"; 
}
?>