mambax7 / references

class/PEAR.php

Doc Comments +1 added lines, -1 removed lines

@@ -492,7 +492,7 @@
      * handling applied.  If the $mode and $options parameters are not
      * specified, the object's defaults are used.
      *
-     * @param mixed  $message     a text error message or a PEAR error object
+     * @param string|null  $message     a text error message or a PEAR error object
      *
      * @param int    $code        a numeric error code (it is up to your class
      *                            to define these if you want to use codes)

Indentation +980 added lines, -980 removed lines

@@ -40,25 +40,25 @@ 
 define('references_PEAR_ERROR_EXCEPTION', 32);
 /**#@-*/
 define('references_PEAR_ZE2', function_exists('version_compare')
-                              && version_compare(zend_version(), '2-dev', 'ge'));
+							  && version_compare(zend_version(), '2-dev', 'ge'));
 
 if (substr(PHP_OS, 0, 3) == 'WIN') {
-    define('references_OS_WINDOWS', true);
-    define('references_OS_UNIX', false);
-    define('references_PEAR_OS', 'Windows');
+	define('references_OS_WINDOWS', true);
+	define('references_OS_UNIX', false);
+	define('references_PEAR_OS', 'Windows');
 } else {
-    define('references_OS_WINDOWS', false);
-    define('references_OS_UNIX', true);
-    define('references_PEAR_OS', 'Unix'); // blatant assumption
+	define('references_OS_WINDOWS', false);
+	define('references_OS_UNIX', true);
+	define('references_PEAR_OS', 'Unix'); // blatant assumption
 }
 
 // instant backwards compatibility
 if (!defined('PATH_SEPARATOR')) {
-    if (references_OS_WINDOWS) {
-        define('PATH_SEPARATOR', ';');
-    } else {
-        define('PATH_SEPARATOR', ':');
-    }
+	if (references_OS_WINDOWS) {
+		define('PATH_SEPARATOR', ';');
+	} else {
+		define('PATH_SEPARATOR', ':');
+	}
 }
 
 $GLOBALS['_PEAR_default_error_mode']     = references_PEAR_ERROR_RETURN;
@@ -101,712 +101,712 @@ 
  */
 class references_PEAR
 {
-    // {{{ properties
-
-    /**
-     * Whether to enable internal debug messages.
-     *
-     * @var bool
-     * @access  private
-     */
-    public $_debug = false;
-
-    /**
-     * Default error mode for this object.
-     *
-     * @var int
-     * @access  private
-     */
-    public $_default_error_mode = null;
-
-    /**
-     * Default error options used for this object when error mode
-     * is references_PEAR_ERROR_TRIGGER.
-     *
-     * @var int
-     * @access  private
-     */
-    public $_default_error_options = null;
-
-    /**
-     * Default error handler (callback) for this object, if error mode is
-     * references_PEAR_ERROR_CALLBACK.
-     *
-     * @var string
-     * @access  private
-     */
-    public $_default_error_handler = '';
-
-    /**
-     * Which class to use for error objects.
-     *
-     * @var string
-     * @access  private
-     */
-    public $_error_class = 'PEAR_Error';
-
-    /**
-     * An array of expected errors.
-     *
-     * @var array
-     * @access  private
-     */
-    public $_expected_errors = array();
-
-    // }}}
-
-    // {{{ constructor
-
-    /**
-     * Constructor.  Registers this object in
-     * $_PEAR_destructor_object_list for destructor emulation if a
-     * destructor object exists.
-     *
-     * @param  string $error_class (optional) which class to use for
-     *                             error objects, defaults to PEAR_Error.
-     * @access public
-     */
-    public function __construct($error_class = null)
-    {
-        $classname = strtolower(get_class($this));
-        if ($this->_debug) {
-            print "PEAR constructor called, class=$classname\n";
-        }
-        if ($error_class !== null) {
-            $this->_error_class = $error_class;
-        }
-        while ($classname && strcasecmp($classname, 'pear')) {
-            $destructor = "_$classname";
-            if (method_exists($this, $destructor)) {
-                global $_PEAR_destructor_object_list;
-                $_PEAR_destructor_object_list[] = &$this;
-                if (!isset($GLOBALS['_PEAR_SHUTDOWN_REGISTERED'])) {
-                    register_shutdown_function('references_PEAR_call_destructors');
-                    $GLOBALS['_PEAR_SHUTDOWN_REGISTERED'] = true;
-                }
-                break;
-            } else {
-                $classname = get_parent_class($classname);
-            }
-        }
-    }
-
-    // }}}
-    // {{{ destructor
-
-    /**
-     * Destructor (the emulated type of...).  Does nothing right now,
-     * but is included for forward compatibility, so subclass
-     * destructors should always call it.
-     *
-     * See the note in the class desciption about output from
-     * destructors.
-     *
-     * @access public
-     * @return void
-     */
-    public function _PEAR()
-    {
-        if ($this->_debug) {
-            printf("PEAR destructor called, class=%s\n", strtolower(get_class($this)));
-        }
-    }
-
-    // }}}
-    // {{{ getStaticProperty()
-
-    /**
-     * If you have a class that's mostly/entirely static, and you need static
-     * properties, you can use this method to simulate them. Eg. in your method(s)
-     * do this: $myVar = &references_PEAR::getStaticProperty('myclass', 'myVar');
-     * You MUST use a reference, or they will not persist!
-     *
-     * @access public
-     * @param  string $class The calling classname, to prevent clashes
-     * @param  string $var   The variable to retrieve.
-     * @return mixed   A reference to the variable. If not set it will be
-     *                       auto initialised to NULL.
-     */
-    public function &getStaticProperty($class, $var)
-    {
-        static $properties;
-        if (!isset($properties[$class])) {
-            $properties[$class] = array();
-        }
-        if (!array_key_exists($var, $properties[$class])) {
-            $properties[$class][$var] = null;
-        }
-
-        return $properties[$class][$var];
-    }
-
-    // }}}
-    // {{{ registerShutdownFunc()
-
-    /**
-     * Use this function to register a shutdown method for static
-     * classes.
-     *
-     * @access public
-     * @param  mixed $func The function name (or array of class/method) to call
-     * @param  mixed $args The arguments to pass to the function
-     * @return void
-     */
-    public function registerShutdownFunc($func, $args = array())
-    {
-        // if we are called statically, there is a potential
-        // that no shutdown func is registered.  Bug #6445
-        if (!isset($GLOBALS['_PEAR_SHUTDOWN_REGISTERED'])) {
-            register_shutdown_function('references__PEAR_call_destructors');
-            $GLOBALS['_PEAR_SHUTDOWN_REGISTERED'] = true;
-        }
-        $GLOBALS['_PEAR_shutdown_funcs'][] = array($func, $args);
-    }
-
-    // }}}
-    // {{{ isError()
-
-    /**
-     * Tell whether a value is a PEAR error.
-     *
-     * @param  mixed $data the value to test
-     * @param  int   $code if $data is an error object, return true
-     *                     only if $code is a string and
-     *                     $obj->getMessage() == $code or
-     *                     $code is an integer and $obj->getCode() == $code
-     * @access  public
-     * @return bool  true if parameter is an error
-     */
-    public function isError($data, $code = null)
-    {
-        if (is_a($data, 'PEAR_Error')) {
-            if (is_null($code)) {
-                return true;
-            } elseif (is_string($code)) {
-                return $data->getMessage() == $code;
-            } else {
-                return $data->getCode() == $code;
-            }
-        }
-
-        return false;
-    }
-
-    // }}}
-    // {{{ setErrorHandling()
-
-    /**
-     * Sets how errors generated by this object should be handled.
-     * Can be invoked both in objects and statically.  If called
-     * statically, setErrorHandling sets the default behaviour for all
-     * PEAR objects.  If called in an object, setErrorHandling sets
-     * the default behaviour for that object.
-     *
-     * @param int   $mode
-     *                       One of references_PEAR_ERROR_RETURN, references_PEAR_ERROR_PRINT,
-     *                       references_PEAR_ERROR_TRIGGER, references_PEAR_ERROR_DIE,
-     *                       references_PEAR_ERROR_CALLBACK or references_PEAR_ERROR_EXCEPTION.
-     *
-     * @param mixed $options
-     *                       When $mode is references_PEAR_ERROR_TRIGGER, this is the error level (one
-     *                       of E_USER_NOTICE, E_USER_WARNING or E_USER_ERROR).
-     *
-     *        When $mode is references_PEAR_ERROR_CALLBACK, this parameter is expected
-     *        to be the callback function or method.  A callback
-     *        function is a string with the name of the function, a
-     *        callback method is an array of two elements: the element
-     *        at index 0 is the object, and the element at index 1 is
-     *        the name of the method to call in the object.
-     *
-     *        When $mode is references_PEAR_ERROR_PRINT or references_PEAR_ERROR_DIE, this is
-     *        a printf format string used when printing the error
-     *        message.
-     *
-     * @access public
-     * @return void
-     * @see    references_PEAR_ERROR_RETURN
-     * @see    references_PEAR_ERROR_PRINT
-     * @see    references_PEAR_ERROR_TRIGGER
-     * @see    references_PEAR_ERROR_DIE
-     * @see    references_PEAR_ERROR_CALLBACK
-     * @see    references_PEAR_ERROR_EXCEPTION
-     *
-     */
-
-    public function setErrorHandling($mode = null, $options = null)
-    {
-        if (isset($this) && is_a($this, 'PEAR')) {
-            $setmode    = &$this->_default_error_mode;
-            $setoptions = &$this->_default_error_options;
-        } else {
-            $setmode    = &$GLOBALS['_PEAR_default_error_mode'];
-            $setoptions = &$GLOBALS['_PEAR_default_error_options'];
-        }
-
-        switch ($mode) {
-            case references_PEAR_ERROR_EXCEPTION:
-            case references_PEAR_ERROR_RETURN:
-            case references_PEAR_ERROR_PRINT:
-            case references_PEAR_ERROR_TRIGGER:
-            case references_PEAR_ERROR_DIE:
-            case null:
-                $setmode    = $mode;
-                $setoptions = $options;
-                break;
-
-            case references_PEAR_ERROR_CALLBACK:
-                $setmode = $mode;
-                // class/object method callback
-                if (is_callable($options)) {
-                    $setoptions = $options;
-                } else {
-                    trigger_error('invalid error callback', E_USER_WARNING);
-                }
-                break;
-
-            default:
-                trigger_error('invalid error mode', E_USER_WARNING);
-                break;
-        }
-    }
-
-    // }}}
-    // {{{ expectError()
-
-    /**
-     * This method is used to tell which errors you expect to get.
-     * Expected errors are always returned with error mode
-     * references_PEAR_ERROR_RETURN.  Expected error codes are stored in a stack,
-     * and this method pushes a new element onto it.  The list of
-     * expected errors are in effect until they are popped off the
-     * stack with the popExpect() method.
-     *
-     * Note that this method can not be called statically
-     *
-     * @param mixed $code a single error code or an array of error codes to expect
-     *
-     * @return int the new depth of the "expected errors" stack
-     * @access public
-     */
-    public function expectError($code = '*')
-    {
-        if (is_array($code)) {
-            array_push($this->_expected_errors, $code);
-        } else {
-            array_push($this->_expected_errors, array($code));
-        }
-
-        return count($this->_expected_errors);
-    }
-
-    // }}}
-    // {{{ popExpect()
-
-    /**
-     * This method pops one element off the expected error codes
-     * stack.
-     *
-     * @return array the list of error codes that were popped
-     */
-    public function popExpect()
-    {
-        return array_pop($this->_expected_errors);
-    }
-
-    // }}}
-    // {{{ _checkDelExpect()
-
-    /**
-     * This method checks unsets an error code if available
-     *
-     * @param mixed error code
-     * @return bool true if the error code was unset, false otherwise
-     * @access private
-     */
-    public function _checkDelExpect($error_code)
-    {
-        $deleted = false;
-
-        foreach ($this->_expected_errors as $key => $error_array) {
-            if (in_array($error_code, $error_array)) {
-                unset($this->_expected_errors[$key][array_search($error_code, $error_array)]);
-                $deleted = true;
-            }
-
-            // clean up empty arrays
-            if (0 == count($this->_expected_errors[$key])) {
-                unset($this->_expected_errors[$key]);
-            }
-        }
-
-        return $deleted;
-    }
-
-    // }}}
-    // {{{ delExpect()
-
-    /**
-     * This method deletes all occurences of the specified element from
-     * the expected error codes stack.
-     *
-     * @param  mixed $error_code error code that should be deleted
-     * @return mixed list of error codes that were deleted or error
-     * @access public
-     */
-    public function delExpect($error_code)
-    {
-        $deleted = false;
-
-        if (is_array($error_code) && (0 != count($error_code))) {
-            // $error_code is a non-empty array here;
-            // we walk through it trying to unset all
-            // values
-            foreach ($error_code as $key => $error) {
-                if ($this->_checkDelExpect($error)) {
-                    $deleted = true;
-                } else {
-                    $deleted = false;
-                }
-            }
-
-            return $deleted ? true : references_PEAR::raiseError('The expected error you submitted does not exist'); // IMPROVE ME
-        } elseif (!empty($error_code)) {
-            // $error_code comes alone, trying to unset it
-            if ($this->_checkDelExpect($error_code)) {
-                return true;
-            } else {
-                return references_PEAR::raiseError('The expected error you submitted does not exist'); // IMPROVE ME
-            }
-        } else {
-            // $error_code is empty
-            return references_PEAR::raiseError('The expected error you submitted is empty'); // IMPROVE ME
-        }
-    }
-
-    // }}}
-    // {{{ raiseError()
-
-    /**
-     * This method is a wrapper that returns an instance of the
-     * configured error class with this object's default error
-     * handling applied.  If the $mode and $options parameters are not
-     * specified, the object's defaults are used.
-     *
-     * @param mixed  $message     a text error message or a PEAR error object
-     *
-     * @param int    $code        a numeric error code (it is up to your class
-     *                            to define these if you want to use codes)
-     *
-     * @param int    $mode        One of references_PEAR_ERROR_RETURN, references_PEAR_ERROR_PRINT,
-     *                            references_PEAR_ERROR_TRIGGER, references_PEAR_ERROR_DIE,
-     *                            references_PEAR_ERROR_CALLBACK, references_PEAR_ERROR_EXCEPTION.
-     *
-     * @param mixed  $options     If $mode is references_PEAR_ERROR_TRIGGER, this parameter
-     *                            specifies the PHP-internal error level (one of
-     *                            E_USER_NOTICE, E_USER_WARNING or E_USER_ERROR).
-     *                            If $mode is references_PEAR_ERROR_CALLBACK, this
-     *                            parameter specifies the callback function or
-     *                            method.  In other error modes this parameter
-     *                            is ignored.
-     *
-     * @param string $userinfo    If you need to pass along for example debug
-     *                            information, this parameter is meant for that.
-     *
-     * @param string $error_class The returned error object will be
-     *                            instantiated from this class, if specified.
-     *
-     * @param bool   $skipmsg     If true, raiseError will only pass error codes,
-     *                            the error message parameter will be dropped.
-     *
-     * @access public
-     * @return object a PEAR error object
-     * @see    references_PEAR::setErrorHandling
-     * @since  PHP 4.0.5
-     */
-    public function &raiseError($message = null, $code = null, $mode = null, $options = null, $userinfo = null, $error_class = null, $skipmsg = false)
-    {
-        // The error is yet a PEAR error object
-        if (is_object($message)) {
-            $code                          = $message->getCode();
-            $userinfo                      = $message->getUserInfo();
-            $error_class                   = $message->getType();
-            $message->error_message_prefix = '';
-            $message                       = $message->getMessage();
-        }
-
-        if (isset($this) && isset($this->_expected_errors) && count($this->_expected_errors) > 0 && count($exp = end($this->_expected_errors))) {
-            if ($exp[0] === '*'
-                || (is_int(reset($exp)) && in_array($code, $exp))
-                || (is_string(reset($exp)) && in_array($message, $exp))
-            ) {
-                $mode = references_PEAR_ERROR_RETURN;
-            }
-        }
-        // No mode given, try global ones
-        if ($mode === null) {
-            // Class error handler
-            if (isset($this) && isset($this->_default_error_mode)) {
-                $mode    = $this->_default_error_mode;
-                $options = $this->_default_error_options;
-                // Global error handler
-            } elseif (isset($GLOBALS['_PEAR_default_error_mode'])) {
-                $mode    = $GLOBALS['_PEAR_default_error_mode'];
-                $options = $GLOBALS['_PEAR_default_error_options'];
-            }
-        }
-
-        if ($error_class !== null) {
-            $ec = $error_class;
-        } elseif (isset($this) && isset($this->_error_class)) {
-            $ec = $this->_error_class;
-        } else {
-            $ec = 'references_PEAR_Error';
-        }
-        if ($skipmsg) {
-            $a = new $ec($code, $mode, $options, $userinfo);
-
-            return $a;
-        } else {
-            $a = new $ec($message, $code, $mode, $options, $userinfo);
-
-            return $a;
-        }
-    }
-
-    // }}}
-    // {{{ throwError()
-
-    /**
-     * Simpler form of raiseError with fewer options.  In most cases
-     * message, code and userinfo are enough.
-     *
-     * @param string $message
-     *
-     * @param null   $code
-     * @param null   $userinfo
-     * @return object
-     */
-    public function &throwError($message = null, $code = null, $userinfo = null)
-    {
-        if (isset($this) && is_a($this, 'PEAR')) {
-            $a = &$this->raiseError($message, $code, null, null, $userinfo);
-
-            return $a;
-        } else {
-            $a = &references_PEAR::raiseError($message, $code, null, null, $userinfo);
-
-            return $a;
-        }
-    }
-
-    // }}}
-    public function staticPushErrorHandling($mode, $options = null)
-    {
-        $stack       = &$GLOBALS['_PEAR_error_handler_stack'];
-        $def_mode    = &$GLOBALS['_PEAR_default_error_mode'];
-        $def_options = &$GLOBALS['_PEAR_default_error_options'];
-        $stack[]     = array($def_mode, $def_options);
-        switch ($mode) {
-            case references_PEAR_ERROR_EXCEPTION:
-            case references_PEAR_ERROR_RETURN:
-            case references_PEAR_ERROR_PRINT:
-            case references_PEAR_ERROR_TRIGGER:
-            case references_PEAR_ERROR_DIE:
-            case null:
-                $def_mode    = $mode;
-                $def_options = $options;
-                break;
-
-            case references_PEAR_ERROR_CALLBACK:
-                $def_mode = $mode;
-                // class/object method callback
-                if (is_callable($options)) {
-                    $def_options = $options;
-                } else {
-                    trigger_error('invalid error callback', E_USER_WARNING);
-                }
-                break;
-
-            default:
-                trigger_error('invalid error mode', E_USER_WARNING);
-                break;
-        }
-        $stack[] = array($mode, $options);
-
-        return true;
-    }
-
-    public function staticPopErrorHandling()
-    {
-        $stack      = &$GLOBALS['_PEAR_error_handler_stack'];
-        $setmode    = &$GLOBALS['_PEAR_default_error_mode'];
-        $setoptions = &$GLOBALS['_PEAR_default_error_options'];
-        array_pop($stack);
-        list($mode, $options) = $stack[count($stack) - 1];
-        array_pop($stack);
-        switch ($mode) {
-            case references_PEAR_ERROR_EXCEPTION:
-            case references_PEAR_ERROR_RETURN:
-            case references_PEAR_ERROR_PRINT:
-            case references_PEAR_ERROR_TRIGGER:
-            case references_PEAR_ERROR_DIE:
-            case null:
-                $setmode    = $mode;
-                $setoptions = $options;
-                break;
-
-            case references_PEAR_ERROR_CALLBACK:
-                $setmode = $mode;
-                // class/object method callback
-                if (is_callable($options)) {
-                    $setoptions = $options;
-                } else {
-                    trigger_error('invalid error callback', E_USER_WARNING);
-                }
-                break;
-
-            default:
-                trigger_error('invalid error mode', E_USER_WARNING);
-                break;
-        }
-
-        return true;
-    }
-
-    // {{{ pushErrorHandling()
-
-    /**
-     * Push a new error handler on top of the error handler options stack. With this
-     * you can easily override the actual error handler for some code and restore
-     * it later with popErrorHandling.
-     *
-     * @param mixed $mode    (same as setErrorHandling)
-     * @param mixed $options (same as setErrorHandling)
-     *
-     * @return bool Always true
-     *
-     * @see references_PEAR::setErrorHandling
-     */
-    public function pushErrorHandling($mode, $options = null)
-    {
-        $stack = &$GLOBALS['_PEAR_error_handler_stack'];
-        if (isset($this) && is_a($this, 'PEAR')) {
-            $def_mode    = &$this->_default_error_mode;
-            $def_options = &$this->_default_error_options;
-        } else {
-            $def_mode    = &$GLOBALS['_PEAR_default_error_mode'];
-            $def_options = &$GLOBALS['_PEAR_default_error_options'];
-        }
-        $stack[] = array($def_mode, $def_options);
-
-        if (isset($this) && is_a($this, 'PEAR')) {
-            $this->setErrorHandling($mode, $options);
-        } else {
-            references_PEAR::setErrorHandling($mode, $options);
-        }
-        $stack[] = array($mode, $options);
-
-        return true;
-    }
-
-    // }}}
-    // {{{ popErrorHandling()
-
-    /**
-     * Pop the last error handler used
-     *
-     * @return bool Always true
-     *
-     * @see references_PEAR::pushErrorHandling
-     */
-    public function popErrorHandling()
-    {
-        $stack = &$GLOBALS['_PEAR_error_handler_stack'];
-        array_pop($stack);
-        list($mode, $options) = $stack[count($stack) - 1];
-        array_pop($stack);
-        if (isset($this) && is_a($this, 'PEAR')) {
-            $this->setErrorHandling($mode, $options);
-        } else {
-            references_PEAR::setErrorHandling($mode, $options);
-        }
-
-        return true;
-    }
-
-    // }}}
-    // {{{ loadExtension()
-
-    /**
-     * OS independant PHP extension load. Remember to take care
-     * on the correct extension name for case sensitive OSes.
-     *
-     * @param string $ext The extension name
-     * @return bool Success or not on the dl() call
-     */
-    public function loadExtension($ext)
-    {
-        if (!extension_loaded($ext)) {
-            // if either returns true dl() will produce a FATAL error, stop that
-            if ((ini_get('enable_dl') != 1) || (ini_get('safe_mode') == 1)) {
-                return false;
-            }
-            if (references_OS_WINDOWS) {
-                $suffix = '.dll';
-            } elseif (PHP_OS === 'HP-UX') {
-                $suffix = '.sl';
-            } elseif (PHP_OS === 'AIX') {
-                $suffix = '.a';
-            } elseif (PHP_OS === 'OSX') {
-                $suffix = '.bundle';
-            } else {
-                $suffix = '.so';
-            }
-
-            return @dl('php_' . $ext . $suffix) || @dl($ext . $suffix);
-        }
-
-        return true;
-    }
-
-    // }}}
+	// {{{ properties
+
+	/**
+	 * Whether to enable internal debug messages.
+	 *
+	 * @var bool
+	 * @access  private
+	 */
+	public $_debug = false;
+
+	/**
+	 * Default error mode for this object.
+	 *
+	 * @var int
+	 * @access  private
+	 */
+	public $_default_error_mode = null;
+
+	/**
+	 * Default error options used for this object when error mode
+	 * is references_PEAR_ERROR_TRIGGER.
+	 *
+	 * @var int
+	 * @access  private
+	 */
+	public $_default_error_options = null;
+
+	/**
+	 * Default error handler (callback) for this object, if error mode is
+	 * references_PEAR_ERROR_CALLBACK.
+	 *
+	 * @var string
+	 * @access  private
+	 */
+	public $_default_error_handler = '';
+
+	/**
+	 * Which class to use for error objects.
+	 *
+	 * @var string
+	 * @access  private
+	 */
+	public $_error_class = 'PEAR_Error';
+
+	/**
+	 * An array of expected errors.
+	 *
+	 * @var array
+	 * @access  private
+	 */
+	public $_expected_errors = array();
+
+	// }}}
+
+	// {{{ constructor
+
+	/**
+	 * Constructor.  Registers this object in
+	 * $_PEAR_destructor_object_list for destructor emulation if a
+	 * destructor object exists.
+	 *
+	 * @param  string $error_class (optional) which class to use for
+	 *                             error objects, defaults to PEAR_Error.
+	 * @access public
+	 */
+	public function __construct($error_class = null)
+	{
+		$classname = strtolower(get_class($this));
+		if ($this->_debug) {
+			print "PEAR constructor called, class=$classname\n";
+		}
+		if ($error_class !== null) {
+			$this->_error_class = $error_class;
+		}
+		while ($classname && strcasecmp($classname, 'pear')) {
+			$destructor = "_$classname";
+			if (method_exists($this, $destructor)) {
+				global $_PEAR_destructor_object_list;
+				$_PEAR_destructor_object_list[] = &$this;
+				if (!isset($GLOBALS['_PEAR_SHUTDOWN_REGISTERED'])) {
+					register_shutdown_function('references_PEAR_call_destructors');
+					$GLOBALS['_PEAR_SHUTDOWN_REGISTERED'] = true;
+				}
+				break;
+			} else {
+				$classname = get_parent_class($classname);
+			}
+		}
+	}
+
+	// }}}
+	// {{{ destructor
+
+	/**
+	 * Destructor (the emulated type of...).  Does nothing right now,
+	 * but is included for forward compatibility, so subclass
+	 * destructors should always call it.
+	 *
+	 * See the note in the class desciption about output from
+	 * destructors.
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function _PEAR()
+	{
+		if ($this->_debug) {
+			printf("PEAR destructor called, class=%s\n", strtolower(get_class($this)));
+		}
+	}
+
+	// }}}
+	// {{{ getStaticProperty()
+
+	/**
+	 * If you have a class that's mostly/entirely static, and you need static
+	 * properties, you can use this method to simulate them. Eg. in your method(s)
+	 * do this: $myVar = &references_PEAR::getStaticProperty('myclass', 'myVar');
+	 * You MUST use a reference, or they will not persist!
+	 *
+	 * @access public
+	 * @param  string $class The calling classname, to prevent clashes
+	 * @param  string $var   The variable to retrieve.
+	 * @return mixed   A reference to the variable. If not set it will be
+	 *                       auto initialised to NULL.
+	 */
+	public function &getStaticProperty($class, $var)
+	{
+		static $properties;
+		if (!isset($properties[$class])) {
+			$properties[$class] = array();
+		}
+		if (!array_key_exists($var, $properties[$class])) {
+			$properties[$class][$var] = null;
+		}
+
+		return $properties[$class][$var];
+	}
+
+	// }}}
+	// {{{ registerShutdownFunc()
+
+	/**
+	 * Use this function to register a shutdown method for static
+	 * classes.
+	 *
+	 * @access public
+	 * @param  mixed $func The function name (or array of class/method) to call
+	 * @param  mixed $args The arguments to pass to the function
+	 * @return void
+	 */
+	public function registerShutdownFunc($func, $args = array())
+	{
+		// if we are called statically, there is a potential
+		// that no shutdown func is registered.  Bug #6445
+		if (!isset($GLOBALS['_PEAR_SHUTDOWN_REGISTERED'])) {
+			register_shutdown_function('references__PEAR_call_destructors');
+			$GLOBALS['_PEAR_SHUTDOWN_REGISTERED'] = true;
+		}
+		$GLOBALS['_PEAR_shutdown_funcs'][] = array($func, $args);
+	}
+
+	// }}}
+	// {{{ isError()
+
+	/**
+	 * Tell whether a value is a PEAR error.
+	 *
+	 * @param  mixed $data the value to test
+	 * @param  int   $code if $data is an error object, return true
+	 *                     only if $code is a string and
+	 *                     $obj->getMessage() == $code or
+	 *                     $code is an integer and $obj->getCode() == $code
+	 * @access  public
+	 * @return bool  true if parameter is an error
+	 */
+	public function isError($data, $code = null)
+	{
+		if (is_a($data, 'PEAR_Error')) {
+			if (is_null($code)) {
+				return true;
+			} elseif (is_string($code)) {
+				return $data->getMessage() == $code;
+			} else {
+				return $data->getCode() == $code;
+			}
+		}
+
+		return false;
+	}
+
+	// }}}
+	// {{{ setErrorHandling()
+
+	/**
+	 * Sets how errors generated by this object should be handled.
+	 * Can be invoked both in objects and statically.  If called
+	 * statically, setErrorHandling sets the default behaviour for all
+	 * PEAR objects.  If called in an object, setErrorHandling sets
+	 * the default behaviour for that object.
+	 *
+	 * @param int   $mode
+	 *                       One of references_PEAR_ERROR_RETURN, references_PEAR_ERROR_PRINT,
+	 *                       references_PEAR_ERROR_TRIGGER, references_PEAR_ERROR_DIE,
+	 *                       references_PEAR_ERROR_CALLBACK or references_PEAR_ERROR_EXCEPTION.
+	 *
+	 * @param mixed $options
+	 *                       When $mode is references_PEAR_ERROR_TRIGGER, this is the error level (one
+	 *                       of E_USER_NOTICE, E_USER_WARNING or E_USER_ERROR).
+	 *
+	 *        When $mode is references_PEAR_ERROR_CALLBACK, this parameter is expected
+	 *        to be the callback function or method.  A callback
+	 *        function is a string with the name of the function, a
+	 *        callback method is an array of two elements: the element
+	 *        at index 0 is the object, and the element at index 1 is
+	 *        the name of the method to call in the object.
+	 *
+	 *        When $mode is references_PEAR_ERROR_PRINT or references_PEAR_ERROR_DIE, this is
+	 *        a printf format string used when printing the error
+	 *        message.
+	 *
+	 * @access public
+	 * @return void
+	 * @see    references_PEAR_ERROR_RETURN
+	 * @see    references_PEAR_ERROR_PRINT
+	 * @see    references_PEAR_ERROR_TRIGGER
+	 * @see    references_PEAR_ERROR_DIE
+	 * @see    references_PEAR_ERROR_CALLBACK
+	 * @see    references_PEAR_ERROR_EXCEPTION
+	 *
+	 */
+
+	public function setErrorHandling($mode = null, $options = null)
+	{
+		if (isset($this) && is_a($this, 'PEAR')) {
+			$setmode    = &$this->_default_error_mode;
+			$setoptions = &$this->_default_error_options;
+		} else {
+			$setmode    = &$GLOBALS['_PEAR_default_error_mode'];
+			$setoptions = &$GLOBALS['_PEAR_default_error_options'];
+		}
+
+		switch ($mode) {
+			case references_PEAR_ERROR_EXCEPTION:
+			case references_PEAR_ERROR_RETURN:
+			case references_PEAR_ERROR_PRINT:
+			case references_PEAR_ERROR_TRIGGER:
+			case references_PEAR_ERROR_DIE:
+			case null:
+				$setmode    = $mode;
+				$setoptions = $options;
+				break;
+
+			case references_PEAR_ERROR_CALLBACK:
+				$setmode = $mode;
+				// class/object method callback
+				if (is_callable($options)) {
+					$setoptions = $options;
+				} else {
+					trigger_error('invalid error callback', E_USER_WARNING);
+				}
+				break;
+
+			default:
+				trigger_error('invalid error mode', E_USER_WARNING);
+				break;
+		}
+	}
+
+	// }}}
+	// {{{ expectError()
+
+	/**
+	 * This method is used to tell which errors you expect to get.
+	 * Expected errors are always returned with error mode
+	 * references_PEAR_ERROR_RETURN.  Expected error codes are stored in a stack,
+	 * and this method pushes a new element onto it.  The list of
+	 * expected errors are in effect until they are popped off the
+	 * stack with the popExpect() method.
+	 *
+	 * Note that this method can not be called statically
+	 *
+	 * @param mixed $code a single error code or an array of error codes to expect
+	 *
+	 * @return int the new depth of the "expected errors" stack
+	 * @access public
+	 */
+	public function expectError($code = '*')
+	{
+		if (is_array($code)) {
+			array_push($this->_expected_errors, $code);
+		} else {
+			array_push($this->_expected_errors, array($code));
+		}
+
+		return count($this->_expected_errors);
+	}
+
+	// }}}
+	// {{{ popExpect()
+
+	/**
+	 * This method pops one element off the expected error codes
+	 * stack.
+	 *
+	 * @return array the list of error codes that were popped
+	 */
+	public function popExpect()
+	{
+		return array_pop($this->_expected_errors);
+	}
+
+	// }}}
+	// {{{ _checkDelExpect()
+
+	/**
+	 * This method checks unsets an error code if available
+	 *
+	 * @param mixed error code
+	 * @return bool true if the error code was unset, false otherwise
+	 * @access private
+	 */
+	public function _checkDelExpect($error_code)
+	{
+		$deleted = false;
+
+		foreach ($this->_expected_errors as $key => $error_array) {
+			if (in_array($error_code, $error_array)) {
+				unset($this->_expected_errors[$key][array_search($error_code, $error_array)]);
+				$deleted = true;
+			}
+
+			// clean up empty arrays
+			if (0 == count($this->_expected_errors[$key])) {
+				unset($this->_expected_errors[$key]);
+			}
+		}
+
+		return $deleted;
+	}
+
+	// }}}
+	// {{{ delExpect()
+
+	/**
+	 * This method deletes all occurences of the specified element from
+	 * the expected error codes stack.
+	 *
+	 * @param  mixed $error_code error code that should be deleted
+	 * @return mixed list of error codes that were deleted or error
+	 * @access public
+	 */
+	public function delExpect($error_code)
+	{
+		$deleted = false;
+
+		if (is_array($error_code) && (0 != count($error_code))) {
+			// $error_code is a non-empty array here;
+			// we walk through it trying to unset all
+			// values
+			foreach ($error_code as $key => $error) {
+				if ($this->_checkDelExpect($error)) {
+					$deleted = true;
+				} else {
+					$deleted = false;
+				}
+			}
+
+			return $deleted ? true : references_PEAR::raiseError('The expected error you submitted does not exist'); // IMPROVE ME
+		} elseif (!empty($error_code)) {
+			// $error_code comes alone, trying to unset it
+			if ($this->_checkDelExpect($error_code)) {
+				return true;
+			} else {
+				return references_PEAR::raiseError('The expected error you submitted does not exist'); // IMPROVE ME
+			}
+		} else {
+			// $error_code is empty
+			return references_PEAR::raiseError('The expected error you submitted is empty'); // IMPROVE ME
+		}
+	}
+
+	// }}}
+	// {{{ raiseError()
+
+	/**
+	 * This method is a wrapper that returns an instance of the
+	 * configured error class with this object's default error
+	 * handling applied.  If the $mode and $options parameters are not
+	 * specified, the object's defaults are used.
+	 *
+	 * @param mixed  $message     a text error message or a PEAR error object
+	 *
+	 * @param int    $code        a numeric error code (it is up to your class
+	 *                            to define these if you want to use codes)
+	 *
+	 * @param int    $mode        One of references_PEAR_ERROR_RETURN, references_PEAR_ERROR_PRINT,
+	 *                            references_PEAR_ERROR_TRIGGER, references_PEAR_ERROR_DIE,
+	 *                            references_PEAR_ERROR_CALLBACK, references_PEAR_ERROR_EXCEPTION.
+	 *
+	 * @param mixed  $options     If $mode is references_PEAR_ERROR_TRIGGER, this parameter
+	 *                            specifies the PHP-internal error level (one of
+	 *                            E_USER_NOTICE, E_USER_WARNING or E_USER_ERROR).
+	 *                            If $mode is references_PEAR_ERROR_CALLBACK, this
+	 *                            parameter specifies the callback function or
+	 *                            method.  In other error modes this parameter
+	 *                            is ignored.
+	 *
+	 * @param string $userinfo    If you need to pass along for example debug
+	 *                            information, this parameter is meant for that.
+	 *
+	 * @param string $error_class The returned error object will be
+	 *                            instantiated from this class, if specified.
+	 *
+	 * @param bool   $skipmsg     If true, raiseError will only pass error codes,
+	 *                            the error message parameter will be dropped.
+	 *
+	 * @access public
+	 * @return object a PEAR error object
+	 * @see    references_PEAR::setErrorHandling
+	 * @since  PHP 4.0.5
+	 */
+	public function &raiseError($message = null, $code = null, $mode = null, $options = null, $userinfo = null, $error_class = null, $skipmsg = false)
+	{
+		// The error is yet a PEAR error object
+		if (is_object($message)) {
+			$code                          = $message->getCode();
+			$userinfo                      = $message->getUserInfo();
+			$error_class                   = $message->getType();
+			$message->error_message_prefix = '';
+			$message                       = $message->getMessage();
+		}
+
+		if (isset($this) && isset($this->_expected_errors) && count($this->_expected_errors) > 0 && count($exp = end($this->_expected_errors))) {
+			if ($exp[0] === '*'
+				|| (is_int(reset($exp)) && in_array($code, $exp))
+				|| (is_string(reset($exp)) && in_array($message, $exp))
+			) {
+				$mode = references_PEAR_ERROR_RETURN;
+			}
+		}
+		// No mode given, try global ones
+		if ($mode === null) {
+			// Class error handler
+			if (isset($this) && isset($this->_default_error_mode)) {
+				$mode    = $this->_default_error_mode;
+				$options = $this->_default_error_options;
+				// Global error handler
+			} elseif (isset($GLOBALS['_PEAR_default_error_mode'])) {
+				$mode    = $GLOBALS['_PEAR_default_error_mode'];
+				$options = $GLOBALS['_PEAR_default_error_options'];
+			}
+		}
+
+		if ($error_class !== null) {
+			$ec = $error_class;
+		} elseif (isset($this) && isset($this->_error_class)) {
+			$ec = $this->_error_class;
+		} else {
+			$ec = 'references_PEAR_Error';
+		}
+		if ($skipmsg) {
+			$a = new $ec($code, $mode, $options, $userinfo);
+
+			return $a;
+		} else {
+			$a = new $ec($message, $code, $mode, $options, $userinfo);
+
+			return $a;
+		}
+	}
+
+	// }}}
+	// {{{ throwError()
+
+	/**
+	 * Simpler form of raiseError with fewer options.  In most cases
+	 * message, code and userinfo are enough.
+	 *
+	 * @param string $message
+	 *
+	 * @param null   $code
+	 * @param null   $userinfo
+	 * @return object
+	 */
+	public function &throwError($message = null, $code = null, $userinfo = null)
+	{
+		if (isset($this) && is_a($this, 'PEAR')) {
+			$a = &$this->raiseError($message, $code, null, null, $userinfo);
+
+			return $a;
+		} else {
+			$a = &references_PEAR::raiseError($message, $code, null, null, $userinfo);
+
+			return $a;
+		}
+	}
+
+	// }}}
+	public function staticPushErrorHandling($mode, $options = null)
+	{
+		$stack       = &$GLOBALS['_PEAR_error_handler_stack'];
+		$def_mode    = &$GLOBALS['_PEAR_default_error_mode'];
+		$def_options = &$GLOBALS['_PEAR_default_error_options'];
+		$stack[]     = array($def_mode, $def_options);
+		switch ($mode) {
+			case references_PEAR_ERROR_EXCEPTION:
+			case references_PEAR_ERROR_RETURN:
+			case references_PEAR_ERROR_PRINT:
+			case references_PEAR_ERROR_TRIGGER:
+			case references_PEAR_ERROR_DIE:
+			case null:
+				$def_mode    = $mode;
+				$def_options = $options;
+				break;
+
+			case references_PEAR_ERROR_CALLBACK:
+				$def_mode = $mode;
+				// class/object method callback
+				if (is_callable($options)) {
+					$def_options = $options;
+				} else {
+					trigger_error('invalid error callback', E_USER_WARNING);
+				}
+				break;
+
+			default:
+				trigger_error('invalid error mode', E_USER_WARNING);
+				break;
+		}
+		$stack[] = array($mode, $options);
+
+		return true;
+	}
+
+	public function staticPopErrorHandling()
+	{
+		$stack      = &$GLOBALS['_PEAR_error_handler_stack'];
+		$setmode    = &$GLOBALS['_PEAR_default_error_mode'];
+		$setoptions = &$GLOBALS['_PEAR_default_error_options'];
+		array_pop($stack);
+		list($mode, $options) = $stack[count($stack) - 1];
+		array_pop($stack);
+		switch ($mode) {
+			case references_PEAR_ERROR_EXCEPTION:
+			case references_PEAR_ERROR_RETURN:
+			case references_PEAR_ERROR_PRINT:
+			case references_PEAR_ERROR_TRIGGER:
+			case references_PEAR_ERROR_DIE:
+			case null:
+				$setmode    = $mode;
+				$setoptions = $options;
+				break;
+
+			case references_PEAR_ERROR_CALLBACK:
+				$setmode = $mode;
+				// class/object method callback
+				if (is_callable($options)) {
+					$setoptions = $options;
+				} else {
+					trigger_error('invalid error callback', E_USER_WARNING);
+				}
+				break;
+
+			default:
+				trigger_error('invalid error mode', E_USER_WARNING);
+				break;
+		}
+
+		return true;
+	}
+
+	// {{{ pushErrorHandling()
+
+	/**
+	 * Push a new error handler on top of the error handler options stack. With this
+	 * you can easily override the actual error handler for some code and restore
+	 * it later with popErrorHandling.
+	 *
+	 * @param mixed $mode    (same as setErrorHandling)
+	 * @param mixed $options (same as setErrorHandling)
+	 *
+	 * @return bool Always true
+	 *
+	 * @see references_PEAR::setErrorHandling
+	 */
+	public function pushErrorHandling($mode, $options = null)
+	{
+		$stack = &$GLOBALS['_PEAR_error_handler_stack'];
+		if (isset($this) && is_a($this, 'PEAR')) {
+			$def_mode    = &$this->_default_error_mode;
+			$def_options = &$this->_default_error_options;
+		} else {
+			$def_mode    = &$GLOBALS['_PEAR_default_error_mode'];
+			$def_options = &$GLOBALS['_PEAR_default_error_options'];
+		}
+		$stack[] = array($def_mode, $def_options);
+
+		if (isset($this) && is_a($this, 'PEAR')) {
+			$this->setErrorHandling($mode, $options);
+		} else {
+			references_PEAR::setErrorHandling($mode, $options);
+		}
+		$stack[] = array($mode, $options);
+
+		return true;
+	}
+
+	// }}}
+	// {{{ popErrorHandling()
+
+	/**
+	 * Pop the last error handler used
+	 *
+	 * @return bool Always true
+	 *
+	 * @see references_PEAR::pushErrorHandling
+	 */
+	public function popErrorHandling()
+	{
+		$stack = &$GLOBALS['_PEAR_error_handler_stack'];
+		array_pop($stack);
+		list($mode, $options) = $stack[count($stack) - 1];
+		array_pop($stack);
+		if (isset($this) && is_a($this, 'PEAR')) {
+			$this->setErrorHandling($mode, $options);
+		} else {
+			references_PEAR::setErrorHandling($mode, $options);
+		}
+
+		return true;
+	}
+
+	// }}}
+	// {{{ loadExtension()
+
+	/**
+	 * OS independant PHP extension load. Remember to take care
+	 * on the correct extension name for case sensitive OSes.
+	 *
+	 * @param string $ext The extension name
+	 * @return bool Success or not on the dl() call
+	 */
+	public function loadExtension($ext)
+	{
+		if (!extension_loaded($ext)) {
+			// if either returns true dl() will produce a FATAL error, stop that
+			if ((ini_get('enable_dl') != 1) || (ini_get('safe_mode') == 1)) {
+				return false;
+			}
+			if (references_OS_WINDOWS) {
+				$suffix = '.dll';
+			} elseif (PHP_OS === 'HP-UX') {
+				$suffix = '.sl';
+			} elseif (PHP_OS === 'AIX') {
+				$suffix = '.a';
+			} elseif (PHP_OS === 'OSX') {
+				$suffix = '.bundle';
+			} else {
+				$suffix = '.so';
+			}
+
+			return @dl('php_' . $ext . $suffix) || @dl($ext . $suffix);
+		}
+
+		return true;
+	}
+
+	// }}}
 }
 
 // {{{ _PEAR_call_destructors()
 
 function references_PEAR_call_destructors()
 {
-    global $_PEAR_destructor_object_list;
-    if (is_array($_PEAR_destructor_object_list)
-        && count($_PEAR_destructor_object_list)
-    ) {
-        reset($_PEAR_destructor_object_list);
-        if (references_PEAR::getStaticProperty('PEAR', 'destructlifo')) {
-            $_PEAR_destructor_object_list = array_reverse($_PEAR_destructor_object_list);
-        }
-        while (list($k, $objref) = each($_PEAR_destructor_object_list)) {
-            $classname = get_class($objref);
-            while ($classname) {
-                $destructor = "_$classname";
-                if (method_exists($objref, $destructor)) {
-                    $objref->$destructor();
-                    break;
-                } else {
-                    $classname = get_parent_class($classname);
-                }
-            }
-        }
-        // Empty the object list to ensure that destructors are
-        // not called more than once.
-        $_PEAR_destructor_object_list = array();
-    }
-
-    // Now call the shutdown functions
-    if (is_array($GLOBALS['_PEAR_shutdown_funcs']) and !empty($GLOBALS['_PEAR_shutdown_funcs'])) {
-        foreach ($GLOBALS['_PEAR_shutdown_funcs'] as $value) {
-            call_user_func_array($value[0], $value[1]);
-        }
-    }
+	global $_PEAR_destructor_object_list;
+	if (is_array($_PEAR_destructor_object_list)
+		&& count($_PEAR_destructor_object_list)
+	) {
+		reset($_PEAR_destructor_object_list);
+		if (references_PEAR::getStaticProperty('PEAR', 'destructlifo')) {
+			$_PEAR_destructor_object_list = array_reverse($_PEAR_destructor_object_list);
+		}
+		while (list($k, $objref) = each($_PEAR_destructor_object_list)) {
+			$classname = get_class($objref);
+			while ($classname) {
+				$destructor = "_$classname";
+				if (method_exists($objref, $destructor)) {
+					$objref->$destructor();
+					break;
+				} else {
+					$classname = get_parent_class($classname);
+				}
+			}
+		}
+		// Empty the object list to ensure that destructors are
+		// not called more than once.
+		$_PEAR_destructor_object_list = array();
+	}
+
+	// Now call the shutdown functions
+	if (is_array($GLOBALS['_PEAR_shutdown_funcs']) and !empty($GLOBALS['_PEAR_shutdown_funcs'])) {
+		foreach ($GLOBALS['_PEAR_shutdown_funcs'] as $value) {
+			call_user_func_array($value[0], $value[1]);
+		}
+	}
 }
 
 // }}}
@@ -829,274 +829,274 @@ 
  */
 class references_PEAR_Error
 {
-    // {{{ properties
-
-    public $error_message_prefix = '';
-    public $mode                 = references_PEAR_ERROR_RETURN;
-    public $level                = E_USER_NOTICE;
-    public $code                 = -1;
-    public $message              = '';
-    public $userinfo             = '';
-    public $backtrace            = null;
-
-    // }}}
-    // {{{ constructor
-
-    /**
-     * PEAR_Error constructor
-     *
-     * @param string $message  message
-     *
-     * @param int    $code     (optional) error code
-     *
-     * @param int    $mode     (optional) error mode, one of: references_PEAR_ERROR_RETURN,
-     *                         references_PEAR_ERROR_PRINT, references_PEAR_ERROR_DIE, references_PEAR_ERROR_TRIGGER,
-     *                         references_PEAR_ERROR_CALLBACK or references_PEAR_ERROR_EXCEPTION
-     *
-     * @param mixed  $options  (optional) error level, _OR_ in the case of
-     *                         references_PEAR_ERROR_CALLBACK, the callback function or object/method
-     *                         tuple.
-     *
-     * @param string $userinfo (optional) additional user/debug info
-     *
-     * @access public
-     *
-     */
-    public function __construct($message = 'unknown error', $code = null, $mode = null, $options = null, $userinfo = null)
-    {
-        if ($mode === null) {
-            $mode = references_PEAR_ERROR_RETURN;
-        }
-        $this->message  = $message;
-        $this->code     = $code;
-        $this->mode     = $mode;
-        $this->userinfo = $userinfo;
-        if (!references_PEAR::getStaticProperty('PEAR_Error', 'skiptrace')) {
-            $this->backtrace = debug_backtrace();
-            if (isset($this->backtrace[0]) && isset($this->backtrace[0]['object'])) {
-                unset($this->backtrace[0]['object']);
-            }
-        }
-        if ($mode & references_PEAR_ERROR_CALLBACK) {
-            $this->level    = E_USER_NOTICE;
-            $this->callback = $options;
-        } else {
-            if ($options === null) {
-                $options = E_USER_NOTICE;
-            }
-            $this->level    = $options;
-            $this->callback = null;
-        }
-        if ($this->mode & references_PEAR_ERROR_PRINT) {
-            if (is_null($options) || is_int($options)) {
-                $format = '%s';
-            } else {
-                $format = $options;
-            }
-            printf($format, $this->getMessage());
-        }
-        if ($this->mode & references_PEAR_ERROR_TRIGGER) {
-            trigger_error($this->getMessage(), $this->level);
-        }
-        if ($this->mode & references_PEAR_ERROR_DIE) {
-            $msg = $this->getMessage();
-            if (is_null($options) || is_int($options)) {
-                $format = '%s';
-                if (substr($msg, -1) !== "\n") {
-                    $msg .= "\n";
-                }
-            } else {
-                $format = $options;
-            }
-            die(sprintf($format, $msg));
-        }
-        if ($this->mode & references_PEAR_ERROR_CALLBACK) {
-            if (is_callable($this->callback)) {
-                call_user_func($this->callback, $this);
-            }
-        }
-        if ($this->mode & references_PEAR_ERROR_EXCEPTION) {
-            trigger_error('references_PEAR_ERROR_EXCEPTION is obsolete, use class PEAR_Exception for exceptions', E_USER_WARNING);
-            eval('$e = new Exception($this->message, $this->code);throw($e);');
-        }
-    }
-
-    // }}}
-    // {{{ getMode()
-
-    /**
-     * Get the error mode from an error object.
-     *
-     * @return int error mode
-     * @access public
-     */
-    public function getMode()
-    {
-        return $this->mode;
-    }
-
-    // }}}
-    // {{{ getCallback()
-
-    /**
-     * Get the callback function/method from an error object.
-     *
-     * @return mixed callback function or object/method array
-     * @access public
-     */
-    public function getCallback()
-    {
-        return $this->callback;
-    }
-
-    // }}}
-    // {{{ getMessage()
-
-    /**
-     * Get the error message from an error object.
-     *
-     * @return string full error message
-     * @access public
-     */
-    public function getMessage()
-    {
-        return ($this->error_message_prefix . $this->message);
-    }
-
-    // }}}
-    // {{{ getCode()
-
-    /**
-     * Get error code from an error object
-     *
-     * @return int error code
-     * @access public
-     */
-    public function getCode()
-    {
-        return $this->code;
-    }
-
-    // }}}
-    // {{{ getType()
-
-    /**
-     * Get the name of this error/exception.
-     *
-     * @return string error/exception name (type)
-     * @access public
-     */
-    public function getType()
-    {
-        return get_class($this);
-    }
-
-    // }}}
-    // {{{ getUserInfo()
-
-    /**
-     * Get additional user-supplied information.
-     *
-     * @return string user-supplied information
-     * @access public
-     */
-    public function getUserInfo()
-    {
-        return $this->userinfo;
-    }
-
-    // }}}
-    // {{{ getDebugInfo()
-
-    /**
-     * Get additional debug information supplied by the application.
-     *
-     * @return string debug information
-     * @access public
-     */
-    public function getDebugInfo()
-    {
-        return $this->getUserInfo();
-    }
-
-    // }}}
-    // {{{ getBacktrace()
-
-    /**
-     * Get the call backtrace from where the error was generated.
-     * Supported with PHP 4.3.0 or newer.
-     *
-     * @param  int $frame (optional) what frame to fetch
-     * @return array Backtrace, or NULL if not available.
-     * @access public
-     */
-    public function getBacktrace($frame = null)
-    {
-        if (defined('PEAR_IGNORE_BACKTRACE')) {
-            return null;
-        }
-        if ($frame === null) {
-            return $this->backtrace;
-        }
-
-        return $this->backtrace[$frame];
-    }
-
-    // }}}
-    // {{{ addUserInfo()
-
-    public function addUserInfo($info)
-    {
-        if (empty($this->userinfo)) {
-            $this->userinfo = $info;
-        } else {
-            $this->userinfo .= " ** $info";
-        }
-    }
-
-    // }}}
-    // {{{ toString()
-
-    /**
-     * Make a string representation of this object.
-     *
-     * @return string a string with an object summary
-     * @access public
-     */
-    public function toString()
-    {
-        $modes  = array();
-        $levels = array(
-            E_USER_NOTICE  => 'notice',
-            E_USER_WARNING => 'warning',
-            E_USER_ERROR   => 'error'
-        );
-        if ($this->mode & references_PEAR_ERROR_CALLBACK) {
-            if (is_array($this->callback)) {
-                $callback = (is_object($this->callback[0]) ? strtolower(get_class($this->callback[0])) : $this->callback[0]) . '::' . $this->callback[1];
-            } else {
-                $callback = $this->callback;
-            }
-
-            return sprintf('[%s: message="%s" code=%d mode=callback ' . 'callback=%s prefix="%s" info="%s"]', strtolower(get_class($this)), $this->message, $this->code, $callback, $this->error_message_prefix, $this->userinfo);
-        }
-        if ($this->mode & references_PEAR_ERROR_PRINT) {
-            $modes[] = 'print';
-        }
-        if ($this->mode & references_PEAR_ERROR_TRIGGER) {
-            $modes[] = 'trigger';
-        }
-        if ($this->mode & references_PEAR_ERROR_DIE) {
-            $modes[] = 'die';
-        }
-        if ($this->mode & references_PEAR_ERROR_RETURN) {
-            $modes[] = 'return';
-        }
-
-        return sprintf('[%s: message="%s" code=%d mode=%s level=%s ' . 'prefix="%s" info="%s"]', strtolower(get_class($this)), $this->message, $this->code, implode('|', $modes), $levels[$this->level], $this->error_message_prefix, $this->userinfo);
-    }
-
-    // }}}
+	// {{{ properties
+
+	public $error_message_prefix = '';
+	public $mode                 = references_PEAR_ERROR_RETURN;
+	public $level                = E_USER_NOTICE;
+	public $code                 = -1;
+	public $message              = '';
+	public $userinfo             = '';
+	public $backtrace            = null;
+
+	// }}}
+	// {{{ constructor
+
+	/**
+	 * PEAR_Error constructor
+	 *
+	 * @param string $message  message
+	 *
+	 * @param int    $code     (optional) error code
+	 *
+	 * @param int    $mode     (optional) error mode, one of: references_PEAR_ERROR_RETURN,
+	 *                         references_PEAR_ERROR_PRINT, references_PEAR_ERROR_DIE, references_PEAR_ERROR_TRIGGER,
+	 *                         references_PEAR_ERROR_CALLBACK or references_PEAR_ERROR_EXCEPTION
+	 *
+	 * @param mixed  $options  (optional) error level, _OR_ in the case of
+	 *                         references_PEAR_ERROR_CALLBACK, the callback function or object/method
+	 *                         tuple.
+	 *
+	 * @param string $userinfo (optional) additional user/debug info
+	 *
+	 * @access public
+	 *
+	 */
+	public function __construct($message = 'unknown error', $code = null, $mode = null, $options = null, $userinfo = null)
+	{
+		if ($mode === null) {
+			$mode = references_PEAR_ERROR_RETURN;
+		}
+		$this->message  = $message;
+		$this->code     = $code;
+		$this->mode     = $mode;
+		$this->userinfo = $userinfo;
+		if (!references_PEAR::getStaticProperty('PEAR_Error', 'skiptrace')) {
+			$this->backtrace = debug_backtrace();
+			if (isset($this->backtrace[0]) && isset($this->backtrace[0]['object'])) {
+				unset($this->backtrace[0]['object']);
+			}
+		}
+		if ($mode & references_PEAR_ERROR_CALLBACK) {
+			$this->level    = E_USER_NOTICE;
+			$this->callback = $options;
+		} else {
+			if ($options === null) {
+				$options = E_USER_NOTICE;
+			}
+			$this->level    = $options;
+			$this->callback = null;
+		}
+		if ($this->mode & references_PEAR_ERROR_PRINT) {
+			if (is_null($options) || is_int($options)) {
+				$format = '%s';
+			} else {
+				$format = $options;
+			}
+			printf($format, $this->getMessage());
+		}
+		if ($this->mode & references_PEAR_ERROR_TRIGGER) {
+			trigger_error($this->getMessage(), $this->level);
+		}
+		if ($this->mode & references_PEAR_ERROR_DIE) {
+			$msg = $this->getMessage();
+			if (is_null($options) || is_int($options)) {
+				$format = '%s';
+				if (substr($msg, -1) !== "\n") {
+					$msg .= "\n";
+				}
+			} else {
+				$format = $options;
+			}
+			die(sprintf($format, $msg));
+		}
+		if ($this->mode & references_PEAR_ERROR_CALLBACK) {
+			if (is_callable($this->callback)) {
+				call_user_func($this->callback, $this);
+			}
+		}
+		if ($this->mode & references_PEAR_ERROR_EXCEPTION) {
+			trigger_error('references_PEAR_ERROR_EXCEPTION is obsolete, use class PEAR_Exception for exceptions', E_USER_WARNING);
+			eval('$e = new Exception($this->message, $this->code);throw($e);');
+		}
+	}
+
+	// }}}
+	// {{{ getMode()
+
+	/**
+	 * Get the error mode from an error object.
+	 *
+	 * @return int error mode
+	 * @access public
+	 */
+	public function getMode()
+	{
+		return $this->mode;
+	}
+
+	// }}}
+	// {{{ getCallback()
+
+	/**
+	 * Get the callback function/method from an error object.
+	 *
+	 * @return mixed callback function or object/method array
+	 * @access public
+	 */
+	public function getCallback()
+	{
+		return $this->callback;
+	}
+
+	// }}}
+	// {{{ getMessage()
+
+	/**
+	 * Get the error message from an error object.
+	 *
+	 * @return string full error message
+	 * @access public
+	 */
+	public function getMessage()
+	{
+		return ($this->error_message_prefix . $this->message);
+	}
+
+	// }}}
+	// {{{ getCode()
+
+	/**
+	 * Get error code from an error object
+	 *
+	 * @return int error code
+	 * @access public
+	 */
+	public function getCode()
+	{
+		return $this->code;
+	}
+
+	// }}}
+	// {{{ getType()
+
+	/**
+	 * Get the name of this error/exception.
+	 *
+	 * @return string error/exception name (type)
+	 * @access public
+	 */
+	public function getType()
+	{
+		return get_class($this);
+	}
+
+	// }}}
+	// {{{ getUserInfo()
+
+	/**
+	 * Get additional user-supplied information.
+	 *
+	 * @return string user-supplied information
+	 * @access public
+	 */
+	public function getUserInfo()
+	{
+		return $this->userinfo;
+	}
+
+	// }}}
+	// {{{ getDebugInfo()
+
+	/**
+	 * Get additional debug information supplied by the application.
+	 *
+	 * @return string debug information
+	 * @access public
+	 */
+	public function getDebugInfo()
+	{
+		return $this->getUserInfo();
+	}
+
+	// }}}
+	// {{{ getBacktrace()
+
+	/**
+	 * Get the call backtrace from where the error was generated.
+	 * Supported with PHP 4.3.0 or newer.
+	 *
+	 * @param  int $frame (optional) what frame to fetch
+	 * @return array Backtrace, or NULL if not available.
+	 * @access public
+	 */
+	public function getBacktrace($frame = null)
+	{
+		if (defined('PEAR_IGNORE_BACKTRACE')) {
+			return null;
+		}
+		if ($frame === null) {
+			return $this->backtrace;
+		}
+
+		return $this->backtrace[$frame];
+	}
+
+	// }}}
+	// {{{ addUserInfo()
+
+	public function addUserInfo($info)
+	{
+		if (empty($this->userinfo)) {
+			$this->userinfo = $info;
+		} else {
+			$this->userinfo .= " ** $info";
+		}
+	}
+
+	// }}}
+	// {{{ toString()
+
+	/**
+	 * Make a string representation of this object.
+	 *
+	 * @return string a string with an object summary
+	 * @access public
+	 */
+	public function toString()
+	{
+		$modes  = array();
+		$levels = array(
+			E_USER_NOTICE  => 'notice',
+			E_USER_WARNING => 'warning',
+			E_USER_ERROR   => 'error'
+		);
+		if ($this->mode & references_PEAR_ERROR_CALLBACK) {
+			if (is_array($this->callback)) {
+				$callback = (is_object($this->callback[0]) ? strtolower(get_class($this->callback[0])) : $this->callback[0]) . '::' . $this->callback[1];
+			} else {
+				$callback = $this->callback;
+			}
+
+			return sprintf('[%s: message="%s" code=%d mode=callback ' . 'callback=%s prefix="%s" info="%s"]', strtolower(get_class($this)), $this->message, $this->code, $callback, $this->error_message_prefix, $this->userinfo);
+		}
+		if ($this->mode & references_PEAR_ERROR_PRINT) {
+			$modes[] = 'print';
+		}
+		if ($this->mode & references_PEAR_ERROR_TRIGGER) {
+			$modes[] = 'trigger';
+		}
+		if ($this->mode & references_PEAR_ERROR_DIE) {
+			$modes[] = 'die';
+		}
+		if ($this->mode & references_PEAR_ERROR_RETURN) {
+			$modes[] = 'return';
+		}
+
+		return sprintf('[%s: message="%s" code=%d mode=%s level=%s ' . 'prefix="%s" info="%s"]', strtolower(get_class($this)), $this->message, $this->code, implode('|', $modes), $levels[$this->level], $this->error_message_prefix, $this->userinfo);
+	}
+
+	// }}}
 }
 
 /*

Spacing +16 added lines, -16 removed lines

@@ -763,7 +763,7 @@ 
                 $suffix = '.so';
             }
 
-            return @dl('php_' . $ext . $suffix) || @dl($ext . $suffix);
+            return @dl('php_'.$ext.$suffix) || @dl($ext.$suffix);
         }
 
         return true;
@@ -877,7 +877,7 @@ 
                 unset($this->backtrace[0]['object']);
             }
         }
-        if ($mode & references_PEAR_ERROR_CALLBACK) {
+        if ($mode&references_PEAR_ERROR_CALLBACK) {
             $this->level    = E_USER_NOTICE;
             $this->callback = $options;
         } else {
@@ -887,7 +887,7 @@ 
             $this->level    = $options;
             $this->callback = null;
         }
-        if ($this->mode & references_PEAR_ERROR_PRINT) {
+        if ($this->mode&references_PEAR_ERROR_PRINT) {
             if (is_null($options) || is_int($options)) {
                 $format = '%s';
             } else {
@@ -895,10 +895,10 @@ 
             }
             printf($format, $this->getMessage());
         }
-        if ($this->mode & references_PEAR_ERROR_TRIGGER) {
+        if ($this->mode&references_PEAR_ERROR_TRIGGER) {
             trigger_error($this->getMessage(), $this->level);
         }
-        if ($this->mode & references_PEAR_ERROR_DIE) {
+        if ($this->mode&references_PEAR_ERROR_DIE) {
             $msg = $this->getMessage();
             if (is_null($options) || is_int($options)) {
                 $format = '%s';
@@ -910,12 +910,12 @@ 
             }
             die(sprintf($format, $msg));
         }
-        if ($this->mode & references_PEAR_ERROR_CALLBACK) {
+        if ($this->mode&references_PEAR_ERROR_CALLBACK) {
             if (is_callable($this->callback)) {
                 call_user_func($this->callback, $this);
             }
         }
-        if ($this->mode & references_PEAR_ERROR_EXCEPTION) {
+        if ($this->mode&references_PEAR_ERROR_EXCEPTION) {
             trigger_error('references_PEAR_ERROR_EXCEPTION is obsolete, use class PEAR_Exception for exceptions', E_USER_WARNING);
             eval('$e = new Exception($this->message, $this->code);throw($e);');
         }
@@ -960,7 +960,7 @@ 
      */
     public function getMessage()
     {
-        return ($this->error_message_prefix . $this->message);
+        return ($this->error_message_prefix.$this->message);
     }
 
     // }}}
@@ -1071,29 +1071,29 @@ 
             E_USER_WARNING => 'warning',
             E_USER_ERROR   => 'error'
         );
-        if ($this->mode & references_PEAR_ERROR_CALLBACK) {
+        if ($this->mode&references_PEAR_ERROR_CALLBACK) {
             if (is_array($this->callback)) {
-                $callback = (is_object($this->callback[0]) ? strtolower(get_class($this->callback[0])) : $this->callback[0]) . '::' . $this->callback[1];
+                $callback = (is_object($this->callback[0]) ? strtolower(get_class($this->callback[0])) : $this->callback[0]).'::'.$this->callback[1];
             } else {
                 $callback = $this->callback;
             }
 
-            return sprintf('[%s: message="%s" code=%d mode=callback ' . 'callback=%s prefix="%s" info="%s"]', strtolower(get_class($this)), $this->message, $this->code, $callback, $this->error_message_prefix, $this->userinfo);
+            return sprintf('[%s: message="%s" code=%d mode=callback '.'callback=%s prefix="%s" info="%s"]', strtolower(get_class($this)), $this->message, $this->code, $callback, $this->error_message_prefix, $this->userinfo);
         }
-        if ($this->mode & references_PEAR_ERROR_PRINT) {
+        if ($this->mode&references_PEAR_ERROR_PRINT) {
             $modes[] = 'print';
         }
-        if ($this->mode & references_PEAR_ERROR_TRIGGER) {
+        if ($this->mode&references_PEAR_ERROR_TRIGGER) {
             $modes[] = 'trigger';
         }
-        if ($this->mode & references_PEAR_ERROR_DIE) {
+        if ($this->mode&references_PEAR_ERROR_DIE) {
             $modes[] = 'die';
         }
-        if ($this->mode & references_PEAR_ERROR_RETURN) {
+        if ($this->mode&references_PEAR_ERROR_RETURN) {
             $modes[] = 'return';
         }
 
-        return sprintf('[%s: message="%s" code=%d mode=%s level=%s ' . 'prefix="%s" info="%s"]', strtolower(get_class($this)), $this->message, $this->code, implode('|', $modes), $levels[$this->level], $this->error_message_prefix, $this->userinfo);
+        return sprintf('[%s: message="%s" code=%d mode=%s level=%s '.'prefix="%s" info="%s"]', strtolower(get_class($this)), $this->message, $this->code, implode('|', $modes), $levels[$this->level], $this->error_message_prefix, $this->userinfo);
     }
 
     // }}}

class/PersistableObjectHandler.php

Doc Comments +2 added lines, -2 removed lines

@@ -235,7 +235,7 @@ 
      * @param boolean $as_object
      * @param string  $fields    Requested fields from the query
      *
-     * @return array
+     * @return string
      */
     protected function convertResultSet($result, $id_as_key = false, $as_object = true, $fields = '*')
     {
@@ -502,7 +502,7 @@ 
     /**
      * delete an object from the database
      *
-     * @param  XoopsObject $obj reference to the object to delete
+     * @param  references_articles $obj reference to the object to delete
      * @param  bool        $force
      * @return bool   FALSE if failed.
      */

Spacing +59 added lines, -59 removed lines

@@ -129,7 +129,7 @@ 
      */
     protected function _getIdForCache($query, $start, $limit)
     {
-        $id = md5($query . '-' . (string)$start . '-' . (string)$limit);
+        $id = md5($query.'-'.(string) $start.'-'.(string) $limit);
 
         return $id;
     }
@@ -164,17 +164,17 @@ 
             $criteria = new CriteriaCompo();
             $vnb      = count($this->keyName);
             for ($i = 0; $i < $vnb; ++$i) {
-                $criteria->add(new Criteria($this->keyName[$i], (int)$id[$i]));
+                $criteria->add(new Criteria($this->keyName[$i], (int) $id[$i]));
             }
         } else {
-            $criteria = new Criteria($this->keyName, (int)$id);
+            $criteria = new Criteria($this->keyName, (int) $id);
         }
         $criteria->setLimit(1);
-        $obj_array =& $this->getObjects($criteria, false, $as_object);
+        $obj_array = & $this->getObjects($criteria, false, $as_object);
         if (count($obj_array) != 1) {
             $ret = null;
         } else {
-            $ret =& $obj_array[0];
+            $ret = & $obj_array[0];
         }
 
         return $ret;
@@ -193,19 +193,19 @@ 
      */
     public function &getObjects(CriteriaElement $criteria = null, $id_as_key = false, $as_object = true, $fields = '*', $autoSort = true)
     {
-        require_once __DIR__ . '/lite.php';
+        require_once __DIR__.'/lite.php';
         $ret   = array();
         $limit = $start = 0;
-        $sql   = 'SELECT ' . $fields . ' FROM ' . $this->table;
+        $sql   = 'SELECT '.$fields.' FROM '.$this->table;
         if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
-            $sql .= ' ' . $criteria->renderWhere();
+            $sql .= ' '.$criteria->renderWhere();
             if ($criteria->groupby != '') {
                 $sql .= $criteria->getGroupby();
             }
             if ($criteria->getSort() != '') {
-                $sql .= ' ORDER BY ' . $criteria->getSort() . ' ' . $criteria->getOrder();
+                $sql .= ' ORDER BY '.$criteria->getSort().' '.$criteria->getOrder();
             } elseif ($this->identifierName != '' && $autoSort) {
-                $sql .= ' ORDER BY ' . $this->identifierName;
+                $sql .= ' ORDER BY '.$this->identifierName;
             }
             $limit = $criteria->getLimit();
             $start = $criteria->getStart();
@@ -241,11 +241,11 @@ 
     {
         $ret = array();
         while ($myrow = $this->db->fetchArray($result)) {
-            $obj =& $this->create(false);
+            $obj = & $this->create(false);
             $obj->assignVars($myrow);
             if (!$id_as_key) {
                 if ($as_object) {
-                    $ret[] =& $obj;
+                    $ret[] = & $obj;
                 } else {
                     $row     = array();
                     $vars    = $obj->getVars();
@@ -258,9 +258,9 @@ 
             } else {
                 if ($as_object) {
                     if ($fields === '*') {
-                        $ret[$myrow[$this->keyName]] =& $obj;
+                        $ret[$myrow[$this->keyName]] = & $obj;
                     } else {
-                        $ret[] =& $obj;
+                        $ret[] = & $obj;
                     }
                 } else {
                     $row     = array();
@@ -286,20 +286,20 @@ 
      */
     public function getIds($criteria = null)
     {
-        require_once __DIR__ . '/lite.php';
+        require_once __DIR__.'/lite.php';
         $limit = $start = 0;
 
         $Cache_Lite = new references_Cache_Lite($this->cacheOptions);
-        $sql        = 'SELECT ' . $this->keyName . ' FROM ' . $this->table;
+        $sql        = 'SELECT '.$this->keyName.' FROM '.$this->table;
         if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
-            $sql .= ' ' . $criteria->renderWhere();
+            $sql .= ' '.$criteria->renderWhere();
             if ($criteria->groupby != '') {
                 $sql .= $criteria->getGroupby();
             }
             if ($criteria->getSort() != '') {
-                $sql .= ' ORDER BY ' . $criteria->getSort() . ' ' . $criteria->getOrder();
+                $sql .= ' ORDER BY '.$criteria->getSort().' '.$criteria->getOrder();
             } elseif ($this->identifierName != '') {
-                $sql .= ' ORDER BY ' . $this->identifierName;
+                $sql .= ' ORDER BY '.$this->identifierName;
             }
             $limit = $criteria->getLimit();
             $start = $criteria->getStart();
@@ -329,26 +329,26 @@ 
      */
     public function getList($criteria = null)
     {
-        require_once __DIR__ . '/lite.php';
+        require_once __DIR__.'/lite.php';
         $limit      = $start = 0;
         $Cache_Lite = new references_Cache_Lite($this->cacheOptions);
 
         $ret = array();
 
-        $sql = 'SELECT ' . $this->keyName;
+        $sql = 'SELECT '.$this->keyName;
         if (!empty($this->identifierName)) {
-            $sql .= ', ' . $this->identifierName;
+            $sql .= ', '.$this->identifierName;
         }
-        $sql .= ' FROM ' . $this->table;
+        $sql .= ' FROM '.$this->table;
         if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
-            $sql .= ' ' . $criteria->renderWhere();
+            $sql .= ' '.$criteria->renderWhere();
             if ($criteria->groupby != '') {
                 $sql .= $criteria->getGroupby();
             }
             if ($criteria->getSort() != '') {
-                $sql .= ' ORDER BY ' . $criteria->getSort() . ' ' . $criteria->getOrder();
+                $sql .= ' ORDER BY '.$criteria->getSort().' '.$criteria->getOrder();
             } elseif ($this->identifierName != '') {
-                $sql .= ' ORDER BY ' . $this->identifierName;
+                $sql .= ' ORDER BY '.$this->identifierName;
             }
             $limit = $criteria->getLimit();
             $start = $criteria->getStart();
@@ -389,11 +389,11 @@ 
         $ret = array();
         if (is_array($ids) && count($ids) > 0) {
             $criteria = new CriteriaCompo();
-            $criteria->add(new Criteria($this->keyName, '(' . implode(',', $ids) . ')', 'IN'));
+            $criteria->add(new Criteria($this->keyName, '('.implode(',', $ids).')', 'IN'));
             if (!is_null($additionnal)) {
                 $criteria->add($additionnal);
             }
-            $ret =& $this->getObjects($criteria, true);
+            $ret = & $this->getObjects($criteria, true);
         }
 
         return $ret;
@@ -410,17 +410,17 @@ 
         $field   = '';
         $groupby = false;
         $limit   = $start = 0;
-        require_once __DIR__ . '/lite.php';
+        require_once __DIR__.'/lite.php';
 
         if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
             if ($criteria->groupby != '') {
                 $groupby = true;
-                $field   = $criteria->groupby . ', '; //Not entirely secure unless you KNOW that no criteria's groupby clause is going to be mis-used
+                $field   = $criteria->groupby.', '; //Not entirely secure unless you KNOW that no criteria's groupby clause is going to be mis-used
             }
         }
-        $sql = 'SELECT ' . $field . 'COUNT(*) FROM ' . $this->table;
+        $sql = 'SELECT '.$field.'COUNT(*) FROM '.$this->table;
         if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
-            $sql .= ' ' . $criteria->renderWhere();
+            $sql .= ' '.$criteria->renderWhere();
             if ($criteria->groupby != '') {
                 $sql .= $criteria->getGroupby();
             }
@@ -467,11 +467,11 @@ 
     public function getSum($field, $criteria = null)
     {
         $limit = $start = 0;
-        require_once __DIR__ . '/lite.php';
+        require_once __DIR__.'/lite.php';
 
-        $sql = 'SELECT Sum(' . $field . ') as cpt FROM ' . $this->table;
+        $sql = 'SELECT Sum('.$field.') as cpt FROM '.$this->table;
         if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
-            $sql .= ' ' . $criteria->renderWhere();
+            $sql .= ' '.$criteria->renderWhere();
             if ($criteria->groupby != '') {
                 $sql .= $criteria->getGroupby();
             }
@@ -512,13 +512,13 @@ 
             $clause = array();
             $vnb    = count($this->keyName);
             for ($i = 0; $i < $vnb; ++$i) {
-                $clause[] = $this->keyName[$i] . ' = ' . $obj->getVar($this->keyName[$i]);
+                $clause[] = $this->keyName[$i].' = '.$obj->getVar($this->keyName[$i]);
             }
             $whereclause = implode(' AND ', $clause);
         } else {
-            $whereclause = $this->keyName . ' = ' . $obj->getVar($this->keyName);
+            $whereclause = $this->keyName.' = '.$obj->getVar($this->keyName);
         }
-        $sql = 'DELETE FROM ' . $this->table . ' WHERE ' . $whereclause;
+        $sql = 'DELETE FROM '.$this->table.' WHERE '.$whereclause;
         if (false != $force) {
             $result = $this->db->queryF($sql);
         } else {
@@ -545,7 +545,7 @@ 
     {
         $object = $this->create(true);
         $object->setVars($vars);
-        $retval =& $this->insert($object, $force);
+        $retval = & $this->insert($object, $force);
         unset($object);
 
         // Clear cache
@@ -576,7 +576,7 @@ 
              * @TODO: Change to if (!(class_exists($this->className) && $obj instanceof $this->className)) when going fully PHP5
              */
             if (!is_a($obj, $this->className)) {
-                $obj->setErrors(get_class($obj) . ' Differs from ' . $this->className);
+                $obj->setErrors(get_class($obj).' Differs from '.$this->className);
 
                 return false;
             }
@@ -595,7 +595,7 @@ 
         }
         foreach ($obj->cleanVars as $k => $v) {
             if ($obj->vars[$k]['data_type'] == XOBJ_DTYPE_INT) {
-                $cleanvars[$k] = (int)$v;
+                $cleanvars[$k] = (int) $v;
             } elseif (is_array($v)) {
                 $cleanvars[$k] = $this->db->quoteString(implode(',', $v));
             } else {
@@ -608,16 +608,16 @@ 
         if ($obj->isNew()) {
             if (!is_array($this->keyName)) {
                 if ($cleanvars[$this->keyName] < 1) {
-                    $cleanvars[$this->keyName] = $this->db->genId($this->table . '_' . $this->keyName . '_seq');
+                    $cleanvars[$this->keyName] = $this->db->genId($this->table.'_'.$this->keyName.'_seq');
                 }
             }
             $ignore = '';
             if ($ignoreInsert) {
                 $ignore = 'IGNORE';
             }
-            $sql = "INSERT $ignore INTO " . $this->table . ' (' . implode(',', array_keys($cleanvars)) . ') VALUES (' . implode(',', array_values($cleanvars)) . ')';
+            $sql = "INSERT $ignore INTO ".$this->table.' ('.implode(',', array_keys($cleanvars)).') VALUES ('.implode(',', array_values($cleanvars)).')';
         } else {
-            $sql = 'UPDATE ' . $this->table . ' SET';
+            $sql = 'UPDATE '.$this->table.' SET';
             foreach ($cleanvars as $key => $value) {
                 if ((!is_array($this->keyName) && $key == $this->keyName) || (is_array($this->keyName) && in_array($key, $this->keyName))) {
                     continue;
@@ -625,7 +625,7 @@ 
                 if (isset($notfirst)) {
                     $sql .= ',';
                 }
-                $sql .= ' ' . $key . ' = ' . $value;
+                $sql .= ' '.$key.' = '.$value;
                 $notfirst = true;
             }
             if (is_array($this->keyName)) {
@@ -635,12 +635,12 @@ 
                     if ($i > 0) {
                         $whereclause .= ' AND ';
                     }
-                    $whereclause .= $this->keyName[$i] . ' = ' . $obj->getVar($this->keyName[$i]);
+                    $whereclause .= $this->keyName[$i].' = '.$obj->getVar($this->keyName[$i]);
                 }
             } else {
-                $whereclause = $this->keyName . ' = ' . $obj->getVar($this->keyName);
+                $whereclause = $this->keyName.' = '.$obj->getVar($this->keyName);
             }
-            $sql .= ' WHERE ' . $whereclause;
+            $sql .= ' WHERE '.$whereclause;
         }
 
         if (false != $force) {
@@ -674,7 +674,7 @@ 
      */
     public function updateAll($fieldname, $fieldvalue, $criteria = null, $force = false)
     {
-        $set_clause = $fieldname . ' = ';
+        $set_clause = $fieldname.' = ';
         if (is_numeric($fieldvalue)) {
             $set_clause .= $fieldvalue;
         } elseif (is_array($fieldvalue)) {
@@ -682,9 +682,9 @@ 
         } else {
             $set_clause .= $this->db->quoteString($fieldvalue);
         }
-        $sql = 'UPDATE ' . $this->table . ' SET ' . $set_clause;
+        $sql = 'UPDATE '.$this->table.' SET '.$set_clause;
         if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
-            $sql .= ' ' . $criteria->renderWhere();
+            $sql .= ' '.$criteria->renderWhere();
         }
         if ($force) {
             $result = $this->db->queryF($sql);
@@ -732,8 +732,8 @@ 
     public function deleteAll($criteria = null)
     {
         if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
-            $sql = 'DELETE FROM ' . $this->table;
-            $sql .= ' ' . $criteria->renderWhere();
+            $sql = 'DELETE FROM '.$this->table;
+            $sql .= ' '.$criteria->renderWhere();
             if (!$this->db->queryF($sql)) {
                 return false;
             }
@@ -779,15 +779,15 @@ 
      */
     public function getDistincts($field, $criteria = null, $format = 's')
     {
-        require_once __DIR__ . '/lite.php';
+        require_once __DIR__.'/lite.php';
         $limit = $start = 0;
-        $sql   = 'SELECT ' . $this->keyName . ', ' . $field . ' FROM ' . $this->table;
+        $sql   = 'SELECT '.$this->keyName.', '.$field.' FROM '.$this->table;
         if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
-            $sql .= ' ' . $criteria->renderWhere();
+            $sql .= ' '.$criteria->renderWhere();
             $limit = $criteria->getLimit();
             $start = $criteria->getStart();
         }
-        $sql .= ' GROUP BY ' . $field . ' ORDER BY ' . $field;
+        $sql .= ' GROUP BY '.$field.' ORDER BY '.$field;
 
         $Cache_Lite = new references_Cache_Lite($this->cacheOptions);
         $id         = $this->_getIdForCache($sql, $start, $limit);
@@ -835,7 +835,7 @@ 
         $critere->setStart($start);
         $critere->setSort($sort);
         $critere->setOrder($order);
-        $items =& $this->getObjects($critere, $idAsKey);
+        $items = & $this->getObjects($critere, $idAsKey);
 
         return $items;
     }
@@ -845,7 +845,7 @@ 
      */
     public function forceCacheClean()
     {
-        require_once __DIR__ . '/lite.php';
+        require_once __DIR__.'/lite.php';
         $Cache_Lite = new references_Cache_Lite($this->cacheOptions);
         $Cache_Lite->clean();
     }

Indentation +808 added lines, -808 removed lines

@@ -25,44 +25,44 @@ 
 
 class references_Object extends XoopsObject
 {
-    public function toArray($format = 's')
-    {
-        $ret = array();
-        foreach ($this->vars as $k => $v) {
-            $ret[$k] = $this->getVar($k, $format);
-        }
-
-        return $ret;
-    }
-
-    // TODO: Rajouter une méthode intsert() et delete()
-
-    /**
-     * Permet de valoriser un champ de la table comme si c'était une propriété de la classe
-     *
-     * @example $enregistrement->nom_du_champ = 'ma chaine'
-     *
-     * @param string $key   Le nom du champ à traiter
-     * @param mixed  $value La valeur à lui attribuer
-     * @return void
-     */
-    public function __set($key, $value)
-    {
-        return $this->setVar($key, $value);
-    }
-
-    /**
-     * Permet d'accéder aux champs de la table comme à des propriétés de la classe
-     *
-     * @example echo $enregistrement->nom_du_champ;
-     *
-     * @param string $key Le nom du champ que l'on souhaite récupérer
-     * @return mixed
-     */
-    public function __get($key)
-    {
-        return $this->getVar($key);
-    }
+	public function toArray($format = 's')
+	{
+		$ret = array();
+		foreach ($this->vars as $k => $v) {
+			$ret[$k] = $this->getVar($k, $format);
+		}
+
+		return $ret;
+	}
+
+	// TODO: Rajouter une méthode intsert() et delete()
+
+	/**
+	 * Permet de valoriser un champ de la table comme si c'était une propriété de la classe
+	 *
+	 * @example $enregistrement->nom_du_champ = 'ma chaine'
+	 *
+	 * @param string $key   Le nom du champ à traiter
+	 * @param mixed  $value La valeur à lui attribuer
+	 * @return void
+	 */
+	public function __set($key, $value)
+	{
+		return $this->setVar($key, $value);
+	}
+
+	/**
+	 * Permet d'accéder aux champs de la table comme à des propriétés de la classe
+	 *
+	 * @example echo $enregistrement->nom_du_champ;
+	 *
+	 * @param string $key Le nom du champ que l'on souhaite récupérer
+	 * @return mixed
+	 */
+	public function __get($key)
+	{
+		return $this->getVar($key);
+	}
 }
 
 /**
@@ -73,778 +73,778 @@ 
  */
 class references_XoopsPersistableObjectHandler extends XoopsObjectHandler
 {
-    /**#@+
+	/**#@+
      * Information about the class, the handler is managing
      *
      * @var string
      */
-    public    $table;
-    public    $keyName;
-    public    $className;
-    public    $identifierName;
-    protected $cacheOptions = array();
-    /**#@-*/
-
-    /**
-     * Constructor - called from child classes
-     * @param object $db           {@link XoopsDatabase} object
-     * @param string $tablename    Name of database table
-     * @param string $classname    Name of Class, this handler is managing
-     * @param string $keyname      Name of the property, holding the key
-     * @param string $idenfierName Name of the property, holding the label
-     * @param array  $cacheOptions Optional, options for the cache
-     *
-     */
-    public function __construct(&$db, $tablename, $classname, $keyname, $idenfierName = '', $cacheOptions = null)
-    {
-        parent::__construct($db);
-        $this->table     = $db->prefix($tablename);
-        $this->keyName   = $keyname;
-        $this->className = $classname;
-        if (trim($idenfierName) != '') {
-            $this->identifierName = $idenfierName;
-        }
-        // To diable cache, add this line after the first one : 'caching' => false,
-        if (is_null($cacheOptions)) {
-            $this->setCachingOptions(array('cacheDir' => REFERENCES_CACHE_PATH, 'lifeTime' => null, 'automaticSerialization' => true, 'fileNameProtection' => false));
-        } else {
-            $this->setCachingOptions($cacheOptions);
-        }
-    }
-
-    public function setCachingOptions($cacheOptions)
-    {
-        $this->cacheOptions = $cacheOptions;
-    }
-
-    /**
-     * Generates a unique ID for a Sql Query
-     *
-     * @param  string  $query The SQL query for which we want a unidque ID
-     * @param  integer $start Which record to start at
-     * @param  integer $limit Max number of objects to fetch
-     * @return string  An MD5 of the query
-     */
-    protected function _getIdForCache($query, $start, $limit)
-    {
-        $id = md5($query . '-' . (string)$start . '-' . (string)$limit);
-
-        return $id;
-    }
-
-    /**
-     * create a new object
-     *
-     * @param bool $isNew Flag the new objects as "new"?
-     *
-     * @return object
-     */
-    public function &create($isNew = true)
-    {
-        $obj = new $this->className();
-        if ($isNew === true) {
-            $obj->setNew();
-        }
-
-        return $obj;
-    }
-
-    /**
-     * retrieve an object
-     *
-     * @param  mixed $id        ID of the object - or array of ids for joint keys. Joint keys MUST be given in the same order as in the constructor
-     * @param  bool  $as_object whether to return an object or an array
-     * @return mixed reference to the object, FALSE if failed
-     */
-    public function &get($id, $as_object = true)
-    {
-        if (is_array($this->keyName)) {
-            $criteria = new CriteriaCompo();
-            $vnb      = count($this->keyName);
-            for ($i = 0; $i < $vnb; ++$i) {
-                $criteria->add(new Criteria($this->keyName[$i], (int)$id[$i]));
-            }
-        } else {
-            $criteria = new Criteria($this->keyName, (int)$id);
-        }
-        $criteria->setLimit(1);
-        $obj_array =& $this->getObjects($criteria, false, $as_object);
-        if (count($obj_array) != 1) {
-            $ret = null;
-        } else {
-            $ret =& $obj_array[0];
-        }
-
-        return $ret;
-    }
-
-    /**
-     * retrieve objects from the database
-     *
-     * @param null|CriteriaElement $criteria  {@link CriteriaElement} conditions to be met
-     * @param bool                 $id_as_key use the ID as key for the array?
-     * @param bool                 $as_object return an array of objects?
-     *
-     * @param string               $fields
-     * @param bool                 $autoSort
-     * @return array
-     */
-    public function &getObjects(CriteriaElement $criteria = null, $id_as_key = false, $as_object = true, $fields = '*', $autoSort = true)
-    {
-        require_once __DIR__ . '/lite.php';
-        $ret   = array();
-        $limit = $start = 0;
-        $sql   = 'SELECT ' . $fields . ' FROM ' . $this->table;
-        if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
-            $sql .= ' ' . $criteria->renderWhere();
-            if ($criteria->groupby != '') {
-                $sql .= $criteria->getGroupby();
-            }
-            if ($criteria->getSort() != '') {
-                $sql .= ' ORDER BY ' . $criteria->getSort() . ' ' . $criteria->getOrder();
-            } elseif ($this->identifierName != '' && $autoSort) {
-                $sql .= ' ORDER BY ' . $this->identifierName;
-            }
-            $limit = $criteria->getLimit();
-            $start = $criteria->getStart();
-        }
-        $Cache_Lite = new references_Cache_Lite($this->cacheOptions);
-        $id         = $this->_getIdForCache($sql, $start, $limit);
-        $cacheData  = $Cache_Lite->get($id);
-        if ($cacheData === false) {
-            $result = $this->db->query($sql, $limit, $start);
-            if (!$result) {
-                return $ret;
-            }
-            $ret = $this->convertResultSet($result, $id_as_key, $as_object, $fields);
-            $Cache_Lite->save($ret);
-
-            return $ret;
-        } else {
-            return $cacheData;
-        }
-    }
-
-    /**
-     * Convert a database resultset to a returnable array
-     *
-     * @param object  $result    database resultset
-     * @param boolean $id_as_key - should NOT be used with joint keys
-     * @param boolean $as_object
-     * @param string  $fields    Requested fields from the query
-     *
-     * @return array
-     */
-    protected function convertResultSet($result, $id_as_key = false, $as_object = true, $fields = '*')
-    {
-        $ret = array();
-        while ($myrow = $this->db->fetchArray($result)) {
-            $obj =& $this->create(false);
-            $obj->assignVars($myrow);
-            if (!$id_as_key) {
-                if ($as_object) {
-                    $ret[] =& $obj;
-                } else {
-                    $row     = array();
-                    $vars    = $obj->getVars();
-                    $tbl_tmp = array_keys($vars);
-                    foreach ($tbl_tmp as $i) {
-                        $row[$i] = $obj->getVar($i);
-                    }
-                    $ret[] = $row;
-                }
-            } else {
-                if ($as_object) {
-                    if ($fields === '*') {
-                        $ret[$myrow[$this->keyName]] =& $obj;
-                    } else {
-                        $ret[] =& $obj;
-                    }
-                } else {
-                    $row     = array();
-                    $vars    = $obj->getVars();
-                    $tbl_tmp = array_keys($vars);
-                    foreach ($tbl_tmp as $i) {
-                        $row[$i] = $obj->getVar($i);
-                    }
-                    $ret[$myrow[$this->keyName]] = $row;
-                }
-            }
-            unset($obj);
-        }
-
-        return $ret;
-    }
-
-    /**
-     * get IDs of objects matching a condition
-     *
-     * @param  object $criteria {@link CriteriaElement} to match
-     * @return array  of object IDs
-     */
-    public function getIds($criteria = null)
-    {
-        require_once __DIR__ . '/lite.php';
-        $limit = $start = 0;
-
-        $Cache_Lite = new references_Cache_Lite($this->cacheOptions);
-        $sql        = 'SELECT ' . $this->keyName . ' FROM ' . $this->table;
-        if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
-            $sql .= ' ' . $criteria->renderWhere();
-            if ($criteria->groupby != '') {
-                $sql .= $criteria->getGroupby();
-            }
-            if ($criteria->getSort() != '') {
-                $sql .= ' ORDER BY ' . $criteria->getSort() . ' ' . $criteria->getOrder();
-            } elseif ($this->identifierName != '') {
-                $sql .= ' ORDER BY ' . $this->identifierName;
-            }
-            $limit = $criteria->getLimit();
-            $start = $criteria->getStart();
-        }
-
-        $id        = $this->_getIdForCache($sql, $start, $limit);
-        $cacheData = $Cache_Lite->get($id);
-        if ($cacheData === false) {
-            $result = $this->db->query($sql, $limit, $start);
-            $ret    = array();
-            while ($myrow = $this->db->fetchArray($result)) {
-                $ret[] = $myrow[$this->keyName];
-            }
-            $Cache_Lite->save($ret);
-
-            return $ret;
-        } else {
-            return $cacheData;
-        }
-    }
-
-    /**
-     * Retrieve a list of objects as arrays - DON'T USE WITH JOINT KEYS
-     *
-     * @param object $criteria {@link CriteriaElement} conditions to be met
-     * @return array
-     */
-    public function getList($criteria = null)
-    {
-        require_once __DIR__ . '/lite.php';
-        $limit      = $start = 0;
-        $Cache_Lite = new references_Cache_Lite($this->cacheOptions);
-
-        $ret = array();
-
-        $sql = 'SELECT ' . $this->keyName;
-        if (!empty($this->identifierName)) {
-            $sql .= ', ' . $this->identifierName;
-        }
-        $sql .= ' FROM ' . $this->table;
-        if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
-            $sql .= ' ' . $criteria->renderWhere();
-            if ($criteria->groupby != '') {
-                $sql .= $criteria->getGroupby();
-            }
-            if ($criteria->getSort() != '') {
-                $sql .= ' ORDER BY ' . $criteria->getSort() . ' ' . $criteria->getOrder();
-            } elseif ($this->identifierName != '') {
-                $sql .= ' ORDER BY ' . $this->identifierName;
-            }
-            $limit = $criteria->getLimit();
-            $start = $criteria->getStart();
-        }
-
-        $id        = $this->_getIdForCache($sql, $start, $limit);
-        $cacheData = $Cache_Lite->get($id);
-        if ($cacheData === false) {
-            $result = $this->db->query($sql, $limit, $start);
-            if (!$result) {
-                $Cache_Lite->save($ret);
-
-                return $ret;
-            }
-
-            $myts = MyTextSanitizer::getInstance();
-            while ($myrow = $this->db->fetchArray($result)) {
-                //identifiers should be textboxes, so sanitize them like that
-                $ret[$myrow[$this->keyName]] = empty($this->identifierName) ? 1 : $myts->htmlSpecialChars($myrow[$this->identifierName]);
-            }
-            $Cache_Lite->save($ret);
-
-            return $ret;
-        } else {
-            return $cacheData;
-        }
-    }
-
-    /**
-     * Retourne des éléments selon leur ID
-     *
-     * @param array $ids Les ID des éléments à retrouver
-     * @param null  $additionnal
-     * @return array Tableau d'objets
-     */
-    public function getItemsFromIds($ids, $additionnal = null)
-    {
-        $ret = array();
-        if (is_array($ids) && count($ids) > 0) {
-            $criteria = new CriteriaCompo();
-            $criteria->add(new Criteria($this->keyName, '(' . implode(',', $ids) . ')', 'IN'));
-            if (!is_null($additionnal)) {
-                $criteria->add($additionnal);
-            }
-            $ret =& $this->getObjects($criteria, true);
-        }
-
-        return $ret;
-    }
-
-    /**
-     * count objects matching a condition
-     *
-     * @param  object $criteria {@link CriteriaElement} to match
-     * @return int    count of objects
-     */
-    public function getCount($criteria = null)
-    {
-        $field   = '';
-        $groupby = false;
-        $limit   = $start = 0;
-        require_once __DIR__ . '/lite.php';
-
-        if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
-            if ($criteria->groupby != '') {
-                $groupby = true;
-                $field   = $criteria->groupby . ', '; //Not entirely secure unless you KNOW that no criteria's groupby clause is going to be mis-used
-            }
-        }
-        $sql = 'SELECT ' . $field . 'COUNT(*) FROM ' . $this->table;
-        if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
-            $sql .= ' ' . $criteria->renderWhere();
-            if ($criteria->groupby != '') {
-                $sql .= $criteria->getGroupby();
-            }
-            $limit = $criteria->getLimit();
-            $start = $criteria->getStart();
-        }
-        $Cache_Lite = new references_Cache_Lite($this->cacheOptions);
-        $id         = $this->_getIdForCache($sql, $start, $limit);
-        $cacheData  = $Cache_Lite->get($id);
-        if ($cacheData === false) {
-            $result = $this->db->query($sql, $limit, $start);
-            if (!$result) {
-                $ret = 0;
-                $Cache_Lite->save($ret);
-
-                return $ret;
-            }
-            if ($groupby == false) {
-                list($count) = $this->db->fetchRow($result);
-                $Cache_Lite->save($count);
-
-                return $count;
-            } else {
-                $ret = array();
-                while (list($id, $count) = $this->db->fetchRow($result)) {
-                    $ret[$id] = $count;
-                }
-                $Cache_Lite->save($ret);
-
-                return $ret;
-            }
-        } else {
-            return $cacheData;
-        }
-    }
-
-    /**
-     * Retourne le total d'un champ
-     *
-     * @param  string $field    Le champ dont on veut calculer le total
-     * @param  object $criteria {@link CriteriaElement} to match
-     * @return integer le total
-     */
-    public function getSum($field, $criteria = null)
-    {
-        $limit = $start = 0;
-        require_once __DIR__ . '/lite.php';
-
-        $sql = 'SELECT Sum(' . $field . ') as cpt FROM ' . $this->table;
-        if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
-            $sql .= ' ' . $criteria->renderWhere();
-            if ($criteria->groupby != '') {
-                $sql .= $criteria->getGroupby();
-            }
-            $limit = $criteria->getLimit();
-            $start = $criteria->getStart();
-        }
-        $Cache_Lite = new references_Cache_Lite($this->cacheOptions);
-        $id         = $this->_getIdForCache($sql, $start, $limit);
-        $cacheData  = $Cache_Lite->get($id);
-        if ($cacheData === false) {
-            $result = $this->db->query($sql, $limit, $start);
-            if (!$result) {
-                $ret = 0;
-                $Cache_Lite->save($ret);
-
-                return $ret;
-            }
-            $row   = $this->db->fetchArray($result);
-            $count = $row['cpt'];
-            $Cache_Lite->save($count);
-
-            return $count;
-        } else {
-            return $cacheData;
-        }
-    }
-
-    /**
-     * delete an object from the database
-     *
-     * @param  XoopsObject $obj reference to the object to delete
-     * @param  bool        $force
-     * @return bool   FALSE if failed.
-     */
-    public function delete(XoopsObject $obj, $force = false)
-    {
-        if (is_array($this->keyName)) {
-            $clause = array();
-            $vnb    = count($this->keyName);
-            for ($i = 0; $i < $vnb; ++$i) {
-                $clause[] = $this->keyName[$i] . ' = ' . $obj->getVar($this->keyName[$i]);
-            }
-            $whereclause = implode(' AND ', $clause);
-        } else {
-            $whereclause = $this->keyName . ' = ' . $obj->getVar($this->keyName);
-        }
-        $sql = 'DELETE FROM ' . $this->table . ' WHERE ' . $whereclause;
-        if (false != $force) {
-            $result = $this->db->queryF($sql);
-        } else {
-            $result = $this->db->query($sql);
-        }
-        // Clear cache
-        $this->forceCacheClean();
-
-        if (!$result) {
-            return false;
-        }
-
-        return true;
-    }
-
-    /**
-     * Quickly insert a record like this $myobject_handler->quickInsert('field1' => field1value, 'field2' => $field2value)
-     *
-     * @param  array $vars  Array containing the fields name and value
-     * @param  bool  $force whether to force the query execution despite security settings
-     * @return bool  @link insert's value
-     */
-    public function quickInsert($vars = null, $force = true)
-    {
-        $object = $this->create(true);
-        $object->setVars($vars);
-        $retval =& $this->insert($object, $force);
-        unset($object);
-
-        // Clear cache
-        $this->forceCacheClean();
-
-        return $retval;
-    }
-
-    /**
-     * insert a new object in the database
-     *
-     * @param  XoopsObject $obj         reference to the object
-     * @param  bool        $force       whether to force the query execution despite security settings
-     * @param  bool        $checkObject check if the object is dirty and clean the attributes
-     * @param bool         $ignoreInsert
-     * @return bool FALSE if failed, TRUE if already present and unchanged or successful
-     */
-
-    public function insert(XoopsObject $obj, $force = false, $checkObject = true, $ignoreInsert = false)
-    {
-        if ($checkObject != false) {
-            if (!is_object($obj)) {
-                trigger_error('Error, not object');
-
-                return false;
-            }
-            /**
-             * @TODO: Change to if (!(class_exists($this->className) && $obj instanceof $this->className)) when going fully PHP5
-             */
-            if (!is_a($obj, $this->className)) {
-                $obj->setErrors(get_class($obj) . ' Differs from ' . $this->className);
-
-                return false;
-            }
-            if (!$obj->isDirty()) {
-                $obj->setErrors('Not dirty'); //will usually not be outputted as errors are not displayed when the method returns true, but it can be helpful when troubleshooting code - Mith
-
-                return true;
-            }
-        }
-        if (!$obj->cleanVars()) {
-            foreach ($obj->getErrors() as $oneerror) {
-                trigger_error($oneerror);
-            }
-
-            return false;
-        }
-        foreach ($obj->cleanVars as $k => $v) {
-            if ($obj->vars[$k]['data_type'] == XOBJ_DTYPE_INT) {
-                $cleanvars[$k] = (int)$v;
-            } elseif (is_array($v)) {
-                $cleanvars[$k] = $this->db->quoteString(implode(',', $v));
-            } else {
-                $cleanvars[$k] = $this->db->quoteString($v);
-            }
-        }
-        if (isset($cleanvars['dohtml'])) {        // Modification Herv� to be able to use dohtml
-            unset($cleanvars['dohtml']);
-        }
-        if ($obj->isNew()) {
-            if (!is_array($this->keyName)) {
-                if ($cleanvars[$this->keyName] < 1) {
-                    $cleanvars[$this->keyName] = $this->db->genId($this->table . '_' . $this->keyName . '_seq');
-                }
-            }
-            $ignore = '';
-            if ($ignoreInsert) {
-                $ignore = 'IGNORE';
-            }
-            $sql = "INSERT $ignore INTO " . $this->table . ' (' . implode(',', array_keys($cleanvars)) . ') VALUES (' . implode(',', array_values($cleanvars)) . ')';
-        } else {
-            $sql = 'UPDATE ' . $this->table . ' SET';
-            foreach ($cleanvars as $key => $value) {
-                if ((!is_array($this->keyName) && $key == $this->keyName) || (is_array($this->keyName) && in_array($key, $this->keyName))) {
-                    continue;
-                }
-                if (isset($notfirst)) {
-                    $sql .= ',';
-                }
-                $sql .= ' ' . $key . ' = ' . $value;
-                $notfirst = true;
-            }
-            if (is_array($this->keyName)) {
-                $whereclause = '';
-                $vnb         = count($this->keyName);
-                for ($i = 0; $i < $vnb; ++$i) {
-                    if ($i > 0) {
-                        $whereclause .= ' AND ';
-                    }
-                    $whereclause .= $this->keyName[$i] . ' = ' . $obj->getVar($this->keyName[$i]);
-                }
-            } else {
-                $whereclause = $this->keyName . ' = ' . $obj->getVar($this->keyName);
-            }
-            $sql .= ' WHERE ' . $whereclause;
-        }
-
-        if (false != $force) {
-            $result = $this->db->queryF($sql);
-        } else {
-            $result = $this->db->query($sql);
-        }
-
-        // Clear cache
-        $this->forceCacheClean();
-
-        if (!$result) {
-            return false;
-        }
-        if ($obj->isNew() && !is_array($this->keyName)) {
-            $obj->assignVar($this->keyName, $this->db->getInsertId());
-        }
-
-        return true;
-    }
-
-    /**
-     * Change a value for objects with a certain criteria
-     *
-     * @param string $fieldname  Name of the field
-     * @param string $fieldvalue Value to write
-     * @param object $criteria   {@link CriteriaElement}
-     *
-     * @param bool   $force
-     * @return bool
-     */
-    public function updateAll($fieldname, $fieldvalue, $criteria = null, $force = false)
-    {
-        $set_clause = $fieldname . ' = ';
-        if (is_numeric($fieldvalue)) {
-            $set_clause .= $fieldvalue;
-        } elseif (is_array($fieldvalue)) {
-            $set_clause .= $this->db->quoteString(implode(',', $fieldvalue));
-        } else {
-            $set_clause .= $this->db->quoteString($fieldvalue);
-        }
-        $sql = 'UPDATE ' . $this->table . ' SET ' . $set_clause;
-        if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
-            $sql .= ' ' . $criteria->renderWhere();
-        }
-        if ($force) {
-            $result = $this->db->queryF($sql);
-        } else {
-            $result = $this->db->query($sql);
-        }
-
-        // Clear cache
-        $this->forceCacheClean();
-
-        if (!$result) {
-            return false;
-        }
-
-        return true;
-    }
-
-    //  check if target object is attempting to use duplicated info
-    public function isDuplicated(&$obj, $field = '', $error = '')
-    {
-        if (empty($field)) {
-            return false;
-        }
-        $criteria = new CriteriaCompo();
-        $criteria->add(new Criteria($field, $obj->getVar($field)));
-        //  one more condition if target object exisits in database
-        if (!$obj->isNew()) {
-            $criteria->add(new Criteria($this->_key, $obj->getVar($this->_key), '!='));
-        }
-        if ($this->getCount($criteria)) {
-            $obj->setErrors($error);
-
-            return true;
-        }
-
-        return false;
-    }
-
-    /**
-     * delete all objects meeting the conditions
-     *
-     * @param  object $criteria {@link CriteriaElement} with conditions to meet
-     * @return bool
-     */
-    public function deleteAll($criteria = null)
-    {
-        if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
-            $sql = 'DELETE FROM ' . $this->table;
-            $sql .= ' ' . $criteria->renderWhere();
-            if (!$this->db->queryF($sql)) {
-                return false;
-            }
-            $rows = $this->db->getAffectedRows();
-
-            // Clear cache
-            $this->forceCacheClean();
-
-            return $rows > 0 ? $rows : true;
-        }
-
-        return false;
-    }
-
-    /**
-     * Compare two objects and returns, in an array, the differences
-     *
-     * @param  XoopsObject $old_object The first object to compare
-     * @param  XoopsObject $new_object The new object
-     * @return array       differences  key = fieldname, value = array('old_value', 'new_value')
-     */
-    public function compareObjects($old_object, $new_object)
-    {
-        $ret       = array();
-        $vars_name = array_keys($old_object->getVars());
-        foreach ($vars_name as $one_var) {
-            if ($old_object->getVar($one_var, 'f') == $new_object->getVar($one_var, 'f')) {
-            } else {
-                $ret[$one_var] = array($old_object->getVar($one_var), $new_object->getVar($one_var));
-            }
-        }
-
-        return $ret;
-    }
-
-    /**
-     * Get distincted values of a field in the table
-     *
-     * @param  string $field    Field's name
-     * @param  object $criteria {@link CriteriaElement} conditions to be met
-     * @param  string $format   Format in wich we want the datas
-     * @return array  containing the distinct values
-     */
-    public function getDistincts($field, $criteria = null, $format = 's')
-    {
-        require_once __DIR__ . '/lite.php';
-        $limit = $start = 0;
-        $sql   = 'SELECT ' . $this->keyName . ', ' . $field . ' FROM ' . $this->table;
-        if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
-            $sql .= ' ' . $criteria->renderWhere();
-            $limit = $criteria->getLimit();
-            $start = $criteria->getStart();
-        }
-        $sql .= ' GROUP BY ' . $field . ' ORDER BY ' . $field;
-
-        $Cache_Lite = new references_Cache_Lite($this->cacheOptions);
-        $id         = $this->_getIdForCache($sql, $start, $limit);
-        $cacheData  = $Cache_Lite->get($id);
-        if ($cacheData === false) {
-            $result = $this->db->query($sql, $limit, $start);
-            $ret    = array();
-            $obj    = new $this->className();
-            while ($myrow = $this->db->fetchArray($result)) {
-                $obj->setVar($field, $myrow[$field]);
-                $ret[$myrow[$this->keyName]] = $obj->getVar($field, $format);
-            }
-            $Cache_Lite->save($ret);
-
-            return $ret;
-        } else {
-            return $cacheData;
-        }
-    }
-
-    /**
-     * A generic shortcut to getObjects
-     *
-     * @author Herve Thouzard - Instant Zero
-     *
-     * @param  integer $start   Starting position
-     * @param  integer $limit   Maximum count of elements to return
-     * @param  string  $sort    Field to use for the sort
-     * @param  string  $order   Sort order
-     * @param  boolean $idAsKey Do we have to return an array whoses keys are the record's ID ?
-     * @return array   Array of current objects
-     */
-    public function getItems($start = 0, $limit = 0, $sort = '', $order = 'ASC', $idAsKey = true)
-    {
-        if (trim($order) == '') {
-            if (isset($this->identifierName) && trim($this->identifierName) != '') {
-                $order = $this->identifierName;
-            } else {
-                $order = $this->keyName;
-            }
-        }
-        $items   = array();
-        $critere = new Criteria($this->keyName, 0, '<>');
-        $critere->setLimit($limit);
-        $critere->setStart($start);
-        $critere->setSort($sort);
-        $critere->setOrder($order);
-        $items =& $this->getObjects($critere, $idAsKey);
-
-        return $items;
-    }
-
-    /**
-     * Forces the cache to be cleaned
-     */
-    public function forceCacheClean()
-    {
-        require_once __DIR__ . '/lite.php';
-        $Cache_Lite = new references_Cache_Lite($this->cacheOptions);
-        $Cache_Lite->clean();
-    }
+	public    $table;
+	public    $keyName;
+	public    $className;
+	public    $identifierName;
+	protected $cacheOptions = array();
+	/**#@-*/
+
+	/**
+	 * Constructor - called from child classes
+	 * @param object $db           {@link XoopsDatabase} object
+	 * @param string $tablename    Name of database table
+	 * @param string $classname    Name of Class, this handler is managing
+	 * @param string $keyname      Name of the property, holding the key
+	 * @param string $idenfierName Name of the property, holding the label
+	 * @param array  $cacheOptions Optional, options for the cache
+	 *
+	 */
+	public function __construct(&$db, $tablename, $classname, $keyname, $idenfierName = '', $cacheOptions = null)
+	{
+		parent::__construct($db);
+		$this->table     = $db->prefix($tablename);
+		$this->keyName   = $keyname;
+		$this->className = $classname;
+		if (trim($idenfierName) != '') {
+			$this->identifierName = $idenfierName;
+		}
+		// To diable cache, add this line after the first one : 'caching' => false,
+		if (is_null($cacheOptions)) {
+			$this->setCachingOptions(array('cacheDir' => REFERENCES_CACHE_PATH, 'lifeTime' => null, 'automaticSerialization' => true, 'fileNameProtection' => false));
+		} else {
+			$this->setCachingOptions($cacheOptions);
+		}
+	}
+
+	public function setCachingOptions($cacheOptions)
+	{
+		$this->cacheOptions = $cacheOptions;
+	}
+
+	/**
+	 * Generates a unique ID for a Sql Query
+	 *
+	 * @param  string  $query The SQL query for which we want a unidque ID
+	 * @param  integer $start Which record to start at
+	 * @param  integer $limit Max number of objects to fetch
+	 * @return string  An MD5 of the query
+	 */
+	protected function _getIdForCache($query, $start, $limit)
+	{
+		$id = md5($query . '-' . (string)$start . '-' . (string)$limit);
+
+		return $id;
+	}
+
+	/**
+	 * create a new object
+	 *
+	 * @param bool $isNew Flag the new objects as "new"?
+	 *
+	 * @return object
+	 */
+	public function &create($isNew = true)
+	{
+		$obj = new $this->className();
+		if ($isNew === true) {
+			$obj->setNew();
+		}
+
+		return $obj;
+	}
+
+	/**
+	 * retrieve an object
+	 *
+	 * @param  mixed $id        ID of the object - or array of ids for joint keys. Joint keys MUST be given in the same order as in the constructor
+	 * @param  bool  $as_object whether to return an object or an array
+	 * @return mixed reference to the object, FALSE if failed
+	 */
+	public function &get($id, $as_object = true)
+	{
+		if (is_array($this->keyName)) {
+			$criteria = new CriteriaCompo();
+			$vnb      = count($this->keyName);
+			for ($i = 0; $i < $vnb; ++$i) {
+				$criteria->add(new Criteria($this->keyName[$i], (int)$id[$i]));
+			}
+		} else {
+			$criteria = new Criteria($this->keyName, (int)$id);
+		}
+		$criteria->setLimit(1);
+		$obj_array =& $this->getObjects($criteria, false, $as_object);
+		if (count($obj_array) != 1) {
+			$ret = null;
+		} else {
+			$ret =& $obj_array[0];
+		}
+
+		return $ret;
+	}
+
+	/**
+	 * retrieve objects from the database
+	 *
+	 * @param null|CriteriaElement $criteria  {@link CriteriaElement} conditions to be met
+	 * @param bool                 $id_as_key use the ID as key for the array?
+	 * @param bool                 $as_object return an array of objects?
+	 *
+	 * @param string               $fields
+	 * @param bool                 $autoSort
+	 * @return array
+	 */
+	public function &getObjects(CriteriaElement $criteria = null, $id_as_key = false, $as_object = true, $fields = '*', $autoSort = true)
+	{
+		require_once __DIR__ . '/lite.php';
+		$ret   = array();
+		$limit = $start = 0;
+		$sql   = 'SELECT ' . $fields . ' FROM ' . $this->table;
+		if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
+			$sql .= ' ' . $criteria->renderWhere();
+			if ($criteria->groupby != '') {
+				$sql .= $criteria->getGroupby();
+			}
+			if ($criteria->getSort() != '') {
+				$sql .= ' ORDER BY ' . $criteria->getSort() . ' ' . $criteria->getOrder();
+			} elseif ($this->identifierName != '' && $autoSort) {
+				$sql .= ' ORDER BY ' . $this->identifierName;
+			}
+			$limit = $criteria->getLimit();
+			$start = $criteria->getStart();
+		}
+		$Cache_Lite = new references_Cache_Lite($this->cacheOptions);
+		$id         = $this->_getIdForCache($sql, $start, $limit);
+		$cacheData  = $Cache_Lite->get($id);
+		if ($cacheData === false) {
+			$result = $this->db->query($sql, $limit, $start);
+			if (!$result) {
+				return $ret;
+			}
+			$ret = $this->convertResultSet($result, $id_as_key, $as_object, $fields);
+			$Cache_Lite->save($ret);
+
+			return $ret;
+		} else {
+			return $cacheData;
+		}
+	}
+
+	/**
+	 * Convert a database resultset to a returnable array
+	 *
+	 * @param object  $result    database resultset
+	 * @param boolean $id_as_key - should NOT be used with joint keys
+	 * @param boolean $as_object
+	 * @param string  $fields    Requested fields from the query
+	 *
+	 * @return array
+	 */
+	protected function convertResultSet($result, $id_as_key = false, $as_object = true, $fields = '*')
+	{
+		$ret = array();
+		while ($myrow = $this->db->fetchArray($result)) {
+			$obj =& $this->create(false);
+			$obj->assignVars($myrow);
+			if (!$id_as_key) {
+				if ($as_object) {
+					$ret[] =& $obj;
+				} else {
+					$row     = array();
+					$vars    = $obj->getVars();
+					$tbl_tmp = array_keys($vars);
+					foreach ($tbl_tmp as $i) {
+						$row[$i] = $obj->getVar($i);
+					}
+					$ret[] = $row;
+				}
+			} else {
+				if ($as_object) {
+					if ($fields === '*') {
+						$ret[$myrow[$this->keyName]] =& $obj;
+					} else {
+						$ret[] =& $obj;
+					}
+				} else {
+					$row     = array();
+					$vars    = $obj->getVars();
+					$tbl_tmp = array_keys($vars);
+					foreach ($tbl_tmp as $i) {
+						$row[$i] = $obj->getVar($i);
+					}
+					$ret[$myrow[$this->keyName]] = $row;
+				}
+			}
+			unset($obj);
+		}
+
+		return $ret;
+	}
+
+	/**
+	 * get IDs of objects matching a condition
+	 *
+	 * @param  object $criteria {@link CriteriaElement} to match
+	 * @return array  of object IDs
+	 */
+	public function getIds($criteria = null)
+	{
+		require_once __DIR__ . '/lite.php';
+		$limit = $start = 0;
+
+		$Cache_Lite = new references_Cache_Lite($this->cacheOptions);
+		$sql        = 'SELECT ' . $this->keyName . ' FROM ' . $this->table;
+		if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
+			$sql .= ' ' . $criteria->renderWhere();
+			if ($criteria->groupby != '') {
+				$sql .= $criteria->getGroupby();
+			}
+			if ($criteria->getSort() != '') {
+				$sql .= ' ORDER BY ' . $criteria->getSort() . ' ' . $criteria->getOrder();
+			} elseif ($this->identifierName != '') {
+				$sql .= ' ORDER BY ' . $this->identifierName;
+			}
+			$limit = $criteria->getLimit();
+			$start = $criteria->getStart();
+		}
+
+		$id        = $this->_getIdForCache($sql, $start, $limit);
+		$cacheData = $Cache_Lite->get($id);
+		if ($cacheData === false) {
+			$result = $this->db->query($sql, $limit, $start);
+			$ret    = array();
+			while ($myrow = $this->db->fetchArray($result)) {
+				$ret[] = $myrow[$this->keyName];
+			}
+			$Cache_Lite->save($ret);
+
+			return $ret;
+		} else {
+			return $cacheData;
+		}
+	}
+
+	/**
+	 * Retrieve a list of objects as arrays - DON'T USE WITH JOINT KEYS
+	 *
+	 * @param object $criteria {@link CriteriaElement} conditions to be met
+	 * @return array
+	 */
+	public function getList($criteria = null)
+	{
+		require_once __DIR__ . '/lite.php';
+		$limit      = $start = 0;
+		$Cache_Lite = new references_Cache_Lite($this->cacheOptions);
+
+		$ret = array();
+
+		$sql = 'SELECT ' . $this->keyName;
+		if (!empty($this->identifierName)) {
+			$sql .= ', ' . $this->identifierName;
+		}
+		$sql .= ' FROM ' . $this->table;
+		if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
+			$sql .= ' ' . $criteria->renderWhere();
+			if ($criteria->groupby != '') {
+				$sql .= $criteria->getGroupby();
+			}
+			if ($criteria->getSort() != '') {
+				$sql .= ' ORDER BY ' . $criteria->getSort() . ' ' . $criteria->getOrder();
+			} elseif ($this->identifierName != '') {
+				$sql .= ' ORDER BY ' . $this->identifierName;
+			}
+			$limit = $criteria->getLimit();
+			$start = $criteria->getStart();
+		}
+
+		$id        = $this->_getIdForCache($sql, $start, $limit);
+		$cacheData = $Cache_Lite->get($id);
+		if ($cacheData === false) {
+			$result = $this->db->query($sql, $limit, $start);
+			if (!$result) {
+				$Cache_Lite->save($ret);
+
+				return $ret;
+			}
+
+			$myts = MyTextSanitizer::getInstance();
+			while ($myrow = $this->db->fetchArray($result)) {
+				//identifiers should be textboxes, so sanitize them like that
+				$ret[$myrow[$this->keyName]] = empty($this->identifierName) ? 1 : $myts->htmlSpecialChars($myrow[$this->identifierName]);
+			}
+			$Cache_Lite->save($ret);
+
+			return $ret;
+		} else {
+			return $cacheData;
+		}
+	}
+
+	/**
+	 * Retourne des éléments selon leur ID
+	 *
+	 * @param array $ids Les ID des éléments à retrouver
+	 * @param null  $additionnal
+	 * @return array Tableau d'objets
+	 */
+	public function getItemsFromIds($ids, $additionnal = null)
+	{
+		$ret = array();
+		if (is_array($ids) && count($ids) > 0) {
+			$criteria = new CriteriaCompo();
+			$criteria->add(new Criteria($this->keyName, '(' . implode(',', $ids) . ')', 'IN'));
+			if (!is_null($additionnal)) {
+				$criteria->add($additionnal);
+			}
+			$ret =& $this->getObjects($criteria, true);
+		}
+
+		return $ret;
+	}
+
+	/**
+	 * count objects matching a condition
+	 *
+	 * @param  object $criteria {@link CriteriaElement} to match
+	 * @return int    count of objects
+	 */
+	public function getCount($criteria = null)
+	{
+		$field   = '';
+		$groupby = false;
+		$limit   = $start = 0;
+		require_once __DIR__ . '/lite.php';
+
+		if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
+			if ($criteria->groupby != '') {
+				$groupby = true;
+				$field   = $criteria->groupby . ', '; //Not entirely secure unless you KNOW that no criteria's groupby clause is going to be mis-used
+			}
+		}
+		$sql = 'SELECT ' . $field . 'COUNT(*) FROM ' . $this->table;
+		if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
+			$sql .= ' ' . $criteria->renderWhere();
+			if ($criteria->groupby != '') {
+				$sql .= $criteria->getGroupby();
+			}
+			$limit = $criteria->getLimit();
+			$start = $criteria->getStart();
+		}
+		$Cache_Lite = new references_Cache_Lite($this->cacheOptions);
+		$id         = $this->_getIdForCache($sql, $start, $limit);
+		$cacheData  = $Cache_Lite->get($id);
+		if ($cacheData === false) {
+			$result = $this->db->query($sql, $limit, $start);
+			if (!$result) {
+				$ret = 0;
+				$Cache_Lite->save($ret);
+
+				return $ret;
+			}
+			if ($groupby == false) {
+				list($count) = $this->db->fetchRow($result);
+				$Cache_Lite->save($count);
+
+				return $count;
+			} else {
+				$ret = array();
+				while (list($id, $count) = $this->db->fetchRow($result)) {
+					$ret[$id] = $count;
+				}
+				$Cache_Lite->save($ret);
+
+				return $ret;
+			}
+		} else {
+			return $cacheData;
+		}
+	}
+
+	/**
+	 * Retourne le total d'un champ
+	 *
+	 * @param  string $field    Le champ dont on veut calculer le total
+	 * @param  object $criteria {@link CriteriaElement} to match
+	 * @return integer le total
+	 */
+	public function getSum($field, $criteria = null)
+	{
+		$limit = $start = 0;
+		require_once __DIR__ . '/lite.php';
+
+		$sql = 'SELECT Sum(' . $field . ') as cpt FROM ' . $this->table;
+		if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
+			$sql .= ' ' . $criteria->renderWhere();
+			if ($criteria->groupby != '') {
+				$sql .= $criteria->getGroupby();
+			}
+			$limit = $criteria->getLimit();
+			$start = $criteria->getStart();
+		}
+		$Cache_Lite = new references_Cache_Lite($this->cacheOptions);
+		$id         = $this->_getIdForCache($sql, $start, $limit);
+		$cacheData  = $Cache_Lite->get($id);
+		if ($cacheData === false) {
+			$result = $this->db->query($sql, $limit, $start);
+			if (!$result) {
+				$ret = 0;
+				$Cache_Lite->save($ret);
+
+				return $ret;
+			}
+			$row   = $this->db->fetchArray($result);
+			$count = $row['cpt'];
+			$Cache_Lite->save($count);
+
+			return $count;
+		} else {
+			return $cacheData;
+		}
+	}
+
+	/**
+	 * delete an object from the database
+	 *
+	 * @param  XoopsObject $obj reference to the object to delete
+	 * @param  bool        $force
+	 * @return bool   FALSE if failed.
+	 */
+	public function delete(XoopsObject $obj, $force = false)
+	{
+		if (is_array($this->keyName)) {
+			$clause = array();
+			$vnb    = count($this->keyName);
+			for ($i = 0; $i < $vnb; ++$i) {
+				$clause[] = $this->keyName[$i] . ' = ' . $obj->getVar($this->keyName[$i]);
+			}
+			$whereclause = implode(' AND ', $clause);
+		} else {
+			$whereclause = $this->keyName . ' = ' . $obj->getVar($this->keyName);
+		}
+		$sql = 'DELETE FROM ' . $this->table . ' WHERE ' . $whereclause;
+		if (false != $force) {
+			$result = $this->db->queryF($sql);
+		} else {
+			$result = $this->db->query($sql);
+		}
+		// Clear cache
+		$this->forceCacheClean();
+
+		if (!$result) {
+			return false;
+		}
+
+		return true;
+	}
+
+	/**
+	 * Quickly insert a record like this $myobject_handler->quickInsert('field1' => field1value, 'field2' => $field2value)
+	 *
+	 * @param  array $vars  Array containing the fields name and value
+	 * @param  bool  $force whether to force the query execution despite security settings
+	 * @return bool  @link insert's value
+	 */
+	public function quickInsert($vars = null, $force = true)
+	{
+		$object = $this->create(true);
+		$object->setVars($vars);
+		$retval =& $this->insert($object, $force);
+		unset($object);
+
+		// Clear cache
+		$this->forceCacheClean();
+
+		return $retval;
+	}
+
+	/**
+	 * insert a new object in the database
+	 *
+	 * @param  XoopsObject $obj         reference to the object
+	 * @param  bool        $force       whether to force the query execution despite security settings
+	 * @param  bool        $checkObject check if the object is dirty and clean the attributes
+	 * @param bool         $ignoreInsert
+	 * @return bool FALSE if failed, TRUE if already present and unchanged or successful
+	 */
+
+	public function insert(XoopsObject $obj, $force = false, $checkObject = true, $ignoreInsert = false)
+	{
+		if ($checkObject != false) {
+			if (!is_object($obj)) {
+				trigger_error('Error, not object');
+
+				return false;
+			}
+			/**
+			 * @TODO: Change to if (!(class_exists($this->className) && $obj instanceof $this->className)) when going fully PHP5
+			 */
+			if (!is_a($obj, $this->className)) {
+				$obj->setErrors(get_class($obj) . ' Differs from ' . $this->className);
+
+				return false;
+			}
+			if (!$obj->isDirty()) {
+				$obj->setErrors('Not dirty'); //will usually not be outputted as errors are not displayed when the method returns true, but it can be helpful when troubleshooting code - Mith
+
+				return true;
+			}
+		}
+		if (!$obj->cleanVars()) {
+			foreach ($obj->getErrors() as $oneerror) {
+				trigger_error($oneerror);
+			}
+
+			return false;
+		}
+		foreach ($obj->cleanVars as $k => $v) {
+			if ($obj->vars[$k]['data_type'] == XOBJ_DTYPE_INT) {
+				$cleanvars[$k] = (int)$v;
+			} elseif (is_array($v)) {
+				$cleanvars[$k] = $this->db->quoteString(implode(',', $v));
+			} else {
+				$cleanvars[$k] = $this->db->quoteString($v);
+			}
+		}
+		if (isset($cleanvars['dohtml'])) {        // Modification Herv� to be able to use dohtml
+			unset($cleanvars['dohtml']);
+		}
+		if ($obj->isNew()) {
+			if (!is_array($this->keyName)) {
+				if ($cleanvars[$this->keyName] < 1) {
+					$cleanvars[$this->keyName] = $this->db->genId($this->table . '_' . $this->keyName . '_seq');
+				}
+			}
+			$ignore = '';
+			if ($ignoreInsert) {
+				$ignore = 'IGNORE';
+			}
+			$sql = "INSERT $ignore INTO " . $this->table . ' (' . implode(',', array_keys($cleanvars)) . ') VALUES (' . implode(',', array_values($cleanvars)) . ')';
+		} else {
+			$sql = 'UPDATE ' . $this->table . ' SET';
+			foreach ($cleanvars as $key => $value) {
+				if ((!is_array($this->keyName) && $key == $this->keyName) || (is_array($this->keyName) && in_array($key, $this->keyName))) {
+					continue;
+				}
+				if (isset($notfirst)) {
+					$sql .= ',';
+				}
+				$sql .= ' ' . $key . ' = ' . $value;
+				$notfirst = true;
+			}
+			if (is_array($this->keyName)) {
+				$whereclause = '';
+				$vnb         = count($this->keyName);
+				for ($i = 0; $i < $vnb; ++$i) {
+					if ($i > 0) {
+						$whereclause .= ' AND ';
+					}
+					$whereclause .= $this->keyName[$i] . ' = ' . $obj->getVar($this->keyName[$i]);
+				}
+			} else {
+				$whereclause = $this->keyName . ' = ' . $obj->getVar($this->keyName);
+			}
+			$sql .= ' WHERE ' . $whereclause;
+		}
+
+		if (false != $force) {
+			$result = $this->db->queryF($sql);
+		} else {
+			$result = $this->db->query($sql);
+		}
+
+		// Clear cache
+		$this->forceCacheClean();
+
+		if (!$result) {
+			return false;
+		}
+		if ($obj->isNew() && !is_array($this->keyName)) {
+			$obj->assignVar($this->keyName, $this->db->getInsertId());
+		}
+
+		return true;
+	}
+
+	/**
+	 * Change a value for objects with a certain criteria
+	 *
+	 * @param string $fieldname  Name of the field
+	 * @param string $fieldvalue Value to write
+	 * @param object $criteria   {@link CriteriaElement}
+	 *
+	 * @param bool   $force
+	 * @return bool
+	 */
+	public function updateAll($fieldname, $fieldvalue, $criteria = null, $force = false)
+	{
+		$set_clause = $fieldname . ' = ';
+		if (is_numeric($fieldvalue)) {
+			$set_clause .= $fieldvalue;
+		} elseif (is_array($fieldvalue)) {
+			$set_clause .= $this->db->quoteString(implode(',', $fieldvalue));
+		} else {
+			$set_clause .= $this->db->quoteString($fieldvalue);
+		}
+		$sql = 'UPDATE ' . $this->table . ' SET ' . $set_clause;
+		if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
+			$sql .= ' ' . $criteria->renderWhere();
+		}
+		if ($force) {
+			$result = $this->db->queryF($sql);
+		} else {
+			$result = $this->db->query($sql);
+		}
+
+		// Clear cache
+		$this->forceCacheClean();
+
+		if (!$result) {
+			return false;
+		}
+
+		return true;
+	}
+
+	//  check if target object is attempting to use duplicated info
+	public function isDuplicated(&$obj, $field = '', $error = '')
+	{
+		if (empty($field)) {
+			return false;
+		}
+		$criteria = new CriteriaCompo();
+		$criteria->add(new Criteria($field, $obj->getVar($field)));
+		//  one more condition if target object exisits in database
+		if (!$obj->isNew()) {
+			$criteria->add(new Criteria($this->_key, $obj->getVar($this->_key), '!='));
+		}
+		if ($this->getCount($criteria)) {
+			$obj->setErrors($error);
+
+			return true;
+		}
+
+		return false;
+	}
+
+	/**
+	 * delete all objects meeting the conditions
+	 *
+	 * @param  object $criteria {@link CriteriaElement} with conditions to meet
+	 * @return bool
+	 */
+	public function deleteAll($criteria = null)
+	{
+		if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
+			$sql = 'DELETE FROM ' . $this->table;
+			$sql .= ' ' . $criteria->renderWhere();
+			if (!$this->db->queryF($sql)) {
+				return false;
+			}
+			$rows = $this->db->getAffectedRows();
+
+			// Clear cache
+			$this->forceCacheClean();
+
+			return $rows > 0 ? $rows : true;
+		}
+
+		return false;
+	}
+
+	/**
+	 * Compare two objects and returns, in an array, the differences
+	 *
+	 * @param  XoopsObject $old_object The first object to compare
+	 * @param  XoopsObject $new_object The new object
+	 * @return array       differences  key = fieldname, value = array('old_value', 'new_value')
+	 */
+	public function compareObjects($old_object, $new_object)
+	{
+		$ret       = array();
+		$vars_name = array_keys($old_object->getVars());
+		foreach ($vars_name as $one_var) {
+			if ($old_object->getVar($one_var, 'f') == $new_object->getVar($one_var, 'f')) {
+			} else {
+				$ret[$one_var] = array($old_object->getVar($one_var), $new_object->getVar($one_var));
+			}
+		}
+
+		return $ret;
+	}
+
+	/**
+	 * Get distincted values of a field in the table
+	 *
+	 * @param  string $field    Field's name
+	 * @param  object $criteria {@link CriteriaElement} conditions to be met
+	 * @param  string $format   Format in wich we want the datas
+	 * @return array  containing the distinct values
+	 */
+	public function getDistincts($field, $criteria = null, $format = 's')
+	{
+		require_once __DIR__ . '/lite.php';
+		$limit = $start = 0;
+		$sql   = 'SELECT ' . $this->keyName . ', ' . $field . ' FROM ' . $this->table;
+		if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
+			$sql .= ' ' . $criteria->renderWhere();
+			$limit = $criteria->getLimit();
+			$start = $criteria->getStart();
+		}
+		$sql .= ' GROUP BY ' . $field . ' ORDER BY ' . $field;
+
+		$Cache_Lite = new references_Cache_Lite($this->cacheOptions);
+		$id         = $this->_getIdForCache($sql, $start, $limit);
+		$cacheData  = $Cache_Lite->get($id);
+		if ($cacheData === false) {
+			$result = $this->db->query($sql, $limit, $start);
+			$ret    = array();
+			$obj    = new $this->className();
+			while ($myrow = $this->db->fetchArray($result)) {
+				$obj->setVar($field, $myrow[$field]);
+				$ret[$myrow[$this->keyName]] = $obj->getVar($field, $format);
+			}
+			$Cache_Lite->save($ret);
+
+			return $ret;
+		} else {
+			return $cacheData;
+		}
+	}
+
+	/**
+	 * A generic shortcut to getObjects
+	 *
+	 * @author Herve Thouzard - Instant Zero
+	 *
+	 * @param  integer $start   Starting position
+	 * @param  integer $limit   Maximum count of elements to return
+	 * @param  string  $sort    Field to use for the sort
+	 * @param  string  $order   Sort order
+	 * @param  boolean $idAsKey Do we have to return an array whoses keys are the record's ID ?
+	 * @return array   Array of current objects
+	 */
+	public function getItems($start = 0, $limit = 0, $sort = '', $order = 'ASC', $idAsKey = true)
+	{
+		if (trim($order) == '') {
+			if (isset($this->identifierName) && trim($this->identifierName) != '') {
+				$order = $this->identifierName;
+			} else {
+				$order = $this->keyName;
+			}
+		}
+		$items   = array();
+		$critere = new Criteria($this->keyName, 0, '<>');
+		$critere->setLimit($limit);
+		$critere->setStart($start);
+		$critere->setSort($sort);
+		$critere->setOrder($order);
+		$items =& $this->getObjects($critere, $idAsKey);
+
+		return $items;
+	}
+
+	/**
+	 * Forces the cache to be cleaned
+	 */
+	public function forceCacheClean()
+	{
+		require_once __DIR__ . '/lite.php';
+		$Cache_Lite = new references_Cache_Lite($this->cacheOptions);
+		$Cache_Lite->clean();
+	}
 }

class/references_articles.php

Doc Comments +2 added lines, -2 removed lines

@@ -499,7 +499,7 @@ 
     /**
      * Notification de la publication d'une nouvelle référence
      *
-     * @param object|references_articles $article L'annonce pour laquelle on fait la notification
+     * @param references_articles $article L'annonce pour laquelle on fait la notification
      * @return bool
      */
     public function notifyNewArticle(references_articles $article)
@@ -574,7 +574,7 @@ 
     /**
      * Indique si une référence est visible d'un utilisateur
      *
-     * @param object|references_articles $article L'article à controler
+     * @param references_articles $article L'article à controler
      * @param integer                    $uid     L'id de l'utilisateur à controler
      * @return bool
      */

Indentation +603 added lines, -603 removed lines

@@ -22,7 +22,7 @@ 
 
 require_once XOOPS_ROOT_PATH . '/kernel/object.php';
 if (!class_exists('references_XoopsPersistableObjectHandler')) {
-    require_once XOOPS_ROOT_PATH . '/modules/references/class/PersistableObjectHandler.php';
+	require_once XOOPS_ROOT_PATH . '/modules/references/class/PersistableObjectHandler.php';
 }
 
 define('REFERENCES_STATUS_ONLINE', 1);    // Articles en ligne
@@ -30,610 +30,610 @@ 
 
 class references_articles extends references_Object
 {
-    public function __construct()
-    {
-        $this->initVar('article_id', XOBJ_DTYPE_INT, null, false);
-        $this->initVar('article_category_id', XOBJ_DTYPE_INT, null, false);
-        $this->initVar('article_timestamp', XOBJ_DTYPE_INT, null, false);
-        $this->initVar('article_weight', XOBJ_DTYPE_INT, null, false);
-        $this->initVar('article_date', XOBJ_DTYPE_TXTBOX, null, false);
-        $this->initVar('article_title', XOBJ_DTYPE_TXTBOX, null, false);
-        $this->initVar('article_text', XOBJ_DTYPE_TXTAREA, null, false);
-        $this->initVar('article_externalurl', XOBJ_DTYPE_TXTBOX, null, false);
-        $this->initVar('article_picture1', XOBJ_DTYPE_TXTBOX, null, false);
-        $this->initVar('article_picture1_text', XOBJ_DTYPE_TXTBOX, null, false);
-        $this->initVar('article_picture2', XOBJ_DTYPE_TXTBOX, null, false);
-        $this->initVar('article_picture2_text', XOBJ_DTYPE_TXTBOX, null, false);
-        $this->initVar('article_picture3', XOBJ_DTYPE_TXTBOX, null, false);
-        $this->initVar('article_picture3_text', XOBJ_DTYPE_TXTBOX, null, false);
-        $this->initVar('article_picture4', XOBJ_DTYPE_TXTBOX, null, false);
-        $this->initVar('article_picture4_text', XOBJ_DTYPE_TXTBOX, null, false);
-        $this->initVar('article_picture5', XOBJ_DTYPE_TXTBOX, null, false);
-        $this->initVar('article_picture5_text', XOBJ_DTYPE_TXTBOX, null, false);
-        $this->initVar('article_picture6', XOBJ_DTYPE_TXTBOX, null, false);
-        $this->initVar('article_picture6_text', XOBJ_DTYPE_TXTBOX, null, false);
-        $this->initVar('article_picture7', XOBJ_DTYPE_TXTBOX, null, false);
-        $this->initVar('article_picture7_text', XOBJ_DTYPE_TXTBOX, null, false);
-        $this->initVar('article_picture8', XOBJ_DTYPE_TXTBOX, null, false);
-        $this->initVar('article_picture8_text', XOBJ_DTYPE_TXTBOX, null, false);
-        $this->initVar('article_picture9', XOBJ_DTYPE_TXTBOX, null, false);
-        $this->initVar('article_picture9_text', XOBJ_DTYPE_TXTBOX, null, false);
-        $this->initVar('article_picture10', XOBJ_DTYPE_TXTBOX, null, false);
-        $this->initVar('article_picture10_text', XOBJ_DTYPE_TXTBOX, null, false);
-        $this->initVar('article_author', XOBJ_DTYPE_INT, null, false);
-        $this->initVar('article_online', XOBJ_DTYPE_INT, null, false);
-        $this->initVar('article_attached_file', XOBJ_DTYPE_TXTBOX, null, false);
-        $this->initVar('article_readmore', XOBJ_DTYPE_TXTAREA, null, false);
-
-        // Pour autoriser le html
-        $this->initVar('dohtml', XOBJ_DTYPE_INT, 1, false);
-    }
-
-    /**
-     * Indique si l'article en cours est visible
-     *
-     * @return boolean
-     */
-    public function isArticleOnline()
-    {
-        return $this->getVar('article_online') == REFERENCES_STATUS_ONLINE ? true : false;
-    }
-
-    /**
-     * Retourne une image qui indique si l'article est en ligne ou pas
-     *
-     * @return string
-     */
-    public function getOnlinePicture()
-    {
-        if ($this->isArticleOnline()) {
-            return REFERENCES_IMAGES_URL . 'status_online.png';
-        } else {
-            return REFERENCES_IMAGES_URL . 'status_offline.png';
-        }
-    }
-
-    /**
-     * Retourne la chaine de caractères qui peut être utilisée dans l'attribut href d'une balise html A.
-     *
-     * @return string
-     */
-    public function getHrefTitle()
-    {
-        return references_utils::makeHrefTitle($this->getVar('article_title'));
-    }
-
-    /**
-     * Indique si une image de l'article existe
-     *
-     * @param integer $indice L'indice de l'image recherchée
-     * @return boolean Vrai si l'image existe sinon faux
-     */
-    public function pictureExists($indice)
-    {
-        $return    = false;
-        $fieldName = 'article_picture' . $indice;
-        if (xoops_trim($this->getVar($fieldName)) != '' && file_exists(references_utils::getModuleOption('images_path') . DIRECTORY_SEPARATOR . $this->getVar($fieldName))) {
-            $return = true;
-        }
-
-        return $return;
-    }
-
-    /**
-     * Supprime l'image associée à un article
-     *
-     * @param integer $indice L'indice de l'image recherchée
-     * @return void
-     */
-    public function deletePicture($indice)
-    {
-        $fieldName = 'article_picture' . $indice;
-        if ($this->pictureExists($indice)) {
-            @unlink(references_utils::getModuleOption('images_path') . references_utils::getModuleOption('images_path') . $this->getVar($fieldName));
-        }
-        $this->setVar($fieldName, '');
-    }
-
-    /**
-     * Retourne l'URL de l'image de l'article courant
-     *
-     * @param integer $indice L'indice de l'image recherchée
-     * @return string  L'URL
-     */
-    public function getPictureUrl($indice)
-    {
-        $fieldName = 'article_picture' . $indice;
-        if (xoops_trim($this->getVar($fieldName)) != '' && $this->pictureExists($indice)) {
-            return references_utils::getModuleOption('images_url') . '/' . $this->getVar($fieldName);
-        } else {
-            return REFERENCES_IMAGES_URL . 'blank.gif';
-        }
-    }
-
-    /**
-     * Retourne le chemin de l'image de l'article courante
-     *
-     * @param integer $indice L'indice de l'image recherchée
-     * @return string  Le chemin
-     */
-    public function getPicturePath($indice)
-    {
-        $fieldName = 'article_picture' . $indice;
-        if (xoops_trim($this->getVar($fieldName)) != '') {
-            return references_utils::getModuleOption('images_path') . DIRECTORY_SEPARATOR . $this->getVar($fieldName);
-        } else {
-            return '';
-        }
-    }
-
-    /**
-     * Indique si la vignette de l'image de l'article existe
-     *
-     * @param integer $indice L'indice de l'image recherchée
-     * @return boolean Vrai si l'image existe sinon faux
-     */
-    public function thumbExists($indice)
-    {
-        $fieldName = 'article_picture' . $indice;
-        $return    = false;
-        if (xoops_trim($this->getVar($fieldName)) != '' && file_exists(references_utils::getModuleOption('images_path') . DIRECTORY_SEPARATOR . REFERENCES_THUMBS_PREFIX . $this->getVar($fieldName))) {
-            $return = true;
-        }
-
-        return $return;
-    }
-
-    /**
-     * Retourne l'URL de la vignette de l'article
-     *
-     * @param integer $indice L'indice de l'image recherchée
-     * @return string  L'URL
-     */
-    public function getThumbUrl($indice)
-    {
-        $fieldName = 'article_picture' . $indice;
-        if (xoops_trim($this->getVar($fieldName)) != '') {
-            return references_utils::getModuleOption('images_url') . '/' . REFERENCES_THUMBS_PREFIX . $this->getVar($fieldName);
-        } else {
-            return REFERENCES_IMAGES_URL . 'blank.gif';
-        }
-    }
-
-    /**
-     * Retourne le chemin de la vignette de l'annonce
-     *
-     * @param integer $indice L'indice de l'image recherchée
-     * @return string  L'URL
-     */
-    public function getThumbPath($indice)
-    {
-        $fieldName = 'article_picture' . $indice;
-        if (xoops_trim($this->getVar($fieldName)) != '') {
-            return references_utils::getModuleOption('images_path') . DIRECTORY_SEPARATOR . REFERENCES_THUMBS_PREFIX . $this->getVar($fieldName);
-        } else {
-            return '';
-        }
-    }
-
-    /**
-     * Indique si le fichier attaché à un article existe
-     *
-     * @return boolean
-     */
-    public function attachmentExists()
-    {
-        $return = false;
-        if (xoops_trim($this->getVar('article_attached_file')) != '' && file_exists(references_utils::getModuleOption('attached_path') . DIRECTORY_SEPARATOR . $this->getVar('article_attached_file'))) {
-            $return = true;
-        }
-
-        return $return;
-    }
-
-    /**
-     * Retourne l'URL du fichier attaché
-     *
-     * @return string    L'url du fichier attaché sinon une chaine vide
-     */
-    public function getAttachmentUrl()
-    {
-        if (xoops_trim($this->getVar('article_attached_file')) != '' && $this->attachmentExists()) {
-            return references_utils::getModuleOption('attached_url') . '/' . $this->getVar('article_attached_file');
-        } else {
-            return '';
-        }
-    }
-
-    /**
-     * Retourne le chemin du fichier attaché
-     *
-     * @return string    Le chemin du fichier attaché sinon une chaine vide
-     */
-    public function getAttachmentPath()
-    {
-        if (xoops_trim($this->getVar('article_attached_file')) != '' && $this->attachmentExists()) {
-            return references_utils::getModuleOption('attached_path') . DIRECTORY_SEPARATOR . $this->getVar('article_attached_file');
-        } else {
-            return '';
-        }
-    }
-
-    /**
-     * Supprime le fichier attaché à un article
-     */
-    public function deleteAttachment()
-    {
-        if ($this->attachmentExists()) {
-            @unlink(references_utils::getModuleOption('attached_path') . DIRECTORY_SEPARATOR . $this->getVar('article_attached_file'));
-        }
-        $this->setVar('article_attached_file', '');
-    }
-
-    /**
-     * Supprime la miniature associée à l'article
-     *
-     * @param integer $indice L'indice de l'image recherchée
-     * @return void
-     */
-    public function deleteThumb($indice)
-    {
-        $fieldName = 'article_picture' . $indice;
-        if ($this->thumbExists($indice)) {
-            @unlink(references_utils::getModuleOption('images_path') . DIRECTORY_SEPARATOR . REFERENCES_THUMBS_PREFIX . $this->getVar($fieldName));
-        }
-    }
-
-    /**
-     * Supprime l'image (et vignette) d'un article (raccourcis)
-     *
-     * @return void
-     */
-    public function deletePicturesAndThumbs()
-    {
-        for ($i = 1; $i <= 10; ++$i) {
-            $this->deleteThumb($i);
-            $this->deletePicture($i);
-        }
-    }
-
-    /**
-     * Retourne le timestamp de création formaté
-     *
-     * @return string
-     */
-    public function getFormatedTimeStamp()
-    {
-        return formatTimestamp($this->getVar('article_timestamp'), 's');
-    }
-
-    /**
-     * Indique s'il existe au moins une image pour l'article
-     *
-     * @return boolean
-     */
-    public function isThereAPicture()
-    {
-        for ($i = 1; $i <= 10; ++$i) {
-            if ($this->pictureExists($i)) {
-                return true;
-            }
-        }
-
-        return false;
-    }
-
-    /**
-     * Inidique s'il existe au moins une vignette pour l'article
-     *
-     * @return boolean
-     */
-    public function isThereAThumb()
-    {
-        for ($i = 1; $i <= 10; ++$i) {
-            if ($this->thumbExists($i)) {
-                return true;
-            }
-        }
-
-        return false;
-    }
-
-    /**
-     * Retourne l'url pour atteindre l'élément
-     *
-     * @param bool $shortVersion
-     * @return string
-     */
-    public function getUrl($shortVersion = false)
-    {
-        if (!$shortVersion) {
-            return REFERENCES_URL . 'reference.php?article_id=' . $this->getVar('article_id');
-        } else {
-            return 'reference.php?article_id=' . $this->getVar('article_id');
-        }
-    }
-
-    /**
-     * Retourne les éléments de l'annnonce formatés pour affichage
-     *
-     * @param string $format Format à utiliser
-     * @return array
-     */
-    public function toArray($format = 's')
-    {
-        $ret                       = array();
-        $ret                       = parent::toArray($format);
-        $hrefTitle                 = $this->getHrefTitle();
-        $ret['article_href_title'] = $hrefTitle;
-        $ret['article_url']        = $this->getUrl();
-        // Indique si une annonce est expirée
-        $ret['article_is_online'] = $this->isArticleOnline();
-        if ($this->isThereAPicture()) {
-            $ret['article_picture_exists'] = true;
-            for ($i = 1; $i <= 10; ++$i) {
-                if ($this->pictureExists($i)) {
-                    $ret['article_picture_url' . $i]  = $this->getPictureUrl($i);
-                    $ret['article_picture_path' . $i] = $this->getPicturePath($i);
-                    $ret['article_pictures_urls'][]   = $this->getPictureUrl($i);
-                    $ret['article_pictures_paths'][]  = $this->getPicturePath($i);
-                    $fieldName                        = 'article_picture' . $i . '_text';
-                    if (xoops_trim($this->getVar($fieldName)) != '') {
-                        $ret['article_pictures_texts'][] = references_utils::makeHrefTitle($this->getVar($fieldName));
-                    } else {
-                        $ret['article_pictures_texts'][] = $hrefTitle;
-                    }
-                }
-            }
-        } else {
-            $ret['article_picture_exists'] = false;
-        }
-        $ret['article_short_text'] = references_utils::truncate_tagsafe($this->getVar('article_text'), REFERENCES_SHORTEN_TEXT);
-
-        if ($this->attachmentExists()) {
-            $ret['article_attachment_exists'] = true;
-            $ret['article_attachment_url']    = $this->getAttachmentUrl();
-            $ret['article_attachment_path']   = $this->getAttachmentPath();
-        } else {
-            $ret['attachment_exists'] = false;
-        }
-
-        if ($this->isThereAThumb()) {
-            $ret['article_thumb_exists'] = true;
-            for ($i = 1; $i <= 10; ++$i) {
-                if ($this->thumbExists($i)) {
-                    $ret['article_thumb_url' . $i]  = $this->getThumbUrl($i);
-                    $ret['article_thumb_path' . $i] = $this->getThumbPath($i);
-                    $ret['article_thumbs_urls'][]   = $this->getThumbUrl($i);
-                    $ret['article_thumbs_paths'][]  = $this->getThumbPath($i);
-                }
-            }
-        } else {
-            $ret['article_thumb_exists'] = false;
-        }
-
-        $ret['article_timestamp_formated'] = $this->getFormatedTimeStamp();
-
-        return $ret;
-    }
+	public function __construct()
+	{
+		$this->initVar('article_id', XOBJ_DTYPE_INT, null, false);
+		$this->initVar('article_category_id', XOBJ_DTYPE_INT, null, false);
+		$this->initVar('article_timestamp', XOBJ_DTYPE_INT, null, false);
+		$this->initVar('article_weight', XOBJ_DTYPE_INT, null, false);
+		$this->initVar('article_date', XOBJ_DTYPE_TXTBOX, null, false);
+		$this->initVar('article_title', XOBJ_DTYPE_TXTBOX, null, false);
+		$this->initVar('article_text', XOBJ_DTYPE_TXTAREA, null, false);
+		$this->initVar('article_externalurl', XOBJ_DTYPE_TXTBOX, null, false);
+		$this->initVar('article_picture1', XOBJ_DTYPE_TXTBOX, null, false);
+		$this->initVar('article_picture1_text', XOBJ_DTYPE_TXTBOX, null, false);
+		$this->initVar('article_picture2', XOBJ_DTYPE_TXTBOX, null, false);
+		$this->initVar('article_picture2_text', XOBJ_DTYPE_TXTBOX, null, false);
+		$this->initVar('article_picture3', XOBJ_DTYPE_TXTBOX, null, false);
+		$this->initVar('article_picture3_text', XOBJ_DTYPE_TXTBOX, null, false);
+		$this->initVar('article_picture4', XOBJ_DTYPE_TXTBOX, null, false);
+		$this->initVar('article_picture4_text', XOBJ_DTYPE_TXTBOX, null, false);
+		$this->initVar('article_picture5', XOBJ_DTYPE_TXTBOX, null, false);
+		$this->initVar('article_picture5_text', XOBJ_DTYPE_TXTBOX, null, false);
+		$this->initVar('article_picture6', XOBJ_DTYPE_TXTBOX, null, false);
+		$this->initVar('article_picture6_text', XOBJ_DTYPE_TXTBOX, null, false);
+		$this->initVar('article_picture7', XOBJ_DTYPE_TXTBOX, null, false);
+		$this->initVar('article_picture7_text', XOBJ_DTYPE_TXTBOX, null, false);
+		$this->initVar('article_picture8', XOBJ_DTYPE_TXTBOX, null, false);
+		$this->initVar('article_picture8_text', XOBJ_DTYPE_TXTBOX, null, false);
+		$this->initVar('article_picture9', XOBJ_DTYPE_TXTBOX, null, false);
+		$this->initVar('article_picture9_text', XOBJ_DTYPE_TXTBOX, null, false);
+		$this->initVar('article_picture10', XOBJ_DTYPE_TXTBOX, null, false);
+		$this->initVar('article_picture10_text', XOBJ_DTYPE_TXTBOX, null, false);
+		$this->initVar('article_author', XOBJ_DTYPE_INT, null, false);
+		$this->initVar('article_online', XOBJ_DTYPE_INT, null, false);
+		$this->initVar('article_attached_file', XOBJ_DTYPE_TXTBOX, null, false);
+		$this->initVar('article_readmore', XOBJ_DTYPE_TXTAREA, null, false);
+
+		// Pour autoriser le html
+		$this->initVar('dohtml', XOBJ_DTYPE_INT, 1, false);
+	}
+
+	/**
+	 * Indique si l'article en cours est visible
+	 *
+	 * @return boolean
+	 */
+	public function isArticleOnline()
+	{
+		return $this->getVar('article_online') == REFERENCES_STATUS_ONLINE ? true : false;
+	}
+
+	/**
+	 * Retourne une image qui indique si l'article est en ligne ou pas
+	 *
+	 * @return string
+	 */
+	public function getOnlinePicture()
+	{
+		if ($this->isArticleOnline()) {
+			return REFERENCES_IMAGES_URL . 'status_online.png';
+		} else {
+			return REFERENCES_IMAGES_URL . 'status_offline.png';
+		}
+	}
+
+	/**
+	 * Retourne la chaine de caractères qui peut être utilisée dans l'attribut href d'une balise html A.
+	 *
+	 * @return string
+	 */
+	public function getHrefTitle()
+	{
+		return references_utils::makeHrefTitle($this->getVar('article_title'));
+	}
+
+	/**
+	 * Indique si une image de l'article existe
+	 *
+	 * @param integer $indice L'indice de l'image recherchée
+	 * @return boolean Vrai si l'image existe sinon faux
+	 */
+	public function pictureExists($indice)
+	{
+		$return    = false;
+		$fieldName = 'article_picture' . $indice;
+		if (xoops_trim($this->getVar($fieldName)) != '' && file_exists(references_utils::getModuleOption('images_path') . DIRECTORY_SEPARATOR . $this->getVar($fieldName))) {
+			$return = true;
+		}
+
+		return $return;
+	}
+
+	/**
+	 * Supprime l'image associée à un article
+	 *
+	 * @param integer $indice L'indice de l'image recherchée
+	 * @return void
+	 */
+	public function deletePicture($indice)
+	{
+		$fieldName = 'article_picture' . $indice;
+		if ($this->pictureExists($indice)) {
+			@unlink(references_utils::getModuleOption('images_path') . references_utils::getModuleOption('images_path') . $this->getVar($fieldName));
+		}
+		$this->setVar($fieldName, '');
+	}
+
+	/**
+	 * Retourne l'URL de l'image de l'article courant
+	 *
+	 * @param integer $indice L'indice de l'image recherchée
+	 * @return string  L'URL
+	 */
+	public function getPictureUrl($indice)
+	{
+		$fieldName = 'article_picture' . $indice;
+		if (xoops_trim($this->getVar($fieldName)) != '' && $this->pictureExists($indice)) {
+			return references_utils::getModuleOption('images_url') . '/' . $this->getVar($fieldName);
+		} else {
+			return REFERENCES_IMAGES_URL . 'blank.gif';
+		}
+	}
+
+	/**
+	 * Retourne le chemin de l'image de l'article courante
+	 *
+	 * @param integer $indice L'indice de l'image recherchée
+	 * @return string  Le chemin
+	 */
+	public function getPicturePath($indice)
+	{
+		$fieldName = 'article_picture' . $indice;
+		if (xoops_trim($this->getVar($fieldName)) != '') {
+			return references_utils::getModuleOption('images_path') . DIRECTORY_SEPARATOR . $this->getVar($fieldName);
+		} else {
+			return '';
+		}
+	}
+
+	/**
+	 * Indique si la vignette de l'image de l'article existe
+	 *
+	 * @param integer $indice L'indice de l'image recherchée
+	 * @return boolean Vrai si l'image existe sinon faux
+	 */
+	public function thumbExists($indice)
+	{
+		$fieldName = 'article_picture' . $indice;
+		$return    = false;
+		if (xoops_trim($this->getVar($fieldName)) != '' && file_exists(references_utils::getModuleOption('images_path') . DIRECTORY_SEPARATOR . REFERENCES_THUMBS_PREFIX . $this->getVar($fieldName))) {
+			$return = true;
+		}
+
+		return $return;
+	}
+
+	/**
+	 * Retourne l'URL de la vignette de l'article
+	 *
+	 * @param integer $indice L'indice de l'image recherchée
+	 * @return string  L'URL
+	 */
+	public function getThumbUrl($indice)
+	{
+		$fieldName = 'article_picture' . $indice;
+		if (xoops_trim($this->getVar($fieldName)) != '') {
+			return references_utils::getModuleOption('images_url') . '/' . REFERENCES_THUMBS_PREFIX . $this->getVar($fieldName);
+		} else {
+			return REFERENCES_IMAGES_URL . 'blank.gif';
+		}
+	}
+
+	/**
+	 * Retourne le chemin de la vignette de l'annonce
+	 *
+	 * @param integer $indice L'indice de l'image recherchée
+	 * @return string  L'URL
+	 */
+	public function getThumbPath($indice)
+	{
+		$fieldName = 'article_picture' . $indice;
+		if (xoops_trim($this->getVar($fieldName)) != '') {
+			return references_utils::getModuleOption('images_path') . DIRECTORY_SEPARATOR . REFERENCES_THUMBS_PREFIX . $this->getVar($fieldName);
+		} else {
+			return '';
+		}
+	}
+
+	/**
+	 * Indique si le fichier attaché à un article existe
+	 *
+	 * @return boolean
+	 */
+	public function attachmentExists()
+	{
+		$return = false;
+		if (xoops_trim($this->getVar('article_attached_file')) != '' && file_exists(references_utils::getModuleOption('attached_path') . DIRECTORY_SEPARATOR . $this->getVar('article_attached_file'))) {
+			$return = true;
+		}
+
+		return $return;
+	}
+
+	/**
+	 * Retourne l'URL du fichier attaché
+	 *
+	 * @return string    L'url du fichier attaché sinon une chaine vide
+	 */
+	public function getAttachmentUrl()
+	{
+		if (xoops_trim($this->getVar('article_attached_file')) != '' && $this->attachmentExists()) {
+			return references_utils::getModuleOption('attached_url') . '/' . $this->getVar('article_attached_file');
+		} else {
+			return '';
+		}
+	}
+
+	/**
+	 * Retourne le chemin du fichier attaché
+	 *
+	 * @return string    Le chemin du fichier attaché sinon une chaine vide
+	 */
+	public function getAttachmentPath()
+	{
+		if (xoops_trim($this->getVar('article_attached_file')) != '' && $this->attachmentExists()) {
+			return references_utils::getModuleOption('attached_path') . DIRECTORY_SEPARATOR . $this->getVar('article_attached_file');
+		} else {
+			return '';
+		}
+	}
+
+	/**
+	 * Supprime le fichier attaché à un article
+	 */
+	public function deleteAttachment()
+	{
+		if ($this->attachmentExists()) {
+			@unlink(references_utils::getModuleOption('attached_path') . DIRECTORY_SEPARATOR . $this->getVar('article_attached_file'));
+		}
+		$this->setVar('article_attached_file', '');
+	}
+
+	/**
+	 * Supprime la miniature associée à l'article
+	 *
+	 * @param integer $indice L'indice de l'image recherchée
+	 * @return void
+	 */
+	public function deleteThumb($indice)
+	{
+		$fieldName = 'article_picture' . $indice;
+		if ($this->thumbExists($indice)) {
+			@unlink(references_utils::getModuleOption('images_path') . DIRECTORY_SEPARATOR . REFERENCES_THUMBS_PREFIX . $this->getVar($fieldName));
+		}
+	}
+
+	/**
+	 * Supprime l'image (et vignette) d'un article (raccourcis)
+	 *
+	 * @return void
+	 */
+	public function deletePicturesAndThumbs()
+	{
+		for ($i = 1; $i <= 10; ++$i) {
+			$this->deleteThumb($i);
+			$this->deletePicture($i);
+		}
+	}
+
+	/**
+	 * Retourne le timestamp de création formaté
+	 *
+	 * @return string
+	 */
+	public function getFormatedTimeStamp()
+	{
+		return formatTimestamp($this->getVar('article_timestamp'), 's');
+	}
+
+	/**
+	 * Indique s'il existe au moins une image pour l'article
+	 *
+	 * @return boolean
+	 */
+	public function isThereAPicture()
+	{
+		for ($i = 1; $i <= 10; ++$i) {
+			if ($this->pictureExists($i)) {
+				return true;
+			}
+		}
+
+		return false;
+	}
+
+	/**
+	 * Inidique s'il existe au moins une vignette pour l'article
+	 *
+	 * @return boolean
+	 */
+	public function isThereAThumb()
+	{
+		for ($i = 1; $i <= 10; ++$i) {
+			if ($this->thumbExists($i)) {
+				return true;
+			}
+		}
+
+		return false;
+	}
+
+	/**
+	 * Retourne l'url pour atteindre l'élément
+	 *
+	 * @param bool $shortVersion
+	 * @return string
+	 */
+	public function getUrl($shortVersion = false)
+	{
+		if (!$shortVersion) {
+			return REFERENCES_URL . 'reference.php?article_id=' . $this->getVar('article_id');
+		} else {
+			return 'reference.php?article_id=' . $this->getVar('article_id');
+		}
+	}
+
+	/**
+	 * Retourne les éléments de l'annnonce formatés pour affichage
+	 *
+	 * @param string $format Format à utiliser
+	 * @return array
+	 */
+	public function toArray($format = 's')
+	{
+		$ret                       = array();
+		$ret                       = parent::toArray($format);
+		$hrefTitle                 = $this->getHrefTitle();
+		$ret['article_href_title'] = $hrefTitle;
+		$ret['article_url']        = $this->getUrl();
+		// Indique si une annonce est expirée
+		$ret['article_is_online'] = $this->isArticleOnline();
+		if ($this->isThereAPicture()) {
+			$ret['article_picture_exists'] = true;
+			for ($i = 1; $i <= 10; ++$i) {
+				if ($this->pictureExists($i)) {
+					$ret['article_picture_url' . $i]  = $this->getPictureUrl($i);
+					$ret['article_picture_path' . $i] = $this->getPicturePath($i);
+					$ret['article_pictures_urls'][]   = $this->getPictureUrl($i);
+					$ret['article_pictures_paths'][]  = $this->getPicturePath($i);
+					$fieldName                        = 'article_picture' . $i . '_text';
+					if (xoops_trim($this->getVar($fieldName)) != '') {
+						$ret['article_pictures_texts'][] = references_utils::makeHrefTitle($this->getVar($fieldName));
+					} else {
+						$ret['article_pictures_texts'][] = $hrefTitle;
+					}
+				}
+			}
+		} else {
+			$ret['article_picture_exists'] = false;
+		}
+		$ret['article_short_text'] = references_utils::truncate_tagsafe($this->getVar('article_text'), REFERENCES_SHORTEN_TEXT);
+
+		if ($this->attachmentExists()) {
+			$ret['article_attachment_exists'] = true;
+			$ret['article_attachment_url']    = $this->getAttachmentUrl();
+			$ret['article_attachment_path']   = $this->getAttachmentPath();
+		} else {
+			$ret['attachment_exists'] = false;
+		}
+
+		if ($this->isThereAThumb()) {
+			$ret['article_thumb_exists'] = true;
+			for ($i = 1; $i <= 10; ++$i) {
+				if ($this->thumbExists($i)) {
+					$ret['article_thumb_url' . $i]  = $this->getThumbUrl($i);
+					$ret['article_thumb_path' . $i] = $this->getThumbPath($i);
+					$ret['article_thumbs_urls'][]   = $this->getThumbUrl($i);
+					$ret['article_thumbs_paths'][]  = $this->getThumbPath($i);
+				}
+			}
+		} else {
+			$ret['article_thumb_exists'] = false;
+		}
+
+		$ret['article_timestamp_formated'] = $this->getFormatedTimeStamp();
+
+		return $ret;
+	}
 }
 
 class ReferencesReferences_articlesHandler extends references_XoopsPersistableObjectHandler
 {
-    public function __construct($db)
-    {    //                         Table                   Classe                Id            Descr.
-        parent::__construct($db, 'references_articles', 'references_articles', 'article_id', 'article_title');
-    }
-
-    /**
-     * Retourne le critère à utiliser pour voir les catégories en respectant les permissions
-     *
-     * @param  string $permissionsType Type de permission (pour l'instant permission de voir)
-     * @return obejct de type Criteria
-     */
-    public function getPermissionsCategoriesCriteria($permissionsType = REFERENCES_PERM_READ)
-    {
-        global $xoopsUser;
-        static $permissions = array();
-        if (is_array($permissions) && array_key_exists($permissionsType, $permissions)) {
-            return $permissions[$permissionsType];
-        }
-        $categories    = array();
-        $currentModule = references_utils::getModule();
-        $groups        = is_object($xoopsUser) ? $xoopsUser->getGroups() : XOOPS_GROUP_ANONYMOUS;
-        $gperm_handler = xoops_getHandler('groupperm');
-        $categories    = $gperm_handler->getItemIds($permissionsType, $groups, $currentModule->getVar('mid'));
-        if (is_array($categories) && count($categories) > 0) {
-            $permissions[$permissionsType] = new Criteria('article_category_id', '(' . implode(',', $categories) . ')', 'IN');
-        } else {    // Ne peut rien voir
-            $permissions[$permissionsType] = new Criteria('article_category_id', '0', '=');
-        }
-
-        return $permissions[$permissionsType];
-    }
-
-    /**
-     * Retourne les articles récents en tenant compte des permissions de consultation sur les catégories
-     *
-     * @param integer  $start      Indice de début
-     * @param integer  $limit      Nombre d'objets à renvoyer
-     * @param  string  $sort       Zone de tri
-     * @param  string  $order      Sens du tri
-     * @param  boolean $onlyOnline Uniquement les articles en ligne ?
-     * @param integer  $categoryId Identifiant d'une catégorie à laquelle se limiter
-     * @return array   Objets de type references_articles
-     */
-    public function getRecentArticles($start = 0, $limit = 0, $sort = 'article_timestamp', $order = 'DESC', $onlyOnline = true, $categoryId = 0)
-    {
-        $criteria = new CriteriaCompo();
-        $criteria->add(new Criteria('article_id', 0, '<>'));
-        $criteria->add($this->getPermissionsCategoriesCriteria());
-        if ($onlyOnline) {
-            $criteria->add(new Criteria('article_online', REFERENCES_STATUS_ONLINE, '='));
-        }
-        if (is_array($categoryId) && count($categoryId) > 0) {
-            $criteria->add(new Criteria('article_category_id', '(' . implode(',', $categoryId) . ')', 'IN'));
-        } elseif ($categoryId > 0) {
-            $criteria->add(new Criteria('article_category_id', $categoryId, '='));
-        }
-        $criteria->setStart($start);
-        $criteria->setSort($sort);
-        $criteria->setOrder($order);
-        $criteria->setLimit($limit);
-
-        return $this->getObjects($criteria);
-    }
-
-    /**
-     * Retourne le nombre total d'articles en ligne
-     *
-     * @return integer
-     */
-    public function getOnlineArticlesCount()
-    {
-        return $this->getCount(new Criteria('article_online', REFERENCES_STATUS_ONLINE, '='));
-    }
-
-    /**
-     * Notification de la publication d'une nouvelle référence
-     *
-     * @param object|references_articles $article L'annonce pour laquelle on fait la notification
-     * @return bool
-     */
-    public function notifyNewArticle(references_articles $article)
-    {
-        $plugins = references_plugins::getInstance();
-        $plugins->fireAction(references_plugins::EVENT_ON_REFERENCE_CREATE, new references_parameters(array('reference' => $article)));
-
-        return true;
-    }
-
-    /**
-     * Effectue la suppression d'un article (et de ses images et fichier attaché)
-     *
-     * @param references_articles $article L'article à supprimer
-     * @return boolean    Le résultat de la suppression
-     */
-    public function deleteArticle(references_articles $article)
-    {
-        $article->deletePicturesAndThumbs();
-        $article->deleteAttachment();
-
-        return $this->delete($article, true);
-    }
-
-    /**
-     * Retourne la liste des catégories uniques utilisées par les références
-     *
-     */
-    public function getDistinctCategoriesIds()
-    {
-        $ret = array();
-        $sql = 'SELECT distinct(article_category_id) FROM ' . $this->table;
-        $sql .= ' ' . $this->getPermissionsCategoriesCriteria()->renderWhere();    // Permissions
-        $sql .= ' GROUP BY article_category_id ORDER BY article_category_id';
-        $result = $this->db->query($sql);
-        if (!$result) {
-            return $ret;
-        }
-        while ($row = $this->db->fetchArray($result)) {
-            $ret[$row['article_category_id']] = $row['article_category_id'];
-        }
-
-        return $ret;
-    }
-
-    /**
-     * Passe un article en ligne
-     *
-     * @param  references_articles $article
-     * @return boolean
-     */
-    public function onlineArticle(references_articles $article)
-    {
-        $article->setVar('article_online', REFERENCES_STATUS_ONLINE);
-
-        return $this->insert($article, true);
-    }
-
-    /**
-     * Passe un article hors ligne
-     *
-     * @param  references_articles $article
-     * @return boolean
-     */
-    public function offlineArticle(references_articles $article)
-    {
-        $article->setVar('article_online', REFERENCES_STATUS_OFFLINE);
-
-        return $this->insert($article, true);
-    }
-
-    /**
-     * Indique si une référence est visible d'un utilisateur
-     *
-     * @param object|references_articles $article L'article à controler
-     * @param integer                    $uid     L'id de l'utilisateur à controler
-     * @return bool
-     */
-    public function userCanSeeReference(references_articles $article, $uid = 0)
-    {
-        global $xoopsUser;
-        if ($uid == 0) {
-            $uid = references_utils::getCurrentUserID();
-        }
-        $currentModule = references_utils::getModule();
-        $groups        = is_object($xoopsUser) ? $xoopsUser->getGroups() : XOOPS_GROUP_ANONYMOUS;
-        $gperm_handler = xoops_getHandler('groupperm');
-
-        return $gperm_handler->checkRight(REFERENCES_PERM_READ, $article->article_category_id, references_utils::getMemberGroups($uid), $currentModule->getVar('mid'));
-    }
-
-    /**
-     * Remonte un article d'un cran dans l'ordre global des articles
-     *
-     * @param  integer $currentId    L'ID de l'article courant dont on souhaite remonter l'ordre
-     * @param integer  $currentOrder L'ordre de l'élément courant à remonter
-     * @return void
-     */
-    public function moveUp($currentId, $currentOrder)
-    {
-        $sql_plus = 'SELECT article_id FROM ' . $this->table . ' WHERE article_weight = ' . ((int)$currentOrder - 1);
-        $res_plus = $this->db->query($sql_plus);
-        if ($this->db->getRowsNum($res_plus) == 0) {
-            return;
-        }
-        $row_plus = $this->db->fetchArray($res_plus);
-
-        $upd1 = 'UPDATE ' . $this->table . ' SET article_weight = (article_weight + 1) WHERE article_id = ' . $row_plus['article_id'];
-        $this->db->queryF($upd1);
-
-        $upd2 = 'UPDATE ' . $this->table . ' SET article_weight = (article_weight - 1) WHERE article_id = ' . (int)$currentId;
-        $this->db->queryF($upd2);
-        $this->forceCacheClean();
-    }
-
-    /**
-     * Descend un article d'un cran dans l'ordre global des articles
-     *
-     * @param  integer $currentId    L'Id de l'article courant dont on souhaite descendre l'ordre
-     * @param integer  $currentOrder L'orde de l'élément courant à remonter
-     * @return void
-     */
-    public function moveDown($currentId, $currentOrder)
-    {
-        $sql_moins = 'SELECT article_id FROM ' . $this->table . ' WHERE article_weight = ' . ((int)$currentOrder + 1);
-        $res_moins = $this->db->query($sql_moins);
-        if ($this->db->getRowsNum($res_moins) == 0) {
-            return;
-        }
-
-        $row_moins = $this->db->fetchArray($res_moins);
-        $upd1      = 'UPDATE ' . $this->table . ' SET article_weight = (article_weight - 1) WHERE article_id = ' . $row_moins['article_id'];
-        $this->db->queryF($upd1);
-
-        $upd2 = 'UPDATE ' . $this->table . ' SET article_weight =( article_weight + 1) WHERE article_id = ' . (int)$currentId;
-        $this->db->queryF($upd2);
-        $this->forceCacheClean();
-    }
+	public function __construct($db)
+	{    //                         Table                   Classe                Id            Descr.
+		parent::__construct($db, 'references_articles', 'references_articles', 'article_id', 'article_title');
+	}
+
+	/**
+	 * Retourne le critère à utiliser pour voir les catégories en respectant les permissions
+	 *
+	 * @param  string $permissionsType Type de permission (pour l'instant permission de voir)
+	 * @return obejct de type Criteria
+	 */
+	public function getPermissionsCategoriesCriteria($permissionsType = REFERENCES_PERM_READ)
+	{
+		global $xoopsUser;
+		static $permissions = array();
+		if (is_array($permissions) && array_key_exists($permissionsType, $permissions)) {
+			return $permissions[$permissionsType];
+		}
+		$categories    = array();
+		$currentModule = references_utils::getModule();
+		$groups        = is_object($xoopsUser) ? $xoopsUser->getGroups() : XOOPS_GROUP_ANONYMOUS;
+		$gperm_handler = xoops_getHandler('groupperm');
+		$categories    = $gperm_handler->getItemIds($permissionsType, $groups, $currentModule->getVar('mid'));
+		if (is_array($categories) && count($categories) > 0) {
+			$permissions[$permissionsType] = new Criteria('article_category_id', '(' . implode(',', $categories) . ')', 'IN');
+		} else {    // Ne peut rien voir
+			$permissions[$permissionsType] = new Criteria('article_category_id', '0', '=');
+		}
+
+		return $permissions[$permissionsType];
+	}
+
+	/**
+	 * Retourne les articles récents en tenant compte des permissions de consultation sur les catégories
+	 *
+	 * @param integer  $start      Indice de début
+	 * @param integer  $limit      Nombre d'objets à renvoyer
+	 * @param  string  $sort       Zone de tri
+	 * @param  string  $order      Sens du tri
+	 * @param  boolean $onlyOnline Uniquement les articles en ligne ?
+	 * @param integer  $categoryId Identifiant d'une catégorie à laquelle se limiter
+	 * @return array   Objets de type references_articles
+	 */
+	public function getRecentArticles($start = 0, $limit = 0, $sort = 'article_timestamp', $order = 'DESC', $onlyOnline = true, $categoryId = 0)
+	{
+		$criteria = new CriteriaCompo();
+		$criteria->add(new Criteria('article_id', 0, '<>'));
+		$criteria->add($this->getPermissionsCategoriesCriteria());
+		if ($onlyOnline) {
+			$criteria->add(new Criteria('article_online', REFERENCES_STATUS_ONLINE, '='));
+		}
+		if (is_array($categoryId) && count($categoryId) > 0) {
+			$criteria->add(new Criteria('article_category_id', '(' . implode(',', $categoryId) . ')', 'IN'));
+		} elseif ($categoryId > 0) {
+			$criteria->add(new Criteria('article_category_id', $categoryId, '='));
+		}
+		$criteria->setStart($start);
+		$criteria->setSort($sort);
+		$criteria->setOrder($order);
+		$criteria->setLimit($limit);
+
+		return $this->getObjects($criteria);
+	}
+
+	/**
+	 * Retourne le nombre total d'articles en ligne
+	 *
+	 * @return integer
+	 */
+	public function getOnlineArticlesCount()
+	{
+		return $this->getCount(new Criteria('article_online', REFERENCES_STATUS_ONLINE, '='));
+	}
+
+	/**
+	 * Notification de la publication d'une nouvelle référence
+	 *
+	 * @param object|references_articles $article L'annonce pour laquelle on fait la notification
+	 * @return bool
+	 */
+	public function notifyNewArticle(references_articles $article)
+	{
+		$plugins = references_plugins::getInstance();
+		$plugins->fireAction(references_plugins::EVENT_ON_REFERENCE_CREATE, new references_parameters(array('reference' => $article)));
+
+		return true;
+	}
+
+	/**
+	 * Effectue la suppression d'un article (et de ses images et fichier attaché)
+	 *
+	 * @param references_articles $article L'article à supprimer
+	 * @return boolean    Le résultat de la suppression
+	 */
+	public function deleteArticle(references_articles $article)
+	{
+		$article->deletePicturesAndThumbs();
+		$article->deleteAttachment();
+
+		return $this->delete($article, true);
+	}
+
+	/**
+	 * Retourne la liste des catégories uniques utilisées par les références
+	 *
+	 */
+	public function getDistinctCategoriesIds()
+	{
+		$ret = array();
+		$sql = 'SELECT distinct(article_category_id) FROM ' . $this->table;
+		$sql .= ' ' . $this->getPermissionsCategoriesCriteria()->renderWhere();    // Permissions
+		$sql .= ' GROUP BY article_category_id ORDER BY article_category_id';
+		$result = $this->db->query($sql);
+		if (!$result) {
+			return $ret;
+		}
+		while ($row = $this->db->fetchArray($result)) {
+			$ret[$row['article_category_id']] = $row['article_category_id'];
+		}
+
+		return $ret;
+	}
+
+	/**
+	 * Passe un article en ligne
+	 *
+	 * @param  references_articles $article
+	 * @return boolean
+	 */
+	public function onlineArticle(references_articles $article)
+	{
+		$article->setVar('article_online', REFERENCES_STATUS_ONLINE);
+
+		return $this->insert($article, true);
+	}
+
+	/**
+	 * Passe un article hors ligne
+	 *
+	 * @param  references_articles $article
+	 * @return boolean
+	 */
+	public function offlineArticle(references_articles $article)
+	{
+		$article->setVar('article_online', REFERENCES_STATUS_OFFLINE);
+
+		return $this->insert($article, true);
+	}
+
+	/**
+	 * Indique si une référence est visible d'un utilisateur
+	 *
+	 * @param object|references_articles $article L'article à controler
+	 * @param integer                    $uid     L'id de l'utilisateur à controler
+	 * @return bool
+	 */
+	public function userCanSeeReference(references_articles $article, $uid = 0)
+	{
+		global $xoopsUser;
+		if ($uid == 0) {
+			$uid = references_utils::getCurrentUserID();
+		}
+		$currentModule = references_utils::getModule();
+		$groups        = is_object($xoopsUser) ? $xoopsUser->getGroups() : XOOPS_GROUP_ANONYMOUS;
+		$gperm_handler = xoops_getHandler('groupperm');
+
+		return $gperm_handler->checkRight(REFERENCES_PERM_READ, $article->article_category_id, references_utils::getMemberGroups($uid), $currentModule->getVar('mid'));
+	}
+
+	/**
+	 * Remonte un article d'un cran dans l'ordre global des articles
+	 *
+	 * @param  integer $currentId    L'ID de l'article courant dont on souhaite remonter l'ordre
+	 * @param integer  $currentOrder L'ordre de l'élément courant à remonter
+	 * @return void
+	 */
+	public function moveUp($currentId, $currentOrder)
+	{
+		$sql_plus = 'SELECT article_id FROM ' . $this->table . ' WHERE article_weight = ' . ((int)$currentOrder - 1);
+		$res_plus = $this->db->query($sql_plus);
+		if ($this->db->getRowsNum($res_plus) == 0) {
+			return;
+		}
+		$row_plus = $this->db->fetchArray($res_plus);
+
+		$upd1 = 'UPDATE ' . $this->table . ' SET article_weight = (article_weight + 1) WHERE article_id = ' . $row_plus['article_id'];
+		$this->db->queryF($upd1);
+
+		$upd2 = 'UPDATE ' . $this->table . ' SET article_weight = (article_weight - 1) WHERE article_id = ' . (int)$currentId;
+		$this->db->queryF($upd2);
+		$this->forceCacheClean();
+	}
+
+	/**
+	 * Descend un article d'un cran dans l'ordre global des articles
+	 *
+	 * @param  integer $currentId    L'Id de l'article courant dont on souhaite descendre l'ordre
+	 * @param integer  $currentOrder L'orde de l'élément courant à remonter
+	 * @return void
+	 */
+	public function moveDown($currentId, $currentOrder)
+	{
+		$sql_moins = 'SELECT article_id FROM ' . $this->table . ' WHERE article_weight = ' . ((int)$currentOrder + 1);
+		$res_moins = $this->db->query($sql_moins);
+		if ($this->db->getRowsNum($res_moins) == 0) {
+			return;
+		}
+
+		$row_moins = $this->db->fetchArray($res_moins);
+		$upd1      = 'UPDATE ' . $this->table . ' SET article_weight = (article_weight - 1) WHERE article_id = ' . $row_moins['article_id'];
+		$this->db->queryF($upd1);
+
+		$upd2 = 'UPDATE ' . $this->table . ' SET article_weight =( article_weight + 1) WHERE article_id = ' . (int)$currentId;
+		$this->db->queryF($upd2);
+		$this->forceCacheClean();
+	}
 }

Spacing +45 added lines, -45 removed lines

@@ -20,13 +20,13 @@ 
  */
 defined('XOOPS_ROOT_PATH') || exit('XOOPS root path not defined');
 
-require_once XOOPS_ROOT_PATH . '/kernel/object.php';
+require_once XOOPS_ROOT_PATH.'/kernel/object.php';
 if (!class_exists('references_XoopsPersistableObjectHandler')) {
-    require_once XOOPS_ROOT_PATH . '/modules/references/class/PersistableObjectHandler.php';
+    require_once XOOPS_ROOT_PATH.'/modules/references/class/PersistableObjectHandler.php';
 }
 
-define('REFERENCES_STATUS_ONLINE', 1);    // Articles en ligne
-define('REFERENCES_STATUS_OFFLINE', 0);    // Articles hors ligne
+define('REFERENCES_STATUS_ONLINE', 1); // Articles en ligne
+define('REFERENCES_STATUS_OFFLINE', 0); // Articles hors ligne
 
 class references_articles extends references_Object
 {
@@ -87,9 +87,9 @@ 
     public function getOnlinePicture()
     {
         if ($this->isArticleOnline()) {
-            return REFERENCES_IMAGES_URL . 'status_online.png';
+            return REFERENCES_IMAGES_URL.'status_online.png';
         } else {
-            return REFERENCES_IMAGES_URL . 'status_offline.png';
+            return REFERENCES_IMAGES_URL.'status_offline.png';
         }
     }
 
@@ -112,8 +112,8 @@ 
     public function pictureExists($indice)
     {
         $return    = false;
-        $fieldName = 'article_picture' . $indice;
-        if (xoops_trim($this->getVar($fieldName)) != '' && file_exists(references_utils::getModuleOption('images_path') . DIRECTORY_SEPARATOR . $this->getVar($fieldName))) {
+        $fieldName = 'article_picture'.$indice;
+        if (xoops_trim($this->getVar($fieldName)) != '' && file_exists(references_utils::getModuleOption('images_path').DIRECTORY_SEPARATOR.$this->getVar($fieldName))) {
             $return = true;
         }
 
@@ -128,9 +128,9 @@ 
      */
     public function deletePicture($indice)
     {
-        $fieldName = 'article_picture' . $indice;
+        $fieldName = 'article_picture'.$indice;
         if ($this->pictureExists($indice)) {
-            @unlink(references_utils::getModuleOption('images_path') . references_utils::getModuleOption('images_path') . $this->getVar($fieldName));
+            @unlink(references_utils::getModuleOption('images_path').references_utils::getModuleOption('images_path').$this->getVar($fieldName));
         }
         $this->setVar($fieldName, '');
     }
@@ -143,11 +143,11 @@ 
      */
     public function getPictureUrl($indice)
     {
-        $fieldName = 'article_picture' . $indice;
+        $fieldName = 'article_picture'.$indice;
         if (xoops_trim($this->getVar($fieldName)) != '' && $this->pictureExists($indice)) {
-            return references_utils::getModuleOption('images_url') . '/' . $this->getVar($fieldName);
+            return references_utils::getModuleOption('images_url').'/'.$this->getVar($fieldName);
         } else {
-            return REFERENCES_IMAGES_URL . 'blank.gif';
+            return REFERENCES_IMAGES_URL.'blank.gif';
         }
     }
 
@@ -159,9 +159,9 @@ 
      */
     public function getPicturePath($indice)
     {
-        $fieldName = 'article_picture' . $indice;
+        $fieldName = 'article_picture'.$indice;
         if (xoops_trim($this->getVar($fieldName)) != '') {
-            return references_utils::getModuleOption('images_path') . DIRECTORY_SEPARATOR . $this->getVar($fieldName);
+            return references_utils::getModuleOption('images_path').DIRECTORY_SEPARATOR.$this->getVar($fieldName);
         } else {
             return '';
         }
@@ -175,9 +175,9 @@ 
      */
     public function thumbExists($indice)
     {
-        $fieldName = 'article_picture' . $indice;
+        $fieldName = 'article_picture'.$indice;
         $return    = false;
-        if (xoops_trim($this->getVar($fieldName)) != '' && file_exists(references_utils::getModuleOption('images_path') . DIRECTORY_SEPARATOR . REFERENCES_THUMBS_PREFIX . $this->getVar($fieldName))) {
+        if (xoops_trim($this->getVar($fieldName)) != '' && file_exists(references_utils::getModuleOption('images_path').DIRECTORY_SEPARATOR.REFERENCES_THUMBS_PREFIX.$this->getVar($fieldName))) {
             $return = true;
         }
 
@@ -192,11 +192,11 @@ 
      */
     public function getThumbUrl($indice)
     {
-        $fieldName = 'article_picture' . $indice;
+        $fieldName = 'article_picture'.$indice;
         if (xoops_trim($this->getVar($fieldName)) != '') {
-            return references_utils::getModuleOption('images_url') . '/' . REFERENCES_THUMBS_PREFIX . $this->getVar($fieldName);
+            return references_utils::getModuleOption('images_url').'/'.REFERENCES_THUMBS_PREFIX.$this->getVar($fieldName);
         } else {
-            return REFERENCES_IMAGES_URL . 'blank.gif';
+            return REFERENCES_IMAGES_URL.'blank.gif';
         }
     }
 
@@ -208,9 +208,9 @@ 
      */
     public function getThumbPath($indice)
     {
-        $fieldName = 'article_picture' . $indice;
+        $fieldName = 'article_picture'.$indice;
         if (xoops_trim($this->getVar($fieldName)) != '') {
-            return references_utils::getModuleOption('images_path') . DIRECTORY_SEPARATOR . REFERENCES_THUMBS_PREFIX . $this->getVar($fieldName);
+            return references_utils::getModuleOption('images_path').DIRECTORY_SEPARATOR.REFERENCES_THUMBS_PREFIX.$this->getVar($fieldName);
         } else {
             return '';
         }
@@ -224,7 +224,7 @@ 
     public function attachmentExists()
     {
         $return = false;
-        if (xoops_trim($this->getVar('article_attached_file')) != '' && file_exists(references_utils::getModuleOption('attached_path') . DIRECTORY_SEPARATOR . $this->getVar('article_attached_file'))) {
+        if (xoops_trim($this->getVar('article_attached_file')) != '' && file_exists(references_utils::getModuleOption('attached_path').DIRECTORY_SEPARATOR.$this->getVar('article_attached_file'))) {
             $return = true;
         }
 
@@ -239,7 +239,7 @@ 
     public function getAttachmentUrl()
     {
         if (xoops_trim($this->getVar('article_attached_file')) != '' && $this->attachmentExists()) {
-            return references_utils::getModuleOption('attached_url') . '/' . $this->getVar('article_attached_file');
+            return references_utils::getModuleOption('attached_url').'/'.$this->getVar('article_attached_file');
         } else {
             return '';
         }
@@ -253,7 +253,7 @@ 
     public function getAttachmentPath()
     {
         if (xoops_trim($this->getVar('article_attached_file')) != '' && $this->attachmentExists()) {
-            return references_utils::getModuleOption('attached_path') . DIRECTORY_SEPARATOR . $this->getVar('article_attached_file');
+            return references_utils::getModuleOption('attached_path').DIRECTORY_SEPARATOR.$this->getVar('article_attached_file');
         } else {
             return '';
         }
@@ -265,7 +265,7 @@ 
     public function deleteAttachment()
     {
         if ($this->attachmentExists()) {
-            @unlink(references_utils::getModuleOption('attached_path') . DIRECTORY_SEPARATOR . $this->getVar('article_attached_file'));
+            @unlink(references_utils::getModuleOption('attached_path').DIRECTORY_SEPARATOR.$this->getVar('article_attached_file'));
         }
         $this->setVar('article_attached_file', '');
     }
@@ -278,9 +278,9 @@ 
      */
     public function deleteThumb($indice)
     {
-        $fieldName = 'article_picture' . $indice;
+        $fieldName = 'article_picture'.$indice;
         if ($this->thumbExists($indice)) {
-            @unlink(references_utils::getModuleOption('images_path') . DIRECTORY_SEPARATOR . REFERENCES_THUMBS_PREFIX . $this->getVar($fieldName));
+            @unlink(references_utils::getModuleOption('images_path').DIRECTORY_SEPARATOR.REFERENCES_THUMBS_PREFIX.$this->getVar($fieldName));
         }
     }
 
@@ -348,9 +348,9 @@ 
     public function getUrl($shortVersion = false)
     {
         if (!$shortVersion) {
-            return REFERENCES_URL . 'reference.php?article_id=' . $this->getVar('article_id');
+            return REFERENCES_URL.'reference.php?article_id='.$this->getVar('article_id');
         } else {
-            return 'reference.php?article_id=' . $this->getVar('article_id');
+            return 'reference.php?article_id='.$this->getVar('article_id');
         }
     }
 
@@ -373,11 +373,11 @@ 
             $ret['article_picture_exists'] = true;
             for ($i = 1; $i <= 10; ++$i) {
                 if ($this->pictureExists($i)) {
-                    $ret['article_picture_url' . $i]  = $this->getPictureUrl($i);
-                    $ret['article_picture_path' . $i] = $this->getPicturePath($i);
+                    $ret['article_picture_url'.$i]  = $this->getPictureUrl($i);
+                    $ret['article_picture_path'.$i] = $this->getPicturePath($i);
                     $ret['article_pictures_urls'][]   = $this->getPictureUrl($i);
                     $ret['article_pictures_paths'][]  = $this->getPicturePath($i);
-                    $fieldName                        = 'article_picture' . $i . '_text';
+                    $fieldName                        = 'article_picture'.$i.'_text';
                     if (xoops_trim($this->getVar($fieldName)) != '') {
                         $ret['article_pictures_texts'][] = references_utils::makeHrefTitle($this->getVar($fieldName));
                     } else {
@@ -402,8 +402,8 @@ 
             $ret['article_thumb_exists'] = true;
             for ($i = 1; $i <= 10; ++$i) {
                 if ($this->thumbExists($i)) {
-                    $ret['article_thumb_url' . $i]  = $this->getThumbUrl($i);
-                    $ret['article_thumb_path' . $i] = $this->getThumbPath($i);
+                    $ret['article_thumb_url'.$i]  = $this->getThumbUrl($i);
+                    $ret['article_thumb_path'.$i] = $this->getThumbPath($i);
                     $ret['article_thumbs_urls'][]   = $this->getThumbUrl($i);
                     $ret['article_thumbs_paths'][]  = $this->getThumbPath($i);
                 }
@@ -444,7 +444,7 @@ 
         $gperm_handler = xoops_getHandler('groupperm');
         $categories    = $gperm_handler->getItemIds($permissionsType, $groups, $currentModule->getVar('mid'));
         if (is_array($categories) && count($categories) > 0) {
-            $permissions[$permissionsType] = new Criteria('article_category_id', '(' . implode(',', $categories) . ')', 'IN');
+            $permissions[$permissionsType] = new Criteria('article_category_id', '('.implode(',', $categories).')', 'IN');
         } else {    // Ne peut rien voir
             $permissions[$permissionsType] = new Criteria('article_category_id', '0', '=');
         }
@@ -472,7 +472,7 @@ 
             $criteria->add(new Criteria('article_online', REFERENCES_STATUS_ONLINE, '='));
         }
         if (is_array($categoryId) && count($categoryId) > 0) {
-            $criteria->add(new Criteria('article_category_id', '(' . implode(',', $categoryId) . ')', 'IN'));
+            $criteria->add(new Criteria('article_category_id', '('.implode(',', $categoryId).')', 'IN'));
         } elseif ($categoryId > 0) {
             $criteria->add(new Criteria('article_category_id', $categoryId, '='));
         }
@@ -529,8 +529,8 @@ 
     public function getDistinctCategoriesIds()
     {
         $ret = array();
-        $sql = 'SELECT distinct(article_category_id) FROM ' . $this->table;
-        $sql .= ' ' . $this->getPermissionsCategoriesCriteria()->renderWhere();    // Permissions
+        $sql = 'SELECT distinct(article_category_id) FROM '.$this->table;
+        $sql .= ' '.$this->getPermissionsCategoriesCriteria()->renderWhere(); // Permissions
         $sql .= ' GROUP BY article_category_id ORDER BY article_category_id';
         $result = $this->db->query($sql);
         if (!$result) {
@@ -598,17 +598,17 @@ 
      */
     public function moveUp($currentId, $currentOrder)
     {
-        $sql_plus = 'SELECT article_id FROM ' . $this->table . ' WHERE article_weight = ' . ((int)$currentOrder - 1);
+        $sql_plus = 'SELECT article_id FROM '.$this->table.' WHERE article_weight = '.((int) $currentOrder - 1);
         $res_plus = $this->db->query($sql_plus);
         if ($this->db->getRowsNum($res_plus) == 0) {
             return;
         }
         $row_plus = $this->db->fetchArray($res_plus);
 
-        $upd1 = 'UPDATE ' . $this->table . ' SET article_weight = (article_weight + 1) WHERE article_id = ' . $row_plus['article_id'];
+        $upd1 = 'UPDATE '.$this->table.' SET article_weight = (article_weight + 1) WHERE article_id = '.$row_plus['article_id'];
         $this->db->queryF($upd1);
 
-        $upd2 = 'UPDATE ' . $this->table . ' SET article_weight = (article_weight - 1) WHERE article_id = ' . (int)$currentId;
+        $upd2 = 'UPDATE '.$this->table.' SET article_weight = (article_weight - 1) WHERE article_id = '.(int) $currentId;
         $this->db->queryF($upd2);
         $this->forceCacheClean();
     }
@@ -622,17 +622,17 @@ 
      */
     public function moveDown($currentId, $currentOrder)
     {
-        $sql_moins = 'SELECT article_id FROM ' . $this->table . ' WHERE article_weight = ' . ((int)$currentOrder + 1);
+        $sql_moins = 'SELECT article_id FROM '.$this->table.' WHERE article_weight = '.((int) $currentOrder + 1);
         $res_moins = $this->db->query($sql_moins);
         if ($this->db->getRowsNum($res_moins) == 0) {
             return;
         }
 
         $row_moins = $this->db->fetchArray($res_moins);
-        $upd1      = 'UPDATE ' . $this->table . ' SET article_weight = (article_weight - 1) WHERE article_id = ' . $row_moins['article_id'];
+        $upd1      = 'UPDATE '.$this->table.' SET article_weight = (article_weight - 1) WHERE article_id = '.$row_moins['article_id'];
         $this->db->queryF($upd1);
 
-        $upd2 = 'UPDATE ' . $this->table . ' SET article_weight =( article_weight + 1) WHERE article_id = ' . (int)$currentId;
+        $upd2 = 'UPDATE '.$this->table.' SET article_weight =( article_weight + 1) WHERE article_id = '.(int) $currentId;
         $this->db->queryF($upd2);
         $this->forceCacheClean();
     }

class/references_categories.php

Doc Comments +2 added lines, -2 removed lines

@@ -185,7 +185,7 @@ 
     /**
      * Notification de la création d'une nouvelle catégorie
      *
-     * @param object|references_categories $category
+     * @param references_categories $category
      * @return bool
      */
     public function notifyNewCategory(references_categories $category)
@@ -199,7 +199,7 @@ 
     /**
      * Indique si une catégorie est visible d'un utilisateur
      *
-     * @param object|references_categories $category La catégorie à controler
+     * @param references_categories $category La catégorie à controler
      * @param integer                      $uid      L'id de l'utilisateur à controler
      * @return bool
      */

Indentation +183 added lines, -183 removed lines

@@ -22,195 +22,195 @@
 
 require_once XOOPS_ROOT_PATH . '/kernel/object.php';
 if (!class_exists('references_XoopsPersistableObjectHandler')) {
-    require_once XOOPS_ROOT_PATH . '/modules/references/class/PersistableObjectHandler.php';
+	require_once XOOPS_ROOT_PATH . '/modules/references/class/PersistableObjectHandler.php';
 }
 
 class references_categories extends references_Object
 {
-    public function __construct()
-    {
-        $this->initVar('category_id', XOBJ_DTYPE_INT, null, false);
-        $this->initVar('category_title', XOBJ_DTYPE_TXTBOX, null, false);
-        $this->initVar('category_weight', XOBJ_DTYPE_INT, null, false);
-        $this->initVar('category_description', XOBJ_DTYPE_TXTAREA, null, false);
-        // Pour autoriser le html
-        $this->initVar('dohtml', XOBJ_DTYPE_INT, 1, false);
-    }
-
-    /**
-     * Retourne la chaine de caractères qui peut être utilisée dans l'attribut href d'une balise html A.
-     *
-     * @return string
-     */
-    public function getHrefTitle()
-    {
-        return references_utils::makeHrefTitle($this->getVar('category_title'));
-    }
-
-    /**
-     * Retourne l'url à utiliser pour atteindre la catégorie
-     *
-     * @param bool $shortVersion
-     * @return string
-     */
-    public function getUrl($shortVersion = false)
-    {
-        if (!$shortVersion) {
-            return REFERENCES_URL . 'category.php?category_id=' . $this->getVar('category_id');
-        } else {
-            return 'category.php?category_id=' . $this->getVar('category_id');
-        }
-    }
-
-    /**
-     * Retourne les éléments de l'annnonce formatés pour affichage
-     *
-     * @param string $format Format à utiliser
-     * @return array
-     */
-    public function toArray($format = 's')
-    {
-        $ret                          = array();
-        $ret                          = parent::toArray($format);
-        $ret['category_href_title']   = $this->getHrefTitle();
-        $ret['category_url_rewrited'] = $this->getUrl();
-
-        return $ret;
-    }
+	public function __construct()
+	{
+		$this->initVar('category_id', XOBJ_DTYPE_INT, null, false);
+		$this->initVar('category_title', XOBJ_DTYPE_TXTBOX, null, false);
+		$this->initVar('category_weight', XOBJ_DTYPE_INT, null, false);
+		$this->initVar('category_description', XOBJ_DTYPE_TXTAREA, null, false);
+		// Pour autoriser le html
+		$this->initVar('dohtml', XOBJ_DTYPE_INT, 1, false);
+	}
+
+	/**
+	 * Retourne la chaine de caractères qui peut être utilisée dans l'attribut href d'une balise html A.
+	 *
+	 * @return string
+	 */
+	public function getHrefTitle()
+	{
+		return references_utils::makeHrefTitle($this->getVar('category_title'));
+	}
+
+	/**
+	 * Retourne l'url à utiliser pour atteindre la catégorie
+	 *
+	 * @param bool $shortVersion
+	 * @return string
+	 */
+	public function getUrl($shortVersion = false)
+	{
+		if (!$shortVersion) {
+			return REFERENCES_URL . 'category.php?category_id=' . $this->getVar('category_id');
+		} else {
+			return 'category.php?category_id=' . $this->getVar('category_id');
+		}
+	}
+
+	/**
+	 * Retourne les éléments de l'annnonce formatés pour affichage
+	 *
+	 * @param string $format Format à utiliser
+	 * @return array
+	 */
+	public function toArray($format = 's')
+	{
+		$ret                          = array();
+		$ret                          = parent::toArray($format);
+		$ret['category_href_title']   = $this->getHrefTitle();
+		$ret['category_url_rewrited'] = $this->getUrl();
+
+		return $ret;
+	}
 }
 
 class ReferencesReferences_categoriesHandler extends references_XoopsPersistableObjectHandler
 {
-    public function __construct($db)
-    {    //                         Table                   Classe                    Id                Descr.
-        parent::__construct($db, 'references_categories', 'references_categories', 'category_id', 'category_title');
-    }
-
-    /**
-     * Retourne le crit�re � utiliser pour voir les cat�gories en respectant les permissions
-     *
-     * @param  string $permissionsType Type de permission (pour l'instant permission de voir)
-     * @return obejct de type Criteria
-     */
-    public function getPermissionsCategoriesCriteria($permissionsType = REFERENCES_PERM_READ)
-    {
-        global $xoopsUser;
-        static $permissions = array();
-        if (references_utils::isAdmin()) {
-            return new Criteria('category_id', '0', '>');
-        }
-        if (is_array($permissions) && array_key_exists($permissionsType, $permissions)) {
-            return $permissions[$permissionsType];
-        }
-        $categories    = array();
-        $currentModule = references_utils::getModule();
-        $groups        = is_object($xoopsUser) ? $xoopsUser->getGroups() : XOOPS_GROUP_ANONYMOUS;
-        $gperm_handler = xoops_getHandler('groupperm');
-        $categories    = $gperm_handler->getItemIds($permissionsType, $groups, $currentModule->getVar('mid'));
-        if (is_array($categories) && count($categories) > 0) {
-            $permissions[$permissionsType] = new Criteria('category_id', '(' . implode(',', $categories) . ')', 'IN');
-        } else {    // Ne peut rien voir
-            $permissions[$permissionsType] = new Criteria('category_id', '0', '=');
-        }
-
-        return $permissions[$permissionsType];
-    }
-
-    /**
-     * Retourne les catégories
-     *
-     * @param integer $start Indice de début
-     * @param integer $limit Nombre d'objets à renvoyer
-     * @param  string $sort  Zone de tri
-     * @param  string $order Sens du tri
-     * @return array   Objets de type references_categories
-     */
-    public function getCategories($start = 0, $limit = 0, $sort = 'category_weight', $order = 'ASC')
-    {
-        $criteria = new CriteriaCompo();
-        $criteria->add(new Criteria('category_id', 0, '<>'));
-        $criteria->add($this->getPermissionsCategoriesCriteria());
-        $criteria->setStart($start);
-        $criteria->setSort($sort);
-        $criteria->setOrder($order);
-        $criteria->setLimit($limit);
-
-        return $this->getObjects($criteria, true);
-    }
-
-    /**
-     * Retourne la liste des catégories en tant que tableau
-     * @param integer $start Position de départ
-     * @param integer $limit Nombre maximum d'objets à retourner
-     * @param  string $sort  ordre de tri
-     * @param  string $order Sens du tri
-     * @return array
-     */
-    public function getListArray($start = 0, $limit = 0, $sort = 'category_weight', $order = 'ASC')
-    {
-        $criteria = new CriteriaCompo();
-        $criteria->add(new Criteria('category_id', 0, '<>'));
-        $criteria->add($this->getPermissionsCategoriesCriteria());
-        $criteria->setStart($start);
-        $criteria->setSort($sort);
-        $criteria->setOrder($order);
-        $criteria->setLimit($limit);
-
-        return $this->getList($criteria);
-    }
-
-    /**
-     * Retourne le sélecteur à utiliser pour voir la liste des catégies
-     *
-     * @param string  $selectName Le nom du sélecteur
-     * @param integer $selected   L'élément sélectionné
-     * @return string
-     */
-    public function getCategoriesSelect($selectName = 'categoriesSelect', $selected = 0)
-    {
-        $categories = array();
-        $ret        = '';
-        $categories = $this->getListArray(0, 0, 'category_weight ASC, category_title', 'ASC');
-        if (count($categories) == 0) {
-            return $ret;
-        }
-        $jump  = REFERENCES_URL . 'category.php?category_id=';
-        $extra = " onchange='location=\"" . $jump . "\"+this.options[this.selectedIndex].value'";
-
-        return references_utils::htmlSelect($selectName, $categories, $selected, true, '', false, 1, $extra);
-    }
-
-    /**
-     * Notification de la création d'une nouvelle catégorie
-     *
-     * @param object|references_categories $category
-     * @return bool
-     */
-    public function notifyNewCategory(references_categories $category)
-    {
-        $plugins = references_plugins::getInstance();
-        $plugins->fireAction(references_plugins::EVENT_ON_CATEGORY_CREATE, new references_parameters(array('category' => $category)));
-
-        return true;
-    }
-
-    /**
-     * Indique si une catégorie est visible d'un utilisateur
-     *
-     * @param object|references_categories $category La catégorie à controler
-     * @param integer                      $uid      L'id de l'utilisateur à controler
-     * @return bool
-     */
-    public function userCanSeeCategory(references_categories $category, $uid = 0)
-    {
-        global $xoopsUser;
-        if ($uid == 0) {
-            $uid = references_utils::getCurrentUserID();
-        }
-        $currentModule = references_utils::getModule();
-        $groups        = is_object($xoopsUser) ? $xoopsUser->getGroups() : XOOPS_GROUP_ANONYMOUS;
-        $gperm_handler = xoops_getHandler('groupperm');
-
-        return $gperm_handler->checkRight(REFERENCES_PERM_READ, $category->category_id, references_utils::getMemberGroups($uid), $currentModule->getVar('mid'));
-    }
+	public function __construct($db)
+	{    //                         Table                   Classe                    Id                Descr.
+		parent::__construct($db, 'references_categories', 'references_categories', 'category_id', 'category_title');
+	}
+
+	/**
+	 * Retourne le crit�re � utiliser pour voir les cat�gories en respectant les permissions
+	 *
+	 * @param  string $permissionsType Type de permission (pour l'instant permission de voir)
+	 * @return obejct de type Criteria
+	 */
+	public function getPermissionsCategoriesCriteria($permissionsType = REFERENCES_PERM_READ)
+	{
+		global $xoopsUser;
+		static $permissions = array();
+		if (references_utils::isAdmin()) {
+			return new Criteria('category_id', '0', '>');
+		}
+		if (is_array($permissions) && array_key_exists($permissionsType, $permissions)) {
+			return $permissions[$permissionsType];
+		}
+		$categories    = array();
+		$currentModule = references_utils::getModule();
+		$groups        = is_object($xoopsUser) ? $xoopsUser->getGroups() : XOOPS_GROUP_ANONYMOUS;
+		$gperm_handler = xoops_getHandler('groupperm');
+		$categories    = $gperm_handler->getItemIds($permissionsType, $groups, $currentModule->getVar('mid'));
+		if (is_array($categories) && count($categories) > 0) {
+			$permissions[$permissionsType] = new Criteria('category_id', '(' . implode(',', $categories) . ')', 'IN');
+		} else {    // Ne peut rien voir
+			$permissions[$permissionsType] = new Criteria('category_id', '0', '=');
+		}
+
+		return $permissions[$permissionsType];
+	}
+
+	/**
+	 * Retourne les catégories
+	 *
+	 * @param integer $start Indice de début
+	 * @param integer $limit Nombre d'objets à renvoyer
+	 * @param  string $sort  Zone de tri
+	 * @param  string $order Sens du tri
+	 * @return array   Objets de type references_categories
+	 */
+	public function getCategories($start = 0, $limit = 0, $sort = 'category_weight', $order = 'ASC')
+	{
+		$criteria = new CriteriaCompo();
+		$criteria->add(new Criteria('category_id', 0, '<>'));
+		$criteria->add($this->getPermissionsCategoriesCriteria());
+		$criteria->setStart($start);
+		$criteria->setSort($sort);
+		$criteria->setOrder($order);
+		$criteria->setLimit($limit);
+
+		return $this->getObjects($criteria, true);
+	}
+
+	/**
+	 * Retourne la liste des catégories en tant que tableau
+	 * @param integer $start Position de départ
+	 * @param integer $limit Nombre maximum d'objets à retourner
+	 * @param  string $sort  ordre de tri
+	 * @param  string $order Sens du tri
+	 * @return array
+	 */
+	public function getListArray($start = 0, $limit = 0, $sort = 'category_weight', $order = 'ASC')
+	{
+		$criteria = new CriteriaCompo();
+		$criteria->add(new Criteria('category_id', 0, '<>'));
+		$criteria->add($this->getPermissionsCategoriesCriteria());
+		$criteria->setStart($start);
+		$criteria->setSort($sort);
+		$criteria->setOrder($order);
+		$criteria->setLimit($limit);
+
+		return $this->getList($criteria);
+	}
+
+	/**
+	 * Retourne le sélecteur à utiliser pour voir la liste des catégies
+	 *
+	 * @param string  $selectName Le nom du sélecteur
+	 * @param integer $selected   L'élément sélectionné
+	 * @return string
+	 */
+	public function getCategoriesSelect($selectName = 'categoriesSelect', $selected = 0)
+	{
+		$categories = array();
+		$ret        = '';
+		$categories = $this->getListArray(0, 0, 'category_weight ASC, category_title', 'ASC');
+		if (count($categories) == 0) {
+			return $ret;
+		}
+		$jump  = REFERENCES_URL . 'category.php?category_id=';
+		$extra = " onchange='location=\"" . $jump . "\"+this.options[this.selectedIndex].value'";
+
+		return references_utils::htmlSelect($selectName, $categories, $selected, true, '', false, 1, $extra);
+	}
+
+	/**
+	 * Notification de la création d'une nouvelle catégorie
+	 *
+	 * @param object|references_categories $category
+	 * @return bool
+	 */
+	public function notifyNewCategory(references_categories $category)
+	{
+		$plugins = references_plugins::getInstance();
+		$plugins->fireAction(references_plugins::EVENT_ON_CATEGORY_CREATE, new references_parameters(array('category' => $category)));
+
+		return true;
+	}
+
+	/**
+	 * Indique si une catégorie est visible d'un utilisateur
+	 *
+	 * @param object|references_categories $category La catégorie à controler
+	 * @param integer                      $uid      L'id de l'utilisateur à controler
+	 * @return bool
+	 */
+	public function userCanSeeCategory(references_categories $category, $uid = 0)
+	{
+		global $xoopsUser;
+		if ($uid == 0) {
+			$uid = references_utils::getCurrentUserID();
+		}
+		$currentModule = references_utils::getModule();
+		$groups        = is_object($xoopsUser) ? $xoopsUser->getGroups() : XOOPS_GROUP_ANONYMOUS;
+		$gperm_handler = xoops_getHandler('groupperm');
+
+		return $gperm_handler->checkRight(REFERENCES_PERM_READ, $category->category_id, references_utils::getMemberGroups($uid), $currentModule->getVar('mid'));
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -20,9 +20,9 @@ 
  */
 defined('XOOPS_ROOT_PATH') || exit('XOOPS root path not defined');
 
-require_once XOOPS_ROOT_PATH . '/kernel/object.php';
+require_once XOOPS_ROOT_PATH.'/kernel/object.php';
 if (!class_exists('references_XoopsPersistableObjectHandler')) {
-    require_once XOOPS_ROOT_PATH . '/modules/references/class/PersistableObjectHandler.php';
+    require_once XOOPS_ROOT_PATH.'/modules/references/class/PersistableObjectHandler.php';
 }
 
 class references_categories extends references_Object
@@ -56,9 +56,9 @@ 
     public function getUrl($shortVersion = false)
     {
         if (!$shortVersion) {
-            return REFERENCES_URL . 'category.php?category_id=' . $this->getVar('category_id');
+            return REFERENCES_URL.'category.php?category_id='.$this->getVar('category_id');
         } else {
-            return 'category.php?category_id=' . $this->getVar('category_id');
+            return 'category.php?category_id='.$this->getVar('category_id');
         }
     }
 
@@ -108,7 +108,7 @@ 
         $gperm_handler = xoops_getHandler('groupperm');
         $categories    = $gperm_handler->getItemIds($permissionsType, $groups, $currentModule->getVar('mid'));
         if (is_array($categories) && count($categories) > 0) {
-            $permissions[$permissionsType] = new Criteria('category_id', '(' . implode(',', $categories) . ')', 'IN');
+            $permissions[$permissionsType] = new Criteria('category_id', '('.implode(',', $categories).')', 'IN');
         } else {    // Ne peut rien voir
             $permissions[$permissionsType] = new Criteria('category_id', '0', '=');
         }
@@ -174,8 +174,8 @@ 
         if (count($categories) == 0) {
             return $ret;
         }
-        $jump  = REFERENCES_URL . 'category.php?category_id=';
-        $extra = " onchange='location=\"" . $jump . "\"+this.options[this.selectedIndex].value'";
+        $jump  = REFERENCES_URL.'category.php?category_id=';
+        $extra = " onchange='location=\"".$jump."\"+this.options[this.selectedIndex].value'";
 
         return references_utils::htmlSelect($selectName, $categories, $selected, true, '', false, 1, $extra);
     }

class/references_listFilter.php

Doc Comments +9 added lines, -9 removed lines

@@ -253,7 +253,7 @@ 
     /**
      * Retourne les noms à utiliser pour les champs de tri (sélecteur de champ et ordre de tri)
      *
-     * @return array [0] = Nom du sélecteur de champs, [1] = Nom du sélecteur pour le sens du tri
+     * @return string[] [0] = Nom du sélecteur de champs, [1] = Nom du sélecteur pour le sens du tri
      */
     private function getSortPlaceHolderNames()
     {
@@ -279,7 +279,7 @@ 
      *
      * @param  string $optionName
      * @param  mixed  $optionValue
-     * @return object
+     * @return references_listFilter
      */
     public function setOption($optionName, $optionValue)
     {
@@ -408,7 +408,7 @@ 
      *                            [data]            A ne pas renseigner, contient la valeur saisie par l'utilisateur
      *                            [operator]        Opérateur de comparaison pour le Criteria
      *                            [autoComplete]  Indique si on active l'auto complétion sur le champs
-     * @return object L'objet courant pour pouvoir chainer
+     * @return references_listFilter L'objet courant pour pouvoir chainer
      */
     public function initFilter($fieldName, $parameters)
     {
@@ -464,7 +464,7 @@ 
     /**
      * Ajoute les critères par défaut au critère général
      *
-     * @return void
+     * @return references_listFilter
      */
     private function addDefaultCriterias()
     {
@@ -592,7 +592,7 @@ 
     /**
      * Méthode à appeler juste après le constructeur pour qu'elle récupère les données saisies
      *
-     * @return object L'objet courant pour pouvoir chainer
+     * @return references_listFilter L'objet courant pour pouvoir chainer
      */
     public function filter()
     {
@@ -717,7 +717,7 @@ 
      *
      * @param  string $key
      * @param  string $value
-     * @return object
+     * @return references_listFilter
      */
     public function addAdditionnalParameterToPager($key, $value = '')
     {
@@ -731,7 +731,7 @@ 
      *
      * @param  string $key
      * @param  string $value
-     * @return object
+     * @return references_listFilter
      */
     public function addAdditionnalParameterToClearButton($key, $value = '')
     {
@@ -744,7 +744,7 @@ 
      * Permet d'ajouter des paramètres supplémentaires au pager
      *
      * @param $array
-     * @return object
+     * @return references_listFilter
      * @internal param string $key
      * @internal param string $value
      */
@@ -762,7 +762,7 @@ 
     /**
      * Retourne le pager à utiliser
      *
-     * @return mixed Null s'il n'y a pas lieu d'y avoir un pager, sinon un objet de type {@link XoopsPageNav}
+     * @return XoopsPageNav|null Null s'il n'y a pas lieu d'y avoir un pager, sinon un objet de type {@link XoopsPageNav}
      */
     public function getPager()
     {

Indentation +926 added lines, -926 removed lines

@@ -35,930 +35,930 @@
  */
 class references_listFilter
 {
-    const FILTER_DATA_TEXT    = 1;
-    const FILTER_DATA_NUMERIC = 2;
-
-    const FILTER_FIELD_TEXT          = 1;
-    const FILTER_FIELD_SELECT        = 2;
-    const FILTER_FIELD_SELECT_YES_NO = 3;
-
-    /**
-     * Préfixe des variables de sélection
-     */
-    const PREFIX = 'filter_';
-
-    /**
-     * Nom du module (utilisé pour la session)
-     */
-    const MODULE_NAME = 'references';
-
-    /**
-     * Contient toutes les variables participant au filtre (avec leur type et description)
-     *
-     * @var array
-     */
-    private $vars = array();
-
-    /**
-     * Handler des données
-     *
-     * @var reference
-     */
-    private $handler = null;
-
-    /**
-     * Nom de la zone d'opération (par exemple op=products)
-     *
-     * @var string
-     */
-    private $op = '';
-
-    /**
-     * action de l'opération en cour (par exemple op=products)
-     *
-     * @var string
-     */
-    private $operationName = '';
-
-    /**
-     * Nombre maximum d'éléments pas page
-     *
-     * @var intger
-     */
-    private $limit = 10;
-
-    /**
-     * Nom de la variable start
-     *
-     * @var string
-     */
-    private $startName = '';
-
-    /**
-     * Critère {@link Criteria} servant à choisir les données
-     *
-     * @var object
-     */
-    private $criteria = null;
-
-    /**
-     * Indique s'il y a un nouveau critère
-     *
-     * @var boolean
-     */
-    private $newFilter = false;
-
-    /**
-     * Indique si la méthode filter() a été appelée
-     *
-     * @var boolean
-     */
-    private $isInitialized = false;
-
-    /**
-     * Zone de tri pour retourner les données (dans getObjects)
-     *
-     * @var string
-     */
-    private $sortField = '';
-
-    /**
-     * Sens de tri
-     *
-     * @var string
-     */
-    private $sortOrder = '';
-
-    /**
-     * Liste de critères par défaut
-     *
-     * @var array
-     */
-    private $defaultCriterias = array();
-
-    /**
-     * L'url complète du script qui appelle
-     *
-     * @var string
-     */
-    private $baseUrl = '';
-
-    /**
-     * Indique si on conserve en session la position de départ
-     *
-     * @var boolean
-     */
-    private $keepStart = true;
-
-    /**
-     * Indique si l'autocomplétion est activée
-     *
-     * @var boolean
-     */
-    private $hasAutoComplete = false;
-
-    /**
-     * Url du dossier js dans le module
-     *
-     * @var string
-     */
-    private $jsFolderUrl = '';
-
-    /**
-     * Paramètres additionnels à ajouter aux paramètres du pager
-     * @var array
-     */
-    private $additionnalPagerParameters = array();
-
-    /**
-     * Paramètres additionnels à ajouter au bouton permettant de supprimer le filtre en cours
-     * @var array
-     */
-    private $additionnalClearButtonParameters = array();
-
-    /**
-     * Tableau des champs triables [clé] = nom du champ dans la base, valeur = libellé
-     * @var array
-     */
-    private $sortFields = array();
-
-    /**
-     * Initialise les paramètres avec des valeurs par défaut
-     */
-    private function setDefaultValues()
-    {
-        $this->handler                          = null;
-        $this->op                               = '';
-        $this->limit                            = 10;
-        $this->startName                        = 'start';
-        $this->operationName                    = 'op';
-        $this->sortField                        = '';
-        $this->sortOrder                        = 'asc';
-        $this->baseUrl                          = '';
-        $this->keepStart                        = true;
-        $this->hasAutoComplete                  = false;
-        $this->jsFolderUrl                      = '';
-        $this->additionnalPagerParameters       = array();
-        $this->additionnalClearButtonParameters = array();
-        $this->sortFields                       = array();    // Les champs qui peuvent être utilisés pour trier
-    }
-
-    /**
-     * Initialisation des données, handler et opération courante dans l'appelant
-     *
-     * @param mixed   $handler   Soit une référence au handler de données soit un tableau qui contient toutes les options (auxquel cas les autres paramètres sont inutiles)
-     * @param string  $operationName
-     * @param string  $operation Opération courante dans l'appelant
-     * @param string  $startName Nom du paramètre start
-     * @param integer $limit     Nombre maximum d'éléments par page
-     * @param string  $baseUrl   L'url complète du script appelant
-     * @param string  $sortField Zone de tri
-     * @param string  $sortOrder Sens de tri
-     * @param boolean $keepStart Indique si on conserve la position de départ
-     * @param string  $jsFolderUrl
-     * @package string $jsFolderUrl Url du répertoire qui contient les scripts Javascript
-     */
-    public function __construct($handler, $operationName = 'op', $operation = '', $startName = 'start', $limit = 10, $baseUrl = '', $sortField = '', $sortOrder = 'asc', $keepStart = true, $jsFolderUrl = '')
-    {
-        $this->setDefaultValues();
-        if (!is_array($handler)) {
-            $this->handler       = $handler;
-            $this->op            = $operation;
-            $this->limit         = $limit;
-            $this->startName     = $startName;
-            $this->operationName = $operationName;
-            $this->sortField     = $sortField;
-            $this->sortOrder     = $sortOrder;
-            $this->baseUrl       = $baseUrl;
-            $this->keepStart     = $keepStart;
-            $this->jsFolderUrl   = $jsFolderUrl;
-        } else {
-            foreach ($handler as $key => $value) {
-                $this->$key = $value;
-            }
-        }
-    }
-
-    /**
-     * Donne à la classe le nom des champs sur lesquels on peut faire le tri
-     *
-     * @param  array $fields [clé] = nom du champ dans la base, valeur = libellé
-     * @return object
-     */
-    public function setSortFields($fields)
-    {
-        $this->sortFields = $fields;
-    }
-
-    /**
-     * Retourne les noms à utiliser pour les champs de tri (sélecteur de champ et ordre de tri)
-     *
-     * @return array [0] = Nom du sélecteur de champs, [1] = Nom du sélecteur pour le sens du tri
-     */
-    private function getSortPlaceHolderNames()
-    {
-        return array(self::PREFIX . 'sortFields', self::PREFIX . 'sortOrder');
-    }
-
-    /**
-     * Retourne 2 sélecteurs html pour choisir la zone de tri et le sens du tri
-     *
-     * @return string
-     */
-    public function getSortPlaceHolderHtmlCode()
-    {
-        $sortNames      = $this->getSortPlaceHolderNames();
-        $sortFieldsHtml = references_utils::htmlSelect($sortNames[0], $this->sortFields, $this->sortField, false);
-        $sortOrderHtml  = references_utils::htmlSelect($sortNames[1], array('asc' => _MD_REFERENCES_ASC, 'desc' => _MD_REFERENCES_DESC), $this->sortOrder, false);
-
-        return _MD_REFERENCES_SORT_BY . ' ' . $sortFieldsHtml . ' ' . $sortOrderHtml;
-    }
-
-    /**
-     * Permet de valoriser une option directement tout en chainant
-     *
-     * @param  string $optionName
-     * @param  mixed  $optionValue
-     * @return object
-     */
-    public function setOption($optionName, $optionValue)
-    {
-        $this->$optionName = $optionValue;
-
-        return $this;
-    }
-
-    /**
-     * Ajoute un nouveau critère par défaut à la liste des critères par défaut
-     *
-     * @param Criteria $criteria
-     */
-    public function addDefaultCriteria(Criteria $criteria)
-    {
-        $this->defaultCriterias[] = $criteria;
-    }
-
-    /**
-     * Retourne une valeur d'un tableau ou null si l'index n'existe pas
-     *
-     * @param array   $array        Le tableau à traiter
-     * @param  string $index        L'index recherché
-     * @param  mixed  $defaultValue La valeur par défaut
-     * @return mixed
-     */
-    private function getArrayValue($array, $index, $defaultValue = false)
-    {
-        if ($index === 'autoComplete' && isset($array[$index]) && isset($array[$index]) == true) {
-            $this->hasAutoComplete = true;    // On en profite pour vérifier si un champ utilise l'autocomplétion
-        }
-
-        return isset($array[$index]) ? $array[$index] : $defaultValue;
-    }
-
-    /**
-     * Permet de faire l'autocomplétion d'un champ
-     *
-     * @param  string $query
-     * @param         $limit
-     * @param  string $fieldName
-     * @return string
-     */
-    public function autoComplete($query, $limit, $fieldName)
-    {
-        $return = '';
-        if (!$this->hasAutoComplete) {    // Si aucun champ n'est en autocomplétion, c'est pas la peine d'aller plus loin
-
-            return $return;
-        }
-        if (isset($this->vars[$fieldName])) {    // On vérifie que le champ demandé est bien en autocomplétion
-            if ($this->vars[$fieldName]['autoComplete'] == true) {
-                if ($this->vars[$fieldName]['dataType'] == self::FILTER_DATA_TEXT) {
-                    $criteria = new Criteria($fieldName, $query . '%', 'LIKE');
-                }
-                $criteria->setLimit((int)$limit);
-                $ret = $this->handler->getObjects($criteria);
-
-                if (count($ret) > 0) {
-                    foreach ($ret as $object) {
-                        $return .= $object->getVar($fieldName, 'n') . "\n";
-                    }
-                }
-            }
-        }
-
-        return $return;
-    }
-
-    /**
-     * Retourne le code Javascript à utiliser pour initialiser l'auto complétion (et donc à coller dans le code html)
-     *
-     * @param boolean $jqueryAlreadyLoaded Indique si jQuery est déjà chargé par l'appelant, auquel cas rien ne sert de le recharger
-     * @return string
-     */
-    public function getJavascriptInitCode($jqueryAlreadyLoaded = false)
-    {
-        $return = '';
-        if (!$this->hasAutoComplete) {
-            return $return;
-        }
-        $return = '';
-        $return .= "<link rel=\"stylesheet\" type=\"text/css\" media=\"all\" title=\"Style sheet\" href=\"" . $this->jsFolderUrl . "autocomplete/jquery.autocomplete.css\" />\n";
-        if (!$jqueryAlreadyLoaded) {
-            $return .= "<script type=\"text/javascript\" src=\"" . $this->jsFolderUrl . "jquery/jquery.js\"></script>\n";
-        }
-        $return .= "<script type=\"text/javascript\" src=\"" . $this->jsFolderUrl . "noconflict.js\"></script>\n";
-        $return .= "<script type=\"text/javascript\" src=\"" . $this->jsFolderUrl . "autocomplete/jquery.autocomplete.min.js\"></script>\n";
-        $return .= "<script type=\"text/javascript\">\n";
-        $return .= "jQuery(function($) {\n";
-        $return .= "var url='" . $this->baseUrl . "';\n";    // TODO: Supprimer "var" car cela limite sa portée !
-        $return .= "var handlerName='" . $this->handler->className . "';\n";
-
-        foreach ($this->vars as $fieldName => $parameters) {
-            if ($parameters['autoComplete'] == true) {
-                $field = self::PREFIX . $fieldName;
-                $return .= "$('#" . $field . "').autocomplete(url, {\n";
-                $return .= "extraParams: {\n";
-                $return .= "    field: '" . $fieldName . "',\n";
-                $return .= "    op: 'autocomplete',\n";
-                $return .= "    handler: handlerName\n";
-                $return .= "}\n";
-                $return .= "});\n";
-            }
-        }
-        $return .= "});\n";
-        $return .= "</script>\n";
-
-        return $return;
-    }
-
-    /**
-     * Initialisation des données du filtre
-     * Permet d'indiquer quelles sont les zones sur lesquelles on effectue des filtres ainsi que leur type
-     *
-     * @param  string $fieldName  Le nom du champs dans la table
-     * @param  array  $parameters Les paramètres de la zone sous la forme d'un tableau :
-     *                            [dataType]        Entier représentant le type de donnée (numérique ou chaine)
-     *                            [fieldType]       Le type de zone de saisie (zone de texte, liste déroulante, liste déroulante Oui/Non)
-     *                            [values]      La ou les valeurs de la zone de saisie (utilisé dans le cas d'un select)
-     *                            [size]            Largeur d'affichage pour les textbox
-     *                            [maxLength]       Largeur maximale pour les textbox
-     *                            [withNull]        Dans le cas des listes déroulantes, indique s'il faut une valeur nulle
-     *                            [minusOne]        Indique s'il faut retrancher 1 à la valeur saisie récupérée (cas classique des listes Oui/Non avec une valeur nulle)
-     *                            [style]            Dans le cas des liste déroulante, le style à appliquer à la liste
-     *                            [data]            A ne pas renseigner, contient la valeur saisie par l'utilisateur
-     *                            [operator]        Opérateur de comparaison pour le Criteria
-     *                            [autoComplete]  Indique si on active l'auto complétion sur le champs
-     * @return object L'objet courant pour pouvoir chainer
-     */
-    public function initFilter($fieldName, $parameters)
-    {
-        // Tableau des valeurs attendues avec leur valeur par défaut
-        $indexNames = array('dataType' => self::FILTER_DATA_TEXT, 'fieldType' => self::FILTER_FIELD_TEXT, 'values' => null, 'withNull' => false, 'size' => 5, 'maxLength' => 255, 'minusOne' => false, 'data' => null, 'style' => '', 'operator' => '=', 'autoComplete' => false);
-        $data       = array();
-        foreach ($indexNames as $indexName => $defaultValue) {
-            $data[$indexName] = $this->getArrayValue($parameters, $indexName, $defaultValue);
-        }
-        $this->vars[$fieldName] = $data;
-
-        return $this;
-    }
-
-    /**
-     * Retourne le nom du tableau à utiliser pour la session
-     * @note : Le nom de la session est composé de : nom du module_nom du handler, par exemple references_references_articles
-     *
-     * @return string
-     */
-    private function getSessionName()
-    {
-        return self::MODULE_NAME . '_' . $this->handler->table;
-    }
-
-    /**
-     * Retourne le nom de la clé à utiliser pour la conservation du start en session
-     *
-     * @return string
-     */
-    private function getStartSessionName()
-    {
-        return $this->getSessionName() . '_start';
-    }
-
-    /**
-     * Réinitialisation des données avant traitement
-     *
-     * @return void
-     */
-    private function reinitializeFieldsValue()
-    {
-        foreach ($this->vars as $fieldName => $fieldProperties) {
-            if ($fieldProperties['dataType'] == self::FILTER_DATA_NUMERIC) {    // Zone numérique
-                $fieldProperties['data'] = 0;
-            } else {
-                $fieldProperties['data'] = '';
-            }
-            $this->vars[$fieldName] = $fieldProperties;
-        }
-    }
-
-    /**
-     * Ajoute les critères par défaut au critère général
-     *
-     * @return void
-     */
-    private function addDefaultCriterias()
-    {
-        if (is_array($this->defaultCriterias) && count($this->defaultCriterias) > 0) {
-            foreach ($this->defaultCriterias as $criteria) {
-                $this->criteria->add($criteria);
-            }
-        }
-
-        return $this;
-    }
-
-    /**
-     * Indique s'il y a des champs de tri
-     *
-     * @return boolean
-     */
-    private function areThereSortFields()
-    {
-        $return = false;
-        if (is_array($this->sortFields) && count($this->sortFields) > 0) {
-            $return = true;
-        }
-
-        return $return;
-    }
-
-    /**
-     * Indique si le nom du champ passé en paramètre fait partie de la liste des champs "triables"
-     *
-     * @param  string $fieldName
-     * @return boolean
-     */
-    private function isInSortFieldsList($fieldName)
-    {
-        return array_key_exists($fieldName, $this->sortFields);
-    }
-
-    /**
-     * Indique si le sens de tri passé en paramètre fait partie de la liste autorisée
-     *
-     * @param  string $order
-     * @return boolean
-     */
-    private function isInSortOrderList($order)
-    {
-        return in_array($order, array('asc', 'desc'));
-    }
-
-    /**
-     * Récupère, depuis la requête d'entrée, la zone de tri à utiliser et le sens du tri et place l'information en cookie
-     * pour que lorsque l'utilisateur se reconnecte, il retrouve ses informations de tri
-     *
-     * @return void
-     */
-    private function setSortFieldsFromRequest()
-    {
-        if (!$this->areThereSortFields()) {    // S'il n'y a pas de champs triables, on laisse tomber
-
-            return;
-        }
-        $sortField        = $sortOrder = '';
-        $cookieName       = $this->getSessionName();
-        $orderFieldsNames = $this->getSortPlaceHolderNames();
-        if (isset($_REQUEST[$orderFieldsNames[0]]) && isset($_REQUEST[$orderFieldsNames[1]])) {
-            $sortField = $_REQUEST[$orderFieldsNames[0]];
-            $sortOrder = $_REQUEST[$orderFieldsNames[1]];
-        } else {
-            if (isset($_SESSION[$cookieName . '_sortField'])) {
-                $sortField = $_SESSION[$cookieName . '_sortField'];
-            }
-            if (isset($_SESSION[$cookieName . '_sortOrder'])) {
-                $sortOrder = $_SESSION[$cookieName . '_sortOrder'];
-            }
-        }
-
-        if ($this->isInSortFieldsList($sortField) && $this->isInSortOrderList($sortOrder)) {
-            $this->sortField = $sortField;
-            $this->sortOrder = $sortOrder;
-        }
-        if (trim($sortField) != '' && trim($sortOrder) != '') {
-            $_SESSION[$cookieName . '_sortField'] = $sortField;
-            $_SESSION[$cookieName . '_sortOrder'] = $sortOrder;
-        }
-    }
-
-    /**
-     * Réinitialisation des données avant traitement
-     *
-     * @return void
-     */
-    private function setupFilter()
-    {
-        $this->reinitializeFieldsValue();
-        $this->newFilter     = false;
-        $this->isInitialized = true;
-        $this->criteria      = new CriteriaCompo();
-        $this->criteria->add(new Criteria($this->handler->keyName, 0, '<>'));
-        $this->addDefaultCriterias();
-    }
-
-    /**
-     * RAZ des données du filtre si cela a été demandé dans la requête
-     *
-     * @return void
-     */
-    private function isSetCleanFilter()
-    {
-        if (isset($_REQUEST['cleanFilter'])) {
-            $this->setStartInSession(0);
-            unset($_SESSION[$this->getSessionName()]);
-        }
-    }
-
-    /**
-     * Retourne le critère de filtrage courant
-     *
-     * @return object
-     */
-    public function getCriteria()
-    {
-        return $this->criteria;
-    }
-
-    /**
-     * Méthode à appeler juste après le constructeur pour qu'elle récupère les données saisies
-     *
-     * @return object L'objet courant pour pouvoir chainer
-     */
-    public function filter()
-    {
-        $this->setupFilter();                // Réinitialisations
-        $ts = MyTextSanitizer::getInstance();
-        $this->setSortFieldsFromRequest();    // On récupère la zone de tri éventuellement passée dans la requête
-        $this->isSetCleanFilter();
-
-        foreach ($this->vars as $fieldName => $fieldProperties) {
-            // On commence par récupérer toutes les valeurs
-            $formFieldName           = self::PREFIX . $fieldName;    // "filter_website_id" par exemple
-            $fieldProperties['data'] = null;    // Valeur par défaut
-            if (isset($_REQUEST[$formFieldName])) {
-                if ($fieldProperties['dataType'] == self::FILTER_DATA_NUMERIC) {    // Zone numérique
-                    if ((int)$_REQUEST[$formFieldName] != 0) {
-                        $fieldProperties['data'] = (int)$_REQUEST[$formFieldName];
-                        if (!$fieldProperties['minusOne']) {
-                            $this->criteria->add(new Criteria($fieldName, $fieldProperties['data'], $fieldProperties['operator']));
-                        } else {
-                            $this->criteria->add(new Criteria($fieldName, $fieldProperties['data'] - 1, $fieldProperties['operator']));
-                        }
-                        $this->newFilter = true;
-                    }
-                } else {    // Zone texte
-                    if (trim($_REQUEST[$formFieldName]) != '') {
-                        $fieldProperties['data'] = $_REQUEST[$formFieldName];
-                        if (!REFERENCES_EXACT_SEARCH) {
-                            $this->criteria->add(new Criteria($fieldName, '%' . $ts->addSlashes($fieldProperties['data']) . '%', 'LIKE'));
-                        } else {
-                            $this->criteria->add(new Criteria($fieldName, $ts->addSlashes($fieldProperties['data']) . '%', 'LIKE'));
-                        }
-                        $this->newFilter = true;
-                    }
-                }
-            }
-            $this->vars[$fieldName] = $fieldProperties;
-        }
-
-        if ($this->newFilter) {
-            $this->setStartInSession(0);
-        }
-
-        // Récupération des donées de la session s'il n'y a pas eu de filtre(s)
-        if (!$this->newFilter && isset($_SESSION[$this->getSessionName()])) {
-            $sessionFilterData = unserialize($_SESSION[$this->getSessionName()]);
-            if (isset($sessionFilterData['criteria']) && is_object($sessionFilterData['criteria'])) {
-                $this->criteria = $sessionFilterData['criteria'];
-                unset($sessionFilterData['criteria']);
-            }
-            foreach ($this->vars as $fieldName => $fieldProperties) {
-                if (isset($sessionFilterData[$fieldName])) {
-                    $fieldProperties['data'] = $sessionFilterData[$fieldName];
-                }
-                $this->vars[$fieldName] = $fieldProperties;
-            }
-            unset($_SESSION[$this->getSessionName()]);
-        }
-
-        // Mise en place des données dans la session
-        $dataForSession             = array();
-        $dataForSession['criteria'] = $this->criteria;
-        foreach ($this->vars as $fieldName => $fieldProperties) {
-            $dataForSession[$fieldName] = $fieldProperties['data'];
-        }
-        $_SESSION[$this->getSessionName()] = serialize($dataForSession);
-
-        return $this;
-    }
-
-    /**
-     * Retourne le nombre d'enregistrement en fonction des critères courants
-     *
-     * @return integer
-     */
-    public function getCount()
-    {
-        if (!$this->isInitialized) {
-            $this->filter();
-        }
-
-        return $this->handler->getCount($this->criteria);
-    }
-
-    /**
-     * Conserve la valeur de start en session
-     *
-     * @param  integer $start
-     * @return void
-     */
-    private function setStartInSession($start)
-    {
-        if ($this->keepStart) {
-            $startSessionName            = $this->getStartSessionName();
-            $_SESSION[$startSessionName] = (int)$start;
-        }
-    }
-
-    /**
-     * Retourne la valeur de ?start=x
-     *
-     * @return integer
-     */
-    private function getStartValue()
-    {
-        $start = 0;
-        if (isset($_REQUEST[$this->startName])) {
-            $start = (int)$_REQUEST[$this->startName];
-        } elseif ($this->keepStart) {
-            $startSessionName = $this->getStartSessionName();
-            if (isset($_SESSION[$startSessionName])) {
-                $start = (int)$_SESSION[$startSessionName];
-            }
-        }
-        // Mise en session
-        $this->setStartInSession($start);
-
-        return $start;
-    }
-
-    /**
-     * Permet d'ajouter un paramètre supplémentaire au pager
-     *
-     * @param  string $key
-     * @param  string $value
-     * @return object
-     */
-    public function addAdditionnalParameterToPager($key, $value = '')
-    {
-        $this->additionnalPagerParameters[$key] = $value;
-
-        return $this;
-    }
-
-    /**
-     * Permet d'ajouter un paramètre supplémentaire au bouton permettant de supprimer le filtre
-     *
-     * @param  string $key
-     * @param  string $value
-     * @return object
-     */
-    public function addAdditionnalParameterToClearButton($key, $value = '')
-    {
-        $this->additionnalClearButtonParameters[$key] = $value;
-
-        return $this;
-    }
-
-    /**
-     * Permet d'ajouter des paramètres supplémentaires au pager
-     *
-     * @param $array
-     * @return object
-     * @internal param string $key
-     * @internal param string $value
-     */
-    public function addAditionnalArrayParametersToPager($array)
-    {
-        if (count($array) > 0) {
-            foreach ($array as $key => $value) {
-                $this->addAdditionnalParameterToPager($key, $value);
-            }
-        }
-
-        return $this;
-    }
-
-    /**
-     * Retourne le pager à utiliser
-     *
-     * @return mixed Null s'il n'y a pas lieu d'y avoir un pager, sinon un objet de type {@link XoopsPageNav}
-     */
-    public function getPager()
-    {
-        if (!$this->isInitialized) {
-            $this->filter();
-        }
-        require_once XOOPS_ROOT_PATH . '/class/pagenav.php';
-        $itemsCount  = $this->getCount();
-        $queryString = array();
-        if (trim($this->op) != '') {
-            $queryString[$this->operationName] = $this->op;
-        }
-        $pagenav = null;
-
-        if ($itemsCount > $this->limit) {
-            foreach ($this->vars as $fieldName => $fieldProperties) {
-                $formFieldName               = self::PREFIX . $fieldName;    // "filter_website_id" par exemple
-                $queryString[$formFieldName] = $fieldProperties['data'];
-            }
-            // Ajout des paramètres supplémentaires éventuels
-            if (count($this->additionnalPagerParameters) > 0) {
-                foreach ($this->additionnalPagerParameters as $key => $value) {
-                    $queryString[$key] = $value;
-                }
-            }
-            $start   = $this->getStartValue();
-            $pagenav = new XoopsPageNav($itemsCount, $this->limit, $start, $this->startName, http_build_query($queryString));
-        }
-
-        return $pagenav;
-    }
-
-    /**
-     * Retourne une liste d'objets en fonction des critères définis
-     *
-     * @return array
-     */
-    public function getObjects()
-    {
-        if (!$this->isInitialized) {
-            $this->filter();
-        }
-        $start    = $this->getStartValue();
-        $limit    = $this->limit;
-        $criteria = $this->criteria;
-        $criteria->setStart($start);
-        $criteria->setLimit($limit);
-
-        $criteria->setOrder($this->sortOrder);
-        if (trim($this->sortField) != '') {
-            $criteria->setSort($this->sortField);
-        } elseif (trim($this->handler->identifierName) != '') {
-            $criteria->setSort($this->handler->identifierName);
-        }
-
-        return $this->handler->getObjects($this->criteria);
-    }
-
-    /**
-     * Retourne la zone html à utiliser pour créer la zone de filtre (avec sa valeur saisie si c'est le cas)
-     *
-     * @param  string $fieldName La zone de saisie dont on veut récupérer le code html
-     * @return string
-     */
-    public function getFilterField($fieldName)
-    {
-        $html = '';
-        if (!$this->isInitialized) {
-            $this->filter();
-        }
-        if (!isset($this->vars[$fieldName])) {
-            trigger_error('Error, unknow field');
-
-            return $html;
-        }
-        $fieldData     = $this->vars[$fieldName];
-        $htmlFieldName = self::PREFIX . $fieldName;
-
-        switch ($fieldData['fieldType']) {
-            case self::FILTER_FIELD_TEXT:    // Zone de texte
-                $ts   = MyTextSanitizer::getInstance();
-                $html = "<input type='text' name='$htmlFieldName' id='$htmlFieldName' size='" . $fieldData['size'] . "' maxlength='" . $fieldData['maxLength'] . "' value='" . $ts->htmlSpecialChars($fieldData['data']) . "' />";
-                break;
-
-            case self::FILTER_FIELD_SELECT;     // Select
-                $style = '';
-                if (isset($fieldData['style']) && trim($fieldData['style']) != '') {
-                    $style = $fieldData['style'];
-                }
-                $html = references_utils::htmlSelect($htmlFieldName, $fieldData['values'], $fieldData['data'], $fieldData['withNull'], $style);
-                break;
-
-            case self::FILTER_FIELD_SELECT_YES_NO:    // Select de type Oui/Non
-                $html = references_utils::htmlSelect($htmlFieldName, array(2 => _YES, 1 => NO), $fieldData['data'], $fieldData['withNull']);
-                break;
-        }
-
-        return $html;
-    }
-
-    /**
-     * Assigne toutes les zones de filtre à un template
-     *
-     * @param  object  $xoopsTpl
-     * @param  boolean $asArray   Est-ce qu'il faut placer le résultat dans un tableau ou assigner par nom de zone de filtre
-     * @param string   $arrayName Le nom du tableau à utiliser
-     * @return void
-     */
-    public function assignFilterFieldsToTemplate(&$xoopsTpl, $asArray = true, $arrayName = 'filterFields')
-    {
-        $fields = array_keys($this->vars);
-        foreach ($fields as $field) {
-            if (!$asArray) {
-                $xoopsTpl->assign($field, $this->getFilterField($field));
-            } else {
-                $xoopsTpl->append($arrayName, $this->getFilterField($field));
-            }
-        }
-    }
-
-    /**
-     * Retourne le bouton utilisé pour supprimer le filtre en cours
-     *
-     * @return string
-     */
-    public function getClearFilterbutton()
-    {
-        $queryString                       = array();
-        $queryString[$this->operationName] = $this->op;
-        if (count($this->additionnalClearButtonParameters) > 0) {
-            foreach ($this->additionnalClearButtonParameters as $key => $value) {
-                $queryString[$key] = $value;
-            }
-        }
-        $queryString['cleanFilter'] = '1';
-        $baseurl                    = $this->baseUrl;
-
-        return "&nbsp;&nbsp;<a href='$baseurl?" . http_build_query($queryString) . "' title='" . _MD_REFERENCES_CLEAN_FILTER . "'><img align='top' src='../assets/images/clear_left.png' alt='" . _MD_REFERENCES_CLEAN_FILTER . "' /></a>";
-    }
-
-    /**
-     * Retourne le bouton permettant de lancer le filtrage
-     *
-     * @param string $description  Texte à faire apparaître sur le bouton
-     * @param array  $additionnals Champs supplémentaires à faire apparaître avec le bouton
-     * @return string
-     */
-    public function getGoButton($description = _GO, $additionnals = null)
-    {
-        $html = '';
-        if (trim($this->operationName) != '' && trim($this->op) != '') {
-            $html .= "<input type='hidden' name='" . $this->operationName . "' id='" . $this->operationName . "' value='" . $this->op . "' />";
-        }
-        if (!is_null($additionnals)) {
-            foreach ($additionnals as $key => $value) {
-                $html .= "<input type='hidden' name='" . $key . "' id='" . $key . "' value='" . $value . "' />";
-            }
-        }
-        $html .= "<input type='submit' name='btngo' id='btngo' value='$description' />";
-
-        return $html;
-    }
-
-    /**
-     * Retourne le nom de la zone utilisée pour trier les données
-     *
-     * @return string
-     */
-    public function getSortField()
-    {
-        return $this->sortField;
-    }
-
-    /**
-     * Retourne le sens de tri utilisé pour trier les données
-     *
-     * @return string
-     */
-    public function getSortOrder()
-    {
-        return $this->sortOrder();
-    }
-
-    /**
-     * Retourne la valeur d'un champ
-     *
-     * @param  string $fieldName
-     * @return mixed  La valeur du champ ou null si on ne trouve pas la zone
-     */
-    public function getFieldValue($fieldName)
-    {
-        $ret = null;
-        if (isset($this->vars[$fieldName])) {
-            $ret = $this->vars[$fieldName]['data'];
-        }
-
-        return $ret;
-    }
+	const FILTER_DATA_TEXT    = 1;
+	const FILTER_DATA_NUMERIC = 2;
+
+	const FILTER_FIELD_TEXT          = 1;
+	const FILTER_FIELD_SELECT        = 2;
+	const FILTER_FIELD_SELECT_YES_NO = 3;
+
+	/**
+	 * Préfixe des variables de sélection
+	 */
+	const PREFIX = 'filter_';
+
+	/**
+	 * Nom du module (utilisé pour la session)
+	 */
+	const MODULE_NAME = 'references';
+
+	/**
+	 * Contient toutes les variables participant au filtre (avec leur type et description)
+	 *
+	 * @var array
+	 */
+	private $vars = array();
+
+	/**
+	 * Handler des données
+	 *
+	 * @var reference
+	 */
+	private $handler = null;
+
+	/**
+	 * Nom de la zone d'opération (par exemple op=products)
+	 *
+	 * @var string
+	 */
+	private $op = '';
+
+	/**
+	 * action de l'opération en cour (par exemple op=products)
+	 *
+	 * @var string
+	 */
+	private $operationName = '';
+
+	/**
+	 * Nombre maximum d'éléments pas page
+	 *
+	 * @var intger
+	 */
+	private $limit = 10;
+
+	/**
+	 * Nom de la variable start
+	 *
+	 * @var string
+	 */
+	private $startName = '';
+
+	/**
+	 * Critère {@link Criteria} servant à choisir les données
+	 *
+	 * @var object
+	 */
+	private $criteria = null;
+
+	/**
+	 * Indique s'il y a un nouveau critère
+	 *
+	 * @var boolean
+	 */
+	private $newFilter = false;
+
+	/**
+	 * Indique si la méthode filter() a été appelée
+	 *
+	 * @var boolean
+	 */
+	private $isInitialized = false;
+
+	/**
+	 * Zone de tri pour retourner les données (dans getObjects)
+	 *
+	 * @var string
+	 */
+	private $sortField = '';
+
+	/**
+	 * Sens de tri
+	 *
+	 * @var string
+	 */
+	private $sortOrder = '';
+
+	/**
+	 * Liste de critères par défaut
+	 *
+	 * @var array
+	 */
+	private $defaultCriterias = array();
+
+	/**
+	 * L'url complète du script qui appelle
+	 *
+	 * @var string
+	 */
+	private $baseUrl = '';
+
+	/**
+	 * Indique si on conserve en session la position de départ
+	 *
+	 * @var boolean
+	 */
+	private $keepStart = true;
+
+	/**
+	 * Indique si l'autocomplétion est activée
+	 *
+	 * @var boolean
+	 */
+	private $hasAutoComplete = false;
+
+	/**
+	 * Url du dossier js dans le module
+	 *
+	 * @var string
+	 */
+	private $jsFolderUrl = '';
+
+	/**
+	 * Paramètres additionnels à ajouter aux paramètres du pager
+	 * @var array
+	 */
+	private $additionnalPagerParameters = array();
+
+	/**
+	 * Paramètres additionnels à ajouter au bouton permettant de supprimer le filtre en cours
+	 * @var array
+	 */
+	private $additionnalClearButtonParameters = array();
+
+	/**
+	 * Tableau des champs triables [clé] = nom du champ dans la base, valeur = libellé
+	 * @var array
+	 */
+	private $sortFields = array();
+
+	/**
+	 * Initialise les paramètres avec des valeurs par défaut
+	 */
+	private function setDefaultValues()
+	{
+		$this->handler                          = null;
+		$this->op                               = '';
+		$this->limit                            = 10;
+		$this->startName                        = 'start';
+		$this->operationName                    = 'op';
+		$this->sortField                        = '';
+		$this->sortOrder                        = 'asc';
+		$this->baseUrl                          = '';
+		$this->keepStart                        = true;
+		$this->hasAutoComplete                  = false;
+		$this->jsFolderUrl                      = '';
+		$this->additionnalPagerParameters       = array();
+		$this->additionnalClearButtonParameters = array();
+		$this->sortFields                       = array();    // Les champs qui peuvent être utilisés pour trier
+	}
+
+	/**
+	 * Initialisation des données, handler et opération courante dans l'appelant
+	 *
+	 * @param mixed   $handler   Soit une référence au handler de données soit un tableau qui contient toutes les options (auxquel cas les autres paramètres sont inutiles)
+	 * @param string  $operationName
+	 * @param string  $operation Opération courante dans l'appelant
+	 * @param string  $startName Nom du paramètre start
+	 * @param integer $limit     Nombre maximum d'éléments par page
+	 * @param string  $baseUrl   L'url complète du script appelant
+	 * @param string  $sortField Zone de tri
+	 * @param string  $sortOrder Sens de tri
+	 * @param boolean $keepStart Indique si on conserve la position de départ
+	 * @param string  $jsFolderUrl
+	 * @package string $jsFolderUrl Url du répertoire qui contient les scripts Javascript
+	 */
+	public function __construct($handler, $operationName = 'op', $operation = '', $startName = 'start', $limit = 10, $baseUrl = '', $sortField = '', $sortOrder = 'asc', $keepStart = true, $jsFolderUrl = '')
+	{
+		$this->setDefaultValues();
+		if (!is_array($handler)) {
+			$this->handler       = $handler;
+			$this->op            = $operation;
+			$this->limit         = $limit;
+			$this->startName     = $startName;
+			$this->operationName = $operationName;
+			$this->sortField     = $sortField;
+			$this->sortOrder     = $sortOrder;
+			$this->baseUrl       = $baseUrl;
+			$this->keepStart     = $keepStart;
+			$this->jsFolderUrl   = $jsFolderUrl;
+		} else {
+			foreach ($handler as $key => $value) {
+				$this->$key = $value;
+			}
+		}
+	}
+
+	/**
+	 * Donne à la classe le nom des champs sur lesquels on peut faire le tri
+	 *
+	 * @param  array $fields [clé] = nom du champ dans la base, valeur = libellé
+	 * @return object
+	 */
+	public function setSortFields($fields)
+	{
+		$this->sortFields = $fields;
+	}
+
+	/**
+	 * Retourne les noms à utiliser pour les champs de tri (sélecteur de champ et ordre de tri)
+	 *
+	 * @return array [0] = Nom du sélecteur de champs, [1] = Nom du sélecteur pour le sens du tri
+	 */
+	private function getSortPlaceHolderNames()
+	{
+		return array(self::PREFIX . 'sortFields', self::PREFIX . 'sortOrder');
+	}
+
+	/**
+	 * Retourne 2 sélecteurs html pour choisir la zone de tri et le sens du tri
+	 *
+	 * @return string
+	 */
+	public function getSortPlaceHolderHtmlCode()
+	{
+		$sortNames      = $this->getSortPlaceHolderNames();
+		$sortFieldsHtml = references_utils::htmlSelect($sortNames[0], $this->sortFields, $this->sortField, false);
+		$sortOrderHtml  = references_utils::htmlSelect($sortNames[1], array('asc' => _MD_REFERENCES_ASC, 'desc' => _MD_REFERENCES_DESC), $this->sortOrder, false);
+
+		return _MD_REFERENCES_SORT_BY . ' ' . $sortFieldsHtml . ' ' . $sortOrderHtml;
+	}
+
+	/**
+	 * Permet de valoriser une option directement tout en chainant
+	 *
+	 * @param  string $optionName
+	 * @param  mixed  $optionValue
+	 * @return object
+	 */
+	public function setOption($optionName, $optionValue)
+	{
+		$this->$optionName = $optionValue;
+
+		return $this;
+	}
+
+	/**
+	 * Ajoute un nouveau critère par défaut à la liste des critères par défaut
+	 *
+	 * @param Criteria $criteria
+	 */
+	public function addDefaultCriteria(Criteria $criteria)
+	{
+		$this->defaultCriterias[] = $criteria;
+	}
+
+	/**
+	 * Retourne une valeur d'un tableau ou null si l'index n'existe pas
+	 *
+	 * @param array   $array        Le tableau à traiter
+	 * @param  string $index        L'index recherché
+	 * @param  mixed  $defaultValue La valeur par défaut
+	 * @return mixed
+	 */
+	private function getArrayValue($array, $index, $defaultValue = false)
+	{
+		if ($index === 'autoComplete' && isset($array[$index]) && isset($array[$index]) == true) {
+			$this->hasAutoComplete = true;    // On en profite pour vérifier si un champ utilise l'autocomplétion
+		}
+
+		return isset($array[$index]) ? $array[$index] : $defaultValue;
+	}
+
+	/**
+	 * Permet de faire l'autocomplétion d'un champ
+	 *
+	 * @param  string $query
+	 * @param         $limit
+	 * @param  string $fieldName
+	 * @return string
+	 */
+	public function autoComplete($query, $limit, $fieldName)
+	{
+		$return = '';
+		if (!$this->hasAutoComplete) {    // Si aucun champ n'est en autocomplétion, c'est pas la peine d'aller plus loin
+
+			return $return;
+		}
+		if (isset($this->vars[$fieldName])) {    // On vérifie que le champ demandé est bien en autocomplétion
+			if ($this->vars[$fieldName]['autoComplete'] == true) {
+				if ($this->vars[$fieldName]['dataType'] == self::FILTER_DATA_TEXT) {
+					$criteria = new Criteria($fieldName, $query . '%', 'LIKE');
+				}
+				$criteria->setLimit((int)$limit);
+				$ret = $this->handler->getObjects($criteria);
+
+				if (count($ret) > 0) {
+					foreach ($ret as $object) {
+						$return .= $object->getVar($fieldName, 'n') . "\n";
+					}
+				}
+			}
+		}
+
+		return $return;
+	}
+
+	/**
+	 * Retourne le code Javascript à utiliser pour initialiser l'auto complétion (et donc à coller dans le code html)
+	 *
+	 * @param boolean $jqueryAlreadyLoaded Indique si jQuery est déjà chargé par l'appelant, auquel cas rien ne sert de le recharger
+	 * @return string
+	 */
+	public function getJavascriptInitCode($jqueryAlreadyLoaded = false)
+	{
+		$return = '';
+		if (!$this->hasAutoComplete) {
+			return $return;
+		}
+		$return = '';
+		$return .= "<link rel=\"stylesheet\" type=\"text/css\" media=\"all\" title=\"Style sheet\" href=\"" . $this->jsFolderUrl . "autocomplete/jquery.autocomplete.css\" />\n";
+		if (!$jqueryAlreadyLoaded) {
+			$return .= "<script type=\"text/javascript\" src=\"" . $this->jsFolderUrl . "jquery/jquery.js\"></script>\n";
+		}
+		$return .= "<script type=\"text/javascript\" src=\"" . $this->jsFolderUrl . "noconflict.js\"></script>\n";
+		$return .= "<script type=\"text/javascript\" src=\"" . $this->jsFolderUrl . "autocomplete/jquery.autocomplete.min.js\"></script>\n";
+		$return .= "<script type=\"text/javascript\">\n";
+		$return .= "jQuery(function($) {\n";
+		$return .= "var url='" . $this->baseUrl . "';\n";    // TODO: Supprimer "var" car cela limite sa portée !
+		$return .= "var handlerName='" . $this->handler->className . "';\n";
+
+		foreach ($this->vars as $fieldName => $parameters) {
+			if ($parameters['autoComplete'] == true) {
+				$field = self::PREFIX . $fieldName;
+				$return .= "$('#" . $field . "').autocomplete(url, {\n";
+				$return .= "extraParams: {\n";
+				$return .= "    field: '" . $fieldName . "',\n";
+				$return .= "    op: 'autocomplete',\n";
+				$return .= "    handler: handlerName\n";
+				$return .= "}\n";
+				$return .= "});\n";
+			}
+		}
+		$return .= "});\n";
+		$return .= "</script>\n";
+
+		return $return;
+	}
+
+	/**
+	 * Initialisation des données du filtre
+	 * Permet d'indiquer quelles sont les zones sur lesquelles on effectue des filtres ainsi que leur type
+	 *
+	 * @param  string $fieldName  Le nom du champs dans la table
+	 * @param  array  $parameters Les paramètres de la zone sous la forme d'un tableau :
+	 *                            [dataType]        Entier représentant le type de donnée (numérique ou chaine)
+	 *                            [fieldType]       Le type de zone de saisie (zone de texte, liste déroulante, liste déroulante Oui/Non)
+	 *                            [values]      La ou les valeurs de la zone de saisie (utilisé dans le cas d'un select)
+	 *                            [size]            Largeur d'affichage pour les textbox
+	 *                            [maxLength]       Largeur maximale pour les textbox
+	 *                            [withNull]        Dans le cas des listes déroulantes, indique s'il faut une valeur nulle
+	 *                            [minusOne]        Indique s'il faut retrancher 1 à la valeur saisie récupérée (cas classique des listes Oui/Non avec une valeur nulle)
+	 *                            [style]            Dans le cas des liste déroulante, le style à appliquer à la liste
+	 *                            [data]            A ne pas renseigner, contient la valeur saisie par l'utilisateur
+	 *                            [operator]        Opérateur de comparaison pour le Criteria
+	 *                            [autoComplete]  Indique si on active l'auto complétion sur le champs
+	 * @return object L'objet courant pour pouvoir chainer
+	 */
+	public function initFilter($fieldName, $parameters)
+	{
+		// Tableau des valeurs attendues avec leur valeur par défaut
+		$indexNames = array('dataType' => self::FILTER_DATA_TEXT, 'fieldType' => self::FILTER_FIELD_TEXT, 'values' => null, 'withNull' => false, 'size' => 5, 'maxLength' => 255, 'minusOne' => false, 'data' => null, 'style' => '', 'operator' => '=', 'autoComplete' => false);
+		$data       = array();
+		foreach ($indexNames as $indexName => $defaultValue) {
+			$data[$indexName] = $this->getArrayValue($parameters, $indexName, $defaultValue);
+		}
+		$this->vars[$fieldName] = $data;
+
+		return $this;
+	}
+
+	/**
+	 * Retourne le nom du tableau à utiliser pour la session
+	 * @note : Le nom de la session est composé de : nom du module_nom du handler, par exemple references_references_articles
+	 *
+	 * @return string
+	 */
+	private function getSessionName()
+	{
+		return self::MODULE_NAME . '_' . $this->handler->table;
+	}
+
+	/**
+	 * Retourne le nom de la clé à utiliser pour la conservation du start en session
+	 *
+	 * @return string
+	 */
+	private function getStartSessionName()
+	{
+		return $this->getSessionName() . '_start';
+	}
+
+	/**
+	 * Réinitialisation des données avant traitement
+	 *
+	 * @return void
+	 */
+	private function reinitializeFieldsValue()
+	{
+		foreach ($this->vars as $fieldName => $fieldProperties) {
+			if ($fieldProperties['dataType'] == self::FILTER_DATA_NUMERIC) {    // Zone numérique
+				$fieldProperties['data'] = 0;
+			} else {
+				$fieldProperties['data'] = '';
+			}
+			$this->vars[$fieldName] = $fieldProperties;
+		}
+	}
+
+	/**
+	 * Ajoute les critères par défaut au critère général
+	 *
+	 * @return void
+	 */
+	private function addDefaultCriterias()
+	{
+		if (is_array($this->defaultCriterias) && count($this->defaultCriterias) > 0) {
+			foreach ($this->defaultCriterias as $criteria) {
+				$this->criteria->add($criteria);
+			}
+		}
+
+		return $this;
+	}
+
+	/**
+	 * Indique s'il y a des champs de tri
+	 *
+	 * @return boolean
+	 */
+	private function areThereSortFields()
+	{
+		$return = false;
+		if (is_array($this->sortFields) && count($this->sortFields) > 0) {
+			$return = true;
+		}
+
+		return $return;
+	}
+
+	/**
+	 * Indique si le nom du champ passé en paramètre fait partie de la liste des champs "triables"
+	 *
+	 * @param  string $fieldName
+	 * @return boolean
+	 */
+	private function isInSortFieldsList($fieldName)
+	{
+		return array_key_exists($fieldName, $this->sortFields);
+	}
+
+	/**
+	 * Indique si le sens de tri passé en paramètre fait partie de la liste autorisée
+	 *
+	 * @param  string $order
+	 * @return boolean
+	 */
+	private function isInSortOrderList($order)
+	{
+		return in_array($order, array('asc', 'desc'));
+	}
+
+	/**
+	 * Récupère, depuis la requête d'entrée, la zone de tri à utiliser et le sens du tri et place l'information en cookie
+	 * pour que lorsque l'utilisateur se reconnecte, il retrouve ses informations de tri
+	 *
+	 * @return void
+	 */
+	private function setSortFieldsFromRequest()
+	{
+		if (!$this->areThereSortFields()) {    // S'il n'y a pas de champs triables, on laisse tomber
+
+			return;
+		}
+		$sortField        = $sortOrder = '';
+		$cookieName       = $this->getSessionName();
+		$orderFieldsNames = $this->getSortPlaceHolderNames();
+		if (isset($_REQUEST[$orderFieldsNames[0]]) && isset($_REQUEST[$orderFieldsNames[1]])) {
+			$sortField = $_REQUEST[$orderFieldsNames[0]];
+			$sortOrder = $_REQUEST[$orderFieldsNames[1]];
+		} else {
+			if (isset($_SESSION[$cookieName . '_sortField'])) {
+				$sortField = $_SESSION[$cookieName . '_sortField'];
+			}
+			if (isset($_SESSION[$cookieName . '_sortOrder'])) {
+				$sortOrder = $_SESSION[$cookieName . '_sortOrder'];
+			}
+		}
+
+		if ($this->isInSortFieldsList($sortField) && $this->isInSortOrderList($sortOrder)) {
+			$this->sortField = $sortField;
+			$this->sortOrder = $sortOrder;
+		}
+		if (trim($sortField) != '' && trim($sortOrder) != '') {
+			$_SESSION[$cookieName . '_sortField'] = $sortField;
+			$_SESSION[$cookieName . '_sortOrder'] = $sortOrder;
+		}
+	}
+
+	/**
+	 * Réinitialisation des données avant traitement
+	 *
+	 * @return void
+	 */
+	private function setupFilter()
+	{
+		$this->reinitializeFieldsValue();
+		$this->newFilter     = false;
+		$this->isInitialized = true;
+		$this->criteria      = new CriteriaCompo();
+		$this->criteria->add(new Criteria($this->handler->keyName, 0, '<>'));
+		$this->addDefaultCriterias();
+	}
+
+	/**
+	 * RAZ des données du filtre si cela a été demandé dans la requête
+	 *
+	 * @return void
+	 */
+	private function isSetCleanFilter()
+	{
+		if (isset($_REQUEST['cleanFilter'])) {
+			$this->setStartInSession(0);
+			unset($_SESSION[$this->getSessionName()]);
+		}
+	}
+
+	/**
+	 * Retourne le critère de filtrage courant
+	 *
+	 * @return object
+	 */
+	public function getCriteria()
+	{
+		return $this->criteria;
+	}
+
+	/**
+	 * Méthode à appeler juste après le constructeur pour qu'elle récupère les données saisies
+	 *
+	 * @return object L'objet courant pour pouvoir chainer
+	 */
+	public function filter()
+	{
+		$this->setupFilter();                // Réinitialisations
+		$ts = MyTextSanitizer::getInstance();
+		$this->setSortFieldsFromRequest();    // On récupère la zone de tri éventuellement passée dans la requête
+		$this->isSetCleanFilter();
+
+		foreach ($this->vars as $fieldName => $fieldProperties) {
+			// On commence par récupérer toutes les valeurs
+			$formFieldName           = self::PREFIX . $fieldName;    // "filter_website_id" par exemple
+			$fieldProperties['data'] = null;    // Valeur par défaut
+			if (isset($_REQUEST[$formFieldName])) {
+				if ($fieldProperties['dataType'] == self::FILTER_DATA_NUMERIC) {    // Zone numérique
+					if ((int)$_REQUEST[$formFieldName] != 0) {
+						$fieldProperties['data'] = (int)$_REQUEST[$formFieldName];
+						if (!$fieldProperties['minusOne']) {
+							$this->criteria->add(new Criteria($fieldName, $fieldProperties['data'], $fieldProperties['operator']));
+						} else {
+							$this->criteria->add(new Criteria($fieldName, $fieldProperties['data'] - 1, $fieldProperties['operator']));
+						}
+						$this->newFilter = true;
+					}
+				} else {    // Zone texte
+					if (trim($_REQUEST[$formFieldName]) != '') {
+						$fieldProperties['data'] = $_REQUEST[$formFieldName];
+						if (!REFERENCES_EXACT_SEARCH) {
+							$this->criteria->add(new Criteria($fieldName, '%' . $ts->addSlashes($fieldProperties['data']) . '%', 'LIKE'));
+						} else {
+							$this->criteria->add(new Criteria($fieldName, $ts->addSlashes($fieldProperties['data']) . '%', 'LIKE'));
+						}
+						$this->newFilter = true;
+					}
+				}
+			}
+			$this->vars[$fieldName] = $fieldProperties;
+		}
+
+		if ($this->newFilter) {
+			$this->setStartInSession(0);
+		}
+
+		// Récupération des donées de la session s'il n'y a pas eu de filtre(s)
+		if (!$this->newFilter && isset($_SESSION[$this->getSessionName()])) {
+			$sessionFilterData = unserialize($_SESSION[$this->getSessionName()]);
+			if (isset($sessionFilterData['criteria']) && is_object($sessionFilterData['criteria'])) {
+				$this->criteria = $sessionFilterData['criteria'];
+				unset($sessionFilterData['criteria']);
+			}
+			foreach ($this->vars as $fieldName => $fieldProperties) {
+				if (isset($sessionFilterData[$fieldName])) {
+					$fieldProperties['data'] = $sessionFilterData[$fieldName];
+				}
+				$this->vars[$fieldName] = $fieldProperties;
+			}
+			unset($_SESSION[$this->getSessionName()]);
+		}
+
+		// Mise en place des données dans la session
+		$dataForSession             = array();
+		$dataForSession['criteria'] = $this->criteria;
+		foreach ($this->vars as $fieldName => $fieldProperties) {
+			$dataForSession[$fieldName] = $fieldProperties['data'];
+		}
+		$_SESSION[$this->getSessionName()] = serialize($dataForSession);
+
+		return $this;
+	}
+
+	/**
+	 * Retourne le nombre d'enregistrement en fonction des critères courants
+	 *
+	 * @return integer
+	 */
+	public function getCount()
+	{
+		if (!$this->isInitialized) {
+			$this->filter();
+		}
+
+		return $this->handler->getCount($this->criteria);
+	}
+
+	/**
+	 * Conserve la valeur de start en session
+	 *
+	 * @param  integer $start
+	 * @return void
+	 */
+	private function setStartInSession($start)
+	{
+		if ($this->keepStart) {
+			$startSessionName            = $this->getStartSessionName();
+			$_SESSION[$startSessionName] = (int)$start;
+		}
+	}
+
+	/**
+	 * Retourne la valeur de ?start=x
+	 *
+	 * @return integer
+	 */
+	private function getStartValue()
+	{
+		$start = 0;
+		if (isset($_REQUEST[$this->startName])) {
+			$start = (int)$_REQUEST[$this->startName];
+		} elseif ($this->keepStart) {
+			$startSessionName = $this->getStartSessionName();
+			if (isset($_SESSION[$startSessionName])) {
+				$start = (int)$_SESSION[$startSessionName];
+			}
+		}
+		// Mise en session
+		$this->setStartInSession($start);
+
+		return $start;
+	}
+
+	/**
+	 * Permet d'ajouter un paramètre supplémentaire au pager
+	 *
+	 * @param  string $key
+	 * @param  string $value
+	 * @return object
+	 */
+	public function addAdditionnalParameterToPager($key, $value = '')
+	{
+		$this->additionnalPagerParameters[$key] = $value;
+
+		return $this;
+	}
+
+	/**
+	 * Permet d'ajouter un paramètre supplémentaire au bouton permettant de supprimer le filtre
+	 *
+	 * @param  string $key
+	 * @param  string $value
+	 * @return object
+	 */
+	public function addAdditionnalParameterToClearButton($key, $value = '')
+	{
+		$this->additionnalClearButtonParameters[$key] = $value;
+
+		return $this;
+	}
+
+	/**
+	 * Permet d'ajouter des paramètres supplémentaires au pager
+	 *
+	 * @param $array
+	 * @return object
+	 * @internal param string $key
+	 * @internal param string $value
+	 */
+	public function addAditionnalArrayParametersToPager($array)
+	{
+		if (count($array) > 0) {
+			foreach ($array as $key => $value) {
+				$this->addAdditionnalParameterToPager($key, $value);
+			}
+		}
+
+		return $this;
+	}
+
+	/**
+	 * Retourne le pager à utiliser
+	 *
+	 * @return mixed Null s'il n'y a pas lieu d'y avoir un pager, sinon un objet de type {@link XoopsPageNav}
+	 */
+	public function getPager()
+	{
+		if (!$this->isInitialized) {
+			$this->filter();
+		}
+		require_once XOOPS_ROOT_PATH . '/class/pagenav.php';
+		$itemsCount  = $this->getCount();
+		$queryString = array();
+		if (trim($this->op) != '') {
+			$queryString[$this->operationName] = $this->op;
+		}
+		$pagenav = null;
+
+		if ($itemsCount > $this->limit) {
+			foreach ($this->vars as $fieldName => $fieldProperties) {
+				$formFieldName               = self::PREFIX . $fieldName;    // "filter_website_id" par exemple
+				$queryString[$formFieldName] = $fieldProperties['data'];
+			}
+			// Ajout des paramètres supplémentaires éventuels
+			if (count($this->additionnalPagerParameters) > 0) {
+				foreach ($this->additionnalPagerParameters as $key => $value) {
+					$queryString[$key] = $value;
+				}
+			}
+			$start   = $this->getStartValue();
+			$pagenav = new XoopsPageNav($itemsCount, $this->limit, $start, $this->startName, http_build_query($queryString));
+		}
+
+		return $pagenav;
+	}
+
+	/**
+	 * Retourne une liste d'objets en fonction des critères définis
+	 *
+	 * @return array
+	 */
+	public function getObjects()
+	{
+		if (!$this->isInitialized) {
+			$this->filter();
+		}
+		$start    = $this->getStartValue();
+		$limit    = $this->limit;
+		$criteria = $this->criteria;
+		$criteria->setStart($start);
+		$criteria->setLimit($limit);
+
+		$criteria->setOrder($this->sortOrder);
+		if (trim($this->sortField) != '') {
+			$criteria->setSort($this->sortField);
+		} elseif (trim($this->handler->identifierName) != '') {
+			$criteria->setSort($this->handler->identifierName);
+		}
+
+		return $this->handler->getObjects($this->criteria);
+	}
+
+	/**
+	 * Retourne la zone html à utiliser pour créer la zone de filtre (avec sa valeur saisie si c'est le cas)
+	 *
+	 * @param  string $fieldName La zone de saisie dont on veut récupérer le code html
+	 * @return string
+	 */
+	public function getFilterField($fieldName)
+	{
+		$html = '';
+		if (!$this->isInitialized) {
+			$this->filter();
+		}
+		if (!isset($this->vars[$fieldName])) {
+			trigger_error('Error, unknow field');
+
+			return $html;
+		}
+		$fieldData     = $this->vars[$fieldName];
+		$htmlFieldName = self::PREFIX . $fieldName;
+
+		switch ($fieldData['fieldType']) {
+			case self::FILTER_FIELD_TEXT:    // Zone de texte
+				$ts   = MyTextSanitizer::getInstance();
+				$html = "<input type='text' name='$htmlFieldName' id='$htmlFieldName' size='" . $fieldData['size'] . "' maxlength='" . $fieldData['maxLength'] . "' value='" . $ts->htmlSpecialChars($fieldData['data']) . "' />";
+				break;
+
+			case self::FILTER_FIELD_SELECT;     // Select
+				$style = '';
+				if (isset($fieldData['style']) && trim($fieldData['style']) != '') {
+					$style = $fieldData['style'];
+				}
+				$html = references_utils::htmlSelect($htmlFieldName, $fieldData['values'], $fieldData['data'], $fieldData['withNull'], $style);
+				break;
+
+			case self::FILTER_FIELD_SELECT_YES_NO:    // Select de type Oui/Non
+				$html = references_utils::htmlSelect($htmlFieldName, array(2 => _YES, 1 => NO), $fieldData['data'], $fieldData['withNull']);
+				break;
+		}
+
+		return $html;
+	}
+
+	/**
+	 * Assigne toutes les zones de filtre à un template
+	 *
+	 * @param  object  $xoopsTpl
+	 * @param  boolean $asArray   Est-ce qu'il faut placer le résultat dans un tableau ou assigner par nom de zone de filtre
+	 * @param string   $arrayName Le nom du tableau à utiliser
+	 * @return void
+	 */
+	public function assignFilterFieldsToTemplate(&$xoopsTpl, $asArray = true, $arrayName = 'filterFields')
+	{
+		$fields = array_keys($this->vars);
+		foreach ($fields as $field) {
+			if (!$asArray) {
+				$xoopsTpl->assign($field, $this->getFilterField($field));
+			} else {
+				$xoopsTpl->append($arrayName, $this->getFilterField($field));
+			}
+		}
+	}
+
+	/**
+	 * Retourne le bouton utilisé pour supprimer le filtre en cours
+	 *
+	 * @return string
+	 */
+	public function getClearFilterbutton()
+	{
+		$queryString                       = array();
+		$queryString[$this->operationName] = $this->op;
+		if (count($this->additionnalClearButtonParameters) > 0) {
+			foreach ($this->additionnalClearButtonParameters as $key => $value) {
+				$queryString[$key] = $value;
+			}
+		}
+		$queryString['cleanFilter'] = '1';
+		$baseurl                    = $this->baseUrl;
+
+		return "&nbsp;&nbsp;<a href='$baseurl?" . http_build_query($queryString) . "' title='" . _MD_REFERENCES_CLEAN_FILTER . "'><img align='top' src='../assets/images/clear_left.png' alt='" . _MD_REFERENCES_CLEAN_FILTER . "' /></a>";
+	}
+
+	/**
+	 * Retourne le bouton permettant de lancer le filtrage
+	 *
+	 * @param string $description  Texte à faire apparaître sur le bouton
+	 * @param array  $additionnals Champs supplémentaires à faire apparaître avec le bouton
+	 * @return string
+	 */
+	public function getGoButton($description = _GO, $additionnals = null)
+	{
+		$html = '';
+		if (trim($this->operationName) != '' && trim($this->op) != '') {
+			$html .= "<input type='hidden' name='" . $this->operationName . "' id='" . $this->operationName . "' value='" . $this->op . "' />";
+		}
+		if (!is_null($additionnals)) {
+			foreach ($additionnals as $key => $value) {
+				$html .= "<input type='hidden' name='" . $key . "' id='" . $key . "' value='" . $value . "' />";
+			}
+		}
+		$html .= "<input type='submit' name='btngo' id='btngo' value='$description' />";
+
+		return $html;
+	}
+
+	/**
+	 * Retourne le nom de la zone utilisée pour trier les données
+	 *
+	 * @return string
+	 */
+	public function getSortField()
+	{
+		return $this->sortField;
+	}
+
+	/**
+	 * Retourne le sens de tri utilisé pour trier les données
+	 *
+	 * @return string
+	 */
+	public function getSortOrder()
+	{
+		return $this->sortOrder();
+	}
+
+	/**
+	 * Retourne la valeur d'un champ
+	 *
+	 * @param  string $fieldName
+	 * @return mixed  La valeur du champ ou null si on ne trouve pas la zone
+	 */
+	public function getFieldValue($fieldName)
+	{
+		$ret = null;
+		if (isset($this->vars[$fieldName])) {
+			$ret = $this->vars[$fieldName]['data'];
+		}
+
+		return $ret;
+	}
 }

Spacing +43 added lines, -43 removed lines

@@ -200,7 +200,7 @@ 
         $this->jsFolderUrl                      = '';
         $this->additionnalPagerParameters       = array();
         $this->additionnalClearButtonParameters = array();
-        $this->sortFields                       = array();    // Les champs qui peuvent être utilisés pour trier
+        $this->sortFields                       = array(); // Les champs qui peuvent être utilisés pour trier
     }
 
     /**
@@ -257,7 +257,7 @@ 
      */
     private function getSortPlaceHolderNames()
     {
-        return array(self::PREFIX . 'sortFields', self::PREFIX . 'sortOrder');
+        return array(self::PREFIX.'sortFields', self::PREFIX.'sortOrder');
     }
 
     /**
@@ -271,7 +271,7 @@ 
         $sortFieldsHtml = references_utils::htmlSelect($sortNames[0], $this->sortFields, $this->sortField, false);
         $sortOrderHtml  = references_utils::htmlSelect($sortNames[1], array('asc' => _MD_REFERENCES_ASC, 'desc' => _MD_REFERENCES_DESC), $this->sortOrder, false);
 
-        return _MD_REFERENCES_SORT_BY . ' ' . $sortFieldsHtml . ' ' . $sortOrderHtml;
+        return _MD_REFERENCES_SORT_BY.' '.$sortFieldsHtml.' '.$sortOrderHtml;
     }
 
     /**
@@ -309,7 +309,7 @@ 
     private function getArrayValue($array, $index, $defaultValue = false)
     {
         if ($index === 'autoComplete' && isset($array[$index]) && isset($array[$index]) == true) {
-            $this->hasAutoComplete = true;    // On en profite pour vérifier si un champ utilise l'autocomplétion
+            $this->hasAutoComplete = true; // On en profite pour vérifier si un champ utilise l'autocomplétion
         }
 
         return isset($array[$index]) ? $array[$index] : $defaultValue;
@@ -333,14 +333,14 @@ 
         if (isset($this->vars[$fieldName])) {    // On vérifie que le champ demandé est bien en autocomplétion
             if ($this->vars[$fieldName]['autoComplete'] == true) {
                 if ($this->vars[$fieldName]['dataType'] == self::FILTER_DATA_TEXT) {
-                    $criteria = new Criteria($fieldName, $query . '%', 'LIKE');
+                    $criteria = new Criteria($fieldName, $query.'%', 'LIKE');
                 }
-                $criteria->setLimit((int)$limit);
+                $criteria->setLimit((int) $limit);
                 $ret = $this->handler->getObjects($criteria);
 
                 if (count($ret) > 0) {
                     foreach ($ret as $object) {
-                        $return .= $object->getVar($fieldName, 'n') . "\n";
+                        $return .= $object->getVar($fieldName, 'n')."\n";
                     }
                 }
             }
@@ -362,23 +362,23 @@ 
             return $return;
         }
         $return = '';
-        $return .= "<link rel=\"stylesheet\" type=\"text/css\" media=\"all\" title=\"Style sheet\" href=\"" . $this->jsFolderUrl . "autocomplete/jquery.autocomplete.css\" />\n";
+        $return .= "<link rel=\"stylesheet\" type=\"text/css\" media=\"all\" title=\"Style sheet\" href=\"".$this->jsFolderUrl."autocomplete/jquery.autocomplete.css\" />\n";
         if (!$jqueryAlreadyLoaded) {
-            $return .= "<script type=\"text/javascript\" src=\"" . $this->jsFolderUrl . "jquery/jquery.js\"></script>\n";
+            $return .= "<script type=\"text/javascript\" src=\"".$this->jsFolderUrl."jquery/jquery.js\"></script>\n";
         }
-        $return .= "<script type=\"text/javascript\" src=\"" . $this->jsFolderUrl . "noconflict.js\"></script>\n";
-        $return .= "<script type=\"text/javascript\" src=\"" . $this->jsFolderUrl . "autocomplete/jquery.autocomplete.min.js\"></script>\n";
+        $return .= "<script type=\"text/javascript\" src=\"".$this->jsFolderUrl."noconflict.js\"></script>\n";
+        $return .= "<script type=\"text/javascript\" src=\"".$this->jsFolderUrl."autocomplete/jquery.autocomplete.min.js\"></script>\n";
         $return .= "<script type=\"text/javascript\">\n";
         $return .= "jQuery(function($) {\n";
-        $return .= "var url='" . $this->baseUrl . "';\n";    // TODO: Supprimer "var" car cela limite sa portée !
-        $return .= "var handlerName='" . $this->handler->className . "';\n";
+        $return .= "var url='".$this->baseUrl."';\n"; // TODO: Supprimer "var" car cela limite sa portée !
+        $return .= "var handlerName='".$this->handler->className."';\n";
 
         foreach ($this->vars as $fieldName => $parameters) {
             if ($parameters['autoComplete'] == true) {
-                $field = self::PREFIX . $fieldName;
-                $return .= "$('#" . $field . "').autocomplete(url, {\n";
+                $field = self::PREFIX.$fieldName;
+                $return .= "$('#".$field."').autocomplete(url, {\n";
                 $return .= "extraParams: {\n";
-                $return .= "    field: '" . $fieldName . "',\n";
+                $return .= "    field: '".$fieldName."',\n";
                 $return .= "    op: 'autocomplete',\n";
                 $return .= "    handler: handlerName\n";
                 $return .= "}\n";
@@ -431,7 +431,7 @@ 
      */
     private function getSessionName()
     {
-        return self::MODULE_NAME . '_' . $this->handler->table;
+        return self::MODULE_NAME.'_'.$this->handler->table;
     }
 
     /**
@@ -441,7 +441,7 @@ 
      */
     private function getStartSessionName()
     {
-        return $this->getSessionName() . '_start';
+        return $this->getSessionName().'_start';
     }
 
     /**
@@ -533,11 +533,11 @@ 
             $sortField = $_REQUEST[$orderFieldsNames[0]];
             $sortOrder = $_REQUEST[$orderFieldsNames[1]];
         } else {
-            if (isset($_SESSION[$cookieName . '_sortField'])) {
-                $sortField = $_SESSION[$cookieName . '_sortField'];
+            if (isset($_SESSION[$cookieName.'_sortField'])) {
+                $sortField = $_SESSION[$cookieName.'_sortField'];
             }
-            if (isset($_SESSION[$cookieName . '_sortOrder'])) {
-                $sortOrder = $_SESSION[$cookieName . '_sortOrder'];
+            if (isset($_SESSION[$cookieName.'_sortOrder'])) {
+                $sortOrder = $_SESSION[$cookieName.'_sortOrder'];
             }
         }
 
@@ -546,8 +546,8 @@ 
             $this->sortOrder = $sortOrder;
         }
         if (trim($sortField) != '' && trim($sortOrder) != '') {
-            $_SESSION[$cookieName . '_sortField'] = $sortField;
-            $_SESSION[$cookieName . '_sortOrder'] = $sortOrder;
+            $_SESSION[$cookieName.'_sortField'] = $sortField;
+            $_SESSION[$cookieName.'_sortOrder'] = $sortOrder;
         }
     }
 
@@ -596,19 +596,19 @@ 
      */
     public function filter()
     {
-        $this->setupFilter();                // Réinitialisations
+        $this->setupFilter(); // Réinitialisations
         $ts = MyTextSanitizer::getInstance();
-        $this->setSortFieldsFromRequest();    // On récupère la zone de tri éventuellement passée dans la requête
+        $this->setSortFieldsFromRequest(); // On récupère la zone de tri éventuellement passée dans la requête
         $this->isSetCleanFilter();
 
         foreach ($this->vars as $fieldName => $fieldProperties) {
             // On commence par récupérer toutes les valeurs
-            $formFieldName           = self::PREFIX . $fieldName;    // "filter_website_id" par exemple
-            $fieldProperties['data'] = null;    // Valeur par défaut
+            $formFieldName           = self::PREFIX.$fieldName; // "filter_website_id" par exemple
+            $fieldProperties['data'] = null; // Valeur par défaut
             if (isset($_REQUEST[$formFieldName])) {
                 if ($fieldProperties['dataType'] == self::FILTER_DATA_NUMERIC) {    // Zone numérique
-                    if ((int)$_REQUEST[$formFieldName] != 0) {
-                        $fieldProperties['data'] = (int)$_REQUEST[$formFieldName];
+                    if ((int) $_REQUEST[$formFieldName] != 0) {
+                        $fieldProperties['data'] = (int) $_REQUEST[$formFieldName];
                         if (!$fieldProperties['minusOne']) {
                             $this->criteria->add(new Criteria($fieldName, $fieldProperties['data'], $fieldProperties['operator']));
                         } else {
@@ -620,9 +620,9 @@ 
                     if (trim($_REQUEST[$formFieldName]) != '') {
                         $fieldProperties['data'] = $_REQUEST[$formFieldName];
                         if (!REFERENCES_EXACT_SEARCH) {
-                            $this->criteria->add(new Criteria($fieldName, '%' . $ts->addSlashes($fieldProperties['data']) . '%', 'LIKE'));
+                            $this->criteria->add(new Criteria($fieldName, '%'.$ts->addSlashes($fieldProperties['data']).'%', 'LIKE'));
                         } else {
-                            $this->criteria->add(new Criteria($fieldName, $ts->addSlashes($fieldProperties['data']) . '%', 'LIKE'));
+                            $this->criteria->add(new Criteria($fieldName, $ts->addSlashes($fieldProperties['data']).'%', 'LIKE'));
                         }
                         $this->newFilter = true;
                     }
@@ -686,7 +686,7 @@ 
     {
         if ($this->keepStart) {
             $startSessionName            = $this->getStartSessionName();
-            $_SESSION[$startSessionName] = (int)$start;
+            $_SESSION[$startSessionName] = (int) $start;
         }
     }
 
@@ -699,11 +699,11 @@ 
     {
         $start = 0;
         if (isset($_REQUEST[$this->startName])) {
-            $start = (int)$_REQUEST[$this->startName];
+            $start = (int) $_REQUEST[$this->startName];
         } elseif ($this->keepStart) {
             $startSessionName = $this->getStartSessionName();
             if (isset($_SESSION[$startSessionName])) {
-                $start = (int)$_SESSION[$startSessionName];
+                $start = (int) $_SESSION[$startSessionName];
             }
         }
         // Mise en session
@@ -769,7 +769,7 @@ 
         if (!$this->isInitialized) {
             $this->filter();
         }
-        require_once XOOPS_ROOT_PATH . '/class/pagenav.php';
+        require_once XOOPS_ROOT_PATH.'/class/pagenav.php';
         $itemsCount  = $this->getCount();
         $queryString = array();
         if (trim($this->op) != '') {
@@ -779,7 +779,7 @@ 
 
         if ($itemsCount > $this->limit) {
             foreach ($this->vars as $fieldName => $fieldProperties) {
-                $formFieldName               = self::PREFIX . $fieldName;    // "filter_website_id" par exemple
+                $formFieldName               = self::PREFIX.$fieldName; // "filter_website_id" par exemple
                 $queryString[$formFieldName] = $fieldProperties['data'];
             }
             // Ajout des paramètres supplémentaires éventuels
@@ -839,15 +839,15 @@ 
             return $html;
         }
         $fieldData     = $this->vars[$fieldName];
-        $htmlFieldName = self::PREFIX . $fieldName;
+        $htmlFieldName = self::PREFIX.$fieldName;
 
         switch ($fieldData['fieldType']) {
             case self::FILTER_FIELD_TEXT:    // Zone de texte
                 $ts   = MyTextSanitizer::getInstance();
-                $html = "<input type='text' name='$htmlFieldName' id='$htmlFieldName' size='" . $fieldData['size'] . "' maxlength='" . $fieldData['maxLength'] . "' value='" . $ts->htmlSpecialChars($fieldData['data']) . "' />";
+                $html = "<input type='text' name='$htmlFieldName' id='$htmlFieldName' size='".$fieldData['size']."' maxlength='".$fieldData['maxLength']."' value='".$ts->htmlSpecialChars($fieldData['data'])."' />";
                 break;
 
-            case self::FILTER_FIELD_SELECT;     // Select
+            case self::FILTER_FIELD_SELECT; // Select
                 $style = '';
                 if (isset($fieldData['style']) && trim($fieldData['style']) != '') {
                     $style = $fieldData['style'];
@@ -900,7 +900,7 @@ 
         $queryString['cleanFilter'] = '1';
         $baseurl                    = $this->baseUrl;
 
-        return "&nbsp;&nbsp;<a href='$baseurl?" . http_build_query($queryString) . "' title='" . _MD_REFERENCES_CLEAN_FILTER . "'><img align='top' src='../assets/images/clear_left.png' alt='" . _MD_REFERENCES_CLEAN_FILTER . "' /></a>";
+        return "&nbsp;&nbsp;<a href='$baseurl?".http_build_query($queryString)."' title='"._MD_REFERENCES_CLEAN_FILTER."'><img align='top' src='../assets/images/clear_left.png' alt='"._MD_REFERENCES_CLEAN_FILTER."' /></a>";
     }
 
     /**
@@ -914,11 +914,11 @@ 
     {
         $html = '';
         if (trim($this->operationName) != '' && trim($this->op) != '') {
-            $html .= "<input type='hidden' name='" . $this->operationName . "' id='" . $this->operationName . "' value='" . $this->op . "' />";
+            $html .= "<input type='hidden' name='".$this->operationName."' id='".$this->operationName."' value='".$this->op."' />";
         }
         if (!is_null($additionnals)) {
             foreach ($additionnals as $key => $value) {
-                $html .= "<input type='hidden' name='" . $key . "' id='" . $key . "' value='" . $value . "' />";
+                $html .= "<input type='hidden' name='".$key."' id='".$key."' value='".$value."' />";
             }
         }
         $html .= "<input type='submit' name='btngo' id='btngo' value='$description' />";

class/references_plugins.php

Doc Comments +4 added lines, -4 removed lines

@@ -95,7 +95,7 @@ 
     /**
      * Retourne l'instance unique de la classe
      *
-     * @return object
+     * @return references_plugins
      */
     public static function getInstance()
     {
@@ -177,8 +177,8 @@ 
      * Déclenchement d'une action et appel des plugins liés
      *
      * @param string                       $eventToFire L'action déclenchée
-     * @param object|references_parameters $parameters  Les paramètres à passer à chaque plugin
-     * @return object L'objet lui même pour chaîner
+     * @param references_parameters $parameters  Les paramètres à passer à chaque plugin
+     * @return references_plugins L'objet lui même pour chaîner
      */
     public function fireAction($eventToFire, references_parameters $parameters = null)
     {
@@ -212,7 +212,7 @@ 
      * Déclenchement d'un filtre et appel des plugins liés
      *
      * @param string                       $eventToFire Le filtre appelé
-     * @param object|references_parameters $parameters  Les paramètres à passer à chaque plugin
+     * @param references_parameters $parameters  Les paramètres à passer à chaque plugin
      * @return object Le contenu de l'objet passé en paramètre
      */
     public function fireFilter($eventToFire, references_parameters $parameters)

Indentation +236 added lines, -236 removed lines

@@ -25,266 +25,266 @@
  */
 class references_plugins
 {
-    /**
-     * Dictionnaire des évènements
-     */
-    const EVENT_ON_REFERENCE_CREATE = 'onReferenceCreate';
-    const EVENT_ON_CATEGORY_CREATE  = 'onCategoryCreate';
+	/**
+	 * Dictionnaire des évènements
+	 */
+	const EVENT_ON_REFERENCE_CREATE = 'onReferenceCreate';
+	const EVENT_ON_CATEGORY_CREATE  = 'onCategoryCreate';
 
-    // Pour limiter les dépendances
-    const MODULE_DIRNAME = REFERENCES_DIRNAME;
+	// Pour limiter les dépendances
+	const MODULE_DIRNAME = REFERENCES_DIRNAME;
 
-    /**
-     * Types d'évènements
-     */
-    const PLUGIN_ACTION = 0;
-    const PLUGIN_FILTER = 1;
+	/**
+	 * Types d'évènements
+	 */
+	const PLUGIN_ACTION = 0;
+	const PLUGIN_FILTER = 1;
 
-    /**
-     * Nom du script Php inclut qui contient l'inscription des plugins
-     */
-    const PLUGIN_SCRIPT_NAME = 'plugins.php';
+	/**
+	 * Nom du script Php inclut qui contient l'inscription des plugins
+	 */
+	const PLUGIN_SCRIPT_NAME = 'plugins.php';
 
-    /**
-     * Dans le fichier Php qui contient l'inscription des plugins, méthode à appeler pour récupérer la liste des plugins
-     */
-    const PLUGIN_DESCRIBE_METHOD = 'registerEvents';
+	/**
+	 * Dans le fichier Php qui contient l'inscription des plugins, méthode à appeler pour récupérer la liste des plugins
+	 */
+	const PLUGIN_DESCRIBE_METHOD = 'registerEvents';
 
-    /**
-     * Nom de la variable de session qui contient la liste des plugins détachés
-     */
-    const PLUGIN_UNPLUG_SESSION_NAME = 'references_plugins';
+	/**
+	 * Nom de la variable de session qui contient la liste des plugins détachés
+	 */
+	const PLUGIN_UNPLUG_SESSION_NAME = 'references_plugins';
 
-    /**
-     * Priorités des plugins
-     * @var constant
-     */
-    const EVENT_PRIORITY_1 = 1;    // Priorité la plus haute
-    const EVENT_PRIORITY_2 = 2;
-    const EVENT_PRIORITY_3 = 3;
-    const EVENT_PRIORITY_4 = 4;
-    const EVENT_PRIORITY_5 = 5;    // Priorité la plus basse
+	/**
+	 * Priorités des plugins
+	 * @var constant
+	 */
+	const EVENT_PRIORITY_1 = 1;    // Priorité la plus haute
+	const EVENT_PRIORITY_2 = 2;
+	const EVENT_PRIORITY_3 = 3;
+	const EVENT_PRIORITY_4 = 4;
+	const EVENT_PRIORITY_5 = 5;    // Priorité la plus basse
 
-    /**
-     * Utilisé pour construire le nom de la classe
-     */
-    private $pluginsTypeLabel = array(self::PLUGIN_ACTION => 'Action', self::PLUGIN_FILTER => 'Filter');
+	/**
+	 * Utilisé pour construire le nom de la classe
+	 */
+	private $pluginsTypeLabel = array(self::PLUGIN_ACTION => 'Action', self::PLUGIN_FILTER => 'Filter');
 
-    /**
-     * Nom des classes qu'il faut étendre en tant que plugin
-     */
-    private $pluginsClassName = array(self::PLUGIN_ACTION => 'references_action', self::PLUGIN_FILTER => 'references_filter');
+	/**
+	 * Nom des classes qu'il faut étendre en tant que plugin
+	 */
+	private $pluginsClassName = array(self::PLUGIN_ACTION => 'references_action', self::PLUGIN_FILTER => 'references_filter');
 
-    /**
-     * Nom de chacun des dossiers en fonction du type de plugin
-     */
-    private $pluginsTypesFolder = array(self::PLUGIN_ACTION => 'actions', self::PLUGIN_FILTER => 'filters');
+	/**
+	 * Nom de chacun des dossiers en fonction du type de plugin
+	 */
+	private $pluginsTypesFolder = array(self::PLUGIN_ACTION => 'actions', self::PLUGIN_FILTER => 'filters');
 
-    /**
-     * Contient l'unique instance de l'objet
-     * @var object
-     */
-    private static $instance = false;
+	/**
+	 * Contient l'unique instance de l'objet
+	 * @var object
+	 */
+	private static $instance = false;
 
-    /**
-     * Liste des évènements
-     * @var array
-     */
-    private static $events = array();
+	/**
+	 * Liste des évènements
+	 * @var array
+	 */
+	private static $events = array();
 
-    /**
-     * Retourne l'instance unique de la classe
-     *
-     * @return object
-     */
-    public static function getInstance()
-    {
-        static $instance;
-        if (null === $instance) {
-            $instance = new static();
-        }
+	/**
+	 * Retourne l'instance unique de la classe
+	 *
+	 * @return object
+	 */
+	public static function getInstance()
+	{
+		static $instance;
+		if (null === $instance) {
+			$instance = new static();
+		}
 
-        return $instance;
-    }
+		return $instance;
+	}
 
-    /**
-     * Chargement des 2 types de plugins
-     *
-     */
-    private function __construct()
-    {
-        $this->events = array();
-        $this->loadPlugins();
-    }
+	/**
+	 * Chargement des 2 types de plugins
+	 *
+	 */
+	private function __construct()
+	{
+		$this->events = array();
+		$this->loadPlugins();
+	}
 
-    /**
-     * Chargement des plugins (actions et filtres)
-     * @return void
-     */
-    public function loadPlugins()
-    {
-        $this->loadPluginsFiles(REFERENCES_PLUGINS_PATH . $this->pluginsTypesFolder[self::PLUGIN_ACTION], self::PLUGIN_ACTION);
-        $this->loadPluginsFiles(REFERENCES_PLUGINS_PATH . $this->pluginsTypesFolder[self::PLUGIN_FILTER], self::PLUGIN_FILTER);
-    }
+	/**
+	 * Chargement des plugins (actions et filtres)
+	 * @return void
+	 */
+	public function loadPlugins()
+	{
+		$this->loadPluginsFiles(REFERENCES_PLUGINS_PATH . $this->pluginsTypesFolder[self::PLUGIN_ACTION], self::PLUGIN_ACTION);
+		$this->loadPluginsFiles(REFERENCES_PLUGINS_PATH . $this->pluginsTypesFolder[self::PLUGIN_FILTER], self::PLUGIN_FILTER);
+	}
 
-    /**
-     * Vérifie que le fichier Php passé en paramètre contient bien une classe de filtre ou d'action et si c'est le cas, le charge dans la liste des plugins
-     * @param string  $fullPathName Chemin complet vers le fichier (répertoire + nom)
-     * @param integer $type         Type de plugin recherché (action ou filtre)
-     * @param string  $pluginFolder Le nom du répertoire dans lequel se trouve le fichier (le "dernier nom")
-     * @return void
-     */
-    private function loadClass($fullPathName, $type, $pluginFolder)
-    {
-        require_once $fullPathName;
-        // Du style referencesRegionalizationFilter
-        $className = self::MODULE_DIRNAME . ucfirst(strtolower($pluginFolder)) . $this->pluginsTypeLabel[$type];
-        if (class_exists($className) && get_parent_class($className) == $this->pluginsClassName[$type]) {
-            // TODO: Vérifier que l'évènement n'est pas déjà en mémoire
-            $events = call_user_func(array($className, self::PLUGIN_DESCRIBE_METHOD));
-            foreach ($events as $event) {
-                $eventName                                         = $event[0];
-                $eventPriority                                     = $event[1];
-                $fileToInclude                                     = REFERENCES_PLUGINS_PATH . $this->pluginsTypesFolder[$type] . DIRECTORY_SEPARATOR . $pluginFolder . DIRECTORY_SEPARATOR . $event[2];
-                $classToCall                                       = $event[3];
-                $methodToCall                                      = $event[4];
-                $this->events[$type][$eventName][$eventPriority][] = array('fullPathName' => $fileToInclude, 'className' => $classToCall, 'method' => $methodToCall);
-            }
-        }
-    }
+	/**
+	 * Vérifie que le fichier Php passé en paramètre contient bien une classe de filtre ou d'action et si c'est le cas, le charge dans la liste des plugins
+	 * @param string  $fullPathName Chemin complet vers le fichier (répertoire + nom)
+	 * @param integer $type         Type de plugin recherché (action ou filtre)
+	 * @param string  $pluginFolder Le nom du répertoire dans lequel se trouve le fichier (le "dernier nom")
+	 * @return void
+	 */
+	private function loadClass($fullPathName, $type, $pluginFolder)
+	{
+		require_once $fullPathName;
+		// Du style referencesRegionalizationFilter
+		$className = self::MODULE_DIRNAME . ucfirst(strtolower($pluginFolder)) . $this->pluginsTypeLabel[$type];
+		if (class_exists($className) && get_parent_class($className) == $this->pluginsClassName[$type]) {
+			// TODO: Vérifier que l'évènement n'est pas déjà en mémoire
+			$events = call_user_func(array($className, self::PLUGIN_DESCRIBE_METHOD));
+			foreach ($events as $event) {
+				$eventName                                         = $event[0];
+				$eventPriority                                     = $event[1];
+				$fileToInclude                                     = REFERENCES_PLUGINS_PATH . $this->pluginsTypesFolder[$type] . DIRECTORY_SEPARATOR . $pluginFolder . DIRECTORY_SEPARATOR . $event[2];
+				$classToCall                                       = $event[3];
+				$methodToCall                                      = $event[4];
+				$this->events[$type][$eventName][$eventPriority][] = array('fullPathName' => $fileToInclude, 'className' => $classToCall, 'method' => $methodToCall);
+			}
+		}
+	}
 
-    /**
-     * Part à la recherche d'un type de plugin dans les répertoires
-     *
-     * @param  string $path La racine
-     * @param integer $type Le type de plugin recherché (action ou filtre)
-     * @return void
-     */
-    private function loadPluginsFiles($path, $type)
-    {
-        $objects = new DirectoryIterator($path);
-        foreach ($objects as $object) {
-            if ($object->isDir() && !$object->isDot()) {
-                $file = $path . DIRECTORY_SEPARATOR . $object->current() . DIRECTORY_SEPARATOR . self::PLUGIN_SCRIPT_NAME;
-                if (file_exists($file)) {
-                    $this->loadClass($file, $type, $object->current());
-                }
-            }
-        }
-    }
+	/**
+	 * Part à la recherche d'un type de plugin dans les répertoires
+	 *
+	 * @param  string $path La racine
+	 * @param integer $type Le type de plugin recherché (action ou filtre)
+	 * @return void
+	 */
+	private function loadPluginsFiles($path, $type)
+	{
+		$objects = new DirectoryIterator($path);
+		foreach ($objects as $object) {
+			if ($object->isDir() && !$object->isDot()) {
+				$file = $path . DIRECTORY_SEPARATOR . $object->current() . DIRECTORY_SEPARATOR . self::PLUGIN_SCRIPT_NAME;
+				if (file_exists($file)) {
+					$this->loadClass($file, $type, $object->current());
+				}
+			}
+		}
+	}
 
-    /**
-     * Déclenchement d'une action et appel des plugins liés
-     *
-     * @param string                       $eventToFire L'action déclenchée
-     * @param object|references_parameters $parameters  Les paramètres à passer à chaque plugin
-     * @return object L'objet lui même pour chaîner
-     */
-    public function fireAction($eventToFire, references_parameters $parameters = null)
-    {
-        if (!isset($this->events[self::PLUGIN_ACTION][$eventToFire])) {
-            trigger_error(sprintf(_MD_REFERENCES_PLUGINS_ERROR_1, $eventToFire));
+	/**
+	 * Déclenchement d'une action et appel des plugins liés
+	 *
+	 * @param string                       $eventToFire L'action déclenchée
+	 * @param object|references_parameters $parameters  Les paramètres à passer à chaque plugin
+	 * @return object L'objet lui même pour chaîner
+	 */
+	public function fireAction($eventToFire, references_parameters $parameters = null)
+	{
+		if (!isset($this->events[self::PLUGIN_ACTION][$eventToFire])) {
+			trigger_error(sprintf(_MD_REFERENCES_PLUGINS_ERROR_1, $eventToFire));
 
-            return $this;
-        }
-        ksort($this->events[self::PLUGIN_ACTION][$eventToFire]);    // Tri par priorit�
-        foreach ($this->events[self::PLUGIN_ACTION][$eventToFire] as $priority => $events) {
-            foreach ($events as $event) {
-                if ($this->isUnplug(self::PLUGIN_ACTION, $eventToFire, $event['fullPathName'], $event['className'], $event['method'])) {
-                    continue;
-                }
-                require_once $event['fullPathName'];
-                if (!class_exists($event['className'])) {
-                    $class = new $event['className'];
-                }
-                if (!method_exists($event['className'], $event['method'])) {
-                    continue;
-                }
-                call_user_func(array($event['className'], $event['method']), $parameters);
-                unset($class);
-            }
-        }
+			return $this;
+		}
+		ksort($this->events[self::PLUGIN_ACTION][$eventToFire]);    // Tri par priorit�
+		foreach ($this->events[self::PLUGIN_ACTION][$eventToFire] as $priority => $events) {
+			foreach ($events as $event) {
+				if ($this->isUnplug(self::PLUGIN_ACTION, $eventToFire, $event['fullPathName'], $event['className'], $event['method'])) {
+					continue;
+				}
+				require_once $event['fullPathName'];
+				if (!class_exists($event['className'])) {
+					$class = new $event['className'];
+				}
+				if (!method_exists($event['className'], $event['method'])) {
+					continue;
+				}
+				call_user_func(array($event['className'], $event['method']), $parameters);
+				unset($class);
+			}
+		}
 
-        return $this;
-    }
+		return $this;
+	}
 
-    /**
-     * Déclenchement d'un filtre et appel des plugins liés
-     *
-     * @param string                       $eventToFire Le filtre appelé
-     * @param object|references_parameters $parameters  Les paramètres à passer à chaque plugin
-     * @return object Le contenu de l'objet passé en paramètre
-     */
-    public function fireFilter($eventToFire, references_parameters $parameters)
-    {
-        if (!isset($this->events[self::PLUGIN_FILTER][$eventToFire])) {
-            trigger_error(sprintf(_MD_REFERENCES_PLUGINS_ERROR_1, $eventToFire));
+	/**
+	 * Déclenchement d'un filtre et appel des plugins liés
+	 *
+	 * @param string                       $eventToFire Le filtre appelé
+	 * @param object|references_parameters $parameters  Les paramètres à passer à chaque plugin
+	 * @return object Le contenu de l'objet passé en paramètre
+	 */
+	public function fireFilter($eventToFire, references_parameters $parameters)
+	{
+		if (!isset($this->events[self::PLUGIN_FILTER][$eventToFire])) {
+			trigger_error(sprintf(_MD_REFERENCES_PLUGINS_ERROR_1, $eventToFire));
 
-            return $this;
-        }
-        ksort($this->events[self::PLUGIN_FILTER][$eventToFire]);    // Tri par priorité
-        foreach ($this->events[self::PLUGIN_FILTER][$eventToFire] as $priority => $events) {
-            foreach ($events as $event) {
-                if ($this->isUnplug(self::PLUGIN_FILTER, $eventToFire, $event['fullPathName'], $event['className'], $event['method'])) {
-                    continue;
-                }
-                require_once $event['fullPathName'];
-                if (!method_exists($event['className'], $event['method'])) {
-                    continue;
-                }
-                //if (!class_exists($event['className'])) {
-                $class = new $event['className'];
-                //}
-                $class->$event['method']($parameters);
-                //call_user_func(array($event['className'], $event['method']), $parameters);
-                unset($class);
-            }
-        }
+			return $this;
+		}
+		ksort($this->events[self::PLUGIN_FILTER][$eventToFire]);    // Tri par priorité
+		foreach ($this->events[self::PLUGIN_FILTER][$eventToFire] as $priority => $events) {
+			foreach ($events as $event) {
+				if ($this->isUnplug(self::PLUGIN_FILTER, $eventToFire, $event['fullPathName'], $event['className'], $event['method'])) {
+					continue;
+				}
+				require_once $event['fullPathName'];
+				if (!method_exists($event['className'], $event['method'])) {
+					continue;
+				}
+				//if (!class_exists($event['className'])) {
+				$class = new $event['className'];
+				//}
+				$class->$event['method']($parameters);
+				//call_user_func(array($event['className'], $event['method']), $parameters);
+				unset($class);
+			}
+		}
 
-        if (!is_null($parameters)) {
-            return $parameters;
-        }
-    }
+		if (!is_null($parameters)) {
+			return $parameters;
+		}
+	}
 
-    /**
-     * Indique si un plugin s'est détaché d'un évènement particulier
-     *
-     * @param  integer $eventType
-     * @param  string  $eventToFire
-     * @param  string  $fullPathName
-     * @param  string  $className
-     * @param  string  $method
-     * @return boolean
-     */
-    public function isUnplug($eventType, $eventToFire, $fullPathName, $className, $method)
-    {
-        $unplug = array();
-        if (isset($_SESSION[self::PLUGIN_UNPLUG_SESSION_NAME])) {
-            $unplug = $_SESSION[self::PLUGIN_UNPLUG_SESSION_NAME];
-        } else {
-            return false;
-        }
+	/**
+	 * Indique si un plugin s'est détaché d'un évènement particulier
+	 *
+	 * @param  integer $eventType
+	 * @param  string  $eventToFire
+	 * @param  string  $fullPathName
+	 * @param  string  $className
+	 * @param  string  $method
+	 * @return boolean
+	 */
+	public function isUnplug($eventType, $eventToFire, $fullPathName, $className, $method)
+	{
+		$unplug = array();
+		if (isset($_SESSION[self::PLUGIN_UNPLUG_SESSION_NAME])) {
+			$unplug = $_SESSION[self::PLUGIN_UNPLUG_SESSION_NAME];
+		} else {
+			return false;
+		}
 
-        return isset($unplug[$eventType][$eventToFire][$fullPathName][$className][$method]);
-    }
+		return isset($unplug[$eventType][$eventToFire][$fullPathName][$className][$method]);
+	}
 
-    /**
-     * Permet à un plugin de se détacher d'un évènement
-     *
-     * @param  integer $eventType
-     * @param  string  $eventToFire
-     * @param  string  $fullPathName
-     * @param  string  $className
-     * @param  string  $method
-     * @return void
-     */
-    public function unplugFromEvent($eventType, $eventToFire, $fullPathName, $className, $method)
-    {
-        $unplug = array();
-        if (isset($_SESSION[self::PLUGIN_UNPLUG_SESSION_NAME])) {
-            $unplug = $_SESSION[self::PLUGIN_UNPLUG_SESSION_NAME];
-        }
-        $unplug[$eventType][$eventToFire][$fullPathName][$className][$method] = true;
-        $_SESSION[self::PLUGIN_UNPLUG_SESSION_NAME]                           = $unplug;
-    }
+	/**
+	 * Permet à un plugin de se détacher d'un évènement
+	 *
+	 * @param  integer $eventType
+	 * @param  string  $eventToFire
+	 * @param  string  $fullPathName
+	 * @param  string  $className
+	 * @param  string  $method
+	 * @return void
+	 */
+	public function unplugFromEvent($eventType, $eventToFire, $fullPathName, $className, $method)
+	{
+		$unplug = array();
+		if (isset($_SESSION[self::PLUGIN_UNPLUG_SESSION_NAME])) {
+			$unplug = $_SESSION[self::PLUGIN_UNPLUG_SESSION_NAME];
+		}
+		$unplug[$eventType][$eventToFire][$fullPathName][$className][$method] = true;
+		$_SESSION[self::PLUGIN_UNPLUG_SESSION_NAME]                           = $unplug;
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -59,11 +59,11 @@ 
      * Priorités des plugins
      * @var constant
      */
-    const EVENT_PRIORITY_1 = 1;    // Priorité la plus haute
+    const EVENT_PRIORITY_1 = 1; // Priorité la plus haute
     const EVENT_PRIORITY_2 = 2;
     const EVENT_PRIORITY_3 = 3;
     const EVENT_PRIORITY_4 = 4;
-    const EVENT_PRIORITY_5 = 5;    // Priorité la plus basse
+    const EVENT_PRIORITY_5 = 5; // Priorité la plus basse
 
     /**
      * Utilisé pour construire le nom de la classe
@@ -123,8 +123,8 @@ 
      */
     public function loadPlugins()
     {
-        $this->loadPluginsFiles(REFERENCES_PLUGINS_PATH . $this->pluginsTypesFolder[self::PLUGIN_ACTION], self::PLUGIN_ACTION);
-        $this->loadPluginsFiles(REFERENCES_PLUGINS_PATH . $this->pluginsTypesFolder[self::PLUGIN_FILTER], self::PLUGIN_FILTER);
+        $this->loadPluginsFiles(REFERENCES_PLUGINS_PATH.$this->pluginsTypesFolder[self::PLUGIN_ACTION], self::PLUGIN_ACTION);
+        $this->loadPluginsFiles(REFERENCES_PLUGINS_PATH.$this->pluginsTypesFolder[self::PLUGIN_FILTER], self::PLUGIN_FILTER);
     }
 
     /**
@@ -138,14 +138,14 @@ 
     {
         require_once $fullPathName;
         // Du style referencesRegionalizationFilter
-        $className = self::MODULE_DIRNAME . ucfirst(strtolower($pluginFolder)) . $this->pluginsTypeLabel[$type];
+        $className = self::MODULE_DIRNAME.ucfirst(strtolower($pluginFolder)).$this->pluginsTypeLabel[$type];
         if (class_exists($className) && get_parent_class($className) == $this->pluginsClassName[$type]) {
             // TODO: Vérifier que l'évènement n'est pas déjà en mémoire
             $events = call_user_func(array($className, self::PLUGIN_DESCRIBE_METHOD));
             foreach ($events as $event) {
                 $eventName                                         = $event[0];
                 $eventPriority                                     = $event[1];
-                $fileToInclude                                     = REFERENCES_PLUGINS_PATH . $this->pluginsTypesFolder[$type] . DIRECTORY_SEPARATOR . $pluginFolder . DIRECTORY_SEPARATOR . $event[2];
+                $fileToInclude                                     = REFERENCES_PLUGINS_PATH.$this->pluginsTypesFolder[$type].DIRECTORY_SEPARATOR.$pluginFolder.DIRECTORY_SEPARATOR.$event[2];
                 $classToCall                                       = $event[3];
                 $methodToCall                                      = $event[4];
                 $this->events[$type][$eventName][$eventPriority][] = array('fullPathName' => $fileToInclude, 'className' => $classToCall, 'method' => $methodToCall);
@@ -165,7 +165,7 @@ 
         $objects = new DirectoryIterator($path);
         foreach ($objects as $object) {
             if ($object->isDir() && !$object->isDot()) {
-                $file = $path . DIRECTORY_SEPARATOR . $object->current() . DIRECTORY_SEPARATOR . self::PLUGIN_SCRIPT_NAME;
+                $file = $path.DIRECTORY_SEPARATOR.$object->current().DIRECTORY_SEPARATOR.self::PLUGIN_SCRIPT_NAME;
                 if (file_exists($file)) {
                     $this->loadClass($file, $type, $object->current());
                 }
@@ -187,7 +187,7 @@ 
 
             return $this;
         }
-        ksort($this->events[self::PLUGIN_ACTION][$eventToFire]);    // Tri par priorit�
+        ksort($this->events[self::PLUGIN_ACTION][$eventToFire]); // Tri par priorit�
         foreach ($this->events[self::PLUGIN_ACTION][$eventToFire] as $priority => $events) {
             foreach ($events as $event) {
                 if ($this->isUnplug(self::PLUGIN_ACTION, $eventToFire, $event['fullPathName'], $event['className'], $event['method'])) {
@@ -222,7 +222,7 @@ 
 
             return $this;
         }
-        ksort($this->events[self::PLUGIN_FILTER][$eventToFire]);    // Tri par priorité
+        ksort($this->events[self::PLUGIN_FILTER][$eventToFire]); // Tri par priorité
         foreach ($this->events[self::PLUGIN_FILTER][$eventToFire] as $priority => $events) {
             foreach ($events as $event) {
                 if ($this->isUnplug(self::PLUGIN_FILTER, $eventToFire, $event['fullPathName'], $event['className'], $event['method'])) {

class/registryfile.php

Doc Comments +1 added lines, -1 removed lines

@@ -26,7 +26,7 @@
     /**
      * Access the only instance of this class
      *
-     * @return object
+     * @return references_registryfile
      *
      * @static
      * @staticvar   object

Indentation +57 added lines, -57 removed lines

@@ -21,68 +21,68 @@
  */
 class references_registryfile
 {
-    public $filename;    // Nom du fichier � traiter
+	public $filename;    // Nom du fichier � traiter
 
-    /**
-     * Access the only instance of this class
-     *
-     * @return object
-     *
-     * @static
-     * @staticvar   object
-     */
-    public static function getInstance()
-    {
-        static $instance;
-        if (null === $instance) {
-            $instance = new static();
-        }
+	/**
+	 * Access the only instance of this class
+	 *
+	 * @return object
+	 *
+	 * @static
+	 * @staticvar   object
+	 */
+	public static function getInstance()
+	{
+		static $instance;
+		if (null === $instance) {
+			$instance = new static();
+		}
 
-        return $instance;
-    }
+		return $instance;
+	}
 
-    public function __construct($fichier = null)
-    {
-        $this->setfile($fichier);
-    }
+	public function __construct($fichier = null)
+	{
+		$this->setfile($fichier);
+	}
 
-    public function setfile($fichier = null)
-    {
-        if ($fichier) {
-            $this->filename = XOOPS_UPLOAD_PATH . DIRECTORY_SEPARATOR . $fichier;
-        }
-    }
+	public function setfile($fichier = null)
+	{
+		if ($fichier) {
+			$this->filename = XOOPS_UPLOAD_PATH . DIRECTORY_SEPARATOR . $fichier;
+		}
+	}
 
-    public function getfile($fichier = null)
-    {
-        $fw = '';
-        if (!$fichier) {
-            $fw = $this->filename;
-        } else {
-            $fw = XOOPS_UPLOAD_PATH . DIRECTORY_SEPARATOR . $fichier;
-        }
-        if (file_exists($fw)) {
-            return file_get_contents($fw);
-        } else {
-            return '';
-        }
-    }
+	public function getfile($fichier = null)
+	{
+		$fw = '';
+		if (!$fichier) {
+			$fw = $this->filename;
+		} else {
+			$fw = XOOPS_UPLOAD_PATH . DIRECTORY_SEPARATOR . $fichier;
+		}
+		if (file_exists($fw)) {
+			return file_get_contents($fw);
+		} else {
+			return '';
+		}
+	}
 
-    public function savefile($content, $fichier = null)
-    {
-        $fw = '';
-        if (!$fichier) {
-            $fw = $this->filename;
-        } else {
-            $fw = XOOPS_UPLOAD_PATH . DIRECTORY_SEPARATOR . $fichier;
-        }
-        if (file_exists($fw)) {
-            @unlink($fw);
-        }
-        $fp = fopen($fw, 'w') || exit('Error, impossible to create the file ' . $this->filename);
-        fwrite($fp, $content);
-        fclose($fp);
+	public function savefile($content, $fichier = null)
+	{
+		$fw = '';
+		if (!$fichier) {
+			$fw = $this->filename;
+		} else {
+			$fw = XOOPS_UPLOAD_PATH . DIRECTORY_SEPARATOR . $fichier;
+		}
+		if (file_exists($fw)) {
+			@unlink($fw);
+		}
+		$fp = fopen($fw, 'w') || exit('Error, impossible to create the file ' . $this->filename);
+		fwrite($fp, $content);
+		fclose($fp);
 
-        return true;
-    }
+		return true;
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -21,7 +21,7 @@ 
  */
 class references_registryfile
 {
-    public $filename;    // Nom du fichier � traiter
+    public $filename; // Nom du fichier � traiter
 
     /**
      * Access the only instance of this class
@@ -49,7 +49,7 @@ 
     public function setfile($fichier = null)
     {
         if ($fichier) {
-            $this->filename = XOOPS_UPLOAD_PATH . DIRECTORY_SEPARATOR . $fichier;
+            $this->filename = XOOPS_UPLOAD_PATH.DIRECTORY_SEPARATOR.$fichier;
         }
     }
 
@@ -59,7 +59,7 @@ 
         if (!$fichier) {
             $fw = $this->filename;
         } else {
-            $fw = XOOPS_UPLOAD_PATH . DIRECTORY_SEPARATOR . $fichier;
+            $fw = XOOPS_UPLOAD_PATH.DIRECTORY_SEPARATOR.$fichier;
         }
         if (file_exists($fw)) {
             return file_get_contents($fw);
@@ -74,12 +74,12 @@ 
         if (!$fichier) {
             $fw = $this->filename;
         } else {
-            $fw = XOOPS_UPLOAD_PATH . DIRECTORY_SEPARATOR . $fichier;
+            $fw = XOOPS_UPLOAD_PATH.DIRECTORY_SEPARATOR.$fichier;
         }
         if (file_exists($fw)) {
             @unlink($fw);
         }
-        $fp = fopen($fw, 'w') || exit('Error, impossible to create the file ' . $this->filename);
+        $fp = fopen($fw, 'w') || exit('Error, impossible to create the file '.$this->filename);
         fwrite($fp, $content);
         fclose($fp);
 

plugins/actions/twitter/Twitter.class.php

Doc Comments +7 added lines

@@ -16,6 +16,10 @@ 
     private $debug = false;
     public  $error = false;
 
+    /**
+     * @param string $user
+     * @param string $pass
+     */
     function __construct($user, $pass, $debug = false)
     {
         // Store an auth key for the HTTP Authorization: header
@@ -23,6 +27,9 @@ 
         $this->debug = $debug;
     }
 
+    /**
+     * @param string $new_status
+     */
     function update($new_status)
     {
         if (strlen($new_status) > 140) {

Indentation +58 added lines, -58 removed lines

@@ -6,70 +6,70 @@
  */
 
 if (class_exists('Twitter')) {
-    return true;
+	return true;
 }
 
 class Twitter
 {
 
-    private $auth  = false;
-    private $debug = false;
-    public  $error = false;
+	private $auth  = false;
+	private $debug = false;
+	public  $error = false;
 
-    function __construct($user, $pass, $debug = false)
-    {
-        // Store an auth key for the HTTP Authorization: header
-        $this->auth  = base64_encode($user . ':' . $pass);
-        $this->debug = $debug;
-    }
+	function __construct($user, $pass, $debug = false)
+	{
+		// Store an auth key for the HTTP Authorization: header
+		$this->auth  = base64_encode($user . ':' . $pass);
+		$this->debug = $debug;
+	}
 
-    function update($new_status)
-    {
-        if (strlen($new_status) > 140) {
-            $this->error = "Status too long: {$new_status}.";
-            return false;
-        }
-        $fp = @fsockopen('twitter.com', 80, $errno, $errstr);
-        if (!$fp) {
-            $this->error = "Socket error #{$errno}: {$errstr}";
-            return false;
-        }
-        $post_data = 'status=' . urlencode($new_status);
-        $to_send   = "POST /statuses/update.xml HTTP/1.1\r\n";
-        $to_send .= "Host: twitter.com\r\n";
-        $to_send .= 'Content-Length: ' . strlen($post_data) . "\r\n";
-        $to_send .= "Authorization: Basic {$this->auth}\r\n\r\n";
-        $to_send .= $post_data . "\r\n\r\n";
-        $bytes = fwrite($fp, $to_send);
-        if ($bytes === false) {
-            $this->error = 'Socket error: Error sending data.';
-            return false;
-        } elseif ($bytes < strlen($to_send)) {
-            $this->error = 'Socket error: Could not send all data.';
-            return false;
-        }
-        if ($this->debug) echo "Sent:\n{$to_send}\n\n";
-        $response = '';
-        while (!feof($fp)) {
-            $buf = fread($fp, 1024);
-            if ($buf === false) {
-                $this->error = 'Socket error: Error reading data.';
-                return false;
-            }
-            $response .= $buf;
-        }
-        if ($this->debug) echo "Received:\n{$response}";
-        $was_error = preg_match('#' . preg_quote('<error>') . '(.+)' . preg_quote('</error>') . '#i', $response, $matches);
-        if ($was_error) {
-            $this->error = "Twitter error: {$matches[1]}";
-            return false;
-        }
-        list($first_line) = explode("\r\n", $response);
-        if ($first_line !== 'HTTP/1.1 200 OK') {
-            $this->error = "Request error: {$first_line}";
-            return false;
-        }
-        return true;
-    }
+	function update($new_status)
+	{
+		if (strlen($new_status) > 140) {
+			$this->error = "Status too long: {$new_status}.";
+			return false;
+		}
+		$fp = @fsockopen('twitter.com', 80, $errno, $errstr);
+		if (!$fp) {
+			$this->error = "Socket error #{$errno}: {$errstr}";
+			return false;
+		}
+		$post_data = 'status=' . urlencode($new_status);
+		$to_send   = "POST /statuses/update.xml HTTP/1.1\r\n";
+		$to_send .= "Host: twitter.com\r\n";
+		$to_send .= 'Content-Length: ' . strlen($post_data) . "\r\n";
+		$to_send .= "Authorization: Basic {$this->auth}\r\n\r\n";
+		$to_send .= $post_data . "\r\n\r\n";
+		$bytes = fwrite($fp, $to_send);
+		if ($bytes === false) {
+			$this->error = 'Socket error: Error sending data.';
+			return false;
+		} elseif ($bytes < strlen($to_send)) {
+			$this->error = 'Socket error: Could not send all data.';
+			return false;
+		}
+		if ($this->debug) echo "Sent:\n{$to_send}\n\n";
+		$response = '';
+		while (!feof($fp)) {
+			$buf = fread($fp, 1024);
+			if ($buf === false) {
+				$this->error = 'Socket error: Error reading data.';
+				return false;
+			}
+			$response .= $buf;
+		}
+		if ($this->debug) echo "Received:\n{$response}";
+		$was_error = preg_match('#' . preg_quote('<error>') . '(.+)' . preg_quote('</error>') . '#i', $response, $matches);
+		if ($was_error) {
+			$this->error = "Twitter error: {$matches[1]}";
+			return false;
+		}
+		list($first_line) = explode("\r\n", $response);
+		if ($first_line !== 'HTTP/1.1 200 OK') {
+			$this->error = "Request error: {$first_line}";
+			return false;
+		}
+		return true;
+	}
 
 }

Spacing +5 added lines, -5 removed lines

@@ -19,7 +19,7 @@ 
     function __construct($user, $pass, $debug = false)
     {
         // Store an auth key for the HTTP Authorization: header
-        $this->auth  = base64_encode($user . ':' . $pass);
+        $this->auth  = base64_encode($user.':'.$pass);
         $this->debug = $debug;
     }
 
@@ -34,12 +34,12 @@ 
             $this->error = "Socket error #{$errno}: {$errstr}";
             return false;
         }
-        $post_data = 'status=' . urlencode($new_status);
+        $post_data = 'status='.urlencode($new_status);
         $to_send   = "POST /statuses/update.xml HTTP/1.1\r\n";
         $to_send .= "Host: twitter.com\r\n";
-        $to_send .= 'Content-Length: ' . strlen($post_data) . "\r\n";
+        $to_send .= 'Content-Length: '.strlen($post_data)."\r\n";
         $to_send .= "Authorization: Basic {$this->auth}\r\n\r\n";
-        $to_send .= $post_data . "\r\n\r\n";
+        $to_send .= $post_data."\r\n\r\n";
         $bytes = fwrite($fp, $to_send);
         if ($bytes === false) {
             $this->error = 'Socket error: Error sending data.';
@@ -59,7 +59,7 @@ 
             $response .= $buf;
         }
         if ($this->debug) echo "Received:\n{$response}";
-        $was_error = preg_match('#' . preg_quote('<error>') . '(.+)' . preg_quote('</error>') . '#i', $response, $matches);
+        $was_error = preg_match('#'.preg_quote('<error>').'(.+)'.preg_quote('</error>').'#i', $response, $matches);
         if ($was_error) {
             $this->error = "Twitter error: {$matches[1]}";
             return false;

Braces +6 added lines, -2 removed lines

@@ -48,7 +48,9 @@ 
             $this->error = 'Socket error: Could not send all data.';
             return false;
         }
-        if ($this->debug) echo "Sent:\n{$to_send}\n\n";
+        if ($this->debug) {
+        	echo "Sent:\n{$to_send}\n\n";
+        }
         $response = '';
         while (!feof($fp)) {
             $buf = fread($fp, 1024);
@@ -58,7 +60,9 @@ 
             }
             $response .= $buf;
         }
-        if ($this->debug) echo "Received:\n{$response}";
+        if ($this->debug) {
+        	echo "Received:\n{$response}";
+        }
         $was_error = preg_match('#' . preg_quote('<error>') . '(.+)' . preg_quote('</error>') . '#i', $response, $matches);
         if ($was_error) {
             $this->error = "Twitter error: {$matches[1]}";

language/english/modinfo.php

Spacing +1 added lines, -1 removed lines

@@ -90,7 +90,7 @@
 
 //Help
 define('_MI_REFERENCES_DIRNAME', basename(dirname(dirname(__DIR__))));
-define('_MI_REFERENCES_HELP_HEADER', __DIR__ . '/help/helpheader.html');
+define('_MI_REFERENCES_HELP_HEADER', __DIR__.'/help/helpheader.html');
 define('_MI_REFERENCES_BACK_2_ADMIN', 'Back to Administration of ');
 define('_MI_REFERENCES_HELP_OVERVIEW', 'Overview');