Changeset 2566:9bf417837888 for inc/core/class.dc.settings.php

Timestamp:

11/17/13 20:25:53 (12 years ago)

Author:

franck <carnet.franck.paul@…>

Branch:

2.6

Children:

2567:6c11245cbf04, 2568:61c67a7d17fa

Message:

Add some people in CREDITS, remove trailing spaces and tabs.

File:

• inc/core/class.dc.settings.php (modified) (23 diffs)

inc/core/class.dc.settings.php

@@ -25 +25 @@
      protected $table;        ///< <b>string</b> Settings table name
      protected $blog_id;      ///< <b>string</b> Blog ID
-     
+
      protected $namespaces = array();        ///< <b>array</b> Associative namespaces array
-     
+
      protected $ns;           ///< <b>string</b> Current namespace
-     
+
      /**
      Object constructor. Retrieves blog settings and puts them in $namespaces
      array. Local (blog) settings have a highest priority than global settings.
-     
+
      @param    core      <b>dcCore</b>       dcCore object
      @param    blog_id   <b>string</b>       Blog ID
@@ -44 +44 @@
           $this->loadSettings();
      }
-     
-     /**
-     Retrieves all namespaces (and their settings) from database, with one query. 
+
+     /**
+     Retrieves all namespaces (and their settings) from database, with one query.
      */
      private function loadSettings()
@@ -61 +61 @@
                trigger_error(__('Unable to retrieve namespaces:').' '.$this->con->error(), E_USER_ERROR);
           }
-          
+
           /* Prevent empty tables (install phase, for instance) */
           if ($rs->isEmpty()) {
                return;
           }
-          
+
           do {
                $ns = trim($rs->f('setting_ns'));
@@ -77 +77 @@
           } while(!$rs->isStart());
      }
-          
-     
+
+
      /**
      Create a new namespace. If the namespace already exists, return it without modification.
-     
+
      @param    ns   <b>string</b>       Namespace name
      @return   <b>dcNamespace</b>  The namespace created
@@ -139 +139 @@
           return true;
      }
-     
+
      /**
      Returns full namespace with all settings pertaining to it.
-     
+
      @param    ns   <b>string</b>       Namespace name
      @return   <b>dcNamespace</b>
@@ -150 +150 @@
           return $this->namespaces[$ns];
      }
-     
+
      /**
      Magic __get method.
@@ -165 +165 @@
           return $this->get($n);
      }
-     
+
      /**
      Magic __set method.
@@ -174 +174 @@
           $this->set($n,$v);
      }
-     
+
      /**
      Returns $namespaces property content.
-     
+
      @return   <b>array</b>
      */
@@ -184 +184 @@
           return $this->namespaces;
      }
-     
-     /**
-     Raises a E_USER_NOTICE errror for deprecated functions. 
+
+     /**
+     Raises a E_USER_NOTICE errror for deprecated functions.
      This allows the developer to know he's been using deprecated functions.
-     
+
      @param    name <b>string</b>  Name of the deprecated function that was called.
      */
@@ -202 +202 @@
           }
      }
-     
+
      /**
      @deprecated Please set your settings via $core->blog->settings->{namespace}->{setting}
-     
+
      Sets a setting in $settings property. This sets the setting for script
      execution time only and if setting exists.
-     
+
      @param    n         <b>string</b>       Setting name
      @param    v         <b>mixed</b>        Setting value
@@ -217 +217 @@
           // a setting directly, without passing via a namespace.
           $this->raiseDeprecated('old_style_set');
-          
+
           if (!$this->ns) {
                throw new Exception(__('No namespace specified'));
           }
-          
+
           if (isset($this->namespaces[$this->ns]->$n)) {
                $this->namespaces[$this->ns]->$n['value'] = $v;
@@ -234 +234 @@
           }
      }
-     
+
      /**
      @deprecated Please access your settings via $core->blog->settings->{namespace}->...
-     
+
      Sets a working namespace. You should do this before accessing any setting.
-     
+
      @param    ns        <b>string</b>       Namespace name
      */
@@ -251 +251 @@
           }
      }
-     
+
      /**
      @deprecated Please set your settings via $core->blog->settings->{namespace}->put()
-     
+
      Creates or updates a setting.
-     
+
      $type could be 'string', 'integer', 'float', 'boolean' or null. If $type is
      null and setting exists, it will keep current setting type.
-     
+
      $value_change allow you to not change setting. Useful if you need to change
      a setting label or type and don't want to change its value.
-     
+
      Don't forget to set namespace before calling this method.
-     
+
      @param    id             <b>string</b>       Setting ID
      @param    value          <b>mixed</b>        Setting value
@@ -284 +284 @@
           $this->namespaces[$this->ns]->put($id, $value, $type, $label, $value_change, $global);
      }
-     
+
      /**
      @deprecated Please get your settings via $core->blog->settings->{namespace}->{setting}
-     
+
      Returns setting value if exists.
-     
+
      @param    n         <b>string</b>       Setting name
      @return   <b>mixed</b>
@@ -307 +307 @@
                }
           }
-          
+
           return null;
      }
-     
+
      /**
      @deprecated Please get your settings via $core->blog->settings->{namespace}->dumpSettings
-     
+
      Returns all settings content.
-     
+
      @return   <b>array</b>
      */
@@ -323 +323 @@
           // the settings directly, without passing via a namespace.
           $this->raiseDeprecated('dumpSettings');
-          
+
           $settings = array();
           // Parse all the namespaces
@@ -329 +329 @@
                $settings = array_merge($settings, $this->namespaces[$ns]->dumpSettings());
           }
-          
+
           return $settings;
      }
-     
+
      /**
      @deprecated Please get your settings via $core->blog->settings->{namespace}->dumpGlobalSettings
-     
+
      Returns all global settings content.
-     
+
      @return   <b>array</b>
      */
@@ -345 +345 @@
           // the settings directly, without passing via a namespace.
           $this->raiseDeprecated('dumpGlobalSettings');
-          
+
           $settings = array();
           // Parse all the namespaces
@@ -351 +351 @@
                $settings = array_merge($settings, $this->namespaces[$ns]->dumpGlobalSettings());
           }
-          
+
           return $settings;
      }
@@ -359 +359 @@
      <b>$params</b> is an array taking the following
      optionnal parameters:
-     
+
      - ns : retrieve setting from given namespace
      - id : retrieve only settings corresponding to the given id
-     
+
      @param    params         <b>array</b>        Parameters
-     @return   <b>record</b>  A record 
+     @return   <b>record</b>  A record
      */
      public function getGlobalSettings($params=array())
@@ -392 +392 @@
      /**
      Updates a setting from a given record
-     
+
      @param    rs        <b>record</b>       the setting to update
      */
-     public function updateSetting($rs) 
+     public function updateSetting($rs)
      {
           $cur = $this->con->openCursor($this->table);
@@ -411 +411 @@
           $cur->update($where."AND setting_id = '".$this->con->escape($cur->setting_id)."' AND setting_ns = '".$this->con->escape($cur->setting_ns)."' ");
      }
-     
+
      /**
      Drops a setting from a given record
-     
+
      @param    rs        <b>record</b>       the setting to drop
      @return   int       number of deleted records (0 if setting does not exist)
@@ -429 +429 @@
      }
 }
-?>