Completed
Push — master ( 7d7e14...402923 )
by Michael
03:30
created
class/references_parameters.php 3 patches
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -39,7 +39,7 @@
 block discarded – undo
39 39
      *
40 40
      * @param string $key	Le nom du champ à traiter
41 41
      * @param mixed $value	La valeur à lui attribuer
42
-     * @return object
42
+     * @return references_parameters
43 43
      */
44 44
     function __set($key, $value)
45 45
     {
Please login to merge, or discard this patch.
Indentation   +52 added lines, -52 removed lines patch added patch discarded remove patch
@@ -30,62 +30,62 @@
 block discarded – undo
30 30
  */
31 31
 class references_parameters extends ArrayObject
32 32
 {
33
-    /**
34
-     * Permet de valoriser un indice de la classe comme si c'était une propriété de la classe
35
-     *
36
-     * @example $enregistrement->nom_du_champ = 'ma chaine'
37
-     *
38
-     * @param string $key   Le nom du champ à traiter
39
-     * @param mixed  $value La valeur à lui attribuer
40
-     * @return object
41
-     */
42
-    public function __set($key, $value)
43
-    {
44
-        parent::offsetSet($key, $value);
33
+	/**
34
+	 * Permet de valoriser un indice de la classe comme si c'était une propriété de la classe
35
+	 *
36
+	 * @example $enregistrement->nom_du_champ = 'ma chaine'
37
+	 *
38
+	 * @param string $key   Le nom du champ à traiter
39
+	 * @param mixed  $value La valeur à lui attribuer
40
+	 * @return object
41
+	 */
42
+	public function __set($key, $value)
43
+	{
44
+		parent::offsetSet($key, $value);
45 45
 
46
-        return $this;
47
-    }
46
+		return $this;
47
+	}
48 48
 
49
-    /**
50
-     * Valorisation d'un indice de la classe en utilisant un appel de fonction basé sur le principe suivant :
51
-     *      $maClasse->setLimit(10);
52
-     * Il est possible de chainer comme ceci : $maClasse->setStart(0)->setLimit(10);
53
-     *
54
-     * @param  string $method
55
-     * @param  mixed  $args
56
-     * @return object
57
-     */
58
-    public function __call($method, $args)
59
-    {
60
-        if (substr($method, 0, 3) === 'set') {
61
-            parent::offsetSet(strtolower(substr($method, 3, 1)) . substr($method, 4), $args[0]);
49
+	/**
50
+	 * Valorisation d'un indice de la classe en utilisant un appel de fonction basé sur le principe suivant :
51
+	 *      $maClasse->setLimit(10);
52
+	 * Il est possible de chainer comme ceci : $maClasse->setStart(0)->setLimit(10);
53
+	 *
54
+	 * @param  string $method
55
+	 * @param  mixed  $args
56
+	 * @return object
57
+	 */
58
+	public function __call($method, $args)
59
+	{
60
+		if (substr($method, 0, 3) === 'set') {
61
+			parent::offsetSet(strtolower(substr($method, 3, 1)) . substr($method, 4), $args[0]);
62 62
 
63
-            return $this;
64
-        } else {    // Affichage de la valeur
63
+			return $this;
64
+		} else {    // Affichage de la valeur
65 65
 
66
-            return parent::offsetGet($method);
67
-        }
68
-    }
66
+			return parent::offsetGet($method);
67
+		}
68
+	}
69 69
 
70
-    /**
71
-     * Méthode qui essaye de faire la même chose que la méthode extend() de jQuery
72
-     *
73
-     * On lui passe les valeurs par défaut que l'on attend et la méthode les compare avec les valeurs actuelles
74
-     * Si des valeurs manquent, elles sont ajoutées
75
-     *
76
-     * @param  references_parameters $defaultValues
77
-     * @return references_parameters
78
-     */
79
-    public function extend(self $defaultValues)
80
-    {
81
-        $result = new self;
82
-        $result = $this;
83
-        foreach ($defaultValues as $key => $value) {
84
-            if (!isset($result[$key])) {
85
-                $result[$key] = $value;
86
-            }
87
-        }
70
+	/**
71
+	 * Méthode qui essaye de faire la même chose que la méthode extend() de jQuery
72
+	 *
73
+	 * On lui passe les valeurs par défaut que l'on attend et la méthode les compare avec les valeurs actuelles
74
+	 * Si des valeurs manquent, elles sont ajoutées
75
+	 *
76
+	 * @param  references_parameters $defaultValues
77
+	 * @return references_parameters
78
+	 */
79
+	public function extend(self $defaultValues)
80
+	{
81
+		$result = new self;
82
+		$result = $this;
83
+		foreach ($defaultValues as $key => $value) {
84
+			if (!isset($result[$key])) {
85
+				$result[$key] = $value;
86
+			}
87
+		}
88 88
 
89
-        return $result;
90
-    }
89
+		return $result;
90
+	}
91 91
 }
Please login to merge, or discard this patch.
Spacing   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -58,7 +58,7 @@
 block discarded – undo
58 58
     public function __call($method, $args)
59 59
     {
60 60
         if (substr($method, 0, 3) === 'set') {
61
-            parent::offsetSet(strtolower(substr($method, 3, 1)) . substr($method, 4), $args[0]);
61
+            parent::offsetSet(strtolower(substr($method, 3, 1)).substr($method, 4), $args[0]);
62 62
 
63 63
             return $this;
64 64
         } else {    // Affichage de la valeur
Please login to merge, or discard this patch.
plugins/actions/twitter/bitly.class.php 3 patches
Doc Comments   +11 added lines patch added patch discarded remove patch
@@ -28,6 +28,10 @@  discard block
 block discarded – undo
28 28
         'expand'
29 29
         );
30 30
 
31
+    /**
32
+     * @param string $login
33
+     * @param string $apiKey
34
+     */
31 35
     public function Bitly($login, $apiKey)
32 36
     {
33 37
         $this->login = $login;
@@ -115,6 +119,10 @@  discard block
 block discarded – undo
115 119
         return $this->process('stats', $postFields);
116 120
     }
117 121
 
122
+    /**
123
+     * @param string $action
124
+     * @param string $postFields
125
+     */
118 126
     protected function process($action, $postFields) {
119 127
         $ch = curl_init( $this->api . $action);
120 128
 
@@ -134,6 +142,9 @@  discard block
 block discarded – undo
134 142
         return $response;
135 143
     }
136 144
 
145
+    /**
146
+     * @param string $format
147
+     */
137 148
     public function setReturnFormat($format)
138 149
     {
139 150
         // needed for restoration
Please login to merge, or discard this patch.
Indentation   +209 added lines, -209 removed lines patch added patch discarded remove patch
@@ -13,218 +13,218 @@
 block discarded – undo
13 13
 */
14 14
 
15 15
 if (class_exists('Bitly')) {
16
-    return true;
16
+	return true;
17 17
 }
18 18
 
19 19
 class Bitly
20 20
 {
21 21
 
22
-    protected $api          = 'http://api.bit.ly/';
23
-    private   $format       = 'json';
24
-    private   $version      = '2.0.1';
25
-    private   $validActions = array(
26
-        'shorten',
27
-        'stats',
28
-        'info',
29
-        'expand'
30
-    );
31
-
32
-    public function __construct($login, $apiKey)
33
-    {
34
-        $this->login        = $login;
35
-        $this->apiKey       = $apiKey;
36
-        $this->statusCode   = 'OK';
37
-        $this->errorMessage = '';
38
-        $this->errorCode    = '';
39
-        return true;
40
-    }
41
-
42
-    private function setError($message, $code = 101)
43
-    {
44
-        $this->errorCode    = $code;
45
-        $this->errorMessage = $message;
46
-        $this->statusCode   = 'ERROR';
47
-    }
48
-
49
-    public function validAction($action)
50
-    {
51
-        if (in_array($action, $this->validActions)) {
52
-            return true;
53
-        }
54
-        $this->setError("Undefined method $action", 202);
55
-        return false;
56
-    }
57
-
58
-    public function error()
59
-    {
60
-        $ret = array(
61
-            'errorCode'    => $this->errorCode,
62
-            'errorMessage' => $this->errorMessage,
63
-            'statusCode'   => $this->statusCode
64
-        );
65
-
66
-        // Function used for passing empty result sometimes.
67
-        if ($this->statusCode === 'OK') {
68
-            $ret['results'] = array();
69
-        }
70
-        if ($this->format === 'json') {
71
-            return json_encode($ret);
72
-        } else {
73
-            throw new Exception('Unsupported format');
74
-        }
75
-    }
76
-
77
-    public function shorten($message)
78
-    {
79
-
80
-        $postFields = '';
81
-        preg_match_all("/http(s?):\/\/[^( |$|\]|,|\\\)]+/i", $message, $matches);
82
-
83
-        for ($i = 0; $i < count($matches[0]); $i++) {
84
-            $curr = $matches[0][$i];
85
-            // ignore bitly urls
86
-            if (!strstr($curr, 'http://bit.ly')) {
87
-                $postFields .= '&longUrl=' . urlencode($curr);
88
-            }
89
-        }
90
-
91
-        // nothing to shorten, return empty result
92
-        if (!strlen($postFields)) {
93
-            return $this->error();
94
-        }
95
-        return $this->process('shorten', $postFields);
96
-    }
97
-
98
-    public function expand($message)
99
-    {
100
-        $postFields = '&hash=' . $this->getHash($message);
101
-        return $this->process('expand', $postFields);
102
-    }
103
-
104
-    public function info($bitlyUrl)
105
-    {
106
-        $hash       = $this->getHash($bitlyUrl);
107
-        $postFields = '&hash=' . $hash;
108
-        return $this->process('info', $postFields);
109
-    }
110
-
111
-    public function stats($bitlyUrl)
112
-    {
113
-        // Take only first hash or url. Ignore others.
114
-        $a          = split(',', $bitlyUrl);
115
-        $postFields = '&hash=' . $this->getHash($a[0]);
116
-        return $this->process('stats', $postFields);
117
-    }
118
-
119
-    protected function process($action, $postFields)
120
-    {
121
-        $ch = curl_init($this->api . $action);
122
-
123
-        $postFields = 'version=' . $this->version . $postFields;
124
-        $postFields .= '&format=' . $this->format;
125
-        $postFields .= '&history=1';
126
-
127
-        curl_setopt($ch, CURLOPT_USERPWD, $this->login . ':' . $this->apiKey);
128
-        curl_setopt($ch, CURLOPT_POST, 1);
129
-        curl_setopt($ch, CURLOPT_POSTFIELDS, $postFields);
130
-        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
131
-
132
-        $response = curl_exec($ch);
133
-
134
-        curl_close($ch);
135
-
136
-        return $response;
137
-    }
138
-
139
-    public function setReturnFormat($format)
140
-    {
141
-        // needed for restoration
142
-        $this->oldFormat = $this->format;
143
-        $this->format    = $format;
144
-        return $this->format;
145
-    }
146
-
147
-    private function restoreFormat()
148
-    {
149
-        if (!empty($this->oldFormat)) {
150
-            $this->format = $this->oldFormat;
151
-        }
152
-        return $this->format;
153
-    }
154
-
155
-    // expect url, shortened url or hash
156
-    public function getHash($message)
157
-    {
158
-        // if url and not bit.ly get shortened first
159
-        if (strstr($message, 'http://') && !strstr($message, 'http://bit.ly')) {
160
-            $message = $this->shortenSingle($message);
161
-        }
162
-        $hash = str_replace('http://bit.ly/', '', $message);
163
-        return $hash;
164
-    }
165
-
166
-    public function shortenSingle($message)
167
-    {
168
-        $this->setReturnFormat('json');
169
-        $data = json_decode($this->shorten($message), true);
170
-        // return to previous state.
171
-        $this->restoreFormat();
172
-
173
-        // replace every long url with short one
174
-        foreach ($data['results'] as $url => $d) {
175
-            $message = str_replace($url, $d['shortUrl'], $message);
176
-        }
177
-        return $message;
178
-    }
179
-
180
-    public function expandSingle($shortUrl)
181
-    {
182
-        $this->setReturnFormat('json');
183
-        $data = json_decode($this->expand($shortUrl), true);
184
-        $this->restoreFormat();
185
-        return $data['results'][$this->getHash($shortUrl)]['longUrl'];
186
-    }
187
-
188
-    public function getInfoArray($url)
189
-    {
190
-        $this->setReturnFormat('json');
191
-        $json = $this->info($url);
192
-        $this->restoreFormat();
193
-        $data = json_decode($json, true);
194
-
195
-        $this->infoArray = array_pop($data['results']);
196
-        return $this->infoArray;
197
-    }
198
-
199
-    public function getStatsArray($url)
200
-    {
201
-        $this->setReturnFormat('json');
202
-        $json = $this->stats($url);
203
-        $this->restoreFormat();
204
-        $data             = json_decode($json, true);
205
-        $this->statsArray = $data['results'];
206
-        return $this->statsArray;
207
-    }
208
-
209
-    public function getClicks()
210
-    {
211
-        return $this->statsArray['clicks'];
212
-    }
213
-
214
-    // get thumbnail (small, middle, large)
215
-    public function getThumbnail($size = 'small')
216
-    {
217
-        if (!in_array($size, array('small', 'medium', 'large'))) {
218
-            throw new Exception('Invalid size value');
219
-        }
220
-        if (empty($this->infoArray)) {
221
-            throw new Exception('Info not loaded');
222
-        }
223
-        return $this->infoArray['thumbnail'][$size];
224
-    }
225
-
226
-    public function getTitle()
227
-    {
228
-        return $this->infoArray['htmlTitle'];
229
-    }
22
+	protected $api          = 'http://api.bit.ly/';
23
+	private   $format       = 'json';
24
+	private   $version      = '2.0.1';
25
+	private   $validActions = array(
26
+		'shorten',
27
+		'stats',
28
+		'info',
29
+		'expand'
30
+	);
31
+
32
+	public function __construct($login, $apiKey)
33
+	{
34
+		$this->login        = $login;
35
+		$this->apiKey       = $apiKey;
36
+		$this->statusCode   = 'OK';
37
+		$this->errorMessage = '';
38
+		$this->errorCode    = '';
39
+		return true;
40
+	}
41
+
42
+	private function setError($message, $code = 101)
43
+	{
44
+		$this->errorCode    = $code;
45
+		$this->errorMessage = $message;
46
+		$this->statusCode   = 'ERROR';
47
+	}
48
+
49
+	public function validAction($action)
50
+	{
51
+		if (in_array($action, $this->validActions)) {
52
+			return true;
53
+		}
54
+		$this->setError("Undefined method $action", 202);
55
+		return false;
56
+	}
57
+
58
+	public function error()
59
+	{
60
+		$ret = array(
61
+			'errorCode'    => $this->errorCode,
62
+			'errorMessage' => $this->errorMessage,
63
+			'statusCode'   => $this->statusCode
64
+		);
65
+
66
+		// Function used for passing empty result sometimes.
67
+		if ($this->statusCode === 'OK') {
68
+			$ret['results'] = array();
69
+		}
70
+		if ($this->format === 'json') {
71
+			return json_encode($ret);
72
+		} else {
73
+			throw new Exception('Unsupported format');
74
+		}
75
+	}
76
+
77
+	public function shorten($message)
78
+	{
79
+
80
+		$postFields = '';
81
+		preg_match_all("/http(s?):\/\/[^( |$|\]|,|\\\)]+/i", $message, $matches);
82
+
83
+		for ($i = 0; $i < count($matches[0]); $i++) {
84
+			$curr = $matches[0][$i];
85
+			// ignore bitly urls
86
+			if (!strstr($curr, 'http://bit.ly')) {
87
+				$postFields .= '&longUrl=' . urlencode($curr);
88
+			}
89
+		}
90
+
91
+		// nothing to shorten, return empty result
92
+		if (!strlen($postFields)) {
93
+			return $this->error();
94
+		}
95
+		return $this->process('shorten', $postFields);
96
+	}
97
+
98
+	public function expand($message)
99
+	{
100
+		$postFields = '&hash=' . $this->getHash($message);
101
+		return $this->process('expand', $postFields);
102
+	}
103
+
104
+	public function info($bitlyUrl)
105
+	{
106
+		$hash       = $this->getHash($bitlyUrl);
107
+		$postFields = '&hash=' . $hash;
108
+		return $this->process('info', $postFields);
109
+	}
110
+
111
+	public function stats($bitlyUrl)
112
+	{
113
+		// Take only first hash or url. Ignore others.
114
+		$a          = split(',', $bitlyUrl);
115
+		$postFields = '&hash=' . $this->getHash($a[0]);
116
+		return $this->process('stats', $postFields);
117
+	}
118
+
119
+	protected function process($action, $postFields)
120
+	{
121
+		$ch = curl_init($this->api . $action);
122
+
123
+		$postFields = 'version=' . $this->version . $postFields;
124
+		$postFields .= '&format=' . $this->format;
125
+		$postFields .= '&history=1';
126
+
127
+		curl_setopt($ch, CURLOPT_USERPWD, $this->login . ':' . $this->apiKey);
128
+		curl_setopt($ch, CURLOPT_POST, 1);
129
+		curl_setopt($ch, CURLOPT_POSTFIELDS, $postFields);
130
+		curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
131
+
132
+		$response = curl_exec($ch);
133
+
134
+		curl_close($ch);
135
+
136
+		return $response;
137
+	}
138
+
139
+	public function setReturnFormat($format)
140
+	{
141
+		// needed for restoration
142
+		$this->oldFormat = $this->format;
143
+		$this->format    = $format;
144
+		return $this->format;
145
+	}
146
+
147
+	private function restoreFormat()
148
+	{
149
+		if (!empty($this->oldFormat)) {
150
+			$this->format = $this->oldFormat;
151
+		}
152
+		return $this->format;
153
+	}
154
+
155
+	// expect url, shortened url or hash
156
+	public function getHash($message)
157
+	{
158
+		// if url and not bit.ly get shortened first
159
+		if (strstr($message, 'http://') && !strstr($message, 'http://bit.ly')) {
160
+			$message = $this->shortenSingle($message);
161
+		}
162
+		$hash = str_replace('http://bit.ly/', '', $message);
163
+		return $hash;
164
+	}
165
+
166
+	public function shortenSingle($message)
167
+	{
168
+		$this->setReturnFormat('json');
169
+		$data = json_decode($this->shorten($message), true);
170
+		// return to previous state.
171
+		$this->restoreFormat();
172
+
173
+		// replace every long url with short one
174
+		foreach ($data['results'] as $url => $d) {
175
+			$message = str_replace($url, $d['shortUrl'], $message);
176
+		}
177
+		return $message;
178
+	}
179
+
180
+	public function expandSingle($shortUrl)
181
+	{
182
+		$this->setReturnFormat('json');
183
+		$data = json_decode($this->expand($shortUrl), true);
184
+		$this->restoreFormat();
185
+		return $data['results'][$this->getHash($shortUrl)]['longUrl'];
186
+	}
187
+
188
+	public function getInfoArray($url)
189
+	{
190
+		$this->setReturnFormat('json');
191
+		$json = $this->info($url);
192
+		$this->restoreFormat();
193
+		$data = json_decode($json, true);
194
+
195
+		$this->infoArray = array_pop($data['results']);
196
+		return $this->infoArray;
197
+	}
198
+
199
+	public function getStatsArray($url)
200
+	{
201
+		$this->setReturnFormat('json');
202
+		$json = $this->stats($url);
203
+		$this->restoreFormat();
204
+		$data             = json_decode($json, true);
205
+		$this->statsArray = $data['results'];
206
+		return $this->statsArray;
207
+	}
208
+
209
+	public function getClicks()
210
+	{
211
+		return $this->statsArray['clicks'];
212
+	}
213
+
214
+	// get thumbnail (small, middle, large)
215
+	public function getThumbnail($size = 'small')
216
+	{
217
+		if (!in_array($size, array('small', 'medium', 'large'))) {
218
+			throw new Exception('Invalid size value');
219
+		}
220
+		if (empty($this->infoArray)) {
221
+			throw new Exception('Info not loaded');
222
+		}
223
+		return $this->infoArray['thumbnail'][$size];
224
+	}
225
+
226
+	public function getTitle()
227
+	{
228
+		return $this->infoArray['htmlTitle'];
229
+	}
230 230
 }
Please login to merge, or discard this patch.
Spacing   +8 added lines, -8 removed lines patch added patch discarded remove patch
@@ -84,7 +84,7 @@  discard block
 block discarded – undo
84 84
             $curr = $matches[0][$i];
85 85
             // ignore bitly urls
86 86
             if (!strstr($curr, 'http://bit.ly')) {
87
-                $postFields .= '&longUrl=' . urlencode($curr);
87
+                $postFields .= '&longUrl='.urlencode($curr);
88 88
             }
89 89
         }
90 90
 
@@ -97,14 +97,14 @@  discard block
 block discarded – undo
97 97
 
98 98
     public function expand($message)
99 99
     {
100
-        $postFields = '&hash=' . $this->getHash($message);
100
+        $postFields = '&hash='.$this->getHash($message);
101 101
         return $this->process('expand', $postFields);
102 102
     }
103 103
 
104 104
     public function info($bitlyUrl)
105 105
     {
106 106
         $hash       = $this->getHash($bitlyUrl);
107
-        $postFields = '&hash=' . $hash;
107
+        $postFields = '&hash='.$hash;
108 108
         return $this->process('info', $postFields);
109 109
     }
110 110
 
@@ -112,19 +112,19 @@  discard block
 block discarded – undo
112 112
     {
113 113
         // Take only first hash or url. Ignore others.
114 114
         $a          = split(',', $bitlyUrl);
115
-        $postFields = '&hash=' . $this->getHash($a[0]);
115
+        $postFields = '&hash='.$this->getHash($a[0]);
116 116
         return $this->process('stats', $postFields);
117 117
     }
118 118
 
119 119
     protected function process($action, $postFields)
120 120
     {
121
-        $ch = curl_init($this->api . $action);
121
+        $ch = curl_init($this->api.$action);
122 122
 
123
-        $postFields = 'version=' . $this->version . $postFields;
124
-        $postFields .= '&format=' . $this->format;
123
+        $postFields = 'version='.$this->version.$postFields;
124
+        $postFields .= '&format='.$this->format;
125 125
         $postFields .= '&history=1';
126 126
 
127
-        curl_setopt($ch, CURLOPT_USERPWD, $this->login . ':' . $this->apiKey);
127
+        curl_setopt($ch, CURLOPT_USERPWD, $this->login.':'.$this->apiKey);
128 128
         curl_setopt($ch, CURLOPT_POST, 1);
129 129
         curl_setopt($ch, CURLOPT_POSTFIELDS, $postFields);
130 130
         curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
Please login to merge, or discard this patch.
class/PEAR.php 3 patches
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -492,7 +492,7 @@
 block discarded – undo
492 492
      * handling applied.  If the $mode and $options parameters are not
493 493
      * specified, the object's defaults are used.
494 494
      *
495
-     * @param mixed  $message     a text error message or a PEAR error object
495
+     * @param string|null  $message     a text error message or a PEAR error object
496 496
      *
497 497
      * @param int    $code        a numeric error code (it is up to your class
498 498
      *                            to define these if you want to use codes)
Please login to merge, or discard this patch.
Indentation   +980 added lines, -980 removed lines patch added patch discarded remove patch
@@ -40,25 +40,25 @@  discard block
 block discarded – undo
40 40
 define('references_PEAR_ERROR_EXCEPTION', 32);
41 41
 /**#@-*/
42 42
 define('references_PEAR_ZE2', function_exists('version_compare')
43
-                              && version_compare(zend_version(), '2-dev', 'ge'));
43
+							  && version_compare(zend_version(), '2-dev', 'ge'));
44 44
 
45 45
 if (substr(PHP_OS, 0, 3) == 'WIN') {
46
-    define('references_OS_WINDOWS', true);
47
-    define('references_OS_UNIX', false);
48
-    define('references_PEAR_OS', 'Windows');
46
+	define('references_OS_WINDOWS', true);
47
+	define('references_OS_UNIX', false);
48
+	define('references_PEAR_OS', 'Windows');
49 49
 } else {
50
-    define('references_OS_WINDOWS', false);
51
-    define('references_OS_UNIX', true);
52
-    define('references_PEAR_OS', 'Unix'); // blatant assumption
50
+	define('references_OS_WINDOWS', false);
51
+	define('references_OS_UNIX', true);
52
+	define('references_PEAR_OS', 'Unix'); // blatant assumption
53 53
 }
54 54
 
55 55
 // instant backwards compatibility
56 56
 if (!defined('PATH_SEPARATOR')) {
57
-    if (references_OS_WINDOWS) {
58
-        define('PATH_SEPARATOR', ';');
59
-    } else {
60
-        define('PATH_SEPARATOR', ':');
61
-    }
57
+	if (references_OS_WINDOWS) {
58
+		define('PATH_SEPARATOR', ';');
59
+	} else {
60
+		define('PATH_SEPARATOR', ':');
61
+	}
62 62
 }
63 63
 
64 64
 $GLOBALS['_PEAR_default_error_mode']     = references_PEAR_ERROR_RETURN;
@@ -101,712 +101,712 @@  discard block
 block discarded – undo
101 101
  */
102 102
 class references_PEAR
103 103
 {
104
-    // {{{ properties
105
-
106
-    /**
107
-     * Whether to enable internal debug messages.
108
-     *
109
-     * @var bool
110
-     * @access  private
111
-     */
112
-    public $_debug = false;
113
-
114
-    /**
115
-     * Default error mode for this object.
116
-     *
117
-     * @var int
118
-     * @access  private
119
-     */
120
-    public $_default_error_mode = null;
121
-
122
-    /**
123
-     * Default error options used for this object when error mode
124
-     * is references_PEAR_ERROR_TRIGGER.
125
-     *
126
-     * @var int
127
-     * @access  private
128
-     */
129
-    public $_default_error_options = null;
130
-
131
-    /**
132
-     * Default error handler (callback) for this object, if error mode is
133
-     * references_PEAR_ERROR_CALLBACK.
134
-     *
135
-     * @var string
136
-     * @access  private
137
-     */
138
-    public $_default_error_handler = '';
139
-
140
-    /**
141
-     * Which class to use for error objects.
142
-     *
143
-     * @var string
144
-     * @access  private
145
-     */
146
-    public $_error_class = 'PEAR_Error';
147
-
148
-    /**
149
-     * An array of expected errors.
150
-     *
151
-     * @var array
152
-     * @access  private
153
-     */
154
-    public $_expected_errors = array();
155
-
156
-    // }}}
157
-
158
-    // {{{ constructor
159
-
160
-    /**
161
-     * Constructor.  Registers this object in
162
-     * $_PEAR_destructor_object_list for destructor emulation if a
163
-     * destructor object exists.
164
-     *
165
-     * @param  string $error_class (optional) which class to use for
166
-     *                             error objects, defaults to PEAR_Error.
167
-     * @access public
168
-     */
169
-    public function __construct($error_class = null)
170
-    {
171
-        $classname = strtolower(get_class($this));
172
-        if ($this->_debug) {
173
-            print "PEAR constructor called, class=$classname\n";
174
-        }
175
-        if ($error_class !== null) {
176
-            $this->_error_class = $error_class;
177
-        }
178
-        while ($classname && strcasecmp($classname, 'pear')) {
179
-            $destructor = "_$classname";
180
-            if (method_exists($this, $destructor)) {
181
-                global $_PEAR_destructor_object_list;
182
-                $_PEAR_destructor_object_list[] = &$this;
183
-                if (!isset($GLOBALS['_PEAR_SHUTDOWN_REGISTERED'])) {
184
-                    register_shutdown_function('references_PEAR_call_destructors');
185
-                    $GLOBALS['_PEAR_SHUTDOWN_REGISTERED'] = true;
186
-                }
187
-                break;
188
-            } else {
189
-                $classname = get_parent_class($classname);
190
-            }
191
-        }
192
-    }
193
-
194
-    // }}}
195
-    // {{{ destructor
196
-
197
-    /**
198
-     * Destructor (the emulated type of...).  Does nothing right now,
199
-     * but is included for forward compatibility, so subclass
200
-     * destructors should always call it.
201
-     *
202
-     * See the note in the class desciption about output from
203
-     * destructors.
204
-     *
205
-     * @access public
206
-     * @return void
207
-     */
208
-    public function _PEAR()
209
-    {
210
-        if ($this->_debug) {
211
-            printf("PEAR destructor called, class=%s\n", strtolower(get_class($this)));
212
-        }
213
-    }
214
-
215
-    // }}}
216
-    // {{{ getStaticProperty()
217
-
218
-    /**
219
-     * If you have a class that's mostly/entirely static, and you need static
220
-     * properties, you can use this method to simulate them. Eg. in your method(s)
221
-     * do this: $myVar = &references_PEAR::getStaticProperty('myclass', 'myVar');
222
-     * You MUST use a reference, or they will not persist!
223
-     *
224
-     * @access public
225
-     * @param  string $class The calling classname, to prevent clashes
226
-     * @param  string $var   The variable to retrieve.
227
-     * @return mixed   A reference to the variable. If not set it will be
228
-     *                       auto initialised to NULL.
229
-     */
230
-    public function &getStaticProperty($class, $var)
231
-    {
232
-        static $properties;
233
-        if (!isset($properties[$class])) {
234
-            $properties[$class] = array();
235
-        }
236
-        if (!array_key_exists($var, $properties[$class])) {
237
-            $properties[$class][$var] = null;
238
-        }
239
-
240
-        return $properties[$class][$var];
241
-    }
242
-
243
-    // }}}
244
-    // {{{ registerShutdownFunc()
245
-
246
-    /**
247
-     * Use this function to register a shutdown method for static
248
-     * classes.
249
-     *
250
-     * @access public
251
-     * @param  mixed $func The function name (or array of class/method) to call
252
-     * @param  mixed $args The arguments to pass to the function
253
-     * @return void
254
-     */
255
-    public function registerShutdownFunc($func, $args = array())
256
-    {
257
-        // if we are called statically, there is a potential
258
-        // that no shutdown func is registered.  Bug #6445
259
-        if (!isset($GLOBALS['_PEAR_SHUTDOWN_REGISTERED'])) {
260
-            register_shutdown_function('references__PEAR_call_destructors');
261
-            $GLOBALS['_PEAR_SHUTDOWN_REGISTERED'] = true;
262
-        }
263
-        $GLOBALS['_PEAR_shutdown_funcs'][] = array($func, $args);
264
-    }
265
-
266
-    // }}}
267
-    // {{{ isError()
268
-
269
-    /**
270
-     * Tell whether a value is a PEAR error.
271
-     *
272
-     * @param  mixed $data the value to test
273
-     * @param  int   $code if $data is an error object, return true
274
-     *                     only if $code is a string and
275
-     *                     $obj->getMessage() == $code or
276
-     *                     $code is an integer and $obj->getCode() == $code
277
-     * @access  public
278
-     * @return bool  true if parameter is an error
279
-     */
280
-    public function isError($data, $code = null)
281
-    {
282
-        if (is_a($data, 'PEAR_Error')) {
283
-            if (is_null($code)) {
284
-                return true;
285
-            } elseif (is_string($code)) {
286
-                return $data->getMessage() == $code;
287
-            } else {
288
-                return $data->getCode() == $code;
289
-            }
290
-        }
291
-
292
-        return false;
293
-    }
294
-
295
-    // }}}
296
-    // {{{ setErrorHandling()
297
-
298
-    /**
299
-     * Sets how errors generated by this object should be handled.
300
-     * Can be invoked both in objects and statically.  If called
301
-     * statically, setErrorHandling sets the default behaviour for all
302
-     * PEAR objects.  If called in an object, setErrorHandling sets
303
-     * the default behaviour for that object.
304
-     *
305
-     * @param int   $mode
306
-     *                       One of references_PEAR_ERROR_RETURN, references_PEAR_ERROR_PRINT,
307
-     *                       references_PEAR_ERROR_TRIGGER, references_PEAR_ERROR_DIE,
308
-     *                       references_PEAR_ERROR_CALLBACK or references_PEAR_ERROR_EXCEPTION.
309
-     *
310
-     * @param mixed $options
311
-     *                       When $mode is references_PEAR_ERROR_TRIGGER, this is the error level (one
312
-     *                       of E_USER_NOTICE, E_USER_WARNING or E_USER_ERROR).
313
-     *
314
-     *        When $mode is references_PEAR_ERROR_CALLBACK, this parameter is expected
315
-     *        to be the callback function or method.  A callback
316
-     *        function is a string with the name of the function, a
317
-     *        callback method is an array of two elements: the element
318
-     *        at index 0 is the object, and the element at index 1 is
319
-     *        the name of the method to call in the object.
320
-     *
321
-     *        When $mode is references_PEAR_ERROR_PRINT or references_PEAR_ERROR_DIE, this is
322
-     *        a printf format string used when printing the error
323
-     *        message.
324
-     *
325
-     * @access public
326
-     * @return void
327
-     * @see    references_PEAR_ERROR_RETURN
328
-     * @see    references_PEAR_ERROR_PRINT
329
-     * @see    references_PEAR_ERROR_TRIGGER
330
-     * @see    references_PEAR_ERROR_DIE
331
-     * @see    references_PEAR_ERROR_CALLBACK
332
-     * @see    references_PEAR_ERROR_EXCEPTION
333
-     *
334
-     */
335
-
336
-    public function setErrorHandling($mode = null, $options = null)
337
-    {
338
-        if (isset($this) && is_a($this, 'PEAR')) {
339
-            $setmode    = &$this->_default_error_mode;
340
-            $setoptions = &$this->_default_error_options;
341
-        } else {
342
-            $setmode    = &$GLOBALS['_PEAR_default_error_mode'];
343
-            $setoptions = &$GLOBALS['_PEAR_default_error_options'];
344
-        }
345
-
346
-        switch ($mode) {
347
-            case references_PEAR_ERROR_EXCEPTION:
348
-            case references_PEAR_ERROR_RETURN:
349
-            case references_PEAR_ERROR_PRINT:
350
-            case references_PEAR_ERROR_TRIGGER:
351
-            case references_PEAR_ERROR_DIE:
352
-            case null:
353
-                $setmode    = $mode;
354
-                $setoptions = $options;
355
-                break;
356
-
357
-            case references_PEAR_ERROR_CALLBACK:
358
-                $setmode = $mode;
359
-                // class/object method callback
360
-                if (is_callable($options)) {
361
-                    $setoptions = $options;
362
-                } else {
363
-                    trigger_error('invalid error callback', E_USER_WARNING);
364
-                }
365
-                break;
366
-
367
-            default:
368
-                trigger_error('invalid error mode', E_USER_WARNING);
369
-                break;
370
-        }
371
-    }
372
-
373
-    // }}}
374
-    // {{{ expectError()
375
-
376
-    /**
377
-     * This method is used to tell which errors you expect to get.
378
-     * Expected errors are always returned with error mode
379
-     * references_PEAR_ERROR_RETURN.  Expected error codes are stored in a stack,
380
-     * and this method pushes a new element onto it.  The list of
381
-     * expected errors are in effect until they are popped off the
382
-     * stack with the popExpect() method.
383
-     *
384
-     * Note that this method can not be called statically
385
-     *
386
-     * @param mixed $code a single error code or an array of error codes to expect
387
-     *
388
-     * @return int the new depth of the "expected errors" stack
389
-     * @access public
390
-     */
391
-    public function expectError($code = '*')
392
-    {
393
-        if (is_array($code)) {
394
-            array_push($this->_expected_errors, $code);
395
-        } else {
396
-            array_push($this->_expected_errors, array($code));
397
-        }
398
-
399
-        return count($this->_expected_errors);
400
-    }
401
-
402
-    // }}}
403
-    // {{{ popExpect()
404
-
405
-    /**
406
-     * This method pops one element off the expected error codes
407
-     * stack.
408
-     *
409
-     * @return array the list of error codes that were popped
410
-     */
411
-    public function popExpect()
412
-    {
413
-        return array_pop($this->_expected_errors);
414
-    }
415
-
416
-    // }}}
417
-    // {{{ _checkDelExpect()
418
-
419
-    /**
420
-     * This method checks unsets an error code if available
421
-     *
422
-     * @param mixed error code
423
-     * @return bool true if the error code was unset, false otherwise
424
-     * @access private
425
-     */
426
-    public function _checkDelExpect($error_code)
427
-    {
428
-        $deleted = false;
429
-
430
-        foreach ($this->_expected_errors as $key => $error_array) {
431
-            if (in_array($error_code, $error_array)) {
432
-                unset($this->_expected_errors[$key][array_search($error_code, $error_array)]);
433
-                $deleted = true;
434
-            }
435
-
436
-            // clean up empty arrays
437
-            if (0 == count($this->_expected_errors[$key])) {
438
-                unset($this->_expected_errors[$key]);
439
-            }
440
-        }
441
-
442
-        return $deleted;
443
-    }
444
-
445
-    // }}}
446
-    // {{{ delExpect()
447
-
448
-    /**
449
-     * This method deletes all occurences of the specified element from
450
-     * the expected error codes stack.
451
-     *
452
-     * @param  mixed $error_code error code that should be deleted
453
-     * @return mixed list of error codes that were deleted or error
454
-     * @access public
455
-     */
456
-    public function delExpect($error_code)
457
-    {
458
-        $deleted = false;
459
-
460
-        if (is_array($error_code) && (0 != count($error_code))) {
461
-            // $error_code is a non-empty array here;
462
-            // we walk through it trying to unset all
463
-            // values
464
-            foreach ($error_code as $key => $error) {
465
-                if ($this->_checkDelExpect($error)) {
466
-                    $deleted = true;
467
-                } else {
468
-                    $deleted = false;
469
-                }
470
-            }
471
-
472
-            return $deleted ? true : references_PEAR::raiseError('The expected error you submitted does not exist'); // IMPROVE ME
473
-        } elseif (!empty($error_code)) {
474
-            // $error_code comes alone, trying to unset it
475
-            if ($this->_checkDelExpect($error_code)) {
476
-                return true;
477
-            } else {
478
-                return references_PEAR::raiseError('The expected error you submitted does not exist'); // IMPROVE ME
479
-            }
480
-        } else {
481
-            // $error_code is empty
482
-            return references_PEAR::raiseError('The expected error you submitted is empty'); // IMPROVE ME
483
-        }
484
-    }
485
-
486
-    // }}}
487
-    // {{{ raiseError()
488
-
489
-    /**
490
-     * This method is a wrapper that returns an instance of the
491
-     * configured error class with this object's default error
492
-     * handling applied.  If the $mode and $options parameters are not
493
-     * specified, the object's defaults are used.
494
-     *
495
-     * @param mixed  $message     a text error message or a PEAR error object
496
-     *
497
-     * @param int    $code        a numeric error code (it is up to your class
498
-     *                            to define these if you want to use codes)
499
-     *
500
-     * @param int    $mode        One of references_PEAR_ERROR_RETURN, references_PEAR_ERROR_PRINT,
501
-     *                            references_PEAR_ERROR_TRIGGER, references_PEAR_ERROR_DIE,
502
-     *                            references_PEAR_ERROR_CALLBACK, references_PEAR_ERROR_EXCEPTION.
503
-     *
504
-     * @param mixed  $options     If $mode is references_PEAR_ERROR_TRIGGER, this parameter
505
-     *                            specifies the PHP-internal error level (one of
506
-     *                            E_USER_NOTICE, E_USER_WARNING or E_USER_ERROR).
507
-     *                            If $mode is references_PEAR_ERROR_CALLBACK, this
508
-     *                            parameter specifies the callback function or
509
-     *                            method.  In other error modes this parameter
510
-     *                            is ignored.
511
-     *
512
-     * @param string $userinfo    If you need to pass along for example debug
513
-     *                            information, this parameter is meant for that.
514
-     *
515
-     * @param string $error_class The returned error object will be
516
-     *                            instantiated from this class, if specified.
517
-     *
518
-     * @param bool   $skipmsg     If true, raiseError will only pass error codes,
519
-     *                            the error message parameter will be dropped.
520
-     *
521
-     * @access public
522
-     * @return object a PEAR error object
523
-     * @see    references_PEAR::setErrorHandling
524
-     * @since  PHP 4.0.5
525
-     */
526
-    public function &raiseError($message = null, $code = null, $mode = null, $options = null, $userinfo = null, $error_class = null, $skipmsg = false)
527
-    {
528
-        // The error is yet a PEAR error object
529
-        if (is_object($message)) {
530
-            $code                          = $message->getCode();
531
-            $userinfo                      = $message->getUserInfo();
532
-            $error_class                   = $message->getType();
533
-            $message->error_message_prefix = '';
534
-            $message                       = $message->getMessage();
535
-        }
536
-
537
-        if (isset($this) && isset($this->_expected_errors) && count($this->_expected_errors) > 0 && count($exp = end($this->_expected_errors))) {
538
-            if ($exp[0] === '*'
539
-                || (is_int(reset($exp)) && in_array($code, $exp))
540
-                || (is_string(reset($exp)) && in_array($message, $exp))
541
-            ) {
542
-                $mode = references_PEAR_ERROR_RETURN;
543
-            }
544
-        }
545
-        // No mode given, try global ones
546
-        if ($mode === null) {
547
-            // Class error handler
548
-            if (isset($this) && isset($this->_default_error_mode)) {
549
-                $mode    = $this->_default_error_mode;
550
-                $options = $this->_default_error_options;
551
-                // Global error handler
552
-            } elseif (isset($GLOBALS['_PEAR_default_error_mode'])) {
553
-                $mode    = $GLOBALS['_PEAR_default_error_mode'];
554
-                $options = $GLOBALS['_PEAR_default_error_options'];
555
-            }
556
-        }
557
-
558
-        if ($error_class !== null) {
559
-            $ec = $error_class;
560
-        } elseif (isset($this) && isset($this->_error_class)) {
561
-            $ec = $this->_error_class;
562
-        } else {
563
-            $ec = 'references_PEAR_Error';
564
-        }
565
-        if ($skipmsg) {
566
-            $a = new $ec($code, $mode, $options, $userinfo);
567
-
568
-            return $a;
569
-        } else {
570
-            $a = new $ec($message, $code, $mode, $options, $userinfo);
571
-
572
-            return $a;
573
-        }
574
-    }
575
-
576
-    // }}}
577
-    // {{{ throwError()
578
-
579
-    /**
580
-     * Simpler form of raiseError with fewer options.  In most cases
581
-     * message, code and userinfo are enough.
582
-     *
583
-     * @param string $message
584
-     *
585
-     * @param null   $code
586
-     * @param null   $userinfo
587
-     * @return object
588
-     */
589
-    public function &throwError($message = null, $code = null, $userinfo = null)
590
-    {
591
-        if (isset($this) && is_a($this, 'PEAR')) {
592
-            $a = &$this->raiseError($message, $code, null, null, $userinfo);
593
-
594
-            return $a;
595
-        } else {
596
-            $a = &references_PEAR::raiseError($message, $code, null, null, $userinfo);
597
-
598
-            return $a;
599
-        }
600
-    }
601
-
602
-    // }}}
603
-    public function staticPushErrorHandling($mode, $options = null)
604
-    {
605
-        $stack       = &$GLOBALS['_PEAR_error_handler_stack'];
606
-        $def_mode    = &$GLOBALS['_PEAR_default_error_mode'];
607
-        $def_options = &$GLOBALS['_PEAR_default_error_options'];
608
-        $stack[]     = array($def_mode, $def_options);
609
-        switch ($mode) {
610
-            case references_PEAR_ERROR_EXCEPTION:
611
-            case references_PEAR_ERROR_RETURN:
612
-            case references_PEAR_ERROR_PRINT:
613
-            case references_PEAR_ERROR_TRIGGER:
614
-            case references_PEAR_ERROR_DIE:
615
-            case null:
616
-                $def_mode    = $mode;
617
-                $def_options = $options;
618
-                break;
619
-
620
-            case references_PEAR_ERROR_CALLBACK:
621
-                $def_mode = $mode;
622
-                // class/object method callback
623
-                if (is_callable($options)) {
624
-                    $def_options = $options;
625
-                } else {
626
-                    trigger_error('invalid error callback', E_USER_WARNING);
627
-                }
628
-                break;
629
-
630
-            default:
631
-                trigger_error('invalid error mode', E_USER_WARNING);
632
-                break;
633
-        }
634
-        $stack[] = array($mode, $options);
635
-
636
-        return true;
637
-    }
638
-
639
-    public function staticPopErrorHandling()
640
-    {
641
-        $stack      = &$GLOBALS['_PEAR_error_handler_stack'];
642
-        $setmode    = &$GLOBALS['_PEAR_default_error_mode'];
643
-        $setoptions = &$GLOBALS['_PEAR_default_error_options'];
644
-        array_pop($stack);
645
-        list($mode, $options) = $stack[count($stack) - 1];
646
-        array_pop($stack);
647
-        switch ($mode) {
648
-            case references_PEAR_ERROR_EXCEPTION:
649
-            case references_PEAR_ERROR_RETURN:
650
-            case references_PEAR_ERROR_PRINT:
651
-            case references_PEAR_ERROR_TRIGGER:
652
-            case references_PEAR_ERROR_DIE:
653
-            case null:
654
-                $setmode    = $mode;
655
-                $setoptions = $options;
656
-                break;
657
-
658
-            case references_PEAR_ERROR_CALLBACK:
659
-                $setmode = $mode;
660
-                // class/object method callback
661
-                if (is_callable($options)) {
662
-                    $setoptions = $options;
663
-                } else {
664
-                    trigger_error('invalid error callback', E_USER_WARNING);
665
-                }
666
-                break;
667
-
668
-            default:
669
-                trigger_error('invalid error mode', E_USER_WARNING);
670
-                break;
671
-        }
672
-
673
-        return true;
674
-    }
675
-
676
-    // {{{ pushErrorHandling()
677
-
678
-    /**
679
-     * Push a new error handler on top of the error handler options stack. With this
680
-     * you can easily override the actual error handler for some code and restore
681
-     * it later with popErrorHandling.
682
-     *
683
-     * @param mixed $mode    (same as setErrorHandling)
684
-     * @param mixed $options (same as setErrorHandling)
685
-     *
686
-     * @return bool Always true
687
-     *
688
-     * @see references_PEAR::setErrorHandling
689
-     */
690
-    public function pushErrorHandling($mode, $options = null)
691
-    {
692
-        $stack = &$GLOBALS['_PEAR_error_handler_stack'];
693
-        if (isset($this) && is_a($this, 'PEAR')) {
694
-            $def_mode    = &$this->_default_error_mode;
695
-            $def_options = &$this->_default_error_options;
696
-        } else {
697
-            $def_mode    = &$GLOBALS['_PEAR_default_error_mode'];
698
-            $def_options = &$GLOBALS['_PEAR_default_error_options'];
699
-        }
700
-        $stack[] = array($def_mode, $def_options);
701
-
702
-        if (isset($this) && is_a($this, 'PEAR')) {
703
-            $this->setErrorHandling($mode, $options);
704
-        } else {
705
-            references_PEAR::setErrorHandling($mode, $options);
706
-        }
707
-        $stack[] = array($mode, $options);
708
-
709
-        return true;
710
-    }
711
-
712
-    // }}}
713
-    // {{{ popErrorHandling()
714
-
715
-    /**
716
-     * Pop the last error handler used
717
-     *
718
-     * @return bool Always true
719
-     *
720
-     * @see references_PEAR::pushErrorHandling
721
-     */
722
-    public function popErrorHandling()
723
-    {
724
-        $stack = &$GLOBALS['_PEAR_error_handler_stack'];
725
-        array_pop($stack);
726
-        list($mode, $options) = $stack[count($stack) - 1];
727
-        array_pop($stack);
728
-        if (isset($this) && is_a($this, 'PEAR')) {
729
-            $this->setErrorHandling($mode, $options);
730
-        } else {
731
-            references_PEAR::setErrorHandling($mode, $options);
732
-        }
733
-
734
-        return true;
735
-    }
736
-
737
-    // }}}
738
-    // {{{ loadExtension()
739
-
740
-    /**
741
-     * OS independant PHP extension load. Remember to take care
742
-     * on the correct extension name for case sensitive OSes.
743
-     *
744
-     * @param string $ext The extension name
745
-     * @return bool Success or not on the dl() call
746
-     */
747
-    public function loadExtension($ext)
748
-    {
749
-        if (!extension_loaded($ext)) {
750
-            // if either returns true dl() will produce a FATAL error, stop that
751
-            if ((ini_get('enable_dl') != 1) || (ini_get('safe_mode') == 1)) {
752
-                return false;
753
-            }
754
-            if (references_OS_WINDOWS) {
755
-                $suffix = '.dll';
756
-            } elseif (PHP_OS === 'HP-UX') {
757
-                $suffix = '.sl';
758
-            } elseif (PHP_OS === 'AIX') {
759
-                $suffix = '.a';
760
-            } elseif (PHP_OS === 'OSX') {
761
-                $suffix = '.bundle';
762
-            } else {
763
-                $suffix = '.so';
764
-            }
765
-
766
-            return @dl('php_' . $ext . $suffix) || @dl($ext . $suffix);
767
-        }
768
-
769
-        return true;
770
-    }
771
-
772
-    // }}}
104
+	// {{{ properties
105
+
106
+	/**
107
+	 * Whether to enable internal debug messages.
108
+	 *
109
+	 * @var bool
110
+	 * @access  private
111
+	 */
112
+	public $_debug = false;
113
+
114
+	/**
115
+	 * Default error mode for this object.
116
+	 *
117
+	 * @var int
118
+	 * @access  private
119
+	 */
120
+	public $_default_error_mode = null;
121
+
122
+	/**
123
+	 * Default error options used for this object when error mode
124
+	 * is references_PEAR_ERROR_TRIGGER.
125
+	 *
126
+	 * @var int
127
+	 * @access  private
128
+	 */
129
+	public $_default_error_options = null;
130
+
131
+	/**
132
+	 * Default error handler (callback) for this object, if error mode is
133
+	 * references_PEAR_ERROR_CALLBACK.
134
+	 *
135
+	 * @var string
136
+	 * @access  private
137
+	 */
138
+	public $_default_error_handler = '';
139
+
140
+	/**
141
+	 * Which class to use for error objects.
142
+	 *
143
+	 * @var string
144
+	 * @access  private
145
+	 */
146
+	public $_error_class = 'PEAR_Error';
147
+
148
+	/**
149
+	 * An array of expected errors.
150
+	 *
151
+	 * @var array
152
+	 * @access  private
153
+	 */
154
+	public $_expected_errors = array();
155
+
156
+	// }}}
157
+
158
+	// {{{ constructor
159
+
160
+	/**
161
+	 * Constructor.  Registers this object in
162
+	 * $_PEAR_destructor_object_list for destructor emulation if a
163
+	 * destructor object exists.
164
+	 *
165
+	 * @param  string $error_class (optional) which class to use for
166
+	 *                             error objects, defaults to PEAR_Error.
167
+	 * @access public
168
+	 */
169
+	public function __construct($error_class = null)
170
+	{
171
+		$classname = strtolower(get_class($this));
172
+		if ($this->_debug) {
173
+			print "PEAR constructor called, class=$classname\n";
174
+		}
175
+		if ($error_class !== null) {
176
+			$this->_error_class = $error_class;
177
+		}
178
+		while ($classname && strcasecmp($classname, 'pear')) {
179
+			$destructor = "_$classname";
180
+			if (method_exists($this, $destructor)) {
181
+				global $_PEAR_destructor_object_list;
182
+				$_PEAR_destructor_object_list[] = &$this;
183
+				if (!isset($GLOBALS['_PEAR_SHUTDOWN_REGISTERED'])) {
184
+					register_shutdown_function('references_PEAR_call_destructors');
185
+					$GLOBALS['_PEAR_SHUTDOWN_REGISTERED'] = true;
186
+				}
187
+				break;
188
+			} else {
189
+				$classname = get_parent_class($classname);
190
+			}
191
+		}
192
+	}
193
+
194
+	// }}}
195
+	// {{{ destructor
196
+
197
+	/**
198
+	 * Destructor (the emulated type of...).  Does nothing right now,
199
+	 * but is included for forward compatibility, so subclass
200
+	 * destructors should always call it.
201
+	 *
202
+	 * See the note in the class desciption about output from
203
+	 * destructors.
204
+	 *
205
+	 * @access public
206
+	 * @return void
207
+	 */
208
+	public function _PEAR()
209
+	{
210
+		if ($this->_debug) {
211
+			printf("PEAR destructor called, class=%s\n", strtolower(get_class($this)));
212
+		}
213
+	}
214
+
215
+	// }}}
216
+	// {{{ getStaticProperty()
217
+
218
+	/**
219
+	 * If you have a class that's mostly/entirely static, and you need static
220
+	 * properties, you can use this method to simulate them. Eg. in your method(s)
221
+	 * do this: $myVar = &references_PEAR::getStaticProperty('myclass', 'myVar');
222
+	 * You MUST use a reference, or they will not persist!
223
+	 *
224
+	 * @access public
225
+	 * @param  string $class The calling classname, to prevent clashes
226
+	 * @param  string $var   The variable to retrieve.
227
+	 * @return mixed   A reference to the variable. If not set it will be
228
+	 *                       auto initialised to NULL.
229
+	 */
230
+	public function &getStaticProperty($class, $var)
231
+	{
232
+		static $properties;
233
+		if (!isset($properties[$class])) {
234
+			$properties[$class] = array();
235
+		}
236
+		if (!array_key_exists($var, $properties[$class])) {
237
+			$properties[$class][$var] = null;
238
+		}
239
+
240
+		return $properties[$class][$var];
241
+	}
242
+
243
+	// }}}
244
+	// {{{ registerShutdownFunc()
245
+
246
+	/**
247
+	 * Use this function to register a shutdown method for static
248
+	 * classes.
249
+	 *
250
+	 * @access public
251
+	 * @param  mixed $func The function name (or array of class/method) to call
252
+	 * @param  mixed $args The arguments to pass to the function
253
+	 * @return void
254
+	 */
255
+	public function registerShutdownFunc($func, $args = array())
256
+	{
257
+		// if we are called statically, there is a potential
258
+		// that no shutdown func is registered.  Bug #6445
259
+		if (!isset($GLOBALS['_PEAR_SHUTDOWN_REGISTERED'])) {
260
+			register_shutdown_function('references__PEAR_call_destructors');
261
+			$GLOBALS['_PEAR_SHUTDOWN_REGISTERED'] = true;
262
+		}
263
+		$GLOBALS['_PEAR_shutdown_funcs'][] = array($func, $args);
264
+	}
265
+
266
+	// }}}
267
+	// {{{ isError()
268
+
269
+	/**
270
+	 * Tell whether a value is a PEAR error.
271
+	 *
272
+	 * @param  mixed $data the value to test
273
+	 * @param  int   $code if $data is an error object, return true
274
+	 *                     only if $code is a string and
275
+	 *                     $obj->getMessage() == $code or
276
+	 *                     $code is an integer and $obj->getCode() == $code
277
+	 * @access  public
278
+	 * @return bool  true if parameter is an error
279
+	 */
280
+	public function isError($data, $code = null)
281
+	{
282
+		if (is_a($data, 'PEAR_Error')) {
283
+			if (is_null($code)) {
284
+				return true;
285
+			} elseif (is_string($code)) {
286
+				return $data->getMessage() == $code;
287
+			} else {
288
+				return $data->getCode() == $code;
289
+			}
290
+		}
291
+
292
+		return false;
293
+	}
294
+
295
+	// }}}
296
+	// {{{ setErrorHandling()
297
+
298
+	/**
299
+	 * Sets how errors generated by this object should be handled.
300
+	 * Can be invoked both in objects and statically.  If called
301
+	 * statically, setErrorHandling sets the default behaviour for all
302
+	 * PEAR objects.  If called in an object, setErrorHandling sets
303
+	 * the default behaviour for that object.
304
+	 *
305
+	 * @param int   $mode
306
+	 *                       One of references_PEAR_ERROR_RETURN, references_PEAR_ERROR_PRINT,
307
+	 *                       references_PEAR_ERROR_TRIGGER, references_PEAR_ERROR_DIE,
308
+	 *                       references_PEAR_ERROR_CALLBACK or references_PEAR_ERROR_EXCEPTION.
309
+	 *
310
+	 * @param mixed $options
311
+	 *                       When $mode is references_PEAR_ERROR_TRIGGER, this is the error level (one
312
+	 *                       of E_USER_NOTICE, E_USER_WARNING or E_USER_ERROR).
313
+	 *
314
+	 *        When $mode is references_PEAR_ERROR_CALLBACK, this parameter is expected
315
+	 *        to be the callback function or method.  A callback
316
+	 *        function is a string with the name of the function, a
317
+	 *        callback method is an array of two elements: the element
318
+	 *        at index 0 is the object, and the element at index 1 is
319
+	 *        the name of the method to call in the object.
320
+	 *
321
+	 *        When $mode is references_PEAR_ERROR_PRINT or references_PEAR_ERROR_DIE, this is
322
+	 *        a printf format string used when printing the error
323
+	 *        message.
324
+	 *
325
+	 * @access public
326
+	 * @return void
327
+	 * @see    references_PEAR_ERROR_RETURN
328
+	 * @see    references_PEAR_ERROR_PRINT
329
+	 * @see    references_PEAR_ERROR_TRIGGER
330
+	 * @see    references_PEAR_ERROR_DIE
331
+	 * @see    references_PEAR_ERROR_CALLBACK
332
+	 * @see    references_PEAR_ERROR_EXCEPTION
333
+	 *
334
+	 */
335
+
336
+	public function setErrorHandling($mode = null, $options = null)
337
+	{
338
+		if (isset($this) && is_a($this, 'PEAR')) {
339
+			$setmode    = &$this->_default_error_mode;
340
+			$setoptions = &$this->_default_error_options;
341
+		} else {
342
+			$setmode    = &$GLOBALS['_PEAR_default_error_mode'];
343
+			$setoptions = &$GLOBALS['_PEAR_default_error_options'];
344
+		}
345
+
346
+		switch ($mode) {
347
+			case references_PEAR_ERROR_EXCEPTION:
348
+			case references_PEAR_ERROR_RETURN:
349
+			case references_PEAR_ERROR_PRINT:
350
+			case references_PEAR_ERROR_TRIGGER:
351
+			case references_PEAR_ERROR_DIE:
352
+			case null:
353
+				$setmode    = $mode;
354
+				$setoptions = $options;
355
+				break;
356
+
357
+			case references_PEAR_ERROR_CALLBACK:
358
+				$setmode = $mode;
359
+				// class/object method callback
360
+				if (is_callable($options)) {
361
+					$setoptions = $options;
362
+				} else {
363
+					trigger_error('invalid error callback', E_USER_WARNING);
364
+				}
365
+				break;
366
+
367
+			default:
368
+				trigger_error('invalid error mode', E_USER_WARNING);
369
+				break;
370
+		}
371
+	}
372
+
373
+	// }}}
374
+	// {{{ expectError()
375
+
376
+	/**
377
+	 * This method is used to tell which errors you expect to get.
378
+	 * Expected errors are always returned with error mode
379
+	 * references_PEAR_ERROR_RETURN.  Expected error codes are stored in a stack,
380
+	 * and this method pushes a new element onto it.  The list of
381
+	 * expected errors are in effect until they are popped off the
382
+	 * stack with the popExpect() method.
383
+	 *
384
+	 * Note that this method can not be called statically
385
+	 *
386
+	 * @param mixed $code a single error code or an array of error codes to expect
387
+	 *
388
+	 * @return int the new depth of the "expected errors" stack
389
+	 * @access public
390
+	 */
391
+	public function expectError($code = '*')
392
+	{
393
+		if (is_array($code)) {
394
+			array_push($this->_expected_errors, $code);
395
+		} else {
396
+			array_push($this->_expected_errors, array($code));
397
+		}
398
+
399
+		return count($this->_expected_errors);
400
+	}
401
+
402
+	// }}}
403
+	// {{{ popExpect()
404
+
405
+	/**
406
+	 * This method pops one element off the expected error codes
407
+	 * stack.
408
+	 *
409
+	 * @return array the list of error codes that were popped
410
+	 */
411
+	public function popExpect()
412
+	{
413
+		return array_pop($this->_expected_errors);
414
+	}
415
+
416
+	// }}}
417
+	// {{{ _checkDelExpect()
418
+
419
+	/**
420
+	 * This method checks unsets an error code if available
421
+	 *
422
+	 * @param mixed error code
423
+	 * @return bool true if the error code was unset, false otherwise
424
+	 * @access private
425
+	 */
426
+	public function _checkDelExpect($error_code)
427
+	{
428
+		$deleted = false;
429
+
430
+		foreach ($this->_expected_errors as $key => $error_array) {
431
+			if (in_array($error_code, $error_array)) {
432
+				unset($this->_expected_errors[$key][array_search($error_code, $error_array)]);
433
+				$deleted = true;
434
+			}
435
+
436
+			// clean up empty arrays
437
+			if (0 == count($this->_expected_errors[$key])) {
438
+				unset($this->_expected_errors[$key]);
439
+			}
440
+		}
441
+
442
+		return $deleted;
443
+	}
444
+
445
+	// }}}
446
+	// {{{ delExpect()
447
+
448
+	/**
449
+	 * This method deletes all occurences of the specified element from
450
+	 * the expected error codes stack.
451
+	 *
452
+	 * @param  mixed $error_code error code that should be deleted
453
+	 * @return mixed list of error codes that were deleted or error
454
+	 * @access public
455
+	 */
456
+	public function delExpect($error_code)
457
+	{
458
+		$deleted = false;
459
+
460
+		if (is_array($error_code) && (0 != count($error_code))) {
461
+			// $error_code is a non-empty array here;
462
+			// we walk through it trying to unset all
463
+			// values
464
+			foreach ($error_code as $key => $error) {
465
+				if ($this->_checkDelExpect($error)) {
466
+					$deleted = true;
467
+				} else {
468
+					$deleted = false;
469
+				}
470
+			}
471
+
472
+			return $deleted ? true : references_PEAR::raiseError('The expected error you submitted does not exist'); // IMPROVE ME
473
+		} elseif (!empty($error_code)) {
474
+			// $error_code comes alone, trying to unset it
475
+			if ($this->_checkDelExpect($error_code)) {
476
+				return true;
477
+			} else {
478
+				return references_PEAR::raiseError('The expected error you submitted does not exist'); // IMPROVE ME
479
+			}
480
+		} else {
481
+			// $error_code is empty
482
+			return references_PEAR::raiseError('The expected error you submitted is empty'); // IMPROVE ME
483
+		}
484
+	}
485
+
486
+	// }}}
487
+	// {{{ raiseError()
488
+
489
+	/**
490
+	 * This method is a wrapper that returns an instance of the
491
+	 * configured error class with this object's default error
492
+	 * handling applied.  If the $mode and $options parameters are not
493
+	 * specified, the object's defaults are used.
494
+	 *
495
+	 * @param mixed  $message     a text error message or a PEAR error object
496
+	 *
497
+	 * @param int    $code        a numeric error code (it is up to your class
498
+	 *                            to define these if you want to use codes)
499
+	 *
500
+	 * @param int    $mode        One of references_PEAR_ERROR_RETURN, references_PEAR_ERROR_PRINT,
501
+	 *                            references_PEAR_ERROR_TRIGGER, references_PEAR_ERROR_DIE,
502
+	 *                            references_PEAR_ERROR_CALLBACK, references_PEAR_ERROR_EXCEPTION.
503
+	 *
504
+	 * @param mixed  $options     If $mode is references_PEAR_ERROR_TRIGGER, this parameter
505
+	 *                            specifies the PHP-internal error level (one of
506
+	 *                            E_USER_NOTICE, E_USER_WARNING or E_USER_ERROR).
507
+	 *                            If $mode is references_PEAR_ERROR_CALLBACK, this
508
+	 *                            parameter specifies the callback function or
509
+	 *                            method.  In other error modes this parameter
510
+	 *                            is ignored.
511
+	 *
512
+	 * @param string $userinfo    If you need to pass along for example debug
513
+	 *                            information, this parameter is meant for that.
514
+	 *
515
+	 * @param string $error_class The returned error object will be
516
+	 *                            instantiated from this class, if specified.
517
+	 *
518
+	 * @param bool   $skipmsg     If true, raiseError will only pass error codes,
519
+	 *                            the error message parameter will be dropped.
520
+	 *
521
+	 * @access public
522
+	 * @return object a PEAR error object
523
+	 * @see    references_PEAR::setErrorHandling
524
+	 * @since  PHP 4.0.5
525
+	 */
526
+	public function &raiseError($message = null, $code = null, $mode = null, $options = null, $userinfo = null, $error_class = null, $skipmsg = false)
527
+	{
528
+		// The error is yet a PEAR error object
529
+		if (is_object($message)) {
530
+			$code                          = $message->getCode();
531
+			$userinfo                      = $message->getUserInfo();
532
+			$error_class                   = $message->getType();
533
+			$message->error_message_prefix = '';
534
+			$message                       = $message->getMessage();
535
+		}
536
+
537
+		if (isset($this) && isset($this->_expected_errors) && count($this->_expected_errors) > 0 && count($exp = end($this->_expected_errors))) {
538
+			if ($exp[0] === '*'
539
+				|| (is_int(reset($exp)) && in_array($code, $exp))
540
+				|| (is_string(reset($exp)) && in_array($message, $exp))
541
+			) {
542
+				$mode = references_PEAR_ERROR_RETURN;
543
+			}
544
+		}
545
+		// No mode given, try global ones
546
+		if ($mode === null) {
547
+			// Class error handler
548
+			if (isset($this) && isset($this->_default_error_mode)) {
549
+				$mode    = $this->_default_error_mode;
550
+				$options = $this->_default_error_options;
551
+				// Global error handler
552
+			} elseif (isset($GLOBALS['_PEAR_default_error_mode'])) {
553
+				$mode    = $GLOBALS['_PEAR_default_error_mode'];
554
+				$options = $GLOBALS['_PEAR_default_error_options'];
555
+			}
556
+		}
557
+
558
+		if ($error_class !== null) {
559
+			$ec = $error_class;
560
+		} elseif (isset($this) && isset($this->_error_class)) {
561
+			$ec = $this->_error_class;
562
+		} else {
563
+			$ec = 'references_PEAR_Error';
564
+		}
565
+		if ($skipmsg) {
566
+			$a = new $ec($code, $mode, $options, $userinfo);
567
+
568
+			return $a;
569
+		} else {
570
+			$a = new $ec($message, $code, $mode, $options, $userinfo);
571
+
572
+			return $a;
573
+		}
574
+	}
575
+
576
+	// }}}
577
+	// {{{ throwError()
578
+
579
+	/**
580
+	 * Simpler form of raiseError with fewer options.  In most cases
581
+	 * message, code and userinfo are enough.
582
+	 *
583
+	 * @param string $message
584
+	 *
585
+	 * @param null   $code
586
+	 * @param null   $userinfo
587
+	 * @return object
588
+	 */
589
+	public function &throwError($message = null, $code = null, $userinfo = null)
590
+	{
591
+		if (isset($this) && is_a($this, 'PEAR')) {
592
+			$a = &$this->raiseError($message, $code, null, null, $userinfo);
593
+
594
+			return $a;
595
+		} else {
596
+			$a = &references_PEAR::raiseError($message, $code, null, null, $userinfo);
597
+
598
+			return $a;
599
+		}
600
+	}
601
+
602
+	// }}}
603
+	public function staticPushErrorHandling($mode, $options = null)
604
+	{
605
+		$stack       = &$GLOBALS['_PEAR_error_handler_stack'];
606
+		$def_mode    = &$GLOBALS['_PEAR_default_error_mode'];
607
+		$def_options = &$GLOBALS['_PEAR_default_error_options'];
608
+		$stack[]     = array($def_mode, $def_options);
609
+		switch ($mode) {
610
+			case references_PEAR_ERROR_EXCEPTION:
611
+			case references_PEAR_ERROR_RETURN:
612
+			case references_PEAR_ERROR_PRINT:
613
+			case references_PEAR_ERROR_TRIGGER:
614
+			case references_PEAR_ERROR_DIE:
615
+			case null:
616
+				$def_mode    = $mode;
617
+				$def_options = $options;
618
+				break;
619
+
620
+			case references_PEAR_ERROR_CALLBACK:
621
+				$def_mode = $mode;
622
+				// class/object method callback
623
+				if (is_callable($options)) {
624
+					$def_options = $options;
625
+				} else {
626
+					trigger_error('invalid error callback', E_USER_WARNING);
627
+				}
628
+				break;
629
+
630
+			default:
631
+				trigger_error('invalid error mode', E_USER_WARNING);
632
+				break;
633
+		}
634
+		$stack[] = array($mode, $options);
635
+
636
+		return true;
637
+	}
638
+
639
+	public function staticPopErrorHandling()
640
+	{
641
+		$stack      = &$GLOBALS['_PEAR_error_handler_stack'];
642
+		$setmode    = &$GLOBALS['_PEAR_default_error_mode'];
643
+		$setoptions = &$GLOBALS['_PEAR_default_error_options'];
644
+		array_pop($stack);
645
+		list($mode, $options) = $stack[count($stack) - 1];
646
+		array_pop($stack);
647
+		switch ($mode) {
648
+			case references_PEAR_ERROR_EXCEPTION:
649
+			case references_PEAR_ERROR_RETURN:
650
+			case references_PEAR_ERROR_PRINT:
651
+			case references_PEAR_ERROR_TRIGGER:
652
+			case references_PEAR_ERROR_DIE:
653
+			case null:
654
+				$setmode    = $mode;
655
+				$setoptions = $options;
656
+				break;
657
+
658
+			case references_PEAR_ERROR_CALLBACK:
659
+				$setmode = $mode;
660
+				// class/object method callback
661
+				if (is_callable($options)) {
662
+					$setoptions = $options;
663
+				} else {
664
+					trigger_error('invalid error callback', E_USER_WARNING);
665
+				}
666
+				break;
667
+
668
+			default:
669
+				trigger_error('invalid error mode', E_USER_WARNING);
670
+				break;
671
+		}
672
+
673
+		return true;
674
+	}
675
+
676
+	// {{{ pushErrorHandling()
677
+
678
+	/**
679
+	 * Push a new error handler on top of the error handler options stack. With this
680
+	 * you can easily override the actual error handler for some code and restore
681
+	 * it later with popErrorHandling.
682
+	 *
683
+	 * @param mixed $mode    (same as setErrorHandling)
684
+	 * @param mixed $options (same as setErrorHandling)
685
+	 *
686
+	 * @return bool Always true
687
+	 *
688
+	 * @see references_PEAR::setErrorHandling
689
+	 */
690
+	public function pushErrorHandling($mode, $options = null)
691
+	{
692
+		$stack = &$GLOBALS['_PEAR_error_handler_stack'];
693
+		if (isset($this) && is_a($this, 'PEAR')) {
694
+			$def_mode    = &$this->_default_error_mode;
695
+			$def_options = &$this->_default_error_options;
696
+		} else {
697
+			$def_mode    = &$GLOBALS['_PEAR_default_error_mode'];
698
+			$def_options = &$GLOBALS['_PEAR_default_error_options'];
699
+		}
700
+		$stack[] = array($def_mode, $def_options);
701
+
702
+		if (isset($this) && is_a($this, 'PEAR')) {
703
+			$this->setErrorHandling($mode, $options);
704
+		} else {
705
+			references_PEAR::setErrorHandling($mode, $options);
706
+		}
707
+		$stack[] = array($mode, $options);
708
+
709
+		return true;
710
+	}
711
+
712
+	// }}}
713
+	// {{{ popErrorHandling()
714
+
715
+	/**
716
+	 * Pop the last error handler used
717
+	 *
718
+	 * @return bool Always true
719
+	 *
720
+	 * @see references_PEAR::pushErrorHandling
721
+	 */
722
+	public function popErrorHandling()
723
+	{
724
+		$stack = &$GLOBALS['_PEAR_error_handler_stack'];
725
+		array_pop($stack);
726
+		list($mode, $options) = $stack[count($stack) - 1];
727
+		array_pop($stack);
728
+		if (isset($this) && is_a($this, 'PEAR')) {
729
+			$this->setErrorHandling($mode, $options);
730
+		} else {
731
+			references_PEAR::setErrorHandling($mode, $options);
732
+		}
733
+
734
+		return true;
735
+	}
736
+
737
+	// }}}
738
+	// {{{ loadExtension()
739
+
740
+	/**
741
+	 * OS independant PHP extension load. Remember to take care
742
+	 * on the correct extension name for case sensitive OSes.
743
+	 *
744
+	 * @param string $ext The extension name
745
+	 * @return bool Success or not on the dl() call
746
+	 */
747
+	public function loadExtension($ext)
748
+	{
749
+		if (!extension_loaded($ext)) {
750
+			// if either returns true dl() will produce a FATAL error, stop that
751
+			if ((ini_get('enable_dl') != 1) || (ini_get('safe_mode') == 1)) {
752
+				return false;
753
+			}
754
+			if (references_OS_WINDOWS) {
755
+				$suffix = '.dll';
756
+			} elseif (PHP_OS === 'HP-UX') {
757
+				$suffix = '.sl';
758
+			} elseif (PHP_OS === 'AIX') {
759
+				$suffix = '.a';
760
+			} elseif (PHP_OS === 'OSX') {
761
+				$suffix = '.bundle';
762
+			} else {
763
+				$suffix = '.so';
764
+			}
765
+
766
+			return @dl('php_' . $ext . $suffix) || @dl($ext . $suffix);
767
+		}
768
+
769
+		return true;
770
+	}
771
+
772
+	// }}}
773 773
 }
774 774
 
775 775
 // {{{ _PEAR_call_destructors()
776 776
 
777 777
 function references_PEAR_call_destructors()
778 778
 {
779
-    global $_PEAR_destructor_object_list;
780
-    if (is_array($_PEAR_destructor_object_list)
781
-        && count($_PEAR_destructor_object_list)
782
-    ) {
783
-        reset($_PEAR_destructor_object_list);
784
-        if (references_PEAR::getStaticProperty('PEAR', 'destructlifo')) {
785
-            $_PEAR_destructor_object_list = array_reverse($_PEAR_destructor_object_list);
786
-        }
787
-        while (list($k, $objref) = each($_PEAR_destructor_object_list)) {
788
-            $classname = get_class($objref);
789
-            while ($classname) {
790
-                $destructor = "_$classname";
791
-                if (method_exists($objref, $destructor)) {
792
-                    $objref->$destructor();
793
-                    break;
794
-                } else {
795
-                    $classname = get_parent_class($classname);
796
-                }
797
-            }
798
-        }
799
-        // Empty the object list to ensure that destructors are
800
-        // not called more than once.
801
-        $_PEAR_destructor_object_list = array();
802
-    }
803
-
804
-    // Now call the shutdown functions
805
-    if (is_array($GLOBALS['_PEAR_shutdown_funcs']) and !empty($GLOBALS['_PEAR_shutdown_funcs'])) {
806
-        foreach ($GLOBALS['_PEAR_shutdown_funcs'] as $value) {
807
-            call_user_func_array($value[0], $value[1]);
808
-        }
809
-    }
779
+	global $_PEAR_destructor_object_list;
780
+	if (is_array($_PEAR_destructor_object_list)
781
+		&& count($_PEAR_destructor_object_list)
782
+	) {
783
+		reset($_PEAR_destructor_object_list);
784
+		if (references_PEAR::getStaticProperty('PEAR', 'destructlifo')) {
785
+			$_PEAR_destructor_object_list = array_reverse($_PEAR_destructor_object_list);
786
+		}
787
+		while (list($k, $objref) = each($_PEAR_destructor_object_list)) {
788
+			$classname = get_class($objref);
789
+			while ($classname) {
790
+				$destructor = "_$classname";
791
+				if (method_exists($objref, $destructor)) {
792
+					$objref->$destructor();
793
+					break;
794
+				} else {
795
+					$classname = get_parent_class($classname);
796
+				}
797
+			}
798
+		}
799
+		// Empty the object list to ensure that destructors are
800
+		// not called more than once.
801
+		$_PEAR_destructor_object_list = array();
802
+	}
803
+
804
+	// Now call the shutdown functions
805
+	if (is_array($GLOBALS['_PEAR_shutdown_funcs']) and !empty($GLOBALS['_PEAR_shutdown_funcs'])) {
806
+		foreach ($GLOBALS['_PEAR_shutdown_funcs'] as $value) {
807
+			call_user_func_array($value[0], $value[1]);
808
+		}
809
+	}
810 810
 }
811 811
 
812 812
 // }}}
@@ -829,274 +829,274 @@  discard block
 block discarded – undo
829 829
  */
830 830
 class references_PEAR_Error
831 831
 {
832
-    // {{{ properties
833
-
834
-    public $error_message_prefix = '';
835
-    public $mode                 = references_PEAR_ERROR_RETURN;
836
-    public $level                = E_USER_NOTICE;
837
-    public $code                 = -1;
838
-    public $message              = '';
839
-    public $userinfo             = '';
840
-    public $backtrace            = null;
841
-
842
-    // }}}
843
-    // {{{ constructor
844
-
845
-    /**
846
-     * PEAR_Error constructor
847
-     *
848
-     * @param string $message  message
849
-     *
850
-     * @param int    $code     (optional) error code
851
-     *
852
-     * @param int    $mode     (optional) error mode, one of: references_PEAR_ERROR_RETURN,
853
-     *                         references_PEAR_ERROR_PRINT, references_PEAR_ERROR_DIE, references_PEAR_ERROR_TRIGGER,
854
-     *                         references_PEAR_ERROR_CALLBACK or references_PEAR_ERROR_EXCEPTION
855
-     *
856
-     * @param mixed  $options  (optional) error level, _OR_ in the case of
857
-     *                         references_PEAR_ERROR_CALLBACK, the callback function or object/method
858
-     *                         tuple.
859
-     *
860
-     * @param string $userinfo (optional) additional user/debug info
861
-     *
862
-     * @access public
863
-     *
864
-     */
865
-    public function __construct($message = 'unknown error', $code = null, $mode = null, $options = null, $userinfo = null)
866
-    {
867
-        if ($mode === null) {
868
-            $mode = references_PEAR_ERROR_RETURN;
869
-        }
870
-        $this->message  = $message;
871
-        $this->code     = $code;
872
-        $this->mode     = $mode;
873
-        $this->userinfo = $userinfo;
874
-        if (!references_PEAR::getStaticProperty('PEAR_Error', 'skiptrace')) {
875
-            $this->backtrace = debug_backtrace();
876
-            if (isset($this->backtrace[0]) && isset($this->backtrace[0]['object'])) {
877
-                unset($this->backtrace[0]['object']);
878
-            }
879
-        }
880
-        if ($mode & references_PEAR_ERROR_CALLBACK) {
881
-            $this->level    = E_USER_NOTICE;
882
-            $this->callback = $options;
883
-        } else {
884
-            if ($options === null) {
885
-                $options = E_USER_NOTICE;
886
-            }
887
-            $this->level    = $options;
888
-            $this->callback = null;
889
-        }
890
-        if ($this->mode & references_PEAR_ERROR_PRINT) {
891
-            if (is_null($options) || is_int($options)) {
892
-                $format = '%s';
893
-            } else {
894
-                $format = $options;
895
-            }
896
-            printf($format, $this->getMessage());
897
-        }
898
-        if ($this->mode & references_PEAR_ERROR_TRIGGER) {
899
-            trigger_error($this->getMessage(), $this->level);
900
-        }
901
-        if ($this->mode & references_PEAR_ERROR_DIE) {
902
-            $msg = $this->getMessage();
903
-            if (is_null($options) || is_int($options)) {
904
-                $format = '%s';
905
-                if (substr($msg, -1) !== "\n") {
906
-                    $msg .= "\n";
907
-                }
908
-            } else {
909
-                $format = $options;
910
-            }
911
-            die(sprintf($format, $msg));
912
-        }
913
-        if ($this->mode & references_PEAR_ERROR_CALLBACK) {
914
-            if (is_callable($this->callback)) {
915
-                call_user_func($this->callback, $this);
916
-            }
917
-        }
918
-        if ($this->mode & references_PEAR_ERROR_EXCEPTION) {
919
-            trigger_error('references_PEAR_ERROR_EXCEPTION is obsolete, use class PEAR_Exception for exceptions', E_USER_WARNING);
920
-            eval('$e = new Exception($this->message, $this->code);throw($e);');
921
-        }
922
-    }
923
-
924
-    // }}}
925
-    // {{{ getMode()
926
-
927
-    /**
928
-     * Get the error mode from an error object.
929
-     *
930
-     * @return int error mode
931
-     * @access public
932
-     */
933
-    public function getMode()
934
-    {
935
-        return $this->mode;
936
-    }
937
-
938
-    // }}}
939
-    // {{{ getCallback()
940
-
941
-    /**
942
-     * Get the callback function/method from an error object.
943
-     *
944
-     * @return mixed callback function or object/method array
945
-     * @access public
946
-     */
947
-    public function getCallback()
948
-    {
949
-        return $this->callback;
950
-    }
951
-
952
-    // }}}
953
-    // {{{ getMessage()
954
-
955
-    /**
956
-     * Get the error message from an error object.
957
-     *
958
-     * @return string full error message
959
-     * @access public
960
-     */
961
-    public function getMessage()
962
-    {
963
-        return ($this->error_message_prefix . $this->message);
964
-    }
965
-
966
-    // }}}
967
-    // {{{ getCode()
968
-
969
-    /**
970
-     * Get error code from an error object
971
-     *
972
-     * @return int error code
973
-     * @access public
974
-     */
975
-    public function getCode()
976
-    {
977
-        return $this->code;
978
-    }
979
-
980
-    // }}}
981
-    // {{{ getType()
982
-
983
-    /**
984
-     * Get the name of this error/exception.
985
-     *
986
-     * @return string error/exception name (type)
987
-     * @access public
988
-     */
989
-    public function getType()
990
-    {
991
-        return get_class($this);
992
-    }
993
-
994
-    // }}}
995
-    // {{{ getUserInfo()
996
-
997
-    /**
998
-     * Get additional user-supplied information.
999
-     *
1000
-     * @return string user-supplied information
1001
-     * @access public
1002
-     */
1003
-    public function getUserInfo()
1004
-    {
1005
-        return $this->userinfo;
1006
-    }
1007
-
1008
-    // }}}
1009
-    // {{{ getDebugInfo()
1010
-
1011
-    /**
1012
-     * Get additional debug information supplied by the application.
1013
-     *
1014
-     * @return string debug information
1015
-     * @access public
1016
-     */
1017
-    public function getDebugInfo()
1018
-    {
1019
-        return $this->getUserInfo();
1020
-    }
1021
-
1022
-    // }}}
1023
-    // {{{ getBacktrace()
1024
-
1025
-    /**
1026
-     * Get the call backtrace from where the error was generated.
1027
-     * Supported with PHP 4.3.0 or newer.
1028
-     *
1029
-     * @param  int $frame (optional) what frame to fetch
1030
-     * @return array Backtrace, or NULL if not available.
1031
-     * @access public
1032
-     */
1033
-    public function getBacktrace($frame = null)
1034
-    {
1035
-        if (defined('PEAR_IGNORE_BACKTRACE')) {
1036
-            return null;
1037
-        }
1038
-        if ($frame === null) {
1039
-            return $this->backtrace;
1040
-        }
1041
-
1042
-        return $this->backtrace[$frame];
1043
-    }
1044
-
1045
-    // }}}
1046
-    // {{{ addUserInfo()
1047
-
1048
-    public function addUserInfo($info)
1049
-    {
1050
-        if (empty($this->userinfo)) {
1051
-            $this->userinfo = $info;
1052
-        } else {
1053
-            $this->userinfo .= " ** $info";
1054
-        }
1055
-    }
1056
-
1057
-    // }}}
1058
-    // {{{ toString()
1059
-
1060
-    /**
1061
-     * Make a string representation of this object.
1062
-     *
1063
-     * @return string a string with an object summary
1064
-     * @access public
1065
-     */
1066
-    public function toString()
1067
-    {
1068
-        $modes  = array();
1069
-        $levels = array(
1070
-            E_USER_NOTICE  => 'notice',
1071
-            E_USER_WARNING => 'warning',
1072
-            E_USER_ERROR   => 'error'
1073
-        );
1074
-        if ($this->mode & references_PEAR_ERROR_CALLBACK) {
1075
-            if (is_array($this->callback)) {
1076
-                $callback = (is_object($this->callback[0]) ? strtolower(get_class($this->callback[0])) : $this->callback[0]) . '::' . $this->callback[1];
1077
-            } else {
1078
-                $callback = $this->callback;
1079
-            }
1080
-
1081
-            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);
1082
-        }
1083
-        if ($this->mode & references_PEAR_ERROR_PRINT) {
1084
-            $modes[] = 'print';
1085
-        }
1086
-        if ($this->mode & references_PEAR_ERROR_TRIGGER) {
1087
-            $modes[] = 'trigger';
1088
-        }
1089
-        if ($this->mode & references_PEAR_ERROR_DIE) {
1090
-            $modes[] = 'die';
1091
-        }
1092
-        if ($this->mode & references_PEAR_ERROR_RETURN) {
1093
-            $modes[] = 'return';
1094
-        }
1095
-
1096
-        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);
1097
-    }
1098
-
1099
-    // }}}
832
+	// {{{ properties
833
+
834
+	public $error_message_prefix = '';
835
+	public $mode                 = references_PEAR_ERROR_RETURN;
836
+	public $level                = E_USER_NOTICE;
837
+	public $code                 = -1;
838
+	public $message              = '';
839
+	public $userinfo             = '';
840
+	public $backtrace            = null;
841
+
842
+	// }}}
843
+	// {{{ constructor
844
+
845
+	/**
846
+	 * PEAR_Error constructor
847
+	 *
848
+	 * @param string $message  message
849
+	 *
850
+	 * @param int    $code     (optional) error code
851
+	 *
852
+	 * @param int    $mode     (optional) error mode, one of: references_PEAR_ERROR_RETURN,
853
+	 *                         references_PEAR_ERROR_PRINT, references_PEAR_ERROR_DIE, references_PEAR_ERROR_TRIGGER,
854
+	 *                         references_PEAR_ERROR_CALLBACK or references_PEAR_ERROR_EXCEPTION
855
+	 *
856
+	 * @param mixed  $options  (optional) error level, _OR_ in the case of
857
+	 *                         references_PEAR_ERROR_CALLBACK, the callback function or object/method
858
+	 *                         tuple.
859
+	 *
860
+	 * @param string $userinfo (optional) additional user/debug info
861
+	 *
862
+	 * @access public
863
+	 *
864
+	 */
865
+	public function __construct($message = 'unknown error', $code = null, $mode = null, $options = null, $userinfo = null)
866
+	{
867
+		if ($mode === null) {
868
+			$mode = references_PEAR_ERROR_RETURN;
869
+		}
870
+		$this->message  = $message;
871
+		$this->code     = $code;
872
+		$this->mode     = $mode;
873
+		$this->userinfo = $userinfo;
874
+		if (!references_PEAR::getStaticProperty('PEAR_Error', 'skiptrace')) {
875
+			$this->backtrace = debug_backtrace();
876
+			if (isset($this->backtrace[0]) && isset($this->backtrace[0]['object'])) {
877
+				unset($this->backtrace[0]['object']);
878
+			}
879
+		}
880
+		if ($mode & references_PEAR_ERROR_CALLBACK) {
881
+			$this->level    = E_USER_NOTICE;
882
+			$this->callback = $options;
883
+		} else {
884
+			if ($options === null) {
885
+				$options = E_USER_NOTICE;
886
+			}
887
+			$this->level    = $options;
888
+			$this->callback = null;
889
+		}
890
+		if ($this->mode & references_PEAR_ERROR_PRINT) {
891
+			if (is_null($options) || is_int($options)) {
892
+				$format = '%s';
893
+			} else {
894
+				$format = $options;
895
+			}
896
+			printf($format, $this->getMessage());
897
+		}
898
+		if ($this->mode & references_PEAR_ERROR_TRIGGER) {
899
+			trigger_error($this->getMessage(), $this->level);
900
+		}
901
+		if ($this->mode & references_PEAR_ERROR_DIE) {
902
+			$msg = $this->getMessage();
903
+			if (is_null($options) || is_int($options)) {
904
+				$format = '%s';
905
+				if (substr($msg, -1) !== "\n") {
906
+					$msg .= "\n";
907
+				}
908
+			} else {
909
+				$format = $options;
910
+			}
911
+			die(sprintf($format, $msg));
912
+		}
913
+		if ($this->mode & references_PEAR_ERROR_CALLBACK) {
914
+			if (is_callable($this->callback)) {
915
+				call_user_func($this->callback, $this);
916
+			}
917
+		}
918
+		if ($this->mode & references_PEAR_ERROR_EXCEPTION) {
919
+			trigger_error('references_PEAR_ERROR_EXCEPTION is obsolete, use class PEAR_Exception for exceptions', E_USER_WARNING);
920
+			eval('$e = new Exception($this->message, $this->code);throw($e);');
921
+		}
922
+	}
923
+
924
+	// }}}
925
+	// {{{ getMode()
926
+
927
+	/**
928
+	 * Get the error mode from an error object.
929
+	 *
930
+	 * @return int error mode
931
+	 * @access public
932
+	 */
933
+	public function getMode()
934
+	{
935
+		return $this->mode;
936
+	}
937
+
938
+	// }}}
939
+	// {{{ getCallback()
940
+
941
+	/**
942
+	 * Get the callback function/method from an error object.
943
+	 *
944
+	 * @return mixed callback function or object/method array
945
+	 * @access public
946
+	 */
947
+	public function getCallback()
948
+	{
949
+		return $this->callback;
950
+	}
951
+
952
+	// }}}
953
+	// {{{ getMessage()
954
+
955
+	/**
956
+	 * Get the error message from an error object.
957
+	 *
958
+	 * @return string full error message
959
+	 * @access public
960
+	 */
961
+	public function getMessage()
962
+	{
963
+		return ($this->error_message_prefix . $this->message);
964
+	}
965
+
966
+	// }}}
967
+	// {{{ getCode()
968
+
969
+	/**
970
+	 * Get error code from an error object
971
+	 *
972
+	 * @return int error code
973
+	 * @access public
974
+	 */
975
+	public function getCode()
976
+	{
977
+		return $this->code;
978
+	}
979
+
980
+	// }}}
981
+	// {{{ getType()
982
+
983
+	/**
984
+	 * Get the name of this error/exception.
985
+	 *
986
+	 * @return string error/exception name (type)
987
+	 * @access public
988
+	 */
989
+	public function getType()
990
+	{
991
+		return get_class($this);
992
+	}
993
+
994
+	// }}}
995
+	// {{{ getUserInfo()
996
+
997
+	/**
998
+	 * Get additional user-supplied information.
999
+	 *
1000
+	 * @return string user-supplied information
1001
+	 * @access public
1002
+	 */
1003
+	public function getUserInfo()
1004
+	{
1005
+		return $this->userinfo;
1006
+	}
1007
+
1008
+	// }}}
1009
+	// {{{ getDebugInfo()
1010
+
1011
+	/**
1012
+	 * Get additional debug information supplied by the application.
1013
+	 *
1014
+	 * @return string debug information
1015
+	 * @access public
1016
+	 */
1017
+	public function getDebugInfo()
1018
+	{
1019
+		return $this->getUserInfo();
1020
+	}
1021
+
1022
+	// }}}
1023
+	// {{{ getBacktrace()
1024
+
1025
+	/**
1026
+	 * Get the call backtrace from where the error was generated.
1027
+	 * Supported with PHP 4.3.0 or newer.
1028
+	 *
1029
+	 * @param  int $frame (optional) what frame to fetch
1030
+	 * @return array Backtrace, or NULL if not available.
1031
+	 * @access public
1032
+	 */
1033
+	public function getBacktrace($frame = null)
1034
+	{
1035
+		if (defined('PEAR_IGNORE_BACKTRACE')) {
1036
+			return null;
1037
+		}
1038
+		if ($frame === null) {
1039
+			return $this->backtrace;
1040
+		}
1041
+
1042
+		return $this->backtrace[$frame];
1043
+	}
1044
+
1045
+	// }}}
1046
+	// {{{ addUserInfo()
1047
+
1048
+	public function addUserInfo($info)
1049
+	{
1050
+		if (empty($this->userinfo)) {
1051
+			$this->userinfo = $info;
1052
+		} else {
1053
+			$this->userinfo .= " ** $info";
1054
+		}
1055
+	}
1056
+
1057
+	// }}}
1058
+	// {{{ toString()
1059
+
1060
+	/**
1061
+	 * Make a string representation of this object.
1062
+	 *
1063
+	 * @return string a string with an object summary
1064
+	 * @access public
1065
+	 */
1066
+	public function toString()
1067
+	{
1068
+		$modes  = array();
1069
+		$levels = array(
1070
+			E_USER_NOTICE  => 'notice',
1071
+			E_USER_WARNING => 'warning',
1072
+			E_USER_ERROR   => 'error'
1073
+		);
1074
+		if ($this->mode & references_PEAR_ERROR_CALLBACK) {
1075
+			if (is_array($this->callback)) {
1076
+				$callback = (is_object($this->callback[0]) ? strtolower(get_class($this->callback[0])) : $this->callback[0]) . '::' . $this->callback[1];
1077
+			} else {
1078
+				$callback = $this->callback;
1079
+			}
1080
+
1081
+			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);
1082
+		}
1083
+		if ($this->mode & references_PEAR_ERROR_PRINT) {
1084
+			$modes[] = 'print';
1085
+		}
1086
+		if ($this->mode & references_PEAR_ERROR_TRIGGER) {
1087
+			$modes[] = 'trigger';
1088
+		}
1089
+		if ($this->mode & references_PEAR_ERROR_DIE) {
1090
+			$modes[] = 'die';
1091
+		}
1092
+		if ($this->mode & references_PEAR_ERROR_RETURN) {
1093
+			$modes[] = 'return';
1094
+		}
1095
+
1096
+		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);
1097
+	}
1098
+
1099
+	// }}}
1100 1100
 }
1101 1101
 
1102 1102
 /*
Please login to merge, or discard this patch.
Spacing   +16 added lines, -16 removed lines patch added patch discarded remove patch
@@ -763,7 +763,7 @@  discard block
 block discarded – undo
763 763
                 $suffix = '.so';
764 764
             }
765 765
 
766
-            return @dl('php_' . $ext . $suffix) || @dl($ext . $suffix);
766
+            return @dl('php_'.$ext.$suffix) || @dl($ext.$suffix);
767 767
         }
768 768
 
769 769
         return true;
@@ -877,7 +877,7 @@  discard block
 block discarded – undo
877 877
                 unset($this->backtrace[0]['object']);
878 878
             }
879 879
         }
880
-        if ($mode & references_PEAR_ERROR_CALLBACK) {
880
+        if ($mode&references_PEAR_ERROR_CALLBACK) {
881 881
             $this->level    = E_USER_NOTICE;
882 882
             $this->callback = $options;
883 883
         } else {
@@ -887,7 +887,7 @@  discard block
 block discarded – undo
887 887
             $this->level    = $options;
888 888
             $this->callback = null;
889 889
         }
890
-        if ($this->mode & references_PEAR_ERROR_PRINT) {
890
+        if ($this->mode&references_PEAR_ERROR_PRINT) {
891 891
             if (is_null($options) || is_int($options)) {
892 892
                 $format = '%s';
893 893
             } else {
@@ -895,10 +895,10 @@  discard block
 block discarded – undo
895 895
             }
896 896
             printf($format, $this->getMessage());
897 897
         }
898
-        if ($this->mode & references_PEAR_ERROR_TRIGGER) {
898
+        if ($this->mode&references_PEAR_ERROR_TRIGGER) {
899 899
             trigger_error($this->getMessage(), $this->level);
900 900
         }
901
-        if ($this->mode & references_PEAR_ERROR_DIE) {
901
+        if ($this->mode&references_PEAR_ERROR_DIE) {
902 902
             $msg = $this->getMessage();
903 903
             if (is_null($options) || is_int($options)) {
904 904
                 $format = '%s';
@@ -910,12 +910,12 @@  discard block
 block discarded – undo
910 910
             }
911 911
             die(sprintf($format, $msg));
912 912
         }
913
-        if ($this->mode & references_PEAR_ERROR_CALLBACK) {
913
+        if ($this->mode&references_PEAR_ERROR_CALLBACK) {
914 914
             if (is_callable($this->callback)) {
915 915
                 call_user_func($this->callback, $this);
916 916
             }
917 917
         }
918
-        if ($this->mode & references_PEAR_ERROR_EXCEPTION) {
918
+        if ($this->mode&references_PEAR_ERROR_EXCEPTION) {
919 919
             trigger_error('references_PEAR_ERROR_EXCEPTION is obsolete, use class PEAR_Exception for exceptions', E_USER_WARNING);
920 920
             eval('$e = new Exception($this->message, $this->code);throw($e);');
921 921
         }
@@ -960,7 +960,7 @@  discard block
 block discarded – undo
960 960
      */
961 961
     public function getMessage()
962 962
     {
963
-        return ($this->error_message_prefix . $this->message);
963
+        return ($this->error_message_prefix.$this->message);
964 964
     }
965 965
 
966 966
     // }}}
@@ -1071,29 +1071,29 @@  discard block
 block discarded – undo
1071 1071
             E_USER_WARNING => 'warning',
1072 1072
             E_USER_ERROR   => 'error'
1073 1073
         );
1074
-        if ($this->mode & references_PEAR_ERROR_CALLBACK) {
1074
+        if ($this->mode&references_PEAR_ERROR_CALLBACK) {
1075 1075
             if (is_array($this->callback)) {
1076
-                $callback = (is_object($this->callback[0]) ? strtolower(get_class($this->callback[0])) : $this->callback[0]) . '::' . $this->callback[1];
1076
+                $callback = (is_object($this->callback[0]) ? strtolower(get_class($this->callback[0])) : $this->callback[0]).'::'.$this->callback[1];
1077 1077
             } else {
1078 1078
                 $callback = $this->callback;
1079 1079
             }
1080 1080
 
1081
-            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);
1081
+            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);
1082 1082
         }
1083
-        if ($this->mode & references_PEAR_ERROR_PRINT) {
1083
+        if ($this->mode&references_PEAR_ERROR_PRINT) {
1084 1084
             $modes[] = 'print';
1085 1085
         }
1086
-        if ($this->mode & references_PEAR_ERROR_TRIGGER) {
1086
+        if ($this->mode&references_PEAR_ERROR_TRIGGER) {
1087 1087
             $modes[] = 'trigger';
1088 1088
         }
1089
-        if ($this->mode & references_PEAR_ERROR_DIE) {
1089
+        if ($this->mode&references_PEAR_ERROR_DIE) {
1090 1090
             $modes[] = 'die';
1091 1091
         }
1092
-        if ($this->mode & references_PEAR_ERROR_RETURN) {
1092
+        if ($this->mode&references_PEAR_ERROR_RETURN) {
1093 1093
             $modes[] = 'return';
1094 1094
         }
1095 1095
 
1096
-        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);
1096
+        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);
1097 1097
     }
1098 1098
 
1099 1099
     // }}}
Please login to merge, or discard this patch.
class/PersistableObjectHandler.php 3 patches
Doc Comments   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -235,7 +235,7 @@  discard block
 block discarded – undo
235 235
      * @param boolean $as_object
236 236
      * @param string  $fields    Requested fields from the query
237 237
      *
238
-     * @return array
238
+     * @return string
239 239
      */
240 240
     protected function convertResultSet($result, $id_as_key = false, $as_object = true, $fields = '*')
241 241
     {
@@ -502,7 +502,7 @@  discard block
 block discarded – undo
502 502
     /**
503 503
      * delete an object from the database
504 504
      *
505
-     * @param  XoopsObject $obj reference to the object to delete
505
+     * @param  references_articles $obj reference to the object to delete
506 506
      * @param  bool        $force
507 507
      * @return bool   FALSE if failed.
508 508
      */
Please login to merge, or discard this patch.
Spacing   +59 added lines, -59 removed lines patch added patch discarded remove patch
@@ -129,7 +129,7 @@  discard block
 block discarded – undo
129 129
      */
130 130
     protected function _getIdForCache($query, $start, $limit)
131 131
     {
132
-        $id = md5($query . '-' . (string)$start . '-' . (string)$limit);
132
+        $id = md5($query.'-'.(string) $start.'-'.(string) $limit);
133 133
 
134 134
         return $id;
135 135
     }
@@ -164,17 +164,17 @@  discard block
 block discarded – undo
164 164
             $criteria = new CriteriaCompo();
165 165
             $vnb      = count($this->keyName);
166 166
             for ($i = 0; $i < $vnb; ++$i) {
167
-                $criteria->add(new Criteria($this->keyName[$i], (int)$id[$i]));
167
+                $criteria->add(new Criteria($this->keyName[$i], (int) $id[$i]));
168 168
             }
169 169
         } else {
170
-            $criteria = new Criteria($this->keyName, (int)$id);
170
+            $criteria = new Criteria($this->keyName, (int) $id);
171 171
         }
172 172
         $criteria->setLimit(1);
173
-        $obj_array =& $this->getObjects($criteria, false, $as_object);
173
+        $obj_array = & $this->getObjects($criteria, false, $as_object);
174 174
         if (count($obj_array) != 1) {
175 175
             $ret = null;
176 176
         } else {
177
-            $ret =& $obj_array[0];
177
+            $ret = & $obj_array[0];
178 178
         }
179 179
 
180 180
         return $ret;
@@ -193,19 +193,19 @@  discard block
 block discarded – undo
193 193
      */
194 194
     public function &getObjects(CriteriaElement $criteria = null, $id_as_key = false, $as_object = true, $fields = '*', $autoSort = true)
195 195
     {
196
-        require_once __DIR__ . '/lite.php';
196
+        require_once __DIR__.'/lite.php';
197 197
         $ret   = array();
198 198
         $limit = $start = 0;
199
-        $sql   = 'SELECT ' . $fields . ' FROM ' . $this->table;
199
+        $sql   = 'SELECT '.$fields.' FROM '.$this->table;
200 200
         if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
201
-            $sql .= ' ' . $criteria->renderWhere();
201
+            $sql .= ' '.$criteria->renderWhere();
202 202
             if ($criteria->groupby != '') {
203 203
                 $sql .= $criteria->getGroupby();
204 204
             }
205 205
             if ($criteria->getSort() != '') {
206
-                $sql .= ' ORDER BY ' . $criteria->getSort() . ' ' . $criteria->getOrder();
206
+                $sql .= ' ORDER BY '.$criteria->getSort().' '.$criteria->getOrder();
207 207
             } elseif ($this->identifierName != '' && $autoSort) {
208
-                $sql .= ' ORDER BY ' . $this->identifierName;
208
+                $sql .= ' ORDER BY '.$this->identifierName;
209 209
             }
210 210
             $limit = $criteria->getLimit();
211 211
             $start = $criteria->getStart();
@@ -241,11 +241,11 @@  discard block
 block discarded – undo
241 241
     {
242 242
         $ret = array();
243 243
         while ($myrow = $this->db->fetchArray($result)) {
244
-            $obj =& $this->create(false);
244
+            $obj = & $this->create(false);
245 245
             $obj->assignVars($myrow);
246 246
             if (!$id_as_key) {
247 247
                 if ($as_object) {
248
-                    $ret[] =& $obj;
248
+                    $ret[] = & $obj;
249 249
                 } else {
250 250
                     $row     = array();
251 251
                     $vars    = $obj->getVars();
@@ -258,9 +258,9 @@  discard block
 block discarded – undo
258 258
             } else {
259 259
                 if ($as_object) {
260 260
                     if ($fields === '*') {
261
-                        $ret[$myrow[$this->keyName]] =& $obj;
261
+                        $ret[$myrow[$this->keyName]] = & $obj;
262 262
                     } else {
263
-                        $ret[] =& $obj;
263
+                        $ret[] = & $obj;
264 264
                     }
265 265
                 } else {
266 266
                     $row     = array();
@@ -286,20 +286,20 @@  discard block
 block discarded – undo
286 286
      */
287 287
     public function getIds($criteria = null)
288 288
     {
289
-        require_once __DIR__ . '/lite.php';
289
+        require_once __DIR__.'/lite.php';
290 290
         $limit = $start = 0;
291 291
 
292 292
         $Cache_Lite = new references_Cache_Lite($this->cacheOptions);
293
-        $sql        = 'SELECT ' . $this->keyName . ' FROM ' . $this->table;
293
+        $sql        = 'SELECT '.$this->keyName.' FROM '.$this->table;
294 294
         if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
295
-            $sql .= ' ' . $criteria->renderWhere();
295
+            $sql .= ' '.$criteria->renderWhere();
296 296
             if ($criteria->groupby != '') {
297 297
                 $sql .= $criteria->getGroupby();
298 298
             }
299 299
             if ($criteria->getSort() != '') {
300
-                $sql .= ' ORDER BY ' . $criteria->getSort() . ' ' . $criteria->getOrder();
300
+                $sql .= ' ORDER BY '.$criteria->getSort().' '.$criteria->getOrder();
301 301
             } elseif ($this->identifierName != '') {
302
-                $sql .= ' ORDER BY ' . $this->identifierName;
302
+                $sql .= ' ORDER BY '.$this->identifierName;
303 303
             }
304 304
             $limit = $criteria->getLimit();
305 305
             $start = $criteria->getStart();
@@ -329,26 +329,26 @@  discard block
 block discarded – undo
329 329
      */
330 330
     public function getList($criteria = null)
331 331
     {
332
-        require_once __DIR__ . '/lite.php';
332
+        require_once __DIR__.'/lite.php';
333 333
         $limit      = $start = 0;
334 334
         $Cache_Lite = new references_Cache_Lite($this->cacheOptions);
335 335
 
336 336
         $ret = array();
337 337
 
338
-        $sql = 'SELECT ' . $this->keyName;
338
+        $sql = 'SELECT '.$this->keyName;
339 339
         if (!empty($this->identifierName)) {
340
-            $sql .= ', ' . $this->identifierName;
340
+            $sql .= ', '.$this->identifierName;
341 341
         }
342
-        $sql .= ' FROM ' . $this->table;
342
+        $sql .= ' FROM '.$this->table;
343 343
         if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
344
-            $sql .= ' ' . $criteria->renderWhere();
344
+            $sql .= ' '.$criteria->renderWhere();
345 345
             if ($criteria->groupby != '') {
346 346
                 $sql .= $criteria->getGroupby();
347 347
             }
348 348
             if ($criteria->getSort() != '') {
349
-                $sql .= ' ORDER BY ' . $criteria->getSort() . ' ' . $criteria->getOrder();
349
+                $sql .= ' ORDER BY '.$criteria->getSort().' '.$criteria->getOrder();
350 350
             } elseif ($this->identifierName != '') {
351
-                $sql .= ' ORDER BY ' . $this->identifierName;
351
+                $sql .= ' ORDER BY '.$this->identifierName;
352 352
             }
353 353
             $limit = $criteria->getLimit();
354 354
             $start = $criteria->getStart();
@@ -389,11 +389,11 @@  discard block
 block discarded – undo
389 389
         $ret = array();
390 390
         if (is_array($ids) && count($ids) > 0) {
391 391
             $criteria = new CriteriaCompo();
392
-            $criteria->add(new Criteria($this->keyName, '(' . implode(',', $ids) . ')', 'IN'));
392
+            $criteria->add(new Criteria($this->keyName, '('.implode(',', $ids).')', 'IN'));
393 393
             if (!is_null($additionnal)) {
394 394
                 $criteria->add($additionnal);
395 395
             }
396
-            $ret =& $this->getObjects($criteria, true);
396
+            $ret = & $this->getObjects($criteria, true);
397 397
         }
398 398
 
399 399
         return $ret;
@@ -410,17 +410,17 @@  discard block
 block discarded – undo
410 410
         $field   = '';
411 411
         $groupby = false;
412 412
         $limit   = $start = 0;
413
-        require_once __DIR__ . '/lite.php';
413
+        require_once __DIR__.'/lite.php';
414 414
 
415 415
         if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
416 416
             if ($criteria->groupby != '') {
417 417
                 $groupby = true;
418
-                $field   = $criteria->groupby . ', '; //Not entirely secure unless you KNOW that no criteria's groupby clause is going to be mis-used
418
+                $field   = $criteria->groupby.', '; //Not entirely secure unless you KNOW that no criteria's groupby clause is going to be mis-used
419 419
             }
420 420
         }
421
-        $sql = 'SELECT ' . $field . 'COUNT(*) FROM ' . $this->table;
421
+        $sql = 'SELECT '.$field.'COUNT(*) FROM '.$this->table;
422 422
         if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
423
-            $sql .= ' ' . $criteria->renderWhere();
423
+            $sql .= ' '.$criteria->renderWhere();
424 424
             if ($criteria->groupby != '') {
425 425
                 $sql .= $criteria->getGroupby();
426 426
             }
@@ -467,11 +467,11 @@  discard block
 block discarded – undo
467 467
     public function getSum($field, $criteria = null)
468 468
     {
469 469
         $limit = $start = 0;
470
-        require_once __DIR__ . '/lite.php';
470
+        require_once __DIR__.'/lite.php';
471 471
 
472
-        $sql = 'SELECT Sum(' . $field . ') as cpt FROM ' . $this->table;
472
+        $sql = 'SELECT Sum('.$field.') as cpt FROM '.$this->table;
473 473
         if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
474
-            $sql .= ' ' . $criteria->renderWhere();
474
+            $sql .= ' '.$criteria->renderWhere();
475 475
             if ($criteria->groupby != '') {
476 476
                 $sql .= $criteria->getGroupby();
477 477
             }
@@ -512,13 +512,13 @@  discard block
 block discarded – undo
512 512
             $clause = array();
513 513
             $vnb    = count($this->keyName);
514 514
             for ($i = 0; $i < $vnb; ++$i) {
515
-                $clause[] = $this->keyName[$i] . ' = ' . $obj->getVar($this->keyName[$i]);
515
+                $clause[] = $this->keyName[$i].' = '.$obj->getVar($this->keyName[$i]);
516 516
             }
517 517
             $whereclause = implode(' AND ', $clause);
518 518
         } else {
519
-            $whereclause = $this->keyName . ' = ' . $obj->getVar($this->keyName);
519
+            $whereclause = $this->keyName.' = '.$obj->getVar($this->keyName);
520 520
         }
521
-        $sql = 'DELETE FROM ' . $this->table . ' WHERE ' . $whereclause;
521
+        $sql = 'DELETE FROM '.$this->table.' WHERE '.$whereclause;
522 522
         if (false != $force) {
523 523
             $result = $this->db->queryF($sql);
524 524
         } else {
@@ -545,7 +545,7 @@  discard block
 block discarded – undo
545 545
     {
546 546
         $object = $this->create(true);
547 547
         $object->setVars($vars);
548
-        $retval =& $this->insert($object, $force);
548
+        $retval = & $this->insert($object, $force);
549 549
         unset($object);
550 550
 
551 551
         // Clear cache
@@ -576,7 +576,7 @@  discard block
 block discarded – undo
576 576
              * @TODO: Change to if (!(class_exists($this->className) && $obj instanceof $this->className)) when going fully PHP5
577 577
              */
578 578
             if (!is_a($obj, $this->className)) {
579
-                $obj->setErrors(get_class($obj) . ' Differs from ' . $this->className);
579
+                $obj->setErrors(get_class($obj).' Differs from '.$this->className);
580 580
 
581 581
                 return false;
582 582
             }
@@ -595,7 +595,7 @@  discard block
 block discarded – undo
595 595
         }
596 596
         foreach ($obj->cleanVars as $k => $v) {
597 597
             if ($obj->vars[$k]['data_type'] == XOBJ_DTYPE_INT) {
598
-                $cleanvars[$k] = (int)$v;
598
+                $cleanvars[$k] = (int) $v;
599 599
             } elseif (is_array($v)) {
600 600
                 $cleanvars[$k] = $this->db->quoteString(implode(',', $v));
601 601
             } else {
@@ -608,16 +608,16 @@  discard block
 block discarded – undo
608 608
         if ($obj->isNew()) {
609 609
             if (!is_array($this->keyName)) {
610 610
                 if ($cleanvars[$this->keyName] < 1) {
611
-                    $cleanvars[$this->keyName] = $this->db->genId($this->table . '_' . $this->keyName . '_seq');
611
+                    $cleanvars[$this->keyName] = $this->db->genId($this->table.'_'.$this->keyName.'_seq');
612 612
                 }
613 613
             }
614 614
             $ignore = '';
615 615
             if ($ignoreInsert) {
616 616
                 $ignore = 'IGNORE';
617 617
             }
618
-            $sql = "INSERT $ignore INTO " . $this->table . ' (' . implode(',', array_keys($cleanvars)) . ') VALUES (' . implode(',', array_values($cleanvars)) . ')';
618
+            $sql = "INSERT $ignore INTO ".$this->table.' ('.implode(',', array_keys($cleanvars)).') VALUES ('.implode(',', array_values($cleanvars)).')';
619 619
         } else {
620
-            $sql = 'UPDATE ' . $this->table . ' SET';
620
+            $sql = 'UPDATE '.$this->table.' SET';
621 621
             foreach ($cleanvars as $key => $value) {
622 622
                 if ((!is_array($this->keyName) && $key == $this->keyName) || (is_array($this->keyName) && in_array($key, $this->keyName))) {
623 623
                     continue;
@@ -625,7 +625,7 @@  discard block
 block discarded – undo
625 625
                 if (isset($notfirst)) {
626 626
                     $sql .= ',';
627 627
                 }
628
-                $sql .= ' ' . $key . ' = ' . $value;
628
+                $sql .= ' '.$key.' = '.$value;
629 629
                 $notfirst = true;
630 630
             }
631 631
             if (is_array($this->keyName)) {
@@ -635,12 +635,12 @@  discard block
 block discarded – undo
635 635
                     if ($i > 0) {
636 636
                         $whereclause .= ' AND ';
637 637
                     }
638
-                    $whereclause .= $this->keyName[$i] . ' = ' . $obj->getVar($this->keyName[$i]);
638
+                    $whereclause .= $this->keyName[$i].' = '.$obj->getVar($this->keyName[$i]);
639 639
                 }
640 640
             } else {
641
-                $whereclause = $this->keyName . ' = ' . $obj->getVar($this->keyName);
641
+                $whereclause = $this->keyName.' = '.$obj->getVar($this->keyName);
642 642
             }
643
-            $sql .= ' WHERE ' . $whereclause;
643
+            $sql .= ' WHERE '.$whereclause;
644 644
         }
645 645
 
646 646
         if (false != $force) {
@@ -674,7 +674,7 @@  discard block
 block discarded – undo
674 674
      */
675 675
     public function updateAll($fieldname, $fieldvalue, $criteria = null, $force = false)
676 676
     {
677
-        $set_clause = $fieldname . ' = ';
677
+        $set_clause = $fieldname.' = ';
678 678
         if (is_numeric($fieldvalue)) {
679 679
             $set_clause .= $fieldvalue;
680 680
         } elseif (is_array($fieldvalue)) {
@@ -682,9 +682,9 @@  discard block
 block discarded – undo
682 682
         } else {
683 683
             $set_clause .= $this->db->quoteString($fieldvalue);
684 684
         }
685
-        $sql = 'UPDATE ' . $this->table . ' SET ' . $set_clause;
685
+        $sql = 'UPDATE '.$this->table.' SET '.$set_clause;
686 686
         if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
687
-            $sql .= ' ' . $criteria->renderWhere();
687
+            $sql .= ' '.$criteria->renderWhere();
688 688
         }
689 689
         if ($force) {
690 690
             $result = $this->db->queryF($sql);
@@ -732,8 +732,8 @@  discard block
 block discarded – undo
732 732
     public function deleteAll($criteria = null)
733 733
     {
734 734
         if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
735
-            $sql = 'DELETE FROM ' . $this->table;
736
-            $sql .= ' ' . $criteria->renderWhere();
735
+            $sql = 'DELETE FROM '.$this->table;
736
+            $sql .= ' '.$criteria->renderWhere();
737 737
             if (!$this->db->queryF($sql)) {
738 738
                 return false;
739 739
             }
@@ -779,15 +779,15 @@  discard block
 block discarded – undo
779 779
      */
780 780
     public function getDistincts($field, $criteria = null, $format = 's')
781 781
     {
782
-        require_once __DIR__ . '/lite.php';
782
+        require_once __DIR__.'/lite.php';
783 783
         $limit = $start = 0;
784
-        $sql   = 'SELECT ' . $this->keyName . ', ' . $field . ' FROM ' . $this->table;
784
+        $sql   = 'SELECT '.$this->keyName.', '.$field.' FROM '.$this->table;
785 785
         if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
786
-            $sql .= ' ' . $criteria->renderWhere();
786
+            $sql .= ' '.$criteria->renderWhere();
787 787
             $limit = $criteria->getLimit();
788 788
             $start = $criteria->getStart();
789 789
         }
790
-        $sql .= ' GROUP BY ' . $field . ' ORDER BY ' . $field;
790
+        $sql .= ' GROUP BY '.$field.' ORDER BY '.$field;
791 791
 
792 792
         $Cache_Lite = new references_Cache_Lite($this->cacheOptions);
793 793
         $id         = $this->_getIdForCache($sql, $start, $limit);
@@ -835,7 +835,7 @@  discard block
 block discarded – undo
835 835
         $critere->setStart($start);
836 836
         $critere->setSort($sort);
837 837
         $critere->setOrder($order);
838
-        $items =& $this->getObjects($critere, $idAsKey);
838
+        $items = & $this->getObjects($critere, $idAsKey);
839 839
 
840 840
         return $items;
841 841
     }
@@ -845,7 +845,7 @@  discard block
 block discarded – undo
845 845
      */
846 846
     public function forceCacheClean()
847 847
     {
848
-        require_once __DIR__ . '/lite.php';
848
+        require_once __DIR__.'/lite.php';
849 849
         $Cache_Lite = new references_Cache_Lite($this->cacheOptions);
850 850
         $Cache_Lite->clean();
851 851
     }
Please login to merge, or discard this patch.
Indentation   +808 added lines, -808 removed lines patch added patch discarded remove patch
@@ -25,44 +25,44 @@  discard block
 block discarded – undo
25 25
 
26 26
 class references_Object extends XoopsObject
27 27
 {
28
-    public function toArray($format = 's')
29
-    {
30
-        $ret = array();
31
-        foreach ($this->vars as $k => $v) {
32
-            $ret[$k] = $this->getVar($k, $format);
33
-        }
34
-
35
-        return $ret;
36
-    }
37
-
38
-    // TODO: Rajouter une méthode intsert() et delete()
39
-
40
-    /**
41
-     * Permet de valoriser un champ de la table comme si c'était une propriété de la classe
42
-     *
43
-     * @example $enregistrement->nom_du_champ = 'ma chaine'
44
-     *
45
-     * @param string $key   Le nom du champ à traiter
46
-     * @param mixed  $value La valeur à lui attribuer
47
-     * @return void
48
-     */
49
-    public function __set($key, $value)
50
-    {
51
-        return $this->setVar($key, $value);
52
-    }
53
-
54
-    /**
55
-     * Permet d'accéder aux champs de la table comme à des propriétés de la classe
56
-     *
57
-     * @example echo $enregistrement->nom_du_champ;
58
-     *
59
-     * @param string $key Le nom du champ que l'on souhaite récupérer
60
-     * @return mixed
61
-     */
62
-    public function __get($key)
63
-    {
64
-        return $this->getVar($key);
65
-    }
28
+	public function toArray($format = 's')
29
+	{
30
+		$ret = array();
31
+		foreach ($this->vars as $k => $v) {
32
+			$ret[$k] = $this->getVar($k, $format);
33
+		}
34
+
35
+		return $ret;
36
+	}
37
+
38
+	// TODO: Rajouter une méthode intsert() et delete()
39
+
40
+	/**
41
+	 * Permet de valoriser un champ de la table comme si c'était une propriété de la classe
42
+	 *
43
+	 * @example $enregistrement->nom_du_champ = 'ma chaine'
44
+	 *
45
+	 * @param string $key   Le nom du champ à traiter
46
+	 * @param mixed  $value La valeur à lui attribuer
47
+	 * @return void
48
+	 */
49
+	public function __set($key, $value)
50
+	{
51
+		return $this->setVar($key, $value);
52
+	}
53
+
54
+	/**
55
+	 * Permet d'accéder aux champs de la table comme à des propriétés de la classe
56
+	 *
57
+	 * @example echo $enregistrement->nom_du_champ;
58
+	 *
59
+	 * @param string $key Le nom du champ que l'on souhaite récupérer
60
+	 * @return mixed
61
+	 */
62
+	public function __get($key)
63
+	{
64
+		return $this->getVar($key);
65
+	}
66 66
 }
67 67
 
68 68
 /**
@@ -73,778 +73,778 @@  discard block
 block discarded – undo
73 73
  */
74 74
 class references_XoopsPersistableObjectHandler extends XoopsObjectHandler
75 75
 {
76
-    /**#@+
76
+	/**#@+
77 77
      * Information about the class, the handler is managing
78 78
      *
79 79
      * @var string
80 80
      */
81
-    public    $table;
82
-    public    $keyName;
83
-    public    $className;
84
-    public    $identifierName;
85
-    protected $cacheOptions = array();
86
-    /**#@-*/
87
-
88
-    /**
89
-     * Constructor - called from child classes
90
-     * @param object $db           {@link XoopsDatabase} object
91
-     * @param string $tablename    Name of database table
92
-     * @param string $classname    Name of Class, this handler is managing
93
-     * @param string $keyname      Name of the property, holding the key
94
-     * @param string $idenfierName Name of the property, holding the label
95
-     * @param array  $cacheOptions Optional, options for the cache
96
-     *
97
-     */
98
-    public function __construct(&$db, $tablename, $classname, $keyname, $idenfierName = '', $cacheOptions = null)
99
-    {
100
-        parent::__construct($db);
101
-        $this->table     = $db->prefix($tablename);
102
-        $this->keyName   = $keyname;
103
-        $this->className = $classname;
104
-        if (trim($idenfierName) != '') {
105
-            $this->identifierName = $idenfierName;
106
-        }
107
-        // To diable cache, add this line after the first one : 'caching' => false,
108
-        if (is_null($cacheOptions)) {
109
-            $this->setCachingOptions(array('cacheDir' => REFERENCES_CACHE_PATH, 'lifeTime' => null, 'automaticSerialization' => true, 'fileNameProtection' => false));
110
-        } else {
111
-            $this->setCachingOptions($cacheOptions);
112
-        }
113
-    }
114
-
115
-    public function setCachingOptions($cacheOptions)
116
-    {
117
-        $this->cacheOptions = $cacheOptions;
118
-    }
119
-
120
-    /**
121
-     * Generates a unique ID for a Sql Query
122
-     *
123
-     * @param  string  $query The SQL query for which we want a unidque ID
124
-     * @param  integer $start Which record to start at
125
-     * @param  integer $limit Max number of objects to fetch
126
-     * @return string  An MD5 of the query
127
-     */
128
-    protected function _getIdForCache($query, $start, $limit)
129
-    {
130
-        $id = md5($query . '-' . (string)$start . '-' . (string)$limit);
131
-
132
-        return $id;
133
-    }
134
-
135
-    /**
136
-     * create a new object
137
-     *
138
-     * @param bool $isNew Flag the new objects as "new"?
139
-     *
140
-     * @return object
141
-     */
142
-    public function &create($isNew = true)
143
-    {
144
-        $obj = new $this->className();
145
-        if ($isNew === true) {
146
-            $obj->setNew();
147
-        }
148
-
149
-        return $obj;
150
-    }
151
-
152
-    /**
153
-     * retrieve an object
154
-     *
155
-     * @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
156
-     * @param  bool  $as_object whether to return an object or an array
157
-     * @return mixed reference to the object, FALSE if failed
158
-     */
159
-    public function &get($id, $as_object = true)
160
-    {
161
-        if (is_array($this->keyName)) {
162
-            $criteria = new CriteriaCompo();
163
-            $vnb      = count($this->keyName);
164
-            for ($i = 0; $i < $vnb; ++$i) {
165
-                $criteria->add(new Criteria($this->keyName[$i], (int)$id[$i]));
166
-            }
167
-        } else {
168
-            $criteria = new Criteria($this->keyName, (int)$id);
169
-        }
170
-        $criteria->setLimit(1);
171
-        $obj_array =& $this->getObjects($criteria, false, $as_object);
172
-        if (count($obj_array) != 1) {
173
-            $ret = null;
174
-        } else {
175
-            $ret =& $obj_array[0];
176
-        }
177
-
178
-        return $ret;
179
-    }
180
-
181
-    /**
182
-     * retrieve objects from the database
183
-     *
184
-     * @param null|CriteriaElement $criteria  {@link CriteriaElement} conditions to be met
185
-     * @param bool                 $id_as_key use the ID as key for the array?
186
-     * @param bool                 $as_object return an array of objects?
187
-     *
188
-     * @param string               $fields
189
-     * @param bool                 $autoSort
190
-     * @return array
191
-     */
192
-    public function &getObjects(CriteriaElement $criteria = null, $id_as_key = false, $as_object = true, $fields = '*', $autoSort = true)
193
-    {
194
-        require_once __DIR__ . '/lite.php';
195
-        $ret   = array();
196
-        $limit = $start = 0;
197
-        $sql   = 'SELECT ' . $fields . ' FROM ' . $this->table;
198
-        if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
199
-            $sql .= ' ' . $criteria->renderWhere();
200
-            if ($criteria->groupby != '') {
201
-                $sql .= $criteria->getGroupby();
202
-            }
203
-            if ($criteria->getSort() != '') {
204
-                $sql .= ' ORDER BY ' . $criteria->getSort() . ' ' . $criteria->getOrder();
205
-            } elseif ($this->identifierName != '' && $autoSort) {
206
-                $sql .= ' ORDER BY ' . $this->identifierName;
207
-            }
208
-            $limit = $criteria->getLimit();
209
-            $start = $criteria->getStart();
210
-        }
211
-        $Cache_Lite = new references_Cache_Lite($this->cacheOptions);
212
-        $id         = $this->_getIdForCache($sql, $start, $limit);
213
-        $cacheData  = $Cache_Lite->get($id);
214
-        if ($cacheData === false) {
215
-            $result = $this->db->query($sql, $limit, $start);
216
-            if (!$result) {
217
-                return $ret;
218
-            }
219
-            $ret = $this->convertResultSet($result, $id_as_key, $as_object, $fields);
220
-            $Cache_Lite->save($ret);
221
-
222
-            return $ret;
223
-        } else {
224
-            return $cacheData;
225
-        }
226
-    }
227
-
228
-    /**
229
-     * Convert a database resultset to a returnable array
230
-     *
231
-     * @param object  $result    database resultset
232
-     * @param boolean $id_as_key - should NOT be used with joint keys
233
-     * @param boolean $as_object
234
-     * @param string  $fields    Requested fields from the query
235
-     *
236
-     * @return array
237
-     */
238
-    protected function convertResultSet($result, $id_as_key = false, $as_object = true, $fields = '*')
239
-    {
240
-        $ret = array();
241
-        while ($myrow = $this->db->fetchArray($result)) {
242
-            $obj =& $this->create(false);
243
-            $obj->assignVars($myrow);
244
-            if (!$id_as_key) {
245
-                if ($as_object) {
246
-                    $ret[] =& $obj;
247
-                } else {
248
-                    $row     = array();
249
-                    $vars    = $obj->getVars();
250
-                    $tbl_tmp = array_keys($vars);
251
-                    foreach ($tbl_tmp as $i) {
252
-                        $row[$i] = $obj->getVar($i);
253
-                    }
254
-                    $ret[] = $row;
255
-                }
256
-            } else {
257
-                if ($as_object) {
258
-                    if ($fields === '*') {
259
-                        $ret[$myrow[$this->keyName]] =& $obj;
260
-                    } else {
261
-                        $ret[] =& $obj;
262
-                    }
263
-                } else {
264
-                    $row     = array();
265
-                    $vars    = $obj->getVars();
266
-                    $tbl_tmp = array_keys($vars);
267
-                    foreach ($tbl_tmp as $i) {
268
-                        $row[$i] = $obj->getVar($i);
269
-                    }
270
-                    $ret[$myrow[$this->keyName]] = $row;
271
-                }
272
-            }
273
-            unset($obj);
274
-        }
275
-
276
-        return $ret;
277
-    }
278
-
279
-    /**
280
-     * get IDs of objects matching a condition
281
-     *
282
-     * @param  object $criteria {@link CriteriaElement} to match
283
-     * @return array  of object IDs
284
-     */
285
-    public function getIds($criteria = null)
286
-    {
287
-        require_once __DIR__ . '/lite.php';
288
-        $limit = $start = 0;
289
-
290
-        $Cache_Lite = new references_Cache_Lite($this->cacheOptions);
291
-        $sql        = 'SELECT ' . $this->keyName . ' FROM ' . $this->table;
292
-        if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
293
-            $sql .= ' ' . $criteria->renderWhere();
294
-            if ($criteria->groupby != '') {
295
-                $sql .= $criteria->getGroupby();
296
-            }
297
-            if ($criteria->getSort() != '') {
298
-                $sql .= ' ORDER BY ' . $criteria->getSort() . ' ' . $criteria->getOrder();
299
-            } elseif ($this->identifierName != '') {
300
-                $sql .= ' ORDER BY ' . $this->identifierName;
301
-            }
302
-            $limit = $criteria->getLimit();
303
-            $start = $criteria->getStart();
304
-        }
305
-
306
-        $id        = $this->_getIdForCache($sql, $start, $limit);
307
-        $cacheData = $Cache_Lite->get($id);
308
-        if ($cacheData === false) {
309
-            $result = $this->db->query($sql, $limit, $start);
310
-            $ret    = array();
311
-            while ($myrow = $this->db->fetchArray($result)) {
312
-                $ret[] = $myrow[$this->keyName];
313
-            }
314
-            $Cache_Lite->save($ret);
315
-
316
-            return $ret;
317
-        } else {
318
-            return $cacheData;
319
-        }
320
-    }
321
-
322
-    /**
323
-     * Retrieve a list of objects as arrays - DON'T USE WITH JOINT KEYS
324
-     *
325
-     * @param object $criteria {@link CriteriaElement} conditions to be met
326
-     * @return array
327
-     */
328
-    public function getList($criteria = null)
329
-    {
330
-        require_once __DIR__ . '/lite.php';
331
-        $limit      = $start = 0;
332
-        $Cache_Lite = new references_Cache_Lite($this->cacheOptions);
333
-
334
-        $ret = array();
335
-
336
-        $sql = 'SELECT ' . $this->keyName;
337
-        if (!empty($this->identifierName)) {
338
-            $sql .= ', ' . $this->identifierName;
339
-        }
340
-        $sql .= ' FROM ' . $this->table;
341
-        if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
342
-            $sql .= ' ' . $criteria->renderWhere();
343
-            if ($criteria->groupby != '') {
344
-                $sql .= $criteria->getGroupby();
345
-            }
346
-            if ($criteria->getSort() != '') {
347
-                $sql .= ' ORDER BY ' . $criteria->getSort() . ' ' . $criteria->getOrder();
348
-            } elseif ($this->identifierName != '') {
349
-                $sql .= ' ORDER BY ' . $this->identifierName;
350
-            }
351
-            $limit = $criteria->getLimit();
352
-            $start = $criteria->getStart();
353
-        }
354
-
355
-        $id        = $this->_getIdForCache($sql, $start, $limit);
356
-        $cacheData = $Cache_Lite->get($id);
357
-        if ($cacheData === false) {
358
-            $result = $this->db->query($sql, $limit, $start);
359
-            if (!$result) {
360
-                $Cache_Lite->save($ret);
361
-
362
-                return $ret;
363
-            }
364
-
365
-            $myts = MyTextSanitizer::getInstance();
366
-            while ($myrow = $this->db->fetchArray($result)) {
367
-                //identifiers should be textboxes, so sanitize them like that
368
-                $ret[$myrow[$this->keyName]] = empty($this->identifierName) ? 1 : $myts->htmlSpecialChars($myrow[$this->identifierName]);
369
-            }
370
-            $Cache_Lite->save($ret);
371
-
372
-            return $ret;
373
-        } else {
374
-            return $cacheData;
375
-        }
376
-    }
377
-
378
-    /**
379
-     * Retourne des éléments selon leur ID
380
-     *
381
-     * @param array $ids Les ID des éléments à retrouver
382
-     * @param null  $additionnal
383
-     * @return array Tableau d'objets
384
-     */
385
-    public function getItemsFromIds($ids, $additionnal = null)
386
-    {
387
-        $ret = array();
388
-        if (is_array($ids) && count($ids) > 0) {
389
-            $criteria = new CriteriaCompo();
390
-            $criteria->add(new Criteria($this->keyName, '(' . implode(',', $ids) . ')', 'IN'));
391
-            if (!is_null($additionnal)) {
392
-                $criteria->add($additionnal);
393
-            }
394
-            $ret =& $this->getObjects($criteria, true);
395
-        }
396
-
397
-        return $ret;
398
-    }
399
-
400
-    /**
401
-     * count objects matching a condition
402
-     *
403
-     * @param  object $criteria {@link CriteriaElement} to match
404
-     * @return int    count of objects
405
-     */
406
-    public function getCount($criteria = null)
407
-    {
408
-        $field   = '';
409
-        $groupby = false;
410
-        $limit   = $start = 0;
411
-        require_once __DIR__ . '/lite.php';
412
-
413
-        if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
414
-            if ($criteria->groupby != '') {
415
-                $groupby = true;
416
-                $field   = $criteria->groupby . ', '; //Not entirely secure unless you KNOW that no criteria's groupby clause is going to be mis-used
417
-            }
418
-        }
419
-        $sql = 'SELECT ' . $field . 'COUNT(*) FROM ' . $this->table;
420
-        if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
421
-            $sql .= ' ' . $criteria->renderWhere();
422
-            if ($criteria->groupby != '') {
423
-                $sql .= $criteria->getGroupby();
424
-            }
425
-            $limit = $criteria->getLimit();
426
-            $start = $criteria->getStart();
427
-        }
428
-        $Cache_Lite = new references_Cache_Lite($this->cacheOptions);
429
-        $id         = $this->_getIdForCache($sql, $start, $limit);
430
-        $cacheData  = $Cache_Lite->get($id);
431
-        if ($cacheData === false) {
432
-            $result = $this->db->query($sql, $limit, $start);
433
-            if (!$result) {
434
-                $ret = 0;
435
-                $Cache_Lite->save($ret);
436
-
437
-                return $ret;
438
-            }
439
-            if ($groupby == false) {
440
-                list($count) = $this->db->fetchRow($result);
441
-                $Cache_Lite->save($count);
442
-
443
-                return $count;
444
-            } else {
445
-                $ret = array();
446
-                while (list($id, $count) = $this->db->fetchRow($result)) {
447
-                    $ret[$id] = $count;
448
-                }
449
-                $Cache_Lite->save($ret);
450
-
451
-                return $ret;
452
-            }
453
-        } else {
454
-            return $cacheData;
455
-        }
456
-    }
457
-
458
-    /**
459
-     * Retourne le total d'un champ
460
-     *
461
-     * @param  string $field    Le champ dont on veut calculer le total
462
-     * @param  object $criteria {@link CriteriaElement} to match
463
-     * @return integer le total
464
-     */
465
-    public function getSum($field, $criteria = null)
466
-    {
467
-        $limit = $start = 0;
468
-        require_once __DIR__ . '/lite.php';
469
-
470
-        $sql = 'SELECT Sum(' . $field . ') as cpt FROM ' . $this->table;
471
-        if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
472
-            $sql .= ' ' . $criteria->renderWhere();
473
-            if ($criteria->groupby != '') {
474
-                $sql .= $criteria->getGroupby();
475
-            }
476
-            $limit = $criteria->getLimit();
477
-            $start = $criteria->getStart();
478
-        }
479
-        $Cache_Lite = new references_Cache_Lite($this->cacheOptions);
480
-        $id         = $this->_getIdForCache($sql, $start, $limit);
481
-        $cacheData  = $Cache_Lite->get($id);
482
-        if ($cacheData === false) {
483
-            $result = $this->db->query($sql, $limit, $start);
484
-            if (!$result) {
485
-                $ret = 0;
486
-                $Cache_Lite->save($ret);
487
-
488
-                return $ret;
489
-            }
490
-            $row   = $this->db->fetchArray($result);
491
-            $count = $row['cpt'];
492
-            $Cache_Lite->save($count);
493
-
494
-            return $count;
495
-        } else {
496
-            return $cacheData;
497
-        }
498
-    }
499
-
500
-    /**
501
-     * delete an object from the database
502
-     *
503
-     * @param  XoopsObject $obj reference to the object to delete
504
-     * @param  bool        $force
505
-     * @return bool   FALSE if failed.
506
-     */
507
-    public function delete(XoopsObject $obj, $force = false)
508
-    {
509
-        if (is_array($this->keyName)) {
510
-            $clause = array();
511
-            $vnb    = count($this->keyName);
512
-            for ($i = 0; $i < $vnb; ++$i) {
513
-                $clause[] = $this->keyName[$i] . ' = ' . $obj->getVar($this->keyName[$i]);
514
-            }
515
-            $whereclause = implode(' AND ', $clause);
516
-        } else {
517
-            $whereclause = $this->keyName . ' = ' . $obj->getVar($this->keyName);
518
-        }
519
-        $sql = 'DELETE FROM ' . $this->table . ' WHERE ' . $whereclause;
520
-        if (false != $force) {
521
-            $result = $this->db->queryF($sql);
522
-        } else {
523
-            $result = $this->db->query($sql);
524
-        }
525
-        // Clear cache
526
-        $this->forceCacheClean();
527
-
528
-        if (!$result) {
529
-            return false;
530
-        }
531
-
532
-        return true;
533
-    }
534
-
535
-    /**
536
-     * Quickly insert a record like this $myobject_handler->quickInsert('field1' => field1value, 'field2' => $field2value)
537
-     *
538
-     * @param  array $vars  Array containing the fields name and value
539
-     * @param  bool  $force whether to force the query execution despite security settings
540
-     * @return bool  @link insert's value
541
-     */
542
-    public function quickInsert($vars = null, $force = true)
543
-    {
544
-        $object = $this->create(true);
545
-        $object->setVars($vars);
546
-        $retval =& $this->insert($object, $force);
547
-        unset($object);
548
-
549
-        // Clear cache
550
-        $this->forceCacheClean();
551
-
552
-        return $retval;
553
-    }
554
-
555
-    /**
556
-     * insert a new object in the database
557
-     *
558
-     * @param  XoopsObject $obj         reference to the object
559
-     * @param  bool        $force       whether to force the query execution despite security settings
560
-     * @param  bool        $checkObject check if the object is dirty and clean the attributes
561
-     * @param bool         $ignoreInsert
562
-     * @return bool FALSE if failed, TRUE if already present and unchanged or successful
563
-     */
564
-
565
-    public function insert(XoopsObject $obj, $force = false, $checkObject = true, $ignoreInsert = false)
566
-    {
567
-        if ($checkObject != false) {
568
-            if (!is_object($obj)) {
569
-                trigger_error('Error, not object');
570
-
571
-                return false;
572
-            }
573
-            /**
574
-             * @TODO: Change to if (!(class_exists($this->className) && $obj instanceof $this->className)) when going fully PHP5
575
-             */
576
-            if (!is_a($obj, $this->className)) {
577
-                $obj->setErrors(get_class($obj) . ' Differs from ' . $this->className);
578
-
579
-                return false;
580
-            }
581
-            if (!$obj->isDirty()) {
582
-                $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
583
-
584
-                return true;
585
-            }
586
-        }
587
-        if (!$obj->cleanVars()) {
588
-            foreach ($obj->getErrors() as $oneerror) {
589
-                trigger_error($oneerror);
590
-            }
591
-
592
-            return false;
593
-        }
594
-        foreach ($obj->cleanVars as $k => $v) {
595
-            if ($obj->vars[$k]['data_type'] == XOBJ_DTYPE_INT) {
596
-                $cleanvars[$k] = (int)$v;
597
-            } elseif (is_array($v)) {
598
-                $cleanvars[$k] = $this->db->quoteString(implode(',', $v));
599
-            } else {
600
-                $cleanvars[$k] = $this->db->quoteString($v);
601
-            }
602
-        }
603
-        if (isset($cleanvars['dohtml'])) {        // Modification Herv� to be able to use dohtml
604
-            unset($cleanvars['dohtml']);
605
-        }
606
-        if ($obj->isNew()) {
607
-            if (!is_array($this->keyName)) {
608
-                if ($cleanvars[$this->keyName] < 1) {
609
-                    $cleanvars[$this->keyName] = $this->db->genId($this->table . '_' . $this->keyName . '_seq');
610
-                }
611
-            }
612
-            $ignore = '';
613
-            if ($ignoreInsert) {
614
-                $ignore = 'IGNORE';
615
-            }
616
-            $sql = "INSERT $ignore INTO " . $this->table . ' (' . implode(',', array_keys($cleanvars)) . ') VALUES (' . implode(',', array_values($cleanvars)) . ')';
617
-        } else {
618
-            $sql = 'UPDATE ' . $this->table . ' SET';
619
-            foreach ($cleanvars as $key => $value) {
620
-                if ((!is_array($this->keyName) && $key == $this->keyName) || (is_array($this->keyName) && in_array($key, $this->keyName))) {
621
-                    continue;
622
-                }
623
-                if (isset($notfirst)) {
624
-                    $sql .= ',';
625
-                }
626
-                $sql .= ' ' . $key . ' = ' . $value;
627
-                $notfirst = true;
628
-            }
629
-            if (is_array($this->keyName)) {
630
-                $whereclause = '';
631
-                $vnb         = count($this->keyName);
632
-                for ($i = 0; $i < $vnb; ++$i) {
633
-                    if ($i > 0) {
634
-                        $whereclause .= ' AND ';
635
-                    }
636
-                    $whereclause .= $this->keyName[$i] . ' = ' . $obj->getVar($this->keyName[$i]);
637
-                }
638
-            } else {
639
-                $whereclause = $this->keyName . ' = ' . $obj->getVar($this->keyName);
640
-            }
641
-            $sql .= ' WHERE ' . $whereclause;
642
-        }
643
-
644
-        if (false != $force) {
645
-            $result = $this->db->queryF($sql);
646
-        } else {
647
-            $result = $this->db->query($sql);
648
-        }
649
-
650
-        // Clear cache
651
-        $this->forceCacheClean();
652
-
653
-        if (!$result) {
654
-            return false;
655
-        }
656
-        if ($obj->isNew() && !is_array($this->keyName)) {
657
-            $obj->assignVar($this->keyName, $this->db->getInsertId());
658
-        }
659
-
660
-        return true;
661
-    }
662
-
663
-    /**
664
-     * Change a value for objects with a certain criteria
665
-     *
666
-     * @param string $fieldname  Name of the field
667
-     * @param string $fieldvalue Value to write
668
-     * @param object $criteria   {@link CriteriaElement}
669
-     *
670
-     * @param bool   $force
671
-     * @return bool
672
-     */
673
-    public function updateAll($fieldname, $fieldvalue, $criteria = null, $force = false)
674
-    {
675
-        $set_clause = $fieldname . ' = ';
676
-        if (is_numeric($fieldvalue)) {
677
-            $set_clause .= $fieldvalue;
678
-        } elseif (is_array($fieldvalue)) {
679
-            $set_clause .= $this->db->quoteString(implode(',', $fieldvalue));
680
-        } else {
681
-            $set_clause .= $this->db->quoteString($fieldvalue);
682
-        }
683
-        $sql = 'UPDATE ' . $this->table . ' SET ' . $set_clause;
684
-        if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
685
-            $sql .= ' ' . $criteria->renderWhere();
686
-        }
687
-        if ($force) {
688
-            $result = $this->db->queryF($sql);
689
-        } else {
690
-            $result = $this->db->query($sql);
691
-        }
692
-
693
-        // Clear cache
694
-        $this->forceCacheClean();
695
-
696
-        if (!$result) {
697
-            return false;
698
-        }
699
-
700
-        return true;
701
-    }
702
-
703
-    //  check if target object is attempting to use duplicated info
704
-    public function isDuplicated(&$obj, $field = '', $error = '')
705
-    {
706
-        if (empty($field)) {
707
-            return false;
708
-        }
709
-        $criteria = new CriteriaCompo();
710
-        $criteria->add(new Criteria($field, $obj->getVar($field)));
711
-        //  one more condition if target object exisits in database
712
-        if (!$obj->isNew()) {
713
-            $criteria->add(new Criteria($this->_key, $obj->getVar($this->_key), '!='));
714
-        }
715
-        if ($this->getCount($criteria)) {
716
-            $obj->setErrors($error);
717
-
718
-            return true;
719
-        }
720
-
721
-        return false;
722
-    }
723
-
724
-    /**
725
-     * delete all objects meeting the conditions
726
-     *
727
-     * @param  object $criteria {@link CriteriaElement} with conditions to meet
728
-     * @return bool
729
-     */
730
-    public function deleteAll($criteria = null)
731
-    {
732
-        if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
733
-            $sql = 'DELETE FROM ' . $this->table;
734
-            $sql .= ' ' . $criteria->renderWhere();
735
-            if (!$this->db->queryF($sql)) {
736
-                return false;
737
-            }
738
-            $rows = $this->db->getAffectedRows();
739
-
740
-            // Clear cache
741
-            $this->forceCacheClean();
742
-
743
-            return $rows > 0 ? $rows : true;
744
-        }
745
-
746
-        return false;
747
-    }
748
-
749
-    /**
750
-     * Compare two objects and returns, in an array, the differences
751
-     *
752
-     * @param  XoopsObject $old_object The first object to compare
753
-     * @param  XoopsObject $new_object The new object
754
-     * @return array       differences  key = fieldname, value = array('old_value', 'new_value')
755
-     */
756
-    public function compareObjects($old_object, $new_object)
757
-    {
758
-        $ret       = array();
759
-        $vars_name = array_keys($old_object->getVars());
760
-        foreach ($vars_name as $one_var) {
761
-            if ($old_object->getVar($one_var, 'f') == $new_object->getVar($one_var, 'f')) {
762
-            } else {
763
-                $ret[$one_var] = array($old_object->getVar($one_var), $new_object->getVar($one_var));
764
-            }
765
-        }
766
-
767
-        return $ret;
768
-    }
769
-
770
-    /**
771
-     * Get distincted values of a field in the table
772
-     *
773
-     * @param  string $field    Field's name
774
-     * @param  object $criteria {@link CriteriaElement} conditions to be met
775
-     * @param  string $format   Format in wich we want the datas
776
-     * @return array  containing the distinct values
777
-     */
778
-    public function getDistincts($field, $criteria = null, $format = 's')
779
-    {
780
-        require_once __DIR__ . '/lite.php';
781
-        $limit = $start = 0;
782
-        $sql   = 'SELECT ' . $this->keyName . ', ' . $field . ' FROM ' . $this->table;
783
-        if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
784
-            $sql .= ' ' . $criteria->renderWhere();
785
-            $limit = $criteria->getLimit();
786
-            $start = $criteria->getStart();
787
-        }
788
-        $sql .= ' GROUP BY ' . $field . ' ORDER BY ' . $field;
789
-
790
-        $Cache_Lite = new references_Cache_Lite($this->cacheOptions);
791
-        $id         = $this->_getIdForCache($sql, $start, $limit);
792
-        $cacheData  = $Cache_Lite->get($id);
793
-        if ($cacheData === false) {
794
-            $result = $this->db->query($sql, $limit, $start);
795
-            $ret    = array();
796
-            $obj    = new $this->className();
797
-            while ($myrow = $this->db->fetchArray($result)) {
798
-                $obj->setVar($field, $myrow[$field]);
799
-                $ret[$myrow[$this->keyName]] = $obj->getVar($field, $format);
800
-            }
801
-            $Cache_Lite->save($ret);
802
-
803
-            return $ret;
804
-        } else {
805
-            return $cacheData;
806
-        }
807
-    }
808
-
809
-    /**
810
-     * A generic shortcut to getObjects
811
-     *
812
-     * @author Herve Thouzard - Instant Zero
813
-     *
814
-     * @param  integer $start   Starting position
815
-     * @param  integer $limit   Maximum count of elements to return
816
-     * @param  string  $sort    Field to use for the sort
817
-     * @param  string  $order   Sort order
818
-     * @param  boolean $idAsKey Do we have to return an array whoses keys are the record's ID ?
819
-     * @return array   Array of current objects
820
-     */
821
-    public function getItems($start = 0, $limit = 0, $sort = '', $order = 'ASC', $idAsKey = true)
822
-    {
823
-        if (trim($order) == '') {
824
-            if (isset($this->identifierName) && trim($this->identifierName) != '') {
825
-                $order = $this->identifierName;
826
-            } else {
827
-                $order = $this->keyName;
828
-            }
829
-        }
830
-        $items   = array();
831
-        $critere = new Criteria($this->keyName, 0, '<>');
832
-        $critere->setLimit($limit);
833
-        $critere->setStart($start);
834
-        $critere->setSort($sort);
835
-        $critere->setOrder($order);
836
-        $items =& $this->getObjects($critere, $idAsKey);
837
-
838
-        return $items;
839
-    }
840
-
841
-    /**
842
-     * Forces the cache to be cleaned
843
-     */
844
-    public function forceCacheClean()
845
-    {
846
-        require_once __DIR__ . '/lite.php';
847
-        $Cache_Lite = new references_Cache_Lite($this->cacheOptions);
848
-        $Cache_Lite->clean();
849
-    }
81
+	public    $table;
82
+	public    $keyName;
83
+	public    $className;
84
+	public    $identifierName;
85
+	protected $cacheOptions = array();
86
+	/**#@-*/
87
+
88
+	/**
89
+	 * Constructor - called from child classes
90
+	 * @param object $db           {@link XoopsDatabase} object
91
+	 * @param string $tablename    Name of database table
92
+	 * @param string $classname    Name of Class, this handler is managing
93
+	 * @param string $keyname      Name of the property, holding the key
94
+	 * @param string $idenfierName Name of the property, holding the label
95
+	 * @param array  $cacheOptions Optional, options for the cache
96
+	 *
97
+	 */
98
+	public function __construct(&$db, $tablename, $classname, $keyname, $idenfierName = '', $cacheOptions = null)
99
+	{
100
+		parent::__construct($db);
101
+		$this->table     = $db->prefix($tablename);
102
+		$this->keyName   = $keyname;
103
+		$this->className = $classname;
104
+		if (trim($idenfierName) != '') {
105
+			$this->identifierName = $idenfierName;
106
+		}
107
+		// To diable cache, add this line after the first one : 'caching' => false,
108
+		if (is_null($cacheOptions)) {
109
+			$this->setCachingOptions(array('cacheDir' => REFERENCES_CACHE_PATH, 'lifeTime' => null, 'automaticSerialization' => true, 'fileNameProtection' => false));
110
+		} else {
111
+			$this->setCachingOptions($cacheOptions);
112
+		}
113
+	}
114
+
115
+	public function setCachingOptions($cacheOptions)
116
+	{
117
+		$this->cacheOptions = $cacheOptions;
118
+	}
119
+
120
+	/**
121
+	 * Generates a unique ID for a Sql Query
122
+	 *
123
+	 * @param  string  $query The SQL query for which we want a unidque ID
124
+	 * @param  integer $start Which record to start at
125
+	 * @param  integer $limit Max number of objects to fetch
126
+	 * @return string  An MD5 of the query
127
+	 */
128
+	protected function _getIdForCache($query, $start, $limit)
129
+	{
130
+		$id = md5($query . '-' . (string)$start . '-' . (string)$limit);
131
+
132
+		return $id;
133
+	}
134
+
135
+	/**
136
+	 * create a new object
137
+	 *
138
+	 * @param bool $isNew Flag the new objects as "new"?
139
+	 *
140
+	 * @return object
141
+	 */
142
+	public function &create($isNew = true)
143
+	{
144
+		$obj = new $this->className();
145
+		if ($isNew === true) {
146
+			$obj->setNew();
147
+		}
148
+
149
+		return $obj;
150
+	}
151
+
152
+	/**
153
+	 * retrieve an object
154
+	 *
155
+	 * @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
156
+	 * @param  bool  $as_object whether to return an object or an array
157
+	 * @return mixed reference to the object, FALSE if failed
158
+	 */
159
+	public function &get($id, $as_object = true)
160
+	{
161
+		if (is_array($this->keyName)) {
162
+			$criteria = new CriteriaCompo();
163
+			$vnb      = count($this->keyName);
164
+			for ($i = 0; $i < $vnb; ++$i) {
165
+				$criteria->add(new Criteria($this->keyName[$i], (int)$id[$i]));
166
+			}
167
+		} else {
168
+			$criteria = new Criteria($this->keyName, (int)$id);
169
+		}
170
+		$criteria->setLimit(1);
171
+		$obj_array =& $this->getObjects($criteria, false, $as_object);
172
+		if (count($obj_array) != 1) {
173
+			$ret = null;
174
+		} else {
175
+			$ret =& $obj_array[0];
176
+		}
177
+
178
+		return $ret;
179
+	}
180
+
181
+	/**
182
+	 * retrieve objects from the database
183
+	 *
184
+	 * @param null|CriteriaElement $criteria  {@link CriteriaElement} conditions to be met
185
+	 * @param bool                 $id_as_key use the ID as key for the array?
186
+	 * @param bool                 $as_object return an array of objects?
187
+	 *
188
+	 * @param string               $fields
189
+	 * @param bool                 $autoSort
190
+	 * @return array
191
+	 */
192
+	public function &getObjects(CriteriaElement $criteria = null, $id_as_key = false, $as_object = true, $fields = '*', $autoSort = true)
193
+	{
194
+		require_once __DIR__ . '/lite.php';
195
+		$ret   = array();
196
+		$limit = $start = 0;
197
+		$sql   = 'SELECT ' . $fields . ' FROM ' . $this->table;
198
+		if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
199
+			$sql .= ' ' . $criteria->renderWhere();
200
+			if ($criteria->groupby != '') {
201
+				$sql .= $criteria->getGroupby();
202
+			}
203
+			if ($criteria->getSort() != '') {
204
+				$sql .= ' ORDER BY ' . $criteria->getSort() . ' ' . $criteria->getOrder();
205
+			} elseif ($this->identifierName != '' && $autoSort) {
206
+				$sql .= ' ORDER BY ' . $this->identifierName;
207
+			}
208
+			$limit = $criteria->getLimit();
209
+			$start = $criteria->getStart();
210
+		}
211
+		$Cache_Lite = new references_Cache_Lite($this->cacheOptions);
212
+		$id         = $this->_getIdForCache($sql, $start, $limit);
213
+		$cacheData  = $Cache_Lite->get($id);
214
+		if ($cacheData === false) {
215
+			$result = $this->db->query($sql, $limit, $start);
216
+			if (!$result) {
217
+				return $ret;
218
+			}
219
+			$ret = $this->convertResultSet($result, $id_as_key, $as_object, $fields);
220
+			$Cache_Lite->save($ret);
221
+
222
+			return $ret;
223
+		} else {
224
+			return $cacheData;
225
+		}
226
+	}
227
+
228
+	/**
229
+	 * Convert a database resultset to a returnable array
230
+	 *
231
+	 * @param object  $result    database resultset
232
+	 * @param boolean $id_as_key - should NOT be used with joint keys
233
+	 * @param boolean $as_object
234
+	 * @param string  $fields    Requested fields from the query
235
+	 *
236
+	 * @return array
237
+	 */
238
+	protected function convertResultSet($result, $id_as_key = false, $as_object = true, $fields = '*')
239
+	{
240
+		$ret = array();
241
+		while ($myrow = $this->db->fetchArray($result)) {
242
+			$obj =& $this->create(false);
243
+			$obj->assignVars($myrow);
244
+			if (!$id_as_key) {
245
+				if ($as_object) {
246
+					$ret[] =& $obj;
247
+				} else {
248
+					$row     = array();
249
+					$vars    = $obj->getVars();
250
+					$tbl_tmp = array_keys($vars);
251
+					foreach ($tbl_tmp as $i) {
252
+						$row[$i] = $obj->getVar($i);
253
+					}
254
+					$ret[] = $row;
255
+				}
256
+			} else {
257
+				if ($as_object) {
258
+					if ($fields === '*') {
259
+						$ret[$myrow[$this->keyName]] =& $obj;
260
+					} else {
261
+						$ret[] =& $obj;
262
+					}
263
+				} else {
264
+					$row     = array();
265
+					$vars    = $obj->getVars();
266
+					$tbl_tmp = array_keys($vars);
267
+					foreach ($tbl_tmp as $i) {
268
+						$row[$i] = $obj->getVar($i);
269
+					}
270
+					$ret[$myrow[$this->keyName]] = $row;
271
+				}
272
+			}
273
+			unset($obj);
274
+		}
275
+
276
+		return $ret;
277
+	}
278
+
279
+	/**
280
+	 * get IDs of objects matching a condition
281
+	 *
282
+	 * @param  object $criteria {@link CriteriaElement} to match
283
+	 * @return array  of object IDs
284
+	 */
285
+	public function getIds($criteria = null)
286
+	{
287
+		require_once __DIR__ . '/lite.php';
288
+		$limit = $start = 0;
289
+
290
+		$Cache_Lite = new references_Cache_Lite($this->cacheOptions);
291
+		$sql        = 'SELECT ' . $this->keyName . ' FROM ' . $this->table;
292
+		if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
293
+			$sql .= ' ' . $criteria->renderWhere();
294
+			if ($criteria->groupby != '') {
295
+				$sql .= $criteria->getGroupby();
296
+			}
297
+			if ($criteria->getSort() != '') {
298
+				$sql .= ' ORDER BY ' . $criteria->getSort() . ' ' . $criteria->getOrder();
299
+			} elseif ($this->identifierName != '') {
300
+				$sql .= ' ORDER BY ' . $this->identifierName;
301
+			}
302
+			$limit = $criteria->getLimit();
303
+			$start = $criteria->getStart();
304
+		}
305
+
306
+		$id        = $this->_getIdForCache($sql, $start, $limit);
307
+		$cacheData = $Cache_Lite->get($id);
308
+		if ($cacheData === false) {
309
+			$result = $this->db->query($sql, $limit, $start);
310
+			$ret    = array();
311
+			while ($myrow = $this->db->fetchArray($result)) {
312
+				$ret[] = $myrow[$this->keyName];
313
+			}
314
+			$Cache_Lite->save($ret);
315
+
316
+			return $ret;
317
+		} else {
318
+			return $cacheData;
319
+		}
320
+	}
321
+
322
+	/**
323
+	 * Retrieve a list of objects as arrays - DON'T USE WITH JOINT KEYS
324
+	 *
325
+	 * @param object $criteria {@link CriteriaElement} conditions to be met
326
+	 * @return array
327
+	 */
328
+	public function getList($criteria = null)
329
+	{
330
+		require_once __DIR__ . '/lite.php';
331
+		$limit      = $start = 0;
332
+		$Cache_Lite = new references_Cache_Lite($this->cacheOptions);
333
+
334
+		$ret = array();
335
+
336
+		$sql = 'SELECT ' . $this->keyName;
337
+		if (!empty($this->identifierName)) {
338
+			$sql .= ', ' . $this->identifierName;
339
+		}
340
+		$sql .= ' FROM ' . $this->table;
341
+		if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
342
+			$sql .= ' ' . $criteria->renderWhere();
343
+			if ($criteria->groupby != '') {
344
+				$sql .= $criteria->getGroupby();
345
+			}
346
+			if ($criteria->getSort() != '') {
347
+				$sql .= ' ORDER BY ' . $criteria->getSort() . ' ' . $criteria->getOrder();
348
+			} elseif ($this->identifierName != '') {
349
+				$sql .= ' ORDER BY ' . $this->identifierName;
350
+			}
351
+			$limit = $criteria->getLimit();
352
+			$start = $criteria->getStart();
353
+		}
354
+
355
+		$id        = $this->_getIdForCache($sql, $start, $limit);
356
+		$cacheData = $Cache_Lite->get($id);
357
+		if ($cacheData === false) {
358
+			$result = $this->db->query($sql, $limit, $start);
359
+			if (!$result) {
360
+				$Cache_Lite->save($ret);
361
+
362
+				return $ret;
363
+			}
364
+
365
+			$myts = MyTextSanitizer::getInstance();
366
+			while ($myrow = $this->db->fetchArray($result)) {
367
+				//identifiers should be textboxes, so sanitize them like that
368
+				$ret[$myrow[$this->keyName]] = empty($this->identifierName) ? 1 : $myts->htmlSpecialChars($myrow[$this->identifierName]);
369
+			}
370
+			$Cache_Lite->save($ret);
371
+
372
+			return $ret;
373
+		} else {
374
+			return $cacheData;
375
+		}
376
+	}
377
+
378
+	/**
379
+	 * Retourne des éléments selon leur ID
380
+	 *
381
+	 * @param array $ids Les ID des éléments à retrouver
382
+	 * @param null  $additionnal
383
+	 * @return array Tableau d'objets
384
+	 */
385
+	public function getItemsFromIds($ids, $additionnal = null)
386
+	{
387
+		$ret = array();
388
+		if (is_array($ids) && count($ids) > 0) {
389
+			$criteria = new CriteriaCompo();
390
+			$criteria->add(new Criteria($this->keyName, '(' . implode(',', $ids) . ')', 'IN'));
391
+			if (!is_null($additionnal)) {
392
+				$criteria->add($additionnal);
393
+			}
394
+			$ret =& $this->getObjects($criteria, true);
395
+		}
396
+
397
+		return $ret;
398
+	}
399
+
400
+	/**
401
+	 * count objects matching a condition
402
+	 *
403
+	 * @param  object $criteria {@link CriteriaElement} to match
404
+	 * @return int    count of objects
405
+	 */
406
+	public function getCount($criteria = null)
407
+	{
408
+		$field   = '';
409
+		$groupby = false;
410
+		$limit   = $start = 0;
411
+		require_once __DIR__ . '/lite.php';
412
+
413
+		if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
414
+			if ($criteria->groupby != '') {
415
+				$groupby = true;
416
+				$field   = $criteria->groupby . ', '; //Not entirely secure unless you KNOW that no criteria's groupby clause is going to be mis-used
417
+			}
418
+		}
419
+		$sql = 'SELECT ' . $field . 'COUNT(*) FROM ' . $this->table;
420
+		if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
421
+			$sql .= ' ' . $criteria->renderWhere();
422
+			if ($criteria->groupby != '') {
423
+				$sql .= $criteria->getGroupby();
424
+			}
425
+			$limit = $criteria->getLimit();
426
+			$start = $criteria->getStart();
427
+		}
428
+		$Cache_Lite = new references_Cache_Lite($this->cacheOptions);
429
+		$id         = $this->_getIdForCache($sql, $start, $limit);
430
+		$cacheData  = $Cache_Lite->get($id);
431
+		if ($cacheData === false) {
432
+			$result = $this->db->query($sql, $limit, $start);
433
+			if (!$result) {
434
+				$ret = 0;
435
+				$Cache_Lite->save($ret);
436
+
437
+				return $ret;
438
+			}
439
+			if ($groupby == false) {
440
+				list($count) = $this->db->fetchRow($result);
441
+				$Cache_Lite->save($count);
442
+
443
+				return $count;
444
+			} else {
445
+				$ret = array();
446
+				while (list($id, $count) = $this->db->fetchRow($result)) {
447
+					$ret[$id] = $count;
448
+				}
449
+				$Cache_Lite->save($ret);
450
+
451
+				return $ret;
452
+			}
453
+		} else {
454
+			return $cacheData;
455
+		}
456
+	}
457
+
458
+	/**
459
+	 * Retourne le total d'un champ
460
+	 *
461
+	 * @param  string $field    Le champ dont on veut calculer le total
462
+	 * @param  object $criteria {@link CriteriaElement} to match
463
+	 * @return integer le total
464
+	 */
465
+	public function getSum($field, $criteria = null)
466
+	{
467
+		$limit = $start = 0;
468
+		require_once __DIR__ . '/lite.php';
469
+
470
+		$sql = 'SELECT Sum(' . $field . ') as cpt FROM ' . $this->table;
471
+		if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
472
+			$sql .= ' ' . $criteria->renderWhere();
473
+			if ($criteria->groupby != '') {
474
+				$sql .= $criteria->getGroupby();
475
+			}
476
+			$limit = $criteria->getLimit();
477
+			$start = $criteria->getStart();
478
+		}
479
+		$Cache_Lite = new references_Cache_Lite($this->cacheOptions);
480
+		$id         = $this->_getIdForCache($sql, $start, $limit);
481
+		$cacheData  = $Cache_Lite->get($id);
482
+		if ($cacheData === false) {
483
+			$result = $this->db->query($sql, $limit, $start);
484
+			if (!$result) {
485
+				$ret = 0;
486
+				$Cache_Lite->save($ret);
487
+
488
+				return $ret;
489
+			}
490
+			$row   = $this->db->fetchArray($result);
491
+			$count = $row['cpt'];
492
+			$Cache_Lite->save($count);
493
+
494
+			return $count;
495
+		} else {
496
+			return $cacheData;
497
+		}
498
+	}
499
+
500
+	/**
501
+	 * delete an object from the database
502
+	 *
503
+	 * @param  XoopsObject $obj reference to the object to delete
504
+	 * @param  bool        $force
505
+	 * @return bool   FALSE if failed.
506
+	 */
507
+	public function delete(XoopsObject $obj, $force = false)
508
+	{
509
+		if (is_array($this->keyName)) {
510
+			$clause = array();
511
+			$vnb    = count($this->keyName);
512
+			for ($i = 0; $i < $vnb; ++$i) {
513
+				$clause[] = $this->keyName[$i] . ' = ' . $obj->getVar($this->keyName[$i]);
514
+			}
515
+			$whereclause = implode(' AND ', $clause);
516
+		} else {
517
+			$whereclause = $this->keyName . ' = ' . $obj->getVar($this->keyName);
518
+		}
519
+		$sql = 'DELETE FROM ' . $this->table . ' WHERE ' . $whereclause;
520
+		if (false != $force) {
521
+			$result = $this->db->queryF($sql);
522
+		} else {
523
+			$result = $this->db->query($sql);
524
+		}
525
+		// Clear cache
526
+		$this->forceCacheClean();
527
+
528
+		if (!$result) {
529
+			return false;
530
+		}
531
+
532
+		return true;
533
+	}
534
+
535
+	/**
536
+	 * Quickly insert a record like this $myobject_handler->quickInsert('field1' => field1value, 'field2' => $field2value)
537
+	 *
538
+	 * @param  array $vars  Array containing the fields name and value
539
+	 * @param  bool  $force whether to force the query execution despite security settings
540
+	 * @return bool  @link insert's value
541
+	 */
542
+	public function quickInsert($vars = null, $force = true)
543
+	{
544
+		$object = $this->create(true);
545
+		$object->setVars($vars);
546
+		$retval =& $this->insert($object, $force);
547
+		unset($object);
548
+
549
+		// Clear cache
550
+		$this->forceCacheClean();
551
+
552
+		return $retval;
553
+	}
554
+
555
+	/**
556
+	 * insert a new object in the database
557
+	 *
558
+	 * @param  XoopsObject $obj         reference to the object
559
+	 * @param  bool        $force       whether to force the query execution despite security settings
560
+	 * @param  bool        $checkObject check if the object is dirty and clean the attributes
561
+	 * @param bool         $ignoreInsert
562
+	 * @return bool FALSE if failed, TRUE if already present and unchanged or successful
563
+	 */
564
+
565
+	public function insert(XoopsObject $obj, $force = false, $checkObject = true, $ignoreInsert = false)
566
+	{
567
+		if ($checkObject != false) {
568
+			if (!is_object($obj)) {
569
+				trigger_error('Error, not object');
570
+
571
+				return false;
572
+			}
573
+			/**
574
+			 * @TODO: Change to if (!(class_exists($this->className) && $obj instanceof $this->className)) when going fully PHP5
575
+			 */
576
+			if (!is_a($obj, $this->className)) {
577
+				$obj->setErrors(get_class($obj) . ' Differs from ' . $this->className);
578
+
579
+				return false;
580
+			}
581
+			if (!$obj->isDirty()) {
582
+				$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
583
+
584
+				return true;
585
+			}
586
+		}
587
+		if (!$obj->cleanVars()) {
588
+			foreach ($obj->getErrors() as $oneerror) {
589
+				trigger_error($oneerror);
590
+			}
591
+
592
+			return false;
593
+		}
594
+		foreach ($obj->cleanVars as $k => $v) {
595
+			if ($obj->vars[$k]['data_type'] == XOBJ_DTYPE_INT) {
596
+				$cleanvars[$k] = (int)$v;
597
+			} elseif (is_array($v)) {
598
+				$cleanvars[$k] = $this->db->quoteString(implode(',', $v));
599
+			} else {
600
+				$cleanvars[$k] = $this->db->quoteString($v);
601
+			}
602
+		}
603
+		if (isset($cleanvars['dohtml'])) {        // Modification Herv� to be able to use dohtml
604
+			unset($cleanvars['dohtml']);
605
+		}
606
+		if ($obj->isNew()) {
607
+			if (!is_array($this->keyName)) {
608
+				if ($cleanvars[$this->keyName] < 1) {
609
+					$cleanvars[$this->keyName] = $this->db->genId($this->table . '_' . $this->keyName . '_seq');
610
+				}
611
+			}
612
+			$ignore = '';
613
+			if ($ignoreInsert) {
614
+				$ignore = 'IGNORE';
615
+			}
616
+			$sql = "INSERT $ignore INTO " . $this->table . ' (' . implode(',', array_keys($cleanvars)) . ') VALUES (' . implode(',', array_values($cleanvars)) . ')';
617
+		} else {
618
+			$sql = 'UPDATE ' . $this->table . ' SET';
619
+			foreach ($cleanvars as $key => $value) {
620
+				if ((!is_array($this->keyName) && $key == $this->keyName) || (is_array($this->keyName) && in_array($key, $this->keyName))) {
621
+					continue;
622
+				}
623
+				if (isset($notfirst)) {
624
+					$sql .= ',';
625
+				}
626
+				$sql .= ' ' . $key . ' = ' . $value;
627
+				$notfirst = true;
628
+			}
629
+			if (is_array($this->keyName)) {
630
+				$whereclause = '';
631
+				$vnb         = count($this->keyName);
632
+				for ($i = 0; $i < $vnb; ++$i) {
633
+					if ($i > 0) {
634
+						$whereclause .= ' AND ';
635
+					}
636
+					$whereclause .= $this->keyName[$i] . ' = ' . $obj->getVar($this->keyName[$i]);
637
+				}
638
+			} else {
639
+				$whereclause = $this->keyName . ' = ' . $obj->getVar($this->keyName);
640
+			}
641
+			$sql .= ' WHERE ' . $whereclause;
642
+		}
643
+
644
+		if (false != $force) {
645
+			$result = $this->db->queryF($sql);
646
+		} else {
647
+			$result = $this->db->query($sql);
648
+		}
649
+
650
+		// Clear cache
651
+		$this->forceCacheClean();
652
+
653
+		if (!$result) {
654
+			return false;
655
+		}
656
+		if ($obj->isNew() && !is_array($this->keyName)) {
657
+			$obj->assignVar($this->keyName, $this->db->getInsertId());
658
+		}
659
+
660
+		return true;
661
+	}
662
+
663
+	/**
664
+	 * Change a value for objects with a certain criteria
665
+	 *
666
+	 * @param string $fieldname  Name of the field
667
+	 * @param string $fieldvalue Value to write
668
+	 * @param object $criteria   {@link CriteriaElement}
669
+	 *
670
+	 * @param bool   $force
671
+	 * @return bool
672
+	 */
673
+	public function updateAll($fieldname, $fieldvalue, $criteria = null, $force = false)
674
+	{
675
+		$set_clause = $fieldname . ' = ';
676
+		if (is_numeric($fieldvalue)) {
677
+			$set_clause .= $fieldvalue;
678
+		} elseif (is_array($fieldvalue)) {
679
+			$set_clause .= $this->db->quoteString(implode(',', $fieldvalue));
680
+		} else {
681
+			$set_clause .= $this->db->quoteString($fieldvalue);
682
+		}
683
+		$sql = 'UPDATE ' . $this->table . ' SET ' . $set_clause;
684
+		if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
685
+			$sql .= ' ' . $criteria->renderWhere();
686
+		}
687
+		if ($force) {
688
+			$result = $this->db->queryF($sql);
689
+		} else {
690
+			$result = $this->db->query($sql);
691
+		}
692
+
693
+		// Clear cache
694
+		$this->forceCacheClean();
695
+
696
+		if (!$result) {
697
+			return false;
698
+		}
699
+
700
+		return true;
701
+	}
702
+
703
+	//  check if target object is attempting to use duplicated info
704
+	public function isDuplicated(&$obj, $field = '', $error = '')
705
+	{
706
+		if (empty($field)) {
707
+			return false;
708
+		}
709
+		$criteria = new CriteriaCompo();
710
+		$criteria->add(new Criteria($field, $obj->getVar($field)));
711
+		//  one more condition if target object exisits in database
712
+		if (!$obj->isNew()) {
713
+			$criteria->add(new Criteria($this->_key, $obj->getVar($this->_key), '!='));
714
+		}
715
+		if ($this->getCount($criteria)) {
716
+			$obj->setErrors($error);
717
+
718
+			return true;
719
+		}
720
+
721
+		return false;
722
+	}
723
+
724
+	/**
725
+	 * delete all objects meeting the conditions
726
+	 *
727
+	 * @param  object $criteria {@link CriteriaElement} with conditions to meet
728
+	 * @return bool
729
+	 */
730
+	public function deleteAll($criteria = null)
731
+	{
732
+		if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
733
+			$sql = 'DELETE FROM ' . $this->table;
734
+			$sql .= ' ' . $criteria->renderWhere();
735
+			if (!$this->db->queryF($sql)) {
736
+				return false;
737
+			}
738
+			$rows = $this->db->getAffectedRows();
739
+
740
+			// Clear cache
741
+			$this->forceCacheClean();
742
+
743
+			return $rows > 0 ? $rows : true;
744
+		}
745
+
746
+		return false;
747
+	}
748
+
749
+	/**
750
+	 * Compare two objects and returns, in an array, the differences
751
+	 *
752
+	 * @param  XoopsObject $old_object The first object to compare
753
+	 * @param  XoopsObject $new_object The new object
754
+	 * @return array       differences  key = fieldname, value = array('old_value', 'new_value')
755
+	 */
756
+	public function compareObjects($old_object, $new_object)
757
+	{
758
+		$ret       = array();
759
+		$vars_name = array_keys($old_object->getVars());
760
+		foreach ($vars_name as $one_var) {
761
+			if ($old_object->getVar($one_var, 'f') == $new_object->getVar($one_var, 'f')) {
762
+			} else {
763
+				$ret[$one_var] = array($old_object->getVar($one_var), $new_object->getVar($one_var));
764
+			}
765
+		}
766
+
767
+		return $ret;
768
+	}
769
+
770
+	/**
771
+	 * Get distincted values of a field in the table
772
+	 *
773
+	 * @param  string $field    Field's name
774
+	 * @param  object $criteria {@link CriteriaElement} conditions to be met
775
+	 * @param  string $format   Format in wich we want the datas
776
+	 * @return array  containing the distinct values
777
+	 */
778
+	public function getDistincts($field, $criteria = null, $format = 's')
779
+	{
780
+		require_once __DIR__ . '/lite.php';
781
+		$limit = $start = 0;
782
+		$sql   = 'SELECT ' . $this->keyName . ', ' . $field . ' FROM ' . $this->table;
783
+		if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
784
+			$sql .= ' ' . $criteria->renderWhere();
785
+			$limit = $criteria->getLimit();
786
+			$start = $criteria->getStart();
787
+		}
788
+		$sql .= ' GROUP BY ' . $field . ' ORDER BY ' . $field;
789
+
790
+		$Cache_Lite = new references_Cache_Lite($this->cacheOptions);
791
+		$id         = $this->_getIdForCache($sql, $start, $limit);
792
+		$cacheData  = $Cache_Lite->get($id);
793
+		if ($cacheData === false) {
794
+			$result = $this->db->query($sql, $limit, $start);
795
+			$ret    = array();
796
+			$obj    = new $this->className();
797
+			while ($myrow = $this->db->fetchArray($result)) {
798
+				$obj->setVar($field, $myrow[$field]);
799
+				$ret[$myrow[$this->keyName]] = $obj->getVar($field, $format);
800
+			}
801
+			$Cache_Lite->save($ret);
802
+
803
+			return $ret;
804
+		} else {
805
+			return $cacheData;
806
+		}
807
+	}
808
+
809
+	/**
810
+	 * A generic shortcut to getObjects
811
+	 *
812
+	 * @author Herve Thouzard - Instant Zero
813
+	 *
814
+	 * @param  integer $start   Starting position
815
+	 * @param  integer $limit   Maximum count of elements to return
816
+	 * @param  string  $sort    Field to use for the sort
817
+	 * @param  string  $order   Sort order
818
+	 * @param  boolean $idAsKey Do we have to return an array whoses keys are the record's ID ?
819
+	 * @return array   Array of current objects
820
+	 */
821
+	public function getItems($start = 0, $limit = 0, $sort = '', $order = 'ASC', $idAsKey = true)
822
+	{
823
+		if (trim($order) == '') {
824
+			if (isset($this->identifierName) && trim($this->identifierName) != '') {
825
+				$order = $this->identifierName;
826
+			} else {
827
+				$order = $this->keyName;
828
+			}
829
+		}
830
+		$items   = array();
831
+		$critere = new Criteria($this->keyName, 0, '<>');
832
+		$critere->setLimit($limit);
833
+		$critere->setStart($start);
834
+		$critere->setSort($sort);
835
+		$critere->setOrder($order);
836
+		$items =& $this->getObjects($critere, $idAsKey);
837
+
838
+		return $items;
839
+	}
840
+
841
+	/**
842
+	 * Forces the cache to be cleaned
843
+	 */
844
+	public function forceCacheClean()
845
+	{
846
+		require_once __DIR__ . '/lite.php';
847
+		$Cache_Lite = new references_Cache_Lite($this->cacheOptions);
848
+		$Cache_Lite->clean();
849
+	}
850 850
 }
Please login to merge, or discard this patch.
class/references_articles.php 3 patches
Doc Comments   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -499,7 +499,7 @@  discard block
 block discarded – undo
499 499
     /**
500 500
      * Notification de la publication d'une nouvelle référence
501 501
      *
502
-     * @param object|references_articles $article L'annonce pour laquelle on fait la notification
502
+     * @param references_articles $article L'annonce pour laquelle on fait la notification
503 503
      * @return bool
504 504
      */
505 505
     public function notifyNewArticle(references_articles $article)
@@ -574,7 +574,7 @@  discard block
 block discarded – undo
574 574
     /**
575 575
      * Indique si une référence est visible d'un utilisateur
576 576
      *
577
-     * @param object|references_articles $article L'article à controler
577
+     * @param references_articles $article L'article à controler
578 578
      * @param integer                    $uid     L'id de l'utilisateur à controler
579 579
      * @return bool
580 580
      */
Please login to merge, or discard this patch.
Spacing   +45 added lines, -45 removed lines patch added patch discarded remove patch
@@ -22,13 +22,13 @@  discard block
 block discarded – undo
22 22
     die('XOOPS root path not defined');
23 23
 }
24 24
 
25
-require_once XOOPS_ROOT_PATH . '/kernel/object.php';
25
+require_once XOOPS_ROOT_PATH.'/kernel/object.php';
26 26
 if (!class_exists('references_XoopsPersistableObjectHandler')) {
27
-    require_once XOOPS_ROOT_PATH . '/modules/references/class/PersistableObjectHandler.php';
27
+    require_once XOOPS_ROOT_PATH.'/modules/references/class/PersistableObjectHandler.php';
28 28
 }
29 29
 
30
-define('REFERENCES_STATUS_ONLINE', 1);    // Articles en ligne
31
-define('REFERENCES_STATUS_OFFLINE', 0);    // Articles hors ligne
30
+define('REFERENCES_STATUS_ONLINE', 1); // Articles en ligne
31
+define('REFERENCES_STATUS_OFFLINE', 0); // Articles hors ligne
32 32
 
33 33
 class references_articles extends references_Object
34 34
 {
@@ -89,9 +89,9 @@  discard block
 block discarded – undo
89 89
     public function getOnlinePicture()
90 90
     {
91 91
         if ($this->isArticleOnline()) {
92
-            return REFERENCES_IMAGES_URL . 'status_online.png';
92
+            return REFERENCES_IMAGES_URL.'status_online.png';
93 93
         } else {
94
-            return REFERENCES_IMAGES_URL . 'status_offline.png';
94
+            return REFERENCES_IMAGES_URL.'status_offline.png';
95 95
         }
96 96
     }
97 97
 
@@ -114,8 +114,8 @@  discard block
 block discarded – undo
114 114
     public function pictureExists($indice)
115 115
     {
116 116
         $return    = false;
117
-        $fieldName = 'article_picture' . $indice;
118
-        if (xoops_trim($this->getVar($fieldName)) != '' && file_exists(references_utils::getModuleOption('images_path') . DIRECTORY_SEPARATOR . $this->getVar($fieldName))) {
117
+        $fieldName = 'article_picture'.$indice;
118
+        if (xoops_trim($this->getVar($fieldName)) != '' && file_exists(references_utils::getModuleOption('images_path').DIRECTORY_SEPARATOR.$this->getVar($fieldName))) {
119 119
             $return = true;
120 120
         }
121 121
 
@@ -130,9 +130,9 @@  discard block
 block discarded – undo
130 130
      */
131 131
     public function deletePicture($indice)
132 132
     {
133
-        $fieldName = 'article_picture' . $indice;
133
+        $fieldName = 'article_picture'.$indice;
134 134
         if ($this->pictureExists($indice)) {
135
-            @unlink(references_utils::getModuleOption('images_path') . references_utils::getModuleOption('images_path') . $this->getVar($fieldName));
135
+            @unlink(references_utils::getModuleOption('images_path').references_utils::getModuleOption('images_path').$this->getVar($fieldName));
136 136
         }
137 137
         $this->setVar($fieldName, '');
138 138
     }
@@ -145,11 +145,11 @@  discard block
 block discarded – undo
145 145
      */
146 146
     public function getPictureUrl($indice)
147 147
     {
148
-        $fieldName = 'article_picture' . $indice;
148
+        $fieldName = 'article_picture'.$indice;
149 149
         if (xoops_trim($this->getVar($fieldName)) != '' && $this->pictureExists($indice)) {
150
-            return references_utils::getModuleOption('images_url') . '/' . $this->getVar($fieldName);
150
+            return references_utils::getModuleOption('images_url').'/'.$this->getVar($fieldName);
151 151
         } else {
152
-            return REFERENCES_IMAGES_URL . 'blank.gif';
152
+            return REFERENCES_IMAGES_URL.'blank.gif';
153 153
         }
154 154
     }
155 155
 
@@ -161,9 +161,9 @@  discard block
 block discarded – undo
161 161
      */
162 162
     public function getPicturePath($indice)
163 163
     {
164
-        $fieldName = 'article_picture' . $indice;
164
+        $fieldName = 'article_picture'.$indice;
165 165
         if (xoops_trim($this->getVar($fieldName)) != '') {
166
-            return references_utils::getModuleOption('images_path') . DIRECTORY_SEPARATOR . $this->getVar($fieldName);
166
+            return references_utils::getModuleOption('images_path').DIRECTORY_SEPARATOR.$this->getVar($fieldName);
167 167
         } else {
168 168
             return '';
169 169
         }
@@ -177,9 +177,9 @@  discard block
 block discarded – undo
177 177
      */
178 178
     public function thumbExists($indice)
179 179
     {
180
-        $fieldName = 'article_picture' . $indice;
180
+        $fieldName = 'article_picture'.$indice;
181 181
         $return    = false;
182
-        if (xoops_trim($this->getVar($fieldName)) != '' && file_exists(references_utils::getModuleOption('images_path') . DIRECTORY_SEPARATOR . REFERENCES_THUMBS_PREFIX . $this->getVar($fieldName))) {
182
+        if (xoops_trim($this->getVar($fieldName)) != '' && file_exists(references_utils::getModuleOption('images_path').DIRECTORY_SEPARATOR.REFERENCES_THUMBS_PREFIX.$this->getVar($fieldName))) {
183 183
             $return = true;
184 184
         }
185 185
 
@@ -194,11 +194,11 @@  discard block
 block discarded – undo
194 194
      */
195 195
     public function getThumbUrl($indice)
196 196
     {
197
-        $fieldName = 'article_picture' . $indice;
197
+        $fieldName = 'article_picture'.$indice;
198 198
         if (xoops_trim($this->getVar($fieldName)) != '') {
199
-            return references_utils::getModuleOption('images_url') . '/' . REFERENCES_THUMBS_PREFIX . $this->getVar($fieldName);
199
+            return references_utils::getModuleOption('images_url').'/'.REFERENCES_THUMBS_PREFIX.$this->getVar($fieldName);
200 200
         } else {
201
-            return REFERENCES_IMAGES_URL . 'blank.gif';
201
+            return REFERENCES_IMAGES_URL.'blank.gif';
202 202
         }
203 203
     }
204 204
 
@@ -210,9 +210,9 @@  discard block
 block discarded – undo
210 210
      */
211 211
     public function getThumbPath($indice)
212 212
     {
213
-        $fieldName = 'article_picture' . $indice;
213
+        $fieldName = 'article_picture'.$indice;
214 214
         if (xoops_trim($this->getVar($fieldName)) != '') {
215
-            return references_utils::getModuleOption('images_path') . DIRECTORY_SEPARATOR . REFERENCES_THUMBS_PREFIX . $this->getVar($fieldName);
215
+            return references_utils::getModuleOption('images_path').DIRECTORY_SEPARATOR.REFERENCES_THUMBS_PREFIX.$this->getVar($fieldName);
216 216
         } else {
217 217
             return '';
218 218
         }
@@ -226,7 +226,7 @@  discard block
 block discarded – undo
226 226
     public function attachmentExists()
227 227
     {
228 228
         $return = false;
229
-        if (xoops_trim($this->getVar('article_attached_file')) != '' && file_exists(references_utils::getModuleOption('attached_path') . DIRECTORY_SEPARATOR . $this->getVar('article_attached_file'))) {
229
+        if (xoops_trim($this->getVar('article_attached_file')) != '' && file_exists(references_utils::getModuleOption('attached_path').DIRECTORY_SEPARATOR.$this->getVar('article_attached_file'))) {
230 230
             $return = true;
231 231
         }
232 232
 
@@ -241,7 +241,7 @@  discard block
 block discarded – undo
241 241
     public function getAttachmentUrl()
242 242
     {
243 243
         if (xoops_trim($this->getVar('article_attached_file')) != '' && $this->attachmentExists()) {
244
-            return references_utils::getModuleOption('attached_url') . '/' . $this->getVar('article_attached_file');
244
+            return references_utils::getModuleOption('attached_url').'/'.$this->getVar('article_attached_file');
245 245
         } else {
246 246
             return '';
247 247
         }
@@ -255,7 +255,7 @@  discard block
 block discarded – undo
255 255
     public function getAttachmentPath()
256 256
     {
257 257
         if (xoops_trim($this->getVar('article_attached_file')) != '' && $this->attachmentExists()) {
258
-            return references_utils::getModuleOption('attached_path') . DIRECTORY_SEPARATOR . $this->getVar('article_attached_file');
258
+            return references_utils::getModuleOption('attached_path').DIRECTORY_SEPARATOR.$this->getVar('article_attached_file');
259 259
         } else {
260 260
             return '';
261 261
         }
@@ -267,7 +267,7 @@  discard block
 block discarded – undo
267 267
     public function deleteAttachment()
268 268
     {
269 269
         if ($this->attachmentExists()) {
270
-            @unlink(references_utils::getModuleOption('attached_path') . DIRECTORY_SEPARATOR . $this->getVar('article_attached_file'));
270
+            @unlink(references_utils::getModuleOption('attached_path').DIRECTORY_SEPARATOR.$this->getVar('article_attached_file'));
271 271
         }
272 272
         $this->setVar('article_attached_file', '');
273 273
     }
@@ -280,9 +280,9 @@  discard block
 block discarded – undo
280 280
      */
281 281
     public function deleteThumb($indice)
282 282
     {
283
-        $fieldName = 'article_picture' . $indice;
283
+        $fieldName = 'article_picture'.$indice;
284 284
         if ($this->thumbExists($indice)) {
285
-            @unlink(references_utils::getModuleOption('images_path') . DIRECTORY_SEPARATOR . REFERENCES_THUMBS_PREFIX . $this->getVar($fieldName));
285
+            @unlink(references_utils::getModuleOption('images_path').DIRECTORY_SEPARATOR.REFERENCES_THUMBS_PREFIX.$this->getVar($fieldName));
286 286
         }
287 287
     }
288 288
 
@@ -350,9 +350,9 @@  discard block
 block discarded – undo
350 350
     public function getUrl($shortVersion = false)
351 351
     {
352 352
         if (!$shortVersion) {
353
-            return REFERENCES_URL . 'reference.php?article_id=' . $this->getVar('article_id');
353
+            return REFERENCES_URL.'reference.php?article_id='.$this->getVar('article_id');
354 354
         } else {
355
-            return 'reference.php?article_id=' . $this->getVar('article_id');
355
+            return 'reference.php?article_id='.$this->getVar('article_id');
356 356
         }
357 357
     }
358 358
 
@@ -375,11 +375,11 @@  discard block
 block discarded – undo
375 375
             $ret['article_picture_exists'] = true;
376 376
             for ($i = 1; $i <= 10; ++$i) {
377 377
                 if ($this->pictureExists($i)) {
378
-                    $ret['article_picture_url' . $i]  = $this->getPictureUrl($i);
379
-                    $ret['article_picture_path' . $i] = $this->getPicturePath($i);
378
+                    $ret['article_picture_url'.$i]  = $this->getPictureUrl($i);
379
+                    $ret['article_picture_path'.$i] = $this->getPicturePath($i);
380 380
                     $ret['article_pictures_urls'][]   = $this->getPictureUrl($i);
381 381
                     $ret['article_pictures_paths'][]  = $this->getPicturePath($i);
382
-                    $fieldName                        = 'article_picture' . $i . '_text';
382
+                    $fieldName                        = 'article_picture'.$i.'_text';
383 383
                     if (xoops_trim($this->getVar($fieldName)) != '') {
384 384
                         $ret['article_pictures_texts'][] = references_utils::makeHrefTitle($this->getVar($fieldName));
385 385
                     } else {
@@ -404,8 +404,8 @@  discard block
 block discarded – undo
404 404
             $ret['article_thumb_exists'] = true;
405 405
             for ($i = 1; $i <= 10; ++$i) {
406 406
                 if ($this->thumbExists($i)) {
407
-                    $ret['article_thumb_url' . $i]  = $this->getThumbUrl($i);
408
-                    $ret['article_thumb_path' . $i] = $this->getThumbPath($i);
407
+                    $ret['article_thumb_url'.$i]  = $this->getThumbUrl($i);
408
+                    $ret['article_thumb_path'.$i] = $this->getThumbPath($i);
409 409
                     $ret['article_thumbs_urls'][]   = $this->getThumbUrl($i);
410 410
                     $ret['article_thumbs_paths'][]  = $this->getThumbPath($i);
411 411
                 }
@@ -446,7 +446,7 @@  discard block
 block discarded – undo
446 446
         $gperm_handler = xoops_getHandler('groupperm');
447 447
         $categories    = $gperm_handler->getItemIds($permissionsType, $groups, $currentModule->getVar('mid'));
448 448
         if (is_array($categories) && count($categories) > 0) {
449
-            $permissions[$permissionsType] = new Criteria('article_category_id', '(' . implode(',', $categories) . ')', 'IN');
449
+            $permissions[$permissionsType] = new Criteria('article_category_id', '('.implode(',', $categories).')', 'IN');
450 450
         } else {    // Ne peut rien voir
451 451
             $permissions[$permissionsType] = new Criteria('article_category_id', '0', '=');
452 452
         }
@@ -474,7 +474,7 @@  discard block
 block discarded – undo
474 474
             $criteria->add(new Criteria('article_online', REFERENCES_STATUS_ONLINE, '='));
475 475
         }
476 476
         if (is_array($categoryId) && count($categoryId) > 0) {
477
-            $criteria->add(new Criteria('article_category_id', '(' . implode(',', $categoryId) . ')', 'IN'));
477
+            $criteria->add(new Criteria('article_category_id', '('.implode(',', $categoryId).')', 'IN'));
478 478
         } elseif ($categoryId > 0) {
479 479
             $criteria->add(new Criteria('article_category_id', $categoryId, '='));
480 480
         }
@@ -531,8 +531,8 @@  discard block
 block discarded – undo
531 531
     public function getDistinctCategoriesIds()
532 532
     {
533 533
         $ret = array();
534
-        $sql = 'SELECT distinct(article_category_id) FROM ' . $this->table;
535
-        $sql .= ' ' . $this->getPermissionsCategoriesCriteria()->renderWhere();    // Permissions
534
+        $sql = 'SELECT distinct(article_category_id) FROM '.$this->table;
535
+        $sql .= ' '.$this->getPermissionsCategoriesCriteria()->renderWhere(); // Permissions
536 536
         $sql .= ' GROUP BY article_category_id ORDER BY article_category_id';
537 537
         $result = $this->db->query($sql);
538 538
         if (!$result) {
@@ -600,17 +600,17 @@  discard block
 block discarded – undo
600 600
      */
601 601
     public function moveUp($currentId, $currentOrder)
602 602
     {
603
-        $sql_plus = 'SELECT article_id FROM ' . $this->table . ' WHERE article_weight = ' . ((int)$currentOrder - 1);
603
+        $sql_plus = 'SELECT article_id FROM '.$this->table.' WHERE article_weight = '.((int) $currentOrder - 1);
604 604
         $res_plus = $this->db->query($sql_plus);
605 605
         if ($this->db->getRowsNum($res_plus) == 0) {
606 606
             return;
607 607
         }
608 608
         $row_plus = $this->db->fetchArray($res_plus);
609 609
 
610
-        $upd1 = 'UPDATE ' . $this->table . ' SET article_weight = (article_weight + 1) WHERE article_id = ' . $row_plus['article_id'];
610
+        $upd1 = 'UPDATE '.$this->table.' SET article_weight = (article_weight + 1) WHERE article_id = '.$row_plus['article_id'];
611 611
         $this->db->queryF($upd1);
612 612
 
613
-        $upd2 = 'UPDATE ' . $this->table . ' SET article_weight = (article_weight - 1) WHERE article_id = ' . (int)$currentId;
613
+        $upd2 = 'UPDATE '.$this->table.' SET article_weight = (article_weight - 1) WHERE article_id = '.(int) $currentId;
614 614
         $this->db->queryF($upd2);
615 615
         $this->forceCacheClean();
616 616
     }
@@ -624,17 +624,17 @@  discard block
 block discarded – undo
624 624
      */
625 625
     public function moveDown($currentId, $currentOrder)
626 626
     {
627
-        $sql_moins = 'SELECT article_id FROM ' . $this->table . ' WHERE article_weight = ' . ((int)$currentOrder + 1);
627
+        $sql_moins = 'SELECT article_id FROM '.$this->table.' WHERE article_weight = '.((int) $currentOrder + 1);
628 628
         $res_moins = $this->db->query($sql_moins);
629 629
         if ($this->db->getRowsNum($res_moins) == 0) {
630 630
             return;
631 631
         }
632 632
 
633 633
         $row_moins = $this->db->fetchArray($res_moins);
634
-        $upd1      = 'UPDATE ' . $this->table . ' SET article_weight = (article_weight - 1) WHERE article_id = ' . $row_moins['article_id'];
634
+        $upd1      = 'UPDATE '.$this->table.' SET article_weight = (article_weight - 1) WHERE article_id = '.$row_moins['article_id'];
635 635
         $this->db->queryF($upd1);
636 636
 
637
-        $upd2 = 'UPDATE ' . $this->table . ' SET article_weight =( article_weight + 1) WHERE article_id = ' . (int)$currentId;
637
+        $upd2 = 'UPDATE '.$this->table.' SET article_weight =( article_weight + 1) WHERE article_id = '.(int) $currentId;
638 638
         $this->db->queryF($upd2);
639 639
         $this->forceCacheClean();
640 640
     }
Please login to merge, or discard this patch.
Indentation   +603 added lines, -603 removed lines patch added patch discarded remove patch
@@ -22,7 +22,7 @@  discard block
 block discarded – undo
22 22
 
23 23
 require_once XOOPS_ROOT_PATH . '/kernel/object.php';
24 24
 if (!class_exists('references_XoopsPersistableObjectHandler')) {
25
-    require_once XOOPS_ROOT_PATH . '/modules/references/class/PersistableObjectHandler.php';
25
+	require_once XOOPS_ROOT_PATH . '/modules/references/class/PersistableObjectHandler.php';
26 26
 }
27 27
 
28 28
 define('REFERENCES_STATUS_ONLINE', 1);    // Articles en ligne
@@ -30,610 +30,610 @@  discard block
 block discarded – undo
30 30
 
31 31
 class references_articles extends references_Object
32 32
 {
33
-    public function __construct()
34
-    {
35
-        $this->initVar('article_id', XOBJ_DTYPE_INT, null, false);
36
-        $this->initVar('article_category_id', XOBJ_DTYPE_INT, null, false);
37
-        $this->initVar('article_timestamp', XOBJ_DTYPE_INT, null, false);
38
-        $this->initVar('article_weight', XOBJ_DTYPE_INT, null, false);
39
-        $this->initVar('article_date', XOBJ_DTYPE_TXTBOX, null, false);
40
-        $this->initVar('article_title', XOBJ_DTYPE_TXTBOX, null, false);
41
-        $this->initVar('article_text', XOBJ_DTYPE_TXTAREA, null, false);
42
-        $this->initVar('article_externalurl', XOBJ_DTYPE_TXTBOX, null, false);
43
-        $this->initVar('article_picture1', XOBJ_DTYPE_TXTBOX, null, false);
44
-        $this->initVar('article_picture1_text', XOBJ_DTYPE_TXTBOX, null, false);
45
-        $this->initVar('article_picture2', XOBJ_DTYPE_TXTBOX, null, false);
46
-        $this->initVar('article_picture2_text', XOBJ_DTYPE_TXTBOX, null, false);
47
-        $this->initVar('article_picture3', XOBJ_DTYPE_TXTBOX, null, false);
48
-        $this->initVar('article_picture3_text', XOBJ_DTYPE_TXTBOX, null, false);
49
-        $this->initVar('article_picture4', XOBJ_DTYPE_TXTBOX, null, false);
50
-        $this->initVar('article_picture4_text', XOBJ_DTYPE_TXTBOX, null, false);
51
-        $this->initVar('article_picture5', XOBJ_DTYPE_TXTBOX, null, false);
52
-        $this->initVar('article_picture5_text', XOBJ_DTYPE_TXTBOX, null, false);
53
-        $this->initVar('article_picture6', XOBJ_DTYPE_TXTBOX, null, false);
54
-        $this->initVar('article_picture6_text', XOBJ_DTYPE_TXTBOX, null, false);
55
-        $this->initVar('article_picture7', XOBJ_DTYPE_TXTBOX, null, false);
56
-        $this->initVar('article_picture7_text', XOBJ_DTYPE_TXTBOX, null, false);
57
-        $this->initVar('article_picture8', XOBJ_DTYPE_TXTBOX, null, false);
58
-        $this->initVar('article_picture8_text', XOBJ_DTYPE_TXTBOX, null, false);
59
-        $this->initVar('article_picture9', XOBJ_DTYPE_TXTBOX, null, false);
60
-        $this->initVar('article_picture9_text', XOBJ_DTYPE_TXTBOX, null, false);
61
-        $this->initVar('article_picture10', XOBJ_DTYPE_TXTBOX, null, false);
62
-        $this->initVar('article_picture10_text', XOBJ_DTYPE_TXTBOX, null, false);
63
-        $this->initVar('article_author', XOBJ_DTYPE_INT, null, false);
64
-        $this->initVar('article_online', XOBJ_DTYPE_INT, null, false);
65
-        $this->initVar('article_attached_file', XOBJ_DTYPE_TXTBOX, null, false);
66
-        $this->initVar('article_readmore', XOBJ_DTYPE_TXTAREA, null, false);
67
-
68
-        // Pour autoriser le html
69
-        $this->initVar('dohtml', XOBJ_DTYPE_INT, 1, false);
70
-    }
71
-
72
-    /**
73
-     * Indique si l'article en cours est visible
74
-     *
75
-     * @return boolean
76
-     */
77
-    public function isArticleOnline()
78
-    {
79
-        return $this->getVar('article_online') == REFERENCES_STATUS_ONLINE ? true : false;
80
-    }
81
-
82
-    /**
83
-     * Retourne une image qui indique si l'article est en ligne ou pas
84
-     *
85
-     * @return string
86
-     */
87
-    public function getOnlinePicture()
88
-    {
89
-        if ($this->isArticleOnline()) {
90
-            return REFERENCES_IMAGES_URL . 'status_online.png';
91
-        } else {
92
-            return REFERENCES_IMAGES_URL . 'status_offline.png';
93
-        }
94
-    }
95
-
96
-    /**
97
-     * Retourne la chaine de caractères qui peut être utilisée dans l'attribut href d'une balise html A.
98
-     *
99
-     * @return string
100
-     */
101
-    public function getHrefTitle()
102
-    {
103
-        return references_utils::makeHrefTitle($this->getVar('article_title'));
104
-    }
105
-
106
-    /**
107
-     * Indique si une image de l'article existe
108
-     *
109
-     * @param integer $indice L'indice de l'image recherchée
110
-     * @return boolean Vrai si l'image existe sinon faux
111
-     */
112
-    public function pictureExists($indice)
113
-    {
114
-        $return    = false;
115
-        $fieldName = 'article_picture' . $indice;
116
-        if (xoops_trim($this->getVar($fieldName)) != '' && file_exists(references_utils::getModuleOption('images_path') . DIRECTORY_SEPARATOR . $this->getVar($fieldName))) {
117
-            $return = true;
118
-        }
119
-
120
-        return $return;
121
-    }
122
-
123
-    /**
124
-     * Supprime l'image associée à un article
125
-     *
126
-     * @param integer $indice L'indice de l'image recherchée
127
-     * @return void
128
-     */
129
-    public function deletePicture($indice)
130
-    {
131
-        $fieldName = 'article_picture' . $indice;
132
-        if ($this->pictureExists($indice)) {
133
-            @unlink(references_utils::getModuleOption('images_path') . references_utils::getModuleOption('images_path') . $this->getVar($fieldName));
134
-        }
135
-        $this->setVar($fieldName, '');
136
-    }
137
-
138
-    /**
139
-     * Retourne l'URL de l'image de l'article courant
140
-     *
141
-     * @param integer $indice L'indice de l'image recherchée
142
-     * @return string  L'URL
143
-     */
144
-    public function getPictureUrl($indice)
145
-    {
146
-        $fieldName = 'article_picture' . $indice;
147
-        if (xoops_trim($this->getVar($fieldName)) != '' && $this->pictureExists($indice)) {
148
-            return references_utils::getModuleOption('images_url') . '/' . $this->getVar($fieldName);
149
-        } else {
150
-            return REFERENCES_IMAGES_URL . 'blank.gif';
151
-        }
152
-    }
153
-
154
-    /**
155
-     * Retourne le chemin de l'image de l'article courante
156
-     *
157
-     * @param integer $indice L'indice de l'image recherchée
158
-     * @return string  Le chemin
159
-     */
160
-    public function getPicturePath($indice)
161
-    {
162
-        $fieldName = 'article_picture' . $indice;
163
-        if (xoops_trim($this->getVar($fieldName)) != '') {
164
-            return references_utils::getModuleOption('images_path') . DIRECTORY_SEPARATOR . $this->getVar($fieldName);
165
-        } else {
166
-            return '';
167
-        }
168
-    }
169
-
170
-    /**
171
-     * Indique si la vignette de l'image de l'article existe
172
-     *
173
-     * @param integer $indice L'indice de l'image recherchée
174
-     * @return boolean Vrai si l'image existe sinon faux
175
-     */
176
-    public function thumbExists($indice)
177
-    {
178
-        $fieldName = 'article_picture' . $indice;
179
-        $return    = false;
180
-        if (xoops_trim($this->getVar($fieldName)) != '' && file_exists(references_utils::getModuleOption('images_path') . DIRECTORY_SEPARATOR . REFERENCES_THUMBS_PREFIX . $this->getVar($fieldName))) {
181
-            $return = true;
182
-        }
183
-
184
-        return $return;
185
-    }
186
-
187
-    /**
188
-     * Retourne l'URL de la vignette de l'article
189
-     *
190
-     * @param integer $indice L'indice de l'image recherchée
191
-     * @return string  L'URL
192
-     */
193
-    public function getThumbUrl($indice)
194
-    {
195
-        $fieldName = 'article_picture' . $indice;
196
-        if (xoops_trim($this->getVar($fieldName)) != '') {
197
-            return references_utils::getModuleOption('images_url') . '/' . REFERENCES_THUMBS_PREFIX . $this->getVar($fieldName);
198
-        } else {
199
-            return REFERENCES_IMAGES_URL . 'blank.gif';
200
-        }
201
-    }
202
-
203
-    /**
204
-     * Retourne le chemin de la vignette de l'annonce
205
-     *
206
-     * @param integer $indice L'indice de l'image recherchée
207
-     * @return string  L'URL
208
-     */
209
-    public function getThumbPath($indice)
210
-    {
211
-        $fieldName = 'article_picture' . $indice;
212
-        if (xoops_trim($this->getVar($fieldName)) != '') {
213
-            return references_utils::getModuleOption('images_path') . DIRECTORY_SEPARATOR . REFERENCES_THUMBS_PREFIX . $this->getVar($fieldName);
214
-        } else {
215
-            return '';
216
-        }
217
-    }
218
-
219
-    /**
220
-     * Indique si le fichier attaché à un article existe
221
-     *
222
-     * @return boolean
223
-     */
224
-    public function attachmentExists()
225
-    {
226
-        $return = false;
227
-        if (xoops_trim($this->getVar('article_attached_file')) != '' && file_exists(references_utils::getModuleOption('attached_path') . DIRECTORY_SEPARATOR . $this->getVar('article_attached_file'))) {
228
-            $return = true;
229
-        }
230
-
231
-        return $return;
232
-    }
233
-
234
-    /**
235
-     * Retourne l'URL du fichier attaché
236
-     *
237
-     * @return string    L'url du fichier attaché sinon une chaine vide
238
-     */
239
-    public function getAttachmentUrl()
240
-    {
241
-        if (xoops_trim($this->getVar('article_attached_file')) != '' && $this->attachmentExists()) {
242
-            return references_utils::getModuleOption('attached_url') . '/' . $this->getVar('article_attached_file');
243
-        } else {
244
-            return '';
245
-        }
246
-    }
247
-
248
-    /**
249
-     * Retourne le chemin du fichier attaché
250
-     *
251
-     * @return string    Le chemin du fichier attaché sinon une chaine vide
252
-     */
253
-    public function getAttachmentPath()
254
-    {
255
-        if (xoops_trim($this->getVar('article_attached_file')) != '' && $this->attachmentExists()) {
256
-            return references_utils::getModuleOption('attached_path') . DIRECTORY_SEPARATOR . $this->getVar('article_attached_file');
257
-        } else {
258
-            return '';
259
-        }
260
-    }
261
-
262
-    /**
263
-     * Supprime le fichier attaché à un article
264
-     */
265
-    public function deleteAttachment()
266
-    {
267
-        if ($this->attachmentExists()) {
268
-            @unlink(references_utils::getModuleOption('attached_path') . DIRECTORY_SEPARATOR . $this->getVar('article_attached_file'));
269
-        }
270
-        $this->setVar('article_attached_file', '');
271
-    }
272
-
273
-    /**
274
-     * Supprime la miniature associée à l'article
275
-     *
276
-     * @param integer $indice L'indice de l'image recherchée
277
-     * @return void
278
-     */
279
-    public function deleteThumb($indice)
280
-    {
281
-        $fieldName = 'article_picture' . $indice;
282
-        if ($this->thumbExists($indice)) {
283
-            @unlink(references_utils::getModuleOption('images_path') . DIRECTORY_SEPARATOR . REFERENCES_THUMBS_PREFIX . $this->getVar($fieldName));
284
-        }
285
-    }
286
-
287
-    /**
288
-     * Supprime l'image (et vignette) d'un article (raccourcis)
289
-     *
290
-     * @return void
291
-     */
292
-    public function deletePicturesAndThumbs()
293
-    {
294
-        for ($i = 1; $i <= 10; ++$i) {
295
-            $this->deleteThumb($i);
296
-            $this->deletePicture($i);
297
-        }
298
-    }
299
-
300
-    /**
301
-     * Retourne le timestamp de création formaté
302
-     *
303
-     * @return string
304
-     */
305
-    public function getFormatedTimeStamp()
306
-    {
307
-        return formatTimestamp($this->getVar('article_timestamp'), 's');
308
-    }
309
-
310
-    /**
311
-     * Indique s'il existe au moins une image pour l'article
312
-     *
313
-     * @return boolean
314
-     */
315
-    public function isThereAPicture()
316
-    {
317
-        for ($i = 1; $i <= 10; ++$i) {
318
-            if ($this->pictureExists($i)) {
319
-                return true;
320
-            }
321
-        }
322
-
323
-        return false;
324
-    }
325
-
326
-    /**
327
-     * Inidique s'il existe au moins une vignette pour l'article
328
-     *
329
-     * @return boolean
330
-     */
331
-    public function isThereAThumb()
332
-    {
333
-        for ($i = 1; $i <= 10; ++$i) {
334
-            if ($this->thumbExists($i)) {
335
-                return true;
336
-            }
337
-        }
338
-
339
-        return false;
340
-    }
341
-
342
-    /**
343
-     * Retourne l'url pour atteindre l'élément
344
-     *
345
-     * @param bool $shortVersion
346
-     * @return string
347
-     */
348
-    public function getUrl($shortVersion = false)
349
-    {
350
-        if (!$shortVersion) {
351
-            return REFERENCES_URL . 'reference.php?article_id=' . $this->getVar('article_id');
352
-        } else {
353
-            return 'reference.php?article_id=' . $this->getVar('article_id');
354
-        }
355
-    }
356
-
357
-    /**
358
-     * Retourne les éléments de l'annnonce formatés pour affichage
359
-     *
360
-     * @param string $format Format à utiliser
361
-     * @return array
362
-     */
363
-    public function toArray($format = 's')
364
-    {
365
-        $ret                       = array();
366
-        $ret                       = parent::toArray($format);
367
-        $hrefTitle                 = $this->getHrefTitle();
368
-        $ret['article_href_title'] = $hrefTitle;
369
-        $ret['article_url']        = $this->getUrl();
370
-        // Indique si une annonce est expirée
371
-        $ret['article_is_online'] = $this->isArticleOnline();
372
-        if ($this->isThereAPicture()) {
373
-            $ret['article_picture_exists'] = true;
374
-            for ($i = 1; $i <= 10; ++$i) {
375
-                if ($this->pictureExists($i)) {
376
-                    $ret['article_picture_url' . $i]  = $this->getPictureUrl($i);
377
-                    $ret['article_picture_path' . $i] = $this->getPicturePath($i);
378
-                    $ret['article_pictures_urls'][]   = $this->getPictureUrl($i);
379
-                    $ret['article_pictures_paths'][]  = $this->getPicturePath($i);
380
-                    $fieldName                        = 'article_picture' . $i . '_text';
381
-                    if (xoops_trim($this->getVar($fieldName)) != '') {
382
-                        $ret['article_pictures_texts'][] = references_utils::makeHrefTitle($this->getVar($fieldName));
383
-                    } else {
384
-                        $ret['article_pictures_texts'][] = $hrefTitle;
385
-                    }
386
-                }
387
-            }
388
-        } else {
389
-            $ret['article_picture_exists'] = false;
390
-        }
391
-        $ret['article_short_text'] = references_utils::truncate_tagsafe($this->getVar('article_text'), REFERENCES_SHORTEN_TEXT);
392
-
393
-        if ($this->attachmentExists()) {
394
-            $ret['article_attachment_exists'] = true;
395
-            $ret['article_attachment_url']    = $this->getAttachmentUrl();
396
-            $ret['article_attachment_path']   = $this->getAttachmentPath();
397
-        } else {
398
-            $ret['attachment_exists'] = false;
399
-        }
400
-
401
-        if ($this->isThereAThumb()) {
402
-            $ret['article_thumb_exists'] = true;
403
-            for ($i = 1; $i <= 10; ++$i) {
404
-                if ($this->thumbExists($i)) {
405
-                    $ret['article_thumb_url' . $i]  = $this->getThumbUrl($i);
406
-                    $ret['article_thumb_path' . $i] = $this->getThumbPath($i);
407
-                    $ret['article_thumbs_urls'][]   = $this->getThumbUrl($i);
408
-                    $ret['article_thumbs_paths'][]  = $this->getThumbPath($i);
409
-                }
410
-            }
411
-        } else {
412
-            $ret['article_thumb_exists'] = false;
413
-        }
414
-
415
-        $ret['article_timestamp_formated'] = $this->getFormatedTimeStamp();
416
-
417
-        return $ret;
418
-    }
33
+	public function __construct()
34
+	{
35
+		$this->initVar('article_id', XOBJ_DTYPE_INT, null, false);
36
+		$this->initVar('article_category_id', XOBJ_DTYPE_INT, null, false);
37
+		$this->initVar('article_timestamp', XOBJ_DTYPE_INT, null, false);
38
+		$this->initVar('article_weight', XOBJ_DTYPE_INT, null, false);
39
+		$this->initVar('article_date', XOBJ_DTYPE_TXTBOX, null, false);
40
+		$this->initVar('article_title', XOBJ_DTYPE_TXTBOX, null, false);
41
+		$this->initVar('article_text', XOBJ_DTYPE_TXTAREA, null, false);
42
+		$this->initVar('article_externalurl', XOBJ_DTYPE_TXTBOX, null, false);
43
+		$this->initVar('article_picture1', XOBJ_DTYPE_TXTBOX, null, false);
44
+		$this->initVar('article_picture1_text', XOBJ_DTYPE_TXTBOX, null, false);
45
+		$this->initVar('article_picture2', XOBJ_DTYPE_TXTBOX, null, false);
46
+		$this->initVar('article_picture2_text', XOBJ_DTYPE_TXTBOX, null, false);
47
+		$this->initVar('article_picture3', XOBJ_DTYPE_TXTBOX, null, false);
48
+		$this->initVar('article_picture3_text', XOBJ_DTYPE_TXTBOX, null, false);
49
+		$this->initVar('article_picture4', XOBJ_DTYPE_TXTBOX, null, false);
50
+		$this->initVar('article_picture4_text', XOBJ_DTYPE_TXTBOX, null, false);
51
+		$this->initVar('article_picture5', XOBJ_DTYPE_TXTBOX, null, false);
52
+		$this->initVar('article_picture5_text', XOBJ_DTYPE_TXTBOX, null, false);
53
+		$this->initVar('article_picture6', XOBJ_DTYPE_TXTBOX, null, false);
54
+		$this->initVar('article_picture6_text', XOBJ_DTYPE_TXTBOX, null, false);
55
+		$this->initVar('article_picture7', XOBJ_DTYPE_TXTBOX, null, false);
56
+		$this->initVar('article_picture7_text', XOBJ_DTYPE_TXTBOX, null, false);
57
+		$this->initVar('article_picture8', XOBJ_DTYPE_TXTBOX, null, false);
58
+		$this->initVar('article_picture8_text', XOBJ_DTYPE_TXTBOX, null, false);
59
+		$this->initVar('article_picture9', XOBJ_DTYPE_TXTBOX, null, false);
60
+		$this->initVar('article_picture9_text', XOBJ_DTYPE_TXTBOX, null, false);
61
+		$this->initVar('article_picture10', XOBJ_DTYPE_TXTBOX, null, false);
62
+		$this->initVar('article_picture10_text', XOBJ_DTYPE_TXTBOX, null, false);
63
+		$this->initVar('article_author', XOBJ_DTYPE_INT, null, false);
64
+		$this->initVar('article_online', XOBJ_DTYPE_INT, null, false);
65
+		$this->initVar('article_attached_file', XOBJ_DTYPE_TXTBOX, null, false);
66
+		$this->initVar('article_readmore', XOBJ_DTYPE_TXTAREA, null, false);
67
+
68
+		// Pour autoriser le html
69
+		$this->initVar('dohtml', XOBJ_DTYPE_INT, 1, false);
70
+	}
71
+
72
+	/**
73
+	 * Indique si l'article en cours est visible
74
+	 *
75
+	 * @return boolean
76
+	 */
77
+	public function isArticleOnline()
78
+	{
79
+		return $this->getVar('article_online') == REFERENCES_STATUS_ONLINE ? true : false;
80
+	}
81
+
82
+	/**
83
+	 * Retourne une image qui indique si l'article est en ligne ou pas
84
+	 *
85
+	 * @return string
86
+	 */
87
+	public function getOnlinePicture()
88
+	{
89
+		if ($this->isArticleOnline()) {
90
+			return REFERENCES_IMAGES_URL . 'status_online.png';
91
+		} else {
92
+			return REFERENCES_IMAGES_URL . 'status_offline.png';
93
+		}
94
+	}
95
+
96
+	/**
97
+	 * Retourne la chaine de caractères qui peut être utilisée dans l'attribut href d'une balise html A.
98
+	 *
99
+	 * @return string
100
+	 */
101
+	public function getHrefTitle()
102
+	{
103
+		return references_utils::makeHrefTitle($this->getVar('article_title'));
104
+	}
105
+
106
+	/**
107
+	 * Indique si une image de l'article existe
108
+	 *
109
+	 * @param integer $indice L'indice de l'image recherchée
110
+	 * @return boolean Vrai si l'image existe sinon faux
111
+	 */
112
+	public function pictureExists($indice)
113
+	{
114
+		$return    = false;
115
+		$fieldName = 'article_picture' . $indice;
116
+		if (xoops_trim($this->getVar($fieldName)) != '' && file_exists(references_utils::getModuleOption('images_path') . DIRECTORY_SEPARATOR . $this->getVar($fieldName))) {
117
+			$return = true;
118
+		}
119
+
120
+		return $return;
121
+	}
122
+
123
+	/**
124
+	 * Supprime l'image associée à un article
125
+	 *
126
+	 * @param integer $indice L'indice de l'image recherchée
127
+	 * @return void
128
+	 */
129
+	public function deletePicture($indice)
130
+	{
131
+		$fieldName = 'article_picture' . $indice;
132
+		if ($this->pictureExists($indice)) {
133
+			@unlink(references_utils::getModuleOption('images_path') . references_utils::getModuleOption('images_path') . $this->getVar($fieldName));
134
+		}
135
+		$this->setVar($fieldName, '');
136
+	}
137
+
138
+	/**
139
+	 * Retourne l'URL de l'image de l'article courant
140
+	 *
141
+	 * @param integer $indice L'indice de l'image recherchée
142
+	 * @return string  L'URL
143
+	 */
144
+	public function getPictureUrl($indice)
145
+	{
146
+		$fieldName = 'article_picture' . $indice;
147
+		if (xoops_trim($this->getVar($fieldName)) != '' && $this->pictureExists($indice)) {
148
+			return references_utils::getModuleOption('images_url') . '/' . $this->getVar($fieldName);
149
+		} else {
150
+			return REFERENCES_IMAGES_URL . 'blank.gif';
151
+		}
152
+	}
153
+
154
+	/**
155
+	 * Retourne le chemin de l'image de l'article courante
156
+	 *
157
+	 * @param integer $indice L'indice de l'image recherchée
158
+	 * @return string  Le chemin
159
+	 */
160
+	public function getPicturePath($indice)
161
+	{
162
+		$fieldName = 'article_picture' . $indice;
163
+		if (xoops_trim($this->getVar($fieldName)) != '') {
164
+			return references_utils::getModuleOption('images_path') . DIRECTORY_SEPARATOR . $this->getVar($fieldName);
165
+		} else {
166
+			return '';
167
+		}
168
+	}
169
+
170
+	/**
171
+	 * Indique si la vignette de l'image de l'article existe
172
+	 *
173
+	 * @param integer $indice L'indice de l'image recherchée
174
+	 * @return boolean Vrai si l'image existe sinon faux
175
+	 */
176
+	public function thumbExists($indice)
177
+	{
178
+		$fieldName = 'article_picture' . $indice;
179
+		$return    = false;
180
+		if (xoops_trim($this->getVar($fieldName)) != '' && file_exists(references_utils::getModuleOption('images_path') . DIRECTORY_SEPARATOR . REFERENCES_THUMBS_PREFIX . $this->getVar($fieldName))) {
181
+			$return = true;
182
+		}
183
+
184
+		return $return;
185
+	}
186
+
187
+	/**
188
+	 * Retourne l'URL de la vignette de l'article
189
+	 *
190
+	 * @param integer $indice L'indice de l'image recherchée
191
+	 * @return string  L'URL
192
+	 */
193
+	public function getThumbUrl($indice)
194
+	{
195
+		$fieldName = 'article_picture' . $indice;
196
+		if (xoops_trim($this->getVar($fieldName)) != '') {
197
+			return references_utils::getModuleOption('images_url') . '/' . REFERENCES_THUMBS_PREFIX . $this->getVar($fieldName);
198
+		} else {
199
+			return REFERENCES_IMAGES_URL . 'blank.gif';
200
+		}
201
+	}
202
+
203
+	/**
204
+	 * Retourne le chemin de la vignette de l'annonce
205
+	 *
206
+	 * @param integer $indice L'indice de l'image recherchée
207
+	 * @return string  L'URL
208
+	 */
209
+	public function getThumbPath($indice)
210
+	{
211
+		$fieldName = 'article_picture' . $indice;
212
+		if (xoops_trim($this->getVar($fieldName)) != '') {
213
+			return references_utils::getModuleOption('images_path') . DIRECTORY_SEPARATOR . REFERENCES_THUMBS_PREFIX . $this->getVar($fieldName);
214
+		} else {
215
+			return '';
216
+		}
217
+	}
218
+
219
+	/**
220
+	 * Indique si le fichier attaché à un article existe
221
+	 *
222
+	 * @return boolean
223
+	 */
224
+	public function attachmentExists()
225
+	{
226
+		$return = false;
227
+		if (xoops_trim($this->getVar('article_attached_file')) != '' && file_exists(references_utils::getModuleOption('attached_path') . DIRECTORY_SEPARATOR . $this->getVar('article_attached_file'))) {
228
+			$return = true;
229
+		}
230
+
231
+		return $return;
232
+	}
233
+
234
+	/**
235
+	 * Retourne l'URL du fichier attaché
236
+	 *
237
+	 * @return string    L'url du fichier attaché sinon une chaine vide
238
+	 */
239
+	public function getAttachmentUrl()
240
+	{
241
+		if (xoops_trim($this->getVar('article_attached_file')) != '' && $this->attachmentExists()) {
242
+			return references_utils::getModuleOption('attached_url') . '/' . $this->getVar('article_attached_file');
243
+		} else {
244
+			return '';
245
+		}
246
+	}
247
+
248
+	/**
249
+	 * Retourne le chemin du fichier attaché
250
+	 *
251
+	 * @return string    Le chemin du fichier attaché sinon une chaine vide
252
+	 */
253
+	public function getAttachmentPath()
254
+	{
255
+		if (xoops_trim($this->getVar('article_attached_file')) != '' && $this->attachmentExists()) {
256
+			return references_utils::getModuleOption('attached_path') . DIRECTORY_SEPARATOR . $this->getVar('article_attached_file');
257
+		} else {
258
+			return '';
259
+		}
260
+	}
261
+
262
+	/**
263
+	 * Supprime le fichier attaché à un article
264
+	 */
265
+	public function deleteAttachment()
266
+	{
267
+		if ($this->attachmentExists()) {
268
+			@unlink(references_utils::getModuleOption('attached_path') . DIRECTORY_SEPARATOR . $this->getVar('article_attached_file'));
269
+		}
270
+		$this->setVar('article_attached_file', '');
271
+	}
272
+
273
+	/**
274
+	 * Supprime la miniature associée à l'article
275
+	 *
276
+	 * @param integer $indice L'indice de l'image recherchée
277
+	 * @return void
278
+	 */
279
+	public function deleteThumb($indice)
280
+	{
281
+		$fieldName = 'article_picture' . $indice;
282
+		if ($this->thumbExists($indice)) {
283
+			@unlink(references_utils::getModuleOption('images_path') . DIRECTORY_SEPARATOR . REFERENCES_THUMBS_PREFIX . $this->getVar($fieldName));
284
+		}
285
+	}
286
+
287
+	/**
288
+	 * Supprime l'image (et vignette) d'un article (raccourcis)
289
+	 *
290
+	 * @return void
291
+	 */
292
+	public function deletePicturesAndThumbs()
293
+	{
294
+		for ($i = 1; $i <= 10; ++$i) {
295
+			$this->deleteThumb($i);
296
+			$this->deletePicture($i);
297
+		}
298
+	}
299
+
300
+	/**
301
+	 * Retourne le timestamp de création formaté
302
+	 *
303
+	 * @return string
304
+	 */
305
+	public function getFormatedTimeStamp()
306
+	{
307
+		return formatTimestamp($this->getVar('article_timestamp'), 's');
308
+	}
309
+
310
+	/**
311
+	 * Indique s'il existe au moins une image pour l'article
312
+	 *
313
+	 * @return boolean
314
+	 */
315
+	public function isThereAPicture()
316
+	{
317
+		for ($i = 1; $i <= 10; ++$i) {
318
+			if ($this->pictureExists($i)) {
319
+				return true;
320
+			}
321
+		}
322
+
323
+		return false;
324
+	}
325
+
326
+	/**
327
+	 * Inidique s'il existe au moins une vignette pour l'article
328
+	 *
329
+	 * @return boolean
330
+	 */
331
+	public function isThereAThumb()
332
+	{
333
+		for ($i = 1; $i <= 10; ++$i) {
334
+			if ($this->thumbExists($i)) {
335
+				return true;
336
+			}
337
+		}
338
+
339
+		return false;
340
+	}
341
+
342
+	/**
343
+	 * Retourne l'url pour atteindre l'élément
344
+	 *
345
+	 * @param bool $shortVersion
346
+	 * @return string
347
+	 */
348
+	public function getUrl($shortVersion = false)
349
+	{
350
+		if (!$shortVersion) {
351
+			return REFERENCES_URL . 'reference.php?article_id=' . $this->getVar('article_id');
352
+		} else {
353
+			return 'reference.php?article_id=' . $this->getVar('article_id');
354
+		}
355
+	}
356
+
357
+	/**
358
+	 * Retourne les éléments de l'annnonce formatés pour affichage
359
+	 *
360
+	 * @param string $format Format à utiliser
361
+	 * @return array
362
+	 */
363
+	public function toArray($format = 's')
364
+	{
365
+		$ret                       = array();
366
+		$ret                       = parent::toArray($format);
367
+		$hrefTitle                 = $this->getHrefTitle();
368
+		$ret['article_href_title'] = $hrefTitle;
369
+		$ret['article_url']        = $this->getUrl();
370
+		// Indique si une annonce est expirée
371
+		$ret['article_is_online'] = $this->isArticleOnline();
372
+		if ($this->isThereAPicture()) {
373
+			$ret['article_picture_exists'] = true;
374
+			for ($i = 1; $i <= 10; ++$i) {
375
+				if ($this->pictureExists($i)) {
376
+					$ret['article_picture_url' . $i]  = $this->getPictureUrl($i);
377
+					$ret['article_picture_path' . $i] = $this->getPicturePath($i);
378
+					$ret['article_pictures_urls'][]   = $this->getPictureUrl($i);
379
+					$ret['article_pictures_paths'][]  = $this->getPicturePath($i);
380
+					$fieldName                        = 'article_picture' . $i . '_text';
381
+					if (xoops_trim($this->getVar($fieldName)) != '') {
382
+						$ret['article_pictures_texts'][] = references_utils::makeHrefTitle($this->getVar($fieldName));
383
+					} else {
384
+						$ret['article_pictures_texts'][] = $hrefTitle;
385
+					}
386
+				}
387
+			}
388
+		} else {
389
+			$ret['article_picture_exists'] = false;
390
+		}
391
+		$ret['article_short_text'] = references_utils::truncate_tagsafe($this->getVar('article_text'), REFERENCES_SHORTEN_TEXT);
392
+
393
+		if ($this->attachmentExists()) {
394
+			$ret['article_attachment_exists'] = true;
395
+			$ret['article_attachment_url']    = $this->getAttachmentUrl();
396
+			$ret['article_attachment_path']   = $this->getAttachmentPath();
397
+		} else {
398
+			$ret['attachment_exists'] = false;
399
+		}
400
+
401
+		if ($this->isThereAThumb()) {
402
+			$ret['article_thumb_exists'] = true;
403
+			for ($i = 1; $i <= 10; ++$i) {
404
+				if ($this->thumbExists($i)) {
405
+					$ret['article_thumb_url' . $i]  = $this->getThumbUrl($i);
406
+					$ret['article_thumb_path' . $i] = $this->getThumbPath($i);
407
+					$ret['article_thumbs_urls'][]   = $this->getThumbUrl($i);
408
+					$ret['article_thumbs_paths'][]  = $this->getThumbPath($i);
409
+				}
410
+			}
411
+		} else {
412
+			$ret['article_thumb_exists'] = false;
413
+		}
414
+
415
+		$ret['article_timestamp_formated'] = $this->getFormatedTimeStamp();
416
+
417
+		return $ret;
418
+	}
419 419
 }
420 420
 
421 421
 class ReferencesReferences_articlesHandler extends references_XoopsPersistableObjectHandler
422 422
 {
423
-    public function __construct($db)
424
-    {    //                         Table                   Classe                Id            Descr.
425
-        parent::__construct($db, 'references_articles', 'references_articles', 'article_id', 'article_title');
426
-    }
427
-
428
-    /**
429
-     * Retourne le critère à utiliser pour voir les catégories en respectant les permissions
430
-     *
431
-     * @param  string $permissionsType Type de permission (pour l'instant permission de voir)
432
-     * @return obejct de type Criteria
433
-     */
434
-    public function getPermissionsCategoriesCriteria($permissionsType = REFERENCES_PERM_READ)
435
-    {
436
-        global $xoopsUser;
437
-        static $permissions = array();
438
-        if (is_array($permissions) && array_key_exists($permissionsType, $permissions)) {
439
-            return $permissions[$permissionsType];
440
-        }
441
-        $categories    = array();
442
-        $currentModule = references_utils::getModule();
443
-        $groups        = is_object($xoopsUser) ? $xoopsUser->getGroups() : XOOPS_GROUP_ANONYMOUS;
444
-        $gperm_handler = xoops_getHandler('groupperm');
445
-        $categories    = $gperm_handler->getItemIds($permissionsType, $groups, $currentModule->getVar('mid'));
446
-        if (is_array($categories) && count($categories) > 0) {
447
-            $permissions[$permissionsType] = new Criteria('article_category_id', '(' . implode(',', $categories) . ')', 'IN');
448
-        } else {    // Ne peut rien voir
449
-            $permissions[$permissionsType] = new Criteria('article_category_id', '0', '=');
450
-        }
451
-
452
-        return $permissions[$permissionsType];
453
-    }
454
-
455
-    /**
456
-     * Retourne les articles récents en tenant compte des permissions de consultation sur les catégories
457
-     *
458
-     * @param integer  $start      Indice de début
459
-     * @param integer  $limit      Nombre d'objets à renvoyer
460
-     * @param  string  $sort       Zone de tri
461
-     * @param  string  $order      Sens du tri
462
-     * @param  boolean $onlyOnline Uniquement les articles en ligne ?
463
-     * @param integer  $categoryId Identifiant d'une catégorie à laquelle se limiter
464
-     * @return array   Objets de type references_articles
465
-     */
466
-    public function getRecentArticles($start = 0, $limit = 0, $sort = 'article_timestamp', $order = 'DESC', $onlyOnline = true, $categoryId = 0)
467
-    {
468
-        $criteria = new CriteriaCompo();
469
-        $criteria->add(new Criteria('article_id', 0, '<>'));
470
-        $criteria->add($this->getPermissionsCategoriesCriteria());
471
-        if ($onlyOnline) {
472
-            $criteria->add(new Criteria('article_online', REFERENCES_STATUS_ONLINE, '='));
473
-        }
474
-        if (is_array($categoryId) && count($categoryId) > 0) {
475
-            $criteria->add(new Criteria('article_category_id', '(' . implode(',', $categoryId) . ')', 'IN'));
476
-        } elseif ($categoryId > 0) {
477
-            $criteria->add(new Criteria('article_category_id', $categoryId, '='));
478
-        }
479
-        $criteria->setStart($start);
480
-        $criteria->setSort($sort);
481
-        $criteria->setOrder($order);
482
-        $criteria->setLimit($limit);
483
-
484
-        return $this->getObjects($criteria);
485
-    }
486
-
487
-    /**
488
-     * Retourne le nombre total d'articles en ligne
489
-     *
490
-     * @return integer
491
-     */
492
-    public function getOnlineArticlesCount()
493
-    {
494
-        return $this->getCount(new Criteria('article_online', REFERENCES_STATUS_ONLINE, '='));
495
-    }
496
-
497
-    /**
498
-     * Notification de la publication d'une nouvelle référence
499
-     *
500
-     * @param object|references_articles $article L'annonce pour laquelle on fait la notification
501
-     * @return bool
502
-     */
503
-    public function notifyNewArticle(references_articles $article)
504
-    {
505
-        $plugins = references_plugins::getInstance();
506
-        $plugins->fireAction(references_plugins::EVENT_ON_REFERENCE_CREATE, new references_parameters(array('reference' => $article)));
507
-
508
-        return true;
509
-    }
510
-
511
-    /**
512
-     * Effectue la suppression d'un article (et de ses images et fichier attaché)
513
-     *
514
-     * @param references_articles $article L'article à supprimer
515
-     * @return boolean    Le résultat de la suppression
516
-     */
517
-    public function deleteArticle(references_articles $article)
518
-    {
519
-        $article->deletePicturesAndThumbs();
520
-        $article->deleteAttachment();
521
-
522
-        return $this->delete($article, true);
523
-    }
524
-
525
-    /**
526
-     * Retourne la liste des catégories uniques utilisées par les références
527
-     *
528
-     */
529
-    public function getDistinctCategoriesIds()
530
-    {
531
-        $ret = array();
532
-        $sql = 'SELECT distinct(article_category_id) FROM ' . $this->table;
533
-        $sql .= ' ' . $this->getPermissionsCategoriesCriteria()->renderWhere();    // Permissions
534
-        $sql .= ' GROUP BY article_category_id ORDER BY article_category_id';
535
-        $result = $this->db->query($sql);
536
-        if (!$result) {
537
-            return $ret;
538
-        }
539
-        while ($row = $this->db->fetchArray($result)) {
540
-            $ret[$row['article_category_id']] = $row['article_category_id'];
541
-        }
542
-
543
-        return $ret;
544
-    }
545
-
546
-    /**
547
-     * Passe un article en ligne
548
-     *
549
-     * @param  references_articles $article
550
-     * @return boolean
551
-     */
552
-    public function onlineArticle(references_articles $article)
553
-    {
554
-        $article->setVar('article_online', REFERENCES_STATUS_ONLINE);
555
-
556
-        return $this->insert($article, true);
557
-    }
558
-
559
-    /**
560
-     * Passe un article hors ligne
561
-     *
562
-     * @param  references_articles $article
563
-     * @return boolean
564
-     */
565
-    public function offlineArticle(references_articles $article)
566
-    {
567
-        $article->setVar('article_online', REFERENCES_STATUS_OFFLINE);
568
-
569
-        return $this->insert($article, true);
570
-    }
571
-
572
-    /**
573
-     * Indique si une référence est visible d'un utilisateur
574
-     *
575
-     * @param object|references_articles $article L'article à controler
576
-     * @param integer                    $uid     L'id de l'utilisateur à controler
577
-     * @return bool
578
-     */
579
-    public function userCanSeeReference(references_articles $article, $uid = 0)
580
-    {
581
-        global $xoopsUser;
582
-        if ($uid == 0) {
583
-            $uid = references_utils::getCurrentUserID();
584
-        }
585
-        $currentModule = references_utils::getModule();
586
-        $groups        = is_object($xoopsUser) ? $xoopsUser->getGroups() : XOOPS_GROUP_ANONYMOUS;
587
-        $gperm_handler = xoops_getHandler('groupperm');
588
-
589
-        return $gperm_handler->checkRight(REFERENCES_PERM_READ, $article->article_category_id, references_utils::getMemberGroups($uid), $currentModule->getVar('mid'));
590
-    }
591
-
592
-    /**
593
-     * Remonte un article d'un cran dans l'ordre global des articles
594
-     *
595
-     * @param  integer $currentId    L'ID de l'article courant dont on souhaite remonter l'ordre
596
-     * @param integer  $currentOrder L'ordre de l'élément courant à remonter
597
-     * @return void
598
-     */
599
-    public function moveUp($currentId, $currentOrder)
600
-    {
601
-        $sql_plus = 'SELECT article_id FROM ' . $this->table . ' WHERE article_weight = ' . ((int)$currentOrder - 1);
602
-        $res_plus = $this->db->query($sql_plus);
603
-        if ($this->db->getRowsNum($res_plus) == 0) {
604
-            return;
605
-        }
606
-        $row_plus = $this->db->fetchArray($res_plus);
607
-
608
-        $upd1 = 'UPDATE ' . $this->table . ' SET article_weight = (article_weight + 1) WHERE article_id = ' . $row_plus['article_id'];
609
-        $this->db->queryF($upd1);
610
-
611
-        $upd2 = 'UPDATE ' . $this->table . ' SET article_weight = (article_weight - 1) WHERE article_id = ' . (int)$currentId;
612
-        $this->db->queryF($upd2);
613
-        $this->forceCacheClean();
614
-    }
615
-
616
-    /**
617
-     * Descend un article d'un cran dans l'ordre global des articles
618
-     *
619
-     * @param  integer $currentId    L'Id de l'article courant dont on souhaite descendre l'ordre
620
-     * @param integer  $currentOrder L'orde de l'élément courant à remonter
621
-     * @return void
622
-     */
623
-    public function moveDown($currentId, $currentOrder)
624
-    {
625
-        $sql_moins = 'SELECT article_id FROM ' . $this->table . ' WHERE article_weight = ' . ((int)$currentOrder + 1);
626
-        $res_moins = $this->db->query($sql_moins);
627
-        if ($this->db->getRowsNum($res_moins) == 0) {
628
-            return;
629
-        }
630
-
631
-        $row_moins = $this->db->fetchArray($res_moins);
632
-        $upd1      = 'UPDATE ' . $this->table . ' SET article_weight = (article_weight - 1) WHERE article_id = ' . $row_moins['article_id'];
633
-        $this->db->queryF($upd1);
634
-
635
-        $upd2 = 'UPDATE ' . $this->table . ' SET article_weight =( article_weight + 1) WHERE article_id = ' . (int)$currentId;
636
-        $this->db->queryF($upd2);
637
-        $this->forceCacheClean();
638
-    }
423
+	public function __construct($db)
424
+	{    //                         Table                   Classe                Id            Descr.
425
+		parent::__construct($db, 'references_articles', 'references_articles', 'article_id', 'article_title');
426
+	}
427
+
428
+	/**
429
+	 * Retourne le critère à utiliser pour voir les catégories en respectant les permissions
430
+	 *
431
+	 * @param  string $permissionsType Type de permission (pour l'instant permission de voir)
432
+	 * @return obejct de type Criteria
433
+	 */
434
+	public function getPermissionsCategoriesCriteria($permissionsType = REFERENCES_PERM_READ)
435
+	{
436
+		global $xoopsUser;
437
+		static $permissions = array();
438
+		if (is_array($permissions) && array_key_exists($permissionsType, $permissions)) {
439
+			return $permissions[$permissionsType];
440
+		}
441
+		$categories    = array();
442
+		$currentModule = references_utils::getModule();
443
+		$groups        = is_object($xoopsUser) ? $xoopsUser->getGroups() : XOOPS_GROUP_ANONYMOUS;
444
+		$gperm_handler = xoops_getHandler('groupperm');
445
+		$categories    = $gperm_handler->getItemIds($permissionsType, $groups, $currentModule->getVar('mid'));
446
+		if (is_array($categories) && count($categories) > 0) {
447
+			$permissions[$permissionsType] = new Criteria('article_category_id', '(' . implode(',', $categories) . ')', 'IN');
448
+		} else {    // Ne peut rien voir
449
+			$permissions[$permissionsType] = new Criteria('article_category_id', '0', '=');
450
+		}
451
+
452
+		return $permissions[$permissionsType];
453
+	}
454
+
455
+	/**
456
+	 * Retourne les articles récents en tenant compte des permissions de consultation sur les catégories
457
+	 *
458
+	 * @param integer  $start      Indice de début
459
+	 * @param integer  $limit      Nombre d'objets à renvoyer
460
+	 * @param  string  $sort       Zone de tri
461
+	 * @param  string  $order      Sens du tri
462
+	 * @param  boolean $onlyOnline Uniquement les articles en ligne ?
463
+	 * @param integer  $categoryId Identifiant d'une catégorie à laquelle se limiter
464
+	 * @return array   Objets de type references_articles
465
+	 */
466
+	public function getRecentArticles($start = 0, $limit = 0, $sort = 'article_timestamp', $order = 'DESC', $onlyOnline = true, $categoryId = 0)
467
+	{
468
+		$criteria = new CriteriaCompo();
469
+		$criteria->add(new Criteria('article_id', 0, '<>'));
470
+		$criteria->add($this->getPermissionsCategoriesCriteria());
471
+		if ($onlyOnline) {
472
+			$criteria->add(new Criteria('article_online', REFERENCES_STATUS_ONLINE, '='));
473
+		}
474
+		if (is_array($categoryId) && count($categoryId) > 0) {
475
+			$criteria->add(new Criteria('article_category_id', '(' . implode(',', $categoryId) . ')', 'IN'));
476
+		} elseif ($categoryId > 0) {
477
+			$criteria->add(new Criteria('article_category_id', $categoryId, '='));
478
+		}
479
+		$criteria->setStart($start);
480
+		$criteria->setSort($sort);
481
+		$criteria->setOrder($order);
482
+		$criteria->setLimit($limit);
483
+
484
+		return $this->getObjects($criteria);
485
+	}
486
+
487
+	/**
488
+	 * Retourne le nombre total d'articles en ligne
489
+	 *
490
+	 * @return integer
491
+	 */
492
+	public function getOnlineArticlesCount()
493
+	{
494
+		return $this->getCount(new Criteria('article_online', REFERENCES_STATUS_ONLINE, '='));
495
+	}
496
+
497
+	/**
498
+	 * Notification de la publication d'une nouvelle référence
499
+	 *
500
+	 * @param object|references_articles $article L'annonce pour laquelle on fait la notification
501
+	 * @return bool
502
+	 */
503
+	public function notifyNewArticle(references_articles $article)
504
+	{
505
+		$plugins = references_plugins::getInstance();
506
+		$plugins->fireAction(references_plugins::EVENT_ON_REFERENCE_CREATE, new references_parameters(array('reference' => $article)));
507
+
508
+		return true;
509
+	}
510
+
511
+	/**
512
+	 * Effectue la suppression d'un article (et de ses images et fichier attaché)
513
+	 *
514
+	 * @param references_articles $article L'article à supprimer
515
+	 * @return boolean    Le résultat de la suppression
516
+	 */
517
+	public function deleteArticle(references_articles $article)
518
+	{
519
+		$article->deletePicturesAndThumbs();
520
+		$article->deleteAttachment();
521
+
522
+		return $this->delete($article, true);
523
+	}
524
+
525
+	/**
526
+	 * Retourne la liste des catégories uniques utilisées par les références
527
+	 *
528
+	 */
529
+	public function getDistinctCategoriesIds()
530
+	{
531
+		$ret = array();
532
+		$sql = 'SELECT distinct(article_category_id) FROM ' . $this->table;
533
+		$sql .= ' ' . $this->getPermissionsCategoriesCriteria()->renderWhere();    // Permissions
534
+		$sql .= ' GROUP BY article_category_id ORDER BY article_category_id';
535
+		$result = $this->db->query($sql);
536
+		if (!$result) {
537
+			return $ret;
538
+		}
539
+		while ($row = $this->db->fetchArray($result)) {
540
+			$ret[$row['article_category_id']] = $row['article_category_id'];
541
+		}
542
+
543
+		return $ret;
544
+	}
545
+
546
+	/**
547
+	 * Passe un article en ligne
548
+	 *
549
+	 * @param  references_articles $article
550
+	 * @return boolean
551
+	 */
552
+	public function onlineArticle(references_articles $article)
553
+	{
554
+		$article->setVar('article_online', REFERENCES_STATUS_ONLINE);
555
+
556
+		return $this->insert($article, true);
557
+	}
558
+
559
+	/**
560
+	 * Passe un article hors ligne
561
+	 *
562
+	 * @param  references_articles $article
563
+	 * @return boolean
564
+	 */
565
+	public function offlineArticle(references_articles $article)
566
+	{
567
+		$article->setVar('article_online', REFERENCES_STATUS_OFFLINE);
568
+
569
+		return $this->insert($article, true);
570
+	}
571
+
572
+	/**
573
+	 * Indique si une référence est visible d'un utilisateur
574
+	 *
575
+	 * @param object|references_articles $article L'article à controler
576
+	 * @param integer                    $uid     L'id de l'utilisateur à controler
577
+	 * @return bool
578
+	 */
579
+	public function userCanSeeReference(references_articles $article, $uid = 0)
580
+	{
581
+		global $xoopsUser;
582
+		if ($uid == 0) {
583
+			$uid = references_utils::getCurrentUserID();
584
+		}
585
+		$currentModule = references_utils::getModule();
586
+		$groups        = is_object($xoopsUser) ? $xoopsUser->getGroups() : XOOPS_GROUP_ANONYMOUS;
587
+		$gperm_handler = xoops_getHandler('groupperm');
588
+
589
+		return $gperm_handler->checkRight(REFERENCES_PERM_READ, $article->article_category_id, references_utils::getMemberGroups($uid), $currentModule->getVar('mid'));
590
+	}
591
+
592
+	/**
593
+	 * Remonte un article d'un cran dans l'ordre global des articles
594
+	 *
595
+	 * @param  integer $currentId    L'ID de l'article courant dont on souhaite remonter l'ordre
596
+	 * @param integer  $currentOrder L'ordre de l'élément courant à remonter
597
+	 * @return void
598
+	 */
599
+	public function moveUp($currentId, $currentOrder)
600
+	{
601
+		$sql_plus = 'SELECT article_id FROM ' . $this->table . ' WHERE article_weight = ' . ((int)$currentOrder - 1);
602
+		$res_plus = $this->db->query($sql_plus);
603
+		if ($this->db->getRowsNum($res_plus) == 0) {
604
+			return;
605
+		}
606
+		$row_plus = $this->db->fetchArray($res_plus);
607
+
608
+		$upd1 = 'UPDATE ' . $this->table . ' SET article_weight = (article_weight + 1) WHERE article_id = ' . $row_plus['article_id'];
609
+		$this->db->queryF($upd1);
610
+
611
+		$upd2 = 'UPDATE ' . $this->table . ' SET article_weight = (article_weight - 1) WHERE article_id = ' . (int)$currentId;
612
+		$this->db->queryF($upd2);
613
+		$this->forceCacheClean();
614
+	}
615
+
616
+	/**
617
+	 * Descend un article d'un cran dans l'ordre global des articles
618
+	 *
619
+	 * @param  integer $currentId    L'Id de l'article courant dont on souhaite descendre l'ordre
620
+	 * @param integer  $currentOrder L'orde de l'élément courant à remonter
621
+	 * @return void
622
+	 */
623
+	public function moveDown($currentId, $currentOrder)
624
+	{
625
+		$sql_moins = 'SELECT article_id FROM ' . $this->table . ' WHERE article_weight = ' . ((int)$currentOrder + 1);
626
+		$res_moins = $this->db->query($sql_moins);
627
+		if ($this->db->getRowsNum($res_moins) == 0) {
628
+			return;
629
+		}
630
+
631
+		$row_moins = $this->db->fetchArray($res_moins);
632
+		$upd1      = 'UPDATE ' . $this->table . ' SET article_weight = (article_weight - 1) WHERE article_id = ' . $row_moins['article_id'];
633
+		$this->db->queryF($upd1);
634
+
635
+		$upd2 = 'UPDATE ' . $this->table . ' SET article_weight =( article_weight + 1) WHERE article_id = ' . (int)$currentId;
636
+		$this->db->queryF($upd2);
637
+		$this->forceCacheClean();
638
+	}
639 639
 }
Please login to merge, or discard this patch.
class/references_categories.php 3 patches
Doc Comments   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -185,7 +185,7 @@  discard block
 block discarded – undo
185 185
     /**
186 186
      * Notification de la création d'une nouvelle catégorie
187 187
      *
188
-     * @param object|references_categories $category
188
+     * @param references_categories $category
189 189
      * @return bool
190 190
      */
191 191
     public function notifyNewCategory(references_categories $category)
@@ -199,7 +199,7 @@  discard block
 block discarded – undo
199 199
     /**
200 200
      * Indique si une catégorie est visible d'un utilisateur
201 201
      *
202
-     * @param object|references_categories $category La catégorie à controler
202
+     * @param references_categories $category La catégorie à controler
203 203
      * @param integer                      $uid      L'id de l'utilisateur à controler
204 204
      * @return bool
205 205
      */
Please login to merge, or discard this patch.
Spacing   +7 added lines, -7 removed lines patch added patch discarded remove patch
@@ -22,9 +22,9 @@  discard block
 block discarded – undo
22 22
     die('XOOPS root path not defined');
23 23
 }
24 24
 
25
-require_once XOOPS_ROOT_PATH . '/kernel/object.php';
25
+require_once XOOPS_ROOT_PATH.'/kernel/object.php';
26 26
 if (!class_exists('references_XoopsPersistableObjectHandler')) {
27
-    require_once XOOPS_ROOT_PATH . '/modules/references/class/PersistableObjectHandler.php';
27
+    require_once XOOPS_ROOT_PATH.'/modules/references/class/PersistableObjectHandler.php';
28 28
 }
29 29
 
30 30
 class references_categories extends references_Object
@@ -58,9 +58,9 @@  discard block
 block discarded – undo
58 58
     public function getUrl($shortVersion = false)
59 59
     {
60 60
         if (!$shortVersion) {
61
-            return REFERENCES_URL . 'category.php?category_id=' . $this->getVar('category_id');
61
+            return REFERENCES_URL.'category.php?category_id='.$this->getVar('category_id');
62 62
         } else {
63
-            return 'category.php?category_id=' . $this->getVar('category_id');
63
+            return 'category.php?category_id='.$this->getVar('category_id');
64 64
         }
65 65
     }
66 66
 
@@ -110,7 +110,7 @@  discard block
 block discarded – undo
110 110
         $gperm_handler = xoops_getHandler('groupperm');
111 111
         $categories    = $gperm_handler->getItemIds($permissionsType, $groups, $currentModule->getVar('mid'));
112 112
         if (is_array($categories) && count($categories) > 0) {
113
-            $permissions[$permissionsType] = new Criteria('category_id', '(' . implode(',', $categories) . ')', 'IN');
113
+            $permissions[$permissionsType] = new Criteria('category_id', '('.implode(',', $categories).')', 'IN');
114 114
         } else {    // Ne peut rien voir
115 115
             $permissions[$permissionsType] = new Criteria('category_id', '0', '=');
116 116
         }
@@ -176,8 +176,8 @@  discard block
 block discarded – undo
176 176
         if (count($categories) == 0) {
177 177
             return $ret;
178 178
         }
179
-        $jump  = REFERENCES_URL . 'category.php?category_id=';
180
-        $extra = " onchange='location=\"" . $jump . "\"+this.options[this.selectedIndex].value'";
179
+        $jump  = REFERENCES_URL.'category.php?category_id=';
180
+        $extra = " onchange='location=\"".$jump."\"+this.options[this.selectedIndex].value'";
181 181
 
182 182
         return references_utils::htmlSelect($selectName, $categories, $selected, true, '', false, 1, $extra);
183 183
     }
Please login to merge, or discard this patch.
Indentation   +183 added lines, -183 removed lines patch added patch discarded remove patch
@@ -22,195 +22,195 @@
 block discarded – undo
22 22
 
23 23
 require_once XOOPS_ROOT_PATH . '/kernel/object.php';
24 24
 if (!class_exists('references_XoopsPersistableObjectHandler')) {
25
-    require_once XOOPS_ROOT_PATH . '/modules/references/class/PersistableObjectHandler.php';
25
+	require_once XOOPS_ROOT_PATH . '/modules/references/class/PersistableObjectHandler.php';
26 26
 }
27 27
 
28 28
 class references_categories extends references_Object
29 29
 {
30
-    public function __construct()
31
-    {
32
-        $this->initVar('category_id', XOBJ_DTYPE_INT, null, false);
33
-        $this->initVar('category_title', XOBJ_DTYPE_TXTBOX, null, false);
34
-        $this->initVar('category_weight', XOBJ_DTYPE_INT, null, false);
35
-        $this->initVar('category_description', XOBJ_DTYPE_TXTAREA, null, false);
36
-        // Pour autoriser le html
37
-        $this->initVar('dohtml', XOBJ_DTYPE_INT, 1, false);
38
-    }
39
-
40
-    /**
41
-     * Retourne la chaine de caractères qui peut être utilisée dans l'attribut href d'une balise html A.
42
-     *
43
-     * @return string
44
-     */
45
-    public function getHrefTitle()
46
-    {
47
-        return references_utils::makeHrefTitle($this->getVar('category_title'));
48
-    }
49
-
50
-    /**
51
-     * Retourne l'url à utiliser pour atteindre la catégorie
52
-     *
53
-     * @param bool $shortVersion
54
-     * @return string
55
-     */
56
-    public function getUrl($shortVersion = false)
57
-    {
58
-        if (!$shortVersion) {
59
-            return REFERENCES_URL . 'category.php?category_id=' . $this->getVar('category_id');
60
-        } else {
61
-            return 'category.php?category_id=' . $this->getVar('category_id');
62
-        }
63
-    }
64
-
65
-    /**
66
-     * Retourne les éléments de l'annnonce formatés pour affichage
67
-     *
68
-     * @param string $format Format à utiliser
69
-     * @return array
70
-     */
71
-    public function toArray($format = 's')
72
-    {
73
-        $ret                          = array();
74
-        $ret                          = parent::toArray($format);
75
-        $ret['category_href_title']   = $this->getHrefTitle();
76
-        $ret['category_url_rewrited'] = $this->getUrl();
77
-
78
-        return $ret;
79
-    }
30
+	public function __construct()
31
+	{
32
+		$this->initVar('category_id', XOBJ_DTYPE_INT, null, false);
33
+		$this->initVar('category_title', XOBJ_DTYPE_TXTBOX, null, false);
34
+		$this->initVar('category_weight', XOBJ_DTYPE_INT, null, false);
35
+		$this->initVar('category_description', XOBJ_DTYPE_TXTAREA, null, false);
36
+		// Pour autoriser le html
37
+		$this->initVar('dohtml', XOBJ_DTYPE_INT, 1, false);
38
+	}
39
+
40
+	/**
41
+	 * Retourne la chaine de caractères qui peut être utilisée dans l'attribut href d'une balise html A.
42
+	 *
43
+	 * @return string
44
+	 */
45
+	public function getHrefTitle()
46
+	{
47
+		return references_utils::makeHrefTitle($this->getVar('category_title'));
48
+	}
49
+
50
+	/**
51
+	 * Retourne l'url à utiliser pour atteindre la catégorie
52
+	 *
53
+	 * @param bool $shortVersion
54
+	 * @return string
55
+	 */
56
+	public function getUrl($shortVersion = false)
57
+	{
58
+		if (!$shortVersion) {
59
+			return REFERENCES_URL . 'category.php?category_id=' . $this->getVar('category_id');
60
+		} else {
61
+			return 'category.php?category_id=' . $this->getVar('category_id');
62
+		}
63
+	}
64
+
65
+	/**
66
+	 * Retourne les éléments de l'annnonce formatés pour affichage
67
+	 *
68
+	 * @param string $format Format à utiliser
69
+	 * @return array
70
+	 */
71
+	public function toArray($format = 's')
72
+	{
73
+		$ret                          = array();
74
+		$ret                          = parent::toArray($format);
75
+		$ret['category_href_title']   = $this->getHrefTitle();
76
+		$ret['category_url_rewrited'] = $this->getUrl();
77
+
78
+		return $ret;
79
+	}
80 80
 }
81 81
 
82 82
 class ReferencesReferences_categoriesHandler extends references_XoopsPersistableObjectHandler
83 83
 {
84
-    public function __construct($db)
85
-    {    //                         Table                   Classe                    Id                Descr.
86
-        parent::__construct($db, 'references_categories', 'references_categories', 'category_id', 'category_title');
87
-    }
88
-
89
-    /**
90
-     * Retourne le crit�re � utiliser pour voir les cat�gories en respectant les permissions
91
-     *
92
-     * @param  string $permissionsType Type de permission (pour l'instant permission de voir)
93
-     * @return obejct de type Criteria
94
-     */
95
-    public function getPermissionsCategoriesCriteria($permissionsType = REFERENCES_PERM_READ)
96
-    {
97
-        global $xoopsUser;
98
-        static $permissions = array();
99
-        if (references_utils::isAdmin()) {
100
-            return new Criteria('category_id', '0', '>');
101
-        }
102
-        if (is_array($permissions) && array_key_exists($permissionsType, $permissions)) {
103
-            return $permissions[$permissionsType];
104
-        }
105
-        $categories    = array();
106
-        $currentModule = references_utils::getModule();
107
-        $groups        = is_object($xoopsUser) ? $xoopsUser->getGroups() : XOOPS_GROUP_ANONYMOUS;
108
-        $gperm_handler = xoops_getHandler('groupperm');
109
-        $categories    = $gperm_handler->getItemIds($permissionsType, $groups, $currentModule->getVar('mid'));
110
-        if (is_array($categories) && count($categories) > 0) {
111
-            $permissions[$permissionsType] = new Criteria('category_id', '(' . implode(',', $categories) . ')', 'IN');
112
-        } else {    // Ne peut rien voir
113
-            $permissions[$permissionsType] = new Criteria('category_id', '0', '=');
114
-        }
115
-
116
-        return $permissions[$permissionsType];
117
-    }
118
-
119
-    /**
120
-     * Retourne les catégories
121
-     *
122
-     * @param integer $start Indice de début
123
-     * @param integer $limit Nombre d'objets à renvoyer
124
-     * @param  string $sort  Zone de tri
125
-     * @param  string $order Sens du tri
126
-     * @return array   Objets de type references_categories
127
-     */
128
-    public function getCategories($start = 0, $limit = 0, $sort = 'category_weight', $order = 'ASC')
129
-    {
130
-        $criteria = new CriteriaCompo();
131
-        $criteria->add(new Criteria('category_id', 0, '<>'));
132
-        $criteria->add($this->getPermissionsCategoriesCriteria());
133
-        $criteria->setStart($start);
134
-        $criteria->setSort($sort);
135
-        $criteria->setOrder($order);
136
-        $criteria->setLimit($limit);
137
-
138
-        return $this->getObjects($criteria, true);
139
-    }
140
-
141
-    /**
142
-     * Retourne la liste des catégories en tant que tableau
143
-     * @param integer $start Position de départ
144
-     * @param integer $limit Nombre maximum d'objets à retourner
145
-     * @param  string $sort  ordre de tri
146
-     * @param  string $order Sens du tri
147
-     * @return array
148
-     */
149
-    public function getListArray($start = 0, $limit = 0, $sort = 'category_weight', $order = 'ASC')
150
-    {
151
-        $criteria = new CriteriaCompo();
152
-        $criteria->add(new Criteria('category_id', 0, '<>'));
153
-        $criteria->add($this->getPermissionsCategoriesCriteria());
154
-        $criteria->setStart($start);
155
-        $criteria->setSort($sort);
156
-        $criteria->setOrder($order);
157
-        $criteria->setLimit($limit);
158
-
159
-        return $this->getList($criteria);
160
-    }
161
-
162
-    /**
163
-     * Retourne le sélecteur à utiliser pour voir la liste des catégies
164
-     *
165
-     * @param string  $selectName Le nom du sélecteur
166
-     * @param integer $selected   L'élément sélectionné
167
-     * @return string
168
-     */
169
-    public function getCategoriesSelect($selectName = 'categoriesSelect', $selected = 0)
170
-    {
171
-        $categories = array();
172
-        $ret        = '';
173
-        $categories = $this->getListArray(0, 0, 'category_weight ASC, category_title', 'ASC');
174
-        if (count($categories) == 0) {
175
-            return $ret;
176
-        }
177
-        $jump  = REFERENCES_URL . 'category.php?category_id=';
178
-        $extra = " onchange='location=\"" . $jump . "\"+this.options[this.selectedIndex].value'";
179
-
180
-        return references_utils::htmlSelect($selectName, $categories, $selected, true, '', false, 1, $extra);
181
-    }
182
-
183
-    /**
184
-     * Notification de la création d'une nouvelle catégorie
185
-     *
186
-     * @param object|references_categories $category
187
-     * @return bool
188
-     */
189
-    public function notifyNewCategory(references_categories $category)
190
-    {
191
-        $plugins = references_plugins::getInstance();
192
-        $plugins->fireAction(references_plugins::EVENT_ON_CATEGORY_CREATE, new references_parameters(array('category' => $category)));
193
-
194
-        return true;
195
-    }
196
-
197
-    /**
198
-     * Indique si une catégorie est visible d'un utilisateur
199
-     *
200
-     * @param object|references_categories $category La catégorie à controler
201
-     * @param integer                      $uid      L'id de l'utilisateur à controler
202
-     * @return bool
203
-     */
204
-    public function userCanSeeCategory(references_categories $category, $uid = 0)
205
-    {
206
-        global $xoopsUser;
207
-        if ($uid == 0) {
208
-            $uid = references_utils::getCurrentUserID();
209
-        }
210
-        $currentModule = references_utils::getModule();
211
-        $groups        = is_object($xoopsUser) ? $xoopsUser->getGroups() : XOOPS_GROUP_ANONYMOUS;
212
-        $gperm_handler = xoops_getHandler('groupperm');
213
-
214
-        return $gperm_handler->checkRight(REFERENCES_PERM_READ, $category->category_id, references_utils::getMemberGroups($uid), $currentModule->getVar('mid'));
215
-    }
84
+	public function __construct($db)
85
+	{    //                         Table                   Classe                    Id                Descr.
86
+		parent::__construct($db, 'references_categories', 'references_categories', 'category_id', 'category_title');
87
+	}
88
+
89
+	/**
90
+	 * Retourne le crit�re � utiliser pour voir les cat�gories en respectant les permissions
91
+	 *
92
+	 * @param  string $permissionsType Type de permission (pour l'instant permission de voir)
93
+	 * @return obejct de type Criteria
94
+	 */
95
+	public function getPermissionsCategoriesCriteria($permissionsType = REFERENCES_PERM_READ)
96
+	{
97
+		global $xoopsUser;
98
+		static $permissions = array();
99
+		if (references_utils::isAdmin()) {
100
+			return new Criteria('category_id', '0', '>');
101
+		}
102
+		if (is_array($permissions) && array_key_exists($permissionsType, $permissions)) {
103
+			return $permissions[$permissionsType];
104
+		}
105
+		$categories    = array();
106
+		$currentModule = references_utils::getModule();
107
+		$groups        = is_object($xoopsUser) ? $xoopsUser->getGroups() : XOOPS_GROUP_ANONYMOUS;
108
+		$gperm_handler = xoops_getHandler('groupperm');
109
+		$categories    = $gperm_handler->getItemIds($permissionsType, $groups, $currentModule->getVar('mid'));
110
+		if (is_array($categories) && count($categories) > 0) {
111
+			$permissions[$permissionsType] = new Criteria('category_id', '(' . implode(',', $categories) . ')', 'IN');
112
+		} else {    // Ne peut rien voir
113
+			$permissions[$permissionsType] = new Criteria('category_id', '0', '=');
114
+		}
115
+
116
+		return $permissions[$permissionsType];
117
+	}
118
+
119
+	/**
120
+	 * Retourne les catégories
121
+	 *
122
+	 * @param integer $start Indice de début
123
+	 * @param integer $limit Nombre d'objets à renvoyer
124
+	 * @param  string $sort  Zone de tri
125
+	 * @param  string $order Sens du tri
126
+	 * @return array   Objets de type references_categories
127
+	 */
128
+	public function getCategories($start = 0, $limit = 0, $sort = 'category_weight', $order = 'ASC')
129
+	{
130
+		$criteria = new CriteriaCompo();
131
+		$criteria->add(new Criteria('category_id', 0, '<>'));
132
+		$criteria->add($this->getPermissionsCategoriesCriteria());
133
+		$criteria->setStart($start);
134
+		$criteria->setSort($sort);
135
+		$criteria->setOrder($order);
136
+		$criteria->setLimit($limit);
137
+
138
+		return $this->getObjects($criteria, true);
139
+	}
140
+
141
+	/**
142
+	 * Retourne la liste des catégories en tant que tableau
143
+	 * @param integer $start Position de départ
144
+	 * @param integer $limit Nombre maximum d'objets à retourner
145
+	 * @param  string $sort  ordre de tri
146
+	 * @param  string $order Sens du tri
147
+	 * @return array
148
+	 */
149
+	public function getListArray($start = 0, $limit = 0, $sort = 'category_weight', $order = 'ASC')
150
+	{
151
+		$criteria = new CriteriaCompo();
152
+		$criteria->add(new Criteria('category_id', 0, '<>'));
153
+		$criteria->add($this->getPermissionsCategoriesCriteria());
154
+		$criteria->setStart($start);
155
+		$criteria->setSort($sort);
156
+		$criteria->setOrder($order);
157
+		$criteria->setLimit($limit);
158
+
159
+		return $this->getList($criteria);
160
+	}
161
+
162
+	/**
163
+	 * Retourne le sélecteur à utiliser pour voir la liste des catégies
164
+	 *
165
+	 * @param string  $selectName Le nom du sélecteur
166
+	 * @param integer $selected   L'élément sélectionné
167
+	 * @return string
168
+	 */
169
+	public function getCategoriesSelect($selectName = 'categoriesSelect', $selected = 0)
170
+	{
171
+		$categories = array();
172
+		$ret        = '';
173
+		$categories = $this->getListArray(0, 0, 'category_weight ASC, category_title', 'ASC');
174
+		if (count($categories) == 0) {
175
+			return $ret;
176
+		}
177
+		$jump  = REFERENCES_URL . 'category.php?category_id=';
178
+		$extra = " onchange='location=\"" . $jump . "\"+this.options[this.selectedIndex].value'";
179
+
180
+		return references_utils::htmlSelect($selectName, $categories, $selected, true, '', false, 1, $extra);
181
+	}
182
+
183
+	/**
184
+	 * Notification de la création d'une nouvelle catégorie
185
+	 *
186
+	 * @param object|references_categories $category
187
+	 * @return bool
188
+	 */
189
+	public function notifyNewCategory(references_categories $category)
190
+	{
191
+		$plugins = references_plugins::getInstance();
192
+		$plugins->fireAction(references_plugins::EVENT_ON_CATEGORY_CREATE, new references_parameters(array('category' => $category)));
193
+
194
+		return true;
195
+	}
196
+
197
+	/**
198
+	 * Indique si une catégorie est visible d'un utilisateur
199
+	 *
200
+	 * @param object|references_categories $category La catégorie à controler
201
+	 * @param integer                      $uid      L'id de l'utilisateur à controler
202
+	 * @return bool
203
+	 */
204
+	public function userCanSeeCategory(references_categories $category, $uid = 0)
205
+	{
206
+		global $xoopsUser;
207
+		if ($uid == 0) {
208
+			$uid = references_utils::getCurrentUserID();
209
+		}
210
+		$currentModule = references_utils::getModule();
211
+		$groups        = is_object($xoopsUser) ? $xoopsUser->getGroups() : XOOPS_GROUP_ANONYMOUS;
212
+		$gperm_handler = xoops_getHandler('groupperm');
213
+
214
+		return $gperm_handler->checkRight(REFERENCES_PERM_READ, $category->category_id, references_utils::getMemberGroups($uid), $currentModule->getVar('mid'));
215
+	}
216 216
 }
Please login to merge, or discard this patch.
class/references_listFilter.php 3 patches
Doc Comments   +9 added lines, -9 removed lines patch added patch discarded remove patch
@@ -253,7 +253,7 @@  discard block
 block discarded – undo
253 253
     /**
254 254
      * Retourne les noms à utiliser pour les champs de tri (sélecteur de champ et ordre de tri)
255 255
      *
256
-     * @return array [0] = Nom du sélecteur de champs, [1] = Nom du sélecteur pour le sens du tri
256
+     * @return string[] [0] = Nom du sélecteur de champs, [1] = Nom du sélecteur pour le sens du tri
257 257
      */
258 258
     private function getSortPlaceHolderNames()
259 259
     {
@@ -279,7 +279,7 @@  discard block
 block discarded – undo
279 279
      *
280 280
      * @param  string $optionName
281 281
      * @param  mixed  $optionValue
282
-     * @return object
282
+     * @return references_listFilter
283 283
      */
284 284
     public function setOption($optionName, $optionValue)
285 285
     {
@@ -408,7 +408,7 @@  discard block
 block discarded – undo
408 408
      *                            [data]            A ne pas renseigner, contient la valeur saisie par l'utilisateur
409 409
      *                            [operator]        Opérateur de comparaison pour le Criteria
410 410
      *                            [autoComplete]  Indique si on active l'auto complétion sur le champs
411
-     * @return object L'objet courant pour pouvoir chainer
411
+     * @return references_listFilter L'objet courant pour pouvoir chainer
412 412
      */
413 413
     public function initFilter($fieldName, $parameters)
414 414
     {
@@ -464,7 +464,7 @@  discard block
 block discarded – undo
464 464
     /**
465 465
      * Ajoute les critères par défaut au critère général
466 466
      *
467
-     * @return void
467
+     * @return references_listFilter
468 468
      */
469 469
     private function addDefaultCriterias()
470 470
     {
@@ -592,7 +592,7 @@  discard block
 block discarded – undo
592 592
     /**
593 593
      * Méthode à appeler juste après le constructeur pour qu'elle récupère les données saisies
594 594
      *
595
-     * @return object L'objet courant pour pouvoir chainer
595
+     * @return references_listFilter L'objet courant pour pouvoir chainer
596 596
      */
597 597
     public function filter()
598 598
     {
@@ -717,7 +717,7 @@  discard block
 block discarded – undo
717 717
      *
718 718
      * @param  string $key
719 719
      * @param  string $value
720
-     * @return object
720
+     * @return references_listFilter
721 721
      */
722 722
     public function addAdditionnalParameterToPager($key, $value = '')
723 723
     {
@@ -731,7 +731,7 @@  discard block
 block discarded – undo
731 731
      *
732 732
      * @param  string $key
733 733
      * @param  string $value
734
-     * @return object
734
+     * @return references_listFilter
735 735
      */
736 736
     public function addAdditionnalParameterToClearButton($key, $value = '')
737 737
     {
@@ -744,7 +744,7 @@  discard block
 block discarded – undo
744 744
      * Permet d'ajouter des paramètres supplémentaires au pager
745 745
      *
746 746
      * @param $array
747
-     * @return object
747
+     * @return references_listFilter
748 748
      * @internal param string $key
749 749
      * @internal param string $value
750 750
      */
@@ -762,7 +762,7 @@  discard block
 block discarded – undo
762 762
     /**
763 763
      * Retourne le pager à utiliser
764 764
      *
765
-     * @return mixed Null s'il n'y a pas lieu d'y avoir un pager, sinon un objet de type {@link XoopsPageNav}
765
+     * @return XoopsPageNav|null Null s'il n'y a pas lieu d'y avoir un pager, sinon un objet de type {@link XoopsPageNav}
766 766
      */
767 767
     public function getPager()
768 768
     {
Please login to merge, or discard this patch.
Indentation   +926 added lines, -926 removed lines patch added patch discarded remove patch
@@ -35,930 +35,930 @@
 block discarded – undo
35 35
  */
36 36
 class references_listFilter
37 37
 {
38
-    const FILTER_DATA_TEXT    = 1;
39
-    const FILTER_DATA_NUMERIC = 2;
40
-
41
-    const FILTER_FIELD_TEXT          = 1;
42
-    const FILTER_FIELD_SELECT        = 2;
43
-    const FILTER_FIELD_SELECT_YES_NO = 3;
44
-
45
-    /**
46
-     * Préfixe des variables de sélection
47
-     */
48
-    const PREFIX = 'filter_';
49
-
50
-    /**
51
-     * Nom du module (utilisé pour la session)
52
-     */
53
-    const MODULE_NAME = 'references';
54
-
55
-    /**
56
-     * Contient toutes les variables participant au filtre (avec leur type et description)
57
-     *
58
-     * @var array
59
-     */
60
-    private $vars = array();
61
-
62
-    /**
63
-     * Handler des données
64
-     *
65
-     * @var reference
66
-     */
67
-    private $handler = null;
68
-
69
-    /**
70
-     * Nom de la zone d'opération (par exemple op=products)
71
-     *
72
-     * @var string
73
-     */
74
-    private $op = '';
75
-
76
-    /**
77
-     * action de l'opération en cour (par exemple op=products)
78
-     *
79
-     * @var string
80
-     */
81
-    private $operationName = '';
82
-
83
-    /**
84
-     * Nombre maximum d'éléments pas page
85
-     *
86
-     * @var intger
87
-     */
88
-    private $limit = 10;
89
-
90
-    /**
91
-     * Nom de la variable start
92
-     *
93
-     * @var string
94
-     */
95
-    private $startName = '';
96
-
97
-    /**
98
-     * Critère {@link Criteria} servant à choisir les données
99
-     *
100
-     * @var object
101
-     */
102
-    private $criteria = null;
103
-
104
-    /**
105
-     * Indique s'il y a un nouveau critère
106
-     *
107
-     * @var boolean
108
-     */
109
-    private $newFilter = false;
110
-
111
-    /**
112
-     * Indique si la méthode filter() a été appelée
113
-     *
114
-     * @var boolean
115
-     */
116
-    private $isInitialized = false;
117
-
118
-    /**
119
-     * Zone de tri pour retourner les données (dans getObjects)
120
-     *
121
-     * @var string
122
-     */
123
-    private $sortField = '';
124
-
125
-    /**
126
-     * Sens de tri
127
-     *
128
-     * @var string
129
-     */
130
-    private $sortOrder = '';
131
-
132
-    /**
133
-     * Liste de critères par défaut
134
-     *
135
-     * @var array
136
-     */
137
-    private $defaultCriterias = array();
138
-
139
-    /**
140
-     * L'url complète du script qui appelle
141
-     *
142
-     * @var string
143
-     */
144
-    private $baseUrl = '';
145
-
146
-    /**
147
-     * Indique si on conserve en session la position de départ
148
-     *
149
-     * @var boolean
150
-     */
151
-    private $keepStart = true;
152
-
153
-    /**
154
-     * Indique si l'autocomplétion est activée
155
-     *
156
-     * @var boolean
157
-     */
158
-    private $hasAutoComplete = false;
159
-
160
-    /**
161
-     * Url du dossier js dans le module
162
-     *
163
-     * @var string
164
-     */
165
-    private $jsFolderUrl = '';
166
-
167
-    /**
168
-     * Paramètres additionnels à ajouter aux paramètres du pager
169
-     * @var array
170
-     */
171
-    private $additionnalPagerParameters = array();
172
-
173
-    /**
174
-     * Paramètres additionnels à ajouter au bouton permettant de supprimer le filtre en cours
175
-     * @var array
176
-     */
177
-    private $additionnalClearButtonParameters = array();
178
-
179
-    /**
180
-     * Tableau des champs triables [clé] = nom du champ dans la base, valeur = libellé
181
-     * @var array
182
-     */
183
-    private $sortFields = array();
184
-
185
-    /**
186
-     * Initialise les paramètres avec des valeurs par défaut
187
-     */
188
-    private function setDefaultValues()
189
-    {
190
-        $this->handler                          = null;
191
-        $this->op                               = '';
192
-        $this->limit                            = 10;
193
-        $this->startName                        = 'start';
194
-        $this->operationName                    = 'op';
195
-        $this->sortField                        = '';
196
-        $this->sortOrder                        = 'asc';
197
-        $this->baseUrl                          = '';
198
-        $this->keepStart                        = true;
199
-        $this->hasAutoComplete                  = false;
200
-        $this->jsFolderUrl                      = '';
201
-        $this->additionnalPagerParameters       = array();
202
-        $this->additionnalClearButtonParameters = array();
203
-        $this->sortFields                       = array();    // Les champs qui peuvent être utilisés pour trier
204
-    }
205
-
206
-    /**
207
-     * Initialisation des données, handler et opération courante dans l'appelant
208
-     *
209
-     * @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)
210
-     * @param string  $operationName
211
-     * @param string  $operation Opération courante dans l'appelant
212
-     * @param string  $startName Nom du paramètre start
213
-     * @param integer $limit     Nombre maximum d'éléments par page
214
-     * @param string  $baseUrl   L'url complète du script appelant
215
-     * @param string  $sortField Zone de tri
216
-     * @param string  $sortOrder Sens de tri
217
-     * @param boolean $keepStart Indique si on conserve la position de départ
218
-     * @param string  $jsFolderUrl
219
-     * @package string $jsFolderUrl Url du répertoire qui contient les scripts Javascript
220
-     */
221
-    public function __construct($handler, $operationName = 'op', $operation = '', $startName = 'start', $limit = 10, $baseUrl = '', $sortField = '', $sortOrder = 'asc', $keepStart = true, $jsFolderUrl = '')
222
-    {
223
-        $this->setDefaultValues();
224
-        if (!is_array($handler)) {
225
-            $this->handler       = $handler;
226
-            $this->op            = $operation;
227
-            $this->limit         = $limit;
228
-            $this->startName     = $startName;
229
-            $this->operationName = $operationName;
230
-            $this->sortField     = $sortField;
231
-            $this->sortOrder     = $sortOrder;
232
-            $this->baseUrl       = $baseUrl;
233
-            $this->keepStart     = $keepStart;
234
-            $this->jsFolderUrl   = $jsFolderUrl;
235
-        } else {
236
-            foreach ($handler as $key => $value) {
237
-                $this->$key = $value;
238
-            }
239
-        }
240
-    }
241
-
242
-    /**
243
-     * Donne à la classe le nom des champs sur lesquels on peut faire le tri
244
-     *
245
-     * @param  array $fields [clé] = nom du champ dans la base, valeur = libellé
246
-     * @return object
247
-     */
248
-    public function setSortFields($fields)
249
-    {
250
-        $this->sortFields = $fields;
251
-    }
252
-
253
-    /**
254
-     * Retourne les noms à utiliser pour les champs de tri (sélecteur de champ et ordre de tri)
255
-     *
256
-     * @return array [0] = Nom du sélecteur de champs, [1] = Nom du sélecteur pour le sens du tri
257
-     */
258
-    private function getSortPlaceHolderNames()
259
-    {
260
-        return array(self::PREFIX . 'sortFields', self::PREFIX . 'sortOrder');
261
-    }
262
-
263
-    /**
264
-     * Retourne 2 sélecteurs html pour choisir la zone de tri et le sens du tri
265
-     *
266
-     * @return string
267
-     */
268
-    public function getSortPlaceHolderHtmlCode()
269
-    {
270
-        $sortNames      = $this->getSortPlaceHolderNames();
271
-        $sortFieldsHtml = references_utils::htmlSelect($sortNames[0], $this->sortFields, $this->sortField, false);
272
-        $sortOrderHtml  = references_utils::htmlSelect($sortNames[1], array('asc' => _MD_REFERENCES_ASC, 'desc' => _MD_REFERENCES_DESC), $this->sortOrder, false);
273
-
274
-        return _MD_REFERENCES_SORT_BY . ' ' . $sortFieldsHtml . ' ' . $sortOrderHtml;
275
-    }
276
-
277
-    /**
278
-     * Permet de valoriser une option directement tout en chainant
279
-     *
280
-     * @param  string $optionName
281
-     * @param  mixed  $optionValue
282
-     * @return object
283
-     */
284
-    public function setOption($optionName, $optionValue)
285
-    {
286
-        $this->$optionName = $optionValue;
287
-
288
-        return $this;
289
-    }
290
-
291
-    /**
292
-     * Ajoute un nouveau critère par défaut à la liste des critères par défaut
293
-     *
294
-     * @param Criteria $criteria
295
-     */
296
-    public function addDefaultCriteria(Criteria $criteria)
297
-    {
298
-        $this->defaultCriterias[] = $criteria;
299
-    }
300
-
301
-    /**
302
-     * Retourne une valeur d'un tableau ou null si l'index n'existe pas
303
-     *
304
-     * @param array   $array        Le tableau à traiter
305
-     * @param  string $index        L'index recherché
306
-     * @param  mixed  $defaultValue La valeur par défaut
307
-     * @return mixed
308
-     */
309
-    private function getArrayValue($array, $index, $defaultValue = false)
310
-    {
311
-        if ($index === 'autoComplete' && isset($array[$index]) && isset($array[$index]) == true) {
312
-            $this->hasAutoComplete = true;    // On en profite pour vérifier si un champ utilise l'autocomplétion
313
-        }
314
-
315
-        return isset($array[$index]) ? $array[$index] : $defaultValue;
316
-    }
317
-
318
-    /**
319
-     * Permet de faire l'autocomplétion d'un champ
320
-     *
321
-     * @param  string $query
322
-     * @param         $limit
323
-     * @param  string $fieldName
324
-     * @return string
325
-     */
326
-    public function autoComplete($query, $limit, $fieldName)
327
-    {
328
-        $return = '';
329
-        if (!$this->hasAutoComplete) {    // Si aucun champ n'est en autocomplétion, c'est pas la peine d'aller plus loin
330
-
331
-            return $return;
332
-        }
333
-        if (isset($this->vars[$fieldName])) {    // On vérifie que le champ demandé est bien en autocomplétion
334
-            if ($this->vars[$fieldName]['autoComplete'] == true) {
335
-                if ($this->vars[$fieldName]['dataType'] == self::FILTER_DATA_TEXT) {
336
-                    $criteria = new Criteria($fieldName, $query . '%', 'LIKE');
337
-                }
338
-                $criteria->setLimit((int)$limit);
339
-                $ret = $this->handler->getObjects($criteria);
340
-
341
-                if (count($ret) > 0) {
342
-                    foreach ($ret as $object) {
343
-                        $return .= $object->getVar($fieldName, 'n') . "\n";
344
-                    }
345
-                }
346
-            }
347
-        }
348
-
349
-        return $return;
350
-    }
351
-
352
-    /**
353
-     * Retourne le code Javascript à utiliser pour initialiser l'auto complétion (et donc à coller dans le code html)
354
-     *
355
-     * @param boolean $jqueryAlreadyLoaded Indique si jQuery est déjà chargé par l'appelant, auquel cas rien ne sert de le recharger
356
-     * @return string
357
-     */
358
-    public function getJavascriptInitCode($jqueryAlreadyLoaded = false)
359
-    {
360
-        $return = '';
361
-        if (!$this->hasAutoComplete) {
362
-            return $return;
363
-        }
364
-        $return = '';
365
-        $return .= "<link rel=\"stylesheet\" type=\"text/css\" media=\"all\" title=\"Style sheet\" href=\"" . $this->jsFolderUrl . "autocomplete/jquery.autocomplete.css\" />\n";
366
-        if (!$jqueryAlreadyLoaded) {
367
-            $return .= "<script type=\"text/javascript\" src=\"" . $this->jsFolderUrl . "jquery/jquery.js\"></script>\n";
368
-        }
369
-        $return .= "<script type=\"text/javascript\" src=\"" . $this->jsFolderUrl . "noconflict.js\"></script>\n";
370
-        $return .= "<script type=\"text/javascript\" src=\"" . $this->jsFolderUrl . "autocomplete/jquery.autocomplete.min.js\"></script>\n";
371
-        $return .= "<script type=\"text/javascript\">\n";
372
-        $return .= "jQuery(function($) {\n";
373
-        $return .= "var url='" . $this->baseUrl . "';\n";    // TODO: Supprimer "var" car cela limite sa portée !
374
-        $return .= "var handlerName='" . $this->handler->className . "';\n";
375
-
376
-        foreach ($this->vars as $fieldName => $parameters) {
377
-            if ($parameters['autoComplete'] == true) {
378
-                $field = self::PREFIX . $fieldName;
379
-                $return .= "$('#" . $field . "').autocomplete(url, {\n";
380
-                $return .= "extraParams: {\n";
381
-                $return .= "    field: '" . $fieldName . "',\n";
382
-                $return .= "    op: 'autocomplete',\n";
383
-                $return .= "    handler: handlerName\n";
384
-                $return .= "}\n";
385
-                $return .= "});\n";
386
-            }
387
-        }
388
-        $return .= "});\n";
389
-        $return .= "</script>\n";
390
-
391
-        return $return;
392
-    }
393
-
394
-    /**
395
-     * Initialisation des données du filtre
396
-     * Permet d'indiquer quelles sont les zones sur lesquelles on effectue des filtres ainsi que leur type
397
-     *
398
-     * @param  string $fieldName  Le nom du champs dans la table
399
-     * @param  array  $parameters Les paramètres de la zone sous la forme d'un tableau :
400
-     *                            [dataType]        Entier représentant le type de donnée (numérique ou chaine)
401
-     *                            [fieldType]       Le type de zone de saisie (zone de texte, liste déroulante, liste déroulante Oui/Non)
402
-     *                            [values]      La ou les valeurs de la zone de saisie (utilisé dans le cas d'un select)
403
-     *                            [size]            Largeur d'affichage pour les textbox
404
-     *                            [maxLength]       Largeur maximale pour les textbox
405
-     *                            [withNull]        Dans le cas des listes déroulantes, indique s'il faut une valeur nulle
406
-     *                            [minusOne]        Indique s'il faut retrancher 1 à la valeur saisie récupérée (cas classique des listes Oui/Non avec une valeur nulle)
407
-     *                            [style]            Dans le cas des liste déroulante, le style à appliquer à la liste
408
-     *                            [data]            A ne pas renseigner, contient la valeur saisie par l'utilisateur
409
-     *                            [operator]        Opérateur de comparaison pour le Criteria
410
-     *                            [autoComplete]  Indique si on active l'auto complétion sur le champs
411
-     * @return object L'objet courant pour pouvoir chainer
412
-     */
413
-    public function initFilter($fieldName, $parameters)
414
-    {
415
-        // Tableau des valeurs attendues avec leur valeur par défaut
416
-        $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);
417
-        $data       = array();
418
-        foreach ($indexNames as $indexName => $defaultValue) {
419
-            $data[$indexName] = $this->getArrayValue($parameters, $indexName, $defaultValue);
420
-        }
421
-        $this->vars[$fieldName] = $data;
422
-
423
-        return $this;
424
-    }
425
-
426
-    /**
427
-     * Retourne le nom du tableau à utiliser pour la session
428
-     * @note : Le nom de la session est composé de : nom du module_nom du handler, par exemple references_references_articles
429
-     *
430
-     * @return string
431
-     */
432
-    private function getSessionName()
433
-    {
434
-        return self::MODULE_NAME . '_' . $this->handler->table;
435
-    }
436
-
437
-    /**
438
-     * Retourne le nom de la clé à utiliser pour la conservation du start en session
439
-     *
440
-     * @return string
441
-     */
442
-    private function getStartSessionName()
443
-    {
444
-        return $this->getSessionName() . '_start';
445
-    }
446
-
447
-    /**
448
-     * Réinitialisation des données avant traitement
449
-     *
450
-     * @return void
451
-     */
452
-    private function reinitializeFieldsValue()
453
-    {
454
-        foreach ($this->vars as $fieldName => $fieldProperties) {
455
-            if ($fieldProperties['dataType'] == self::FILTER_DATA_NUMERIC) {    // Zone numérique
456
-                $fieldProperties['data'] = 0;
457
-            } else {
458
-                $fieldProperties['data'] = '';
459
-            }
460
-            $this->vars[$fieldName] = $fieldProperties;
461
-        }
462
-    }
463
-
464
-    /**
465
-     * Ajoute les critères par défaut au critère général
466
-     *
467
-     * @return void
468
-     */
469
-    private function addDefaultCriterias()
470
-    {
471
-        if (is_array($this->defaultCriterias) && count($this->defaultCriterias) > 0) {
472
-            foreach ($this->defaultCriterias as $criteria) {
473
-                $this->criteria->add($criteria);
474
-            }
475
-        }
476
-
477
-        return $this;
478
-    }
479
-
480
-    /**
481
-     * Indique s'il y a des champs de tri
482
-     *
483
-     * @return boolean
484
-     */
485
-    private function areThereSortFields()
486
-    {
487
-        $return = false;
488
-        if (is_array($this->sortFields) && count($this->sortFields) > 0) {
489
-            $return = true;
490
-        }
491
-
492
-        return $return;
493
-    }
494
-
495
-    /**
496
-     * Indique si le nom du champ passé en paramètre fait partie de la liste des champs "triables"
497
-     *
498
-     * @param  string $fieldName
499
-     * @return boolean
500
-     */
501
-    private function isInSortFieldsList($fieldName)
502
-    {
503
-        return array_key_exists($fieldName, $this->sortFields);
504
-    }
505
-
506
-    /**
507
-     * Indique si le sens de tri passé en paramètre fait partie de la liste autorisée
508
-     *
509
-     * @param  string $order
510
-     * @return boolean
511
-     */
512
-    private function isInSortOrderList($order)
513
-    {
514
-        return in_array($order, array('asc', 'desc'));
515
-    }
516
-
517
-    /**
518
-     * 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
519
-     * pour que lorsque l'utilisateur se reconnecte, il retrouve ses informations de tri
520
-     *
521
-     * @return void
522
-     */
523
-    private function setSortFieldsFromRequest()
524
-    {
525
-        if (!$this->areThereSortFields()) {    // S'il n'y a pas de champs triables, on laisse tomber
526
-
527
-            return;
528
-        }
529
-        $sortField        = $sortOrder = '';
530
-        $cookieName       = $this->getSessionName();
531
-        $orderFieldsNames = $this->getSortPlaceHolderNames();
532
-        if (isset($_REQUEST[$orderFieldsNames[0]]) && isset($_REQUEST[$orderFieldsNames[1]])) {
533
-            $sortField = $_REQUEST[$orderFieldsNames[0]];
534
-            $sortOrder = $_REQUEST[$orderFieldsNames[1]];
535
-        } else {
536
-            if (isset($_SESSION[$cookieName . '_sortField'])) {
537
-                $sortField = $_SESSION[$cookieName . '_sortField'];
538
-            }
539
-            if (isset($_SESSION[$cookieName . '_sortOrder'])) {
540
-                $sortOrder = $_SESSION[$cookieName . '_sortOrder'];
541
-            }
542
-        }
543
-
544
-        if ($this->isInSortFieldsList($sortField) && $this->isInSortOrderList($sortOrder)) {
545
-            $this->sortField = $sortField;
546
-            $this->sortOrder = $sortOrder;
547
-        }
548
-        if (trim($sortField) != '' && trim($sortOrder) != '') {
549
-            $_SESSION[$cookieName . '_sortField'] = $sortField;
550
-            $_SESSION[$cookieName . '_sortOrder'] = $sortOrder;
551
-        }
552
-    }
553
-
554
-    /**
555
-     * Réinitialisation des données avant traitement
556
-     *
557
-     * @return void
558
-     */
559
-    private function setupFilter()
560
-    {
561
-        $this->reinitializeFieldsValue();
562
-        $this->newFilter     = false;
563
-        $this->isInitialized = true;
564
-        $this->criteria      = new CriteriaCompo();
565
-        $this->criteria->add(new Criteria($this->handler->keyName, 0, '<>'));
566
-        $this->addDefaultCriterias();
567
-    }
568
-
569
-    /**
570
-     * RAZ des données du filtre si cela a été demandé dans la requête
571
-     *
572
-     * @return void
573
-     */
574
-    private function isSetCleanFilter()
575
-    {
576
-        if (isset($_REQUEST['cleanFilter'])) {
577
-            $this->setStartInSession(0);
578
-            unset($_SESSION[$this->getSessionName()]);
579
-        }
580
-    }
581
-
582
-    /**
583
-     * Retourne le critère de filtrage courant
584
-     *
585
-     * @return object
586
-     */
587
-    public function getCriteria()
588
-    {
589
-        return $this->criteria;
590
-    }
591
-
592
-    /**
593
-     * Méthode à appeler juste après le constructeur pour qu'elle récupère les données saisies
594
-     *
595
-     * @return object L'objet courant pour pouvoir chainer
596
-     */
597
-    public function filter()
598
-    {
599
-        $this->setupFilter();                // Réinitialisations
600
-        $ts = MyTextSanitizer::getInstance();
601
-        $this->setSortFieldsFromRequest();    // On récupère la zone de tri éventuellement passée dans la requête
602
-        $this->isSetCleanFilter();
603
-
604
-        foreach ($this->vars as $fieldName => $fieldProperties) {
605
-            // On commence par récupérer toutes les valeurs
606
-            $formFieldName           = self::PREFIX . $fieldName;    // "filter_website_id" par exemple
607
-            $fieldProperties['data'] = null;    // Valeur par défaut
608
-            if (isset($_REQUEST[$formFieldName])) {
609
-                if ($fieldProperties['dataType'] == self::FILTER_DATA_NUMERIC) {    // Zone numérique
610
-                    if ((int)$_REQUEST[$formFieldName] != 0) {
611
-                        $fieldProperties['data'] = (int)$_REQUEST[$formFieldName];
612
-                        if (!$fieldProperties['minusOne']) {
613
-                            $this->criteria->add(new Criteria($fieldName, $fieldProperties['data'], $fieldProperties['operator']));
614
-                        } else {
615
-                            $this->criteria->add(new Criteria($fieldName, $fieldProperties['data'] - 1, $fieldProperties['operator']));
616
-                        }
617
-                        $this->newFilter = true;
618
-                    }
619
-                } else {    // Zone texte
620
-                    if (trim($_REQUEST[$formFieldName]) != '') {
621
-                        $fieldProperties['data'] = $_REQUEST[$formFieldName];
622
-                        if (!REFERENCES_EXACT_SEARCH) {
623
-                            $this->criteria->add(new Criteria($fieldName, '%' . $ts->addSlashes($fieldProperties['data']) . '%', 'LIKE'));
624
-                        } else {
625
-                            $this->criteria->add(new Criteria($fieldName, $ts->addSlashes($fieldProperties['data']) . '%', 'LIKE'));
626
-                        }
627
-                        $this->newFilter = true;
628
-                    }
629
-                }
630
-            }
631
-            $this->vars[$fieldName] = $fieldProperties;
632
-        }
633
-
634
-        if ($this->newFilter) {
635
-            $this->setStartInSession(0);
636
-        }
637
-
638
-        // Récupération des donées de la session s'il n'y a pas eu de filtre(s)
639
-        if (!$this->newFilter && isset($_SESSION[$this->getSessionName()])) {
640
-            $sessionFilterData = unserialize($_SESSION[$this->getSessionName()]);
641
-            if (isset($sessionFilterData['criteria']) && is_object($sessionFilterData['criteria'])) {
642
-                $this->criteria = $sessionFilterData['criteria'];
643
-                unset($sessionFilterData['criteria']);
644
-            }
645
-            foreach ($this->vars as $fieldName => $fieldProperties) {
646
-                if (isset($sessionFilterData[$fieldName])) {
647
-                    $fieldProperties['data'] = $sessionFilterData[$fieldName];
648
-                }
649
-                $this->vars[$fieldName] = $fieldProperties;
650
-            }
651
-            unset($_SESSION[$this->getSessionName()]);
652
-        }
653
-
654
-        // Mise en place des données dans la session
655
-        $dataForSession             = array();
656
-        $dataForSession['criteria'] = $this->criteria;
657
-        foreach ($this->vars as $fieldName => $fieldProperties) {
658
-            $dataForSession[$fieldName] = $fieldProperties['data'];
659
-        }
660
-        $_SESSION[$this->getSessionName()] = serialize($dataForSession);
661
-
662
-        return $this;
663
-    }
664
-
665
-    /**
666
-     * Retourne le nombre d'enregistrement en fonction des critères courants
667
-     *
668
-     * @return integer
669
-     */
670
-    public function getCount()
671
-    {
672
-        if (!$this->isInitialized) {
673
-            $this->filter();
674
-        }
675
-
676
-        return $this->handler->getCount($this->criteria);
677
-    }
678
-
679
-    /**
680
-     * Conserve la valeur de start en session
681
-     *
682
-     * @param  integer $start
683
-     * @return void
684
-     */
685
-    private function setStartInSession($start)
686
-    {
687
-        if ($this->keepStart) {
688
-            $startSessionName            = $this->getStartSessionName();
689
-            $_SESSION[$startSessionName] = (int)$start;
690
-        }
691
-    }
692
-
693
-    /**
694
-     * Retourne la valeur de ?start=x
695
-     *
696
-     * @return integer
697
-     */
698
-    private function getStartValue()
699
-    {
700
-        $start = 0;
701
-        if (isset($_REQUEST[$this->startName])) {
702
-            $start = (int)$_REQUEST[$this->startName];
703
-        } elseif ($this->keepStart) {
704
-            $startSessionName = $this->getStartSessionName();
705
-            if (isset($_SESSION[$startSessionName])) {
706
-                $start = (int)$_SESSION[$startSessionName];
707
-            }
708
-        }
709
-        // Mise en session
710
-        $this->setStartInSession($start);
711
-
712
-        return $start;
713
-    }
714
-
715
-    /**
716
-     * Permet d'ajouter un paramètre supplémentaire au pager
717
-     *
718
-     * @param  string $key
719
-     * @param  string $value
720
-     * @return object
721
-     */
722
-    public function addAdditionnalParameterToPager($key, $value = '')
723
-    {
724
-        $this->additionnalPagerParameters[$key] = $value;
725
-
726
-        return $this;
727
-    }
728
-
729
-    /**
730
-     * Permet d'ajouter un paramètre supplémentaire au bouton permettant de supprimer le filtre
731
-     *
732
-     * @param  string $key
733
-     * @param  string $value
734
-     * @return object
735
-     */
736
-    public function addAdditionnalParameterToClearButton($key, $value = '')
737
-    {
738
-        $this->additionnalClearButtonParameters[$key] = $value;
739
-
740
-        return $this;
741
-    }
742
-
743
-    /**
744
-     * Permet d'ajouter des paramètres supplémentaires au pager
745
-     *
746
-     * @param $array
747
-     * @return object
748
-     * @internal param string $key
749
-     * @internal param string $value
750
-     */
751
-    public function addAditionnalArrayParametersToPager($array)
752
-    {
753
-        if (count($array) > 0) {
754
-            foreach ($array as $key => $value) {
755
-                $this->addAdditionnalParameterToPager($key, $value);
756
-            }
757
-        }
758
-
759
-        return $this;
760
-    }
761
-
762
-    /**
763
-     * Retourne le pager à utiliser
764
-     *
765
-     * @return mixed Null s'il n'y a pas lieu d'y avoir un pager, sinon un objet de type {@link XoopsPageNav}
766
-     */
767
-    public function getPager()
768
-    {
769
-        if (!$this->isInitialized) {
770
-            $this->filter();
771
-        }
772
-        require_once XOOPS_ROOT_PATH . '/class/pagenav.php';
773
-        $itemsCount  = $this->getCount();
774
-        $queryString = array();
775
-        if (trim($this->op) != '') {
776
-            $queryString[$this->operationName] = $this->op;
777
-        }
778
-        $pagenav = null;
779
-
780
-        if ($itemsCount > $this->limit) {
781
-            foreach ($this->vars as $fieldName => $fieldProperties) {
782
-                $formFieldName               = self::PREFIX . $fieldName;    // "filter_website_id" par exemple
783
-                $queryString[$formFieldName] = $fieldProperties['data'];
784
-            }
785
-            // Ajout des paramètres supplémentaires éventuels
786
-            if (count($this->additionnalPagerParameters) > 0) {
787
-                foreach ($this->additionnalPagerParameters as $key => $value) {
788
-                    $queryString[$key] = $value;
789
-                }
790
-            }
791
-            $start   = $this->getStartValue();
792
-            $pagenav = new XoopsPageNav($itemsCount, $this->limit, $start, $this->startName, http_build_query($queryString));
793
-        }
794
-
795
-        return $pagenav;
796
-    }
797
-
798
-    /**
799
-     * Retourne une liste d'objets en fonction des critères définis
800
-     *
801
-     * @return array
802
-     */
803
-    public function getObjects()
804
-    {
805
-        if (!$this->isInitialized) {
806
-            $this->filter();
807
-        }
808
-        $start    = $this->getStartValue();
809
-        $limit    = $this->limit;
810
-        $criteria = $this->criteria;
811
-        $criteria->setStart($start);
812
-        $criteria->setLimit($limit);
813
-
814
-        $criteria->setOrder($this->sortOrder);
815
-        if (trim($this->sortField) != '') {
816
-            $criteria->setSort($this->sortField);
817
-        } elseif (trim($this->handler->identifierName) != '') {
818
-            $criteria->setSort($this->handler->identifierName);
819
-        }
820
-
821
-        return $this->handler->getObjects($this->criteria);
822
-    }
823
-
824
-    /**
825
-     * Retourne la zone html à utiliser pour créer la zone de filtre (avec sa valeur saisie si c'est le cas)
826
-     *
827
-     * @param  string $fieldName La zone de saisie dont on veut récupérer le code html
828
-     * @return string
829
-     */
830
-    public function getFilterField($fieldName)
831
-    {
832
-        $html = '';
833
-        if (!$this->isInitialized) {
834
-            $this->filter();
835
-        }
836
-        if (!isset($this->vars[$fieldName])) {
837
-            trigger_error('Error, unknow field');
838
-
839
-            return $html;
840
-        }
841
-        $fieldData     = $this->vars[$fieldName];
842
-        $htmlFieldName = self::PREFIX . $fieldName;
843
-
844
-        switch ($fieldData['fieldType']) {
845
-            case self::FILTER_FIELD_TEXT:    // Zone de texte
846
-                $ts   = MyTextSanitizer::getInstance();
847
-                $html = "<input type='text' name='$htmlFieldName' id='$htmlFieldName' size='" . $fieldData['size'] . "' maxlength='" . $fieldData['maxLength'] . "' value='" . $ts->htmlSpecialChars($fieldData['data']) . "' />";
848
-                break;
849
-
850
-            case self::FILTER_FIELD_SELECT;     // Select
851
-                $style = '';
852
-                if (isset($fieldData['style']) && trim($fieldData['style']) != '') {
853
-                    $style = $fieldData['style'];
854
-                }
855
-                $html = references_utils::htmlSelect($htmlFieldName, $fieldData['values'], $fieldData['data'], $fieldData['withNull'], $style);
856
-                break;
857
-
858
-            case self::FILTER_FIELD_SELECT_YES_NO:    // Select de type Oui/Non
859
-                $html = references_utils::htmlSelect($htmlFieldName, array(2 => _YES, 1 => NO), $fieldData['data'], $fieldData['withNull']);
860
-                break;
861
-        }
862
-
863
-        return $html;
864
-    }
865
-
866
-    /**
867
-     * Assigne toutes les zones de filtre à un template
868
-     *
869
-     * @param  object  $xoopsTpl
870
-     * @param  boolean $asArray   Est-ce qu'il faut placer le résultat dans un tableau ou assigner par nom de zone de filtre
871
-     * @param string   $arrayName Le nom du tableau à utiliser
872
-     * @return void
873
-     */
874
-    public function assignFilterFieldsToTemplate(&$xoopsTpl, $asArray = true, $arrayName = 'filterFields')
875
-    {
876
-        $fields = array_keys($this->vars);
877
-        foreach ($fields as $field) {
878
-            if (!$asArray) {
879
-                $xoopsTpl->assign($field, $this->getFilterField($field));
880
-            } else {
881
-                $xoopsTpl->append($arrayName, $this->getFilterField($field));
882
-            }
883
-        }
884
-    }
885
-
886
-    /**
887
-     * Retourne le bouton utilisé pour supprimer le filtre en cours
888
-     *
889
-     * @return string
890
-     */
891
-    public function getClearFilterbutton()
892
-    {
893
-        $queryString                       = array();
894
-        $queryString[$this->operationName] = $this->op;
895
-        if (count($this->additionnalClearButtonParameters) > 0) {
896
-            foreach ($this->additionnalClearButtonParameters as $key => $value) {
897
-                $queryString[$key] = $value;
898
-            }
899
-        }
900
-        $queryString['cleanFilter'] = '1';
901
-        $baseurl                    = $this->baseUrl;
902
-
903
-        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>";
904
-    }
905
-
906
-    /**
907
-     * Retourne le bouton permettant de lancer le filtrage
908
-     *
909
-     * @param string $description  Texte à faire apparaître sur le bouton
910
-     * @param array  $additionnals Champs supplémentaires à faire apparaître avec le bouton
911
-     * @return string
912
-     */
913
-    public function getGoButton($description = _GO, $additionnals = null)
914
-    {
915
-        $html = '';
916
-        if (trim($this->operationName) != '' && trim($this->op) != '') {
917
-            $html .= "<input type='hidden' name='" . $this->operationName . "' id='" . $this->operationName . "' value='" . $this->op . "' />";
918
-        }
919
-        if (!is_null($additionnals)) {
920
-            foreach ($additionnals as $key => $value) {
921
-                $html .= "<input type='hidden' name='" . $key . "' id='" . $key . "' value='" . $value . "' />";
922
-            }
923
-        }
924
-        $html .= "<input type='submit' name='btngo' id='btngo' value='$description' />";
925
-
926
-        return $html;
927
-    }
928
-
929
-    /**
930
-     * Retourne le nom de la zone utilisée pour trier les données
931
-     *
932
-     * @return string
933
-     */
934
-    public function getSortField()
935
-    {
936
-        return $this->sortField;
937
-    }
938
-
939
-    /**
940
-     * Retourne le sens de tri utilisé pour trier les données
941
-     *
942
-     * @return string
943
-     */
944
-    public function getSortOrder()
945
-    {
946
-        return $this->sortOrder();
947
-    }
948
-
949
-    /**
950
-     * Retourne la valeur d'un champ
951
-     *
952
-     * @param  string $fieldName
953
-     * @return mixed  La valeur du champ ou null si on ne trouve pas la zone
954
-     */
955
-    public function getFieldValue($fieldName)
956
-    {
957
-        $ret = null;
958
-        if (isset($this->vars[$fieldName])) {
959
-            $ret = $this->vars[$fieldName]['data'];
960
-        }
961
-
962
-        return $ret;
963
-    }
38
+	const FILTER_DATA_TEXT    = 1;
39
+	const FILTER_DATA_NUMERIC = 2;
40
+
41
+	const FILTER_FIELD_TEXT          = 1;
42
+	const FILTER_FIELD_SELECT        = 2;
43
+	const FILTER_FIELD_SELECT_YES_NO = 3;
44
+
45
+	/**
46
+	 * Préfixe des variables de sélection
47
+	 */
48
+	const PREFIX = 'filter_';
49
+
50
+	/**
51
+	 * Nom du module (utilisé pour la session)
52
+	 */
53
+	const MODULE_NAME = 'references';
54
+
55
+	/**
56
+	 * Contient toutes les variables participant au filtre (avec leur type et description)
57
+	 *
58
+	 * @var array
59
+	 */
60
+	private $vars = array();
61
+
62
+	/**
63
+	 * Handler des données
64
+	 *
65
+	 * @var reference
66
+	 */
67
+	private $handler = null;
68
+
69
+	/**
70
+	 * Nom de la zone d'opération (par exemple op=products)
71
+	 *
72
+	 * @var string
73
+	 */
74
+	private $op = '';
75
+
76
+	/**
77
+	 * action de l'opération en cour (par exemple op=products)
78
+	 *
79
+	 * @var string
80
+	 */
81
+	private $operationName = '';
82
+
83
+	/**
84
+	 * Nombre maximum d'éléments pas page
85
+	 *
86
+	 * @var intger
87
+	 */
88
+	private $limit = 10;
89
+
90
+	/**
91
+	 * Nom de la variable start
92
+	 *
93
+	 * @var string
94
+	 */
95
+	private $startName = '';
96
+
97
+	/**
98
+	 * Critère {@link Criteria} servant à choisir les données
99
+	 *
100
+	 * @var object
101
+	 */
102
+	private $criteria = null;
103
+
104
+	/**
105
+	 * Indique s'il y a un nouveau critère
106
+	 *
107
+	 * @var boolean
108
+	 */
109
+	private $newFilter = false;
110
+
111
+	/**
112
+	 * Indique si la méthode filter() a été appelée
113
+	 *
114
+	 * @var boolean
115
+	 */
116
+	private $isInitialized = false;
117
+
118
+	/**
119
+	 * Zone de tri pour retourner les données (dans getObjects)
120
+	 *
121
+	 * @var string
122
+	 */
123
+	private $sortField = '';
124
+
125
+	/**
126
+	 * Sens de tri
127
+	 *
128
+	 * @var string
129
+	 */
130
+	private $sortOrder = '';
131
+
132
+	/**
133
+	 * Liste de critères par défaut
134
+	 *
135
+	 * @var array
136
+	 */
137
+	private $defaultCriterias = array();
138
+
139
+	/**
140
+	 * L'url complète du script qui appelle
141
+	 *
142
+	 * @var string
143
+	 */
144
+	private $baseUrl = '';
145
+
146
+	/**
147
+	 * Indique si on conserve en session la position de départ
148
+	 *
149
+	 * @var boolean
150
+	 */
151
+	private $keepStart = true;
152
+
153
+	/**
154
+	 * Indique si l'autocomplétion est activée
155
+	 *
156
+	 * @var boolean
157
+	 */
158
+	private $hasAutoComplete = false;
159
+
160
+	/**
161
+	 * Url du dossier js dans le module
162
+	 *
163
+	 * @var string
164
+	 */
165
+	private $jsFolderUrl = '';
166
+
167
+	/**
168
+	 * Paramètres additionnels à ajouter aux paramètres du pager
169
+	 * @var array
170
+	 */
171
+	private $additionnalPagerParameters = array();
172
+
173
+	/**
174
+	 * Paramètres additionnels à ajouter au bouton permettant de supprimer le filtre en cours
175
+	 * @var array
176
+	 */
177
+	private $additionnalClearButtonParameters = array();
178
+
179
+	/**
180
+	 * Tableau des champs triables [clé] = nom du champ dans la base, valeur = libellé
181
+	 * @var array
182
+	 */
183
+	private $sortFields = array();
184
+
185
+	/**
186
+	 * Initialise les paramètres avec des valeurs par défaut
187
+	 */
188
+	private function setDefaultValues()
189
+	{
190
+		$this->handler                          = null;
191
+		$this->op                               = '';
192
+		$this->limit                            = 10;
193
+		$this->startName                        = 'start';
194
+		$this->operationName                    = 'op';
195
+		$this->sortField                        = '';
196
+		$this->sortOrder                        = 'asc';
197
+		$this->baseUrl                          = '';
198
+		$this->keepStart                        = true;
199
+		$this->hasAutoComplete                  = false;
200
+		$this->jsFolderUrl                      = '';
201
+		$this->additionnalPagerParameters       = array();
202
+		$this->additionnalClearButtonParameters = array();
203
+		$this->sortFields                       = array();    // Les champs qui peuvent être utilisés pour trier
204
+	}
205
+
206
+	/**
207
+	 * Initialisation des données, handler et opération courante dans l'appelant
208
+	 *
209
+	 * @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)
210
+	 * @param string  $operationName
211
+	 * @param string  $operation Opération courante dans l'appelant
212
+	 * @param string  $startName Nom du paramètre start
213
+	 * @param integer $limit     Nombre maximum d'éléments par page
214
+	 * @param string  $baseUrl   L'url complète du script appelant
215
+	 * @param string  $sortField Zone de tri
216
+	 * @param string  $sortOrder Sens de tri
217
+	 * @param boolean $keepStart Indique si on conserve la position de départ
218
+	 * @param string  $jsFolderUrl
219
+	 * @package string $jsFolderUrl Url du répertoire qui contient les scripts Javascript
220
+	 */
221
+	public function __construct($handler, $operationName = 'op', $operation = '', $startName = 'start', $limit = 10, $baseUrl = '', $sortField = '', $sortOrder = 'asc', $keepStart = true, $jsFolderUrl = '')
222
+	{
223
+		$this->setDefaultValues();
224
+		if (!is_array($handler)) {
225
+			$this->handler       = $handler;
226
+			$this->op            = $operation;
227
+			$this->limit         = $limit;
228
+			$this->startName     = $startName;
229
+			$this->operationName = $operationName;
230
+			$this->sortField     = $sortField;
231
+			$this->sortOrder     = $sortOrder;
232
+			$this->baseUrl       = $baseUrl;
233
+			$this->keepStart     = $keepStart;
234
+			$this->jsFolderUrl   = $jsFolderUrl;
235
+		} else {
236
+			foreach ($handler as $key => $value) {
237
+				$this->$key = $value;
238
+			}
239
+		}
240
+	}
241
+
242
+	/**
243
+	 * Donne à la classe le nom des champs sur lesquels on peut faire le tri
244
+	 *
245
+	 * @param  array $fields [clé] = nom du champ dans la base, valeur = libellé
246
+	 * @return object
247
+	 */
248
+	public function setSortFields($fields)
249
+	{
250
+		$this->sortFields = $fields;
251
+	}
252
+
253
+	/**
254
+	 * Retourne les noms à utiliser pour les champs de tri (sélecteur de champ et ordre de tri)
255
+	 *
256
+	 * @return array [0] = Nom du sélecteur de champs, [1] = Nom du sélecteur pour le sens du tri
257
+	 */
258
+	private function getSortPlaceHolderNames()
259
+	{
260
+		return array(self::PREFIX . 'sortFields', self::PREFIX . 'sortOrder');
261
+	}
262
+
263
+	/**
264
+	 * Retourne 2 sélecteurs html pour choisir la zone de tri et le sens du tri
265
+	 *
266
+	 * @return string
267
+	 */
268
+	public function getSortPlaceHolderHtmlCode()
269
+	{
270
+		$sortNames      = $this->getSortPlaceHolderNames();
271
+		$sortFieldsHtml = references_utils::htmlSelect($sortNames[0], $this->sortFields, $this->sortField, false);
272
+		$sortOrderHtml  = references_utils::htmlSelect($sortNames[1], array('asc' => _MD_REFERENCES_ASC, 'desc' => _MD_REFERENCES_DESC), $this->sortOrder, false);
273
+
274
+		return _MD_REFERENCES_SORT_BY . ' ' . $sortFieldsHtml . ' ' . $sortOrderHtml;
275
+	}
276
+
277
+	/**
278
+	 * Permet de valoriser une option directement tout en chainant
279
+	 *
280
+	 * @param  string $optionName
281
+	 * @param  mixed  $optionValue
282
+	 * @return object
283
+	 */
284
+	public function setOption($optionName, $optionValue)
285
+	{
286
+		$this->$optionName = $optionValue;
287
+
288
+		return $this;
289
+	}
290
+
291
+	/**
292
+	 * Ajoute un nouveau critère par défaut à la liste des critères par défaut
293
+	 *
294
+	 * @param Criteria $criteria
295
+	 */
296
+	public function addDefaultCriteria(Criteria $criteria)
297
+	{
298
+		$this->defaultCriterias[] = $criteria;
299
+	}
300
+
301
+	/**
302
+	 * Retourne une valeur d'un tableau ou null si l'index n'existe pas
303
+	 *
304
+	 * @param array   $array        Le tableau à traiter
305
+	 * @param  string $index        L'index recherché
306
+	 * @param  mixed  $defaultValue La valeur par défaut
307
+	 * @return mixed
308
+	 */
309
+	private function getArrayValue($array, $index, $defaultValue = false)
310
+	{
311
+		if ($index === 'autoComplete' && isset($array[$index]) && isset($array[$index]) == true) {
312
+			$this->hasAutoComplete = true;    // On en profite pour vérifier si un champ utilise l'autocomplétion
313
+		}
314
+
315
+		return isset($array[$index]) ? $array[$index] : $defaultValue;
316
+	}
317
+
318
+	/**
319
+	 * Permet de faire l'autocomplétion d'un champ
320
+	 *
321
+	 * @param  string $query
322
+	 * @param         $limit
323
+	 * @param  string $fieldName
324
+	 * @return string
325
+	 */
326
+	public function autoComplete($query, $limit, $fieldName)
327
+	{
328
+		$return = '';
329
+		if (!$this->hasAutoComplete) {    // Si aucun champ n'est en autocomplétion, c'est pas la peine d'aller plus loin
330
+
331
+			return $return;
332
+		}
333
+		if (isset($this->vars[$fieldName])) {    // On vérifie que le champ demandé est bien en autocomplétion
334
+			if ($this->vars[$fieldName]['autoComplete'] == true) {
335
+				if ($this->vars[$fieldName]['dataType'] == self::FILTER_DATA_TEXT) {
336
+					$criteria = new Criteria($fieldName, $query . '%', 'LIKE');
337
+				}
338
+				$criteria->setLimit((int)$limit);
339
+				$ret = $this->handler->getObjects($criteria);
340
+
341
+				if (count($ret) > 0) {
342
+					foreach ($ret as $object) {
343
+						$return .= $object->getVar($fieldName, 'n') . "\n";
344
+					}
345
+				}
346
+			}
347
+		}
348
+
349
+		return $return;
350
+	}
351
+
352
+	/**
353
+	 * Retourne le code Javascript à utiliser pour initialiser l'auto complétion (et donc à coller dans le code html)
354
+	 *
355
+	 * @param boolean $jqueryAlreadyLoaded Indique si jQuery est déjà chargé par l'appelant, auquel cas rien ne sert de le recharger
356
+	 * @return string
357
+	 */
358
+	public function getJavascriptInitCode($jqueryAlreadyLoaded = false)
359
+	{
360
+		$return = '';
361
+		if (!$this->hasAutoComplete) {
362
+			return $return;
363
+		}
364
+		$return = '';
365
+		$return .= "<link rel=\"stylesheet\" type=\"text/css\" media=\"all\" title=\"Style sheet\" href=\"" . $this->jsFolderUrl . "autocomplete/jquery.autocomplete.css\" />\n";
366
+		if (!$jqueryAlreadyLoaded) {
367
+			$return .= "<script type=\"text/javascript\" src=\"" . $this->jsFolderUrl . "jquery/jquery.js\"></script>\n";
368
+		}
369
+		$return .= "<script type=\"text/javascript\" src=\"" . $this->jsFolderUrl . "noconflict.js\"></script>\n";
370
+		$return .= "<script type=\"text/javascript\" src=\"" . $this->jsFolderUrl . "autocomplete/jquery.autocomplete.min.js\"></script>\n";
371
+		$return .= "<script type=\"text/javascript\">\n";
372
+		$return .= "jQuery(function($) {\n";
373
+		$return .= "var url='" . $this->baseUrl . "';\n";    // TODO: Supprimer "var" car cela limite sa portée !
374
+		$return .= "var handlerName='" . $this->handler->className . "';\n";
375
+
376
+		foreach ($this->vars as $fieldName => $parameters) {
377
+			if ($parameters['autoComplete'] == true) {
378
+				$field = self::PREFIX . $fieldName;
379
+				$return .= "$('#" . $field . "').autocomplete(url, {\n";
380
+				$return .= "extraParams: {\n";
381
+				$return .= "    field: '" . $fieldName . "',\n";
382
+				$return .= "    op: 'autocomplete',\n";
383
+				$return .= "    handler: handlerName\n";
384
+				$return .= "}\n";
385
+				$return .= "});\n";
386
+			}
387
+		}
388
+		$return .= "});\n";
389
+		$return .= "</script>\n";
390
+
391
+		return $return;
392
+	}
393
+
394
+	/**
395
+	 * Initialisation des données du filtre
396
+	 * Permet d'indiquer quelles sont les zones sur lesquelles on effectue des filtres ainsi que leur type
397
+	 *
398
+	 * @param  string $fieldName  Le nom du champs dans la table
399
+	 * @param  array  $parameters Les paramètres de la zone sous la forme d'un tableau :
400
+	 *                            [dataType]        Entier représentant le type de donnée (numérique ou chaine)
401
+	 *                            [fieldType]       Le type de zone de saisie (zone de texte, liste déroulante, liste déroulante Oui/Non)
402
+	 *                            [values]      La ou les valeurs de la zone de saisie (utilisé dans le cas d'un select)
403
+	 *                            [size]            Largeur d'affichage pour les textbox
404
+	 *                            [maxLength]       Largeur maximale pour les textbox
405
+	 *                            [withNull]        Dans le cas des listes déroulantes, indique s'il faut une valeur nulle
406
+	 *                            [minusOne]        Indique s'il faut retrancher 1 à la valeur saisie récupérée (cas classique des listes Oui/Non avec une valeur nulle)
407
+	 *                            [style]            Dans le cas des liste déroulante, le style à appliquer à la liste
408
+	 *                            [data]            A ne pas renseigner, contient la valeur saisie par l'utilisateur
409
+	 *                            [operator]        Opérateur de comparaison pour le Criteria
410
+	 *                            [autoComplete]  Indique si on active l'auto complétion sur le champs
411
+	 * @return object L'objet courant pour pouvoir chainer
412
+	 */
413
+	public function initFilter($fieldName, $parameters)
414
+	{
415
+		// Tableau des valeurs attendues avec leur valeur par défaut
416
+		$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);
417
+		$data       = array();
418
+		foreach ($indexNames as $indexName => $defaultValue) {
419
+			$data[$indexName] = $this->getArrayValue($parameters, $indexName, $defaultValue);
420
+		}
421
+		$this->vars[$fieldName] = $data;
422
+
423
+		return $this;
424
+	}
425
+
426
+	/**
427
+	 * Retourne le nom du tableau à utiliser pour la session
428
+	 * @note : Le nom de la session est composé de : nom du module_nom du handler, par exemple references_references_articles
429
+	 *
430
+	 * @return string
431
+	 */
432
+	private function getSessionName()
433
+	{
434
+		return self::MODULE_NAME . '_' . $this->handler->table;
435
+	}
436
+
437
+	/**
438
+	 * Retourne le nom de la clé à utiliser pour la conservation du start en session
439
+	 *
440
+	 * @return string
441
+	 */
442
+	private function getStartSessionName()
443
+	{
444
+		return $this->getSessionName() . '_start';
445
+	}
446
+
447
+	/**
448
+	 * Réinitialisation des données avant traitement
449
+	 *
450
+	 * @return void
451
+	 */
452
+	private function reinitializeFieldsValue()
453
+	{
454
+		foreach ($this->vars as $fieldName => $fieldProperties) {
455
+			if ($fieldProperties['dataType'] == self::FILTER_DATA_NUMERIC) {    // Zone numérique
456
+				$fieldProperties['data'] = 0;
457
+			} else {
458
+				$fieldProperties['data'] = '';
459
+			}
460
+			$this->vars[$fieldName] = $fieldProperties;
461
+		}
462
+	}
463
+
464
+	/**
465
+	 * Ajoute les critères par défaut au critère général
466
+	 *
467
+	 * @return void
468
+	 */
469
+	private function addDefaultCriterias()
470
+	{
471
+		if (is_array($this->defaultCriterias) && count($this->defaultCriterias) > 0) {
472
+			foreach ($this->defaultCriterias as $criteria) {
473
+				$this->criteria->add($criteria);
474
+			}
475
+		}
476
+
477
+		return $this;
478
+	}
479
+
480
+	/**
481
+	 * Indique s'il y a des champs de tri
482
+	 *
483
+	 * @return boolean
484
+	 */
485
+	private function areThereSortFields()
486
+	{
487
+		$return = false;
488
+		if (is_array($this->sortFields) && count($this->sortFields) > 0) {
489
+			$return = true;
490
+		}
491
+
492
+		return $return;
493
+	}
494
+
495
+	/**
496
+	 * Indique si le nom du champ passé en paramètre fait partie de la liste des champs "triables"
497
+	 *
498
+	 * @param  string $fieldName
499
+	 * @return boolean
500
+	 */
501
+	private function isInSortFieldsList($fieldName)
502
+	{
503
+		return array_key_exists($fieldName, $this->sortFields);
504
+	}
505
+
506
+	/**
507
+	 * Indique si le sens de tri passé en paramètre fait partie de la liste autorisée
508
+	 *
509
+	 * @param  string $order
510
+	 * @return boolean
511
+	 */
512
+	private function isInSortOrderList($order)
513
+	{
514
+		return in_array($order, array('asc', 'desc'));
515
+	}
516
+
517
+	/**
518
+	 * 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
519
+	 * pour que lorsque l'utilisateur se reconnecte, il retrouve ses informations de tri
520
+	 *
521
+	 * @return void
522
+	 */
523
+	private function setSortFieldsFromRequest()
524
+	{
525
+		if (!$this->areThereSortFields()) {    // S'il n'y a pas de champs triables, on laisse tomber
526
+
527
+			return;
528
+		}
529
+		$sortField        = $sortOrder = '';
530
+		$cookieName       = $this->getSessionName();
531
+		$orderFieldsNames = $this->getSortPlaceHolderNames();
532
+		if (isset($_REQUEST[$orderFieldsNames[0]]) && isset($_REQUEST[$orderFieldsNames[1]])) {
533
+			$sortField = $_REQUEST[$orderFieldsNames[0]];
534
+			$sortOrder = $_REQUEST[$orderFieldsNames[1]];
535
+		} else {
536
+			if (isset($_SESSION[$cookieName . '_sortField'])) {
537
+				$sortField = $_SESSION[$cookieName . '_sortField'];
538
+			}
539
+			if (isset($_SESSION[$cookieName . '_sortOrder'])) {
540
+				$sortOrder = $_SESSION[$cookieName . '_sortOrder'];
541
+			}
542
+		}
543
+
544
+		if ($this->isInSortFieldsList($sortField) && $this->isInSortOrderList($sortOrder)) {
545
+			$this->sortField = $sortField;
546
+			$this->sortOrder = $sortOrder;
547
+		}
548
+		if (trim($sortField) != '' && trim($sortOrder) != '') {
549
+			$_SESSION[$cookieName . '_sortField'] = $sortField;
550
+			$_SESSION[$cookieName . '_sortOrder'] = $sortOrder;
551
+		}
552
+	}
553
+
554
+	/**
555
+	 * Réinitialisation des données avant traitement
556
+	 *
557
+	 * @return void
558
+	 */
559
+	private function setupFilter()
560
+	{
561
+		$this->reinitializeFieldsValue();
562
+		$this->newFilter     = false;
563
+		$this->isInitialized = true;
564
+		$this->criteria      = new CriteriaCompo();
565
+		$this->criteria->add(new Criteria($this->handler->keyName, 0, '<>'));
566
+		$this->addDefaultCriterias();
567
+	}
568
+
569
+	/**
570
+	 * RAZ des données du filtre si cela a été demandé dans la requête
571
+	 *
572
+	 * @return void
573
+	 */
574
+	private function isSetCleanFilter()
575
+	{
576
+		if (isset($_REQUEST['cleanFilter'])) {
577
+			$this->setStartInSession(0);
578
+			unset($_SESSION[$this->getSessionName()]);
579
+		}
580
+	}
581
+
582
+	/**
583
+	 * Retourne le critère de filtrage courant
584
+	 *
585
+	 * @return object
586
+	 */
587
+	public function getCriteria()
588
+	{
589
+		return $this->criteria;
590
+	}
591
+
592
+	/**
593
+	 * Méthode à appeler juste après le constructeur pour qu'elle récupère les données saisies
594
+	 *
595
+	 * @return object L'objet courant pour pouvoir chainer
596
+	 */
597
+	public function filter()
598
+	{
599
+		$this->setupFilter();                // Réinitialisations
600
+		$ts = MyTextSanitizer::getInstance();
601
+		$this->setSortFieldsFromRequest();    // On récupère la zone de tri éventuellement passée dans la requête
602
+		$this->isSetCleanFilter();
603
+
604
+		foreach ($this->vars as $fieldName => $fieldProperties) {
605
+			// On commence par récupérer toutes les valeurs
606
+			$formFieldName           = self::PREFIX . $fieldName;    // "filter_website_id" par exemple
607
+			$fieldProperties['data'] = null;    // Valeur par défaut
608
+			if (isset($_REQUEST[$formFieldName])) {
609
+				if ($fieldProperties['dataType'] == self::FILTER_DATA_NUMERIC) {    // Zone numérique
610
+					if ((int)$_REQUEST[$formFieldName] != 0) {
611
+						$fieldProperties['data'] = (int)$_REQUEST[$formFieldName];
612
+						if (!$fieldProperties['minusOne']) {
613
+							$this->criteria->add(new Criteria($fieldName, $fieldProperties['data'], $fieldProperties['operator']));
614
+						} else {
615
+							$this->criteria->add(new Criteria($fieldName, $fieldProperties['data'] - 1, $fieldProperties['operator']));
616
+						}
617
+						$this->newFilter = true;
618
+					}
619
+				} else {    // Zone texte
620
+					if (trim($_REQUEST[$formFieldName]) != '') {
621
+						$fieldProperties['data'] = $_REQUEST[$formFieldName];
622
+						if (!REFERENCES_EXACT_SEARCH) {
623
+							$this->criteria->add(new Criteria($fieldName, '%' . $ts->addSlashes($fieldProperties['data']) . '%', 'LIKE'));
624
+						} else {
625
+							$this->criteria->add(new Criteria($fieldName, $ts->addSlashes($fieldProperties['data']) . '%', 'LIKE'));
626
+						}
627
+						$this->newFilter = true;
628
+					}
629
+				}
630
+			}
631
+			$this->vars[$fieldName] = $fieldProperties;
632
+		}
633
+
634
+		if ($this->newFilter) {
635
+			$this->setStartInSession(0);
636
+		}
637
+
638
+		// Récupération des donées de la session s'il n'y a pas eu de filtre(s)
639
+		if (!$this->newFilter && isset($_SESSION[$this->getSessionName()])) {
640
+			$sessionFilterData = unserialize($_SESSION[$this->getSessionName()]);
641
+			if (isset($sessionFilterData['criteria']) && is_object($sessionFilterData['criteria'])) {
642
+				$this->criteria = $sessionFilterData['criteria'];
643
+				unset($sessionFilterData['criteria']);
644
+			}
645
+			foreach ($this->vars as $fieldName => $fieldProperties) {
646
+				if (isset($sessionFilterData[$fieldName])) {
647
+					$fieldProperties['data'] = $sessionFilterData[$fieldName];
648
+				}
649
+				$this->vars[$fieldName] = $fieldProperties;
650
+			}
651
+			unset($_SESSION[$this->getSessionName()]);
652
+		}
653
+
654
+		// Mise en place des données dans la session
655
+		$dataForSession             = array();
656
+		$dataForSession['criteria'] = $this->criteria;
657
+		foreach ($this->vars as $fieldName => $fieldProperties) {
658
+			$dataForSession[$fieldName] = $fieldProperties['data'];
659
+		}
660
+		$_SESSION[$this->getSessionName()] = serialize($dataForSession);
661
+
662
+		return $this;
663
+	}
664
+
665
+	/**
666
+	 * Retourne le nombre d'enregistrement en fonction des critères courants
667
+	 *
668
+	 * @return integer
669
+	 */
670
+	public function getCount()
671
+	{
672
+		if (!$this->isInitialized) {
673
+			$this->filter();
674
+		}
675
+
676
+		return $this->handler->getCount($this->criteria);
677
+	}
678
+
679
+	/**
680
+	 * Conserve la valeur de start en session
681
+	 *
682
+	 * @param  integer $start
683
+	 * @return void
684
+	 */
685
+	private function setStartInSession($start)
686
+	{
687
+		if ($this->keepStart) {
688
+			$startSessionName            = $this->getStartSessionName();
689
+			$_SESSION[$startSessionName] = (int)$start;
690
+		}
691
+	}
692
+
693
+	/**
694
+	 * Retourne la valeur de ?start=x
695
+	 *
696
+	 * @return integer
697
+	 */
698
+	private function getStartValue()
699
+	{
700
+		$start = 0;
701
+		if (isset($_REQUEST[$this->startName])) {
702
+			$start = (int)$_REQUEST[$this->startName];
703
+		} elseif ($this->keepStart) {
704
+			$startSessionName = $this->getStartSessionName();
705
+			if (isset($_SESSION[$startSessionName])) {
706
+				$start = (int)$_SESSION[$startSessionName];
707
+			}
708
+		}
709
+		// Mise en session
710
+		$this->setStartInSession($start);
711
+
712
+		return $start;
713
+	}
714
+
715
+	/**
716
+	 * Permet d'ajouter un paramètre supplémentaire au pager
717
+	 *
718
+	 * @param  string $key
719
+	 * @param  string $value
720
+	 * @return object
721
+	 */
722
+	public function addAdditionnalParameterToPager($key, $value = '')
723
+	{
724
+		$this->additionnalPagerParameters[$key] = $value;
725
+
726
+		return $this;
727
+	}
728
+
729
+	/**
730
+	 * Permet d'ajouter un paramètre supplémentaire au bouton permettant de supprimer le filtre
731
+	 *
732
+	 * @param  string $key
733
+	 * @param  string $value
734
+	 * @return object
735
+	 */
736
+	public function addAdditionnalParameterToClearButton($key, $value = '')
737
+	{
738
+		$this->additionnalClearButtonParameters[$key] = $value;
739
+
740
+		return $this;
741
+	}
742
+
743
+	/**
744
+	 * Permet d'ajouter des paramètres supplémentaires au pager
745
+	 *
746
+	 * @param $array
747
+	 * @return object
748
+	 * @internal param string $key
749
+	 * @internal param string $value
750
+	 */
751
+	public function addAditionnalArrayParametersToPager($array)
752
+	{
753
+		if (count($array) > 0) {
754
+			foreach ($array as $key => $value) {
755
+				$this->addAdditionnalParameterToPager($key, $value);
756
+			}
757
+		}
758
+
759
+		return $this;
760
+	}
761
+
762
+	/**
763
+	 * Retourne le pager à utiliser
764
+	 *
765
+	 * @return mixed Null s'il n'y a pas lieu d'y avoir un pager, sinon un objet de type {@link XoopsPageNav}
766
+	 */
767
+	public function getPager()
768
+	{
769
+		if (!$this->isInitialized) {
770
+			$this->filter();
771
+		}
772
+		require_once XOOPS_ROOT_PATH . '/class/pagenav.php';
773
+		$itemsCount  = $this->getCount();
774
+		$queryString = array();
775
+		if (trim($this->op) != '') {
776
+			$queryString[$this->operationName] = $this->op;
777
+		}
778
+		$pagenav = null;
779
+
780
+		if ($itemsCount > $this->limit) {
781
+			foreach ($this->vars as $fieldName => $fieldProperties) {
782
+				$formFieldName               = self::PREFIX . $fieldName;    // "filter_website_id" par exemple
783
+				$queryString[$formFieldName] = $fieldProperties['data'];
784
+			}
785
+			// Ajout des paramètres supplémentaires éventuels
786
+			if (count($this->additionnalPagerParameters) > 0) {
787
+				foreach ($this->additionnalPagerParameters as $key => $value) {
788
+					$queryString[$key] = $value;
789
+				}
790
+			}
791
+			$start   = $this->getStartValue();
792
+			$pagenav = new XoopsPageNav($itemsCount, $this->limit, $start, $this->startName, http_build_query($queryString));
793
+		}
794
+
795
+		return $pagenav;
796
+	}
797
+
798
+	/**
799
+	 * Retourne une liste d'objets en fonction des critères définis
800
+	 *
801
+	 * @return array
802
+	 */
803
+	public function getObjects()
804
+	{
805
+		if (!$this->isInitialized) {
806
+			$this->filter();
807
+		}
808
+		$start    = $this->getStartValue();
809
+		$limit    = $this->limit;
810
+		$criteria = $this->criteria;
811
+		$criteria->setStart($start);
812
+		$criteria->setLimit($limit);
813
+
814
+		$criteria->setOrder($this->sortOrder);
815
+		if (trim($this->sortField) != '') {
816
+			$criteria->setSort($this->sortField);
817
+		} elseif (trim($this->handler->identifierName) != '') {
818
+			$criteria->setSort($this->handler->identifierName);
819
+		}
820
+
821
+		return $this->handler->getObjects($this->criteria);
822
+	}
823
+
824
+	/**
825
+	 * Retourne la zone html à utiliser pour créer la zone de filtre (avec sa valeur saisie si c'est le cas)
826
+	 *
827
+	 * @param  string $fieldName La zone de saisie dont on veut récupérer le code html
828
+	 * @return string
829
+	 */
830
+	public function getFilterField($fieldName)
831
+	{
832
+		$html = '';
833
+		if (!$this->isInitialized) {
834
+			$this->filter();
835
+		}
836
+		if (!isset($this->vars[$fieldName])) {
837
+			trigger_error('Error, unknow field');
838
+
839
+			return $html;
840
+		}
841
+		$fieldData     = $this->vars[$fieldName];
842
+		$htmlFieldName = self::PREFIX . $fieldName;
843
+
844
+		switch ($fieldData['fieldType']) {
845
+			case self::FILTER_FIELD_TEXT:    // Zone de texte
846
+				$ts   = MyTextSanitizer::getInstance();
847
+				$html = "<input type='text' name='$htmlFieldName' id='$htmlFieldName' size='" . $fieldData['size'] . "' maxlength='" . $fieldData['maxLength'] . "' value='" . $ts->htmlSpecialChars($fieldData['data']) . "' />";
848
+				break;
849
+
850
+			case self::FILTER_FIELD_SELECT;     // Select
851
+				$style = '';
852
+				if (isset($fieldData['style']) && trim($fieldData['style']) != '') {
853
+					$style = $fieldData['style'];
854
+				}
855
+				$html = references_utils::htmlSelect($htmlFieldName, $fieldData['values'], $fieldData['data'], $fieldData['withNull'], $style);
856
+				break;
857
+
858
+			case self::FILTER_FIELD_SELECT_YES_NO:    // Select de type Oui/Non
859
+				$html = references_utils::htmlSelect($htmlFieldName, array(2 => _YES, 1 => NO), $fieldData['data'], $fieldData['withNull']);
860
+				break;
861
+		}
862
+
863
+		return $html;
864
+	}
865
+
866
+	/**
867
+	 * Assigne toutes les zones de filtre à un template
868
+	 *
869
+	 * @param  object  $xoopsTpl
870
+	 * @param  boolean $asArray   Est-ce qu'il faut placer le résultat dans un tableau ou assigner par nom de zone de filtre
871
+	 * @param string   $arrayName Le nom du tableau à utiliser
872
+	 * @return void
873
+	 */
874
+	public function assignFilterFieldsToTemplate(&$xoopsTpl, $asArray = true, $arrayName = 'filterFields')
875
+	{
876
+		$fields = array_keys($this->vars);
877
+		foreach ($fields as $field) {
878
+			if (!$asArray) {
879
+				$xoopsTpl->assign($field, $this->getFilterField($field));
880
+			} else {
881
+				$xoopsTpl->append($arrayName, $this->getFilterField($field));
882
+			}
883
+		}
884
+	}
885
+
886
+	/**
887
+	 * Retourne le bouton utilisé pour supprimer le filtre en cours
888
+	 *
889
+	 * @return string
890
+	 */
891
+	public function getClearFilterbutton()
892
+	{
893
+		$queryString                       = array();
894
+		$queryString[$this->operationName] = $this->op;
895
+		if (count($this->additionnalClearButtonParameters) > 0) {
896
+			foreach ($this->additionnalClearButtonParameters as $key => $value) {
897
+				$queryString[$key] = $value;
898
+			}
899
+		}
900
+		$queryString['cleanFilter'] = '1';
901
+		$baseurl                    = $this->baseUrl;
902
+
903
+		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>";
904
+	}
905
+
906
+	/**
907
+	 * Retourne le bouton permettant de lancer le filtrage
908
+	 *
909
+	 * @param string $description  Texte à faire apparaître sur le bouton
910
+	 * @param array  $additionnals Champs supplémentaires à faire apparaître avec le bouton
911
+	 * @return string
912
+	 */
913
+	public function getGoButton($description = _GO, $additionnals = null)
914
+	{
915
+		$html = '';
916
+		if (trim($this->operationName) != '' && trim($this->op) != '') {
917
+			$html .= "<input type='hidden' name='" . $this->operationName . "' id='" . $this->operationName . "' value='" . $this->op . "' />";
918
+		}
919
+		if (!is_null($additionnals)) {
920
+			foreach ($additionnals as $key => $value) {
921
+				$html .= "<input type='hidden' name='" . $key . "' id='" . $key . "' value='" . $value . "' />";
922
+			}
923
+		}
924
+		$html .= "<input type='submit' name='btngo' id='btngo' value='$description' />";
925
+
926
+		return $html;
927
+	}
928
+
929
+	/**
930
+	 * Retourne le nom de la zone utilisée pour trier les données
931
+	 *
932
+	 * @return string
933
+	 */
934
+	public function getSortField()
935
+	{
936
+		return $this->sortField;
937
+	}
938
+
939
+	/**
940
+	 * Retourne le sens de tri utilisé pour trier les données
941
+	 *
942
+	 * @return string
943
+	 */
944
+	public function getSortOrder()
945
+	{
946
+		return $this->sortOrder();
947
+	}
948
+
949
+	/**
950
+	 * Retourne la valeur d'un champ
951
+	 *
952
+	 * @param  string $fieldName
953
+	 * @return mixed  La valeur du champ ou null si on ne trouve pas la zone
954
+	 */
955
+	public function getFieldValue($fieldName)
956
+	{
957
+		$ret = null;
958
+		if (isset($this->vars[$fieldName])) {
959
+			$ret = $this->vars[$fieldName]['data'];
960
+		}
961
+
962
+		return $ret;
963
+	}
964 964
 }
Please login to merge, or discard this patch.
Spacing   +43 added lines, -43 removed lines patch added patch discarded remove patch
@@ -200,7 +200,7 @@  discard block
 block discarded – undo
200 200
         $this->jsFolderUrl                      = '';
201 201
         $this->additionnalPagerParameters       = array();
202 202
         $this->additionnalClearButtonParameters = array();
203
-        $this->sortFields                       = array();    // Les champs qui peuvent être utilisés pour trier
203
+        $this->sortFields                       = array(); // Les champs qui peuvent être utilisés pour trier
204 204
     }
205 205
 
206 206
     /**
@@ -257,7 +257,7 @@  discard block
 block discarded – undo
257 257
      */
258 258
     private function getSortPlaceHolderNames()
259 259
     {
260
-        return array(self::PREFIX . 'sortFields', self::PREFIX . 'sortOrder');
260
+        return array(self::PREFIX.'sortFields', self::PREFIX.'sortOrder');
261 261
     }
262 262
 
263 263
     /**
@@ -271,7 +271,7 @@  discard block
 block discarded – undo
271 271
         $sortFieldsHtml = references_utils::htmlSelect($sortNames[0], $this->sortFields, $this->sortField, false);
272 272
         $sortOrderHtml  = references_utils::htmlSelect($sortNames[1], array('asc' => _MD_REFERENCES_ASC, 'desc' => _MD_REFERENCES_DESC), $this->sortOrder, false);
273 273
 
274
-        return _MD_REFERENCES_SORT_BY . ' ' . $sortFieldsHtml . ' ' . $sortOrderHtml;
274
+        return _MD_REFERENCES_SORT_BY.' '.$sortFieldsHtml.' '.$sortOrderHtml;
275 275
     }
276 276
 
277 277
     /**
@@ -309,7 +309,7 @@  discard block
 block discarded – undo
309 309
     private function getArrayValue($array, $index, $defaultValue = false)
310 310
     {
311 311
         if ($index === 'autoComplete' && isset($array[$index]) && isset($array[$index]) == true) {
312
-            $this->hasAutoComplete = true;    // On en profite pour vérifier si un champ utilise l'autocomplétion
312
+            $this->hasAutoComplete = true; // On en profite pour vérifier si un champ utilise l'autocomplétion
313 313
         }
314 314
 
315 315
         return isset($array[$index]) ? $array[$index] : $defaultValue;
@@ -333,14 +333,14 @@  discard block
 block discarded – undo
333 333
         if (isset($this->vars[$fieldName])) {    // On vérifie que le champ demandé est bien en autocomplétion
334 334
             if ($this->vars[$fieldName]['autoComplete'] == true) {
335 335
                 if ($this->vars[$fieldName]['dataType'] == self::FILTER_DATA_TEXT) {
336
-                    $criteria = new Criteria($fieldName, $query . '%', 'LIKE');
336
+                    $criteria = new Criteria($fieldName, $query.'%', 'LIKE');
337 337
                 }
338
-                $criteria->setLimit((int)$limit);
338
+                $criteria->setLimit((int) $limit);
339 339
                 $ret = $this->handler->getObjects($criteria);
340 340
 
341 341
                 if (count($ret) > 0) {
342 342
                     foreach ($ret as $object) {
343
-                        $return .= $object->getVar($fieldName, 'n') . "\n";
343
+                        $return .= $object->getVar($fieldName, 'n')."\n";
344 344
                     }
345 345
                 }
346 346
             }
@@ -362,23 +362,23 @@  discard block
 block discarded – undo
362 362
             return $return;
363 363
         }
364 364
         $return = '';
365
-        $return .= "<link rel=\"stylesheet\" type=\"text/css\" media=\"all\" title=\"Style sheet\" href=\"" . $this->jsFolderUrl . "autocomplete/jquery.autocomplete.css\" />\n";
365
+        $return .= "<link rel=\"stylesheet\" type=\"text/css\" media=\"all\" title=\"Style sheet\" href=\"".$this->jsFolderUrl."autocomplete/jquery.autocomplete.css\" />\n";
366 366
         if (!$jqueryAlreadyLoaded) {
367
-            $return .= "<script type=\"text/javascript\" src=\"" . $this->jsFolderUrl . "jquery/jquery.js\"></script>\n";
367
+            $return .= "<script type=\"text/javascript\" src=\"".$this->jsFolderUrl."jquery/jquery.js\"></script>\n";
368 368
         }
369
-        $return .= "<script type=\"text/javascript\" src=\"" . $this->jsFolderUrl . "noconflict.js\"></script>\n";
370
-        $return .= "<script type=\"text/javascript\" src=\"" . $this->jsFolderUrl . "autocomplete/jquery.autocomplete.min.js\"></script>\n";
369
+        $return .= "<script type=\"text/javascript\" src=\"".$this->jsFolderUrl."noconflict.js\"></script>\n";
370
+        $return .= "<script type=\"text/javascript\" src=\"".$this->jsFolderUrl."autocomplete/jquery.autocomplete.min.js\"></script>\n";
371 371
         $return .= "<script type=\"text/javascript\">\n";
372 372
         $return .= "jQuery(function($) {\n";
373
-        $return .= "var url='" . $this->baseUrl . "';\n";    // TODO: Supprimer "var" car cela limite sa portée !
374
-        $return .= "var handlerName='" . $this->handler->className . "';\n";
373
+        $return .= "var url='".$this->baseUrl."';\n"; // TODO: Supprimer "var" car cela limite sa portée !
374
+        $return .= "var handlerName='".$this->handler->className."';\n";
375 375
 
376 376
         foreach ($this->vars as $fieldName => $parameters) {
377 377
             if ($parameters['autoComplete'] == true) {
378
-                $field = self::PREFIX . $fieldName;
379
-                $return .= "$('#" . $field . "').autocomplete(url, {\n";
378
+                $field = self::PREFIX.$fieldName;
379
+                $return .= "$('#".$field."').autocomplete(url, {\n";
380 380
                 $return .= "extraParams: {\n";
381
-                $return .= "    field: '" . $fieldName . "',\n";
381
+                $return .= "    field: '".$fieldName."',\n";
382 382
                 $return .= "    op: 'autocomplete',\n";
383 383
                 $return .= "    handler: handlerName\n";
384 384
                 $return .= "}\n";
@@ -431,7 +431,7 @@  discard block
 block discarded – undo
431 431
      */
432 432
     private function getSessionName()
433 433
     {
434
-        return self::MODULE_NAME . '_' . $this->handler->table;
434
+        return self::MODULE_NAME.'_'.$this->handler->table;
435 435
     }
436 436
 
437 437
     /**
@@ -441,7 +441,7 @@  discard block
 block discarded – undo
441 441
      */
442 442
     private function getStartSessionName()
443 443
     {
444
-        return $this->getSessionName() . '_start';
444
+        return $this->getSessionName().'_start';
445 445
     }
446 446
 
447 447
     /**
@@ -533,11 +533,11 @@  discard block
 block discarded – undo
533 533
             $sortField = $_REQUEST[$orderFieldsNames[0]];
534 534
             $sortOrder = $_REQUEST[$orderFieldsNames[1]];
535 535
         } else {
536
-            if (isset($_SESSION[$cookieName . '_sortField'])) {
537
-                $sortField = $_SESSION[$cookieName . '_sortField'];
536
+            if (isset($_SESSION[$cookieName.'_sortField'])) {
537
+                $sortField = $_SESSION[$cookieName.'_sortField'];
538 538
             }
539
-            if (isset($_SESSION[$cookieName . '_sortOrder'])) {
540
-                $sortOrder = $_SESSION[$cookieName . '_sortOrder'];
539
+            if (isset($_SESSION[$cookieName.'_sortOrder'])) {
540
+                $sortOrder = $_SESSION[$cookieName.'_sortOrder'];
541 541
             }
542 542
         }
543 543
 
@@ -546,8 +546,8 @@  discard block
 block discarded – undo
546 546
             $this->sortOrder = $sortOrder;
547 547
         }
548 548
         if (trim($sortField) != '' && trim($sortOrder) != '') {
549
-            $_SESSION[$cookieName . '_sortField'] = $sortField;
550
-            $_SESSION[$cookieName . '_sortOrder'] = $sortOrder;
549
+            $_SESSION[$cookieName.'_sortField'] = $sortField;
550
+            $_SESSION[$cookieName.'_sortOrder'] = $sortOrder;
551 551
         }
552 552
     }
553 553
 
@@ -596,19 +596,19 @@  discard block
 block discarded – undo
596 596
      */
597 597
     public function filter()
598 598
     {
599
-        $this->setupFilter();                // Réinitialisations
599
+        $this->setupFilter(); // Réinitialisations
600 600
         $ts = MyTextSanitizer::getInstance();
601
-        $this->setSortFieldsFromRequest();    // On récupère la zone de tri éventuellement passée dans la requête
601
+        $this->setSortFieldsFromRequest(); // On récupère la zone de tri éventuellement passée dans la requête
602 602
         $this->isSetCleanFilter();
603 603
 
604 604
         foreach ($this->vars as $fieldName => $fieldProperties) {
605 605
             // On commence par récupérer toutes les valeurs
606
-            $formFieldName           = self::PREFIX . $fieldName;    // "filter_website_id" par exemple
607
-            $fieldProperties['data'] = null;    // Valeur par défaut
606
+            $formFieldName           = self::PREFIX.$fieldName; // "filter_website_id" par exemple
607
+            $fieldProperties['data'] = null; // Valeur par défaut
608 608
             if (isset($_REQUEST[$formFieldName])) {
609 609
                 if ($fieldProperties['dataType'] == self::FILTER_DATA_NUMERIC) {    // Zone numérique
610
-                    if ((int)$_REQUEST[$formFieldName] != 0) {
611
-                        $fieldProperties['data'] = (int)$_REQUEST[$formFieldName];
610
+                    if ((int) $_REQUEST[$formFieldName] != 0) {
611
+                        $fieldProperties['data'] = (int) $_REQUEST[$formFieldName];
612 612
                         if (!$fieldProperties['minusOne']) {
613 613
                             $this->criteria->add(new Criteria($fieldName, $fieldProperties['data'], $fieldProperties['operator']));
614 614
                         } else {
@@ -620,9 +620,9 @@  discard block
 block discarded – undo
620 620
                     if (trim($_REQUEST[$formFieldName]) != '') {
621 621
                         $fieldProperties['data'] = $_REQUEST[$formFieldName];
622 622
                         if (!REFERENCES_EXACT_SEARCH) {
623
-                            $this->criteria->add(new Criteria($fieldName, '%' . $ts->addSlashes($fieldProperties['data']) . '%', 'LIKE'));
623
+                            $this->criteria->add(new Criteria($fieldName, '%'.$ts->addSlashes($fieldProperties['data']).'%', 'LIKE'));
624 624
                         } else {
625
-                            $this->criteria->add(new Criteria($fieldName, $ts->addSlashes($fieldProperties['data']) . '%', 'LIKE'));
625
+                            $this->criteria->add(new Criteria($fieldName, $ts->addSlashes($fieldProperties['data']).'%', 'LIKE'));
626 626
                         }
627 627
                         $this->newFilter = true;
628 628
                     }
@@ -686,7 +686,7 @@  discard block
 block discarded – undo
686 686
     {
687 687
         if ($this->keepStart) {
688 688
             $startSessionName            = $this->getStartSessionName();
689
-            $_SESSION[$startSessionName] = (int)$start;
689
+            $_SESSION[$startSessionName] = (int) $start;
690 690
         }
691 691
     }
692 692
 
@@ -699,11 +699,11 @@  discard block
 block discarded – undo
699 699
     {
700 700
         $start = 0;
701 701
         if (isset($_REQUEST[$this->startName])) {
702
-            $start = (int)$_REQUEST[$this->startName];
702
+            $start = (int) $_REQUEST[$this->startName];
703 703
         } elseif ($this->keepStart) {
704 704
             $startSessionName = $this->getStartSessionName();
705 705
             if (isset($_SESSION[$startSessionName])) {
706
-                $start = (int)$_SESSION[$startSessionName];
706
+                $start = (int) $_SESSION[$startSessionName];
707 707
             }
708 708
         }
709 709
         // Mise en session
@@ -769,7 +769,7 @@  discard block
 block discarded – undo
769 769
         if (!$this->isInitialized) {
770 770
             $this->filter();
771 771
         }
772
-        require_once XOOPS_ROOT_PATH . '/class/pagenav.php';
772
+        require_once XOOPS_ROOT_PATH.'/class/pagenav.php';
773 773
         $itemsCount  = $this->getCount();
774 774
         $queryString = array();
775 775
         if (trim($this->op) != '') {
@@ -779,7 +779,7 @@  discard block
 block discarded – undo
779 779
 
780 780
         if ($itemsCount > $this->limit) {
781 781
             foreach ($this->vars as $fieldName => $fieldProperties) {
782
-                $formFieldName               = self::PREFIX . $fieldName;    // "filter_website_id" par exemple
782
+                $formFieldName               = self::PREFIX.$fieldName; // "filter_website_id" par exemple
783 783
                 $queryString[$formFieldName] = $fieldProperties['data'];
784 784
             }
785 785
             // Ajout des paramètres supplémentaires éventuels
@@ -839,15 +839,15 @@  discard block
 block discarded – undo
839 839
             return $html;
840 840
         }
841 841
         $fieldData     = $this->vars[$fieldName];
842
-        $htmlFieldName = self::PREFIX . $fieldName;
842
+        $htmlFieldName = self::PREFIX.$fieldName;
843 843
 
844 844
         switch ($fieldData['fieldType']) {
845 845
             case self::FILTER_FIELD_TEXT:    // Zone de texte
846 846
                 $ts   = MyTextSanitizer::getInstance();
847
-                $html = "<input type='text' name='$htmlFieldName' id='$htmlFieldName' size='" . $fieldData['size'] . "' maxlength='" . $fieldData['maxLength'] . "' value='" . $ts->htmlSpecialChars($fieldData['data']) . "' />";
847
+                $html = "<input type='text' name='$htmlFieldName' id='$htmlFieldName' size='".$fieldData['size']."' maxlength='".$fieldData['maxLength']."' value='".$ts->htmlSpecialChars($fieldData['data'])."' />";
848 848
                 break;
849 849
 
850
-            case self::FILTER_FIELD_SELECT;     // Select
850
+            case self::FILTER_FIELD_SELECT; // Select
851 851
                 $style = '';
852 852
                 if (isset($fieldData['style']) && trim($fieldData['style']) != '') {
853 853
                     $style = $fieldData['style'];
@@ -900,7 +900,7 @@  discard block
 block discarded – undo
900 900
         $queryString['cleanFilter'] = '1';
901 901
         $baseurl                    = $this->baseUrl;
902 902
 
903
-        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>";
903
+        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>";
904 904
     }
905 905
 
906 906
     /**
@@ -914,11 +914,11 @@  discard block
 block discarded – undo
914 914
     {
915 915
         $html = '';
916 916
         if (trim($this->operationName) != '' && trim($this->op) != '') {
917
-            $html .= "<input type='hidden' name='" . $this->operationName . "' id='" . $this->operationName . "' value='" . $this->op . "' />";
917
+            $html .= "<input type='hidden' name='".$this->operationName."' id='".$this->operationName."' value='".$this->op."' />";
918 918
         }
919 919
         if (!is_null($additionnals)) {
920 920
             foreach ($additionnals as $key => $value) {
921
-                $html .= "<input type='hidden' name='" . $key . "' id='" . $key . "' value='" . $value . "' />";
921
+                $html .= "<input type='hidden' name='".$key."' id='".$key."' value='".$value."' />";
922 922
             }
923 923
         }
924 924
         $html .= "<input type='submit' name='btngo' id='btngo' value='$description' />";
Please login to merge, or discard this patch.
class/references_plugins.php 3 patches
Doc Comments   +4 added lines, -4 removed lines patch added patch discarded remove patch
@@ -95,7 +95,7 @@  discard block
 block discarded – undo
95 95
     /**
96 96
      * Retourne l'instance unique de la classe
97 97
      *
98
-     * @return object
98
+     * @return references_plugins
99 99
      */
100 100
     public static function getInstance()
101 101
     {
@@ -177,8 +177,8 @@  discard block
 block discarded – undo
177 177
      * Déclenchement d'une action et appel des plugins liés
178 178
      *
179 179
      * @param string                       $eventToFire L'action déclenchée
180
-     * @param object|references_parameters $parameters  Les paramètres à passer à chaque plugin
181
-     * @return object L'objet lui même pour chaîner
180
+     * @param references_parameters $parameters  Les paramètres à passer à chaque plugin
181
+     * @return references_plugins L'objet lui même pour chaîner
182 182
      */
183 183
     public function fireAction($eventToFire, references_parameters $parameters = null)
184 184
     {
@@ -212,7 +212,7 @@  discard block
 block discarded – undo
212 212
      * Déclenchement d'un filtre et appel des plugins liés
213 213
      *
214 214
      * @param string                       $eventToFire Le filtre appelé
215
-     * @param object|references_parameters $parameters  Les paramètres à passer à chaque plugin
215
+     * @param references_parameters $parameters  Les paramètres à passer à chaque plugin
216 216
      * @return object Le contenu de l'objet passé en paramètre
217 217
      */
218 218
     public function fireFilter($eventToFire, references_parameters $parameters)
Please login to merge, or discard this patch.
Indentation   +236 added lines, -236 removed lines patch added patch discarded remove patch
@@ -25,266 +25,266 @@
 block discarded – undo
25 25
  */
26 26
 class references_plugins
27 27
 {
28
-    /**
29
-     * Dictionnaire des évènements
30
-     */
31
-    const EVENT_ON_REFERENCE_CREATE = 'onReferenceCreate';
32
-    const EVENT_ON_CATEGORY_CREATE  = 'onCategoryCreate';
28
+	/**
29
+	 * Dictionnaire des évènements
30
+	 */
31
+	const EVENT_ON_REFERENCE_CREATE = 'onReferenceCreate';
32
+	const EVENT_ON_CATEGORY_CREATE  = 'onCategoryCreate';
33 33
 
34
-    // Pour limiter les dépendances
35
-    const MODULE_DIRNAME = REFERENCES_DIRNAME;
34
+	// Pour limiter les dépendances
35
+	const MODULE_DIRNAME = REFERENCES_DIRNAME;
36 36
 
37
-    /**
38
-     * Types d'évènements
39
-     */
40
-    const PLUGIN_ACTION = 0;
41
-    const PLUGIN_FILTER = 1;
37
+	/**
38
+	 * Types d'évènements
39
+	 */
40
+	const PLUGIN_ACTION = 0;
41
+	const PLUGIN_FILTER = 1;
42 42
 
43
-    /**
44
-     * Nom du script Php inclut qui contient l'inscription des plugins
45
-     */
46
-    const PLUGIN_SCRIPT_NAME = 'plugins.php';
43
+	/**
44
+	 * Nom du script Php inclut qui contient l'inscription des plugins
45
+	 */
46
+	const PLUGIN_SCRIPT_NAME = 'plugins.php';
47 47
 
48
-    /**
49
-     * Dans le fichier Php qui contient l'inscription des plugins, méthode à appeler pour récupérer la liste des plugins
50
-     */
51
-    const PLUGIN_DESCRIBE_METHOD = 'registerEvents';
48
+	/**
49
+	 * Dans le fichier Php qui contient l'inscription des plugins, méthode à appeler pour récupérer la liste des plugins
50
+	 */
51
+	const PLUGIN_DESCRIBE_METHOD = 'registerEvents';
52 52
 
53
-    /**
54
-     * Nom de la variable de session qui contient la liste des plugins détachés
55
-     */
56
-    const PLUGIN_UNPLUG_SESSION_NAME = 'references_plugins';
53
+	/**
54
+	 * Nom de la variable de session qui contient la liste des plugins détachés
55
+	 */
56
+	const PLUGIN_UNPLUG_SESSION_NAME = 'references_plugins';
57 57
 
58
-    /**
59
-     * Priorités des plugins
60
-     * @var constant
61
-     */
62
-    const EVENT_PRIORITY_1 = 1;    // Priorité la plus haute
63
-    const EVENT_PRIORITY_2 = 2;
64
-    const EVENT_PRIORITY_3 = 3;
65
-    const EVENT_PRIORITY_4 = 4;
66
-    const EVENT_PRIORITY_5 = 5;    // Priorité la plus basse
58
+	/**
59
+	 * Priorités des plugins
60
+	 * @var constant
61
+	 */
62
+	const EVENT_PRIORITY_1 = 1;    // Priorité la plus haute
63
+	const EVENT_PRIORITY_2 = 2;
64
+	const EVENT_PRIORITY_3 = 3;
65
+	const EVENT_PRIORITY_4 = 4;
66
+	const EVENT_PRIORITY_5 = 5;    // Priorité la plus basse
67 67
 
68
-    /**
69
-     * Utilisé pour construire le nom de la classe
70
-     */
71
-    private $pluginsTypeLabel = array(self::PLUGIN_ACTION => 'Action', self::PLUGIN_FILTER => 'Filter');
68
+	/**
69
+	 * Utilisé pour construire le nom de la classe
70
+	 */
71
+	private $pluginsTypeLabel = array(self::PLUGIN_ACTION => 'Action', self::PLUGIN_FILTER => 'Filter');
72 72
 
73
-    /**
74
-     * Nom des classes qu'il faut étendre en tant que plugin
75
-     */
76
-    private $pluginsClassName = array(self::PLUGIN_ACTION => 'references_action', self::PLUGIN_FILTER => 'references_filter');
73
+	/**
74
+	 * Nom des classes qu'il faut étendre en tant que plugin
75
+	 */
76
+	private $pluginsClassName = array(self::PLUGIN_ACTION => 'references_action', self::PLUGIN_FILTER => 'references_filter');
77 77
 
78
-    /**
79
-     * Nom de chacun des dossiers en fonction du type de plugin
80
-     */
81
-    private $pluginsTypesFolder = array(self::PLUGIN_ACTION => 'actions', self::PLUGIN_FILTER => 'filters');
78
+	/**
79
+	 * Nom de chacun des dossiers en fonction du type de plugin
80
+	 */
81
+	private $pluginsTypesFolder = array(self::PLUGIN_ACTION => 'actions', self::PLUGIN_FILTER => 'filters');
82 82
 
83
-    /**
84
-     * Contient l'unique instance de l'objet
85
-     * @var object
86
-     */
87
-    private static $instance = false;
83
+	/**
84
+	 * Contient l'unique instance de l'objet
85
+	 * @var object
86
+	 */
87
+	private static $instance = false;
88 88
 
89
-    /**
90
-     * Liste des évènements
91
-     * @var array
92
-     */
93
-    private static $events = array();
89
+	/**
90
+	 * Liste des évènements
91
+	 * @var array
92
+	 */
93
+	private static $events = array();
94 94
 
95
-    /**
96
-     * Retourne l'instance unique de la classe
97
-     *
98
-     * @return object
99
-     */
100
-    public static function getInstance()
101
-    {
102
-        static $instance;
103
-        if (null === $instance) {
104
-            $instance = new static();
105
-        }
95
+	/**
96
+	 * Retourne l'instance unique de la classe
97
+	 *
98
+	 * @return object
99
+	 */
100
+	public static function getInstance()
101
+	{
102
+		static $instance;
103
+		if (null === $instance) {
104
+			$instance = new static();
105
+		}
106 106
 
107
-        return $instance;
108
-    }
107
+		return $instance;
108
+	}
109 109
 
110
-    /**
111
-     * Chargement des 2 types de plugins
112
-     *
113
-     */
114
-    private function __construct()
115
-    {
116
-        $this->events = array();
117
-        $this->loadPlugins();
118
-    }
110
+	/**
111
+	 * Chargement des 2 types de plugins
112
+	 *
113
+	 */
114
+	private function __construct()
115
+	{
116
+		$this->events = array();
117
+		$this->loadPlugins();
118
+	}
119 119
 
120
-    /**
121
-     * Chargement des plugins (actions et filtres)
122
-     * @return void
123
-     */
124
-    public function loadPlugins()
125
-    {
126
-        $this->loadPluginsFiles(REFERENCES_PLUGINS_PATH . $this->pluginsTypesFolder[self::PLUGIN_ACTION], self::PLUGIN_ACTION);
127
-        $this->loadPluginsFiles(REFERENCES_PLUGINS_PATH . $this->pluginsTypesFolder[self::PLUGIN_FILTER], self::PLUGIN_FILTER);
128
-    }
120
+	/**
121
+	 * Chargement des plugins (actions et filtres)
122
+	 * @return void
123
+	 */
124
+	public function loadPlugins()
125
+	{
126
+		$this->loadPluginsFiles(REFERENCES_PLUGINS_PATH . $this->pluginsTypesFolder[self::PLUGIN_ACTION], self::PLUGIN_ACTION);
127
+		$this->loadPluginsFiles(REFERENCES_PLUGINS_PATH . $this->pluginsTypesFolder[self::PLUGIN_FILTER], self::PLUGIN_FILTER);
128
+	}
129 129
 
130
-    /**
131
-     * 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
132
-     * @param string  $fullPathName Chemin complet vers le fichier (répertoire + nom)
133
-     * @param integer $type         Type de plugin recherché (action ou filtre)
134
-     * @param string  $pluginFolder Le nom du répertoire dans lequel se trouve le fichier (le "dernier nom")
135
-     * @return void
136
-     */
137
-    private function loadClass($fullPathName, $type, $pluginFolder)
138
-    {
139
-        require_once $fullPathName;
140
-        // Du style referencesRegionalizationFilter
141
-        $className = self::MODULE_DIRNAME . ucfirst(strtolower($pluginFolder)) . $this->pluginsTypeLabel[$type];
142
-        if (class_exists($className) && get_parent_class($className) == $this->pluginsClassName[$type]) {
143
-            // TODO: Vérifier que l'évènement n'est pas déjà en mémoire
144
-            $events = call_user_func(array($className, self::PLUGIN_DESCRIBE_METHOD));
145
-            foreach ($events as $event) {
146
-                $eventName                                         = $event[0];
147
-                $eventPriority                                     = $event[1];
148
-                $fileToInclude                                     = REFERENCES_PLUGINS_PATH . $this->pluginsTypesFolder[$type] . DIRECTORY_SEPARATOR . $pluginFolder . DIRECTORY_SEPARATOR . $event[2];
149
-                $classToCall                                       = $event[3];
150
-                $methodToCall                                      = $event[4];
151
-                $this->events[$type][$eventName][$eventPriority][] = array('fullPathName' => $fileToInclude, 'className' => $classToCall, 'method' => $methodToCall);
152
-            }
153
-        }
154
-    }
130
+	/**
131
+	 * 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
132
+	 * @param string  $fullPathName Chemin complet vers le fichier (répertoire + nom)
133
+	 * @param integer $type         Type de plugin recherché (action ou filtre)
134
+	 * @param string  $pluginFolder Le nom du répertoire dans lequel se trouve le fichier (le "dernier nom")
135
+	 * @return void
136
+	 */
137
+	private function loadClass($fullPathName, $type, $pluginFolder)
138
+	{
139
+		require_once $fullPathName;
140
+		// Du style referencesRegionalizationFilter
141
+		$className = self::MODULE_DIRNAME . ucfirst(strtolower($pluginFolder)) . $this->pluginsTypeLabel[$type];
142
+		if (class_exists($className) && get_parent_class($className) == $this->pluginsClassName[$type]) {
143
+			// TODO: Vérifier que l'évènement n'est pas déjà en mémoire
144
+			$events = call_user_func(array($className, self::PLUGIN_DESCRIBE_METHOD));
145
+			foreach ($events as $event) {
146
+				$eventName                                         = $event[0];
147
+				$eventPriority                                     = $event[1];
148
+				$fileToInclude                                     = REFERENCES_PLUGINS_PATH . $this->pluginsTypesFolder[$type] . DIRECTORY_SEPARATOR . $pluginFolder . DIRECTORY_SEPARATOR . $event[2];
149
+				$classToCall                                       = $event[3];
150
+				$methodToCall                                      = $event[4];
151
+				$this->events[$type][$eventName][$eventPriority][] = array('fullPathName' => $fileToInclude, 'className' => $classToCall, 'method' => $methodToCall);
152
+			}
153
+		}
154
+	}
155 155
 
156
-    /**
157
-     * Part à la recherche d'un type de plugin dans les répertoires
158
-     *
159
-     * @param  string $path La racine
160
-     * @param integer $type Le type de plugin recherché (action ou filtre)
161
-     * @return void
162
-     */
163
-    private function loadPluginsFiles($path, $type)
164
-    {
165
-        $objects = new DirectoryIterator($path);
166
-        foreach ($objects as $object) {
167
-            if ($object->isDir() && !$object->isDot()) {
168
-                $file = $path . DIRECTORY_SEPARATOR . $object->current() . DIRECTORY_SEPARATOR . self::PLUGIN_SCRIPT_NAME;
169
-                if (file_exists($file)) {
170
-                    $this->loadClass($file, $type, $object->current());
171
-                }
172
-            }
173
-        }
174
-    }
156
+	/**
157
+	 * Part à la recherche d'un type de plugin dans les répertoires
158
+	 *
159
+	 * @param  string $path La racine
160
+	 * @param integer $type Le type de plugin recherché (action ou filtre)
161
+	 * @return void
162
+	 */
163
+	private function loadPluginsFiles($path, $type)
164
+	{
165
+		$objects = new DirectoryIterator($path);
166
+		foreach ($objects as $object) {
167
+			if ($object->isDir() && !$object->isDot()) {
168
+				$file = $path . DIRECTORY_SEPARATOR . $object->current() . DIRECTORY_SEPARATOR . self::PLUGIN_SCRIPT_NAME;
169
+				if (file_exists($file)) {
170
+					$this->loadClass($file, $type, $object->current());
171
+				}
172
+			}
173
+		}
174
+	}
175 175
 
176
-    /**
177
-     * Déclenchement d'une action et appel des plugins liés
178
-     *
179
-     * @param string                       $eventToFire L'action déclenchée
180
-     * @param object|references_parameters $parameters  Les paramètres à passer à chaque plugin
181
-     * @return object L'objet lui même pour chaîner
182
-     */
183
-    public function fireAction($eventToFire, references_parameters $parameters = null)
184
-    {
185
-        if (!isset($this->events[self::PLUGIN_ACTION][$eventToFire])) {
186
-            trigger_error(sprintf(_MD_REFERENCES_PLUGINS_ERROR_1, $eventToFire));
176
+	/**
177
+	 * Déclenchement d'une action et appel des plugins liés
178
+	 *
179
+	 * @param string                       $eventToFire L'action déclenchée
180
+	 * @param object|references_parameters $parameters  Les paramètres à passer à chaque plugin
181
+	 * @return object L'objet lui même pour chaîner
182
+	 */
183
+	public function fireAction($eventToFire, references_parameters $parameters = null)
184
+	{
185
+		if (!isset($this->events[self::PLUGIN_ACTION][$eventToFire])) {
186
+			trigger_error(sprintf(_MD_REFERENCES_PLUGINS_ERROR_1, $eventToFire));
187 187
 
188
-            return $this;
189
-        }
190
-        ksort($this->events[self::PLUGIN_ACTION][$eventToFire]);    // Tri par priorit�
191
-        foreach ($this->events[self::PLUGIN_ACTION][$eventToFire] as $priority => $events) {
192
-            foreach ($events as $event) {
193
-                if ($this->isUnplug(self::PLUGIN_ACTION, $eventToFire, $event['fullPathName'], $event['className'], $event['method'])) {
194
-                    continue;
195
-                }
196
-                require_once $event['fullPathName'];
197
-                if (!class_exists($event['className'])) {
198
-                    $class = new $event['className'];
199
-                }
200
-                if (!method_exists($event['className'], $event['method'])) {
201
-                    continue;
202
-                }
203
-                call_user_func(array($event['className'], $event['method']), $parameters);
204
-                unset($class);
205
-            }
206
-        }
188
+			return $this;
189
+		}
190
+		ksort($this->events[self::PLUGIN_ACTION][$eventToFire]);    // Tri par priorit�
191
+		foreach ($this->events[self::PLUGIN_ACTION][$eventToFire] as $priority => $events) {
192
+			foreach ($events as $event) {
193
+				if ($this->isUnplug(self::PLUGIN_ACTION, $eventToFire, $event['fullPathName'], $event['className'], $event['method'])) {
194
+					continue;
195
+				}
196
+				require_once $event['fullPathName'];
197
+				if (!class_exists($event['className'])) {
198
+					$class = new $event['className'];
199
+				}
200
+				if (!method_exists($event['className'], $event['method'])) {
201
+					continue;
202
+				}
203
+				call_user_func(array($event['className'], $event['method']), $parameters);
204
+				unset($class);
205
+			}
206
+		}
207 207
 
208
-        return $this;
209
-    }
208
+		return $this;
209
+	}
210 210
 
211
-    /**
212
-     * Déclenchement d'un filtre et appel des plugins liés
213
-     *
214
-     * @param string                       $eventToFire Le filtre appelé
215
-     * @param object|references_parameters $parameters  Les paramètres à passer à chaque plugin
216
-     * @return object Le contenu de l'objet passé en paramètre
217
-     */
218
-    public function fireFilter($eventToFire, references_parameters $parameters)
219
-    {
220
-        if (!isset($this->events[self::PLUGIN_FILTER][$eventToFire])) {
221
-            trigger_error(sprintf(_MD_REFERENCES_PLUGINS_ERROR_1, $eventToFire));
211
+	/**
212
+	 * Déclenchement d'un filtre et appel des plugins liés
213
+	 *
214
+	 * @param string                       $eventToFire Le filtre appelé
215
+	 * @param object|references_parameters $parameters  Les paramètres à passer à chaque plugin
216
+	 * @return object Le contenu de l'objet passé en paramètre
217
+	 */
218
+	public function fireFilter($eventToFire, references_parameters $parameters)
219
+	{
220
+		if (!isset($this->events[self::PLUGIN_FILTER][$eventToFire])) {
221
+			trigger_error(sprintf(_MD_REFERENCES_PLUGINS_ERROR_1, $eventToFire));
222 222
 
223
-            return $this;
224
-        }
225
-        ksort($this->events[self::PLUGIN_FILTER][$eventToFire]);    // Tri par priorité
226
-        foreach ($this->events[self::PLUGIN_FILTER][$eventToFire] as $priority => $events) {
227
-            foreach ($events as $event) {
228
-                if ($this->isUnplug(self::PLUGIN_FILTER, $eventToFire, $event['fullPathName'], $event['className'], $event['method'])) {
229
-                    continue;
230
-                }
231
-                require_once $event['fullPathName'];
232
-                if (!method_exists($event['className'], $event['method'])) {
233
-                    continue;
234
-                }
235
-                //if (!class_exists($event['className'])) {
236
-                $class = new $event['className'];
237
-                //}
238
-                $class->$event['method']($parameters);
239
-                //call_user_func(array($event['className'], $event['method']), $parameters);
240
-                unset($class);
241
-            }
242
-        }
223
+			return $this;
224
+		}
225
+		ksort($this->events[self::PLUGIN_FILTER][$eventToFire]);    // Tri par priorité
226
+		foreach ($this->events[self::PLUGIN_FILTER][$eventToFire] as $priority => $events) {
227
+			foreach ($events as $event) {
228
+				if ($this->isUnplug(self::PLUGIN_FILTER, $eventToFire, $event['fullPathName'], $event['className'], $event['method'])) {
229
+					continue;
230
+				}
231
+				require_once $event['fullPathName'];
232
+				if (!method_exists($event['className'], $event['method'])) {
233
+					continue;
234
+				}
235
+				//if (!class_exists($event['className'])) {
236
+				$class = new $event['className'];
237
+				//}
238
+				$class->$event['method']($parameters);
239
+				//call_user_func(array($event['className'], $event['method']), $parameters);
240
+				unset($class);
241
+			}
242
+		}
243 243
 
244
-        if (!is_null($parameters)) {
245
-            return $parameters;
246
-        }
247
-    }
244
+		if (!is_null($parameters)) {
245
+			return $parameters;
246
+		}
247
+	}
248 248
 
249
-    /**
250
-     * Indique si un plugin s'est détaché d'un évènement particulier
251
-     *
252
-     * @param  integer $eventType
253
-     * @param  string  $eventToFire
254
-     * @param  string  $fullPathName
255
-     * @param  string  $className
256
-     * @param  string  $method
257
-     * @return boolean
258
-     */
259
-    public function isUnplug($eventType, $eventToFire, $fullPathName, $className, $method)
260
-    {
261
-        $unplug = array();
262
-        if (isset($_SESSION[self::PLUGIN_UNPLUG_SESSION_NAME])) {
263
-            $unplug = $_SESSION[self::PLUGIN_UNPLUG_SESSION_NAME];
264
-        } else {
265
-            return false;
266
-        }
249
+	/**
250
+	 * Indique si un plugin s'est détaché d'un évènement particulier
251
+	 *
252
+	 * @param  integer $eventType
253
+	 * @param  string  $eventToFire
254
+	 * @param  string  $fullPathName
255
+	 * @param  string  $className
256
+	 * @param  string  $method
257
+	 * @return boolean
258
+	 */
259
+	public function isUnplug($eventType, $eventToFire, $fullPathName, $className, $method)
260
+	{
261
+		$unplug = array();
262
+		if (isset($_SESSION[self::PLUGIN_UNPLUG_SESSION_NAME])) {
263
+			$unplug = $_SESSION[self::PLUGIN_UNPLUG_SESSION_NAME];
264
+		} else {
265
+			return false;
266
+		}
267 267
 
268
-        return isset($unplug[$eventType][$eventToFire][$fullPathName][$className][$method]);
269
-    }
268
+		return isset($unplug[$eventType][$eventToFire][$fullPathName][$className][$method]);
269
+	}
270 270
 
271
-    /**
272
-     * Permet à un plugin de se détacher d'un évènement
273
-     *
274
-     * @param  integer $eventType
275
-     * @param  string  $eventToFire
276
-     * @param  string  $fullPathName
277
-     * @param  string  $className
278
-     * @param  string  $method
279
-     * @return void
280
-     */
281
-    public function unplugFromEvent($eventType, $eventToFire, $fullPathName, $className, $method)
282
-    {
283
-        $unplug = array();
284
-        if (isset($_SESSION[self::PLUGIN_UNPLUG_SESSION_NAME])) {
285
-            $unplug = $_SESSION[self::PLUGIN_UNPLUG_SESSION_NAME];
286
-        }
287
-        $unplug[$eventType][$eventToFire][$fullPathName][$className][$method] = true;
288
-        $_SESSION[self::PLUGIN_UNPLUG_SESSION_NAME]                           = $unplug;
289
-    }
271
+	/**
272
+	 * Permet à un plugin de se détacher d'un évènement
273
+	 *
274
+	 * @param  integer $eventType
275
+	 * @param  string  $eventToFire
276
+	 * @param  string  $fullPathName
277
+	 * @param  string  $className
278
+	 * @param  string  $method
279
+	 * @return void
280
+	 */
281
+	public function unplugFromEvent($eventType, $eventToFire, $fullPathName, $className, $method)
282
+	{
283
+		$unplug = array();
284
+		if (isset($_SESSION[self::PLUGIN_UNPLUG_SESSION_NAME])) {
285
+			$unplug = $_SESSION[self::PLUGIN_UNPLUG_SESSION_NAME];
286
+		}
287
+		$unplug[$eventType][$eventToFire][$fullPathName][$className][$method] = true;
288
+		$_SESSION[self::PLUGIN_UNPLUG_SESSION_NAME]                           = $unplug;
289
+	}
290 290
 }
Please login to merge, or discard this patch.
Spacing   +9 added lines, -9 removed lines patch added patch discarded remove patch
@@ -59,11 +59,11 @@  discard block
 block discarded – undo
59 59
      * Priorités des plugins
60 60
      * @var constant
61 61
      */
62
-    const EVENT_PRIORITY_1 = 1;    // Priorité la plus haute
62
+    const EVENT_PRIORITY_1 = 1; // Priorité la plus haute
63 63
     const EVENT_PRIORITY_2 = 2;
64 64
     const EVENT_PRIORITY_3 = 3;
65 65
     const EVENT_PRIORITY_4 = 4;
66
-    const EVENT_PRIORITY_5 = 5;    // Priorité la plus basse
66
+    const EVENT_PRIORITY_5 = 5; // Priorité la plus basse
67 67
 
68 68
     /**
69 69
      * Utilisé pour construire le nom de la classe
@@ -123,8 +123,8 @@  discard block
 block discarded – undo
123 123
      */
124 124
     public function loadPlugins()
125 125
     {
126
-        $this->loadPluginsFiles(REFERENCES_PLUGINS_PATH . $this->pluginsTypesFolder[self::PLUGIN_ACTION], self::PLUGIN_ACTION);
127
-        $this->loadPluginsFiles(REFERENCES_PLUGINS_PATH . $this->pluginsTypesFolder[self::PLUGIN_FILTER], self::PLUGIN_FILTER);
126
+        $this->loadPluginsFiles(REFERENCES_PLUGINS_PATH.$this->pluginsTypesFolder[self::PLUGIN_ACTION], self::PLUGIN_ACTION);
127
+        $this->loadPluginsFiles(REFERENCES_PLUGINS_PATH.$this->pluginsTypesFolder[self::PLUGIN_FILTER], self::PLUGIN_FILTER);
128 128
     }
129 129
 
130 130
     /**
@@ -138,14 +138,14 @@  discard block
 block discarded – undo
138 138
     {
139 139
         require_once $fullPathName;
140 140
         // Du style referencesRegionalizationFilter
141
-        $className = self::MODULE_DIRNAME . ucfirst(strtolower($pluginFolder)) . $this->pluginsTypeLabel[$type];
141
+        $className = self::MODULE_DIRNAME.ucfirst(strtolower($pluginFolder)).$this->pluginsTypeLabel[$type];
142 142
         if (class_exists($className) && get_parent_class($className) == $this->pluginsClassName[$type]) {
143 143
             // TODO: Vérifier que l'évènement n'est pas déjà en mémoire
144 144
             $events = call_user_func(array($className, self::PLUGIN_DESCRIBE_METHOD));
145 145
             foreach ($events as $event) {
146 146
                 $eventName                                         = $event[0];
147 147
                 $eventPriority                                     = $event[1];
148
-                $fileToInclude                                     = REFERENCES_PLUGINS_PATH . $this->pluginsTypesFolder[$type] . DIRECTORY_SEPARATOR . $pluginFolder . DIRECTORY_SEPARATOR . $event[2];
148
+                $fileToInclude                                     = REFERENCES_PLUGINS_PATH.$this->pluginsTypesFolder[$type].DIRECTORY_SEPARATOR.$pluginFolder.DIRECTORY_SEPARATOR.$event[2];
149 149
                 $classToCall                                       = $event[3];
150 150
                 $methodToCall                                      = $event[4];
151 151
                 $this->events[$type][$eventName][$eventPriority][] = array('fullPathName' => $fileToInclude, 'className' => $classToCall, 'method' => $methodToCall);
@@ -165,7 +165,7 @@  discard block
 block discarded – undo
165 165
         $objects = new DirectoryIterator($path);
166 166
         foreach ($objects as $object) {
167 167
             if ($object->isDir() && !$object->isDot()) {
168
-                $file = $path . DIRECTORY_SEPARATOR . $object->current() . DIRECTORY_SEPARATOR . self::PLUGIN_SCRIPT_NAME;
168
+                $file = $path.DIRECTORY_SEPARATOR.$object->current().DIRECTORY_SEPARATOR.self::PLUGIN_SCRIPT_NAME;
169 169
                 if (file_exists($file)) {
170 170
                     $this->loadClass($file, $type, $object->current());
171 171
                 }
@@ -187,7 +187,7 @@  discard block
 block discarded – undo
187 187
 
188 188
             return $this;
189 189
         }
190
-        ksort($this->events[self::PLUGIN_ACTION][$eventToFire]);    // Tri par priorit�
190
+        ksort($this->events[self::PLUGIN_ACTION][$eventToFire]); // Tri par priorit�
191 191
         foreach ($this->events[self::PLUGIN_ACTION][$eventToFire] as $priority => $events) {
192 192
             foreach ($events as $event) {
193 193
                 if ($this->isUnplug(self::PLUGIN_ACTION, $eventToFire, $event['fullPathName'], $event['className'], $event['method'])) {
@@ -222,7 +222,7 @@  discard block
 block discarded – undo
222 222
 
223 223
             return $this;
224 224
         }
225
-        ksort($this->events[self::PLUGIN_FILTER][$eventToFire]);    // Tri par priorité
225
+        ksort($this->events[self::PLUGIN_FILTER][$eventToFire]); // Tri par priorité
226 226
         foreach ($this->events[self::PLUGIN_FILTER][$eventToFire] as $priority => $events) {
227 227
             foreach ($events as $event) {
228 228
                 if ($this->isUnplug(self::PLUGIN_FILTER, $eventToFire, $event['fullPathName'], $event['className'], $event['method'])) {
Please login to merge, or discard this patch.
class/references_utils.php 3 patches
Doc Comments   +10 added lines, -7 removed lines patch added patch discarded remove patch
@@ -48,7 +48,7 @@  discard block
 block discarded – undo
48 48
     /**
49 49
      * Access the only instance of this class
50 50
      *
51
-     * @return object
51
+     * @return references_utils
52 52
      *
53 53
      * @static
54 54
      * @staticvar   object
@@ -386,7 +386,7 @@  discard block
 block discarded – undo
386 386
     /**
387 387
      * Internal function used to get the handler of the current module
388 388
      *
389
-     * @return object The module
389
+     * @return integer The module
390 390
      */
391 391
     public static function getModule()
392 392
     {
@@ -489,7 +489,7 @@  discard block
 block discarded – undo
489 489
     /**
490 490
      * V�rifie que l'utilisateur courant fait partie du groupe des administrateurs
491 491
      *
492
-     * @return booleean Admin or not
492
+     * @return boolean Admin or not
493 493
      */
494 494
     public static function isAdmin()
495 495
     {
@@ -550,7 +550,7 @@  discard block
 block discarded – undo
550 550
     /**
551 551
      * Conversion d'un dateTime Mysql en date lisible en fran�ais
552 552
      * @param $dateTime
553
-     * @return bool|string
553
+     * @return string
554 554
      */
555 555
     public static function sqlDateTimeToFrench($dateTime)
556 556
     {
@@ -943,7 +943,7 @@  discard block
 block discarded – undo
943 943
      * @param null    $uploadMaxSize
944 944
      * @param null    $maxWidth
945 945
      * @param null    $maxHeight
946
-     * @return mixed True si l'upload s'est bien déroulé sinon le message d'erreur correspondant
946
+     * @return boolean|string True si l'upload s'est bien déroulé sinon le message d'erreur correspondant
947 947
      */
948 948
     public static function uploadFile($indice, $dstpath = XOOPS_UPLOAD_PATH, $mimeTypes = null, $uploadMaxSize = null, $maxWidth = null, $maxHeight = null)
949 949
     {
@@ -1031,7 +1031,7 @@  discard block
 block discarded – undo
1031 1031
      *
1032 1032
      * @param int     $duration
1033 1033
      * @param integer $startingDate Date de départ (timestamp)
1034
-     * @return bool|string
1034
+     * @return string
1035 1035
      * @internal param int $durations Durée en jours
1036 1036
      */
1037 1037
     public static function addDaysToDate($duration = 1, $startingDate = 0)
@@ -1073,6 +1073,9 @@  discard block
 block discarded – undo
1073 1073
         return $breadcrumb;
1074 1074
     }
1075 1075
 
1076
+    /**
1077
+     * @param string $string
1078
+     */
1076 1079
     public static function close_tags($string)
1077 1080
     {
1078 1081
         // match opened tags
@@ -1394,7 +1397,7 @@  discard block
 block discarded – undo
1394 1397
      * Create the <option> of an html select
1395 1398
      *
1396 1399
      * @param  array $array   Array of index and labels
1397
-     * @param  mixed $default the default value
1400
+     * @param  integer $default the default value
1398 1401
      * @param bool   $withNull
1399 1402
      * @return string
1400 1403
      */
Please login to merge, or discard this patch.
Indentation   +1529 added lines, -1529 removed lines patch added patch discarded remove patch
@@ -36,1533 +36,1533 @@
 block discarded – undo
36 36
 
37 37
 class references_utils
38 38
 {
39
-    // Pour la portabilité de module à module
40
-    const MODULE_NAME    = 'references';
41
-    const MODULE_DIRNAME = REFERENCES_DIRNAME;
42
-    const MODULE_PATH    = REFERENCES_PATH;
43
-    const MODULE_URL     = REFERENCES_URL;
44
-    const MODULE_JS_URL  = REFERENCES_JS_URL;
45
-
46
-    /**
47
-     * Access the only instance of this class
48
-     *
49
-     * @return object
50
-     *
51
-     * @static
52
-     * @staticvar   object
53
-     */
54
-    public static function getInstance()
55
-    {
56
-        static $instance;
57
-        if (null === $instance) {
58
-            $instance = new static();
59
-        }
60
-
61
-        return $instance;
62
-    }
63
-
64
-    /**
65
-     * Returns a module's option (with cache)
66
-     *
67
-     * @param  string  $option    module option's name
68
-     * @param  boolean $withCache Do we have to use some cache ?
69
-     * @return mixed   option's value
70
-     */
71
-    public static function getModuleOption($option, $withCache = true)
72
-    {
73
-        global $xoopsModuleConfig, $xoopsModule;
74
-        $repmodule = self::MODULE_NAME;
75
-        static $options = array();
76
-        if (is_array($options) && array_key_exists($option, $options) && $withCache) {
77
-            return $options[$option];
78
-        }
79
-
80
-        $retval = false;
81
-        if (isset($xoopsModuleConfig) && (is_object($xoopsModule) && $xoopsModule->getVar('dirname') == $repmodule && $xoopsModule->getVar('isactive'))) {
82
-            if (isset($xoopsModuleConfig[$option])) {
83
-                $retval = $xoopsModuleConfig[$option];
84
-            }
85
-        } else {
86
-            $module_handler = xoops_getHandler('module');
87
-            $module         = $module_handler->getByDirname($repmodule);
88
-            $config_handler = xoops_getHandler('config');
89
-            if ($module) {
90
-                $moduleConfig = $config_handler->getConfigsByCat(0, $module->getVar('mid'));
91
-                if (isset($moduleConfig[$option])) {
92
-                    $retval = $moduleConfig[$option];
93
-                }
94
-            }
95
-        }
96
-        $options[$option] = $retval;
97
-
98
-        return $retval;
99
-    }
100
-
101
-    /**
102
-     * Is Xoops 2.3.x ?
103
-     *
104
-     * @return boolean need to say it ?
105
-     */
106
-    public static function isX23()
107
-    {
108
-        $x23 = false;
109
-        $xv  = str_replace('XOOPS ', '', XOOPS_VERSION);
110
-        if ((int)substr($xv, 2, 1) >= 3) {
111
-            $x23 = true;
112
-        }
113
-
114
-        return $x23;
115
-    }
116
-
117
-    /**
118
-     * Retreive an editor according to the module's option "form_options"
119
-     *
120
-     * @param  string $caption Caption to give to the editor
121
-     * @param  string $name    Editor's name
122
-     * @param  string $value   Editor's value
123
-     * @param  string $width   Editor's width
124
-     * @param  string $height  Editor's height
125
-     * @param string  $supplemental
126
-     * @return object The editor to use
127
-     */
128
-    public static function getWysiwygForm($caption, $name, $value = '', $width = '100%', $height = '400px', $supplemental = '')
129
-    {
130
-        $editor                   = false;
131
-        $editor_configs           = array();
132
-        $editor_configs['name']   = $name;
133
-        $editor_configs['value']  = $value;
134
-        $editor_configs['rows']   = 35;
135
-        $editor_configs['cols']   = 60;
136
-        $editor_configs['width']  = '100%';
137
-        $editor_configs['height'] = '400px';
138
-
139
-        $editor_option = strtolower(self::getModuleOption('form_options'));
140
-
141
-        if (self::isX23()) {
142
-            $editor = new XoopsFormEditor($caption, $editor_option, $editor_configs);
143
-
144
-            return $editor;
145
-        }
146
-
147
-        // Only for Xoops 2.0.x
148
-        switch ($editor_option) {
149
-            case 'fckeditor':
150
-                if (is_readable(XOOPS_ROOT_PATH . '/class/fckeditor/formfckeditor.php')) {
151
-                    require_once(XOOPS_ROOT_PATH . '/class/fckeditor/formfckeditor.php');
152
-                    $editor = new XoopsFormFckeditor($caption, $name, $value);
153
-                }
154
-                break;
155
-
156
-            case 'htmlarea':
157
-                if (is_readable(XOOPS_ROOT_PATH . '/class/htmlarea/formhtmlarea.php')) {
158
-                    require_once(XOOPS_ROOT_PATH . '/class/htmlarea/formhtmlarea.php');
159
-                    $editor = new XoopsFormHtmlarea($caption, $name, $value);
160
-                }
161
-                break;
162
-
163
-            case 'dhtmltextarea':
164
-                $editor = new XoopsFormDhtmlTextArea($caption, $name, $value, 10, 50, $supplemental);
165
-                break;
166
-
167
-            case 'textarea':
168
-                $editor = new XoopsFormTextArea($caption, $name, $value);
169
-                break;
170
-
171
-            case 'tinyeditor':
172
-            case 'tinymce':
173
-                if (is_readable(XOOPS_ROOT_PATH . '/class/xoopseditor/tinyeditor/formtinyeditortextarea.php')) {
174
-                    require_once XOOPS_ROOT_PATH . '/class/xoopseditor/tinyeditor/formtinyeditortextarea.php';
175
-                    $editor = new XoopsFormTinyeditorTextArea(array('caption' => $caption, 'name' => $name, 'value' => $value, 'width' => '100%', 'height' => '400px'));
176
-                }
177
-                break;
178
-
179
-            case 'koivi':
180
-                if (is_readable(XOOPS_ROOT_PATH . '/class/wysiwyg/formwysiwygtextarea.php')) {
181
-                    require_once(XOOPS_ROOT_PATH . '/class/wysiwyg/formwysiwygtextarea.php');
182
-                    $editor = new XoopsFormWysiwygTextArea($caption, $name, $value, $width, $height, '');
183
-                }
184
-                break;
185
-        }
186
-        if (!is_object($editor)) {
187
-            trigger_error('Error, impossible to get the requested text editor', E_USER_ERROR);
188
-        }
189
-
190
-        return $editor;
191
-    }
192
-
193
-    /**
194
-     * Create (in a link) a javascript confirmation's box
195
-     *
196
-     * @param  string  $message Message to display
197
-     * @param  boolean $form    Is this a confirmation for a form ?
198
-     * @return string  the javascript code to insert in the link (or in the form)
199
-     */
200
-    public static function javascriptLinkConfirm($message, $form = false)
201
-    {
202
-        if (!$form) {
203
-            return "onclick=\"javascript:return confirm('" . str_replace("'", ' ', $message) . "')\"";
204
-        } else {
205
-            return "onSubmit=\"javascript:return confirm('" . str_replace("'", ' ', $message) . "')\"";
206
-        }
207
-    }
208
-
209
-    /**
210
-     * Get current user IP
211
-     *
212
-     * @return string IP address (format Ipv4)
213
-     */
214
-    public static function IP()
215
-    {
216
-        $proxy_ip = '';
217
-        if (!empty($_SERVER['HTTP_X_FORWARDED_FOR'])) {
218
-            $proxy_ip = $_SERVER['HTTP_X_FORWARDED_FOR'];
219
-        } elseif (!empty($_SERVER['HTTP_X_FORWARDED'])) {
220
-            $proxy_ip = $_SERVER['HTTP_X_FORWARDED'];
221
-        } elseif (!empty($_SERVER['HTTP_FORWARDED_FOR'])) {
222
-            $proxy_ip = $_SERVER['HTTP_FORWARDED_FOR'];
223
-        } elseif (!empty($_SERVER['HTTP_FORWARDED'])) {
224
-            $proxy_ip = $_SERVER['HTTP_FORWARDED'];
225
-        } elseif (!empty($_SERVER['HTTP_VIA'])) {
226
-            $proxy_ip = $_SERVER['HTTP_VIA'];
227
-        } elseif (!empty($_SERVER['HTTP_X_COMING_FROM'])) {
228
-            $proxy_ip = $_SERVER['HTTP_X_COMING_FROM'];
229
-        } elseif (!empty($_SERVER['HTTP_COMING_FROM'])) {
230
-            $proxy_ip = $_SERVER['HTTP_COMING_FROM'];
231
-        }
232
-        $regs = array();
233
-        if (!empty($proxy_ip) && $is_ip = ereg('^([0-9]{1,3}\.){3,3}[0-9]{1,3}', $proxy_ip, $regs) && count($regs) > 0) {
234
-            $the_IP = $regs[0];
235
-        } else {
236
-            $the_IP = $_SERVER['REMOTE_ADDR'];
237
-        }
238
-
239
-        return $the_IP;
240
-    }
241
-
242
-    /**
243
-     * Set the page's title, meta description and meta keywords
244
-     * Datas are supposed to be sanitized
245
-     *
246
-     * @param  string $pageTitle       Page's Title
247
-     * @param  string $metaDescription Page's meta description
248
-     * @param  string $metaKeywords    Page's meta keywords
249
-     * @return void
250
-     */
251
-    public static function setMetas($pageTitle = '', $metaDescription = '', $metaKeywords = '')
252
-    {
253
-        global $xoTheme, $xoTheme, $xoopsTpl;
254
-        $xoopsTpl->assign('xoops_pagetitle', $pageTitle);
255
-        if (isset($xoTheme) && is_object($xoTheme)) {
256
-            if (!empty($metaKeywords)) {
257
-                $xoTheme->addMeta('meta', 'keywords', $metaKeywords);
258
-            }
259
-            if (!empty($metaDescription)) {
260
-                $xoTheme->addMeta('meta', 'description', $metaDescription);
261
-            }
262
-        } elseif (isset($xoopsTpl) && is_object($xoopsTpl)) {    // Compatibility for old Xoops versions
263
-            if (!empty($metaKeywords)) {
264
-                $xoopsTpl->assign('xoops_meta_keywords', $metaKeywords);
265
-            }
266
-            if (!empty($metaDescription)) {
267
-                $xoopsTpl->assign('xoops_meta_description', $metaDescription);
268
-            }
269
-        }
270
-    }
271
-
272
-    /**
273
-     * Send an email from a template to a list of recipients
274
-     *
275
-     * @param         $tplName
276
-     * @param  array  $recipients List of recipients
277
-     * @param  string $subject    Email's subject
278
-     * @param  array  $variables  Varirables to give to the template
279
-     * @return bool Result of the send
280
-     * @internal param string $tpl_name Template's name
281
-     */
282
-    public static function sendEmailFromTpl($tplName, $recipients, $subject, $variables)
283
-    {
284
-        global $xoopsConfig;
285
-        require_once XOOPS_ROOT_PATH . '/class/xoopsmailer.php';
286
-        if (!is_array($recipients)) {
287
-            if (trim($recipients) == '') {
288
-                return false;
289
-            }
290
-        } else {
291
-            if (count($recipients) == 0) {
292
-                return false;
293
-            }
294
-        }
295
-        if (function_exists('xoops_getMailer')) {
296
-            $xoopsMailer =& xoops_getMailer();
297
-        } else {
298
-            $xoopsMailer =& getMailer();
299
-        }
300
-
301
-        $xoopsMailer->useMail();
302
-        $xoopsMailer->setTemplateDir(XOOPS_ROOT_PATH . '/modules/' . self::MODULE_NAME . '/language/' . $xoopsConfig['language'] . '/mail_template');
303
-        $xoopsMailer->setTemplate($tplName);
304
-        $xoopsMailer->setToEmails($recipients);
305
-        // TODO: Change !
306
-        // $xoopsMailer->setFromEmail('[email protected]');
307
-        //$xoopsMailer->setFromName('MonSite');
308
-        $xoopsMailer->setSubject($subject);
309
-        foreach ($variables as $key => $value) {
310
-            $xoopsMailer->assign($key, $value);
311
-        }
312
-        $res = $xoopsMailer->send();
313
-        unset($xoopsMailer);
314
-        $filename = XOOPS_UPLOAD_PATH . '/logmail_' . self::MODULE_NAME . '.php';
315
-        if (!file_exists($filename)) {
316
-            $fp = @fopen($filename, 'a');
317
-            if ($fp) {
318
-                fwrite($fp, '<?php exit(); ?>');
319
-                fclose($fp);
320
-            }
321
-        }
322
-        $fp = @fopen($filename, 'a');
323
-
324
-        if ($fp) {
325
-            fwrite($fp, str_repeat('-', 120) . "\n");
326
-            fwrite($fp, date('d/m/Y H:i:s') . "\n");
327
-            fwrite($fp, 'Template name : ' . $tplName . "\n");
328
-            fwrite($fp, 'Email subject : ' . $subject . "\n");
329
-            if (is_array($recipients)) {
330
-                fwrite($fp, 'Recipient(s) : ' . implode(',', $recipients) . "\n");
331
-            } else {
332
-                fwrite($fp, 'Recipient(s) : ' . $recipients . "\n");
333
-            }
334
-            fwrite($fp, 'Transmited variables : ' . implode(',', $variables) . "\n");
335
-            fclose($fp);
336
-        }
337
-
338
-        return $res;
339
-    }
340
-
341
-    /**
342
-     * Remove module's cache
343
-     */
344
-    public static function updateCache()
345
-    {
346
-        global $xoopsModule;
347
-        $folder  = $xoopsModule->getVar('dirname');
348
-        $tpllist = array();
349
-        require_once XOOPS_ROOT_PATH . '/class/xoopsblock.php';
350
-        require_once XOOPS_ROOT_PATH . '/class/template.php';
351
-        $tplfile_handler = xoops_getHandler('tplfile');
352
-        $tpllist         = $tplfile_handler->find(null, null, null, $folder);
353
-        xoops_template_clear_module_cache($xoopsModule->getVar('mid'));            // Clear module's blocks cache
354
-
355
-        foreach ($tpllist as $onetemplate) {    // Remove cache for each page.
356
-            if ($onetemplate->getVar('tpl_type') === 'module') {
357
-                //  Note, I've been testing all the other methods (like the one of Smarty) and none of them run, that's why I have used this code
358
-                $files_del = array();
359
-                $files_del = glob(XOOPS_CACHE_PATH . '/*' . $onetemplate->getVar('tpl_file') . '*');
360
-                if (count($files_del) > 0 && is_array($files_del)) {
361
-                    foreach ($files_del as $one_file) {
362
-                        if (is_file($one_file)) {
363
-                            unlink($one_file);
364
-                        }
365
-                    }
366
-                }
367
-            }
368
-        }
369
-    }
370
-
371
-    /**
372
-     * Redirect user with a message
373
-     *
374
-     * @param string $message message to display
375
-     * @param string $url     The place where to go
376
-     * @param        integer  timeout Time to wait before to redirect
377
-     */
378
-    public static function redirect($message = '', $url = 'index.php', $time = 2)
379
-    {
380
-        redirect_header($url, $time, $message);
381
-        exit();
382
-    }
383
-
384
-    /**
385
-     * Internal function used to get the handler of the current module
386
-     *
387
-     * @return object The module
388
-     */
389
-    public static function getModule()
390
-    {
391
-        static $mymodule;
392
-        if (!isset($mymodule)) {
393
-            global $xoopsModule;
394
-            if (isset($xoopsModule) && is_object($xoopsModule) && $xoopsModule->getVar('dirname') == REFERENCES_DIRNAME) {
395
-                $mymodule =& $xoopsModule;
396
-            } else {
397
-                $hModule  = xoops_getHandler('module');
398
-                $mymodule = $hModule->getByDirname(REFERENCES_DIRNAME);
399
-            }
400
-        }
401
-
402
-        return $mymodule;
403
-    }
404
-
405
-    /**
406
-     * Returns the module's name (as defined by the user in the module manager) with cache
407
-     * @return string Module's name
408
-     */
409
-    public static function getModuleName()
410
-    {
411
-        static $moduleName;
412
-        if (!isset($moduleName)) {
413
-            $mymodule   = self::getModule();
414
-            $moduleName = $mymodule->getVar('name');
415
-        }
416
-
417
-        return $moduleName;
418
-    }
419
-
420
-    /**
421
-     * Create a title for the href tags inside html links
422
-     *
423
-     * @param  string $title Text to use
424
-     * @return string Formated text
425
-     */
426
-    public static function makeHrefTitle($title)
427
-    {
428
-        $s = "\"'";
429
-        $r = '  ';
430
-
431
-        return strtr($title, $s, $r);
432
-    }
433
-
434
-    /**
435
-     * Retourne la liste des utilisateurs appartenants � un groupe
436
-     *
437
-     * @param  int $groupId Searched group
438
-     * @return array Array of XoopsUsers
439
-     */
440
-    public static function getUsersFromGroup($groupId)
441
-    {
442
-        $users          = array();
443
-        $member_handler = xoops_getHandler('member');
444
-        $users          = $member_handler->getUsersByGroup($groupId, true);
445
-
446
-        return $users;
447
-    }
448
-
449
-    /**
450
-     * Retourne les ID des utilisateurs faisant partie de plusieurs groupes
451
-     * @param  array $groups Les ID des groupes dont on recherche les ID utilisateurs
452
-     * @return array Les ID utilisateurs
453
-     */
454
-    public static function getUsersIdsFromGroups($groups)
455
-    {
456
-        $usersIds       = array();
457
-        $member_handler = xoops_getHandler('member');
458
-        foreach ($groups as $groupId) {
459
-            $temporaryGroup = array();
460
-            $temporaryGroup = $member_handler->getUsersByGroup($groupId);
461
-            if (count($temporaryGroup) > 0) {
462
-                $usersIds = array_merge($usersIds, $temporaryGroup);
463
-            }
464
-        }
465
-
466
-        return array_unique($usersIds);
467
-    }
468
-
469
-    /**
470
-     * Retourne la liste des emails des utilisateurs membres d'un groupe
471
-     *
472
-     * @param $groupId
473
-     * @return array Emails list
474
-     * @internal param int $group_id Group's number
475
-     */
476
-    public static function getEmailsFromGroup($groupId)
477
-    {
478
-        $ret   = array();
479
-        $users = self::getUsersFromGroup($groupId);
480
-        foreach ($users as $user) {
481
-            $ret[] = $user->getVar('email');
482
-        }
483
-
484
-        return $ret;
485
-    }
486
-
487
-    /**
488
-     * V�rifie que l'utilisateur courant fait partie du groupe des administrateurs
489
-     *
490
-     * @return booleean Admin or not
491
-     */
492
-    public static function isAdmin()
493
-    {
494
-        global $xoopsUser, $xoopsModule;
495
-        if (is_object($xoopsUser)) {
496
-            if (in_array(XOOPS_GROUP_ADMIN, $xoopsUser->getGroups())) {
497
-                return true;
498
-            } elseif (isset($xoopsModule) && $xoopsUser->isAdmin($xoopsModule->getVar('mid'))) {
499
-                return true;
500
-            }
501
-        }
502
-
503
-        return false;
504
-    }
505
-
506
-    /**
507
-     * Returns the current date in the Mysql format
508
-     *
509
-     * @return string Date in the Mysql format
510
-     */
511
-    public static function getCurrentSQLDate()
512
-    {
513
-        return date('Y-m-d');    // 2007-05-02
514
-    }
515
-
516
-    public static function getCurrentSQLDateTime()
517
-    {
518
-        return date('Y-m-d H:i:s');    // 2007-05-02
519
-    }
520
-
521
-    /**
522
-     * Convert a Mysql date to the human's format
523
-     *
524
-     * @param  string $date The date to convert
525
-     * @param string  $format
526
-     * @return string The date in a human form
527
-     */
528
-    public static function SQLDateToHuman($date, $format = 'l')
529
-    {
530
-        if ($date != '0000-00-00' && xoops_trim($date) != '') {
531
-            return formatTimestamp(strtotime($date), $format);
532
-        } else {
533
-            return '';
534
-        }
535
-    }
536
-
537
-    /**
538
-     * Convert a timestamp to a Mysql date
539
-     *
540
-     * @param  integer $timestamp The timestamp to use
541
-     * @return string  The date in the Mysql format
542
-     */
543
-    public static function timestampToMysqlDate($timestamp)
544
-    {
545
-        return date('Y-m-d', (int)$timestamp);
546
-    }
547
-
548
-    /**
549
-     * Conversion d'un dateTime Mysql en date lisible en fran�ais
550
-     * @param $dateTime
551
-     * @return bool|string
552
-     */
553
-    public static function sqlDateTimeToFrench($dateTime)
554
-    {
555
-        return date('d/m/Y H:i:s', strtotime($dateTime));
556
-    }
557
-
558
-    /**
559
-     * Convert a timestamp to a Mysql datetime form
560
-     * @param  integer $timestamp The timestamp to use
561
-     * @return string  The date and time in the Mysql format
562
-     */
563
-    public static function timestampToMysqlDateTime($timestamp)
564
-    {
565
-        return date('Y-m-d H:i:s', $timestamp);
566
-    }
567
-
568
-    /**
569
-     * This function indicates if the current Xoops version needs to add asterisks to required fields in forms
570
-     *
571
-     * @return boolean Yes = we need to add them, false = no
572
-     */
573
-    public static function needsAsterisk()
574
-    {
575
-        if (self::isX23()) {
576
-            return false;
577
-        }
578
-        if (strpos(strtolower(XOOPS_VERSION), 'impresscms') !== false) {
579
-            return false;
580
-        }
581
-        if (strpos(strtolower(XOOPS_VERSION), 'legacy') === false) {
582
-            $xv = xoops_trim(str_replace('XOOPS ', '', XOOPS_VERSION));
583
-            if ((int)substr($xv, 4, 2) >= 17) {
584
-                return false;
585
-            }
586
-        }
587
-
588
-        return true;
589
-    }
590
-
591
-    /**
592
-     * Mark the mandatory fields of a form with a star
593
-     *
594
-     * @param  object $sform The form to modify
595
-     * @return object The modified form
596
-     * @internal param string $caracter The character to use to mark fields
597
-     */
598
-    public static function &formMarkRequiredFields(&$sform)
599
-    {
600
-        if (self::needsAsterisk()) {
601
-            $required = array();
602
-            foreach ($sform->getRequired() as $item) {
603
-                $required[] = $item->_name;
604
-            }
605
-            $elements = array();
606
-            $elements = &$sform->getElements();
607
-            $cnt      = count($elements);
608
-            for ($i = 0; $i < $cnt; ++$i) {
609
-                if (is_object($elements[$i]) && in_array($elements[$i]->_name, $required)) {
610
-                    $elements[$i]->_caption .= ' *';
611
-                }
612
-            }
613
-        }
614
-
615
-        return $sform;
616
-    }
617
-
618
-    /**
619
-     * Create an html heading (from h1 to h6)
620
-     *
621
-     * @param  string  $title The text to use
622
-     * @param  integer $level Level to return
623
-     * @return string  The heading
624
-     */
625
-    public static function htitle($title = '', $level = 1)
626
-    {
627
-        printf('<h%01d>%s</h%01d>', $level, $title, $level);
628
-    }
629
-
630
-    /**
631
-     * Create a unique upload filename
632
-     *
633
-     * @param  string  $folder   The folder where the file will be saved
634
-     * @param  string  $fileName Original filename (coming from the user)
635
-     * @param  boolean $trimName Do we need to create a short unique name ?
636
-     * @return string  The unique filename to use (with its extension)
637
-     */
638
-    public static function createUploadName($folder, $fileName, $trimName = false)
639
-    {
640
-        $workingfolder = $folder;
641
-        if (substr($workingfolder, strlen($workingfolder) - 1, 1) !== '/') {
642
-            $workingfolder .= '/';
643
-        }
644
-        $ext  = basename($fileName);
645
-        $ext  = explode('.', $ext);
646
-        $ext  = '.' . $ext[count($ext) - 1];
647
-        $true = true;
648
-        while ($true) {
649
-            $ipbits = explode('.', $_SERVER['REMOTE_ADDR']);
650
-            list($usec, $sec) = explode(' ', microtime());
651
-            $usec = (integer)($usec * 65536);
652
-            $sec  = ((integer)$sec) & 0xFFFF;
653
-
654
-            if ($trimName) {
655
-                $uid = sprintf('%06x%04x%04x', ($ipbits[0] << 24) | ($ipbits[1] << 16) | ($ipbits[2] << 8) | $ipbits[3], $sec, $usec);
656
-            } else {
657
-                $uid = sprintf('%08x-%04x-%04x', ($ipbits[0] << 24) | ($ipbits[1] << 16) | ($ipbits[2] << 8) | $ipbits[3], $sec, $usec);
658
-            }
659
-            if (!file_exists($workingfolder . $uid . $ext)) {
660
-                $true = false;
661
-            }
662
-        }
663
-
664
-        return $uid . $ext;
665
-    }
666
-
667
-    /**
668
-     * Replace html entities with their ASCII equivalent
669
-     *
670
-     * @param  string $chaine The string undecode
671
-     * @return string The undecoded string
672
-     */
673
-    public static function unhtml($chaine)
674
-    {
675
-        $search = $replace = array();
676
-        $chaine = html_entity_decode($chaine);
677
-
678
-        for ($i = 0; $i <= 255; ++$i) {
679
-            $search[]  = '&#' . $i . ';';
680
-            $replace[] = chr($i);
681
-        }
682
-        $replace[]='...'; $search[]='…';
683
-        $replace[]="'"; $search[]='‘';
684
-        $replace[]="'"; $search[]= '’';
685
-        $replace[]='-'; $search[] = '&bull;';   // $replace[] = '•';
686
-        $replace[]='—'; $search[]='&mdash;';
687
-        $replace[]='-'; $search[]='&ndash;';
688
-        $replace[]='-'; $search[]='&shy;';
689
-        $replace[]='"'; $search[]='&quot;';
690
-        $replace[]='&'; $search[]='&amp;';
691
-        $replace[]='ˆ'; $search[]='&circ;';
692
-        $replace[]='¡'; $search[]='&iexcl;';
693
-        $replace[]='¦'; $search[]='&brvbar;';
694
-        $replace[]='¨'; $search[]='&uml;';
695
-        $replace[]='¯'; $search[]='&macr;';
696
-        $replace[]='´'; $search[]='&acute;';
697
-        $replace[]='¸'; $search[]='&cedil;';
698
-        $replace[]='¿'; $search[]='&iquest;';
699
-        $replace[]='˜'; $search[]='&tilde;';
700
-        $replace[]="'"; $search[]='&lsquo;';    // $replace[]='‘';
701
-        $replace[]="'"; $search[]='&rsquo;';    // $replace[]='’';
702
-        $replace[]='‚'; $search[]='&sbquo;';
703
-        $replace[]="'"; $search[]='&ldquo;';    // $replace[]='“';
704
-        $replace[]="'"; $search[]='&rdquo;';    // $replace[]='”';
705
-        $replace[]='„'; $search[]='&bdquo;';
706
-        $replace[]='‹'; $search[]='&lsaquo;';
707
-        $replace[]='›'; $search[]='&rsaquo;';
708
-        $replace[]='<'; $search[]='&lt;';
709
-        $replace[]='>'; $search[]='&gt;';
710
-        $replace[]='±'; $search[]='&plusmn;';
711
-        $replace[]='«'; $search[]='&laquo;';
712
-        $replace[]='»'; $search[]='&raquo;';
713
-        $replace[]='×'; $search[]='&times;';
714
-        $replace[]='÷'; $search[]='&divide;';
715
-        $replace[]='¢'; $search[]='&cent;';
716
-        $replace[]='£'; $search[]='&pound;';
717
-        $replace[]='¤'; $search[]='&curren;';
718
-        $replace[]='¥'; $search[]='&yen;';
719
-        $replace[]='§'; $search[]='&sect;';
720
-        $replace[]='©'; $search[]='&copy;';
721
-        $replace[]='¬'; $search[]='&not;';
722
-        $replace[]='®'; $search[]='&reg;';
723
-        $replace[]='°'; $search[]='&deg;';
724
-        $replace[]='µ'; $search[]='&micro;';
725
-        $replace[]='¶'; $search[]='&para;';
726
-        $replace[]='·'; $search[]='&middot;';
727
-        $replace[]='†'; $search[]='&dagger;';
728
-        $replace[]='‡'; $search[]='&Dagger;';
729
-        $replace[]='‰'; $search[]='&permil;';
730
-        $replace[]='Euro'; $search[]='&euro;';      // $replace[]='€'
731
-        $replace[]='¼'; $search[]='&frac14;';
732
-        $replace[]='½'; $search[]='&frac12;';
733
-        $replace[]='¾'; $search[]='&frac34;';
734
-        $replace[]='¹'; $search[]='&sup1;';
735
-        $replace[]='²'; $search[]='&sup2;';
736
-        $replace[]='³'; $search[]='&sup3;';
737
-        $replace[]='á'; $search[]='&aacute;';
738
-        $replace[]='Á'; $search[]='&Aacute;';
739
-        $replace[]='â'; $search[]='&acirc;';
740
-        $replace[]='Â'; $search[]='&Acirc;';
741
-        $replace[]='à'; $search[]='&agrave;';
742
-        $replace[]='À'; $search[]='&Agrave;';
743
-        $replace[]='å'; $search[]='&aring;';
744
-        $replace[]='Å'; $search[]='&Aring;';
745
-        $replace[]='ã'; $search[]='&atilde;';
746
-        $replace[]='Ã'; $search[]='&Atilde;';
747
-        $replace[]='ä'; $search[]='&auml;';
748
-        $replace[]='Ä'; $search[]='&Auml;';
749
-        $replace[]='ª'; $search[]='&ordf;';
750
-        $replace[]='æ'; $search[]='&aelig;';
751
-        $replace[]='Æ'; $search[]='&AElig;';
752
-        $replace[]='ç'; $search[]='&ccedil;';
753
-        $replace[]='Ç'; $search[]='&Ccedil;';
754
-        $replace[]='ð'; $search[]='&eth;';
755
-        $replace[]='Ð'; $search[]='&ETH;';
756
-        $replace[]='é'; $search[]='&eacute;';
757
-        $replace[]='É'; $search[]='&Eacute;';
758
-        $replace[]='ê'; $search[]='&ecirc;';
759
-        $replace[]='Ê'; $search[]='&Ecirc;';
760
-        $replace[]='è'; $search[]='&egrave;';
761
-        $replace[]='È'; $search[]='&Egrave;';
762
-        $replace[]='ë'; $search[]='&euml;';
763
-        $replace[]='Ë'; $search[]='&Euml;';
764
-        $replace[]='ƒ'; $search[]='&fnof;';
765
-        $replace[]='í'; $search[]='&iacute;';
766
-        $replace[]='Í'; $search[]='&Iacute;';
767
-        $replace[]='î'; $search[]='&icirc;';
768
-        $replace[]='Î'; $search[]='&Icirc;';
769
-        $replace[]='ì'; $search[]='&igrave;';
770
-        $replace[]='Ì'; $search[]='&Igrave;';
771
-        $replace[]='ï'; $search[]='&iuml;';
772
-        $replace[]='Ï'; $search[]='&Iuml;';
773
-        $replace[]='ñ'; $search[]='&ntilde;';
774
-        $replace[]='Ñ'; $search[]='&Ntilde;';
775
-        $replace[]='ó'; $search[]='&oacute;';
776
-        $replace[]='Ó'; $search[]='&Oacute;';
777
-        $replace[]='ô'; $search[]='&ocirc;';
778
-        $replace[]='Ô'; $search[]='&Ocirc;';
779
-        $replace[]='ò'; $search[]='&ograve;';
780
-        $replace[]='Ò'; $search[]='&Ograve;';
781
-        $replace[]='º'; $search[]='&ordm;';
782
-        $replace[]='ø'; $search[]='&oslash;';
783
-        $replace[]='Ø'; $search[]='&Oslash;';
784
-        $replace[]='õ'; $search[]='&otilde;';
785
-        $replace[]='Õ'; $search[]='&Otilde;';
786
-        $replace[]='ö'; $search[]='&ouml;';
787
-        $replace[]='Ö'; $search[]='&Ouml;';
788
-        $replace[]='œ'; $search[]='&oelig;';
789
-        $replace[]='Œ'; $search[]='&OElig;';
790
-        $replace[]='š'; $search[]='&scaron;';
791
-        $replace[]='Š'; $search[]='&Scaron;';
792
-        $replace[]='ß'; $search[]='&szlig;';
793
-        $replace[]='þ'; $search[]='&thorn;';
794
-        $replace[]='Þ'; $search[]='&THORN;';
795
-        $replace[]='ú'; $search[]='&uacute;';
796
-        $replace[]='Ú'; $search[]='&Uacute;';
797
-        $replace[]='û'; $search[]='&ucirc;';
798
-        $replace[]='Û'; $search[]='&Ucirc;';
799
-        $replace[]='ù'; $search[]='&ugrave;';
800
-        $replace[]='Ù'; $search[]='&Ugrave;';
801
-        $replace[]='ü'; $search[]='&uuml;';
802
-        $replace[]='Ü'; $search[]='&Uuml;';
803
-        $replace[]='ý'; $search[]='&yacute;';
804
-        $replace[]='Ý'; $search[]='&Yacute;';
805
-        $replace[]='ÿ'; $search[]='&yuml;';
806
-        $replace[]='Ÿ'; $search[]='&Yuml;';
807
-        $chaine    = str_replace($search, $replace, $chaine);
808
-
809
-        return $chaine;
810
-    }
811
-
812
-    /**
813
-     * Création d'une titre pour être utilisé par l'url rewriting
814
-     *
815
-     * @param string  $content  Le texte à utiliser pour créer l'url
816
-     * @param integer $urw      La limite basse pour créer les mots
817
-     * @return string Le texte à utiliser pour l'url
818
-     *                          Note, some parts are from Solo's code
819
-     */
820
-    public static function makeSeoUrl($content, $urw = 1)
821
-    {
822
-        $s       = "ÀÁÂÃÄÅÒÓÔÕÖØÈÉÊËÇÌÍÎÏÙÚÛÜŸÑàáâãäåòóôõöøèéêëçìíîïùúûüÿñ '()";
823
-        $r       = 'AAAAAAOOOOOOEEEECIIIIUUUUYNaaaaaaooooooeeeeciiiiuuuuyn----';
824
-        $content = self::unhtml($content);    // First, remove html entities
825
-        $content = strtr($content, $s, $r);
826
-        $content = strip_tags($content);
827
-        $content = strtolower($content);
828
-        $content = htmlentities($content);    // TODO: Vérifier
829
-        $content = preg_replace('/&([a-zA-Z])(uml|acute|grave|circ|tilde);/', '$1', $content);
830
-        $content = html_entity_decode($content);
831
-        $content = eregi_replace('quot', ' ', $content);
832
-        $content = eregi_replace("'", ' ', $content);
833
-        $content = eregi_replace('-', ' ', $content);
834
-        $content = eregi_replace('[[:punct:]]', '', $content);
835
-        // Selon option mais attention au fichier .htaccess !
836
-        // $content = eregi_replace('[[:digit:]]','', $content);
837
-        $content = preg_replace('/[^a-z|A-Z|0-9]/', '-', $content);
838
-
839
-        $words    = explode(' ', $content);
840
-        $keywords = '';
841
-        foreach ($words as $word) {
842
-            if (strlen($word) >= $urw) {
843
-                $keywords .= '-' . trim($word);
844
-            }
845
-        }
846
-        if (!$keywords) {
847
-            $keywords = '-';
848
-        }
849
-        // Supprime les tirets en double
850
-        $keywords = str_replace('---', '-', $keywords);
851
-        $keywords = str_replace('--', '-', $keywords);
852
-        // Supprime un éventuel tiret à la fin de la chaine
853
-        if (substr($keywords, strlen($keywords) - 1, 1) == '-') {
854
-            $keywords = substr($keywords, 0, strlen($keywords) - 1);
855
-        }
856
-
857
-        return $keywords;
858
-    }
859
-
860
-    /**
861
-     * Create the meta keywords based on the content
862
-     *
863
-     * @param  string $content Content from which we have to create metakeywords
864
-     * @return string The list of meta keywords
865
-     */
866
-    public static function createMetaKeywords($content)
867
-    {
868
-        $keywordscount = REFERENCES_METAGEN_MAX_KEYWORDS;
869
-        $keywordsorder = REFERENCES_METAGEN_KEYWORDS_ORDER;
870
-
871
-        $tmp = array();
872
-        // Search for the "Minimum keyword length"
873
-        // TODO: Remplacer references_keywords_limit par une constante
874
-        if (isset($_SESSION['references_keywords_limit'])) {
875
-            $limit = $_SESSION['references_keywords_limit'];
876
-        } else {
877
-            $config_handler                        = xoops_getHandler('config');
878
-            $xoopsConfigSearch                     =& $config_handler->getConfigsByCat(XOOPS_CONF_SEARCH);
879
-            $limit                                 = $xoopsConfigSearch['keyword_min'];
880
-            $_SESSION['references_keywords_limit'] = $limit;
881
-        }
882
-        $myts            = MyTextSanitizer::getInstance();
883
-        $content         = str_replace('<br>', ' ', $content);
884
-        $content         = $myts->undoHtmlSpecialChars($content);
885
-        $content         = strip_tags($content);
886
-        $content         = strtolower($content);
887
-        $search_pattern  = array('&nbsp;', "\t", "\r\n", "\r", "\n", ',', '.', "'", ';', ':', ')', '(', '"', '?', '!', '{', '}', '[', ']', '<', '>', '/', '+', '-', '_', '\\', '*');
888
-        $replace_pattern = array(' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', '', '', '', '', '', '', '', '', '', '', '', '', '', '', '', '', '', '', '');
889
-        $content         = str_replace($search_pattern, $replace_pattern, $content);
890
-        $keywords        = explode(' ', $content);
891
-        switch ($keywordsorder) {
892
-            case 0:    // Ordre d'apparition dans le texte
893
-                $keywords = array_unique($keywords);
894
-                break;
895
-            case 1:    // Ordre de fréquence des mots
896
-                $keywords = array_count_values($keywords);
897
-                asort($keywords);
898
-                $keywords = array_keys($keywords);
899
-                break;
900
-            case 2:    // Ordre inverse de la fréquence des mots
901
-                $keywords = array_count_values($keywords);
902
-                arsort($keywords);
903
-                $keywords = array_keys($keywords);
904
-                break;
905
-        }
906
-        // Remove black listed words
907
-        if (xoops_trim(self::getModuleOption('metagen_blacklist')) != '') {
908
-            $metagen_blacklist = str_replace("\r", '', self::getModuleOption('metagen_blacklist'));
909
-            $metablack         = explode("\n", $metagen_blacklist);
910
-            array_walk($metablack, 'trim');
911
-            $keywords = array_diff($keywords, $metablack);
912
-        }
913
-
914
-        foreach ($keywords as $keyword) {
915
-            if (strlen($keyword) >= $limit && !is_numeric($keyword)) {
916
-                $tmp[] = $keyword;
917
-            }
918
-        }
919
-        $tmp = array_slice($tmp, 0, $keywordscount);
920
-        if (count($tmp) > 0) {
921
-            return implode(',', $tmp);
922
-        } else {
923
-            if (!isset($config_handler) || !is_object($config_handler)) {
924
-                $config_handler = xoops_getHandler('config');
925
-            }
926
-            $xoopsConfigMetaFooter =& $config_handler->getConfigsByCat(XOOPS_CONF_METAFOOTER);
927
-            if (isset($xoopsConfigMetaFooter['meta_keywords'])) {
928
-                return $xoopsConfigMetaFooter['meta_keywords'];
929
-            } else {
930
-                return '';
931
-            }
932
-        }
933
-    }
934
-
935
-    /**
936
-     * Fonction chargée de gérer l'upload
937
-     *
938
-     * @param integer $indice L'indice du fichier à télécharger
939
-     * @param string  $dstpath
940
-     * @param null    $mimeTypes
941
-     * @param null    $uploadMaxSize
942
-     * @param null    $maxWidth
943
-     * @param null    $maxHeight
944
-     * @return mixed True si l'upload s'est bien déroulé sinon le message d'erreur correspondant
945
-     */
946
-    public static function uploadFile($indice, $dstpath = XOOPS_UPLOAD_PATH, $mimeTypes = null, $uploadMaxSize = null, $maxWidth = null, $maxHeight = null)
947
-    {
948
-        require_once XOOPS_ROOT_PATH . '/class/uploader.php';
949
-        global $destname;
950
-        if (isset($_POST['xoops_upload_file'])) {
951
-            require_once XOOPS_ROOT_PATH . '/class/uploader.php';
952
-            $fldname = '';
953
-            $fldname = $_FILES[$_POST['xoops_upload_file'][$indice]];
954
-            $fldname = get_magic_quotes_gpc() ? stripslashes($fldname['name']) : $fldname['name'];
955
-            if (xoops_trim($fldname != '')) {
956
-                $destname = self::createUploadName($dstpath, $fldname, true);
957
-                if ($mimeTypes === null) {
958
-                    $permittedtypes = explode("\n", str_replace("\r", '', self::getModuleOption('mimetypes')));
959
-                    array_walk($permittedtypes, 'trim');
960
-                } else {
961
-                    $permittedtypes = $mimeTypes;
962
-                }
963
-                if ($uploadMaxSize === null) {
964
-                    $uploadSize = self::getModuleOption('maxuploadsize');
965
-                } else {
966
-                    $uploadSize = $uploadMaxSize;
967
-                }
968
-                $uploader = new XoopsMediaUploader($dstpath, $permittedtypes, $uploadSize, $maxWidth, $maxHeight);
969
-                //$uploader->allowUnknownTypes = true;
970
-                $uploader->setTargetFileName($destname);
971
-                if ($uploader->fetchMedia($_POST['xoops_upload_file'][$indice])) {
972
-                    if ($uploader->upload()) {
973
-                        return true;
974
-                    } else {
975
-                        return _ERRORS . ' ' . htmlentities($uploader->getErrors());
976
-                    }
977
-                } else {
978
-                    return htmlentities($uploader->getErrors());
979
-                }
980
-            } else {
981
-                return false;
982
-            }
983
-        } else {
984
-            return false;
985
-        }
986
-    }
987
-
988
-    /**
989
-     * Resize a Picture to some given dimensions (using the wideImage library)
990
-     *
991
-     * @param string  $src_path      Picture's source
992
-     * @param string  $dst_path      Picture's destination
993
-     * @param integer $param_width   Maximum picture's width
994
-     * @param integer $param_height  Maximum picture's height
995
-     * @param boolean $keep_original Do we have to keep the original picture ?
996
-     * @param string  $fit           Resize mode (see the wideImage library for more information)
997
-     * @return bool
998
-     */
999
-    public static function resizePicture($src_path, $dst_path, $param_width, $param_height, $keep_original = false, $fit = 'inside')
1000
-    {
1001
-        //        require_once self::MODULE_PATH . 'class/wideimage/WideImage.php';
1002
-        $img    = WideImage::load($src_path);
1003
-        $result = $img->resize($param_width, $param_height, $fit);
1004
-        $result->saveToFile($dst_path, null);
1005
-        if (!$keep_original) {
1006
-            @unlink($src_path);
1007
-        }
1008
-
1009
-        return true;
1010
-    }
1011
-
1012
-    /**
1013
-     * Déclenchement d'une alerte Xoops suite à un évènement
1014
-     *
1015
-     * @param string       $category La catégorie de l'évènement
1016
-     * @param integer      $itemId   L'ID de l'élément (trop général pour être décris précisément)
1017
-     * @param unknown_type $event    L'évènement qui est déclencé
1018
-     * @param unknown_type $tags     Les variables à passer au template
1019
-     */
1020
-    public static function notify($category, $itemId, $event, $tags)
1021
-    {
1022
-        $notification_handler = xoops_getHandler('notification');
1023
-        $tags['X_MODULE_URL'] = REFERENCES_URL;
1024
-        $notification_handler->triggerEvent($category, $itemId, $event, $tags);
1025
-    }
1026
-
1027
-    /**
1028
-     * Ajoute des jours à une date et retourne la nouvelle date au format Date de Mysql
1029
-     *
1030
-     * @param int     $duration
1031
-     * @param integer $startingDate Date de départ (timestamp)
1032
-     * @return bool|string
1033
-     * @internal param int $durations Durée en jours
1034
-     */
1035
-    public static function addDaysToDate($duration = 1, $startingDate = 0)
1036
-    {
1037
-        if ($startingDate == 0) {
1038
-            $startingDate = time();
1039
-        }
1040
-        $endingDate = $startingDate + ($duration * 86400);
1041
-
1042
-        return date('Y-m-d', $endingDate);
1043
-    }
1044
-
1045
-    /**
1046
-     * Retourne un breadcrumb en fonction des paramètres passés et en partant (d'office) de la racine du module
1047
-     *
1048
-     * @param array  $path  Le chemin complet (excepté la racine) du breadcrumb sous la forme clé=url valeur=titre
1049
-     * @param string $raquo Le séparateur par défaut à utiliser
1050
-     * @return string le breadcrumb
1051
-     */
1052
-    public static function breadcrumb($path, $raquo = ' &raquo; ')
1053
-    {
1054
-        $breadcrumb        = '';
1055
-        $workingBreadcrumb = array();
1056
-        if (is_array($path)) {
1057
-            $moduleName          = self::getModuleName();
1058
-            $workingBreadcrumb[] = "<a href='" . REFERENCES_URL . "' title='" . self::makeHrefTitle($moduleName) . "'>" . $moduleName . '</a>';
1059
-            foreach ($path as $url => $title) {
1060
-                $workingBreadcrumb[] = "<a href='" . $url . "'>" . $title . '</a>';
1061
-            }
1062
-            $cnt = count($workingBreadcrumb);
1063
-            for ($i = 0; $i < $cnt; ++$i) {
1064
-                if ($i == $cnt - 1) {
1065
-                    $workingBreadcrumb[$i] = strip_tags($workingBreadcrumb[$i]);
1066
-                }
1067
-            }
1068
-            $breadcrumb = implode($raquo, $workingBreadcrumb);
1069
-        }
1070
-
1071
-        return $breadcrumb;
1072
-    }
1073
-
1074
-    public static function close_tags($string)
1075
-    {
1076
-        // match opened tags
1077
-        if (preg_match_all('/<([a-z\:\-]+)[^\/]>/', $string, $start_tags)) {
1078
-            $start_tags = $start_tags[1];
1079
-
1080
-            // match closed tags
1081
-            if (preg_match_all('/<\/([a-z]+)>/', $string, $end_tags)) {
1082
-                $complete_tags = array();
1083
-                $end_tags      = $end_tags[1];
1084
-
1085
-                foreach ($start_tags as $key => $val) {
1086
-                    $posb = array_search($val, $end_tags);
1087
-                    if (is_int($posb)) {
1088
-                        unset($end_tags[$posb]);
1089
-                    } else {
1090
-                        $complete_tags[] = $val;
1091
-                    }
1092
-                }
1093
-            } else {
1094
-                $complete_tags = $start_tags;
1095
-            }
1096
-
1097
-            $complete_tags = array_reverse($complete_tags);
1098
-            for ($i = 0; $i < count($complete_tags); ++$i) {
1099
-                $string .= '</' . $complete_tags[$i] . '>';
1100
-            }
1101
-        }
1102
-
1103
-        return $string;
1104
-    }
1105
-
1106
-    public static function truncate_tagsafe($string, $length = 80, $etc = '...', $break_words = false)
1107
-    {
1108
-        if ($length == 0) {
1109
-            return '';
1110
-        }
1111
-
1112
-        if (strlen($string) > $length) {
1113
-            $length -= strlen($etc);
1114
-            if (!$break_words) {
1115
-                $string = preg_replace('/\s+?(\S+)?$/', '', substr($string, 0, $length + 1));
1116
-                $string = preg_replace('/<[^>]*$/', '', $string);
1117
-                $string = self::close_tags($string);
1118
-            }
1119
-
1120
-            return $string . $etc;
1121
-        } else {
1122
-            return $string;
1123
-        }
1124
-    }
1125
-
1126
-    /**
1127
-     * Create an infotip
1128
-     * @param $text
1129
-     * @return string
1130
-     */
1131
-    public static function makeInfotips($text)
1132
-    {
1133
-        $ret      = '';
1134
-        $infotips = self::getModuleOption('infotips');
1135
-        if ($infotips > 0) {
1136
-            $myts = MyTextSanitizer::getInstance();
1137
-            $ret  = $myts->htmlSpecialChars(substr(strip_tags($text), 0, $infotips));
1138
-        }
1139
-
1140
-        return $ret;
1141
-    }
1142
-
1143
-    /**
1144
-     * Retourne le type Mime d'un fichier en utilisant d'abord finfo puis mime_content
1145
-     *
1146
-     * @param string $filename Le fichier (avec son chemin d'accès complet) dont on veut connaître le type mime
1147
-     * @return string
1148
-     */
1149
-    public static function getMimeType($filename)
1150
-    {
1151
-        if (function_exists('finfo_open')) {
1152
-            $pathToMagic = REFERENCES_PATH . 'mime/magic';
1153
-            $finfo       = new finfo(FILEINFO_MIME, $pathToMagic);
1154
-            $mimetype    = $finfo->file($filename);
1155
-            finfo_close($finfo);
1156
-            unset($finfo);
1157
-
1158
-            return $mimetype;
1159
-        } else {
1160
-            if (function_exists('mime_content_type')) {
1161
-                return mime_content_type($filename);
1162
-            } else {
1163
-                return '';
1164
-            }
1165
-        }
1166
-    }
1167
-
1168
-    /**
1169
-     * Retourne une liste d'objets XoopsUsers à partir d'une liste d'identifiants
1170
-     *
1171
-     * @param  array $xoopsUsersIDs La liste des ID
1172
-     * @return array Les objets XoopsUsers
1173
-     */
1174
-    public static function getUsersFromIds($xoopsUsersIDs)
1175
-    {
1176
-        $users = array();
1177
-        if (is_array($xoopsUsersIDs) && count($xoopsUsersIDs) > 0) {
1178
-            $xoopsUsersIDs = array_unique($xoopsUsersIDs);
1179
-            sort($xoopsUsersIDs);
1180
-            if (count($xoopsUsersIDs) > 0) {
1181
-                $member_handler = xoops_getHandler('user');
1182
-                $criteria       = new Criteria('uid', '(' . implode(',', $xoopsUsersIDs) . ')', 'IN');
1183
-                $criteria->setSort('uid');
1184
-                $users = $member_handler->getObjects($criteria, true);
1185
-            }
1186
-        }
1187
-
1188
-        return $users;
1189
-    }
1190
-
1191
-    /**
1192
-     * Retourne l'ID de l'utilisateur courant (s'il est connecté)
1193
-     * @return integer L'uid ou 0
1194
-     */
1195
-    public static function getCurrentUserID()
1196
-    {
1197
-        global $xoopsUser;
1198
-        $uid = is_object($xoopsUser) ? $xoopsUser->getVar('uid') : 0;
1199
-
1200
-        return $uid;
1201
-    }
1202
-
1203
-    /**
1204
-     * Retourne la liste des groupes de l'utilisateur courant (avec cache)
1205
-     * @param int $uid
1206
-     * @return array Les ID des groupes auquel l'utilisateur courant appartient
1207
-     */
1208
-    public static function getMemberGroups($uid = 0)
1209
-    {
1210
-        static $buffer = array();
1211
-        if ($uid == 0) {
1212
-            $uid = self::getCurrentUserID();
1213
-        }
1214
-
1215
-        if (is_array($buffer) && count($buffer) > 0 && isset($buffer[$uid])) {
1216
-            return $buffer[$uid];
1217
-        } else {
1218
-            if ($uid > 0) {
1219
-                $member_handler = xoops_getHandler('member');
1220
-                $buffer[$uid]   = $member_handler->getGroupsByUser($uid, false);    // Renvoie un tableau d'ID (de groupes)
1221
-            } else {
1222
-                $buffer[$uid] = array(XOOPS_GROUP_ANONYMOUS);
1223
-            }
1224
-        }
1225
-
1226
-        return $buffer[$uid];
1227
-    }
1228
-
1229
-    /**
1230
-     * Indique si l'utilisateur courant fait partie d'une groupe donné (avec gestion de cache)
1231
-     *
1232
-     * @param integer $group Groupe recherché
1233
-     * @param int     $uid
1234
-     * @return bool vrai si l'utilisateur fait partie du groupe, faux sinon
1235
-     */
1236
-    public static function isMemberOfGroup($group = 0, $uid = 0)
1237
-    {
1238
-        static $buffer = array();
1239
-        $retval = false;
1240
-        if ($uid == 0) {
1241
-            $uid = self::getCurrentUserID();
1242
-        }
1243
-        if (is_array($buffer) && array_key_exists($group, $buffer)) {
1244
-            $retval = $buffer[$group];
1245
-        } else {
1246
-            $member_handler = xoops_getHandler('member');
1247
-            $groups         = $member_handler->getGroupsByUser($uid, false);    // Renvoie un tableau d'ID (de groupes)
1248
-            $retval         = in_array($group, $groups);
1249
-            $buffer[$group] = $retval;
1250
-        }
1251
-
1252
-        return $retval;
1253
-    }
1254
-
1255
-    /**
1256
-     * Indique si un utilisateur fait partie de plusieurs groupes
1257
-     * La fonction renvoie vrai dès qu'on trouve que le membre fait partir d'un des groupes
1258
-     * @param array    $groups La liste des groupes à vérifier
1259
-     * @param  integer $uid    L'ID de l'utilisateur
1260
-     * @return boolean
1261
-     */
1262
-    public static function isMemberOfGroups($groups, $uid = 0)
1263
-    {
1264
-        if (count($groups) == 0) {
1265
-            return false;
1266
-        }
1267
-        if ($uid == 0) {
1268
-            $uid = self::getCurrentUserID();
1269
-        }
1270
-        foreach ($groups as $groupId) {
1271
-            if (self::isMemberOfGroup($groupId, $uid)) {
1272
-                return true;
1273
-            }
1274
-        }
1275
-
1276
-        return false;
1277
-    }
1278
-
1279
-    /**
1280
-     * Retourne le nombre total de groupes (y compris les anonymes)
1281
-     */
1282
-    public static function getGroupsCount()
1283
-    {
1284
-        static $cache = -1;
1285
-        if ($cache == -1) {
1286
-            global $xoopsDB;
1287
-            $sql    = 'SELECT COUNT(*) FROM ' . $xoopsDB->prefix('groups');
1288
-            $result = $xoopsDB->query($sql);
1289
-            if (!$result) {
1290
-                return false;
1291
-            }
1292
-            list($cache) = $xoopsDB->fetchRow($result);
1293
-        }
1294
-
1295
-        return $cache;
1296
-    }
1297
-
1298
-    /**
1299
-     * Fonction chargée de vérifier qu'un répertoire existe, qu'on peut écrire dedans et création d'un fichier index.html
1300
-     *
1301
-     * @param string $folder Le chemin complet du répertoire à vérifier
1302
-     * @return void
1303
-     */
1304
-    public static function prepareFolder($folder)
1305
-    {
1306
-        if (!is_dir($folder)) {
1307
-            mkdir($folder, 0777);
1308
-            file_put_contents($folder . '/index.html', '<script>history.go(-1);</script>');
1309
-        } else {
1310
-            if (!is_writable($folder)) {
1311
-                chmod($folder, 0777);
1312
-            }
1313
-        }
1314
-    }
1315
-
1316
-    /**
1317
-     * Load a language file
1318
-     *
1319
-     * @param string $languageFile     The required language file
1320
-     * @param string $defaultExtension Default extension to use
1321
-     */
1322
-    public static function loadLanguageFile($languageFile, $defaultExtension = '.php')
1323
-    {
1324
-        global $xoopsConfig;
1325
-        $root = self::MODULE_PATH;
1326
-        if (strstr($languageFile, $defaultExtension) === false) {
1327
-            $languageFile .= $defaultExtension;
1328
-        }
1329
-        if (file_exists($root . 'language' . DIRECTORY_SEPARATOR . $xoopsConfig['language'] . DIRECTORY_SEPARATOR . $languageFile)) {
1330
-            require_once $root . 'language' . DIRECTORY_SEPARATOR . $xoopsConfig['language'] . DIRECTORY_SEPARATOR . $languageFile;
1331
-        } else {    // Fallback
1332
-            require_once $root . 'language' . DIRECTORY_SEPARATOR . 'english' . DIRECTORY_SEPARATOR . $languageFile;
1333
-        }
1334
-    }
1335
-
1336
-    /**
1337
-     * Création d'une vignette en tenant compte des options du module concernant le mode de création des vignettes
1338
-     *
1339
-     * @param  string  $src_path
1340
-     * @param  string  $dst_path
1341
-     * @param  integer $param_width
1342
-     * @param  integer $param_height
1343
-     * @param  boolean $keep_original
1344
-     * @param string   $fit Utilisé uniquement pour la méthode 0 (redimensionnement)
1345
-     * @return boolean
1346
-     */
1347
-    public static function createThumb($src_path, $dst_path, $param_width, $param_height, $keep_original = false, $fit = 'inside')
1348
-    {
1349
-        //        require_once self::MODULE_PATH . 'class/wideimage/WideImage.php';
1350
-        $resize = true;
1351
-        // On commence par vérifier que l'image originale n'est pas plus petite que les dimensions demandées auquel cas il n'y a rien à faire
1352
-        $pictureDimensions = getimagesize($src_path);
1353
-        if (is_array($pictureDimensions)) {
1354
-            $pictureWidth  = $pictureDimensions[0];
1355
-            $pictureHeight = $pictureDimensions[1];
1356
-            if ($pictureWidth < $param_width && $pictureHeight < $param_height) {
1357
-                $resize = false;
1358
-            }
1359
-        }
1360
-        $img = WideImage::load($src_path);
1361
-        if ($resize) { // L'image est suffisament grande pour être réduite
1362
-            $thumbMethod = 0;
1363
-            if ($thumbMethod == 0) { // Redimensionnement de l'image
1364
-                $result = $img->resize($param_width, $param_height, $fit);
1365
-            } else { // Récupération d'une partie de l'image depuis le centre
1366
-                // Calcul de left et top
1367
-                $left = $top = 0;
1368
-                if (is_array($pictureDimensions)) {
1369
-                    if ($pictureWidth > $param_width) {
1370
-                        $left = (int)(($pictureWidth / 2) - ($param_width / 2));
1371
-                    }
1372
-                    if ($pictureHeight > $param_height) {
1373
-                        $top = (int)(($pictureHeight / 2) - ($param_height / 2));
1374
-                    }
1375
-                }
1376
-                $result = $img->crop($left, $top, $param_width, $param_height);
1377
-            }
1378
-            $result->saveToFile($dst_path, null);
1379
-        } else {
1380
-            if ($src_path != $dst_path) {
1381
-                @copy($src_path, $dst_path);
1382
-            }
1383
-        }
1384
-        if (!$keep_original) {
1385
-            @unlink($src_path);
1386
-        }
1387
-
1388
-        return true;
1389
-    }
1390
-
1391
-    /**
1392
-     * Create the <option> of an html select
1393
-     *
1394
-     * @param  array $array   Array of index and labels
1395
-     * @param  mixed $default the default value
1396
-     * @param bool   $withNull
1397
-     * @return string
1398
-     */
1399
-    private static function htmlSelectOptions($array, $default = 0, $withNull = true)
1400
-    {
1401
-        $ret      = array();
1402
-        $selected = '';
1403
-        if ($withNull) {
1404
-            if (!is_array($default)) {
1405
-                if ($default === 0) {
1406
-                    $selected = " selected = 'selected'";
1407
-                }
1408
-            } else {
1409
-                if (in_array(0, $default)) {
1410
-                    $selected = " selected = 'selected'";
1411
-                }
1412
-            }
1413
-            $ret[] = '<option value=0' . $selected . '>---</option>';
1414
-        }
1415
-
1416
-        foreach ($array as $index => $label) {
1417
-            $selected = '';
1418
-            if (!is_array($default)) {
1419
-                if ($index == $default) {
1420
-                    $selected = " selected = 'selected'";
1421
-                }
1422
-            } else {
1423
-                if (in_array($index, $default)) {
1424
-                    $selected = " selected = 'selected'";
1425
-                }
1426
-            }
1427
-            $ret[] = "<option value=\"" . $index . "\"" . $selected . '>' . $label . '</option>';
1428
-        }
1429
-
1430
-        return implode("\n", $ret);
1431
-    }
1432
-
1433
-    /**
1434
-     * Creates an html select an returns its code
1435
-     *
1436
-     * @param  string  $selectName Select's name
1437
-     * @param  array   $array      Key = value of each option, value = label of each option
1438
-     * @param  mixed   $default    Default's value
1439
-     * @param  boolean $withNull   Do we want a null option
1440
-     * @param  string  $style      Is there a style to apply ?
1441
-     * @param  boolean $multiple   Can we select multiple elements ?
1442
-     * @param  integer $size       Size of the selectbox, only used with multiple selectboxes
1443
-     * @param string   $extra
1444
-     * @return string
1445
-     */
1446
-    public static function htmlSelect($selectName, $array, $default, $withNull = true, $style = '', $multiple = false, $size = 1, $extra = '')
1447
-    {
1448
-        $ret = '';
1449
-        $ret .= "<select name='" . $selectName . "' id='" . $selectName . "'";
1450
-        if (xoops_trim($style) != '') {
1451
-            $ret .= " style='" . $style . "' ";
1452
-        }
1453
-        if (xoops_trim($multiple) != '') {
1454
-            $ret .= " multiple = 'multiple' size='" . $size . "' ";
1455
-        }
1456
-        $ret .= $extra . ">\n";
1457
-        $ret .= self::htmlSelectOptions($array, $default, $withNull);
1458
-        $ret .= "</select>\n";
1459
-
1460
-        return $ret;
1461
-    }
1462
-
1463
-    /**
1464
-     * Verify that a mysql table exists
1465
-     * @param $tablename
1466
-     * @return bool
1467
-     */
1468
-    public static function tableExists($tablename)
1469
-    {
1470
-        global $xoopsDB;
1471
-        $result = $xoopsDB->queryF("SHOW TABLES LIKE '$tablename'");
1472
-
1473
-        return ($xoopsDB->getRowsNum($result) > 0);
1474
-    }
1475
-
1476
-    /**
1477
-     * Verify that a field exists inside a mysql table
1478
-     * @param $fieldname
1479
-     * @param $table
1480
-     * @return bool
1481
-     */
1482
-    public static function fieldExists($fieldname, $table)
1483
-    {
1484
-        global $xoopsDB;
1485
-        $result = $xoopsDB->queryF("SHOW COLUMNS FROM $table LIKE '$fieldname'");
1486
-
1487
-        return ($xoopsDB->getRowsNum($result) > 0);
1488
-    }
1489
-
1490
-    /**
1491
-     * Retourne la définition d'un champ
1492
-     *
1493
-     * @param  string $fieldname
1494
-     * @param  string $table
1495
-     * @return array
1496
-     */
1497
-    public static function getFieldDefinition($fieldname, $table)
1498
-    {
1499
-        global $xoopsDB;
1500
-        $result = $xoopsDB->queryF("SHOW COLUMNS FROM $table LIKE '$fieldname'");
1501
-        if ($result) {
1502
-            return $xoopsDB->fetchArray($result);
1503
-        }
1504
-
1505
-        return '';
1506
-    }
1507
-
1508
-    /**
1509
-     * Add a field to a mysql table
1510
-     * @param $field
1511
-     * @param $table
1512
-     * @return resource
1513
-     */
1514
-    public static function addField($field, $table)
1515
-    {
1516
-        global $xoopsDB;
1517
-        $result = $xoopsDB->queryF("ALTER TABLE $table ADD $field;");
1518
-
1519
-        return $result;
1520
-    }
1521
-
1522
-    /**
1523
-     * Maintenance des tables du module et de son cache de requêtes
1524
-     *
1525
-     * @return void
1526
-     */
1527
-    public static function maintainTablesCache()
1528
-    {
1529
-        global $xoopsDB;
1530
-        define('REFERENCES_MAINTAIN', true);
1531
-        require self::MODULE_PATH . 'xoops_version.php';
1532
-        $tables = array();
1533
-        foreach ($modversion['tables'] as $table) {
1534
-            $tables[] = $xoopsDB->prefix($table);
1535
-        }
1536
-        if (count($tables) > 0) {
1537
-            $list = implode(',', $tables);
1538
-            $xoopsDB->queryF('CHECK TABLE ' . $list);
1539
-            $xoopsDB->queryF('ANALYZE TABLE ' . $list);
1540
-            $xoopsDB->queryF('OPTIMIZE TABLE ' . $list);
1541
-        }
1542
-        self::updateCache();
1543
-        $handlers = references_handler::getInstance();
1544
-        $handlers->h_references_articles->forceCacheClean();
1545
-    }
1546
-
1547
-    /**
1548
-     * Indique si le module Tag existe et est activé
1549
-     *
1550
-     * @return boolean
1551
-     * @credit: smartfactory
1552
-     */
1553
-    public static function tagModuleExists()
1554
-    {
1555
-        static $moduleExistsAndIsActive;
1556
-        if (!isset($moduleExistsAndIsActive)) {
1557
-            $modules_handler = xoops_getHandler('module');
1558
-            $tagModule       = $modules_handler->getByDirName('tag');
1559
-            if (!$tagModule) {
1560
-                $moduleExistsAndIsActive = false;
1561
-            } else {
1562
-                $moduleExistsAndIsActive = $tagModule->getVar('isactive') == 1;
1563
-            }
1564
-        }
1565
-
1566
-        return $moduleExistsAndIsActive;
1567
-    }
39
+	// Pour la portabilité de module à module
40
+	const MODULE_NAME    = 'references';
41
+	const MODULE_DIRNAME = REFERENCES_DIRNAME;
42
+	const MODULE_PATH    = REFERENCES_PATH;
43
+	const MODULE_URL     = REFERENCES_URL;
44
+	const MODULE_JS_URL  = REFERENCES_JS_URL;
45
+
46
+	/**
47
+	 * Access the only instance of this class
48
+	 *
49
+	 * @return object
50
+	 *
51
+	 * @static
52
+	 * @staticvar   object
53
+	 */
54
+	public static function getInstance()
55
+	{
56
+		static $instance;
57
+		if (null === $instance) {
58
+			$instance = new static();
59
+		}
60
+
61
+		return $instance;
62
+	}
63
+
64
+	/**
65
+	 * Returns a module's option (with cache)
66
+	 *
67
+	 * @param  string  $option    module option's name
68
+	 * @param  boolean $withCache Do we have to use some cache ?
69
+	 * @return mixed   option's value
70
+	 */
71
+	public static function getModuleOption($option, $withCache = true)
72
+	{
73
+		global $xoopsModuleConfig, $xoopsModule;
74
+		$repmodule = self::MODULE_NAME;
75
+		static $options = array();
76
+		if (is_array($options) && array_key_exists($option, $options) && $withCache) {
77
+			return $options[$option];
78
+		}
79
+
80
+		$retval = false;
81
+		if (isset($xoopsModuleConfig) && (is_object($xoopsModule) && $xoopsModule->getVar('dirname') == $repmodule && $xoopsModule->getVar('isactive'))) {
82
+			if (isset($xoopsModuleConfig[$option])) {
83
+				$retval = $xoopsModuleConfig[$option];
84
+			}
85
+		} else {
86
+			$module_handler = xoops_getHandler('module');
87
+			$module         = $module_handler->getByDirname($repmodule);
88
+			$config_handler = xoops_getHandler('config');
89
+			if ($module) {
90
+				$moduleConfig = $config_handler->getConfigsByCat(0, $module->getVar('mid'));
91
+				if (isset($moduleConfig[$option])) {
92
+					$retval = $moduleConfig[$option];
93
+				}
94
+			}
95
+		}
96
+		$options[$option] = $retval;
97
+
98
+		return $retval;
99
+	}
100
+
101
+	/**
102
+	 * Is Xoops 2.3.x ?
103
+	 *
104
+	 * @return boolean need to say it ?
105
+	 */
106
+	public static function isX23()
107
+	{
108
+		$x23 = false;
109
+		$xv  = str_replace('XOOPS ', '', XOOPS_VERSION);
110
+		if ((int)substr($xv, 2, 1) >= 3) {
111
+			$x23 = true;
112
+		}
113
+
114
+		return $x23;
115
+	}
116
+
117
+	/**
118
+	 * Retreive an editor according to the module's option "form_options"
119
+	 *
120
+	 * @param  string $caption Caption to give to the editor
121
+	 * @param  string $name    Editor's name
122
+	 * @param  string $value   Editor's value
123
+	 * @param  string $width   Editor's width
124
+	 * @param  string $height  Editor's height
125
+	 * @param string  $supplemental
126
+	 * @return object The editor to use
127
+	 */
128
+	public static function getWysiwygForm($caption, $name, $value = '', $width = '100%', $height = '400px', $supplemental = '')
129
+	{
130
+		$editor                   = false;
131
+		$editor_configs           = array();
132
+		$editor_configs['name']   = $name;
133
+		$editor_configs['value']  = $value;
134
+		$editor_configs['rows']   = 35;
135
+		$editor_configs['cols']   = 60;
136
+		$editor_configs['width']  = '100%';
137
+		$editor_configs['height'] = '400px';
138
+
139
+		$editor_option = strtolower(self::getModuleOption('form_options'));
140
+
141
+		if (self::isX23()) {
142
+			$editor = new XoopsFormEditor($caption, $editor_option, $editor_configs);
143
+
144
+			return $editor;
145
+		}
146
+
147
+		// Only for Xoops 2.0.x
148
+		switch ($editor_option) {
149
+			case 'fckeditor':
150
+				if (is_readable(XOOPS_ROOT_PATH . '/class/fckeditor/formfckeditor.php')) {
151
+					require_once(XOOPS_ROOT_PATH . '/class/fckeditor/formfckeditor.php');
152
+					$editor = new XoopsFormFckeditor($caption, $name, $value);
153
+				}
154
+				break;
155
+
156
+			case 'htmlarea':
157
+				if (is_readable(XOOPS_ROOT_PATH . '/class/htmlarea/formhtmlarea.php')) {
158
+					require_once(XOOPS_ROOT_PATH . '/class/htmlarea/formhtmlarea.php');
159
+					$editor = new XoopsFormHtmlarea($caption, $name, $value);
160
+				}
161
+				break;
162
+
163
+			case 'dhtmltextarea':
164
+				$editor = new XoopsFormDhtmlTextArea($caption, $name, $value, 10, 50, $supplemental);
165
+				break;
166
+
167
+			case 'textarea':
168
+				$editor = new XoopsFormTextArea($caption, $name, $value);
169
+				break;
170
+
171
+			case 'tinyeditor':
172
+			case 'tinymce':
173
+				if (is_readable(XOOPS_ROOT_PATH . '/class/xoopseditor/tinyeditor/formtinyeditortextarea.php')) {
174
+					require_once XOOPS_ROOT_PATH . '/class/xoopseditor/tinyeditor/formtinyeditortextarea.php';
175
+					$editor = new XoopsFormTinyeditorTextArea(array('caption' => $caption, 'name' => $name, 'value' => $value, 'width' => '100%', 'height' => '400px'));
176
+				}
177
+				break;
178
+
179
+			case 'koivi':
180
+				if (is_readable(XOOPS_ROOT_PATH . '/class/wysiwyg/formwysiwygtextarea.php')) {
181
+					require_once(XOOPS_ROOT_PATH . '/class/wysiwyg/formwysiwygtextarea.php');
182
+					$editor = new XoopsFormWysiwygTextArea($caption, $name, $value, $width, $height, '');
183
+				}
184
+				break;
185
+		}
186
+		if (!is_object($editor)) {
187
+			trigger_error('Error, impossible to get the requested text editor', E_USER_ERROR);
188
+		}
189
+
190
+		return $editor;
191
+	}
192
+
193
+	/**
194
+	 * Create (in a link) a javascript confirmation's box
195
+	 *
196
+	 * @param  string  $message Message to display
197
+	 * @param  boolean $form    Is this a confirmation for a form ?
198
+	 * @return string  the javascript code to insert in the link (or in the form)
199
+	 */
200
+	public static function javascriptLinkConfirm($message, $form = false)
201
+	{
202
+		if (!$form) {
203
+			return "onclick=\"javascript:return confirm('" . str_replace("'", ' ', $message) . "')\"";
204
+		} else {
205
+			return "onSubmit=\"javascript:return confirm('" . str_replace("'", ' ', $message) . "')\"";
206
+		}
207
+	}
208
+
209
+	/**
210
+	 * Get current user IP
211
+	 *
212
+	 * @return string IP address (format Ipv4)
213
+	 */
214
+	public static function IP()
215
+	{
216
+		$proxy_ip = '';
217
+		if (!empty($_SERVER['HTTP_X_FORWARDED_FOR'])) {
218
+			$proxy_ip = $_SERVER['HTTP_X_FORWARDED_FOR'];
219
+		} elseif (!empty($_SERVER['HTTP_X_FORWARDED'])) {
220
+			$proxy_ip = $_SERVER['HTTP_X_FORWARDED'];
221
+		} elseif (!empty($_SERVER['HTTP_FORWARDED_FOR'])) {
222
+			$proxy_ip = $_SERVER['HTTP_FORWARDED_FOR'];
223
+		} elseif (!empty($_SERVER['HTTP_FORWARDED'])) {
224
+			$proxy_ip = $_SERVER['HTTP_FORWARDED'];
225
+		} elseif (!empty($_SERVER['HTTP_VIA'])) {
226
+			$proxy_ip = $_SERVER['HTTP_VIA'];
227
+		} elseif (!empty($_SERVER['HTTP_X_COMING_FROM'])) {
228
+			$proxy_ip = $_SERVER['HTTP_X_COMING_FROM'];
229
+		} elseif (!empty($_SERVER['HTTP_COMING_FROM'])) {
230
+			$proxy_ip = $_SERVER['HTTP_COMING_FROM'];
231
+		}
232
+		$regs = array();
233
+		if (!empty($proxy_ip) && $is_ip = ereg('^([0-9]{1,3}\.){3,3}[0-9]{1,3}', $proxy_ip, $regs) && count($regs) > 0) {
234
+			$the_IP = $regs[0];
235
+		} else {
236
+			$the_IP = $_SERVER['REMOTE_ADDR'];
237
+		}
238
+
239
+		return $the_IP;
240
+	}
241
+
242
+	/**
243
+	 * Set the page's title, meta description and meta keywords
244
+	 * Datas are supposed to be sanitized
245
+	 *
246
+	 * @param  string $pageTitle       Page's Title
247
+	 * @param  string $metaDescription Page's meta description
248
+	 * @param  string $metaKeywords    Page's meta keywords
249
+	 * @return void
250
+	 */
251
+	public static function setMetas($pageTitle = '', $metaDescription = '', $metaKeywords = '')
252
+	{
253
+		global $xoTheme, $xoTheme, $xoopsTpl;
254
+		$xoopsTpl->assign('xoops_pagetitle', $pageTitle);
255
+		if (isset($xoTheme) && is_object($xoTheme)) {
256
+			if (!empty($metaKeywords)) {
257
+				$xoTheme->addMeta('meta', 'keywords', $metaKeywords);
258
+			}
259
+			if (!empty($metaDescription)) {
260
+				$xoTheme->addMeta('meta', 'description', $metaDescription);
261
+			}
262
+		} elseif (isset($xoopsTpl) && is_object($xoopsTpl)) {    // Compatibility for old Xoops versions
263
+			if (!empty($metaKeywords)) {
264
+				$xoopsTpl->assign('xoops_meta_keywords', $metaKeywords);
265
+			}
266
+			if (!empty($metaDescription)) {
267
+				$xoopsTpl->assign('xoops_meta_description', $metaDescription);
268
+			}
269
+		}
270
+	}
271
+
272
+	/**
273
+	 * Send an email from a template to a list of recipients
274
+	 *
275
+	 * @param         $tplName
276
+	 * @param  array  $recipients List of recipients
277
+	 * @param  string $subject    Email's subject
278
+	 * @param  array  $variables  Varirables to give to the template
279
+	 * @return bool Result of the send
280
+	 * @internal param string $tpl_name Template's name
281
+	 */
282
+	public static function sendEmailFromTpl($tplName, $recipients, $subject, $variables)
283
+	{
284
+		global $xoopsConfig;
285
+		require_once XOOPS_ROOT_PATH . '/class/xoopsmailer.php';
286
+		if (!is_array($recipients)) {
287
+			if (trim($recipients) == '') {
288
+				return false;
289
+			}
290
+		} else {
291
+			if (count($recipients) == 0) {
292
+				return false;
293
+			}
294
+		}
295
+		if (function_exists('xoops_getMailer')) {
296
+			$xoopsMailer =& xoops_getMailer();
297
+		} else {
298
+			$xoopsMailer =& getMailer();
299
+		}
300
+
301
+		$xoopsMailer->useMail();
302
+		$xoopsMailer->setTemplateDir(XOOPS_ROOT_PATH . '/modules/' . self::MODULE_NAME . '/language/' . $xoopsConfig['language'] . '/mail_template');
303
+		$xoopsMailer->setTemplate($tplName);
304
+		$xoopsMailer->setToEmails($recipients);
305
+		// TODO: Change !
306
+		// $xoopsMailer->setFromEmail('[email protected]');
307
+		//$xoopsMailer->setFromName('MonSite');
308
+		$xoopsMailer->setSubject($subject);
309
+		foreach ($variables as $key => $value) {
310
+			$xoopsMailer->assign($key, $value);
311
+		}
312
+		$res = $xoopsMailer->send();
313
+		unset($xoopsMailer);
314
+		$filename = XOOPS_UPLOAD_PATH . '/logmail_' . self::MODULE_NAME . '.php';
315
+		if (!file_exists($filename)) {
316
+			$fp = @fopen($filename, 'a');
317
+			if ($fp) {
318
+				fwrite($fp, '<?php exit(); ?>');
319
+				fclose($fp);
320
+			}
321
+		}
322
+		$fp = @fopen($filename, 'a');
323
+
324
+		if ($fp) {
325
+			fwrite($fp, str_repeat('-', 120) . "\n");
326
+			fwrite($fp, date('d/m/Y H:i:s') . "\n");
327
+			fwrite($fp, 'Template name : ' . $tplName . "\n");
328
+			fwrite($fp, 'Email subject : ' . $subject . "\n");
329
+			if (is_array($recipients)) {
330
+				fwrite($fp, 'Recipient(s) : ' . implode(',', $recipients) . "\n");
331
+			} else {
332
+				fwrite($fp, 'Recipient(s) : ' . $recipients . "\n");
333
+			}
334
+			fwrite($fp, 'Transmited variables : ' . implode(',', $variables) . "\n");
335
+			fclose($fp);
336
+		}
337
+
338
+		return $res;
339
+	}
340
+
341
+	/**
342
+	 * Remove module's cache
343
+	 */
344
+	public static function updateCache()
345
+	{
346
+		global $xoopsModule;
347
+		$folder  = $xoopsModule->getVar('dirname');
348
+		$tpllist = array();
349
+		require_once XOOPS_ROOT_PATH . '/class/xoopsblock.php';
350
+		require_once XOOPS_ROOT_PATH . '/class/template.php';
351
+		$tplfile_handler = xoops_getHandler('tplfile');
352
+		$tpllist         = $tplfile_handler->find(null, null, null, $folder);
353
+		xoops_template_clear_module_cache($xoopsModule->getVar('mid'));            // Clear module's blocks cache
354
+
355
+		foreach ($tpllist as $onetemplate) {    // Remove cache for each page.
356
+			if ($onetemplate->getVar('tpl_type') === 'module') {
357
+				//  Note, I've been testing all the other methods (like the one of Smarty) and none of them run, that's why I have used this code
358
+				$files_del = array();
359
+				$files_del = glob(XOOPS_CACHE_PATH . '/*' . $onetemplate->getVar('tpl_file') . '*');
360
+				if (count($files_del) > 0 && is_array($files_del)) {
361
+					foreach ($files_del as $one_file) {
362
+						if (is_file($one_file)) {
363
+							unlink($one_file);
364
+						}
365
+					}
366
+				}
367
+			}
368
+		}
369
+	}
370
+
371
+	/**
372
+	 * Redirect user with a message
373
+	 *
374
+	 * @param string $message message to display
375
+	 * @param string $url     The place where to go
376
+	 * @param        integer  timeout Time to wait before to redirect
377
+	 */
378
+	public static function redirect($message = '', $url = 'index.php', $time = 2)
379
+	{
380
+		redirect_header($url, $time, $message);
381
+		exit();
382
+	}
383
+
384
+	/**
385
+	 * Internal function used to get the handler of the current module
386
+	 *
387
+	 * @return object The module
388
+	 */
389
+	public static function getModule()
390
+	{
391
+		static $mymodule;
392
+		if (!isset($mymodule)) {
393
+			global $xoopsModule;
394
+			if (isset($xoopsModule) && is_object($xoopsModule) && $xoopsModule->getVar('dirname') == REFERENCES_DIRNAME) {
395
+				$mymodule =& $xoopsModule;
396
+			} else {
397
+				$hModule  = xoops_getHandler('module');
398
+				$mymodule = $hModule->getByDirname(REFERENCES_DIRNAME);
399
+			}
400
+		}
401
+
402
+		return $mymodule;
403
+	}
404
+
405
+	/**
406
+	 * Returns the module's name (as defined by the user in the module manager) with cache
407
+	 * @return string Module's name
408
+	 */
409
+	public static function getModuleName()
410
+	{
411
+		static $moduleName;
412
+		if (!isset($moduleName)) {
413
+			$mymodule   = self::getModule();
414
+			$moduleName = $mymodule->getVar('name');
415
+		}
416
+
417
+		return $moduleName;
418
+	}
419
+
420
+	/**
421
+	 * Create a title for the href tags inside html links
422
+	 *
423
+	 * @param  string $title Text to use
424
+	 * @return string Formated text
425
+	 */
426
+	public static function makeHrefTitle($title)
427
+	{
428
+		$s = "\"'";
429
+		$r = '  ';
430
+
431
+		return strtr($title, $s, $r);
432
+	}
433
+
434
+	/**
435
+	 * Retourne la liste des utilisateurs appartenants � un groupe
436
+	 *
437
+	 * @param  int $groupId Searched group
438
+	 * @return array Array of XoopsUsers
439
+	 */
440
+	public static function getUsersFromGroup($groupId)
441
+	{
442
+		$users          = array();
443
+		$member_handler = xoops_getHandler('member');
444
+		$users          = $member_handler->getUsersByGroup($groupId, true);
445
+
446
+		return $users;
447
+	}
448
+
449
+	/**
450
+	 * Retourne les ID des utilisateurs faisant partie de plusieurs groupes
451
+	 * @param  array $groups Les ID des groupes dont on recherche les ID utilisateurs
452
+	 * @return array Les ID utilisateurs
453
+	 */
454
+	public static function getUsersIdsFromGroups($groups)
455
+	{
456
+		$usersIds       = array();
457
+		$member_handler = xoops_getHandler('member');
458
+		foreach ($groups as $groupId) {
459
+			$temporaryGroup = array();
460
+			$temporaryGroup = $member_handler->getUsersByGroup($groupId);
461
+			if (count($temporaryGroup) > 0) {
462
+				$usersIds = array_merge($usersIds, $temporaryGroup);
463
+			}
464
+		}
465
+
466
+		return array_unique($usersIds);
467
+	}
468
+
469
+	/**
470
+	 * Retourne la liste des emails des utilisateurs membres d'un groupe
471
+	 *
472
+	 * @param $groupId
473
+	 * @return array Emails list
474
+	 * @internal param int $group_id Group's number
475
+	 */
476
+	public static function getEmailsFromGroup($groupId)
477
+	{
478
+		$ret   = array();
479
+		$users = self::getUsersFromGroup($groupId);
480
+		foreach ($users as $user) {
481
+			$ret[] = $user->getVar('email');
482
+		}
483
+
484
+		return $ret;
485
+	}
486
+
487
+	/**
488
+	 * V�rifie que l'utilisateur courant fait partie du groupe des administrateurs
489
+	 *
490
+	 * @return booleean Admin or not
491
+	 */
492
+	public static function isAdmin()
493
+	{
494
+		global $xoopsUser, $xoopsModule;
495
+		if (is_object($xoopsUser)) {
496
+			if (in_array(XOOPS_GROUP_ADMIN, $xoopsUser->getGroups())) {
497
+				return true;
498
+			} elseif (isset($xoopsModule) && $xoopsUser->isAdmin($xoopsModule->getVar('mid'))) {
499
+				return true;
500
+			}
501
+		}
502
+
503
+		return false;
504
+	}
505
+
506
+	/**
507
+	 * Returns the current date in the Mysql format
508
+	 *
509
+	 * @return string Date in the Mysql format
510
+	 */
511
+	public static function getCurrentSQLDate()
512
+	{
513
+		return date('Y-m-d');    // 2007-05-02
514
+	}
515
+
516
+	public static function getCurrentSQLDateTime()
517
+	{
518
+		return date('Y-m-d H:i:s');    // 2007-05-02
519
+	}
520
+
521
+	/**
522
+	 * Convert a Mysql date to the human's format
523
+	 *
524
+	 * @param  string $date The date to convert
525
+	 * @param string  $format
526
+	 * @return string The date in a human form
527
+	 */
528
+	public static function SQLDateToHuman($date, $format = 'l')
529
+	{
530
+		if ($date != '0000-00-00' && xoops_trim($date) != '') {
531
+			return formatTimestamp(strtotime($date), $format);
532
+		} else {
533
+			return '';
534
+		}
535
+	}
536
+
537
+	/**
538
+	 * Convert a timestamp to a Mysql date
539
+	 *
540
+	 * @param  integer $timestamp The timestamp to use
541
+	 * @return string  The date in the Mysql format
542
+	 */
543
+	public static function timestampToMysqlDate($timestamp)
544
+	{
545
+		return date('Y-m-d', (int)$timestamp);
546
+	}
547
+
548
+	/**
549
+	 * Conversion d'un dateTime Mysql en date lisible en fran�ais
550
+	 * @param $dateTime
551
+	 * @return bool|string
552
+	 */
553
+	public static function sqlDateTimeToFrench($dateTime)
554
+	{
555
+		return date('d/m/Y H:i:s', strtotime($dateTime));
556
+	}
557
+
558
+	/**
559
+	 * Convert a timestamp to a Mysql datetime form
560
+	 * @param  integer $timestamp The timestamp to use
561
+	 * @return string  The date and time in the Mysql format
562
+	 */
563
+	public static function timestampToMysqlDateTime($timestamp)
564
+	{
565
+		return date('Y-m-d H:i:s', $timestamp);
566
+	}
567
+
568
+	/**
569
+	 * This function indicates if the current Xoops version needs to add asterisks to required fields in forms
570
+	 *
571
+	 * @return boolean Yes = we need to add them, false = no
572
+	 */
573
+	public static function needsAsterisk()
574
+	{
575
+		if (self::isX23()) {
576
+			return false;
577
+		}
578
+		if (strpos(strtolower(XOOPS_VERSION), 'impresscms') !== false) {
579
+			return false;
580
+		}
581
+		if (strpos(strtolower(XOOPS_VERSION), 'legacy') === false) {
582
+			$xv = xoops_trim(str_replace('XOOPS ', '', XOOPS_VERSION));
583
+			if ((int)substr($xv, 4, 2) >= 17) {
584
+				return false;
585
+			}
586
+		}
587
+
588
+		return true;
589
+	}
590
+
591
+	/**
592
+	 * Mark the mandatory fields of a form with a star
593
+	 *
594
+	 * @param  object $sform The form to modify
595
+	 * @return object The modified form
596
+	 * @internal param string $caracter The character to use to mark fields
597
+	 */
598
+	public static function &formMarkRequiredFields(&$sform)
599
+	{
600
+		if (self::needsAsterisk()) {
601
+			$required = array();
602
+			foreach ($sform->getRequired() as $item) {
603
+				$required[] = $item->_name;
604
+			}
605
+			$elements = array();
606
+			$elements = &$sform->getElements();
607
+			$cnt      = count($elements);
608
+			for ($i = 0; $i < $cnt; ++$i) {
609
+				if (is_object($elements[$i]) && in_array($elements[$i]->_name, $required)) {
610
+					$elements[$i]->_caption .= ' *';
611
+				}
612
+			}
613
+		}
614
+
615
+		return $sform;
616
+	}
617
+
618
+	/**
619
+	 * Create an html heading (from h1 to h6)
620
+	 *
621
+	 * @param  string  $title The text to use
622
+	 * @param  integer $level Level to return
623
+	 * @return string  The heading
624
+	 */
625
+	public static function htitle($title = '', $level = 1)
626
+	{
627
+		printf('<h%01d>%s</h%01d>', $level, $title, $level);
628
+	}
629
+
630
+	/**
631
+	 * Create a unique upload filename
632
+	 *
633
+	 * @param  string  $folder   The folder where the file will be saved
634
+	 * @param  string  $fileName Original filename (coming from the user)
635
+	 * @param  boolean $trimName Do we need to create a short unique name ?
636
+	 * @return string  The unique filename to use (with its extension)
637
+	 */
638
+	public static function createUploadName($folder, $fileName, $trimName = false)
639
+	{
640
+		$workingfolder = $folder;
641
+		if (substr($workingfolder, strlen($workingfolder) - 1, 1) !== '/') {
642
+			$workingfolder .= '/';
643
+		}
644
+		$ext  = basename($fileName);
645
+		$ext  = explode('.', $ext);
646
+		$ext  = '.' . $ext[count($ext) - 1];
647
+		$true = true;
648
+		while ($true) {
649
+			$ipbits = explode('.', $_SERVER['REMOTE_ADDR']);
650
+			list($usec, $sec) = explode(' ', microtime());
651
+			$usec = (integer)($usec * 65536);
652
+			$sec  = ((integer)$sec) & 0xFFFF;
653
+
654
+			if ($trimName) {
655
+				$uid = sprintf('%06x%04x%04x', ($ipbits[0] << 24) | ($ipbits[1] << 16) | ($ipbits[2] << 8) | $ipbits[3], $sec, $usec);
656
+			} else {
657
+				$uid = sprintf('%08x-%04x-%04x', ($ipbits[0] << 24) | ($ipbits[1] << 16) | ($ipbits[2] << 8) | $ipbits[3], $sec, $usec);
658
+			}
659
+			if (!file_exists($workingfolder . $uid . $ext)) {
660
+				$true = false;
661
+			}
662
+		}
663
+
664
+		return $uid . $ext;
665
+	}
666
+
667
+	/**
668
+	 * Replace html entities with their ASCII equivalent
669
+	 *
670
+	 * @param  string $chaine The string undecode
671
+	 * @return string The undecoded string
672
+	 */
673
+	public static function unhtml($chaine)
674
+	{
675
+		$search = $replace = array();
676
+		$chaine = html_entity_decode($chaine);
677
+
678
+		for ($i = 0; $i <= 255; ++$i) {
679
+			$search[]  = '&#' . $i . ';';
680
+			$replace[] = chr($i);
681
+		}
682
+		$replace[]='...'; $search[]='…';
683
+		$replace[]="'"; $search[]='‘';
684
+		$replace[]="'"; $search[]= '’';
685
+		$replace[]='-'; $search[] = '&bull;';   // $replace[] = '•';
686
+		$replace[]='—'; $search[]='&mdash;';
687
+		$replace[]='-'; $search[]='&ndash;';
688
+		$replace[]='-'; $search[]='&shy;';
689
+		$replace[]='"'; $search[]='&quot;';
690
+		$replace[]='&'; $search[]='&amp;';
691
+		$replace[]='ˆ'; $search[]='&circ;';
692
+		$replace[]='¡'; $search[]='&iexcl;';
693
+		$replace[]='¦'; $search[]='&brvbar;';
694
+		$replace[]='¨'; $search[]='&uml;';
695
+		$replace[]='¯'; $search[]='&macr;';
696
+		$replace[]='´'; $search[]='&acute;';
697
+		$replace[]='¸'; $search[]='&cedil;';
698
+		$replace[]='¿'; $search[]='&iquest;';
699
+		$replace[]='˜'; $search[]='&tilde;';
700
+		$replace[]="'"; $search[]='&lsquo;';    // $replace[]='‘';
701
+		$replace[]="'"; $search[]='&rsquo;';    // $replace[]='’';
702
+		$replace[]='‚'; $search[]='&sbquo;';
703
+		$replace[]="'"; $search[]='&ldquo;';    // $replace[]='“';
704
+		$replace[]="'"; $search[]='&rdquo;';    // $replace[]='”';
705
+		$replace[]='„'; $search[]='&bdquo;';
706
+		$replace[]='‹'; $search[]='&lsaquo;';
707
+		$replace[]='›'; $search[]='&rsaquo;';
708
+		$replace[]='<'; $search[]='&lt;';
709
+		$replace[]='>'; $search[]='&gt;';
710
+		$replace[]='±'; $search[]='&plusmn;';
711
+		$replace[]='«'; $search[]='&laquo;';
712
+		$replace[]='»'; $search[]='&raquo;';
713
+		$replace[]='×'; $search[]='&times;';
714
+		$replace[]='÷'; $search[]='&divide;';
715
+		$replace[]='¢'; $search[]='&cent;';
716
+		$replace[]='£'; $search[]='&pound;';
717
+		$replace[]='¤'; $search[]='&curren;';
718
+		$replace[]='¥'; $search[]='&yen;';
719
+		$replace[]='§'; $search[]='&sect;';
720
+		$replace[]='©'; $search[]='&copy;';
721
+		$replace[]='¬'; $search[]='&not;';
722
+		$replace[]='®'; $search[]='&reg;';
723
+		$replace[]='°'; $search[]='&deg;';
724
+		$replace[]='µ'; $search[]='&micro;';
725
+		$replace[]='¶'; $search[]='&para;';
726
+		$replace[]='·'; $search[]='&middot;';
727
+		$replace[]='†'; $search[]='&dagger;';
728
+		$replace[]='‡'; $search[]='&Dagger;';
729
+		$replace[]='‰'; $search[]='&permil;';
730
+		$replace[]='Euro'; $search[]='&euro;';      // $replace[]='€'
731
+		$replace[]='¼'; $search[]='&frac14;';
732
+		$replace[]='½'; $search[]='&frac12;';
733
+		$replace[]='¾'; $search[]='&frac34;';
734
+		$replace[]='¹'; $search[]='&sup1;';
735
+		$replace[]='²'; $search[]='&sup2;';
736
+		$replace[]='³'; $search[]='&sup3;';
737
+		$replace[]='á'; $search[]='&aacute;';
738
+		$replace[]='Á'; $search[]='&Aacute;';
739
+		$replace[]='â'; $search[]='&acirc;';
740
+		$replace[]='Â'; $search[]='&Acirc;';
741
+		$replace[]='à'; $search[]='&agrave;';
742
+		$replace[]='À'; $search[]='&Agrave;';
743
+		$replace[]='å'; $search[]='&aring;';
744
+		$replace[]='Å'; $search[]='&Aring;';
745
+		$replace[]='ã'; $search[]='&atilde;';
746
+		$replace[]='Ã'; $search[]='&Atilde;';
747
+		$replace[]='ä'; $search[]='&auml;';
748
+		$replace[]='Ä'; $search[]='&Auml;';
749
+		$replace[]='ª'; $search[]='&ordf;';
750
+		$replace[]='æ'; $search[]='&aelig;';
751
+		$replace[]='Æ'; $search[]='&AElig;';
752
+		$replace[]='ç'; $search[]='&ccedil;';
753
+		$replace[]='Ç'; $search[]='&Ccedil;';
754
+		$replace[]='ð'; $search[]='&eth;';
755
+		$replace[]='Ð'; $search[]='&ETH;';
756
+		$replace[]='é'; $search[]='&eacute;';
757
+		$replace[]='É'; $search[]='&Eacute;';
758
+		$replace[]='ê'; $search[]='&ecirc;';
759
+		$replace[]='Ê'; $search[]='&Ecirc;';
760
+		$replace[]='è'; $search[]='&egrave;';
761
+		$replace[]='È'; $search[]='&Egrave;';
762
+		$replace[]='ë'; $search[]='&euml;';
763
+		$replace[]='Ë'; $search[]='&Euml;';
764
+		$replace[]='ƒ'; $search[]='&fnof;';
765
+		$replace[]='í'; $search[]='&iacute;';
766
+		$replace[]='Í'; $search[]='&Iacute;';
767
+		$replace[]='î'; $search[]='&icirc;';
768
+		$replace[]='Î'; $search[]='&Icirc;';
769
+		$replace[]='ì'; $search[]='&igrave;';
770
+		$replace[]='Ì'; $search[]='&Igrave;';
771
+		$replace[]='ï'; $search[]='&iuml;';
772
+		$replace[]='Ï'; $search[]='&Iuml;';
773
+		$replace[]='ñ'; $search[]='&ntilde;';
774
+		$replace[]='Ñ'; $search[]='&Ntilde;';
775
+		$replace[]='ó'; $search[]='&oacute;';
776
+		$replace[]='Ó'; $search[]='&Oacute;';
777
+		$replace[]='ô'; $search[]='&ocirc;';
778
+		$replace[]='Ô'; $search[]='&Ocirc;';
779
+		$replace[]='ò'; $search[]='&ograve;';
780
+		$replace[]='Ò'; $search[]='&Ograve;';
781
+		$replace[]='º'; $search[]='&ordm;';
782
+		$replace[]='ø'; $search[]='&oslash;';
783
+		$replace[]='Ø'; $search[]='&Oslash;';
784
+		$replace[]='õ'; $search[]='&otilde;';
785
+		$replace[]='Õ'; $search[]='&Otilde;';
786
+		$replace[]='ö'; $search[]='&ouml;';
787
+		$replace[]='Ö'; $search[]='&Ouml;';
788
+		$replace[]='œ'; $search[]='&oelig;';
789
+		$replace[]='Œ'; $search[]='&OElig;';
790
+		$replace[]='š'; $search[]='&scaron;';
791
+		$replace[]='Š'; $search[]='&Scaron;';
792
+		$replace[]='ß'; $search[]='&szlig;';
793
+		$replace[]='þ'; $search[]='&thorn;';
794
+		$replace[]='Þ'; $search[]='&THORN;';
795
+		$replace[]='ú'; $search[]='&uacute;';
796
+		$replace[]='Ú'; $search[]='&Uacute;';
797
+		$replace[]='û'; $search[]='&ucirc;';
798
+		$replace[]='Û'; $search[]='&Ucirc;';
799
+		$replace[]='ù'; $search[]='&ugrave;';
800
+		$replace[]='Ù'; $search[]='&Ugrave;';
801
+		$replace[]='ü'; $search[]='&uuml;';
802
+		$replace[]='Ü'; $search[]='&Uuml;';
803
+		$replace[]='ý'; $search[]='&yacute;';
804
+		$replace[]='Ý'; $search[]='&Yacute;';
805
+		$replace[]='ÿ'; $search[]='&yuml;';
806
+		$replace[]='Ÿ'; $search[]='&Yuml;';
807
+		$chaine    = str_replace($search, $replace, $chaine);
808
+
809
+		return $chaine;
810
+	}
811
+
812
+	/**
813
+	 * Création d'une titre pour être utilisé par l'url rewriting
814
+	 *
815
+	 * @param string  $content  Le texte à utiliser pour créer l'url
816
+	 * @param integer $urw      La limite basse pour créer les mots
817
+	 * @return string Le texte à utiliser pour l'url
818
+	 *                          Note, some parts are from Solo's code
819
+	 */
820
+	public static function makeSeoUrl($content, $urw = 1)
821
+	{
822
+		$s       = "ÀÁÂÃÄÅÒÓÔÕÖØÈÉÊËÇÌÍÎÏÙÚÛÜŸÑàáâãäåòóôõöøèéêëçìíîïùúûüÿñ '()";
823
+		$r       = 'AAAAAAOOOOOOEEEECIIIIUUUUYNaaaaaaooooooeeeeciiiiuuuuyn----';
824
+		$content = self::unhtml($content);    // First, remove html entities
825
+		$content = strtr($content, $s, $r);
826
+		$content = strip_tags($content);
827
+		$content = strtolower($content);
828
+		$content = htmlentities($content);    // TODO: Vérifier
829
+		$content = preg_replace('/&([a-zA-Z])(uml|acute|grave|circ|tilde);/', '$1', $content);
830
+		$content = html_entity_decode($content);
831
+		$content = eregi_replace('quot', ' ', $content);
832
+		$content = eregi_replace("'", ' ', $content);
833
+		$content = eregi_replace('-', ' ', $content);
834
+		$content = eregi_replace('[[:punct:]]', '', $content);
835
+		// Selon option mais attention au fichier .htaccess !
836
+		// $content = eregi_replace('[[:digit:]]','', $content);
837
+		$content = preg_replace('/[^a-z|A-Z|0-9]/', '-', $content);
838
+
839
+		$words    = explode(' ', $content);
840
+		$keywords = '';
841
+		foreach ($words as $word) {
842
+			if (strlen($word) >= $urw) {
843
+				$keywords .= '-' . trim($word);
844
+			}
845
+		}
846
+		if (!$keywords) {
847
+			$keywords = '-';
848
+		}
849
+		// Supprime les tirets en double
850
+		$keywords = str_replace('---', '-', $keywords);
851
+		$keywords = str_replace('--', '-', $keywords);
852
+		// Supprime un éventuel tiret à la fin de la chaine
853
+		if (substr($keywords, strlen($keywords) - 1, 1) == '-') {
854
+			$keywords = substr($keywords, 0, strlen($keywords) - 1);
855
+		}
856
+
857
+		return $keywords;
858
+	}
859
+
860
+	/**
861
+	 * Create the meta keywords based on the content
862
+	 *
863
+	 * @param  string $content Content from which we have to create metakeywords
864
+	 * @return string The list of meta keywords
865
+	 */
866
+	public static function createMetaKeywords($content)
867
+	{
868
+		$keywordscount = REFERENCES_METAGEN_MAX_KEYWORDS;
869
+		$keywordsorder = REFERENCES_METAGEN_KEYWORDS_ORDER;
870
+
871
+		$tmp = array();
872
+		// Search for the "Minimum keyword length"
873
+		// TODO: Remplacer references_keywords_limit par une constante
874
+		if (isset($_SESSION['references_keywords_limit'])) {
875
+			$limit = $_SESSION['references_keywords_limit'];
876
+		} else {
877
+			$config_handler                        = xoops_getHandler('config');
878
+			$xoopsConfigSearch                     =& $config_handler->getConfigsByCat(XOOPS_CONF_SEARCH);
879
+			$limit                                 = $xoopsConfigSearch['keyword_min'];
880
+			$_SESSION['references_keywords_limit'] = $limit;
881
+		}
882
+		$myts            = MyTextSanitizer::getInstance();
883
+		$content         = str_replace('<br>', ' ', $content);
884
+		$content         = $myts->undoHtmlSpecialChars($content);
885
+		$content         = strip_tags($content);
886
+		$content         = strtolower($content);
887
+		$search_pattern  = array('&nbsp;', "\t", "\r\n", "\r", "\n", ',', '.', "'", ';', ':', ')', '(', '"', '?', '!', '{', '}', '[', ']', '<', '>', '/', '+', '-', '_', '\\', '*');
888
+		$replace_pattern = array(' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', '', '', '', '', '', '', '', '', '', '', '', '', '', '', '', '', '', '', '');
889
+		$content         = str_replace($search_pattern, $replace_pattern, $content);
890
+		$keywords        = explode(' ', $content);
891
+		switch ($keywordsorder) {
892
+			case 0:    // Ordre d'apparition dans le texte
893
+				$keywords = array_unique($keywords);
894
+				break;
895
+			case 1:    // Ordre de fréquence des mots
896
+				$keywords = array_count_values($keywords);
897
+				asort($keywords);
898
+				$keywords = array_keys($keywords);
899
+				break;
900
+			case 2:    // Ordre inverse de la fréquence des mots
901
+				$keywords = array_count_values($keywords);
902
+				arsort($keywords);
903
+				$keywords = array_keys($keywords);
904
+				break;
905
+		}
906
+		// Remove black listed words
907
+		if (xoops_trim(self::getModuleOption('metagen_blacklist')) != '') {
908
+			$metagen_blacklist = str_replace("\r", '', self::getModuleOption('metagen_blacklist'));
909
+			$metablack         = explode("\n", $metagen_blacklist);
910
+			array_walk($metablack, 'trim');
911
+			$keywords = array_diff($keywords, $metablack);
912
+		}
913
+
914
+		foreach ($keywords as $keyword) {
915
+			if (strlen($keyword) >= $limit && !is_numeric($keyword)) {
916
+				$tmp[] = $keyword;
917
+			}
918
+		}
919
+		$tmp = array_slice($tmp, 0, $keywordscount);
920
+		if (count($tmp) > 0) {
921
+			return implode(',', $tmp);
922
+		} else {
923
+			if (!isset($config_handler) || !is_object($config_handler)) {
924
+				$config_handler = xoops_getHandler('config');
925
+			}
926
+			$xoopsConfigMetaFooter =& $config_handler->getConfigsByCat(XOOPS_CONF_METAFOOTER);
927
+			if (isset($xoopsConfigMetaFooter['meta_keywords'])) {
928
+				return $xoopsConfigMetaFooter['meta_keywords'];
929
+			} else {
930
+				return '';
931
+			}
932
+		}
933
+	}
934
+
935
+	/**
936
+	 * Fonction chargée de gérer l'upload
937
+	 *
938
+	 * @param integer $indice L'indice du fichier à télécharger
939
+	 * @param string  $dstpath
940
+	 * @param null    $mimeTypes
941
+	 * @param null    $uploadMaxSize
942
+	 * @param null    $maxWidth
943
+	 * @param null    $maxHeight
944
+	 * @return mixed True si l'upload s'est bien déroulé sinon le message d'erreur correspondant
945
+	 */
946
+	public static function uploadFile($indice, $dstpath = XOOPS_UPLOAD_PATH, $mimeTypes = null, $uploadMaxSize = null, $maxWidth = null, $maxHeight = null)
947
+	{
948
+		require_once XOOPS_ROOT_PATH . '/class/uploader.php';
949
+		global $destname;
950
+		if (isset($_POST['xoops_upload_file'])) {
951
+			require_once XOOPS_ROOT_PATH . '/class/uploader.php';
952
+			$fldname = '';
953
+			$fldname = $_FILES[$_POST['xoops_upload_file'][$indice]];
954
+			$fldname = get_magic_quotes_gpc() ? stripslashes($fldname['name']) : $fldname['name'];
955
+			if (xoops_trim($fldname != '')) {
956
+				$destname = self::createUploadName($dstpath, $fldname, true);
957
+				if ($mimeTypes === null) {
958
+					$permittedtypes = explode("\n", str_replace("\r", '', self::getModuleOption('mimetypes')));
959
+					array_walk($permittedtypes, 'trim');
960
+				} else {
961
+					$permittedtypes = $mimeTypes;
962
+				}
963
+				if ($uploadMaxSize === null) {
964
+					$uploadSize = self::getModuleOption('maxuploadsize');
965
+				} else {
966
+					$uploadSize = $uploadMaxSize;
967
+				}
968
+				$uploader = new XoopsMediaUploader($dstpath, $permittedtypes, $uploadSize, $maxWidth, $maxHeight);
969
+				//$uploader->allowUnknownTypes = true;
970
+				$uploader->setTargetFileName($destname);
971
+				if ($uploader->fetchMedia($_POST['xoops_upload_file'][$indice])) {
972
+					if ($uploader->upload()) {
973
+						return true;
974
+					} else {
975
+						return _ERRORS . ' ' . htmlentities($uploader->getErrors());
976
+					}
977
+				} else {
978
+					return htmlentities($uploader->getErrors());
979
+				}
980
+			} else {
981
+				return false;
982
+			}
983
+		} else {
984
+			return false;
985
+		}
986
+	}
987
+
988
+	/**
989
+	 * Resize a Picture to some given dimensions (using the wideImage library)
990
+	 *
991
+	 * @param string  $src_path      Picture's source
992
+	 * @param string  $dst_path      Picture's destination
993
+	 * @param integer $param_width   Maximum picture's width
994
+	 * @param integer $param_height  Maximum picture's height
995
+	 * @param boolean $keep_original Do we have to keep the original picture ?
996
+	 * @param string  $fit           Resize mode (see the wideImage library for more information)
997
+	 * @return bool
998
+	 */
999
+	public static function resizePicture($src_path, $dst_path, $param_width, $param_height, $keep_original = false, $fit = 'inside')
1000
+	{
1001
+		//        require_once self::MODULE_PATH . 'class/wideimage/WideImage.php';
1002
+		$img    = WideImage::load($src_path);
1003
+		$result = $img->resize($param_width, $param_height, $fit);
1004
+		$result->saveToFile($dst_path, null);
1005
+		if (!$keep_original) {
1006
+			@unlink($src_path);
1007
+		}
1008
+
1009
+		return true;
1010
+	}
1011
+
1012
+	/**
1013
+	 * Déclenchement d'une alerte Xoops suite à un évènement
1014
+	 *
1015
+	 * @param string       $category La catégorie de l'évènement
1016
+	 * @param integer      $itemId   L'ID de l'élément (trop général pour être décris précisément)
1017
+	 * @param unknown_type $event    L'évènement qui est déclencé
1018
+	 * @param unknown_type $tags     Les variables à passer au template
1019
+	 */
1020
+	public static function notify($category, $itemId, $event, $tags)
1021
+	{
1022
+		$notification_handler = xoops_getHandler('notification');
1023
+		$tags['X_MODULE_URL'] = REFERENCES_URL;
1024
+		$notification_handler->triggerEvent($category, $itemId, $event, $tags);
1025
+	}
1026
+
1027
+	/**
1028
+	 * Ajoute des jours à une date et retourne la nouvelle date au format Date de Mysql
1029
+	 *
1030
+	 * @param int     $duration
1031
+	 * @param integer $startingDate Date de départ (timestamp)
1032
+	 * @return bool|string
1033
+	 * @internal param int $durations Durée en jours
1034
+	 */
1035
+	public static function addDaysToDate($duration = 1, $startingDate = 0)
1036
+	{
1037
+		if ($startingDate == 0) {
1038
+			$startingDate = time();
1039
+		}
1040
+		$endingDate = $startingDate + ($duration * 86400);
1041
+
1042
+		return date('Y-m-d', $endingDate);
1043
+	}
1044
+
1045
+	/**
1046
+	 * Retourne un breadcrumb en fonction des paramètres passés et en partant (d'office) de la racine du module
1047
+	 *
1048
+	 * @param array  $path  Le chemin complet (excepté la racine) du breadcrumb sous la forme clé=url valeur=titre
1049
+	 * @param string $raquo Le séparateur par défaut à utiliser
1050
+	 * @return string le breadcrumb
1051
+	 */
1052
+	public static function breadcrumb($path, $raquo = ' &raquo; ')
1053
+	{
1054
+		$breadcrumb        = '';
1055
+		$workingBreadcrumb = array();
1056
+		if (is_array($path)) {
1057
+			$moduleName          = self::getModuleName();
1058
+			$workingBreadcrumb[] = "<a href='" . REFERENCES_URL . "' title='" . self::makeHrefTitle($moduleName) . "'>" . $moduleName . '</a>';
1059
+			foreach ($path as $url => $title) {
1060
+				$workingBreadcrumb[] = "<a href='" . $url . "'>" . $title . '</a>';
1061
+			}
1062
+			$cnt = count($workingBreadcrumb);
1063
+			for ($i = 0; $i < $cnt; ++$i) {
1064
+				if ($i == $cnt - 1) {
1065
+					$workingBreadcrumb[$i] = strip_tags($workingBreadcrumb[$i]);
1066
+				}
1067
+			}
1068
+			$breadcrumb = implode($raquo, $workingBreadcrumb);
1069
+		}
1070
+
1071
+		return $breadcrumb;
1072
+	}
1073
+
1074
+	public static function close_tags($string)
1075
+	{
1076
+		// match opened tags
1077
+		if (preg_match_all('/<([a-z\:\-]+)[^\/]>/', $string, $start_tags)) {
1078
+			$start_tags = $start_tags[1];
1079
+
1080
+			// match closed tags
1081
+			if (preg_match_all('/<\/([a-z]+)>/', $string, $end_tags)) {
1082
+				$complete_tags = array();
1083
+				$end_tags      = $end_tags[1];
1084
+
1085
+				foreach ($start_tags as $key => $val) {
1086
+					$posb = array_search($val, $end_tags);
1087
+					if (is_int($posb)) {
1088
+						unset($end_tags[$posb]);
1089
+					} else {
1090
+						$complete_tags[] = $val;
1091
+					}
1092
+				}
1093
+			} else {
1094
+				$complete_tags = $start_tags;
1095
+			}
1096
+
1097
+			$complete_tags = array_reverse($complete_tags);
1098
+			for ($i = 0; $i < count($complete_tags); ++$i) {
1099
+				$string .= '</' . $complete_tags[$i] . '>';
1100
+			}
1101
+		}
1102
+
1103
+		return $string;
1104
+	}
1105
+
1106
+	public static function truncate_tagsafe($string, $length = 80, $etc = '...', $break_words = false)
1107
+	{
1108
+		if ($length == 0) {
1109
+			return '';
1110
+		}
1111
+
1112
+		if (strlen($string) > $length) {
1113
+			$length -= strlen($etc);
1114
+			if (!$break_words) {
1115
+				$string = preg_replace('/\s+?(\S+)?$/', '', substr($string, 0, $length + 1));
1116
+				$string = preg_replace('/<[^>]*$/', '', $string);
1117
+				$string = self::close_tags($string);
1118
+			}
1119
+
1120
+			return $string . $etc;
1121
+		} else {
1122
+			return $string;
1123
+		}
1124
+	}
1125
+
1126
+	/**
1127
+	 * Create an infotip
1128
+	 * @param $text
1129
+	 * @return string
1130
+	 */
1131
+	public static function makeInfotips($text)
1132
+	{
1133
+		$ret      = '';
1134
+		$infotips = self::getModuleOption('infotips');
1135
+		if ($infotips > 0) {
1136
+			$myts = MyTextSanitizer::getInstance();
1137
+			$ret  = $myts->htmlSpecialChars(substr(strip_tags($text), 0, $infotips));
1138
+		}
1139
+
1140
+		return $ret;
1141
+	}
1142
+
1143
+	/**
1144
+	 * Retourne le type Mime d'un fichier en utilisant d'abord finfo puis mime_content
1145
+	 *
1146
+	 * @param string $filename Le fichier (avec son chemin d'accès complet) dont on veut connaître le type mime
1147
+	 * @return string
1148
+	 */
1149
+	public static function getMimeType($filename)
1150
+	{
1151
+		if (function_exists('finfo_open')) {
1152
+			$pathToMagic = REFERENCES_PATH . 'mime/magic';
1153
+			$finfo       = new finfo(FILEINFO_MIME, $pathToMagic);
1154
+			$mimetype    = $finfo->file($filename);
1155
+			finfo_close($finfo);
1156
+			unset($finfo);
1157
+
1158
+			return $mimetype;
1159
+		} else {
1160
+			if (function_exists('mime_content_type')) {
1161
+				return mime_content_type($filename);
1162
+			} else {
1163
+				return '';
1164
+			}
1165
+		}
1166
+	}
1167
+
1168
+	/**
1169
+	 * Retourne une liste d'objets XoopsUsers à partir d'une liste d'identifiants
1170
+	 *
1171
+	 * @param  array $xoopsUsersIDs La liste des ID
1172
+	 * @return array Les objets XoopsUsers
1173
+	 */
1174
+	public static function getUsersFromIds($xoopsUsersIDs)
1175
+	{
1176
+		$users = array();
1177
+		if (is_array($xoopsUsersIDs) && count($xoopsUsersIDs) > 0) {
1178
+			$xoopsUsersIDs = array_unique($xoopsUsersIDs);
1179
+			sort($xoopsUsersIDs);
1180
+			if (count($xoopsUsersIDs) > 0) {
1181
+				$member_handler = xoops_getHandler('user');
1182
+				$criteria       = new Criteria('uid', '(' . implode(',', $xoopsUsersIDs) . ')', 'IN');
1183
+				$criteria->setSort('uid');
1184
+				$users = $member_handler->getObjects($criteria, true);
1185
+			}
1186
+		}
1187
+
1188
+		return $users;
1189
+	}
1190
+
1191
+	/**
1192
+	 * Retourne l'ID de l'utilisateur courant (s'il est connecté)
1193
+	 * @return integer L'uid ou 0
1194
+	 */
1195
+	public static function getCurrentUserID()
1196
+	{
1197
+		global $xoopsUser;
1198
+		$uid = is_object($xoopsUser) ? $xoopsUser->getVar('uid') : 0;
1199
+
1200
+		return $uid;
1201
+	}
1202
+
1203
+	/**
1204
+	 * Retourne la liste des groupes de l'utilisateur courant (avec cache)
1205
+	 * @param int $uid
1206
+	 * @return array Les ID des groupes auquel l'utilisateur courant appartient
1207
+	 */
1208
+	public static function getMemberGroups($uid = 0)
1209
+	{
1210
+		static $buffer = array();
1211
+		if ($uid == 0) {
1212
+			$uid = self::getCurrentUserID();
1213
+		}
1214
+
1215
+		if (is_array($buffer) && count($buffer) > 0 && isset($buffer[$uid])) {
1216
+			return $buffer[$uid];
1217
+		} else {
1218
+			if ($uid > 0) {
1219
+				$member_handler = xoops_getHandler('member');
1220
+				$buffer[$uid]   = $member_handler->getGroupsByUser($uid, false);    // Renvoie un tableau d'ID (de groupes)
1221
+			} else {
1222
+				$buffer[$uid] = array(XOOPS_GROUP_ANONYMOUS);
1223
+			}
1224
+		}
1225
+
1226
+		return $buffer[$uid];
1227
+	}
1228
+
1229
+	/**
1230
+	 * Indique si l'utilisateur courant fait partie d'une groupe donné (avec gestion de cache)
1231
+	 *
1232
+	 * @param integer $group Groupe recherché
1233
+	 * @param int     $uid
1234
+	 * @return bool vrai si l'utilisateur fait partie du groupe, faux sinon
1235
+	 */
1236
+	public static function isMemberOfGroup($group = 0, $uid = 0)
1237
+	{
1238
+		static $buffer = array();
1239
+		$retval = false;
1240
+		if ($uid == 0) {
1241
+			$uid = self::getCurrentUserID();
1242
+		}
1243
+		if (is_array($buffer) && array_key_exists($group, $buffer)) {
1244
+			$retval = $buffer[$group];
1245
+		} else {
1246
+			$member_handler = xoops_getHandler('member');
1247
+			$groups         = $member_handler->getGroupsByUser($uid, false);    // Renvoie un tableau d'ID (de groupes)
1248
+			$retval         = in_array($group, $groups);
1249
+			$buffer[$group] = $retval;
1250
+		}
1251
+
1252
+		return $retval;
1253
+	}
1254
+
1255
+	/**
1256
+	 * Indique si un utilisateur fait partie de plusieurs groupes
1257
+	 * La fonction renvoie vrai dès qu'on trouve que le membre fait partir d'un des groupes
1258
+	 * @param array    $groups La liste des groupes à vérifier
1259
+	 * @param  integer $uid    L'ID de l'utilisateur
1260
+	 * @return boolean
1261
+	 */
1262
+	public static function isMemberOfGroups($groups, $uid = 0)
1263
+	{
1264
+		if (count($groups) == 0) {
1265
+			return false;
1266
+		}
1267
+		if ($uid == 0) {
1268
+			$uid = self::getCurrentUserID();
1269
+		}
1270
+		foreach ($groups as $groupId) {
1271
+			if (self::isMemberOfGroup($groupId, $uid)) {
1272
+				return true;
1273
+			}
1274
+		}
1275
+
1276
+		return false;
1277
+	}
1278
+
1279
+	/**
1280
+	 * Retourne le nombre total de groupes (y compris les anonymes)
1281
+	 */
1282
+	public static function getGroupsCount()
1283
+	{
1284
+		static $cache = -1;
1285
+		if ($cache == -1) {
1286
+			global $xoopsDB;
1287
+			$sql    = 'SELECT COUNT(*) FROM ' . $xoopsDB->prefix('groups');
1288
+			$result = $xoopsDB->query($sql);
1289
+			if (!$result) {
1290
+				return false;
1291
+			}
1292
+			list($cache) = $xoopsDB->fetchRow($result);
1293
+		}
1294
+
1295
+		return $cache;
1296
+	}
1297
+
1298
+	/**
1299
+	 * Fonction chargée de vérifier qu'un répertoire existe, qu'on peut écrire dedans et création d'un fichier index.html
1300
+	 *
1301
+	 * @param string $folder Le chemin complet du répertoire à vérifier
1302
+	 * @return void
1303
+	 */
1304
+	public static function prepareFolder($folder)
1305
+	{
1306
+		if (!is_dir($folder)) {
1307
+			mkdir($folder, 0777);
1308
+			file_put_contents($folder . '/index.html', '<script>history.go(-1);</script>');
1309
+		} else {
1310
+			if (!is_writable($folder)) {
1311
+				chmod($folder, 0777);
1312
+			}
1313
+		}
1314
+	}
1315
+
1316
+	/**
1317
+	 * Load a language file
1318
+	 *
1319
+	 * @param string $languageFile     The required language file
1320
+	 * @param string $defaultExtension Default extension to use
1321
+	 */
1322
+	public static function loadLanguageFile($languageFile, $defaultExtension = '.php')
1323
+	{
1324
+		global $xoopsConfig;
1325
+		$root = self::MODULE_PATH;
1326
+		if (strstr($languageFile, $defaultExtension) === false) {
1327
+			$languageFile .= $defaultExtension;
1328
+		}
1329
+		if (file_exists($root . 'language' . DIRECTORY_SEPARATOR . $xoopsConfig['language'] . DIRECTORY_SEPARATOR . $languageFile)) {
1330
+			require_once $root . 'language' . DIRECTORY_SEPARATOR . $xoopsConfig['language'] . DIRECTORY_SEPARATOR . $languageFile;
1331
+		} else {    // Fallback
1332
+			require_once $root . 'language' . DIRECTORY_SEPARATOR . 'english' . DIRECTORY_SEPARATOR . $languageFile;
1333
+		}
1334
+	}
1335
+
1336
+	/**
1337
+	 * Création d'une vignette en tenant compte des options du module concernant le mode de création des vignettes
1338
+	 *
1339
+	 * @param  string  $src_path
1340
+	 * @param  string  $dst_path
1341
+	 * @param  integer $param_width
1342
+	 * @param  integer $param_height
1343
+	 * @param  boolean $keep_original
1344
+	 * @param string   $fit Utilisé uniquement pour la méthode 0 (redimensionnement)
1345
+	 * @return boolean
1346
+	 */
1347
+	public static function createThumb($src_path, $dst_path, $param_width, $param_height, $keep_original = false, $fit = 'inside')
1348
+	{
1349
+		//        require_once self::MODULE_PATH . 'class/wideimage/WideImage.php';
1350
+		$resize = true;
1351
+		// On commence par vérifier que l'image originale n'est pas plus petite que les dimensions demandées auquel cas il n'y a rien à faire
1352
+		$pictureDimensions = getimagesize($src_path);
1353
+		if (is_array($pictureDimensions)) {
1354
+			$pictureWidth  = $pictureDimensions[0];
1355
+			$pictureHeight = $pictureDimensions[1];
1356
+			if ($pictureWidth < $param_width && $pictureHeight < $param_height) {
1357
+				$resize = false;
1358
+			}
1359
+		}
1360
+		$img = WideImage::load($src_path);
1361
+		if ($resize) { // L'image est suffisament grande pour être réduite
1362
+			$thumbMethod = 0;
1363
+			if ($thumbMethod == 0) { // Redimensionnement de l'image
1364
+				$result = $img->resize($param_width, $param_height, $fit);
1365
+			} else { // Récupération d'une partie de l'image depuis le centre
1366
+				// Calcul de left et top
1367
+				$left = $top = 0;
1368
+				if (is_array($pictureDimensions)) {
1369
+					if ($pictureWidth > $param_width) {
1370
+						$left = (int)(($pictureWidth / 2) - ($param_width / 2));
1371
+					}
1372
+					if ($pictureHeight > $param_height) {
1373
+						$top = (int)(($pictureHeight / 2) - ($param_height / 2));
1374
+					}
1375
+				}
1376
+				$result = $img->crop($left, $top, $param_width, $param_height);
1377
+			}
1378
+			$result->saveToFile($dst_path, null);
1379
+		} else {
1380
+			if ($src_path != $dst_path) {
1381
+				@copy($src_path, $dst_path);
1382
+			}
1383
+		}
1384
+		if (!$keep_original) {
1385
+			@unlink($src_path);
1386
+		}
1387
+
1388
+		return true;
1389
+	}
1390
+
1391
+	/**
1392
+	 * Create the <option> of an html select
1393
+	 *
1394
+	 * @param  array $array   Array of index and labels
1395
+	 * @param  mixed $default the default value
1396
+	 * @param bool   $withNull
1397
+	 * @return string
1398
+	 */
1399
+	private static function htmlSelectOptions($array, $default = 0, $withNull = true)
1400
+	{
1401
+		$ret      = array();
1402
+		$selected = '';
1403
+		if ($withNull) {
1404
+			if (!is_array($default)) {
1405
+				if ($default === 0) {
1406
+					$selected = " selected = 'selected'";
1407
+				}
1408
+			} else {
1409
+				if (in_array(0, $default)) {
1410
+					$selected = " selected = 'selected'";
1411
+				}
1412
+			}
1413
+			$ret[] = '<option value=0' . $selected . '>---</option>';
1414
+		}
1415
+
1416
+		foreach ($array as $index => $label) {
1417
+			$selected = '';
1418
+			if (!is_array($default)) {
1419
+				if ($index == $default) {
1420
+					$selected = " selected = 'selected'";
1421
+				}
1422
+			} else {
1423
+				if (in_array($index, $default)) {
1424
+					$selected = " selected = 'selected'";
1425
+				}
1426
+			}
1427
+			$ret[] = "<option value=\"" . $index . "\"" . $selected . '>' . $label . '</option>';
1428
+		}
1429
+
1430
+		return implode("\n", $ret);
1431
+	}
1432
+
1433
+	/**
1434
+	 * Creates an html select an returns its code
1435
+	 *
1436
+	 * @param  string  $selectName Select's name
1437
+	 * @param  array   $array      Key = value of each option, value = label of each option
1438
+	 * @param  mixed   $default    Default's value
1439
+	 * @param  boolean $withNull   Do we want a null option
1440
+	 * @param  string  $style      Is there a style to apply ?
1441
+	 * @param  boolean $multiple   Can we select multiple elements ?
1442
+	 * @param  integer $size       Size of the selectbox, only used with multiple selectboxes
1443
+	 * @param string   $extra
1444
+	 * @return string
1445
+	 */
1446
+	public static function htmlSelect($selectName, $array, $default, $withNull = true, $style = '', $multiple = false, $size = 1, $extra = '')
1447
+	{
1448
+		$ret = '';
1449
+		$ret .= "<select name='" . $selectName . "' id='" . $selectName . "'";
1450
+		if (xoops_trim($style) != '') {
1451
+			$ret .= " style='" . $style . "' ";
1452
+		}
1453
+		if (xoops_trim($multiple) != '') {
1454
+			$ret .= " multiple = 'multiple' size='" . $size . "' ";
1455
+		}
1456
+		$ret .= $extra . ">\n";
1457
+		$ret .= self::htmlSelectOptions($array, $default, $withNull);
1458
+		$ret .= "</select>\n";
1459
+
1460
+		return $ret;
1461
+	}
1462
+
1463
+	/**
1464
+	 * Verify that a mysql table exists
1465
+	 * @param $tablename
1466
+	 * @return bool
1467
+	 */
1468
+	public static function tableExists($tablename)
1469
+	{
1470
+		global $xoopsDB;
1471
+		$result = $xoopsDB->queryF("SHOW TABLES LIKE '$tablename'");
1472
+
1473
+		return ($xoopsDB->getRowsNum($result) > 0);
1474
+	}
1475
+
1476
+	/**
1477
+	 * Verify that a field exists inside a mysql table
1478
+	 * @param $fieldname
1479
+	 * @param $table
1480
+	 * @return bool
1481
+	 */
1482
+	public static function fieldExists($fieldname, $table)
1483
+	{
1484
+		global $xoopsDB;
1485
+		$result = $xoopsDB->queryF("SHOW COLUMNS FROM $table LIKE '$fieldname'");
1486
+
1487
+		return ($xoopsDB->getRowsNum($result) > 0);
1488
+	}
1489
+
1490
+	/**
1491
+	 * Retourne la définition d'un champ
1492
+	 *
1493
+	 * @param  string $fieldname
1494
+	 * @param  string $table
1495
+	 * @return array
1496
+	 */
1497
+	public static function getFieldDefinition($fieldname, $table)
1498
+	{
1499
+		global $xoopsDB;
1500
+		$result = $xoopsDB->queryF("SHOW COLUMNS FROM $table LIKE '$fieldname'");
1501
+		if ($result) {
1502
+			return $xoopsDB->fetchArray($result);
1503
+		}
1504
+
1505
+		return '';
1506
+	}
1507
+
1508
+	/**
1509
+	 * Add a field to a mysql table
1510
+	 * @param $field
1511
+	 * @param $table
1512
+	 * @return resource
1513
+	 */
1514
+	public static function addField($field, $table)
1515
+	{
1516
+		global $xoopsDB;
1517
+		$result = $xoopsDB->queryF("ALTER TABLE $table ADD $field;");
1518
+
1519
+		return $result;
1520
+	}
1521
+
1522
+	/**
1523
+	 * Maintenance des tables du module et de son cache de requêtes
1524
+	 *
1525
+	 * @return void
1526
+	 */
1527
+	public static function maintainTablesCache()
1528
+	{
1529
+		global $xoopsDB;
1530
+		define('REFERENCES_MAINTAIN', true);
1531
+		require self::MODULE_PATH . 'xoops_version.php';
1532
+		$tables = array();
1533
+		foreach ($modversion['tables'] as $table) {
1534
+			$tables[] = $xoopsDB->prefix($table);
1535
+		}
1536
+		if (count($tables) > 0) {
1537
+			$list = implode(',', $tables);
1538
+			$xoopsDB->queryF('CHECK TABLE ' . $list);
1539
+			$xoopsDB->queryF('ANALYZE TABLE ' . $list);
1540
+			$xoopsDB->queryF('OPTIMIZE TABLE ' . $list);
1541
+		}
1542
+		self::updateCache();
1543
+		$handlers = references_handler::getInstance();
1544
+		$handlers->h_references_articles->forceCacheClean();
1545
+	}
1546
+
1547
+	/**
1548
+	 * Indique si le module Tag existe et est activé
1549
+	 *
1550
+	 * @return boolean
1551
+	 * @credit: smartfactory
1552
+	 */
1553
+	public static function tagModuleExists()
1554
+	{
1555
+		static $moduleExistsAndIsActive;
1556
+		if (!isset($moduleExistsAndIsActive)) {
1557
+			$modules_handler = xoops_getHandler('module');
1558
+			$tagModule       = $modules_handler->getByDirName('tag');
1559
+			if (!$tagModule) {
1560
+				$moduleExistsAndIsActive = false;
1561
+			} else {
1562
+				$moduleExistsAndIsActive = $tagModule->getVar('isactive') == 1;
1563
+			}
1564
+		}
1565
+
1566
+		return $moduleExistsAndIsActive;
1567
+	}
1568 1568
 }
Please login to merge, or discard this patch.
Spacing   +199 added lines, -199 removed lines patch added patch discarded remove patch
@@ -107,7 +107,7 @@  discard block
 block discarded – undo
107 107
     {
108 108
         $x23 = false;
109 109
         $xv  = str_replace('XOOPS ', '', XOOPS_VERSION);
110
-        if ((int)substr($xv, 2, 1) >= 3) {
110
+        if ((int) substr($xv, 2, 1) >= 3) {
111 111
             $x23 = true;
112 112
         }
113 113
 
@@ -147,15 +147,15 @@  discard block
 block discarded – undo
147 147
         // Only for Xoops 2.0.x
148 148
         switch ($editor_option) {
149 149
             case 'fckeditor':
150
-                if (is_readable(XOOPS_ROOT_PATH . '/class/fckeditor/formfckeditor.php')) {
151
-                    require_once(XOOPS_ROOT_PATH . '/class/fckeditor/formfckeditor.php');
150
+                if (is_readable(XOOPS_ROOT_PATH.'/class/fckeditor/formfckeditor.php')) {
151
+                    require_once(XOOPS_ROOT_PATH.'/class/fckeditor/formfckeditor.php');
152 152
                     $editor = new XoopsFormFckeditor($caption, $name, $value);
153 153
                 }
154 154
                 break;
155 155
 
156 156
             case 'htmlarea':
157
-                if (is_readable(XOOPS_ROOT_PATH . '/class/htmlarea/formhtmlarea.php')) {
158
-                    require_once(XOOPS_ROOT_PATH . '/class/htmlarea/formhtmlarea.php');
157
+                if (is_readable(XOOPS_ROOT_PATH.'/class/htmlarea/formhtmlarea.php')) {
158
+                    require_once(XOOPS_ROOT_PATH.'/class/htmlarea/formhtmlarea.php');
159 159
                     $editor = new XoopsFormHtmlarea($caption, $name, $value);
160 160
                 }
161 161
                 break;
@@ -170,15 +170,15 @@  discard block
 block discarded – undo
170 170
 
171 171
             case 'tinyeditor':
172 172
             case 'tinymce':
173
-                if (is_readable(XOOPS_ROOT_PATH . '/class/xoopseditor/tinyeditor/formtinyeditortextarea.php')) {
174
-                    require_once XOOPS_ROOT_PATH . '/class/xoopseditor/tinyeditor/formtinyeditortextarea.php';
173
+                if (is_readable(XOOPS_ROOT_PATH.'/class/xoopseditor/tinyeditor/formtinyeditortextarea.php')) {
174
+                    require_once XOOPS_ROOT_PATH.'/class/xoopseditor/tinyeditor/formtinyeditortextarea.php';
175 175
                     $editor = new XoopsFormTinyeditorTextArea(array('caption' => $caption, 'name' => $name, 'value' => $value, 'width' => '100%', 'height' => '400px'));
176 176
                 }
177 177
                 break;
178 178
 
179 179
             case 'koivi':
180
-                if (is_readable(XOOPS_ROOT_PATH . '/class/wysiwyg/formwysiwygtextarea.php')) {
181
-                    require_once(XOOPS_ROOT_PATH . '/class/wysiwyg/formwysiwygtextarea.php');
180
+                if (is_readable(XOOPS_ROOT_PATH.'/class/wysiwyg/formwysiwygtextarea.php')) {
181
+                    require_once(XOOPS_ROOT_PATH.'/class/wysiwyg/formwysiwygtextarea.php');
182 182
                     $editor = new XoopsFormWysiwygTextArea($caption, $name, $value, $width, $height, '');
183 183
                 }
184 184
                 break;
@@ -200,9 +200,9 @@  discard block
 block discarded – undo
200 200
     public static function javascriptLinkConfirm($message, $form = false)
201 201
     {
202 202
         if (!$form) {
203
-            return "onclick=\"javascript:return confirm('" . str_replace("'", ' ', $message) . "')\"";
203
+            return "onclick=\"javascript:return confirm('".str_replace("'", ' ', $message)."')\"";
204 204
         } else {
205
-            return "onSubmit=\"javascript:return confirm('" . str_replace("'", ' ', $message) . "')\"";
205
+            return "onSubmit=\"javascript:return confirm('".str_replace("'", ' ', $message)."')\"";
206 206
         }
207 207
     }
208 208
 
@@ -282,7 +282,7 @@  discard block
 block discarded – undo
282 282
     public static function sendEmailFromTpl($tplName, $recipients, $subject, $variables)
283 283
     {
284 284
         global $xoopsConfig;
285
-        require_once XOOPS_ROOT_PATH . '/class/xoopsmailer.php';
285
+        require_once XOOPS_ROOT_PATH.'/class/xoopsmailer.php';
286 286
         if (!is_array($recipients)) {
287 287
             if (trim($recipients) == '') {
288 288
                 return false;
@@ -293,13 +293,13 @@  discard block
 block discarded – undo
293 293
             }
294 294
         }
295 295
         if (function_exists('xoops_getMailer')) {
296
-            $xoopsMailer =& xoops_getMailer();
296
+            $xoopsMailer = & xoops_getMailer();
297 297
         } else {
298
-            $xoopsMailer =& getMailer();
298
+            $xoopsMailer = & getMailer();
299 299
         }
300 300
 
301 301
         $xoopsMailer->useMail();
302
-        $xoopsMailer->setTemplateDir(XOOPS_ROOT_PATH . '/modules/' . self::MODULE_NAME . '/language/' . $xoopsConfig['language'] . '/mail_template');
302
+        $xoopsMailer->setTemplateDir(XOOPS_ROOT_PATH.'/modules/'.self::MODULE_NAME.'/language/'.$xoopsConfig['language'].'/mail_template');
303 303
         $xoopsMailer->setTemplate($tplName);
304 304
         $xoopsMailer->setToEmails($recipients);
305 305
         // TODO: Change !
@@ -311,7 +311,7 @@  discard block
 block discarded – undo
311 311
         }
312 312
         $res = $xoopsMailer->send();
313 313
         unset($xoopsMailer);
314
-        $filename = XOOPS_UPLOAD_PATH . '/logmail_' . self::MODULE_NAME . '.php';
314
+        $filename = XOOPS_UPLOAD_PATH.'/logmail_'.self::MODULE_NAME.'.php';
315 315
         if (!file_exists($filename)) {
316 316
             $fp = @fopen($filename, 'a');
317 317
             if ($fp) {
@@ -322,16 +322,16 @@  discard block
 block discarded – undo
322 322
         $fp = @fopen($filename, 'a');
323 323
 
324 324
         if ($fp) {
325
-            fwrite($fp, str_repeat('-', 120) . "\n");
326
-            fwrite($fp, date('d/m/Y H:i:s') . "\n");
327
-            fwrite($fp, 'Template name : ' . $tplName . "\n");
328
-            fwrite($fp, 'Email subject : ' . $subject . "\n");
325
+            fwrite($fp, str_repeat('-', 120)."\n");
326
+            fwrite($fp, date('d/m/Y H:i:s')."\n");
327
+            fwrite($fp, 'Template name : '.$tplName."\n");
328
+            fwrite($fp, 'Email subject : '.$subject."\n");
329 329
             if (is_array($recipients)) {
330
-                fwrite($fp, 'Recipient(s) : ' . implode(',', $recipients) . "\n");
330
+                fwrite($fp, 'Recipient(s) : '.implode(',', $recipients)."\n");
331 331
             } else {
332
-                fwrite($fp, 'Recipient(s) : ' . $recipients . "\n");
332
+                fwrite($fp, 'Recipient(s) : '.$recipients."\n");
333 333
             }
334
-            fwrite($fp, 'Transmited variables : ' . implode(',', $variables) . "\n");
334
+            fwrite($fp, 'Transmited variables : '.implode(',', $variables)."\n");
335 335
             fclose($fp);
336 336
         }
337 337
 
@@ -346,17 +346,17 @@  discard block
 block discarded – undo
346 346
         global $xoopsModule;
347 347
         $folder  = $xoopsModule->getVar('dirname');
348 348
         $tpllist = array();
349
-        require_once XOOPS_ROOT_PATH . '/class/xoopsblock.php';
350
-        require_once XOOPS_ROOT_PATH . '/class/template.php';
349
+        require_once XOOPS_ROOT_PATH.'/class/xoopsblock.php';
350
+        require_once XOOPS_ROOT_PATH.'/class/template.php';
351 351
         $tplfile_handler = xoops_getHandler('tplfile');
352 352
         $tpllist         = $tplfile_handler->find(null, null, null, $folder);
353
-        xoops_template_clear_module_cache($xoopsModule->getVar('mid'));            // Clear module's blocks cache
353
+        xoops_template_clear_module_cache($xoopsModule->getVar('mid')); // Clear module's blocks cache
354 354
 
355 355
         foreach ($tpllist as $onetemplate) {    // Remove cache for each page.
356 356
             if ($onetemplate->getVar('tpl_type') === 'module') {
357 357
                 //  Note, I've been testing all the other methods (like the one of Smarty) and none of them run, that's why I have used this code
358 358
                 $files_del = array();
359
-                $files_del = glob(XOOPS_CACHE_PATH . '/*' . $onetemplate->getVar('tpl_file') . '*');
359
+                $files_del = glob(XOOPS_CACHE_PATH.'/*'.$onetemplate->getVar('tpl_file').'*');
360 360
                 if (count($files_del) > 0 && is_array($files_del)) {
361 361
                     foreach ($files_del as $one_file) {
362 362
                         if (is_file($one_file)) {
@@ -392,7 +392,7 @@  discard block
 block discarded – undo
392 392
         if (!isset($mymodule)) {
393 393
             global $xoopsModule;
394 394
             if (isset($xoopsModule) && is_object($xoopsModule) && $xoopsModule->getVar('dirname') == REFERENCES_DIRNAME) {
395
-                $mymodule =& $xoopsModule;
395
+                $mymodule = & $xoopsModule;
396 396
             } else {
397 397
                 $hModule  = xoops_getHandler('module');
398 398
                 $mymodule = $hModule->getByDirname(REFERENCES_DIRNAME);
@@ -510,12 +510,12 @@  discard block
 block discarded – undo
510 510
      */
511 511
     public static function getCurrentSQLDate()
512 512
     {
513
-        return date('Y-m-d');    // 2007-05-02
513
+        return date('Y-m-d'); // 2007-05-02
514 514
     }
515 515
 
516 516
     public static function getCurrentSQLDateTime()
517 517
     {
518
-        return date('Y-m-d H:i:s');    // 2007-05-02
518
+        return date('Y-m-d H:i:s'); // 2007-05-02
519 519
     }
520 520
 
521 521
     /**
@@ -542,7 +542,7 @@  discard block
 block discarded – undo
542 542
      */
543 543
     public static function timestampToMysqlDate($timestamp)
544 544
     {
545
-        return date('Y-m-d', (int)$timestamp);
545
+        return date('Y-m-d', (int) $timestamp);
546 546
     }
547 547
 
548 548
     /**
@@ -580,7 +580,7 @@  discard block
 block discarded – undo
580 580
         }
581 581
         if (strpos(strtolower(XOOPS_VERSION), 'legacy') === false) {
582 582
             $xv = xoops_trim(str_replace('XOOPS ', '', XOOPS_VERSION));
583
-            if ((int)substr($xv, 4, 2) >= 17) {
583
+            if ((int) substr($xv, 4, 2) >= 17) {
584 584
                 return false;
585 585
             }
586 586
         }
@@ -643,25 +643,25 @@  discard block
 block discarded – undo
643 643
         }
644 644
         $ext  = basename($fileName);
645 645
         $ext  = explode('.', $ext);
646
-        $ext  = '.' . $ext[count($ext) - 1];
646
+        $ext  = '.'.$ext[count($ext) - 1];
647 647
         $true = true;
648 648
         while ($true) {
649 649
             $ipbits = explode('.', $_SERVER['REMOTE_ADDR']);
650 650
             list($usec, $sec) = explode(' ', microtime());
651
-            $usec = (integer)($usec * 65536);
652
-            $sec  = ((integer)$sec) & 0xFFFF;
651
+            $usec = (integer) ($usec * 65536);
652
+            $sec  = ((integer) $sec)&0xFFFF;
653 653
 
654 654
             if ($trimName) {
655
-                $uid = sprintf('%06x%04x%04x', ($ipbits[0] << 24) | ($ipbits[1] << 16) | ($ipbits[2] << 8) | $ipbits[3], $sec, $usec);
655
+                $uid = sprintf('%06x%04x%04x', ($ipbits[0] << 24)|($ipbits[1] << 16)|($ipbits[2] << 8)|$ipbits[3], $sec, $usec);
656 656
             } else {
657
-                $uid = sprintf('%08x-%04x-%04x', ($ipbits[0] << 24) | ($ipbits[1] << 16) | ($ipbits[2] << 8) | $ipbits[3], $sec, $usec);
657
+                $uid = sprintf('%08x-%04x-%04x', ($ipbits[0] << 24)|($ipbits[1] << 16)|($ipbits[2] << 8)|$ipbits[3], $sec, $usec);
658 658
             }
659
-            if (!file_exists($workingfolder . $uid . $ext)) {
659
+            if (!file_exists($workingfolder.$uid.$ext)) {
660 660
                 $true = false;
661 661
             }
662 662
         }
663 663
 
664
-        return $uid . $ext;
664
+        return $uid.$ext;
665 665
     }
666 666
 
667 667
     /**
@@ -676,135 +676,135 @@  discard block
 block discarded – undo
676 676
         $chaine = html_entity_decode($chaine);
677 677
 
678 678
         for ($i = 0; $i <= 255; ++$i) {
679
-            $search[]  = '&#' . $i . ';';
679
+            $search[]  = '&#'.$i.';';
680 680
             $replace[] = chr($i);
681 681
         }
682
-        $replace[]='...'; $search[]='…';
683
-        $replace[]="'"; $search[]='‘';
684
-        $replace[]="'"; $search[]= '’';
685
-        $replace[]='-'; $search[] = '&bull;';   // $replace[] = '•';
686
-        $replace[]='—'; $search[]='&mdash;';
687
-        $replace[]='-'; $search[]='&ndash;';
688
-        $replace[]='-'; $search[]='&shy;';
689
-        $replace[]='"'; $search[]='&quot;';
690
-        $replace[]='&'; $search[]='&amp;';
691
-        $replace[]='ˆ'; $search[]='&circ;';
692
-        $replace[]='¡'; $search[]='&iexcl;';
693
-        $replace[]='¦'; $search[]='&brvbar;';
694
-        $replace[]='¨'; $search[]='&uml;';
695
-        $replace[]='¯'; $search[]='&macr;';
696
-        $replace[]='´'; $search[]='&acute;';
697
-        $replace[]='¸'; $search[]='&cedil;';
698
-        $replace[]='¿'; $search[]='&iquest;';
699
-        $replace[]='˜'; $search[]='&tilde;';
700
-        $replace[]="'"; $search[]='&lsquo;';    // $replace[]='‘';
701
-        $replace[]="'"; $search[]='&rsquo;';    // $replace[]='’';
702
-        $replace[]='‚'; $search[]='&sbquo;';
703
-        $replace[]="'"; $search[]='&ldquo;';    // $replace[]='“';
704
-        $replace[]="'"; $search[]='&rdquo;';    // $replace[]='”';
705
-        $replace[]='„'; $search[]='&bdquo;';
706
-        $replace[]='‹'; $search[]='&lsaquo;';
707
-        $replace[]='›'; $search[]='&rsaquo;';
708
-        $replace[]='<'; $search[]='&lt;';
709
-        $replace[]='>'; $search[]='&gt;';
710
-        $replace[]='±'; $search[]='&plusmn;';
711
-        $replace[]='«'; $search[]='&laquo;';
712
-        $replace[]='»'; $search[]='&raquo;';
713
-        $replace[]='×'; $search[]='&times;';
714
-        $replace[]='÷'; $search[]='&divide;';
715
-        $replace[]='¢'; $search[]='&cent;';
716
-        $replace[]='£'; $search[]='&pound;';
717
-        $replace[]='¤'; $search[]='&curren;';
718
-        $replace[]='¥'; $search[]='&yen;';
719
-        $replace[]='§'; $search[]='&sect;';
720
-        $replace[]='©'; $search[]='&copy;';
721
-        $replace[]='¬'; $search[]='&not;';
722
-        $replace[]='®'; $search[]='&reg;';
723
-        $replace[]='°'; $search[]='&deg;';
724
-        $replace[]='µ'; $search[]='&micro;';
725
-        $replace[]='¶'; $search[]='&para;';
726
-        $replace[]='·'; $search[]='&middot;';
727
-        $replace[]='†'; $search[]='&dagger;';
728
-        $replace[]='‡'; $search[]='&Dagger;';
729
-        $replace[]='‰'; $search[]='&permil;';
730
-        $replace[]='Euro'; $search[]='&euro;';      // $replace[]='€'
731
-        $replace[]='¼'; $search[]='&frac14;';
732
-        $replace[]='½'; $search[]='&frac12;';
733
-        $replace[]='¾'; $search[]='&frac34;';
734
-        $replace[]='¹'; $search[]='&sup1;';
735
-        $replace[]='²'; $search[]='&sup2;';
736
-        $replace[]='³'; $search[]='&sup3;';
737
-        $replace[]='á'; $search[]='&aacute;';
738
-        $replace[]='Á'; $search[]='&Aacute;';
739
-        $replace[]='â'; $search[]='&acirc;';
740
-        $replace[]='Â'; $search[]='&Acirc;';
741
-        $replace[]='à'; $search[]='&agrave;';
742
-        $replace[]='À'; $search[]='&Agrave;';
743
-        $replace[]='å'; $search[]='&aring;';
744
-        $replace[]='Å'; $search[]='&Aring;';
745
-        $replace[]='ã'; $search[]='&atilde;';
746
-        $replace[]='Ã'; $search[]='&Atilde;';
747
-        $replace[]='ä'; $search[]='&auml;';
748
-        $replace[]='Ä'; $search[]='&Auml;';
749
-        $replace[]='ª'; $search[]='&ordf;';
750
-        $replace[]='æ'; $search[]='&aelig;';
751
-        $replace[]='Æ'; $search[]='&AElig;';
752
-        $replace[]='ç'; $search[]='&ccedil;';
753
-        $replace[]='Ç'; $search[]='&Ccedil;';
754
-        $replace[]='ð'; $search[]='&eth;';
755
-        $replace[]='Ð'; $search[]='&ETH;';
756
-        $replace[]='é'; $search[]='&eacute;';
757
-        $replace[]='É'; $search[]='&Eacute;';
758
-        $replace[]='ê'; $search[]='&ecirc;';
759
-        $replace[]='Ê'; $search[]='&Ecirc;';
760
-        $replace[]='è'; $search[]='&egrave;';
761
-        $replace[]='È'; $search[]='&Egrave;';
762
-        $replace[]='ë'; $search[]='&euml;';
763
-        $replace[]='Ë'; $search[]='&Euml;';
764
-        $replace[]='ƒ'; $search[]='&fnof;';
765
-        $replace[]='í'; $search[]='&iacute;';
766
-        $replace[]='Í'; $search[]='&Iacute;';
767
-        $replace[]='î'; $search[]='&icirc;';
768
-        $replace[]='Î'; $search[]='&Icirc;';
769
-        $replace[]='ì'; $search[]='&igrave;';
770
-        $replace[]='Ì'; $search[]='&Igrave;';
771
-        $replace[]='ï'; $search[]='&iuml;';
772
-        $replace[]='Ï'; $search[]='&Iuml;';
773
-        $replace[]='ñ'; $search[]='&ntilde;';
774
-        $replace[]='Ñ'; $search[]='&Ntilde;';
775
-        $replace[]='ó'; $search[]='&oacute;';
776
-        $replace[]='Ó'; $search[]='&Oacute;';
777
-        $replace[]='ô'; $search[]='&ocirc;';
778
-        $replace[]='Ô'; $search[]='&Ocirc;';
779
-        $replace[]='ò'; $search[]='&ograve;';
780
-        $replace[]='Ò'; $search[]='&Ograve;';
781
-        $replace[]='º'; $search[]='&ordm;';
782
-        $replace[]='ø'; $search[]='&oslash;';
783
-        $replace[]='Ø'; $search[]='&Oslash;';
784
-        $replace[]='õ'; $search[]='&otilde;';
785
-        $replace[]='Õ'; $search[]='&Otilde;';
786
-        $replace[]='ö'; $search[]='&ouml;';
787
-        $replace[]='Ö'; $search[]='&Ouml;';
788
-        $replace[]='œ'; $search[]='&oelig;';
789
-        $replace[]='Œ'; $search[]='&OElig;';
790
-        $replace[]='š'; $search[]='&scaron;';
791
-        $replace[]='Š'; $search[]='&Scaron;';
792
-        $replace[]='ß'; $search[]='&szlig;';
793
-        $replace[]='þ'; $search[]='&thorn;';
794
-        $replace[]='Þ'; $search[]='&THORN;';
795
-        $replace[]='ú'; $search[]='&uacute;';
796
-        $replace[]='Ú'; $search[]='&Uacute;';
797
-        $replace[]='û'; $search[]='&ucirc;';
798
-        $replace[]='Û'; $search[]='&Ucirc;';
799
-        $replace[]='ù'; $search[]='&ugrave;';
800
-        $replace[]='Ù'; $search[]='&Ugrave;';
801
-        $replace[]='ü'; $search[]='&uuml;';
802
-        $replace[]='Ü'; $search[]='&Uuml;';
803
-        $replace[]='ý'; $search[]='&yacute;';
804
-        $replace[]='Ý'; $search[]='&Yacute;';
805
-        $replace[]='ÿ'; $search[]='&yuml;';
806
-        $replace[]='Ÿ'; $search[]='&Yuml;';
807
-        $chaine    = str_replace($search, $replace, $chaine);
682
+        $replace[] = '...'; $search[] = '…';
683
+        $replace[] = "'"; $search[] = '‘';
684
+        $replace[] = "'"; $search[] = '’';
685
+        $replace[] = '-'; $search[] = '&bull;'; // $replace[] = '•';
686
+        $replace[] = '—'; $search[] = '&mdash;';
687
+        $replace[] = '-'; $search[] = '&ndash;';
688
+        $replace[] = '-'; $search[] = '&shy;';
689
+        $replace[] = '"'; $search[] = '&quot;';
690
+        $replace[] = '&'; $search[] = '&amp;';
691
+        $replace[] = 'ˆ'; $search[] = '&circ;';
692
+        $replace[] = '¡'; $search[] = '&iexcl;';
693
+        $replace[] = '¦'; $search[] = '&brvbar;';
694
+        $replace[] = '¨'; $search[] = '&uml;';
695
+        $replace[] = '¯'; $search[] = '&macr;';
696
+        $replace[] = '´'; $search[] = '&acute;';
697
+        $replace[] = '¸'; $search[] = '&cedil;';
698
+        $replace[] = '¿'; $search[] = '&iquest;';
699
+        $replace[] = '˜'; $search[] = '&tilde;';
700
+        $replace[] = "'"; $search[] = '&lsquo;'; // $replace[]='‘';
701
+        $replace[] = "'"; $search[] = '&rsquo;'; // $replace[]='’';
702
+        $replace[] = '‚'; $search[] = '&sbquo;';
703
+        $replace[] = "'"; $search[] = '&ldquo;'; // $replace[]='“';
704
+        $replace[] = "'"; $search[] = '&rdquo;'; // $replace[]='”';
705
+        $replace[] = '„'; $search[] = '&bdquo;';
706
+        $replace[] = '‹'; $search[] = '&lsaquo;';
707
+        $replace[] = '›'; $search[] = '&rsaquo;';
708
+        $replace[] = '<'; $search[] = '&lt;';
709
+        $replace[] = '>'; $search[] = '&gt;';
710
+        $replace[] = '±'; $search[] = '&plusmn;';
711
+        $replace[] = '«'; $search[] = '&laquo;';
712
+        $replace[] = '»'; $search[] = '&raquo;';
713
+        $replace[] = '×'; $search[] = '&times;';
714
+        $replace[] = '÷'; $search[] = '&divide;';
715
+        $replace[] = '¢'; $search[] = '&cent;';
716
+        $replace[] = '£'; $search[] = '&pound;';
717
+        $replace[] = '¤'; $search[] = '&curren;';
718
+        $replace[] = '¥'; $search[] = '&yen;';
719
+        $replace[] = '§'; $search[] = '&sect;';
720
+        $replace[] = '©'; $search[] = '&copy;';
721
+        $replace[] = '¬'; $search[] = '&not;';
722
+        $replace[] = '®'; $search[] = '&reg;';
723
+        $replace[] = '°'; $search[] = '&deg;';
724
+        $replace[] = 'µ'; $search[] = '&micro;';
725
+        $replace[] = '¶'; $search[] = '&para;';
726
+        $replace[] = '·'; $search[] = '&middot;';
727
+        $replace[] = '†'; $search[] = '&dagger;';
728
+        $replace[] = '‡'; $search[] = '&Dagger;';
729
+        $replace[] = '‰'; $search[] = '&permil;';
730
+        $replace[] = 'Euro'; $search[] = '&euro;'; // $replace[]='€'
731
+        $replace[] = '¼'; $search[] = '&frac14;';
732
+        $replace[] = '½'; $search[] = '&frac12;';
733
+        $replace[] = '¾'; $search[] = '&frac34;';
734
+        $replace[] = '¹'; $search[] = '&sup1;';
735
+        $replace[] = '²'; $search[] = '&sup2;';
736
+        $replace[] = '³'; $search[] = '&sup3;';
737
+        $replace[] = 'á'; $search[] = '&aacute;';
738
+        $replace[] = 'Á'; $search[] = '&Aacute;';
739
+        $replace[] = 'â'; $search[] = '&acirc;';
740
+        $replace[] = 'Â'; $search[] = '&Acirc;';
741
+        $replace[] = 'à'; $search[] = '&agrave;';
742
+        $replace[] = 'À'; $search[] = '&Agrave;';
743
+        $replace[] = 'å'; $search[] = '&aring;';
744
+        $replace[] = 'Å'; $search[] = '&Aring;';
745
+        $replace[] = 'ã'; $search[] = '&atilde;';
746
+        $replace[] = 'Ã'; $search[] = '&Atilde;';
747
+        $replace[] = 'ä'; $search[] = '&auml;';
748
+        $replace[] = 'Ä'; $search[] = '&Auml;';
749
+        $replace[] = 'ª'; $search[] = '&ordf;';
750
+        $replace[] = 'æ'; $search[] = '&aelig;';
751
+        $replace[] = 'Æ'; $search[] = '&AElig;';
752
+        $replace[] = 'ç'; $search[] = '&ccedil;';
753
+        $replace[] = 'Ç'; $search[] = '&Ccedil;';
754
+        $replace[] = 'ð'; $search[] = '&eth;';
755
+        $replace[] = 'Ð'; $search[] = '&ETH;';
756
+        $replace[] = 'é'; $search[] = '&eacute;';
757
+        $replace[] = 'É'; $search[] = '&Eacute;';
758
+        $replace[] = 'ê'; $search[] = '&ecirc;';
759
+        $replace[] = 'Ê'; $search[] = '&Ecirc;';
760
+        $replace[] = 'è'; $search[] = '&egrave;';
761
+        $replace[] = 'È'; $search[] = '&Egrave;';
762
+        $replace[] = 'ë'; $search[] = '&euml;';
763
+        $replace[] = 'Ë'; $search[] = '&Euml;';
764
+        $replace[] = 'ƒ'; $search[] = '&fnof;';
765
+        $replace[] = 'í'; $search[] = '&iacute;';
766
+        $replace[] = 'Í'; $search[] = '&Iacute;';
767
+        $replace[] = 'î'; $search[] = '&icirc;';
768
+        $replace[] = 'Î'; $search[] = '&Icirc;';
769
+        $replace[] = 'ì'; $search[] = '&igrave;';
770
+        $replace[] = 'Ì'; $search[] = '&Igrave;';
771
+        $replace[] = 'ï'; $search[] = '&iuml;';
772
+        $replace[] = 'Ï'; $search[] = '&Iuml;';
773
+        $replace[] = 'ñ'; $search[] = '&ntilde;';
774
+        $replace[] = 'Ñ'; $search[] = '&Ntilde;';
775
+        $replace[] = 'ó'; $search[] = '&oacute;';
776
+        $replace[] = 'Ó'; $search[] = '&Oacute;';
777
+        $replace[] = 'ô'; $search[] = '&ocirc;';
778
+        $replace[] = 'Ô'; $search[] = '&Ocirc;';
779
+        $replace[] = 'ò'; $search[] = '&ograve;';
780
+        $replace[] = 'Ò'; $search[] = '&Ograve;';
781
+        $replace[] = 'º'; $search[] = '&ordm;';
782
+        $replace[] = 'ø'; $search[] = '&oslash;';
783
+        $replace[] = 'Ø'; $search[] = '&Oslash;';
784
+        $replace[] = 'õ'; $search[] = '&otilde;';
785
+        $replace[] = 'Õ'; $search[] = '&Otilde;';
786
+        $replace[] = 'ö'; $search[] = '&ouml;';
787
+        $replace[] = 'Ö'; $search[] = '&Ouml;';
788
+        $replace[] = 'œ'; $search[] = '&oelig;';
789
+        $replace[] = 'Œ'; $search[] = '&OElig;';
790
+        $replace[] = 'š'; $search[] = '&scaron;';
791
+        $replace[] = 'Š'; $search[] = '&Scaron;';
792
+        $replace[] = 'ß'; $search[] = '&szlig;';
793
+        $replace[] = 'þ'; $search[] = '&thorn;';
794
+        $replace[] = 'Þ'; $search[] = '&THORN;';
795
+        $replace[] = 'ú'; $search[] = '&uacute;';
796
+        $replace[] = 'Ú'; $search[] = '&Uacute;';
797
+        $replace[] = 'û'; $search[] = '&ucirc;';
798
+        $replace[] = 'Û'; $search[] = '&Ucirc;';
799
+        $replace[] = 'ù'; $search[] = '&ugrave;';
800
+        $replace[] = 'Ù'; $search[] = '&Ugrave;';
801
+        $replace[] = 'ü'; $search[] = '&uuml;';
802
+        $replace[] = 'Ü'; $search[] = '&Uuml;';
803
+        $replace[] = 'ý'; $search[] = '&yacute;';
804
+        $replace[] = 'Ý'; $search[] = '&Yacute;';
805
+        $replace[] = 'ÿ'; $search[] = '&yuml;';
806
+        $replace[] = 'Ÿ'; $search[] = '&Yuml;';
807
+        $chaine = str_replace($search, $replace, $chaine);
808 808
 
809 809
         return $chaine;
810 810
     }
@@ -821,11 +821,11 @@  discard block
 block discarded – undo
821 821
     {
822 822
         $s       = "ÀÁÂÃÄÅÒÓÔÕÖØÈÉÊËÇÌÍÎÏÙÚÛÜŸÑàáâãäåòóôõöøèéêëçìíîïùúûüÿñ '()";
823 823
         $r       = 'AAAAAAOOOOOOEEEECIIIIUUUUYNaaaaaaooooooeeeeciiiiuuuuyn----';
824
-        $content = self::unhtml($content);    // First, remove html entities
824
+        $content = self::unhtml($content); // First, remove html entities
825 825
         $content = strtr($content, $s, $r);
826 826
         $content = strip_tags($content);
827 827
         $content = strtolower($content);
828
-        $content = htmlentities($content);    // TODO: Vérifier
828
+        $content = htmlentities($content); // TODO: Vérifier
829 829
         $content = preg_replace('/&([a-zA-Z])(uml|acute|grave|circ|tilde);/', '$1', $content);
830 830
         $content = html_entity_decode($content);
831 831
         $content = eregi_replace('quot', ' ', $content);
@@ -840,7 +840,7 @@  discard block
 block discarded – undo
840 840
         $keywords = '';
841 841
         foreach ($words as $word) {
842 842
             if (strlen($word) >= $urw) {
843
-                $keywords .= '-' . trim($word);
843
+                $keywords .= '-'.trim($word);
844 844
             }
845 845
         }
846 846
         if (!$keywords) {
@@ -875,7 +875,7 @@  discard block
 block discarded – undo
875 875
             $limit = $_SESSION['references_keywords_limit'];
876 876
         } else {
877 877
             $config_handler                        = xoops_getHandler('config');
878
-            $xoopsConfigSearch                     =& $config_handler->getConfigsByCat(XOOPS_CONF_SEARCH);
878
+            $xoopsConfigSearch                     = & $config_handler->getConfigsByCat(XOOPS_CONF_SEARCH);
879 879
             $limit                                 = $xoopsConfigSearch['keyword_min'];
880 880
             $_SESSION['references_keywords_limit'] = $limit;
881 881
         }
@@ -923,7 +923,7 @@  discard block
 block discarded – undo
923 923
             if (!isset($config_handler) || !is_object($config_handler)) {
924 924
                 $config_handler = xoops_getHandler('config');
925 925
             }
926
-            $xoopsConfigMetaFooter =& $config_handler->getConfigsByCat(XOOPS_CONF_METAFOOTER);
926
+            $xoopsConfigMetaFooter = & $config_handler->getConfigsByCat(XOOPS_CONF_METAFOOTER);
927 927
             if (isset($xoopsConfigMetaFooter['meta_keywords'])) {
928 928
                 return $xoopsConfigMetaFooter['meta_keywords'];
929 929
             } else {
@@ -945,10 +945,10 @@  discard block
 block discarded – undo
945 945
      */
946 946
     public static function uploadFile($indice, $dstpath = XOOPS_UPLOAD_PATH, $mimeTypes = null, $uploadMaxSize = null, $maxWidth = null, $maxHeight = null)
947 947
     {
948
-        require_once XOOPS_ROOT_PATH . '/class/uploader.php';
948
+        require_once XOOPS_ROOT_PATH.'/class/uploader.php';
949 949
         global $destname;
950 950
         if (isset($_POST['xoops_upload_file'])) {
951
-            require_once XOOPS_ROOT_PATH . '/class/uploader.php';
951
+            require_once XOOPS_ROOT_PATH.'/class/uploader.php';
952 952
             $fldname = '';
953 953
             $fldname = $_FILES[$_POST['xoops_upload_file'][$indice]];
954 954
             $fldname = get_magic_quotes_gpc() ? stripslashes($fldname['name']) : $fldname['name'];
@@ -972,7 +972,7 @@  discard block
 block discarded – undo
972 972
                     if ($uploader->upload()) {
973 973
                         return true;
974 974
                     } else {
975
-                        return _ERRORS . ' ' . htmlentities($uploader->getErrors());
975
+                        return _ERRORS.' '.htmlentities($uploader->getErrors());
976 976
                     }
977 977
                 } else {
978 978
                     return htmlentities($uploader->getErrors());
@@ -1055,9 +1055,9 @@  discard block
 block discarded – undo
1055 1055
         $workingBreadcrumb = array();
1056 1056
         if (is_array($path)) {
1057 1057
             $moduleName          = self::getModuleName();
1058
-            $workingBreadcrumb[] = "<a href='" . REFERENCES_URL . "' title='" . self::makeHrefTitle($moduleName) . "'>" . $moduleName . '</a>';
1058
+            $workingBreadcrumb[] = "<a href='".REFERENCES_URL."' title='".self::makeHrefTitle($moduleName)."'>".$moduleName.'</a>';
1059 1059
             foreach ($path as $url => $title) {
1060
-                $workingBreadcrumb[] = "<a href='" . $url . "'>" . $title . '</a>';
1060
+                $workingBreadcrumb[] = "<a href='".$url."'>".$title.'</a>';
1061 1061
             }
1062 1062
             $cnt = count($workingBreadcrumb);
1063 1063
             for ($i = 0; $i < $cnt; ++$i) {
@@ -1096,7 +1096,7 @@  discard block
 block discarded – undo
1096 1096
 
1097 1097
             $complete_tags = array_reverse($complete_tags);
1098 1098
             for ($i = 0; $i < count($complete_tags); ++$i) {
1099
-                $string .= '</' . $complete_tags[$i] . '>';
1099
+                $string .= '</'.$complete_tags[$i].'>';
1100 1100
             }
1101 1101
         }
1102 1102
 
@@ -1117,7 +1117,7 @@  discard block
 block discarded – undo
1117 1117
                 $string = self::close_tags($string);
1118 1118
             }
1119 1119
 
1120
-            return $string . $etc;
1120
+            return $string.$etc;
1121 1121
         } else {
1122 1122
             return $string;
1123 1123
         }
@@ -1149,7 +1149,7 @@  discard block
 block discarded – undo
1149 1149
     public static function getMimeType($filename)
1150 1150
     {
1151 1151
         if (function_exists('finfo_open')) {
1152
-            $pathToMagic = REFERENCES_PATH . 'mime/magic';
1152
+            $pathToMagic = REFERENCES_PATH.'mime/magic';
1153 1153
             $finfo       = new finfo(FILEINFO_MIME, $pathToMagic);
1154 1154
             $mimetype    = $finfo->file($filename);
1155 1155
             finfo_close($finfo);
@@ -1179,7 +1179,7 @@  discard block
 block discarded – undo
1179 1179
             sort($xoopsUsersIDs);
1180 1180
             if (count($xoopsUsersIDs) > 0) {
1181 1181
                 $member_handler = xoops_getHandler('user');
1182
-                $criteria       = new Criteria('uid', '(' . implode(',', $xoopsUsersIDs) . ')', 'IN');
1182
+                $criteria       = new Criteria('uid', '('.implode(',', $xoopsUsersIDs).')', 'IN');
1183 1183
                 $criteria->setSort('uid');
1184 1184
                 $users = $member_handler->getObjects($criteria, true);
1185 1185
             }
@@ -1217,7 +1217,7 @@  discard block
 block discarded – undo
1217 1217
         } else {
1218 1218
             if ($uid > 0) {
1219 1219
                 $member_handler = xoops_getHandler('member');
1220
-                $buffer[$uid]   = $member_handler->getGroupsByUser($uid, false);    // Renvoie un tableau d'ID (de groupes)
1220
+                $buffer[$uid]   = $member_handler->getGroupsByUser($uid, false); // Renvoie un tableau d'ID (de groupes)
1221 1221
             } else {
1222 1222
                 $buffer[$uid] = array(XOOPS_GROUP_ANONYMOUS);
1223 1223
             }
@@ -1244,7 +1244,7 @@  discard block
 block discarded – undo
1244 1244
             $retval = $buffer[$group];
1245 1245
         } else {
1246 1246
             $member_handler = xoops_getHandler('member');
1247
-            $groups         = $member_handler->getGroupsByUser($uid, false);    // Renvoie un tableau d'ID (de groupes)
1247
+            $groups         = $member_handler->getGroupsByUser($uid, false); // Renvoie un tableau d'ID (de groupes)
1248 1248
             $retval         = in_array($group, $groups);
1249 1249
             $buffer[$group] = $retval;
1250 1250
         }
@@ -1284,7 +1284,7 @@  discard block
 block discarded – undo
1284 1284
         static $cache = -1;
1285 1285
         if ($cache == -1) {
1286 1286
             global $xoopsDB;
1287
-            $sql    = 'SELECT COUNT(*) FROM ' . $xoopsDB->prefix('groups');
1287
+            $sql    = 'SELECT COUNT(*) FROM '.$xoopsDB->prefix('groups');
1288 1288
             $result = $xoopsDB->query($sql);
1289 1289
             if (!$result) {
1290 1290
                 return false;
@@ -1305,7 +1305,7 @@  discard block
 block discarded – undo
1305 1305
     {
1306 1306
         if (!is_dir($folder)) {
1307 1307
             mkdir($folder, 0777);
1308
-            file_put_contents($folder . '/index.html', '<script>history.go(-1);</script>');
1308
+            file_put_contents($folder.'/index.html', '<script>history.go(-1);</script>');
1309 1309
         } else {
1310 1310
             if (!is_writable($folder)) {
1311 1311
                 chmod($folder, 0777);
@@ -1326,10 +1326,10 @@  discard block
 block discarded – undo
1326 1326
         if (strstr($languageFile, $defaultExtension) === false) {
1327 1327
             $languageFile .= $defaultExtension;
1328 1328
         }
1329
-        if (file_exists($root . 'language' . DIRECTORY_SEPARATOR . $xoopsConfig['language'] . DIRECTORY_SEPARATOR . $languageFile)) {
1330
-            require_once $root . 'language' . DIRECTORY_SEPARATOR . $xoopsConfig['language'] . DIRECTORY_SEPARATOR . $languageFile;
1329
+        if (file_exists($root.'language'.DIRECTORY_SEPARATOR.$xoopsConfig['language'].DIRECTORY_SEPARATOR.$languageFile)) {
1330
+            require_once $root.'language'.DIRECTORY_SEPARATOR.$xoopsConfig['language'].DIRECTORY_SEPARATOR.$languageFile;
1331 1331
         } else {    // Fallback
1332
-            require_once $root . 'language' . DIRECTORY_SEPARATOR . 'english' . DIRECTORY_SEPARATOR . $languageFile;
1332
+            require_once $root.'language'.DIRECTORY_SEPARATOR.'english'.DIRECTORY_SEPARATOR.$languageFile;
1333 1333
         }
1334 1334
     }
1335 1335
 
@@ -1367,10 +1367,10 @@  discard block
 block discarded – undo
1367 1367
                 $left = $top = 0;
1368 1368
                 if (is_array($pictureDimensions)) {
1369 1369
                     if ($pictureWidth > $param_width) {
1370
-                        $left = (int)(($pictureWidth / 2) - ($param_width / 2));
1370
+                        $left = (int) (($pictureWidth / 2) - ($param_width / 2));
1371 1371
                     }
1372 1372
                     if ($pictureHeight > $param_height) {
1373
-                        $top = (int)(($pictureHeight / 2) - ($param_height / 2));
1373
+                        $top = (int) (($pictureHeight / 2) - ($param_height / 2));
1374 1374
                     }
1375 1375
                 }
1376 1376
                 $result = $img->crop($left, $top, $param_width, $param_height);
@@ -1410,7 +1410,7 @@  discard block
 block discarded – undo
1410 1410
                     $selected = " selected = 'selected'";
1411 1411
                 }
1412 1412
             }
1413
-            $ret[] = '<option value=0' . $selected . '>---</option>';
1413
+            $ret[] = '<option value=0'.$selected.'>---</option>';
1414 1414
         }
1415 1415
 
1416 1416
         foreach ($array as $index => $label) {
@@ -1424,7 +1424,7 @@  discard block
 block discarded – undo
1424 1424
                     $selected = " selected = 'selected'";
1425 1425
                 }
1426 1426
             }
1427
-            $ret[] = "<option value=\"" . $index . "\"" . $selected . '>' . $label . '</option>';
1427
+            $ret[] = "<option value=\"".$index."\"".$selected.'>'.$label.'</option>';
1428 1428
         }
1429 1429
 
1430 1430
         return implode("\n", $ret);
@@ -1446,14 +1446,14 @@  discard block
 block discarded – undo
1446 1446
     public static function htmlSelect($selectName, $array, $default, $withNull = true, $style = '', $multiple = false, $size = 1, $extra = '')
1447 1447
     {
1448 1448
         $ret = '';
1449
-        $ret .= "<select name='" . $selectName . "' id='" . $selectName . "'";
1449
+        $ret .= "<select name='".$selectName."' id='".$selectName."'";
1450 1450
         if (xoops_trim($style) != '') {
1451
-            $ret .= " style='" . $style . "' ";
1451
+            $ret .= " style='".$style."' ";
1452 1452
         }
1453 1453
         if (xoops_trim($multiple) != '') {
1454
-            $ret .= " multiple = 'multiple' size='" . $size . "' ";
1454
+            $ret .= " multiple = 'multiple' size='".$size."' ";
1455 1455
         }
1456
-        $ret .= $extra . ">\n";
1456
+        $ret .= $extra.">\n";
1457 1457
         $ret .= self::htmlSelectOptions($array, $default, $withNull);
1458 1458
         $ret .= "</select>\n";
1459 1459
 
@@ -1528,16 +1528,16 @@  discard block
 block discarded – undo
1528 1528
     {
1529 1529
         global $xoopsDB;
1530 1530
         define('REFERENCES_MAINTAIN', true);
1531
-        require self::MODULE_PATH . 'xoops_version.php';
1531
+        require self::MODULE_PATH.'xoops_version.php';
1532 1532
         $tables = array();
1533 1533
         foreach ($modversion['tables'] as $table) {
1534 1534
             $tables[] = $xoopsDB->prefix($table);
1535 1535
         }
1536 1536
         if (count($tables) > 0) {
1537 1537
             $list = implode(',', $tables);
1538
-            $xoopsDB->queryF('CHECK TABLE ' . $list);
1539
-            $xoopsDB->queryF('ANALYZE TABLE ' . $list);
1540
-            $xoopsDB->queryF('OPTIMIZE TABLE ' . $list);
1538
+            $xoopsDB->queryF('CHECK TABLE '.$list);
1539
+            $xoopsDB->queryF('ANALYZE TABLE '.$list);
1540
+            $xoopsDB->queryF('OPTIMIZE TABLE '.$list);
1541 1541
         }
1542 1542
         self::updateCache();
1543 1543
         $handlers = references_handler::getInstance();
Please login to merge, or discard this patch.