mambax7 / references

class/lite.php

Indentation +836 added lines, -836 removed lines

@@ -28,840 +28,840 @@
 class references_Cache_Lite
 {
 
-    // --- Private properties ---
-
-    /**
-     * Directory where to put the cache files
-     * (make sure to add a trailing slash)
-     *
-     * @var string $_cacheDir
-     */
-    public $_cacheDir = '/tmp/';
-
-    /**
-     * Enable / disable caching
-     *
-     * (can be very usefull for the debug of cached scripts)
-     *
-     * @var boolean $_caching
-     */
-    public $_caching = true;
-
-    /**
-     * Cache lifetime (in seconds)
-     *
-     * If null, the cache is valid forever.
-     *
-     * @var int $_lifeTime
-     */
-    public $_lifeTime = 3600;
-
-    /**
-     * Enable / disable fileLocking
-     *
-     * (can avoid cache corruption under bad circumstances)
-     *
-     * @var boolean $_fileLocking
-     */
-    public $_fileLocking = true;
-
-    /**
-     * Timestamp of the last valid cache
-     *
-     * @var int $_refreshTime
-     */
-    public $_refreshTime;
-
-    /**
-     * File name (with path)
-     *
-     * @var string $_file
-     */
-    public $_file;
-
-    /**
-     * File name (without path)
-     *
-     * @var string $_fileName
-     */
-    public $_fileName;
-
-    /**
-     * Enable / disable write control (the cache is read just after writing to detect corrupt entries)
-     *
-     * Enable write control will lightly slow the cache writing but not the cache reading
-     * Write control can detect some corrupt cache files but maybe it's not a perfect control
-     *
-     * @var boolean $_writeControl
-     */
-    public $_writeControl = true;
-
-    /**
-     * Enable / disable read control
-     *
-     * If enabled, a control key is embeded in cache file and this key is compared with the one
-     * calculated after the reading.
-     *
-     * @var boolean $_writeControl
-     */
-    public $_readControl = true;
-
-    /**
-     * Type of read control (only if read control is enabled)
-     *
-     * Available values are :
-     * 'md5' for a md5 hash control (best but slowest)
-     * 'crc32' for a crc32 hash control (lightly less safe but faster, better choice)
-     * 'strlen' for a length only test (fastest)
-     *
-     * @var boolean $_readControlType
-     */
-    public $_readControlType = 'crc32';
-
-    /**
-     * Pear error mode (when raiseError is called)
-     *
-     * (see PEAR doc)
-     *
-     * @see setToDebug()
-     * @var int $_pearErrorMode
-     */
-    public $_pearErrorMode = REFERENCES_CACHE_LITE_ERROR_RETURN;
-
-    /**
-     * Current cache id
-     *
-     * @var string $_id
-     */
-    public $_id;
-
-    /**
-     * Current cache group
-     *
-     * @var string $_group
-     */
-    public $_group;
-
-    /**
-     * Enable / Disable "Memory Caching"
-     *
-     * NB : There is no lifetime for memory caching !
-     *
-     * @var boolean $_memoryCaching
-     */
-    public $_memoryCaching = false;
-
-    /**
-     * Enable / Disable "Only Memory Caching"
-     * (be carefull, memory caching is "beta quality")
-     *
-     * @var boolean $_onlyMemoryCaching
-     */
-    public $_onlyMemoryCaching = false;
-
-    /**
-     * Memory caching array
-     *
-     * @var array $_memoryCachingArray
-     */
-    public $_memoryCachingArray = array();
-
-    /**
-     * Memory caching counter
-     *
-     * @var int $memoryCachingCounter
-     */
-    public $_memoryCachingCounter = 0;
-
-    /**
-     * Memory caching limit
-     *
-     * @var int $memoryCachingLimit
-     */
-    public $_memoryCachingLimit = 1000;
-
-    /**
-     * File Name protection
-     *
-     * if set to true, you can use any cache id or group name
-     * if set to false, it can be faster but cache ids and group names
-     * will be used directly in cache file names so be carefull with
-     * special characters...
-     *
-     * @var boolean $fileNameProtection
-     */
-    public $_fileNameProtection = true;
-
-    /**
-     * Enable / disable automatic serialization
-     *
-     * it can be used to save directly datas which aren't strings
-     * (but it's slower)
-     *
-     * @var boolean $_serialize
-     */
-    public $_automaticSerialization = false;
-
-    /**
-     * Disable / Tune the automatic cleaning process
-     *
-     * The automatic cleaning process destroy too old (for the given life time)
-     * cache files when a new cache file is written.
-     * 0               => no automatic cache cleaning
-     * 1               => systematic cache cleaning
-     * x (integer) > 1 => automatic cleaning randomly 1 times on x cache write
-     *
-     * @var int $_automaticCleaning
-     */
-    public $_automaticCleaningFactor = 0;
-
-    /**
-     * Nested directory level
-     *
-     * Set the hashed directory structure level. 0 means "no hashed directory
-     * structure", 1 means "one level of directory", 2 means "two levels"...
-     * This option can speed up Cache_Lite only when you have many thousands of
-     * cache file. Only specific benchs can help you to choose the perfect value
-     * for you. Maybe, 1 or 2 is a good start.
-     *
-     * @var int $_hashedDirectoryLevel
-     */
-    public $_hashedDirectoryLevel = 0;
-
-    /**
-     * Umask for hashed directory structure
-     *
-     * @var int $_hashedDirectoryUmask
-     */
-    public $_hashedDirectoryUmask = 0700;
-
-    /**
-     * API break for error handling in REFERENCES_CACHE_LITE_ERROR_RETURN mode
-     *
-     * In REFERENCES_CACHE_LITE_ERROR_RETURN mode, error handling was not good because
-     * for example save() method always returned a boolean (a PEAR_Error object
-     * would be better in REFERENCES_CACHE_LITE_ERROR_RETURN mode). To correct this without
-     * breaking the API, this option (false by default) can change this handling.
-     *
-     * @var boolean
-     */
-    public $_errorHandlingAPIBreak = false;
-
-    // --- Public methods ---
-
-    /**
-     * Constructor
-     *
-     * $options is an assoc. Available options are :
-     * $options = array(
-     *     'cacheDir' => directory where to put the cache files (string) ,
-     *     'caching' => enable / disable caching (boolean) ,
-     *     'lifeTime' => cache lifetime in seconds (int) ,
-     *     'fileLocking' => enable / disable fileLocking (boolean) ,
-     *     'writeControl' => enable / disable write control (boolean) ,
-     *     'readControl' => enable / disable read control (boolean) ,
-     *     'readControlType' => type of read control 'crc32', 'md5', 'strlen' (string) ,
-     *     'pearErrorMode' => pear error mode (when raiseError is called) (cf PEAR doc) (int) ,
-     *     'memoryCaching' => enable / disable memory caching (boolean) ,
-     *     'onlyMemoryCaching' => enable / disable only memory caching (boolean) ,
-     *     'memoryCachingLimit' => max nbr of records to store into memory caching (int) ,
-     *     'fileNameProtection' => enable / disable automatic file name protection (boolean) ,
-     *     'automaticSerialization' => enable / disable automatic serialization (boolean) ,
-     *     'automaticCleaningFactor' => distable / tune automatic cleaning process (int) ,
-     *     'hashedDirectoryLevel' => level of the hashed directory system (int) ,
-     *     'hashedDirectoryUmask' => umask for hashed directory structure (int) ,
-     *     'errorHandlingAPIBreak' => API break for better error handling ? (boolean)
-     * );
-     *
-     * @param array $options options
-     * @access public
-     */
-    public function __construct($options = array(null))
-    {
-        foreach ($options as $key => $value) {
-            $this->setOption($key, $value);
-        }
-    }
-
-    /**
-     * Generic way to set a Cache_Lite option
-     *
-     * see Cache_Lite constructor for available options
-     *
-     * @var string $name  name of the option
-     * @var mixed  $value value of the option
-     * @access public
-     */
-    public function setOption($name, $value)
-    {
-        $availableOptions = array(
-            'errorHandlingAPIBreak',
-            'hashedDirectoryUmask',
-            'hashedDirectoryLevel',
-            'automaticCleaningFactor',
-            'automaticSerialization',
-            'fileNameProtection',
-            'memoryCaching',
-            'onlyMemoryCaching',
-            'memoryCachingLimit',
-            'cacheDir',
-            'caching',
-            'lifeTime',
-            'fileLocking',
-            'writeControl',
-            'readControl',
-            'readControlType',
-            'pearErrorMode'
-        );
-        if (in_array($name, $availableOptions)) {
-            $property        = '_' . $name;
-            $this->$property = $value;
-        }
-    }
-
-    /**
-     * Test if a cache is available and (if yes) return it
-     *
-     * @param string  $id                     cache id
-     * @param string  $group                  name of the cache group
-     * @param boolean $doNotTestCacheValidity if set to true, the cache validity won't be tested
-     * @return string data of the cache (else : false)
-     * @access public
-     */
-    public function get($id, $group = 'default', $doNotTestCacheValidity = false)
-    {
-        $this->_id    = $id;
-        $this->_group = $group;
-        $data         = false;
-        if ($this->_caching) {
-            $this->_setRefreshTime();
-            $this->_setFileName($id, $group);
-            clearstatcache();
-            if ($this->_memoryCaching) {
-                if (isset($this->_memoryCachingArray[$this->_file])) {
-                    if ($this->_automaticSerialization) {
-                        return unserialize($this->_memoryCachingArray[$this->_file]);
-                    }
-
-                    return $this->_memoryCachingArray[$this->_file];
-                }
-                if ($this->_onlyMemoryCaching) {
-                    return false;
-                }
-            }
-            if ($doNotTestCacheValidity || is_null($this->_refreshTime)) {
-                if (file_exists($this->_file)) {
-                    $data = $this->_read();
-                }
-            } else {
-                if (file_exists($this->_file) && (@filemtime($this->_file) > $this->_refreshTime)) {
-                    $data = $this->_read();
-                }
-            }
-            if ($data && $this->_memoryCaching) {
-                $this->_memoryCacheAdd($data);
-            }
-            if ($this->_automaticSerialization && is_string($data)) {
-                $data = unserialize($data);
-            }
-
-            return $data;
-        }
-
-        return false;
-    }
-
-    /**
-     * Save some data in a cache file
-     *
-     * @param string $data  data to put in cache (can be another type than strings if automaticSerialization is on)
-     * @param string $id    cache id
-     * @param string $group name of the cache group
-     * @return boolean true if no problem (else : false or a PEAR_Error object)
-     * @access public
-     */
-    public function save($data, $id = null, $group = 'default')
-    {
-        if ($this->_caching) {
-            if ($this->_automaticSerialization) {
-                $data = serialize($data);
-            }
-            if (isset($id)) {
-                $this->_setFileName($id, $group);
-            }
-            if ($this->_memoryCaching) {
-                $this->_memoryCacheAdd($data);
-                if ($this->_onlyMemoryCaching) {
-                    return true;
-                }
-            }
-            if ($this->_automaticCleaningFactor > 0 && ($this->_automaticCleaningFactor == 1 || mt_rand(1, $this->_automaticCleaningFactor) == 1)) {
-                $this->clean(false, 'old');
-            }
-            if ($this->_writeControl) {
-                $res = $this->_writeAndControl($data);
-                if (is_bool($res)) {
-                    if ($res) {
-                        return true;
-                    }
-                    // if $res if false, we need to invalidate the cache
-                    @touch($this->_file, time() - 2 * abs($this->_lifeTime));
-
-                    return false;
-                }
-            } else {
-                $res = $this->_write($data);
-            }
-            if (is_object($res)) {
-                // $res is a PEAR_Error object
-                if (!$this->_errorHandlingAPIBreak) {
-                    return false; // we return false (old API)
-                }
-            }
-
-            return $res;
-        }
-
-        return false;
-    }
-
-    /**
-     * Remove a cache file
-     *
-     * @param string  $id                cache id
-     * @param string  $group             name of the cache group
-     * @param boolean $checkbeforeunlink check if file exists before removing it
-     * @return boolean true if no problem
-     * @access public
-     */
-    public function remove($id, $group = 'default', $checkbeforeunlink = false)
-    {
-        $this->_setFileName($id, $group);
-        if ($this->_memoryCaching) {
-            if (isset($this->_memoryCachingArray[$this->_file])) {
-                unset($this->_memoryCachingArray[$this->_file]);
-                --$this->_memoryCachingCounter;
-            }
-            if ($this->_onlyMemoryCaching) {
-                return true;
-            }
-        }
-        if ($checkbeforeunlink) {
-            if (!file_exists($this->_file)) {
-                return true;
-            }
-        }
-
-        return $this->_unlink($this->_file);
-    }
-
-    /**
-     * Clean the cache
-     *
-     * if no group is specified all cache files will be destroyed
-     * else only cache files of the specified group will be destroyed
-     *
-     * @param bool|string $group              name of the cache group
-     * @param string      $mode               flush cache mode : 'old', 'ingroup', 'notingroup',
-     *                                        'callback_myFunction'
-     * @return bool true if no problem
-     * @access public
-     */
-    public function clean($group = false, $mode = 'ingroup')
-    {
-        return $this->_cleanDir($this->_cacheDir, $group, $mode);
-    }
-
-    /**
-     * Set to debug mode
-     *
-     * When an error is found, the script will stop and the message will be displayed
-     * (in debug mode only).
-     *
-     * @access public
-     */
-    public function setToDebug()
-    {
-        $this->setOption('pearErrorMode', REFERENCES_CACHE_LITE_ERROR_DIE);
-    }
-
-    /**
-     * Set a new life time
-     *
-     * @param int $newLifeTime new life time (in seconds)
-     * @access public
-     */
-    public function setLifeTime($newLifeTime)
-    {
-        $this->_lifeTime = $newLifeTime;
-        $this->_setRefreshTime();
-    }
-
-    /**
-     * Save the state of the caching memory array into a cache file cache
-     *
-     * @param string $id    cache id
-     * @param string $group name of the cache group
-     * @access public
-     */
-    public function saveMemoryCachingState($id, $group = 'default')
-    {
-        if ($this->_caching) {
-            $array = array(
-                'counter' => $this->_memoryCachingCounter,
-                'array'   => $this->_memoryCachingArray
-            );
-            $data  = serialize($array);
-            $this->save($data, $id, $group);
-        }
-    }
-
-    /**
-     * Load the state of the caching memory array from a given cache file cache
-     *
-     * @param string  $id                     cache id
-     * @param string  $group                  name of the cache group
-     * @param boolean $doNotTestCacheValidity if set to true, the cache validity won't be tested
-     * @access public
-     */
-    public function getMemoryCachingState($id, $group = 'default', $doNotTestCacheValidity = false)
-    {
-        if ($this->_caching) {
-            if ($data = $this->get($id, $group, $doNotTestCacheValidity)) {
-                $array                       = unserialize($data);
-                $this->_memoryCachingCounter = $array['counter'];
-                $this->_memoryCachingArray   = $array['array'];
-            }
-        }
-    }
-
-    /**
-     * Return the cache last modification time
-     *
-     * BE CAREFUL : THIS METHOD IS FOR HACKING ONLY !
-     *
-     * @return int last modification time
-     */
-    public function lastModified()
-    {
-        return @filemtime($this->_file);
-    }
-
-    /**
-     * Trigger a PEAR error
-     *
-     * To improve performances, the PEAR.php file is included dynamically.
-     * The file is so included only when an error is triggered. So, in most
-     * cases, the file isn't included and perfs are much better.
-     *
-     * @param string $msg  error message
-     * @param int    $code error code
-     * @access public
-     * @return object
-     */
-    public function raiseError($msg, $code)
-    {
-        include_once('PEAR.php');
-
-        return references_PEAR::raiseError($msg, $code, $this->_pearErrorMode);
-    }
-
-    /**
-     * Extend the life of a valid cache file
-     *
-     * see http://pear.php.net/bugs/bug.php?id=6681
-     *
-     * @access public
-     */
-    public function extendLife()
-    {
-        @touch($this->_file);
-    }
-
-    // --- Private methods ---
-
-    /**
-     * Compute & set the refresh time
-     *
-     * @access private
-     */
-    public function _setRefreshTime()
-    {
-        if (is_null($this->_lifeTime)) {
-            $this->_refreshTime = null;
-        } else {
-            $this->_refreshTime = time() - $this->_lifeTime;
-        }
-    }
-
-    /**
-     * Remove a file
-     *
-     * @param string $file complete file path and name
-     * @return boolean true if no problem
-     * @access private
-     */
-    public function _unlink($file)
-    {
-        if (!@unlink($file)) {
-            return $this->raiseError('Cache_Lite : Unable to remove cache !', -3);
-        }
-
-        return true;
-    }
-
-    /**
-     * Recursive function for cleaning cache file in the given directory
-     *
-     * @param string      $dir   directory complete path (with a trailing slash)
-     * @param bool|string $group name of the cache group
-     * @param string      $mode  flush cache mode : 'old', 'ingroup', 'notingroup',
-     *                           'callback_myFunction'
-     * @return bool true if no problem
-     * @access private
-     */
-    public function _cleanDir($dir, $group = false, $mode = 'ingroup')
-    {
-        if ($this->_fileNameProtection) {
-            $motif = $group ? 'cache_' . md5($group) . '_' : 'cache_';
-        } else {
-            $motif = $group ? 'cache_' . $group . '_' : 'cache_';
-        }
-        if ($this->_memoryCaching) {
-            foreach ($this->_memoryCachingArray as $key => $v) {
-                if (strpos($key, $motif) !== false) {
-                    unset($this->_memoryCachingArray[$key]);
-                    --$this->_memoryCachingCounter;
-                }
-            }
-            if ($this->_onlyMemoryCaching) {
-                return true;
-            }
-        }
-        if (!($dh = opendir($dir))) {
-            return $this->raiseError('Cache_Lite : Unable to open cache directory !', -4);
-        }
-        $result = true;
-        while ($file = readdir($dh)) {
-            if (($file !== '.') && ($file !== '..')) {
-                if (substr($file, 0, 6) === 'cache_') {
-                    $file2 = $dir . $file;
-                    if (is_file($file2)) {
-                        switch (substr($mode, 0, 9)) {
-                            case 'old':
-                                // files older than lifeTime get deleted from cache
-                                if (!is_null($this->_lifeTime)) {
-                                    if ((time() - @filemtime($file2)) > $this->_lifeTime) {
-                                        $result = ($result and $this->_unlink($file2));
-                                    }
-                                }
-                                break;
-                            case 'notingrou':
-                                if (strpos($file2, $motif) === false) {
-                                    $result = ($result and $this->_unlink($file2));
-                                }
-                                break;
-                            case 'callback_':
-                                $func = substr($mode, 9, strlen($mode) - 9);
-                                if ($func($file2, $group)) {
-                                    $result = ($result and $this->_unlink($file2));
-                                }
-                                break;
-                            case 'ingroup':
-                            default:
-                                if (strpos($file2, $motif) !== false) {
-                                    $result = ($result and $this->_unlink($file2));
-                                }
-                                break;
-                        }
-                    }
-                    if (is_dir($file2) and ($this->_hashedDirectoryLevel > 0)) {
-                        $result = ($result and $this->_cleanDir($file2 . '/', $group, $mode));
-                    }
-                }
-            }
-        }
-
-        return $result;
-    }
-
-    /**
-     * Add some date in the memory caching array
-     *
-     * @param string $data data to cache
-     * @access private
-     */
-    public function _memoryCacheAdd($data)
-    {
-        $this->_memoryCachingArray[$this->_file] = $data;
-        if ($this->_memoryCachingCounter >= $this->_memoryCachingLimit) {
-            list($key,) = each($this->_memoryCachingArray);
-            unset($this->_memoryCachingArray[$key]);
-        } else {
-            ++$this->_memoryCachingCounter;
-        }
-    }
-
-    /**
-     * Make a file name (with path)
-     *
-     * @param string $id    cache id
-     * @param string $group name of the group
-     * @access private
-     */
-    public function _setFileName($id, $group)
-    {
-        if ($this->_fileNameProtection) {
-            $suffix = 'cache_' . md5($group) . '_' . md5($id);
-        } else {
-            $suffix = 'cache_' . $group . '_' . $id;
-        }
-        $root = $this->_cacheDir;
-        if ($this->_hashedDirectoryLevel > 0) {
-            $hash = md5($suffix);
-            for ($i = 0; $i < $this->_hashedDirectoryLevel; ++$i) {
-                $root = $root . 'cache_' . substr($hash, 0, $i + 1) . '/';
-            }
-        }
-        $this->_fileName = $suffix;
-        $this->_file     = $root . $suffix;
-    }
-
-    /**
-     * Read the cache file and return the content
-     *
-     * @return string content of the cache file (else : false or a PEAR_Error object)
-     * @access private
-     */
-    public function _read()
-    {
-        $fp = @fopen($this->_file, 'rb');
-        if ($this->_fileLocking) {
-            @flock($fp, LOCK_SH);
-        }
-        if ($fp) {
-            clearstatcache();
-            $length = @filesize($this->_file);
-            //            $mqr = get_magic_quotes_runtime();
-            //            @set_magic_quotes_runtime(0);
-            if ($this->_readControl) {
-                $hashControl = @fread($fp, 32);
-                $length      = $length - 32;
-            }
-            if ($length) {
-                $data = @fread($fp, $length);
-            } else {
-                $data = '';
-            }
-            //            @set_magic_quotes_runtime($mqr);
-            if ($this->_fileLocking) {
-                @flock($fp, LOCK_UN);
-            }
-            @fclose($fp);
-            if ($this->_readControl) {
-                $hashData = $this->_hash($data, $this->_readControlType);
-                if ($hashData != $hashControl) {
-                    if (!is_null($this->_lifeTime)) {
-                        @touch($this->_file, time() - 2 * abs($this->_lifeTime));
-                    } else {
-                        @unlink($this->_file);
-                    }
-
-                    return false;
-                }
-            }
-
-            return $data;
-        }
-
-        return $this->raiseError('Cache_Lite : Unable to read cache !', -2);
-    }
-
-    /**
-     * Write the given data in the cache file
-     *
-     * @param string $data data to put in cache
-     * @return boolean true if ok (a PEAR_Error object else)
-     * @access private
-     */
-    public function _write($data)
-    {
-        if ($this->_hashedDirectoryLevel > 0) {
-            $hash = md5($this->_fileName);
-            $root = $this->_cacheDir;
-            for ($i = 0; $i < $this->_hashedDirectoryLevel; ++$i) {
-                $root = $root . 'cache_' . substr($hash, 0, $i + 1) . '/';
-                if (!(@is_dir($root))) {
-                    @mkdir($root, $this->_hashedDirectoryUmask);
-                }
-            }
-        }
-        $fp = @fopen($this->_file, 'wb');
-        if ($fp) {
-            if ($this->_fileLocking) {
-                @flock($fp, LOCK_EX);
-            }
-            if ($this->_readControl) {
-                @fwrite($fp, $this->_hash($data, $this->_readControlType), 32);
-            }
-            //            $mqr = get_magic_quotes_runtime();
-            //            @set_magic_quotes_runtime(0);
-            @fwrite($fp, $data);
-            //            @set_magic_quotes_runtime($mqr);
-            if ($this->_fileLocking) {
-                @flock($fp, LOCK_UN);
-            }
-            @fclose($fp);
-
-            return true;
-        }
-
-        return $this->raiseError('Cache_Lite : Unable to write cache file : ' . $this->_file, -1);
-    }
-
-    /**
-     * Write the given data in the cache file and control it just after to avoir corrupted cache entries
-     *
-     * @param string $data data to put in cache
-     * @return boolean true if the test is ok (else : false or a PEAR_Error object)
-     * @access private
-     */
-    public function _writeAndControl($data)
-    {
-        $result = $this->_write($data);
-        if (is_object($result)) {
-            return $result; # We return the PEAR_Error object
-        }
-        $dataRead = $this->_read();
-        if (is_object($dataRead)) {
-            return $dataRead; # We return the PEAR_Error object
-        }
-        if (is_bool($dataRead) && (!$dataRead)) {
-            return false;
-        }
-
-        return ($dataRead == $data);
-    }
-
-    /**
-     * Make a control key with the string containing datas
-     *
-     * @param string $data        data
-     * @param string $controlType type of control 'md5', 'crc32' or 'strlen'
-     * @return string control key
-     * @access private
-     */
-    public function _hash($data, $controlType)
-    {
-        switch ($controlType) {
-            case 'md5':
-                return md5($data);
-            case 'crc32':
-                return sprintf('% 32d', crc32($data));
-            case 'strlen':
-                return sprintf('% 32d', strlen($data));
-            default:
-                return $this->raiseError('Unknown controlType ! (available values are only \'md5\', \'crc32\', \'strlen\')', -5);
-        }
-    }
+	// --- Private properties ---
+
+	/**
+	 * Directory where to put the cache files
+	 * (make sure to add a trailing slash)
+	 *
+	 * @var string $_cacheDir
+	 */
+	public $_cacheDir = '/tmp/';
+
+	/**
+	 * Enable / disable caching
+	 *
+	 * (can be very usefull for the debug of cached scripts)
+	 *
+	 * @var boolean $_caching
+	 */
+	public $_caching = true;
+
+	/**
+	 * Cache lifetime (in seconds)
+	 *
+	 * If null, the cache is valid forever.
+	 *
+	 * @var int $_lifeTime
+	 */
+	public $_lifeTime = 3600;
+
+	/**
+	 * Enable / disable fileLocking
+	 *
+	 * (can avoid cache corruption under bad circumstances)
+	 *
+	 * @var boolean $_fileLocking
+	 */
+	public $_fileLocking = true;
+
+	/**
+	 * Timestamp of the last valid cache
+	 *
+	 * @var int $_refreshTime
+	 */
+	public $_refreshTime;
+
+	/**
+	 * File name (with path)
+	 *
+	 * @var string $_file
+	 */
+	public $_file;
+
+	/**
+	 * File name (without path)
+	 *
+	 * @var string $_fileName
+	 */
+	public $_fileName;
+
+	/**
+	 * Enable / disable write control (the cache is read just after writing to detect corrupt entries)
+	 *
+	 * Enable write control will lightly slow the cache writing but not the cache reading
+	 * Write control can detect some corrupt cache files but maybe it's not a perfect control
+	 *
+	 * @var boolean $_writeControl
+	 */
+	public $_writeControl = true;
+
+	/**
+	 * Enable / disable read control
+	 *
+	 * If enabled, a control key is embeded in cache file and this key is compared with the one
+	 * calculated after the reading.
+	 *
+	 * @var boolean $_writeControl
+	 */
+	public $_readControl = true;
+
+	/**
+	 * Type of read control (only if read control is enabled)
+	 *
+	 * Available values are :
+	 * 'md5' for a md5 hash control (best but slowest)
+	 * 'crc32' for a crc32 hash control (lightly less safe but faster, better choice)
+	 * 'strlen' for a length only test (fastest)
+	 *
+	 * @var boolean $_readControlType
+	 */
+	public $_readControlType = 'crc32';
+
+	/**
+	 * Pear error mode (when raiseError is called)
+	 *
+	 * (see PEAR doc)
+	 *
+	 * @see setToDebug()
+	 * @var int $_pearErrorMode
+	 */
+	public $_pearErrorMode = REFERENCES_CACHE_LITE_ERROR_RETURN;
+
+	/**
+	 * Current cache id
+	 *
+	 * @var string $_id
+	 */
+	public $_id;
+
+	/**
+	 * Current cache group
+	 *
+	 * @var string $_group
+	 */
+	public $_group;
+
+	/**
+	 * Enable / Disable "Memory Caching"
+	 *
+	 * NB : There is no lifetime for memory caching !
+	 *
+	 * @var boolean $_memoryCaching
+	 */
+	public $_memoryCaching = false;
+
+	/**
+	 * Enable / Disable "Only Memory Caching"
+	 * (be carefull, memory caching is "beta quality")
+	 *
+	 * @var boolean $_onlyMemoryCaching
+	 */
+	public $_onlyMemoryCaching = false;
+
+	/**
+	 * Memory caching array
+	 *
+	 * @var array $_memoryCachingArray
+	 */
+	public $_memoryCachingArray = array();
+
+	/**
+	 * Memory caching counter
+	 *
+	 * @var int $memoryCachingCounter
+	 */
+	public $_memoryCachingCounter = 0;
+
+	/**
+	 * Memory caching limit
+	 *
+	 * @var int $memoryCachingLimit
+	 */
+	public $_memoryCachingLimit = 1000;
+
+	/**
+	 * File Name protection
+	 *
+	 * if set to true, you can use any cache id or group name
+	 * if set to false, it can be faster but cache ids and group names
+	 * will be used directly in cache file names so be carefull with
+	 * special characters...
+	 *
+	 * @var boolean $fileNameProtection
+	 */
+	public $_fileNameProtection = true;
+
+	/**
+	 * Enable / disable automatic serialization
+	 *
+	 * it can be used to save directly datas which aren't strings
+	 * (but it's slower)
+	 *
+	 * @var boolean $_serialize
+	 */
+	public $_automaticSerialization = false;
+
+	/**
+	 * Disable / Tune the automatic cleaning process
+	 *
+	 * The automatic cleaning process destroy too old (for the given life time)
+	 * cache files when a new cache file is written.
+	 * 0               => no automatic cache cleaning
+	 * 1               => systematic cache cleaning
+	 * x (integer) > 1 => automatic cleaning randomly 1 times on x cache write
+	 *
+	 * @var int $_automaticCleaning
+	 */
+	public $_automaticCleaningFactor = 0;
+
+	/**
+	 * Nested directory level
+	 *
+	 * Set the hashed directory structure level. 0 means "no hashed directory
+	 * structure", 1 means "one level of directory", 2 means "two levels"...
+	 * This option can speed up Cache_Lite only when you have many thousands of
+	 * cache file. Only specific benchs can help you to choose the perfect value
+	 * for you. Maybe, 1 or 2 is a good start.
+	 *
+	 * @var int $_hashedDirectoryLevel
+	 */
+	public $_hashedDirectoryLevel = 0;
+
+	/**
+	 * Umask for hashed directory structure
+	 *
+	 * @var int $_hashedDirectoryUmask
+	 */
+	public $_hashedDirectoryUmask = 0700;
+
+	/**
+	 * API break for error handling in REFERENCES_CACHE_LITE_ERROR_RETURN mode
+	 *
+	 * In REFERENCES_CACHE_LITE_ERROR_RETURN mode, error handling was not good because
+	 * for example save() method always returned a boolean (a PEAR_Error object
+	 * would be better in REFERENCES_CACHE_LITE_ERROR_RETURN mode). To correct this without
+	 * breaking the API, this option (false by default) can change this handling.
+	 *
+	 * @var boolean
+	 */
+	public $_errorHandlingAPIBreak = false;
+
+	// --- Public methods ---
+
+	/**
+	 * Constructor
+	 *
+	 * $options is an assoc. Available options are :
+	 * $options = array(
+	 *     'cacheDir' => directory where to put the cache files (string) ,
+	 *     'caching' => enable / disable caching (boolean) ,
+	 *     'lifeTime' => cache lifetime in seconds (int) ,
+	 *     'fileLocking' => enable / disable fileLocking (boolean) ,
+	 *     'writeControl' => enable / disable write control (boolean) ,
+	 *     'readControl' => enable / disable read control (boolean) ,
+	 *     'readControlType' => type of read control 'crc32', 'md5', 'strlen' (string) ,
+	 *     'pearErrorMode' => pear error mode (when raiseError is called) (cf PEAR doc) (int) ,
+	 *     'memoryCaching' => enable / disable memory caching (boolean) ,
+	 *     'onlyMemoryCaching' => enable / disable only memory caching (boolean) ,
+	 *     'memoryCachingLimit' => max nbr of records to store into memory caching (int) ,
+	 *     'fileNameProtection' => enable / disable automatic file name protection (boolean) ,
+	 *     'automaticSerialization' => enable / disable automatic serialization (boolean) ,
+	 *     'automaticCleaningFactor' => distable / tune automatic cleaning process (int) ,
+	 *     'hashedDirectoryLevel' => level of the hashed directory system (int) ,
+	 *     'hashedDirectoryUmask' => umask for hashed directory structure (int) ,
+	 *     'errorHandlingAPIBreak' => API break for better error handling ? (boolean)
+	 * );
+	 *
+	 * @param array $options options
+	 * @access public
+	 */
+	public function __construct($options = array(null))
+	{
+		foreach ($options as $key => $value) {
+			$this->setOption($key, $value);
+		}
+	}
+
+	/**
+	 * Generic way to set a Cache_Lite option
+	 *
+	 * see Cache_Lite constructor for available options
+	 *
+	 * @var string $name  name of the option
+	 * @var mixed  $value value of the option
+	 * @access public
+	 */
+	public function setOption($name, $value)
+	{
+		$availableOptions = array(
+			'errorHandlingAPIBreak',
+			'hashedDirectoryUmask',
+			'hashedDirectoryLevel',
+			'automaticCleaningFactor',
+			'automaticSerialization',
+			'fileNameProtection',
+			'memoryCaching',
+			'onlyMemoryCaching',
+			'memoryCachingLimit',
+			'cacheDir',
+			'caching',
+			'lifeTime',
+			'fileLocking',
+			'writeControl',
+			'readControl',
+			'readControlType',
+			'pearErrorMode'
+		);
+		if (in_array($name, $availableOptions)) {
+			$property        = '_' . $name;
+			$this->$property = $value;
+		}
+	}
+
+	/**
+	 * Test if a cache is available and (if yes) return it
+	 *
+	 * @param string  $id                     cache id
+	 * @param string  $group                  name of the cache group
+	 * @param boolean $doNotTestCacheValidity if set to true, the cache validity won't be tested
+	 * @return string data of the cache (else : false)
+	 * @access public
+	 */
+	public function get($id, $group = 'default', $doNotTestCacheValidity = false)
+	{
+		$this->_id    = $id;
+		$this->_group = $group;
+		$data         = false;
+		if ($this->_caching) {
+			$this->_setRefreshTime();
+			$this->_setFileName($id, $group);
+			clearstatcache();
+			if ($this->_memoryCaching) {
+				if (isset($this->_memoryCachingArray[$this->_file])) {
+					if ($this->_automaticSerialization) {
+						return unserialize($this->_memoryCachingArray[$this->_file]);
+					}
+
+					return $this->_memoryCachingArray[$this->_file];
+				}
+				if ($this->_onlyMemoryCaching) {
+					return false;
+				}
+			}
+			if ($doNotTestCacheValidity || is_null($this->_refreshTime)) {
+				if (file_exists($this->_file)) {
+					$data = $this->_read();
+				}
+			} else {
+				if (file_exists($this->_file) && (@filemtime($this->_file) > $this->_refreshTime)) {
+					$data = $this->_read();
+				}
+			}
+			if ($data && $this->_memoryCaching) {
+				$this->_memoryCacheAdd($data);
+			}
+			if ($this->_automaticSerialization && is_string($data)) {
+				$data = unserialize($data);
+			}
+
+			return $data;
+		}
+
+		return false;
+	}
+
+	/**
+	 * Save some data in a cache file
+	 *
+	 * @param string $data  data to put in cache (can be another type than strings if automaticSerialization is on)
+	 * @param string $id    cache id
+	 * @param string $group name of the cache group
+	 * @return boolean true if no problem (else : false or a PEAR_Error object)
+	 * @access public
+	 */
+	public function save($data, $id = null, $group = 'default')
+	{
+		if ($this->_caching) {
+			if ($this->_automaticSerialization) {
+				$data = serialize($data);
+			}
+			if (isset($id)) {
+				$this->_setFileName($id, $group);
+			}
+			if ($this->_memoryCaching) {
+				$this->_memoryCacheAdd($data);
+				if ($this->_onlyMemoryCaching) {
+					return true;
+				}
+			}
+			if ($this->_automaticCleaningFactor > 0 && ($this->_automaticCleaningFactor == 1 || mt_rand(1, $this->_automaticCleaningFactor) == 1)) {
+				$this->clean(false, 'old');
+			}
+			if ($this->_writeControl) {
+				$res = $this->_writeAndControl($data);
+				if (is_bool($res)) {
+					if ($res) {
+						return true;
+					}
+					// if $res if false, we need to invalidate the cache
+					@touch($this->_file, time() - 2 * abs($this->_lifeTime));
+
+					return false;
+				}
+			} else {
+				$res = $this->_write($data);
+			}
+			if (is_object($res)) {
+				// $res is a PEAR_Error object
+				if (!$this->_errorHandlingAPIBreak) {
+					return false; // we return false (old API)
+				}
+			}
+
+			return $res;
+		}
+
+		return false;
+	}
+
+	/**
+	 * Remove a cache file
+	 *
+	 * @param string  $id                cache id
+	 * @param string  $group             name of the cache group
+	 * @param boolean $checkbeforeunlink check if file exists before removing it
+	 * @return boolean true if no problem
+	 * @access public
+	 */
+	public function remove($id, $group = 'default', $checkbeforeunlink = false)
+	{
+		$this->_setFileName($id, $group);
+		if ($this->_memoryCaching) {
+			if (isset($this->_memoryCachingArray[$this->_file])) {
+				unset($this->_memoryCachingArray[$this->_file]);
+				--$this->_memoryCachingCounter;
+			}
+			if ($this->_onlyMemoryCaching) {
+				return true;
+			}
+		}
+		if ($checkbeforeunlink) {
+			if (!file_exists($this->_file)) {
+				return true;
+			}
+		}
+
+		return $this->_unlink($this->_file);
+	}
+
+	/**
+	 * Clean the cache
+	 *
+	 * if no group is specified all cache files will be destroyed
+	 * else only cache files of the specified group will be destroyed
+	 *
+	 * @param bool|string $group              name of the cache group
+	 * @param string      $mode               flush cache mode : 'old', 'ingroup', 'notingroup',
+	 *                                        'callback_myFunction'
+	 * @return bool true if no problem
+	 * @access public
+	 */
+	public function clean($group = false, $mode = 'ingroup')
+	{
+		return $this->_cleanDir($this->_cacheDir, $group, $mode);
+	}
+
+	/**
+	 * Set to debug mode
+	 *
+	 * When an error is found, the script will stop and the message will be displayed
+	 * (in debug mode only).
+	 *
+	 * @access public
+	 */
+	public function setToDebug()
+	{
+		$this->setOption('pearErrorMode', REFERENCES_CACHE_LITE_ERROR_DIE);
+	}
+
+	/**
+	 * Set a new life time
+	 *
+	 * @param int $newLifeTime new life time (in seconds)
+	 * @access public
+	 */
+	public function setLifeTime($newLifeTime)
+	{
+		$this->_lifeTime = $newLifeTime;
+		$this->_setRefreshTime();
+	}
+
+	/**
+	 * Save the state of the caching memory array into a cache file cache
+	 *
+	 * @param string $id    cache id
+	 * @param string $group name of the cache group
+	 * @access public
+	 */
+	public function saveMemoryCachingState($id, $group = 'default')
+	{
+		if ($this->_caching) {
+			$array = array(
+				'counter' => $this->_memoryCachingCounter,
+				'array'   => $this->_memoryCachingArray
+			);
+			$data  = serialize($array);
+			$this->save($data, $id, $group);
+		}
+	}
+
+	/**
+	 * Load the state of the caching memory array from a given cache file cache
+	 *
+	 * @param string  $id                     cache id
+	 * @param string  $group                  name of the cache group
+	 * @param boolean $doNotTestCacheValidity if set to true, the cache validity won't be tested
+	 * @access public
+	 */
+	public function getMemoryCachingState($id, $group = 'default', $doNotTestCacheValidity = false)
+	{
+		if ($this->_caching) {
+			if ($data = $this->get($id, $group, $doNotTestCacheValidity)) {
+				$array                       = unserialize($data);
+				$this->_memoryCachingCounter = $array['counter'];
+				$this->_memoryCachingArray   = $array['array'];
+			}
+		}
+	}
+
+	/**
+	 * Return the cache last modification time
+	 *
+	 * BE CAREFUL : THIS METHOD IS FOR HACKING ONLY !
+	 *
+	 * @return int last modification time
+	 */
+	public function lastModified()
+	{
+		return @filemtime($this->_file);
+	}
+
+	/**
+	 * Trigger a PEAR error
+	 *
+	 * To improve performances, the PEAR.php file is included dynamically.
+	 * The file is so included only when an error is triggered. So, in most
+	 * cases, the file isn't included and perfs are much better.
+	 *
+	 * @param string $msg  error message
+	 * @param int    $code error code
+	 * @access public
+	 * @return object
+	 */
+	public function raiseError($msg, $code)
+	{
+		include_once('PEAR.php');
+
+		return references_PEAR::raiseError($msg, $code, $this->_pearErrorMode);
+	}
+
+	/**
+	 * Extend the life of a valid cache file
+	 *
+	 * see http://pear.php.net/bugs/bug.php?id=6681
+	 *
+	 * @access public
+	 */
+	public function extendLife()
+	{
+		@touch($this->_file);
+	}
+
+	// --- Private methods ---
+
+	/**
+	 * Compute & set the refresh time
+	 *
+	 * @access private
+	 */
+	public function _setRefreshTime()
+	{
+		if (is_null($this->_lifeTime)) {
+			$this->_refreshTime = null;
+		} else {
+			$this->_refreshTime = time() - $this->_lifeTime;
+		}
+	}
+
+	/**
+	 * Remove a file
+	 *
+	 * @param string $file complete file path and name
+	 * @return boolean true if no problem
+	 * @access private
+	 */
+	public function _unlink($file)
+	{
+		if (!@unlink($file)) {
+			return $this->raiseError('Cache_Lite : Unable to remove cache !', -3);
+		}
+
+		return true;
+	}
+
+	/**
+	 * Recursive function for cleaning cache file in the given directory
+	 *
+	 * @param string      $dir   directory complete path (with a trailing slash)
+	 * @param bool|string $group name of the cache group
+	 * @param string      $mode  flush cache mode : 'old', 'ingroup', 'notingroup',
+	 *                           'callback_myFunction'
+	 * @return bool true if no problem
+	 * @access private
+	 */
+	public function _cleanDir($dir, $group = false, $mode = 'ingroup')
+	{
+		if ($this->_fileNameProtection) {
+			$motif = $group ? 'cache_' . md5($group) . '_' : 'cache_';
+		} else {
+			$motif = $group ? 'cache_' . $group . '_' : 'cache_';
+		}
+		if ($this->_memoryCaching) {
+			foreach ($this->_memoryCachingArray as $key => $v) {
+				if (strpos($key, $motif) !== false) {
+					unset($this->_memoryCachingArray[$key]);
+					--$this->_memoryCachingCounter;
+				}
+			}
+			if ($this->_onlyMemoryCaching) {
+				return true;
+			}
+		}
+		if (!($dh = opendir($dir))) {
+			return $this->raiseError('Cache_Lite : Unable to open cache directory !', -4);
+		}
+		$result = true;
+		while ($file = readdir($dh)) {
+			if (($file !== '.') && ($file !== '..')) {
+				if (substr($file, 0, 6) === 'cache_') {
+					$file2 = $dir . $file;
+					if (is_file($file2)) {
+						switch (substr($mode, 0, 9)) {
+							case 'old':
+								// files older than lifeTime get deleted from cache
+								if (!is_null($this->_lifeTime)) {
+									if ((time() - @filemtime($file2)) > $this->_lifeTime) {
+										$result = ($result and $this->_unlink($file2));
+									}
+								}
+								break;
+							case 'notingrou':
+								if (strpos($file2, $motif) === false) {
+									$result = ($result and $this->_unlink($file2));
+								}
+								break;
+							case 'callback_':
+								$func = substr($mode, 9, strlen($mode) - 9);
+								if ($func($file2, $group)) {
+									$result = ($result and $this->_unlink($file2));
+								}
+								break;
+							case 'ingroup':
+							default:
+								if (strpos($file2, $motif) !== false) {
+									$result = ($result and $this->_unlink($file2));
+								}
+								break;
+						}
+					}
+					if (is_dir($file2) and ($this->_hashedDirectoryLevel > 0)) {
+						$result = ($result and $this->_cleanDir($file2 . '/', $group, $mode));
+					}
+				}
+			}
+		}
+
+		return $result;
+	}
+
+	/**
+	 * Add some date in the memory caching array
+	 *
+	 * @param string $data data to cache
+	 * @access private
+	 */
+	public function _memoryCacheAdd($data)
+	{
+		$this->_memoryCachingArray[$this->_file] = $data;
+		if ($this->_memoryCachingCounter >= $this->_memoryCachingLimit) {
+			list($key,) = each($this->_memoryCachingArray);
+			unset($this->_memoryCachingArray[$key]);
+		} else {
+			++$this->_memoryCachingCounter;
+		}
+	}
+
+	/**
+	 * Make a file name (with path)
+	 *
+	 * @param string $id    cache id
+	 * @param string $group name of the group
+	 * @access private
+	 */
+	public function _setFileName($id, $group)
+	{
+		if ($this->_fileNameProtection) {
+			$suffix = 'cache_' . md5($group) . '_' . md5($id);
+		} else {
+			$suffix = 'cache_' . $group . '_' . $id;
+		}
+		$root = $this->_cacheDir;
+		if ($this->_hashedDirectoryLevel > 0) {
+			$hash = md5($suffix);
+			for ($i = 0; $i < $this->_hashedDirectoryLevel; ++$i) {
+				$root = $root . 'cache_' . substr($hash, 0, $i + 1) . '/';
+			}
+		}
+		$this->_fileName = $suffix;
+		$this->_file     = $root . $suffix;
+	}
+
+	/**
+	 * Read the cache file and return the content
+	 *
+	 * @return string content of the cache file (else : false or a PEAR_Error object)
+	 * @access private
+	 */
+	public function _read()
+	{
+		$fp = @fopen($this->_file, 'rb');
+		if ($this->_fileLocking) {
+			@flock($fp, LOCK_SH);
+		}
+		if ($fp) {
+			clearstatcache();
+			$length = @filesize($this->_file);
+			//            $mqr = get_magic_quotes_runtime();
+			//            @set_magic_quotes_runtime(0);
+			if ($this->_readControl) {
+				$hashControl = @fread($fp, 32);
+				$length      = $length - 32;
+			}
+			if ($length) {
+				$data = @fread($fp, $length);
+			} else {
+				$data = '';
+			}
+			//            @set_magic_quotes_runtime($mqr);
+			if ($this->_fileLocking) {
+				@flock($fp, LOCK_UN);
+			}
+			@fclose($fp);
+			if ($this->_readControl) {
+				$hashData = $this->_hash($data, $this->_readControlType);
+				if ($hashData != $hashControl) {
+					if (!is_null($this->_lifeTime)) {
+						@touch($this->_file, time() - 2 * abs($this->_lifeTime));
+					} else {
+						@unlink($this->_file);
+					}
+
+					return false;
+				}
+			}
+
+			return $data;
+		}
+
+		return $this->raiseError('Cache_Lite : Unable to read cache !', -2);
+	}
+
+	/**
+	 * Write the given data in the cache file
+	 *
+	 * @param string $data data to put in cache
+	 * @return boolean true if ok (a PEAR_Error object else)
+	 * @access private
+	 */
+	public function _write($data)
+	{
+		if ($this->_hashedDirectoryLevel > 0) {
+			$hash = md5($this->_fileName);
+			$root = $this->_cacheDir;
+			for ($i = 0; $i < $this->_hashedDirectoryLevel; ++$i) {
+				$root = $root . 'cache_' . substr($hash, 0, $i + 1) . '/';
+				if (!(@is_dir($root))) {
+					@mkdir($root, $this->_hashedDirectoryUmask);
+				}
+			}
+		}
+		$fp = @fopen($this->_file, 'wb');
+		if ($fp) {
+			if ($this->_fileLocking) {
+				@flock($fp, LOCK_EX);
+			}
+			if ($this->_readControl) {
+				@fwrite($fp, $this->_hash($data, $this->_readControlType), 32);
+			}
+			//            $mqr = get_magic_quotes_runtime();
+			//            @set_magic_quotes_runtime(0);
+			@fwrite($fp, $data);
+			//            @set_magic_quotes_runtime($mqr);
+			if ($this->_fileLocking) {
+				@flock($fp, LOCK_UN);
+			}
+			@fclose($fp);
+
+			return true;
+		}
+
+		return $this->raiseError('Cache_Lite : Unable to write cache file : ' . $this->_file, -1);
+	}
+
+	/**
+	 * Write the given data in the cache file and control it just after to avoir corrupted cache entries
+	 *
+	 * @param string $data data to put in cache
+	 * @return boolean true if the test is ok (else : false or a PEAR_Error object)
+	 * @access private
+	 */
+	public function _writeAndControl($data)
+	{
+		$result = $this->_write($data);
+		if (is_object($result)) {
+			return $result; # We return the PEAR_Error object
+		}
+		$dataRead = $this->_read();
+		if (is_object($dataRead)) {
+			return $dataRead; # We return the PEAR_Error object
+		}
+		if (is_bool($dataRead) && (!$dataRead)) {
+			return false;
+		}
+
+		return ($dataRead == $data);
+	}
+
+	/**
+	 * Make a control key with the string containing datas
+	 *
+	 * @param string $data        data
+	 * @param string $controlType type of control 'md5', 'crc32' or 'strlen'
+	 * @return string control key
+	 * @access private
+	 */
+	public function _hash($data, $controlType)
+	{
+		switch ($controlType) {
+			case 'md5':
+				return md5($data);
+			case 'crc32':
+				return sprintf('% 32d', crc32($data));
+			case 'strlen':
+				return sprintf('% 32d', strlen($data));
+			default:
+				return $this->raiseError('Unknown controlType ! (available values are only \'md5\', \'crc32\', \'strlen\')', -5);
+		}
+	}
 }

