Changeset 2679:bae19d3adbc4 for inc

Timestamp:

03/05/14 21:04:23 (11 years ago)

Author:

Nicolas <nikrou77@…>

Branch:

default

Message:

Addresses #1896 : add choice of editor in preferences
Keeps old functions in core addFormater(), callFormater() for compatibility.

Location:

inc

Files:

• admin/lib.admincombos.php (modified) (2 diffs)
• core/class.dc.core.php (modified) (8 diffs)

inc/admin/lib.admincombos.php

@@ -51 +51 @@
      */
      public static function getPostStatusesCombo() {
-          $status_combo =  array();
+          $status_combo =      array();
           foreach (self::$core->blog->getAllPostStatus() as $k => $v) {
                $status_combo[$v] = (string) $k;
@@ -141 +141 @@
 
      /**
-     Returns a combo containing all available formaters in admin
-
-     @return   <b>array</b> the combo box (form::combo -compatible format)
-     */
-     public static function getFormatersCombo() {
-          foreach (self::$core->getFormaters() as $v) {
-               $formaters_combo[$v] = $v;
-          }
+     Returns a combo containing all available editors in admin
+
+     @return   <b>array</b> the combo box (form::combo -compatible format)
+     */
+     public static function getEditorsCombo()
+     {
+          $editors_combo = array();
+
+          foreach (self::$core->getEditors() as $v) {
+               $editors_combo[$v] = $v;
+          }
+          
+          return $editors_combo;
+     }
+
+     /**
+     Returns a combo containing all available formaters by editor in admin
+
+     @param    editor_id <b>string</b>  Editor id (dcLegacyEditor, dcCKEditor, ...)
+     @return   <b>array</b> the combo box (form::combo -compatible format)
+     */
+     public static function getFormatersCombo($editor_id='')
+     {
+          $formaters_combo = array();
+
+        if (!empty($editor_id)) {
+            foreach (self::$core->getFormaters($editor_id) as $formater) {
+                $formaters_combo[$formater] = $formater;
+            }
+        } else {
+            foreach (self::$core->getFormaters() as $editor => $formaters) {
+                foreach ($formaters as $formater) {
+                    $formaters_combo[$editor][$formater] = $formater;
+                }
+            }
+        }
+
           return $formaters_combo;
      }

inc/core/class.dc.core.php

@@ -101 +101 @@
 
           $this->log = new dcLog($this);
-
-          $this->addFormater('xhtml', create_function('$s','return $s;'));
-          $this->addFormater('wiki', array($this,'wikiTransform'));
      }
 
@@ -211 +208 @@
      //@}
 
-
      /// @name Text Formatters methods
      //@{
@@ -219 +215 @@
      argument: the string to transform. It returns the transformed string.
 
+     @param    editor_id <b>string</b>  Editor id (dcLegacyEditor, dcCKEditor, ...)
+     @param    name      <b>string</b>  Formater name
+     @param    func      <b>callback</b>     Function to use, must be a valid and callable callback
+     */
+     public function addEditorFormater($editor_id,$name,$func)
+     {
+          if (is_callable($func)) {
+               $this->formaters[$editor_id][$name] = $func;
+          }
+     }
+
+     /// @name Text Formatters methods
+     //@{
+     /**
+     Adds a new text formater which will call the function <var>$func</var> to
+     transform text. The function must be a valid callback and takes one
+     argument: the string to transform. It returns the transformed string.
+
      @param    name      <b>string</b>       Formater name
      @param    func      <b>callback</b>     Function to use, must be a valid and callable callback
@@ -224 +238 @@
      public function addFormater($name,$func)
      {
-          if (is_callable($func)) {
-               $this->formaters[$name] = $func;
-          }
-     }
-
-     /**
-     Returns formaters list.
-
+          $this->addEditorFormater('dcLegacyEditor',$name,$func);
+     }
+
+     /**
+     Returns editors list
+
+     @return   <b>array</b> An array of editors values.
+     */
+     public function getEditors()
+     {
+          $editors = array();
+
+          foreach (array_keys($this->formaters) as $editor_id) {
+               $editors[$editor_id] = $this->plugins->moduleInfo($editor_id,'name');
+          }
+
+          return $editors;
+     }
+
+     /**
+     Returns formaters list by editor
+
+     @param    editor_id <b>string</b>  Editor id (dcLegacyEditor, dcCKEditor, ...)
      @return   <b>array</b> An array of formaters names in values.
      */
-     public function getFormaters()
-     {
-          return array_keys($this->formaters);
+     public function getFormaters($editor_id='')
+     {
+          $formaters_list = array();
+
+          if (!empty($editor_id) && isset($this->formaters[$editor_id])) {
+               $formaters_list = array_keys($this->formaters[$editor_id]);
+          } else {
+               foreach ($this->formaters as $editor => $formaters) {
+                    $formaters_list[$editor] = array_keys($formaters);
+               }
+          }
+
+          return $formaters_list;
      }
 
@@ -243 +282 @@
      transformed using that formater.
 
+     @param    editor_id <b>string</b>  Editor id (dcLegacyEditor, dcCKEditor, ...)
      @param    name      <b>string</b>       Formater name
      @param    str       <b>string</b>       String to transform
      @return   <b>string</b>  String transformed
      */
+     public function callEditorFormater($editor_id,$name,$str)
+     {
+          if (isset($this->formaters[$editor_id]) && isset($this->formaters[$editor_id][$name])) {
+               return call_user_func($this->formaters[$editor_id][$name],$str);
+          }
+
+          return $str;
+     }
+     //@}
+
+     /**
+     If <var>$name</var> is a valid formater, it returns <var>$str</var>
+     transformed using that formater.
+
+     @param    name      <b>string</b>       Formater name
+     @param    str       <b>string</b>       String to transform
+     @return   <b>string</b>  String transformed
+     */
      public function callFormater($name,$str)
      {
-          if (isset($this->formaters[$name])) {
-               return call_user_func($this->formaters[$name],$str);
-          }
-
-          return $str;
+          return $this->callEditorFormater('dcLegacyEditor',$name,$str);
      }
      //@}
@@ -648 +702 @@
         - [url] => Blog URL
         - [p]
-          - [permission] => true
+          - [permission] => true
           - ...
 
@@ -816 +870 @@
         - [super] => (true|false) super admin
         - [p]
-          - [permission] => true
+          - [permission] => true
           - ...
 
@@ -1484 +1538 @@
      /**
       Return elapsed time since script has been started
-      @param   $mtime <b>float</b> timestamp (microtime format) to evaluate delta from
-                                     current time is taken if null
-      @return <b>float</b>        elapsed time
+      @param     $mtime <b>float</b> timestamp (microtime format) to evaluate delta from
+                                          current time is taken if null
+      @return <b>float</b>          elapsed time
       */
      public function getElapsedTime ($mtime=null) {