Spacing +12 added lines, -12 removed lines

@@ -314,7 +314,7 @@ 
             'pearErrorMode'
         );
         if (in_array($name, $availableOptions)) {
-            $property        = '_' . $name;
+            $property        = '_'.$name;
             $this->$property = $value;
         }
     }
@@ -511,7 +511,7 @@ 
                 'counter' => $this->_memoryCachingCounter,
                 'array'   => $this->_memoryCachingArray
             );
-            $data  = serialize($array);
+            $data = serialize($array);
             $this->save($data, $id, $group);
         }
     }
@@ -623,9 +623,9 @@ 
     public function _cleanDir($dir, $group = false, $mode = 'ingroup')
     {
         if ($this->_fileNameProtection) {
-            $motif = $group ? 'cache_' . md5($group) . '_' : 'cache_';
+            $motif = $group ? 'cache_'.md5($group).'_' : 'cache_';
         } else {
-            $motif = $group ? 'cache_' . $group . '_' : 'cache_';
+            $motif = $group ? 'cache_'.$group.'_' : 'cache_';
         }
         if ($this->_memoryCaching) {
             foreach ($this->_memoryCachingArray as $key => $v) {
@@ -645,7 +645,7 @@ 
         while ($file = readdir($dh)) {
             if (($file !== '.') && ($file !== '..')) {
                 if (substr($file, 0, 6) === 'cache_') {
-                    $file2 = $dir . $file;
+                    $file2 = $dir.$file;
                     if (is_file($file2)) {
                         switch (substr($mode, 0, 9)) {
                             case 'old':
@@ -676,7 +676,7 @@ 
                         }
                     }
                     if (is_dir($file2) and ($this->_hashedDirectoryLevel > 0)) {
-                        $result = ($result and $this->_cleanDir($file2 . '/', $group, $mode));
+                        $result = ($result and $this->_cleanDir($file2.'/', $group, $mode));
                     }
                 }
             }
@@ -712,19 +712,19 @@ 
     public function _setFileName($id, $group)
     {
         if ($this->_fileNameProtection) {
-            $suffix = 'cache_' . md5($group) . '_' . md5($id);
+            $suffix = 'cache_'.md5($group).'_'.md5($id);
         } else {
-            $suffix = 'cache_' . $group . '_' . $id;
+            $suffix = 'cache_'.$group.'_'.$id;
         }
         $root = $this->_cacheDir;
         if ($this->_hashedDirectoryLevel > 0) {
             $hash = md5($suffix);
             for ($i = 0; $i < $this->_hashedDirectoryLevel; ++$i) {
-                $root = $root . 'cache_' . substr($hash, 0, $i + 1) . '/';
+                $root = $root.'cache_'.substr($hash, 0, $i + 1).'/';
             }
         }
         $this->_fileName = $suffix;
-        $this->_file     = $root . $suffix;
+        $this->_file     = $root.$suffix;
     }
 
     /**
@@ -790,7 +790,7 @@ 
             $hash = md5($this->_fileName);
             $root = $this->_cacheDir;
             for ($i = 0; $i < $this->_hashedDirectoryLevel; ++$i) {
-                $root = $root . 'cache_' . substr($hash, 0, $i + 1) . '/';
+                $root = $root.'cache_'.substr($hash, 0, $i + 1).'/';
                 if (!(@is_dir($root))) {
                     @mkdir($root, $this->_hashedDirectoryUmask);
                 }
@@ -816,7 +816,7 @@ 
             return true;
         }
 
-        return $this->raiseError('Cache_Lite : Unable to write cache file : ' . $this->_file, -1);
+        return $this->raiseError('Cache_Lite : Unable to write cache file : '.$this->_file, -1);
     }
 
     /**

class/references_handlers.php

Indentation +27 added lines, -27 removed lines

@@ -24,34 +24,34 @@
  */
 class references_handler
 {
-    public         $h_references_articles   = null;
-    public         $h_references_categories = null;
-    private static $instance                = false;
+	public         $h_references_articles   = null;
+	public         $h_references_categories = null;
+	private static $instance                = false;
 
-    /**
-     * Singleton
-     */
-    private function __construct()
-    {
-        $handlersNames = array('references_articles', 'references_categories');
-        foreach ($handlersNames as $handlerName) {
-            $internalName        = 'h_' . $handlerName;
-            $this->$internalName = xoops_getModuleHandler($handlerName, REFERENCES_DIRNAME);
-        }
-    }
+	/**
+	 * Singleton
+	 */
+	private function __construct()
+	{
+		$handlersNames = array('references_articles', 'references_categories');
+		foreach ($handlersNames as $handlerName) {
+			$internalName        = 'h_' . $handlerName;
+			$this->$internalName = xoops_getModuleHandler($handlerName, REFERENCES_DIRNAME);
+		}
+	}
 
-    /**
-     * Retourne l'instance unique de la clanss
-     *
-     * @return object
-     */
-    public static function getInstance()
-    {
-        static $instance;
-        if (null === $instance) {
-            $instance = new static();
-        }
+	/**
+	 * Retourne l'instance unique de la clanss
+	 *
+	 * @return object
+	 */
+	public static function getInstance()
+	{
+		static $instance;
+		if (null === $instance) {
+			$instance = new static();
+		}
 
-        return $instance;
-    }
+		return $instance;
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -35,7 +35,7 @@
     {
         $handlersNames = array('references_articles', 'references_categories');
         foreach ($handlersNames as $handlerName) {
-            $internalName        = 'h_' . $handlerName;
+            $internalName        = 'h_'.$handlerName;
             $this->$internalName = xoops_getModuleHandler($handlerName, REFERENCES_DIRNAME);
         }
     }

class/references_parameters.php

Indentation +52 added lines, -52 removed lines

@@ -30,62 +30,62 @@
  */
 class references_parameters extends ArrayObject
 {
-    /**
-     * Permet de valoriser un indice de la classe 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 object
-     */
-    public function __set($key, $value)
-    {
-        parent::offsetSet($key, $value);
+	/**
+	 * Permet de valoriser un indice de la classe 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 object
+	 */
+	public function __set($key, $value)
+	{
+		parent::offsetSet($key, $value);
 
-        return $this;
-    }
+		return $this;
+	}
 
-    /**
-     * Valorisation d'un indice de la classe en utilisant un appel de fonction basé sur le principe suivant :
-     *      $maClasse->setLimit(10);
-     * Il est possible de chainer comme ceci : $maClasse->setStart(0)->setLimit(10);
-     *
-     * @param  string $method
-     * @param  mixed  $args
-     * @return object
-     */
-    public function __call($method, $args)
-    {
-        if (substr($method, 0, 3) === 'set') {
-            parent::offsetSet(strtolower(substr($method, 3, 1)) . substr($method, 4), $args[0]);
+	/**
+	 * Valorisation d'un indice de la classe en utilisant un appel de fonction basé sur le principe suivant :
+	 *      $maClasse->setLimit(10);
+	 * Il est possible de chainer comme ceci : $maClasse->setStart(0)->setLimit(10);
+	 *
+	 * @param  string $method
+	 * @param  mixed  $args
+	 * @return object
+	 */
+	public function __call($method, $args)
+	{
+		if (substr($method, 0, 3) === 'set') {
+			parent::offsetSet(strtolower(substr($method, 3, 1)) . substr($method, 4), $args[0]);
 
-            return $this;
-        } else {    // Affichage de la valeur
+			return $this;
+		} else {    // Affichage de la valeur
 
-            return parent::offsetGet($method);
-        }
-    }
+			return parent::offsetGet($method);
+		}
+	}
 
-    /**
-     * Méthode qui essaye de faire la même chose que la méthode extend() de jQuery
-     *
-     * On lui passe les valeurs par défaut que l'on attend et la méthode les compare avec les valeurs actuelles
-     * Si des valeurs manquent, elles sont ajoutées
-     *
-     * @param  references_parameters $defaultValues
-     * @return references_parameters
-     */
-    public function extend(self $defaultValues)
-    {
-        $result = new self;
-        $result = $this;
-        foreach ($defaultValues as $key => $value) {
-            if (!isset($result[$key])) {
-                $result[$key] = $value;
-            }
-        }
+	/**
+	 * Méthode qui essaye de faire la même chose que la méthode extend() de jQuery
+	 *
+	 * On lui passe les valeurs par défaut que l'on attend et la méthode les compare avec les valeurs actuelles
+	 * Si des valeurs manquent, elles sont ajoutées
+	 *
+	 * @param  references_parameters $defaultValues
+	 * @return references_parameters
+	 */
+	public function extend(self $defaultValues)
+	{
+		$result = new self;
+		$result = $this;
+		foreach ($defaultValues as $key => $value) {
+			if (!isset($result[$key])) {
+				$result[$key] = $value;
+			}
+		}
 
-        return $result;
-    }
+		return $result;
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -58,7 +58,7 @@
     public function __call($method, $args)
     {
         if (substr($method, 0, 3) === 'set') {
-            parent::offsetSet(strtolower(substr($method, 3, 1)) . substr($method, 4), $args[0]);
+            parent::offsetSet(strtolower(substr($method, 3, 1)).substr($method, 4), $args[0]);
 
             return $this;
         } else {    // Affichage de la valeur

category.php

Indentation +16 added lines, -16 removed lines

@@ -34,21 +34,21 @@ 
 
 $category_id = isset($_GET['category_id']) ? (int)$_GET['category_id'] : 0;
 if ($category_id == 0) {
-    header('Location: index.php', true, 301);
-    exit;
-    //references_utils::redirect('', 'index.php', 0);
+	header('Location: index.php', true, 301);
+	exit;
+	//references_utils::redirect('', 'index.php', 0);
 }
 // Chargement de la catégorie
 $category = null;
 $category = $h_references_categories->get($category_id);
 if (!is_object($category)) {
-    references_utils::redirect(_MD_REFERENCES_ERROR2, 'index.php', 4);
+	references_utils::redirect(_MD_REFERENCES_ERROR2, 'index.php', 4);
 }
 
 // Vérification des permissions
 $handlers = references_handler::getInstance();
 if (!$handlers->h_references_categories->userCanSeeCategory($category)) {
-    references_utils::redirect(_NOPERM, 'index.php', 4);
+	references_utils::redirect(_NOPERM, 'index.php', 4);
 }
 
 $xoopsTpl->assign('category', $category->toArray());
@@ -64,9 +64,9 @@ 
 $xoTheme->addScript(REFERENCES_JS_URL . 'js/mootools.js');
 $xoTheme->addScript(REFERENCES_JS_URL . 'js/mootools-1.2-more.js');
 if (isset($xoopsConfig) && file_exists(REFERENCES_PATH . 'language/' . $xoopsConfig['language'] . '/slimbox.js')) {
-    $xoTheme->addScript(REFERENCES_URL . 'language/' . $xoopsConfig['language'] . '/slimbox.js');
+	$xoTheme->addScript(REFERENCES_URL . 'language/' . $xoopsConfig['language'] . '/slimbox.js');
 } else {
-    $xoTheme->addScript(REFERENCES_JS_URL . 'js/slimbox.js');
+	$xoTheme->addScript(REFERENCES_JS_URL . 'js/slimbox.js');
 }
 
 $categoriesSelect = $h_references_categories->getCategoriesSelect('categoriesSelect', $category->getVar('category_id'));
@@ -78,15 +78,15 @@ 
 $xoopsTpl->assign('thumbsWidth', references_utils::getModuleOption('thumbs_width'));
 $xoopsTpl->assign('thumbsHeight', references_utils::getModuleOption('thumbs_height'));
 if ($limit > 0) {
-    $items          = array();
-    $items          = $h_references_articles->getRecentArticles($start, $limit, references_utils::getModuleOption('sort_field'), references_utils::getModuleOption('sort_order'), true, $category_id);
-    $categoryTitle  = $category->getVar('category_title');
-    $categoryWeight = $category->getVar('category_weight');
-    if (count($items) > 0) {
-        foreach ($items as $item) {
-            $xoopsTpl->append('articles', $item->toArray());
-        }
-    }
+	$items          = array();
+	$items          = $h_references_articles->getRecentArticles($start, $limit, references_utils::getModuleOption('sort_field'), references_utils::getModuleOption('sort_order'), true, $category_id);
+	$categoryTitle  = $category->getVar('category_title');
+	$categoryWeight = $category->getVar('category_weight');
+	if (count($items) > 0) {
+		foreach ($items as $item) {
+			$xoopsTpl->append('articles', $item->toArray());
+		}
+	}
 }
 $xoopsTpl->assign('isAdmin', references_utils::isAdmin());
 $title = $category->getVar('category_title', 'n') . ' - ' . $xoopsModule->name();

Spacing +13 added lines, -13 removed lines

@@ -24,15 +24,15 @@ 
  *
  * @param integer $category_id Le numéro de la catégorie
  */
-require __DIR__ . '/header.php';
+require __DIR__.'/header.php';
 $xoopsOption['template_main'] = 'references_category.tpl';
-require XOOPS_ROOT_PATH . '/header.php';
+require XOOPS_ROOT_PATH.'/header.php';
 
-$baseurl = REFERENCES_URL . basename(__FILE__);
+$baseurl = REFERENCES_URL.basename(__FILE__);
 $limit   = references_utils::getModuleOption('items_index_page');
 $start   = $index = 0;
 
-$category_id = isset($_GET['category_id']) ? (int)$_GET['category_id'] : 0;
+$category_id = isset($_GET['category_id']) ? (int) $_GET['category_id'] : 0;
 if ($category_id == 0) {
     header('Location: index.php', true, 301);
     exit;
@@ -61,18 +61,18 @@ 
 $xoopsTpl->assign('use_rss', references_utils::getModuleOption('use_rss'));
 
 // MooTools
-$xoTheme->addScript(REFERENCES_JS_URL . 'js/mootools.js');
-$xoTheme->addScript(REFERENCES_JS_URL . 'js/mootools-1.2-more.js');
-if (isset($xoopsConfig) && file_exists(REFERENCES_PATH . 'language/' . $xoopsConfig['language'] . '/slimbox.js')) {
-    $xoTheme->addScript(REFERENCES_URL . 'language/' . $xoopsConfig['language'] . '/slimbox.js');
+$xoTheme->addScript(REFERENCES_JS_URL.'js/mootools.js');
+$xoTheme->addScript(REFERENCES_JS_URL.'js/mootools-1.2-more.js');
+if (isset($xoopsConfig) && file_exists(REFERENCES_PATH.'language/'.$xoopsConfig['language'].'/slimbox.js')) {
+    $xoTheme->addScript(REFERENCES_URL.'language/'.$xoopsConfig['language'].'/slimbox.js');
 } else {
-    $xoTheme->addScript(REFERENCES_JS_URL . 'js/slimbox.js');
+    $xoTheme->addScript(REFERENCES_JS_URL.'js/slimbox.js');
 }
 
 $categoriesSelect = $h_references_categories->getCategoriesSelect('categoriesSelect', $category->getVar('category_id'));
 $xoopsTpl->assign('categoriesSelect', $categoriesSelect);
-$xoTheme->addStylesheet(REFERENCES_JS_URL . 'css/slimbox.css');
-$xoTheme->addStylesheet(REFERENCES_JS_URL . 'css/accordion.css');
+$xoTheme->addStylesheet(REFERENCES_JS_URL.'css/slimbox.css');
+$xoTheme->addStylesheet(REFERENCES_JS_URL.'css/accordion.css');
 
 // ****************************************************************************************************************************
 $xoopsTpl->assign('thumbsWidth', references_utils::getModuleOption('thumbs_width'));
@@ -89,6 +89,6 @@ 
     }
 }
 $xoopsTpl->assign('isAdmin', references_utils::isAdmin());
-$title = $category->getVar('category_title', 'n') . ' - ' . $xoopsModule->name();
+$title = $category->getVar('category_title', 'n').' - '.$xoopsModule->name();
 references_utils::setMetas($title, $title);
-require XOOPS_ROOT_PATH . '/footer.php';
+require XOOPS_ROOT_PATH.'/footer.php';

list.tag.php

Spacing +2 added lines, -2 removed lines

@@ -18,5 +18,5 @@
  *
  * ****************************************************************************
  */
-require __DIR__ . '/header.php';
-require XOOPS_ROOT_PATH . '/modules/tag/list.tag.php';
+require __DIR__.'/header.php';
+require XOOPS_ROOT_PATH.'/modules/tag/list.tag.php';

config.php

Indentation +18 added lines, -18 removed lines

@@ -19,27 +19,27 @@
  * ****************************************************************************
  */
 if (!defined('REFERENCES_CACHE_PATH')) {
-    // Le chemin du cache (il est conseillé de le mettre en dehors de la portée du web)
-    define('REFERENCES_CACHE_PATH', XOOPS_UPLOAD_PATH . DIRECTORY_SEPARATOR . REFERENCES_DIRNAME . '_cache' . DIRECTORY_SEPARATOR);
+	// Le chemin du cache (il est conseillé de le mettre en dehors de la portée du web)
+	define('REFERENCES_CACHE_PATH', XOOPS_UPLOAD_PATH . DIRECTORY_SEPARATOR . REFERENCES_DIRNAME . '_cache' . DIRECTORY_SEPARATOR);
 
-    // Thumbs / Vignettes prefixe
-    define('REFERENCES_THUMBS_PREFIX', 'thumb_');        // Thumbs prefix (when thumbs are automatically created)
+	// Thumbs / Vignettes prefixe
+	define('REFERENCES_THUMBS_PREFIX', 'thumb_');        // Thumbs prefix (when thumbs are automatically created)
 
-    // Short text length / Longueur des textes raccourcis
-    define('REFERENCES_SHORTEN_TEXT', '200');        // Characters count / Nombre de caract�res
+	// Short text length / Longueur des textes raccourcis
+	define('REFERENCES_SHORTEN_TEXT', '200');        // Characters count / Nombre de caract�res
 
-    define('REFERENCES_METAGEN_MAX_KEYWORDS', 40);
-    define('REFERENCES_METAGEN_KEYWORDS_ORDER', 0);
+	define('REFERENCES_METAGEN_MAX_KEYWORDS', 40);
+	define('REFERENCES_METAGEN_KEYWORDS_ORDER', 0);
 
-    // Automatically fill the manual date when creating a reference ? / Remplir automatiquement la date manuelle lorsqu'on crée une référence
-    define('REFERENCES_AUTO_FILL_MANUAL_DATE', true);
+	// Automatically fill the manual date when creating a reference ? / Remplir automatiquement la date manuelle lorsqu'on crée une référence
+	define('REFERENCES_AUTO_FILL_MANUAL_DATE', true);
 
-    /**
-     * Si la valeur est à false, alors dans les listes de recherche, côté admin, on recherche tout ce qui contient quelque chose.
-     * Par exemple si on tape "a", le module trouvera "abajour" et "cartable".
-     * Par contre si on met cette valeur à true alors le module cherchera tout ce qui commence par ...
-     * Par exemple si on tape "a", lemodule trouvera "abajour" MAIS PAS "cartable"
-     * PAR CONTRE "%a" trouvera tout ce qui contient la lettre a
-     */
-    define('REFERENCES_EXACT_SEARCH', true);
+	/**
+	 * Si la valeur est à false, alors dans les listes de recherche, côté admin, on recherche tout ce qui contient quelque chose.
+	 * Par exemple si on tape "a", le module trouvera "abajour" et "cartable".
+	 * Par contre si on met cette valeur à true alors le module cherchera tout ce qui commence par ...
+	 * Par exemple si on tape "a", lemodule trouvera "abajour" MAIS PAS "cartable"
+	 * PAR CONTRE "%a" trouvera tout ce qui contient la lettre a
+	 */
+	define('REFERENCES_EXACT_SEARCH', true);
 }

Spacing +3 added lines, -3 removed lines

@@ -20,13 +20,13 @@
  */
 if (!defined('REFERENCES_CACHE_PATH')) {
     // Le chemin du cache (il est conseillé de le mettre en dehors de la portée du web)
-    define('REFERENCES_CACHE_PATH', XOOPS_UPLOAD_PATH . DIRECTORY_SEPARATOR . REFERENCES_DIRNAME . '_cache' . DIRECTORY_SEPARATOR);
+    define('REFERENCES_CACHE_PATH', XOOPS_UPLOAD_PATH.DIRECTORY_SEPARATOR.REFERENCES_DIRNAME.'_cache'.DIRECTORY_SEPARATOR);
 
     // Thumbs / Vignettes prefixe
-    define('REFERENCES_THUMBS_PREFIX', 'thumb_');        // Thumbs prefix (when thumbs are automatically created)
+    define('REFERENCES_THUMBS_PREFIX', 'thumb_'); // Thumbs prefix (when thumbs are automatically created)
 
     // Short text length / Longueur des textes raccourcis
-    define('REFERENCES_SHORTEN_TEXT', '200');        // Characters count / Nombre de caract�res
+    define('REFERENCES_SHORTEN_TEXT', '200'); // Characters count / Nombre de caract�res
 
     define('REFERENCES_METAGEN_MAX_KEYWORDS', 40);
     define('REFERENCES_METAGEN_KEYWORDS_ORDER', 0);

header.php

Indentation +2 added lines, -2 removed lines

@@ -19,8 +19,8 @@
  * ****************************************************************************
  */
 if (file_exists('../../mainfile.php')) {
-    require __DIR__ . '/../../mainfile.php';
+	require __DIR__ . '/../../mainfile.php';
 } elseif (file_exists('../../../mainfile.php')) {
-    require __DIR__ . '/../../../mainfile.php';
+	require __DIR__ . '/../../../mainfile.php';
 }
 require_once XOOPS_ROOT_PATH . '/modules/references/include/common.php';

Spacing +3 added lines, -3 removed lines

@@ -19,8 +19,8 @@
  * ****************************************************************************
  */
 if (file_exists('../../mainfile.php')) {
-    require __DIR__ . '/../../mainfile.php';
+    require __DIR__.'/../../mainfile.php';
 } elseif (file_exists('../../../mainfile.php')) {
-    require __DIR__ . '/../../../mainfile.php';
+    require __DIR__.'/../../../mainfile.php';
 }
-require_once XOOPS_ROOT_PATH . '/modules/references/include/common.php';
+require_once XOOPS_ROOT_PATH.'/modules/references/include/common.php';

plugins/actions/newcategory/plugins.php

Indentation +38 added lines, -38 removed lines

@@ -25,44 +25,44 @@
  */
 class referencesNewcategoryAction extends references_action
 {
-    public function registerEvents()
-    {
-        /**
-         * La liste des évènements traités par le plugin se présente sous la forme d'un tableau compposé comme ceci :
-         *
-         * Indice   Signification
-         * ----------------------
-         *    0        Evènement sur lequel se raccrocher (voir class/references_plugins.php::EVENT_ON_PRODUCT_CREATE
-         *    1        Priorité du plugin (de 1 à 5)
-         *    2        Script Php à inclure
-         *    3        Classe à instancier
-         *    4        Méthode à appeler
-         */
-        $events   = array();
-        $events[] = array(
-            references_plugins::EVENT_ON_CATEGORY_CREATE,
-            references_plugins::EVENT_PRIORITY_1,
-            basename(__FILE__),
-            __CLASS__,
-            'fireNewCategory'
-        );
+	public function registerEvents()
+	{
+		/**
+		 * La liste des évènements traités par le plugin se présente sous la forme d'un tableau compposé comme ceci :
+		 *
+		 * Indice   Signification
+		 * ----------------------
+		 *    0        Evènement sur lequel se raccrocher (voir class/references_plugins.php::EVENT_ON_PRODUCT_CREATE
+		 *    1        Priorité du plugin (de 1 à 5)
+		 *    2        Script Php à inclure
+		 *    3        Classe à instancier
+		 *    4        Méthode à appeler
+		 */
+		$events   = array();
+		$events[] = array(
+			references_plugins::EVENT_ON_CATEGORY_CREATE,
+			references_plugins::EVENT_PRIORITY_1,
+			basename(__FILE__),
+			__CLASS__,
+			'fireNewCategory'
+		);
 
-        return $events;
-    }
+		return $events;
+	}
 
-    /**
-     * Méthode appelée pour indiquer qu'une nouvelle catégorie de références a été créée
-     *
-     * @param object $parameters La catégorie qui vient d'être publiée
-     * @return void
-     */
-    public function fireNewCategory($parameters)
-    {
-        $category                = $parameters['category'];
-        $notification_handler    = xoops_getHandler('notification');
-        $params                  = array();
-        $params['CATEGORY_URL']  = $category->getUrl();
-        $params['CATEGORY_NAME'] = $category->getVar('category_title');
-        $notification_handler->triggerEvent('global', 0, 'new_category', $params);
-    }
+	/**
+	 * Méthode appelée pour indiquer qu'une nouvelle catégorie de références a été créée
+	 *
+	 * @param object $parameters La catégorie qui vient d'être publiée
+	 * @return void
+	 */
+	public function fireNewCategory($parameters)
+	{
+		$category                = $parameters['category'];
+		$notification_handler    = xoops_getHandler('notification');
+		$params                  = array();
+		$params['CATEGORY_URL']  = $category->getUrl();
+		$params['CATEGORY_NAME'] = $category->getVar('category_title');
+		$notification_handler->triggerEvent('global', 0, 'new_category', $params);
+	}
 }

plugins/actions/twitter/bitly.class.php

Indentation +209 added lines, -209 removed lines

@@ -13,218 +13,218 @@
 */
 
 if (class_exists('Bitly')) {
-    return true;
+	return true;
 }
 
 class Bitly
 {
 
-    protected $api          = 'http://api.bit.ly/';
-    private   $format       = 'json';
-    private   $version      = '2.0.1';
-    private   $validActions = array(
-        'shorten',
-        'stats',
-        'info',
-        'expand'
-    );
-
-    public function __construct($login, $apiKey)
-    {
-        $this->login        = $login;
-        $this->apiKey       = $apiKey;
-        $this->statusCode   = 'OK';
-        $this->errorMessage = '';
-        $this->errorCode    = '';
-        return true;
-    }
-
-    private function setError($message, $code = 101)
-    {
-        $this->errorCode    = $code;
-        $this->errorMessage = $message;
-        $this->statusCode   = 'ERROR';
-    }
-
-    public function validAction($action)
-    {
-        if (in_array($action, $this->validActions)) {
-            return true;
-        }
-        $this->setError("Undefined method $action", 202);
-        return false;
-    }
-
-    public function error()
-    {
-        $ret = array(
-            'errorCode'    => $this->errorCode,
-            'errorMessage' => $this->errorMessage,
-            'statusCode'   => $this->statusCode
-        );
-
-        // Function used for passing empty result sometimes.
-        if ($this->statusCode === 'OK') {
-            $ret['results'] = array();
-        }
-        if ($this->format === 'json') {
-            return json_encode($ret);
-        } else {
-            throw new Exception('Unsupported format');
-        }
-    }
-
-    public function shorten($message)
-    {
-
-        $postFields = '';
-        preg_match_all("/http(s?):\/\/[^( |$|\]|,|\\\)]+/i", $message, $matches);
-
-        for ($i = 0; $i < count($matches[0]); $i++) {
-            $curr = $matches[0][$i];
-            // ignore bitly urls
-            if (!strstr($curr, 'http://bit.ly')) {
-                $postFields .= '&longUrl=' . urlencode($curr);
-            }
-        }
-
-        // nothing to shorten, return empty result
-        if (!strlen($postFields)) {
-            return $this->error();
-        }
-        return $this->process('shorten', $postFields);
-    }
-
-    public function expand($message)
-    {
-        $postFields = '&hash=' . $this->getHash($message);
-        return $this->process('expand', $postFields);
-    }
-
-    public function info($bitlyUrl)
-    {
-        $hash       = $this->getHash($bitlyUrl);
-        $postFields = '&hash=' . $hash;
-        return $this->process('info', $postFields);
-    }
-
-    public function stats($bitlyUrl)
-    {
-        // Take only first hash or url. Ignore others.
-        $a          = split(',', $bitlyUrl);
-        $postFields = '&hash=' . $this->getHash($a[0]);
-        return $this->process('stats', $postFields);
-    }
-
-    protected function process($action, $postFields)
-    {
-        $ch = curl_init($this->api . $action);
-
-        $postFields = 'version=' . $this->version . $postFields;
-        $postFields .= '&format=' . $this->format;
-        $postFields .= '&history=1';
-
-        curl_setopt($ch, CURLOPT_USERPWD, $this->login . ':' . $this->apiKey);
-        curl_setopt($ch, CURLOPT_POST, 1);
-        curl_setopt($ch, CURLOPT_POSTFIELDS, $postFields);
-        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
-
-        $response = curl_exec($ch);
-
-        curl_close($ch);
-
-        return $response;
-    }
-
-    public function setReturnFormat($format)
-    {
-        // needed for restoration
-        $this->oldFormat = $this->format;
-        $this->format    = $format;
-        return $this->format;
-    }
-
-    private function restoreFormat()
-    {
-        if (!empty($this->oldFormat)) {
-            $this->format = $this->oldFormat;
-        }
-        return $this->format;
-    }
-
-    // expect url, shortened url or hash
-    public function getHash($message)
-    {
-        // if url and not bit.ly get shortened first
-        if (strstr($message, 'http://') && !strstr($message, 'http://bit.ly')) {
-            $message = $this->shortenSingle($message);
-        }
-        $hash = str_replace('http://bit.ly/', '', $message);
-        return $hash;
-    }
-
-    public function shortenSingle($message)
-    {
-        $this->setReturnFormat('json');
-        $data = json_decode($this->shorten($message), true);
-        // return to previous state.
-        $this->restoreFormat();
-
-        // replace every long url with short one
-        foreach ($data['results'] as $url => $d) {
-            $message = str_replace($url, $d['shortUrl'], $message);
-        }
-        return $message;
-    }
-
-    public function expandSingle($shortUrl)
-    {
-        $this->setReturnFormat('json');
-        $data = json_decode($this->expand($shortUrl), true);
-        $this->restoreFormat();
-        return $data['results'][$this->getHash($shortUrl)]['longUrl'];
-    }
-
-    public function getInfoArray($url)
-    {
-        $this->setReturnFormat('json');
-        $json = $this->info($url);
-        $this->restoreFormat();
-        $data = json_decode($json, true);
-
-        $this->infoArray = array_pop($data['results']);
-        return $this->infoArray;
-    }
-
-    public function getStatsArray($url)
-    {
-        $this->setReturnFormat('json');
-        $json = $this->stats($url);
-        $this->restoreFormat();
-        $data             = json_decode($json, true);
-        $this->statsArray = $data['results'];
-        return $this->statsArray;
-    }
-
-    public function getClicks()
-    {
-        return $this->statsArray['clicks'];
-    }
-
-    // get thumbnail (small, middle, large)
-    public function getThumbnail($size = 'small')
-    {
-        if (!in_array($size, array('small', 'medium', 'large'))) {
-            throw new Exception('Invalid size value');
-        }
-        if (empty($this->infoArray)) {
-            throw new Exception('Info not loaded');
-        }
-        return $this->infoArray['thumbnail'][$size];
-    }
-
-    public function getTitle()
-    {
-        return $this->infoArray['htmlTitle'];
-    }
+	protected $api          = 'http://api.bit.ly/';
+	private   $format       = 'json';
+	private   $version      = '2.0.1';
+	private   $validActions = array(
+		'shorten',
+		'stats',
+		'info',
+		'expand'
+	);
+
+	public function __construct($login, $apiKey)
+	{
+		$this->login        = $login;
+		$this->apiKey       = $apiKey;
+		$this->statusCode   = 'OK';
+		$this->errorMessage = '';
+		$this->errorCode    = '';
+		return true;
+	}
+
+	private function setError($message, $code = 101)
+	{
+		$this->errorCode    = $code;
+		$this->errorMessage = $message;
+		$this->statusCode   = 'ERROR';
+	}
+
+	public function validAction($action)
+	{
+		if (in_array($action, $this->validActions)) {
+			return true;
+		}
+		$this->setError("Undefined method $action", 202);
+		return false;
+	}
+
+	public function error()
+	{
+		$ret = array(
+			'errorCode'    => $this->errorCode,
+			'errorMessage' => $this->errorMessage,
+			'statusCode'   => $this->statusCode
+		);
+
+		// Function used for passing empty result sometimes.
+		if ($this->statusCode === 'OK') {
+			$ret['results'] = array();
+		}
+		if ($this->format === 'json') {
+			return json_encode($ret);
+		} else {
+			throw new Exception('Unsupported format');
+		}
+	}
+
+	public function shorten($message)
+	{
+
+		$postFields = '';
+		preg_match_all("/http(s?):\/\/[^( |$|\]|,|\\\)]+/i", $message, $matches);
+
+		for ($i = 0; $i < count($matches[0]); $i++) {
+			$curr = $matches[0][$i];
+			// ignore bitly urls
+			if (!strstr($curr, 'http://bit.ly')) {
+				$postFields .= '&longUrl=' . urlencode($curr);
+			}
+		}
+
+		// nothing to shorten, return empty result
+		if (!strlen($postFields)) {
+			return $this->error();
+		}
+		return $this->process('shorten', $postFields);
+	}
+
+	public function expand($message)
+	{
+		$postFields = '&hash=' . $this->getHash($message);
+		return $this->process('expand', $postFields);
+	}
+
+	public function info($bitlyUrl)
+	{
+		$hash       = $this->getHash($bitlyUrl);
+		$postFields = '&hash=' . $hash;
+		return $this->process('info', $postFields);
+	}
+
+	public function stats($bitlyUrl)
+	{
+		// Take only first hash or url. Ignore others.
+		$a          = split(',', $bitlyUrl);
+		$postFields = '&hash=' . $this->getHash($a[0]);
+		return $this->process('stats', $postFields);
+	}
+
+	protected function process($action, $postFields)
+	{
+		$ch = curl_init($this->api . $action);
+
+		$postFields = 'version=' . $this->version . $postFields;
+		$postFields .= '&format=' . $this->format;
+		$postFields .= '&history=1';
+
+		curl_setopt($ch, CURLOPT_USERPWD, $this->login . ':' . $this->apiKey);
+		curl_setopt($ch, CURLOPT_POST, 1);
+		curl_setopt($ch, CURLOPT_POSTFIELDS, $postFields);
+		curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
+
+		$response = curl_exec($ch);
+
+		curl_close($ch);
+
+		return $response;
+	}
+
+	public function setReturnFormat($format)
+	{
+		// needed for restoration
+		$this->oldFormat = $this->format;
+		$this->format    = $format;
+		return $this->format;
+	}
+
+	private function restoreFormat()
+	{
+		if (!empty($this->oldFormat)) {
+			$this->format = $this->oldFormat;
+		}
+		return $this->format;
+	}
+
+	// expect url, shortened url or hash
+	public function getHash($message)
+	{
+		// if url and not bit.ly get shortened first
+		if (strstr($message, 'http://') && !strstr($message, 'http://bit.ly')) {
+			$message = $this->shortenSingle($message);
+		}
+		$hash = str_replace('http://bit.ly/', '', $message);
+		return $hash;
+	}
+
+	public function shortenSingle($message)
+	{
+		$this->setReturnFormat('json');
+		$data = json_decode($this->shorten($message), true);
+		// return to previous state.
+		$this->restoreFormat();
+
+		// replace every long url with short one
+		foreach ($data['results'] as $url => $d) {
+			$message = str_replace($url, $d['shortUrl'], $message);
+		}
+		return $message;
+	}
+
+	public function expandSingle($shortUrl)
+	{
+		$this->setReturnFormat('json');
+		$data = json_decode($this->expand($shortUrl), true);
+		$this->restoreFormat();
+		return $data['results'][$this->getHash($shortUrl)]['longUrl'];
+	}
+
+	public function getInfoArray($url)
+	{
+		$this->setReturnFormat('json');
+		$json = $this->info($url);
+		$this->restoreFormat();
+		$data = json_decode($json, true);
+
+		$this->infoArray = array_pop($data['results']);
+		return $this->infoArray;
+	}
+
+	public function getStatsArray($url)
+	{
+		$this->setReturnFormat('json');
+		$json = $this->stats($url);
+		$this->restoreFormat();
+		$data             = json_decode($json, true);
+		$this->statsArray = $data['results'];
+		return $this->statsArray;
+	}
+
+	public function getClicks()
+	{
+		return $this->statsArray['clicks'];
+	}
+
+	// get thumbnail (small, middle, large)
+	public function getThumbnail($size = 'small')
+	{
+		if (!in_array($size, array('small', 'medium', 'large'))) {
+			throw new Exception('Invalid size value');
+		}
+		if (empty($this->infoArray)) {
+			throw new Exception('Info not loaded');
+		}
+		return $this->infoArray['thumbnail'][$size];
+	}
+
+	public function getTitle()
+	{
+		return $this->infoArray['htmlTitle'];
+	}
 }

Spacing +8 added lines, -8 removed lines

@@ -84,7 +84,7 @@ 
             $curr = $matches[0][$i];
             // ignore bitly urls
             if (!strstr($curr, 'http://bit.ly')) {
-                $postFields .= '&longUrl=' . urlencode($curr);
+                $postFields .= '&longUrl='.urlencode($curr);
             }
         }
 
@@ -97,14 +97,14 @@ 
 
     public function expand($message)
     {
-        $postFields = '&hash=' . $this->getHash($message);
+        $postFields = '&hash='.$this->getHash($message);
         return $this->process('expand', $postFields);
     }
 
     public function info($bitlyUrl)
     {
         $hash       = $this->getHash($bitlyUrl);
-        $postFields = '&hash=' . $hash;
+        $postFields = '&hash='.$hash;
         return $this->process('info', $postFields);
     }
 
@@ -112,19 +112,19 @@ 
     {
         // Take only first hash or url. Ignore others.
         $a          = split(',', $bitlyUrl);
-        $postFields = '&hash=' . $this->getHash($a[0]);
+        $postFields = '&hash='.$this->getHash($a[0]);
         return $this->process('stats', $postFields);
     }
 
     protected function process($action, $postFields)
     {
-        $ch = curl_init($this->api . $action);
+        $ch = curl_init($this->api.$action);
 
-        $postFields = 'version=' . $this->version . $postFields;
-        $postFields .= '&format=' . $this->format;
+        $postFields = 'version='.$this->version.$postFields;
+        $postFields .= '&format='.$this->format;
         $postFields .= '&history=1';
 
-        curl_setopt($ch, CURLOPT_USERPWD, $this->login . ':' . $this->apiKey);
+        curl_setopt($ch, CURLOPT_USERPWD, $this->login.':'.$this->apiKey);
         curl_setopt($ch, CURLOPT_POST, 1);
         curl_setopt($ch, CURLOPT_POSTFIELDS, $postFields);
         curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);