Completed
Push — 1.10.x ( f2aaaf...ef00db )
by Yannick
241:15 queued 197:35
created
main/auth/cas/lib/CAS/PGTStorage/pgt-file.php 5 patches
Doc Comments   +7 added lines, -7 removed lines patch added patch discarded remove patch
@@ -98,7 +98,7 @@  discard block
 block discarded – undo
98 98
    * This method returns an informational string giving the type of storage
99 99
    * used by the object (used for debugging purposes).
100 100
    *
101
-   * @return an informational string.
101
+   * @return string informational string.
102 102
    * @public
103 103
    */
104 104
   function getStorageType()
@@ -110,7 +110,7 @@  discard block
 block discarded – undo
110 110
    * This method returns an informational string giving informations on the
111 111
    * parameters of the storage.(used for debugging purposes).
112 112
    *
113
-   * @return an informational string.
113
+   * @return string informational string.
114 114
    * @public
115 115
    */
116 116
   function getStorageInfo()
@@ -125,9 +125,9 @@  discard block
 block discarded – undo
125 125
   /**
126 126
    * The class constructor, called by CASClient::SetPGTStorageFile().
127 127
    *
128
-   * @param $cas_parent the CASClient instance that creates the object.
129
-   * @param $format the format used to store the PGT's (`plain' and `xml' allowed).
130
-   * @param $path the path where the PGT's should be stored
128
+   * @param CASClient $cas_parent the CASClient instance that creates the object.
129
+   * @param string $format the format used to store the PGT's (`plain' and `xml' allowed).
130
+   * @param string $path the path where the PGT's should be stored
131 131
    *
132 132
    * @public
133 133
    */
@@ -202,7 +202,7 @@  discard block
 block discarded – undo
202 202
    *
203 203
    * @param $pgt_iou the PGT iou.
204 204
    *
205
-   * @return a filename
205
+   * @return string filename
206 206
    * @private
207 207
    */
208 208
   function getPGTIouFilename($pgt_iou)
@@ -243,7 +243,7 @@  discard block
 block discarded – undo
243 243
    *
244 244
    * @param $pgt_iou the PGT iou
245 245
    *
246
-   * @return the corresponding PGT, or FALSE on error
246
+   * @return false|string corresponding PGT, or FALSE on error
247 247
    *
248 248
    * @public
249 249
    */
Please login to merge, or discard this patch.
Switch Indentation   +6 added lines, -6 removed lines patch added patch discarded remove patch
@@ -163,12 +163,12 @@
 block discarded – undo
163 163
       $this->_path = $path;
164 164
       // check the format and store it
165 165
       switch ($format) {
166
-      case CAS_PGT_STORAGE_FILE_FORMAT_PLAIN:
167
-      case CAS_PGT_STORAGE_FILE_FORMAT_XML:
168
-	$this->_format = $format;
169
-	break;
170
-      default:
171
-	phpCAS::error('unknown PGT file storage format (`'.CAS_PGT_STORAGE_FILE_FORMAT_PLAIN.'\' and `'.CAS_PGT_STORAGE_FILE_FORMAT_XML.'\' allowed)');
166
+          case CAS_PGT_STORAGE_FILE_FORMAT_PLAIN:
167
+          case CAS_PGT_STORAGE_FILE_FORMAT_XML:
168
+	    $this->_format = $format;
169
+	    break;
170
+          default:
171
+	    phpCAS::error('unknown PGT file storage format (`'.CAS_PGT_STORAGE_FILE_FORMAT_PLAIN.'\' and `'.CAS_PGT_STORAGE_FILE_FORMAT_XML.'\' allowed)');
172 172
       }
173 173
       phpCAS::traceEnd();      
174 174
     }
Please login to merge, or discard this patch.
Spacing   +13 added lines, -13 removed lines patch added patch discarded remove patch
@@ -131,17 +131,17 @@  discard block
 block discarded – undo
131 131
    *
132 132
    * @public
133 133
    */
134
-  function PGTStorageFile($cas_parent,$format,$path)
134
+  function PGTStorageFile($cas_parent, $format, $path)
135 135
     {
136 136
       phpCAS::traceBegin();
137 137
       // call the ancestor's constructor
138 138
       $this->PGTStorage($cas_parent);
139 139
 
140
-      if (empty($format) ) $format = CAS_PGT_STORAGE_FILE_DEFAULT_FORMAT;
141
-      if (empty($path) ) $path = CAS_PGT_STORAGE_FILE_DEFAULT_PATH;
140
+      if (empty($format)) $format = CAS_PGT_STORAGE_FILE_DEFAULT_FORMAT;
141
+      if (empty($path)) $path = CAS_PGT_STORAGE_FILE_DEFAULT_PATH;
142 142
 
143 143
       // check that the path is an absolute path
144
-      if (getenv("OS")=="Windows_NT"){
144
+      if (getenv("OS") == "Windows_NT") {
145 145
       	
146 146
       	 if (!preg_match('`^[a-zA-Z]:`', $path)) {
147 147
 	     	phpCAS::error('an absolute path is needed for PGT storage to file');
@@ -151,13 +151,13 @@  discard block
 block discarded – undo
151 151
       else
152 152
       {
153 153
       
154
-      	if ( $path[0] != '/' ) {
154
+      	if ($path[0] != '/') {
155 155
 			phpCAS::error('an absolute path is needed for PGT storage to file');
156 156
       	}
157 157
 
158 158
       	// store the path (with a leading and trailing '/')      
159
-      	$path = preg_replace('|[/]*$|','/',$path);
160
-      	$path = preg_replace('|^[/]*|','/',$path);
159
+      	$path = preg_replace('|[/]*$|', '/', $path);
160
+      	$path = preg_replace('|^[/]*|', '/', $path);
161 161
       }
162 162
       
163 163
       $this->_path = $path;
@@ -186,7 +186,7 @@  discard block
 block discarded – undo
186 186
     {
187 187
       phpCAS::traceBegin();
188 188
       // if the storage has already been initialized, return immediatly
189
-      if ( $this->isInitialized() )
189
+      if ($this->isInitialized())
190 190
 	return;
191 191
       // call the ancestor's method (mark as initialized)
192 192
       parent::init();
@@ -222,12 +222,12 @@  discard block
 block discarded – undo
222 222
    *
223 223
    * @public
224 224
    */
225
-  function write($pgt,$pgt_iou)
225
+  function write($pgt, $pgt_iou)
226 226
     {
227 227
       phpCAS::traceBegin();
228 228
       $fname = $this->getPGTIouFilename($pgt_iou);
229
-      if ( $f=fopen($fname,"w") ) {
230
-	if ( fputs($f,$pgt) === FALSE ) {
229
+      if ($f = fopen($fname, "w")) {
230
+	if (fputs($f, $pgt) === FALSE) {
231 231
 	  phpCAS::error('could not write PGT to `'.$fname.'\'');
232 232
 	}
233 233
 	fclose($f);
@@ -252,10 +252,10 @@  discard block
 block discarded – undo
252 252
       phpCAS::traceBegin();
253 253
       $pgt = FALSE;
254 254
       $fname = $this->getPGTIouFilename($pgt_iou);
255
-      if ( !($f=fopen($fname,"r")) ) {
255
+      if (!($f = fopen($fname, "r"))) {
256 256
 	phpCAS::trace('could not open `'.$fname.'\'');
257 257
       } else {
258
-	if ( ($pgt=fgets($f)) === FALSE ) {
258
+	if (($pgt = fgets($f)) === FALSE) {
259 259
 	  phpCAS::trace('could not read PGT from `'.$fname.'\'');
260 260
 	} 
261 261
 	fclose($f);
Please login to merge, or discard this patch.
Braces   +10 added lines, -6 removed lines patch added patch discarded remove patch
@@ -137,8 +137,12 @@  discard block
 block discarded – undo
137 137
       // call the ancestor's constructor
138 138
       $this->PGTStorage($cas_parent);
139 139
 
140
-      if (empty($format) ) $format = CAS_PGT_STORAGE_FILE_DEFAULT_FORMAT;
141
-      if (empty($path) ) $path = CAS_PGT_STORAGE_FILE_DEFAULT_PATH;
140
+      if (empty($format) ) {
141
+          $format = CAS_PGT_STORAGE_FILE_DEFAULT_FORMAT;
142
+      }
143
+      if (empty($path) ) {
144
+          $path = CAS_PGT_STORAGE_FILE_DEFAULT_PATH;
145
+      }
142 146
 
143 147
       // check that the path is an absolute path
144 148
       if (getenv("OS")=="Windows_NT"){
@@ -147,8 +151,7 @@  discard block
 block discarded – undo
147 151
 	     	phpCAS::error('an absolute path is needed for PGT storage to file');
148 152
       	}
149 153
       	
150
-      }
151
-      else
154
+      } else
152 155
       {
153 156
       
154 157
       	if ( $path[0] != '/' ) {
@@ -186,8 +189,9 @@  discard block
 block discarded – undo
186 189
     {
187 190
       phpCAS::traceBegin();
188 191
       // if the storage has already been initialized, return immediatly
189
-      if ( $this->isInitialized() )
190
-	return;
192
+      if ( $this->isInitialized() ) {
193
+      	return;
194
+      }
191 195
       // call the ancestor's method (mark as initialized)
192 196
       parent::init();
193 197
       phpCAS::traceEnd();      
Please login to merge, or discard this patch.
Indentation   +181 added lines, -181 removed lines patch added patch discarded remove patch
@@ -44,231 +44,231 @@
 block discarded – undo
44 44
 
45 45
 class PGTStorageFile extends PGTStorage
46 46
 {
47
-  /** 
48
-   * @addtogroup internalPGTStorageFile 
49
-   * @{ 
50
-   */
47
+    /** 
48
+     * @addtogroup internalPGTStorageFile 
49
+     * @{ 
50
+     */
51 51
 
52
-  /**
53
-   * a string telling where PGT's should be stored on the filesystem. Written by
54
-   * PGTStorageFile::PGTStorageFile(), read by getPath().
55
-   *
56
-   * @private
57
-   */
58
-  var $_path;
52
+    /**
53
+     * a string telling where PGT's should be stored on the filesystem. Written by
54
+     * PGTStorageFile::PGTStorageFile(), read by getPath().
55
+     *
56
+     * @private
57
+     */
58
+    var $_path;
59 59
 
60
-  /**
61
-   * This method returns the name of the directory where PGT's should be stored 
62
-   * on the filesystem.
63
-   *
64
-   * @return the name of a directory (with leading and trailing '/')
65
-   *
66
-   * @private
67
-   */
68
-  function getPath()
60
+    /**
61
+     * This method returns the name of the directory where PGT's should be stored 
62
+     * on the filesystem.
63
+     *
64
+     * @return the name of a directory (with leading and trailing '/')
65
+     *
66
+     * @private
67
+     */
68
+    function getPath()
69 69
     {
70
-      return $this->_path;
70
+        return $this->_path;
71 71
     }
72 72
 
73
-  /**
74
-   * a string telling the format to use to store PGT's (plain or xml). Written by
75
-   * PGTStorageFile::PGTStorageFile(), read by getFormat().
76
-   *
77
-   * @private
78
-   */
79
-  var $_format;
73
+    /**
74
+     * a string telling the format to use to store PGT's (plain or xml). Written by
75
+     * PGTStorageFile::PGTStorageFile(), read by getFormat().
76
+     *
77
+     * @private
78
+     */
79
+    var $_format;
80 80
 
81
-  /**
82
-   * This method returns the format to use when storing PGT's on the filesystem.
83
-   *
84
-   * @return a string corresponding to the format used (plain or xml).
85
-   *
86
-   * @private
87
-   */
88
-  function getFormat()
81
+    /**
82
+     * This method returns the format to use when storing PGT's on the filesystem.
83
+     *
84
+     * @return a string corresponding to the format used (plain or xml).
85
+     *
86
+     * @private
87
+     */
88
+    function getFormat()
89 89
     {
90
-      return $this->_format;
90
+        return $this->_format;
91 91
     }
92 92
 
93
-  // ########################################################################
94
-  //  DEBUGGING
95
-  // ########################################################################
93
+    // ########################################################################
94
+    //  DEBUGGING
95
+    // ########################################################################
96 96
   
97
-  /**
98
-   * This method returns an informational string giving the type of storage
99
-   * used by the object (used for debugging purposes).
100
-   *
101
-   * @return an informational string.
102
-   * @public
103
-   */
104
-  function getStorageType()
97
+    /**
98
+     * This method returns an informational string giving the type of storage
99
+     * used by the object (used for debugging purposes).
100
+     *
101
+     * @return an informational string.
102
+     * @public
103
+     */
104
+    function getStorageType()
105 105
     {
106
-      return "file";
106
+        return "file";
107 107
     }
108 108
 
109
-  /**
110
-   * This method returns an informational string giving informations on the
111
-   * parameters of the storage.(used for debugging purposes).
112
-   *
113
-   * @return an informational string.
114
-   * @public
115
-   */
116
-  function getStorageInfo()
109
+    /**
110
+     * This method returns an informational string giving informations on the
111
+     * parameters of the storage.(used for debugging purposes).
112
+     *
113
+     * @return an informational string.
114
+     * @public
115
+     */
116
+    function getStorageInfo()
117 117
     {
118
-      return 'path=`'.$this->getPath().'\', format=`'.$this->getFormat().'\'';
118
+        return 'path=`'.$this->getPath().'\', format=`'.$this->getFormat().'\'';
119 119
     }
120 120
 
121
-  // ########################################################################
122
-  //  CONSTRUCTOR
123
-  // ########################################################################
121
+    // ########################################################################
122
+    //  CONSTRUCTOR
123
+    // ########################################################################
124 124
   
125
-  /**
126
-   * The class constructor, called by CASClient::SetPGTStorageFile().
127
-   *
128
-   * @param $cas_parent the CASClient instance that creates the object.
129
-   * @param $format the format used to store the PGT's (`plain' and `xml' allowed).
130
-   * @param $path the path where the PGT's should be stored
131
-   *
132
-   * @public
133
-   */
134
-  function PGTStorageFile($cas_parent,$format,$path)
125
+    /**
126
+     * The class constructor, called by CASClient::SetPGTStorageFile().
127
+     *
128
+     * @param $cas_parent the CASClient instance that creates the object.
129
+     * @param $format the format used to store the PGT's (`plain' and `xml' allowed).
130
+     * @param $path the path where the PGT's should be stored
131
+     *
132
+     * @public
133
+     */
134
+    function PGTStorageFile($cas_parent,$format,$path)
135 135
     {
136
-      phpCAS::traceBegin();
137
-      // call the ancestor's constructor
138
-      $this->PGTStorage($cas_parent);
136
+        phpCAS::traceBegin();
137
+        // call the ancestor's constructor
138
+        $this->PGTStorage($cas_parent);
139 139
 
140
-      if (empty($format) ) $format = CAS_PGT_STORAGE_FILE_DEFAULT_FORMAT;
141
-      if (empty($path) ) $path = CAS_PGT_STORAGE_FILE_DEFAULT_PATH;
140
+        if (empty($format) ) $format = CAS_PGT_STORAGE_FILE_DEFAULT_FORMAT;
141
+        if (empty($path) ) $path = CAS_PGT_STORAGE_FILE_DEFAULT_PATH;
142 142
 
143
-      // check that the path is an absolute path
144
-      if (getenv("OS")=="Windows_NT"){
143
+        // check that the path is an absolute path
144
+        if (getenv("OS")=="Windows_NT"){
145 145
       	
146
-      	 if (!preg_match('`^[a-zA-Z]:`', $path)) {
147
-	     	phpCAS::error('an absolute path is needed for PGT storage to file');
148
-      	}
146
+            if (!preg_match('`^[a-zA-Z]:`', $path)) {
147
+                phpCAS::error('an absolute path is needed for PGT storage to file');
148
+            }
149 149
       	
150
-      }
151
-      else
152
-      {
150
+        }
151
+        else
152
+        {
153 153
       
154
-      	if ( $path[0] != '/' ) {
155
-			phpCAS::error('an absolute path is needed for PGT storage to file');
156
-      	}
154
+            if ( $path[0] != '/' ) {
155
+            phpCAS::error('an absolute path is needed for PGT storage to file');
156
+            }
157 157
 
158
-      	// store the path (with a leading and trailing '/')      
159
-      	$path = preg_replace('|[/]*$|','/',$path);
160
-      	$path = preg_replace('|^[/]*|','/',$path);
161
-      }
158
+            // store the path (with a leading and trailing '/')      
159
+            $path = preg_replace('|[/]*$|','/',$path);
160
+            $path = preg_replace('|^[/]*|','/',$path);
161
+        }
162 162
       
163
-      $this->_path = $path;
164
-      // check the format and store it
165
-      switch ($format) {
166
-      case CAS_PGT_STORAGE_FILE_FORMAT_PLAIN:
163
+        $this->_path = $path;
164
+        // check the format and store it
165
+        switch ($format) {
166
+        case CAS_PGT_STORAGE_FILE_FORMAT_PLAIN:
167 167
       case CAS_PGT_STORAGE_FILE_FORMAT_XML:
168
-	$this->_format = $format;
169
-	break;
170
-      default:
171
-	phpCAS::error('unknown PGT file storage format (`'.CAS_PGT_STORAGE_FILE_FORMAT_PLAIN.'\' and `'.CAS_PGT_STORAGE_FILE_FORMAT_XML.'\' allowed)');
172
-      }
173
-      phpCAS::traceEnd();      
168
+    $this->_format = $format;
169
+    break;
170
+        default:
171
+    phpCAS::error('unknown PGT file storage format (`'.CAS_PGT_STORAGE_FILE_FORMAT_PLAIN.'\' and `'.CAS_PGT_STORAGE_FILE_FORMAT_XML.'\' allowed)');
172
+        }
173
+        phpCAS::traceEnd();      
174 174
     }
175 175
 
176
-  // ########################################################################
177
-  //  INITIALIZATION
178
-  // ########################################################################
176
+    // ########################################################################
177
+    //  INITIALIZATION
178
+    // ########################################################################
179 179
   
180
-  /**
181
-   * This method is used to initialize the storage. Halts on error.
182
-   *
183
-   * @public
184
-   */
185
-  function init()
180
+    /**
181
+     * This method is used to initialize the storage. Halts on error.
182
+     *
183
+     * @public
184
+     */
185
+    function init()
186 186
     {
187
-      phpCAS::traceBegin();
188
-      // if the storage has already been initialized, return immediatly
189
-      if ( $this->isInitialized() )
190
-	return;
191
-      // call the ancestor's method (mark as initialized)
192
-      parent::init();
193
-      phpCAS::traceEnd();      
187
+        phpCAS::traceBegin();
188
+        // if the storage has already been initialized, return immediatly
189
+        if ( $this->isInitialized() )
190
+    return;
191
+        // call the ancestor's method (mark as initialized)
192
+        parent::init();
193
+        phpCAS::traceEnd();      
194 194
     }
195 195
 
196
-  // ########################################################################
197
-  //  PGT I/O
198
-  // ########################################################################
196
+    // ########################################################################
197
+    //  PGT I/O
198
+    // ########################################################################
199 199
 
200
-  /**
201
-   * This method returns the filename corresponding to a PGT Iou.
202
-   *
203
-   * @param $pgt_iou the PGT iou.
204
-   *
205
-   * @return a filename
206
-   * @private
207
-   */
208
-  function getPGTIouFilename($pgt_iou)
200
+    /**
201
+     * This method returns the filename corresponding to a PGT Iou.
202
+     *
203
+     * @param $pgt_iou the PGT iou.
204
+     *
205
+     * @return a filename
206
+     * @private
207
+     */
208
+    function getPGTIouFilename($pgt_iou)
209 209
     {
210
-      phpCAS::traceBegin();
211
-      $filename = $this->getPath().$pgt_iou.'.'.$this->getFormat();
212
-      phpCAS::traceEnd($filename);
213
-      return $filename;
210
+        phpCAS::traceBegin();
211
+        $filename = $this->getPath().$pgt_iou.'.'.$this->getFormat();
212
+        phpCAS::traceEnd($filename);
213
+        return $filename;
214 214
     }
215 215
   
216
-  /**
217
-   * This method stores a PGT and its corresponding PGT Iou into a file. Echoes a
218
-   * warning on error.
219
-   *
220
-   * @param $pgt the PGT
221
-   * @param $pgt_iou the PGT iou
222
-   *
223
-   * @public
224
-   */
225
-  function write($pgt,$pgt_iou)
216
+    /**
217
+     * This method stores a PGT and its corresponding PGT Iou into a file. Echoes a
218
+     * warning on error.
219
+     *
220
+     * @param $pgt the PGT
221
+     * @param $pgt_iou the PGT iou
222
+     *
223
+     * @public
224
+     */
225
+    function write($pgt,$pgt_iou)
226 226
     {
227
-      phpCAS::traceBegin();
228
-      $fname = $this->getPGTIouFilename($pgt_iou);
229
-      if ( $f=fopen($fname,"w") ) {
230
-	if ( fputs($f,$pgt) === FALSE ) {
231
-	  phpCAS::error('could not write PGT to `'.$fname.'\'');
232
-	}
233
-	fclose($f);
234
-      } else {
235
-	phpCAS::error('could not open `'.$fname.'\'');
236
-      }
237
-      phpCAS::traceEnd();      
227
+        phpCAS::traceBegin();
228
+        $fname = $this->getPGTIouFilename($pgt_iou);
229
+        if ( $f=fopen($fname,"w") ) {
230
+    if ( fputs($f,$pgt) === FALSE ) {
231
+        phpCAS::error('could not write PGT to `'.$fname.'\'');
232
+    }
233
+    fclose($f);
234
+        } else {
235
+    phpCAS::error('could not open `'.$fname.'\'');
236
+        }
237
+        phpCAS::traceEnd();      
238 238
     }
239 239
 
240
-  /**
241
-   * This method reads a PGT corresponding to a PGT Iou and deletes the 
242
-   * corresponding file.
243
-   *
244
-   * @param $pgt_iou the PGT iou
245
-   *
246
-   * @return the corresponding PGT, or FALSE on error
247
-   *
248
-   * @public
249
-   */
250
-  function read($pgt_iou)
240
+    /**
241
+     * This method reads a PGT corresponding to a PGT Iou and deletes the 
242
+     * corresponding file.
243
+     *
244
+     * @param $pgt_iou the PGT iou
245
+     *
246
+     * @return the corresponding PGT, or FALSE on error
247
+     *
248
+     * @public
249
+     */
250
+    function read($pgt_iou)
251 251
     {
252
-      phpCAS::traceBegin();
253
-      $pgt = FALSE;
254
-      $fname = $this->getPGTIouFilename($pgt_iou);
255
-      if ( !($f=fopen($fname,"r")) ) {
256
-	phpCAS::trace('could not open `'.$fname.'\'');
257
-      } else {
258
-	if ( ($pgt=fgets($f)) === FALSE ) {
259
-	  phpCAS::trace('could not read PGT from `'.$fname.'\'');
260
-	} 
261
-	fclose($f);
262
-      }
252
+        phpCAS::traceBegin();
253
+        $pgt = FALSE;
254
+        $fname = $this->getPGTIouFilename($pgt_iou);
255
+        if ( !($f=fopen($fname,"r")) ) {
256
+    phpCAS::trace('could not open `'.$fname.'\'');
257
+        } else {
258
+    if ( ($pgt=fgets($f)) === FALSE ) {
259
+        phpCAS::trace('could not read PGT from `'.$fname.'\'');
260
+    } 
261
+    fclose($f);
262
+        }
263 263
 
264
-      // delete the PGT file
265
-      @unlink($fname);
264
+        // delete the PGT file
265
+        @unlink($fname);
266 266
 
267
-      phpCAS::traceEnd($pgt);
268
-      return $pgt;
267
+        phpCAS::traceEnd($pgt);
268
+        return $pgt;
269 269
     }
270 270
   
271
-  /** @} */
271
+    /** @} */
272 272
   
273 273
 }
274 274
 
Please login to merge, or discard this patch.
main/auth/cas/lib/CAS/PGTStorage/pgt-main.php 3 patches
Doc Comments   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -126,7 +126,7 @@  discard block
 block discarded – undo
126 126
   /**
127 127
    * This method returns an error message set by PGTStorage::setErrorMessage().
128 128
    *
129
-   * @return an error message when set by PGTStorage::setErrorMessage(), FALSE
129
+   * @return boolean error message when set by PGTStorage::setErrorMessage(), FALSE
130 130
    * otherwise.
131 131
    *
132 132
    * @public
@@ -153,7 +153,7 @@  discard block
 block discarded – undo
153 153
   /**
154 154
    * This method tells if the storage has already been intialized.
155 155
    *
156
-   * @return a boolean
156
+   * @return boolean boolean
157 157
    *
158 158
    * @protected
159 159
    */
Please login to merge, or discard this patch.
Indentation   +131 added lines, -131 removed lines patch added patch discarded remove patch
@@ -44,167 +44,167 @@
 block discarded – undo
44 44
 
45 45
 class PGTStorage
46 46
 {
47
-  /** 
48
-   * @addtogroup internalPGTStorage
49
-   * @{ 
50
-   */
51
-
52
-  // ########################################################################
53
-  //  CONSTRUCTOR
54
-  // ########################################################################
47
+    /** 
48
+     * @addtogroup internalPGTStorage
49
+     * @{ 
50
+     */
51
+
52
+    // ########################################################################
53
+    //  CONSTRUCTOR
54
+    // ########################################################################
55 55
   
56
-  /**
57
-   * The constructor of the class, should be called only by inherited classes.
58
-   *
59
-   * @param $cas_parent the CASclient instance that creates the current object.
60
-   *
61
-   * @protected
62
-   */
63
-  function PGTStorage($cas_parent)
56
+    /**
57
+     * The constructor of the class, should be called only by inherited classes.
58
+     *
59
+     * @param $cas_parent the CASclient instance that creates the current object.
60
+     *
61
+     * @protected
62
+     */
63
+    function PGTStorage($cas_parent)
64 64
     {
65
-      phpCAS::traceBegin();
66
-      if ( !$cas_parent->isProxy() ) {
67
-	phpCAS::error('defining PGT storage makes no sense when not using a CAS proxy'); 
68
-      }
69
-      phpCAS::traceEnd();
65
+        phpCAS::traceBegin();
66
+        if ( !$cas_parent->isProxy() ) {
67
+    phpCAS::error('defining PGT storage makes no sense when not using a CAS proxy'); 
68
+        }
69
+        phpCAS::traceEnd();
70 70
     }
71 71
 
72
-  // ########################################################################
73
-  //  DEBUGGING
74
-  // ########################################################################
72
+    // ########################################################################
73
+    //  DEBUGGING
74
+    // ########################################################################
75 75
   
76
-  /**
77
-   * This virtual method returns an informational string giving the type of storage
78
-   * used by the object (used for debugging purposes).
79
-   *
80
-   * @public
81
-   */
82
-  function getStorageType()
76
+    /**
77
+     * This virtual method returns an informational string giving the type of storage
78
+     * used by the object (used for debugging purposes).
79
+     *
80
+     * @public
81
+     */
82
+    function getStorageType()
83 83
     {
84
-      phpCAS::error(__CLASS__.'::'.__FUNCTION__.'() should never be called'); 
84
+        phpCAS::error(__CLASS__.'::'.__FUNCTION__.'() should never be called'); 
85 85
     }
86 86
 
87
-  /**
88
-   * This virtual method returns an informational string giving informations on the
89
-   * parameters of the storage.(used for debugging purposes).
90
-   *
91
-   * @public
92
-   */
93
-  function getStorageInfo()
87
+    /**
88
+     * This virtual method returns an informational string giving informations on the
89
+     * parameters of the storage.(used for debugging purposes).
90
+     *
91
+     * @public
92
+     */
93
+    function getStorageInfo()
94 94
     {
95
-      phpCAS::error(__CLASS__.'::'.__FUNCTION__.'() should never be called'); 
95
+        phpCAS::error(__CLASS__.'::'.__FUNCTION__.'() should never be called'); 
96 96
     }
97 97
 
98
-  // ########################################################################
99
-  //  ERROR HANDLING
100
-  // ########################################################################
98
+    // ########################################################################
99
+    //  ERROR HANDLING
100
+    // ########################################################################
101 101
   
102
-  /**
103
-   * string used to store an error message. Written by PGTStorage::setErrorMessage(),
104
-   * read by PGTStorage::getErrorMessage().
105
-   *
106
-   * @hideinitializer
107
-   * @private
108
-   * @deprecated not used.
109
-   */
110
-  var $_error_message=FALSE;
111
-
112
-  /**
113
-   * This method sets en error message, which can be read later by 
114
-   * PGTStorage::getErrorMessage().
115
-   *
116
-   * @param $error_message an error message
117
-   *
118
-   * @protected
119
-   * @deprecated not used.
120
-   */
121
-  function setErrorMessage($error_message)
102
+    /**
103
+     * string used to store an error message. Written by PGTStorage::setErrorMessage(),
104
+     * read by PGTStorage::getErrorMessage().
105
+     *
106
+     * @hideinitializer
107
+     * @private
108
+     * @deprecated not used.
109
+     */
110
+    var $_error_message=FALSE;
111
+
112
+    /**
113
+     * This method sets en error message, which can be read later by 
114
+     * PGTStorage::getErrorMessage().
115
+     *
116
+     * @param $error_message an error message
117
+     *
118
+     * @protected
119
+     * @deprecated not used.
120
+     */
121
+    function setErrorMessage($error_message)
122 122
     {
123
-      $this->_error_message = $error_message;
123
+        $this->_error_message = $error_message;
124 124
     }
125 125
 
126
-  /**
127
-   * This method returns an error message set by PGTStorage::setErrorMessage().
128
-   *
129
-   * @return an error message when set by PGTStorage::setErrorMessage(), FALSE
130
-   * otherwise.
131
-   *
132
-   * @public
133
-   * @deprecated not used.
134
-   */
135
-  function getErrorMessage()
126
+    /**
127
+     * This method returns an error message set by PGTStorage::setErrorMessage().
128
+     *
129
+     * @return an error message when set by PGTStorage::setErrorMessage(), FALSE
130
+     * otherwise.
131
+     *
132
+     * @public
133
+     * @deprecated not used.
134
+     */
135
+    function getErrorMessage()
136 136
     {
137
-      return $this->_error_message;
137
+        return $this->_error_message;
138 138
     }
139 139
 
140
-  // ########################################################################
141
-  //  INITIALIZATION
142
-  // ########################################################################
143
-
144
-  /**
145
-   * a boolean telling if the storage has already been initialized. Written by 
146
-   * PGTStorage::init(), read by PGTStorage::isInitialized().
147
-   *
148
-   * @hideinitializer
149
-   * @private
150
-   */
151
-  var $_initialized = FALSE;
152
-
153
-  /**
154
-   * This method tells if the storage has already been intialized.
155
-   *
156
-   * @return a boolean
157
-   *
158
-   * @protected
159
-   */
160
-  function isInitialized()
140
+    // ########################################################################
141
+    //  INITIALIZATION
142
+    // ########################################################################
143
+
144
+    /**
145
+     * a boolean telling if the storage has already been initialized. Written by 
146
+     * PGTStorage::init(), read by PGTStorage::isInitialized().
147
+     *
148
+     * @hideinitializer
149
+     * @private
150
+     */
151
+    var $_initialized = FALSE;
152
+
153
+    /**
154
+     * This method tells if the storage has already been intialized.
155
+     *
156
+     * @return a boolean
157
+     *
158
+     * @protected
159
+     */
160
+    function isInitialized()
161 161
     {
162
-      return $this->_initialized;
162
+        return $this->_initialized;
163 163
     }
164 164
 
165
-  /**
166
-   * This virtual method initializes the object.
167
-   *
168
-   * @protected
169
-   */
170
-  function init()
165
+    /**
166
+     * This virtual method initializes the object.
167
+     *
168
+     * @protected
169
+     */
170
+    function init()
171 171
     {
172
-      $this->_initialized = TRUE;
172
+        $this->_initialized = TRUE;
173 173
     }
174 174
 
175
-  // ########################################################################
176
-  //  PGT I/O
177
-  // ########################################################################
178
-
179
-  /**
180
-   * This virtual method stores a PGT and its corresponding PGT Iuo.
181
-   * @note Should never be called.
182
-   *
183
-   * @param $pgt the PGT
184
-   * @param $pgt_iou the PGT iou
185
-   *
186
-   * @protected
187
-   */
188
-  function write($pgt,$pgt_iou)
175
+    // ########################################################################
176
+    //  PGT I/O
177
+    // ########################################################################
178
+
179
+    /**
180
+     * This virtual method stores a PGT and its corresponding PGT Iuo.
181
+     * @note Should never be called.
182
+     *
183
+     * @param $pgt the PGT
184
+     * @param $pgt_iou the PGT iou
185
+     *
186
+     * @protected
187
+     */
188
+    function write($pgt,$pgt_iou)
189 189
     {
190
-      phpCAS::error(__CLASS__.'::'.__FUNCTION__.'() should never be called'); 
190
+        phpCAS::error(__CLASS__.'::'.__FUNCTION__.'() should never be called'); 
191 191
     }
192 192
 
193
-  /**
194
-   * This virtual method reads a PGT corresponding to a PGT Iou and deletes
195
-   * the corresponding storage entry.
196
-   * @note Should never be called.
197
-   *
198
-   * @param $pgt_iou the PGT iou
199
-   *
200
-   * @protected
201
-   */
202
-  function read($pgt_iou)
193
+    /**
194
+     * This virtual method reads a PGT corresponding to a PGT Iou and deletes
195
+     * the corresponding storage entry.
196
+     * @note Should never be called.
197
+     *
198
+     * @param $pgt_iou the PGT iou
199
+     *
200
+     * @protected
201
+     */
202
+    function read($pgt_iou)
203 203
     {
204
-      phpCAS::error(__CLASS__.'::'.__FUNCTION__.'() should never be called'); 
204
+        phpCAS::error(__CLASS__.'::'.__FUNCTION__.'() should never be called'); 
205 205
     }
206 206
 
207
-  /** @} */
207
+    /** @} */
208 208
   
209 209
 } 
210 210
 
Please login to merge, or discard this patch.
Spacing   +3 added lines, -3 removed lines patch added patch discarded remove patch
@@ -63,7 +63,7 @@  discard block
 block discarded – undo
63 63
   function PGTStorage($cas_parent)
64 64
     {
65 65
       phpCAS::traceBegin();
66
-      if ( !$cas_parent->isProxy() ) {
66
+      if (!$cas_parent->isProxy()) {
67 67
 	phpCAS::error('defining PGT storage makes no sense when not using a CAS proxy'); 
68 68
       }
69 69
       phpCAS::traceEnd();
@@ -107,7 +107,7 @@  discard block
 block discarded – undo
107 107
    * @private
108 108
    * @deprecated not used.
109 109
    */
110
-  var $_error_message=FALSE;
110
+  var $_error_message = FALSE;
111 111
 
112 112
   /**
113 113
    * This method sets en error message, which can be read later by 
@@ -185,7 +185,7 @@  discard block
 block discarded – undo
185 185
    *
186 186
    * @protected
187 187
    */
188
-  function write($pgt,$pgt_iou)
188
+  function write($pgt, $pgt_iou)
189 189
     {
190 190
       phpCAS::error(__CLASS__.'::'.__FUNCTION__.'() should never be called'); 
191 191
     }
Please login to merge, or discard this patch.
main/auth/courses_controller.php 2 patches
Doc Comments   +2 added lines, -1 removed lines patch added patch discarded remove patch
@@ -33,6 +33,7 @@  discard block
 block discarded – undo
33 33
      * render to courses_list view
34 34
      * @param string   	action
35 35
      * @param string    confirmation message(optional)
36
+     * @param string $action
36 37
      */
37 38
     public function courses_list($action, $message = '')
38 39
     {
@@ -79,7 +80,7 @@  discard block
 block discarded – undo
79 80
     /**
80 81
      * It's used for listing courses with categories,
81 82
      * render to courses_categories view
82
-     * @param $action
83
+     * @param string $action
83 84
      * @param string $category_code
84 85
      * @param string $message
85 86
      * @param string $error
Please login to merge, or discard this patch.
Spacing   +17 added lines, -18 removed lines patch added patch discarded remove patch
@@ -61,7 +61,7 @@  discard block
 block discarded – undo
61 61
      * @param string   $message confirmation message(optional)
62 62
      * @param string   $error error message(optional)
63 63
      */
64
-    public function categories_list($action, $message='', $error='')
64
+    public function categories_list($action, $message = '', $error = '')
65 65
     {
66 66
         $data = array();
67 67
         $data['user_course_categories'] = $this->model->get_user_course_categories();
@@ -116,7 +116,7 @@  discard block
 block discarded – undo
116 116
 
117 117
         // we need only the course codes as these will be used to match against the courses of the category
118 118
         if ($user_courses != '') {
119
-            foreach($user_courses as $key => $value) {
119
+            foreach ($user_courses as $key => $value) {
120 120
                 $user_coursecodes[] = $value['code'];
121 121
             }
122 122
         }
@@ -385,13 +385,13 @@  discard block
 block discarded – undo
385 385
                     $html .= '</strong>';
386 386
                 } else {
387 387
                     if (!empty($categoryCourses)) {
388
-                        $html .= '<a href="' . getCourseCategoryUrl(
388
+                        $html .= '<a href="'.getCourseCategoryUrl(
389 389
                                 1,
390 390
                                 $limit['length'],
391 391
                                 $categoryCode,
392 392
                                 $hiddenLinks,
393 393
                                 $action
394
-                            ) . '">';
394
+                            ).'">';
395 395
                         $html .= "$categoryName ($categoryCourses)";
396 396
                         $html .= '</a>';
397 397
                     } else {
@@ -412,13 +412,13 @@  discard block
 block discarded – undo
412 412
                         if ($code == $subCategory1Code) {
413 413
                             $html .= "<strong>$subCategory1Name ($subCategory1Courses)</strong>";
414 414
                         } else {
415
-                            $html .= '<a href="' . getCourseCategoryUrl(
415
+                            $html .= '<a href="'.getCourseCategoryUrl(
416 416
                                     1,
417 417
                                     $limit['length'],
418 418
                                     $categoryCode,
419 419
                                     $hiddenLinks,
420 420
                                     $action
421
-                                ) . '">';
421
+                                ).'">';
422 422
                             $html .= "$subCategory1Name ($subCategory1Courses)";
423 423
                             $html .= '</a>';
424 424
                         }
@@ -436,13 +436,13 @@  discard block
 block discarded – undo
436 436
                                 if ($code == $subCategory2Code) {
437 437
                                     $html .= "<strong>$subCategory2Name ($subCategory2Courses)</strong>";
438 438
                                 } else {
439
-                                    $html .= '<a href="' . getCourseCategoryUrl(
439
+                                    $html .= '<a href="'.getCourseCategoryUrl(
440 440
                                             1,
441 441
                                             $limit['length'],
442 442
                                             $categoryCode,
443 443
                                             $hiddenLinks,
444 444
                                             $action
445
-                                        ) . '">';
445
+                                        ).'">';
446 446
                                     $html .= "$subCategory2Name ($subCategory2Courses)";
447 447
                                     $html .= '</a>';
448 448
                                 }
@@ -460,13 +460,13 @@  discard block
 block discarded – undo
460 460
                                         if ($code == $subCategory3Code) {
461 461
                                             $html .= "<strong>$subCategory3Name ($subCategory3Courses)</strong>";
462 462
                                         } else {
463
-                                            $html .= '<a href="' . getCourseCategoryUrl(
463
+                                            $html .= '<a href="'.getCourseCategoryUrl(
464 464
                                                     1,
465 465
                                                     $limit['length'],
466 466
                                                     $categoryCode,
467 467
                                                     $hiddenLinks,
468 468
                                                     $action
469
-                                                ) . '">';
469
+                                                ).'">';
470 470
                                             $html .= "$subCategory3Name ($subCategory3Courses)";
471 471
                                             $html .= '</a>';
472 472
                                         }
@@ -593,7 +593,7 @@  discard block
 block discarded – undo
593 593
         $icon = '<em class="fa fa-smile-o"></em>';
594 594
 
595 595
         return Display::div(
596
-            $icon . ' ' . get_lang("AlreadyRegisteredToSession"),
596
+            $icon.' '.get_lang("AlreadyRegisteredToSession"),
597 597
             array('class' => 'info-catalog')
598 598
         );
599 599
     }
@@ -605,7 +605,7 @@  discard block
 block discarded – undo
605 605
      */
606 606
     public function getSessionIcon($sessionName)
607 607
     {
608
-        return Display::return_icon('window_list.png', $sessionName, null,ICON_SIZE_MEDIUM);
608
+        return Display::return_icon('window_list.png', $sessionName, null, ICON_SIZE_MEDIUM);
609 609
     }
610 610
 
611 611
     /**
@@ -626,8 +626,7 @@  discard block
 block discarded – undo
626 626
         $pageTotal = intval(ceil(intval($countSessions) / $limit['length']));
627 627
         // Do NOT show pagination if only one page or less
628 628
         $cataloguePagination = $pageTotal > 1 ?
629
-            getCataloguePagination($limit['current'], $limit['length'], $pageTotal) :
630
-            '';
629
+            getCataloguePagination($limit['current'], $limit['length'], $pageTotal) : '';
631 630
         $sessionsBlocks = $this->getFormatedSessionsBlock($sessions);
632 631
 
633 632
         // Get session list catalogue URL
@@ -638,13 +637,13 @@  discard block
 block discarded – undo
638 637
         $tpl = new Template();
639 638
         $tpl->assign('show_courses', CoursesAndSessionsCatalog::showCourses());
640 639
         $tpl->assign('show_sessions', CoursesAndSessionsCatalog::showSessions());
641
-        $tpl->assign('show_tutor', (api_get_setting('show_session_coach')==='true' ? true : false));
640
+        $tpl->assign('show_tutor', (api_get_setting('show_session_coach') === 'true' ? true : false));
642 641
         $tpl->assign('course_url', $courseUrl);
643 642
         $tpl->assign('catalog_pagination', $cataloguePagination);
644 643
         $tpl->assign('hidden_links', $hiddenLinks);
645 644
         $tpl->assign('search_token', Security::get_token());
646 645
         $tpl->assign('search_date', $date);
647
-        $tpl->assign('web_session_courses_ajax_url', api_get_path(WEB_AJAX_PATH) . 'course.ajax.php');
646
+        $tpl->assign('web_session_courses_ajax_url', api_get_path(WEB_AJAX_PATH).'course.ajax.php');
648 647
         $tpl->assign('sessions', $sessionsBlocks);
649 648
         $tpl->assign('already_subscribed_label', $this->getAlreadyRegisteredInSessionLabel());
650 649
 
@@ -671,7 +670,7 @@  discard block
 block discarded – undo
671 670
 
672 671
         $tpl->assign('show_courses', CoursesAndSessionsCatalog::showCourses());
673 672
         $tpl->assign('show_sessions', CoursesAndSessionsCatalog::showSessions());
674
-        $tpl->assign('show_tutor', (api_get_setting('show_session_coach')==='true' ? true : false));
673
+        $tpl->assign('show_tutor', (api_get_setting('show_session_coach') === 'true' ? true : false));
675 674
         $tpl->assign('course_url', $courseUrl);
676 675
         $tpl->assign('already_subscribed_label', $this->getAlreadyRegisteredInSessionLabel());
677 676
         $tpl->assign('hidden_links', $hiddenLinks);
@@ -702,7 +701,7 @@  discard block
 block discarded – undo
702 701
         $tpl = new Template();
703 702
         $tpl->assign('show_courses', CoursesAndSessionsCatalog::showCourses());
704 703
         $tpl->assign('show_sessions', CoursesAndSessionsCatalog::showSessions());
705
-        $tpl->assign('show_tutor', (api_get_setting('show_session_coach')==='true' ? true : false));
704
+        $tpl->assign('show_tutor', (api_get_setting('show_session_coach') === 'true' ? true : false));
706 705
         $tpl->assign('course_url', $courseUrl);
707 706
         $tpl->assign('already_subscribed_label', $this->getAlreadyRegisteredInSessionLabel());
708 707
         $tpl->assign('hidden_links', $hiddenLinks);
Please login to merge, or discard this patch.
auth/external_login/facebook-php-sdk/src/Facebook/Entities/AccessToken.php 3 patches
Doc Comments   +4 added lines, -3 removed lines patch added patch discarded remove patch
@@ -62,6 +62,7 @@  discard block
 block discarded – undo
62 62
    * @param string $accessToken
63 63
    * @param int $expiresAt
64 64
    * @param string|null machineId
65
+   * @param string $machineId
65 66
    */
66 67
   public function __construct($accessToken, $expiresAt = 0, $machineId = null)
67 68
   {
@@ -97,7 +98,7 @@  discard block
 block discarded – undo
97 98
   /**
98 99
    * Getter for machineId.
99 100
    *
100
-   * @return string|null
101
+   * @return string
101 102
    */
102 103
   public function getMachineId()
103 104
   {
@@ -191,11 +192,11 @@  discard block
 block discarded – undo
191 192
   /**
192 193
    * Get a valid code from an access token.
193 194
    *
194
-   * @param AccessToken|string $accessToken
195
+   * @param AccessToken $accessToken
195 196
    * @param string|null $appId
196 197
    * @param string|null $appSecret
197 198
    *
198
-   * @return AccessToken
199
+   * @return string
199 200
    */
200 201
   public static function getCodeFromAccessToken($accessToken, $appId = null, $appSecret = null)
201 202
   {
Please login to merge, or discard this patch.
Indentation   +245 added lines, -245 removed lines patch added patch discarded remove patch
@@ -35,119 +35,119 @@  discard block
 block discarded – undo
35 35
 class AccessToken
36 36
 {
37 37
 
38
-  /**
39
-   * The access token.
40
-   *
41
-   * @var string
42
-   */
43
-  protected $accessToken;
44
-
45
-  /**
46
-   * A unique ID to identify a client.
47
-   *
48
-   * @var string
49
-   */
50
-  protected $machineId;
51
-
52
-  /**
53
-   * Date when token expires.
54
-   *
55
-   * @var \DateTime|null
56
-   */
57
-  protected $expiresAt;
58
-
59
-  /**
60
-   * Create a new access token entity.
61
-   *
62
-   * @param string $accessToken
63
-   * @param int $expiresAt
64
-   * @param string|null machineId
65
-   */
66
-  public function __construct($accessToken, $expiresAt = 0, $machineId = null)
67
-  {
38
+    /**
39
+     * The access token.
40
+     *
41
+     * @var string
42
+     */
43
+    protected $accessToken;
44
+
45
+    /**
46
+     * A unique ID to identify a client.
47
+     *
48
+     * @var string
49
+     */
50
+    protected $machineId;
51
+
52
+    /**
53
+     * Date when token expires.
54
+     *
55
+     * @var \DateTime|null
56
+     */
57
+    protected $expiresAt;
58
+
59
+    /**
60
+     * Create a new access token entity.
61
+     *
62
+     * @param string $accessToken
63
+     * @param int $expiresAt
64
+     * @param string|null machineId
65
+     */
66
+    public function __construct($accessToken, $expiresAt = 0, $machineId = null)
67
+    {
68 68
     $this->accessToken = $accessToken;
69 69
     if ($expiresAt) {
70
-      $this->setExpiresAtFromTimeStamp($expiresAt);
70
+        $this->setExpiresAtFromTimeStamp($expiresAt);
71 71
     }
72 72
     $this->machineId = $machineId;
73
-  }
74
-
75
-  /**
76
-   * Setter for expires_at.
77
-   *
78
-   * @param int $timeStamp
79
-   */
80
-  protected function setExpiresAtFromTimeStamp($timeStamp)
81
-  {
73
+    }
74
+
75
+    /**
76
+     * Setter for expires_at.
77
+     *
78
+     * @param int $timeStamp
79
+     */
80
+    protected function setExpiresAtFromTimeStamp($timeStamp)
81
+    {
82 82
     $dt = new \DateTime();
83 83
     $dt->setTimestamp($timeStamp);
84 84
     $this->expiresAt = $dt;
85
-  }
86
-
87
-  /**
88
-   * Getter for expiresAt.
89
-   *
90
-   * @return \DateTime|null
91
-   */
92
-  public function getExpiresAt()
93
-  {
85
+    }
86
+
87
+    /**
88
+     * Getter for expiresAt.
89
+     *
90
+     * @return \DateTime|null
91
+     */
92
+    public function getExpiresAt()
93
+    {
94 94
     return $this->expiresAt;
95
-  }
96
-
97
-  /**
98
-   * Getter for machineId.
99
-   *
100
-   * @return string|null
101
-   */
102
-  public function getMachineId()
103
-  {
95
+    }
96
+
97
+    /**
98
+     * Getter for machineId.
99
+     *
100
+     * @return string|null
101
+     */
102
+    public function getMachineId()
103
+    {
104 104
     return $this->machineId;
105
-  }
106
-
107
-  /**
108
-   * Determines whether or not this is a long-lived token.
109
-   *
110
-   * @return bool
111
-   */
112
-  public function isLongLived()
113
-  {
105
+    }
106
+
107
+    /**
108
+     * Determines whether or not this is a long-lived token.
109
+     *
110
+     * @return bool
111
+     */
112
+    public function isLongLived()
113
+    {
114 114
     if ($this->expiresAt) {
115
-      return $this->expiresAt->getTimestamp() > time() + (60 * 60 * 2);
115
+        return $this->expiresAt->getTimestamp() > time() + (60 * 60 * 2);
116 116
     }
117 117
     return false;
118
-  }
119
-
120
-  /**
121
-   * Checks the validity of the access token.
122
-   *
123
-   * @param string|null $appId Application ID to use
124
-   * @param string|null $appSecret App secret value to use
125
-   * @param string|null $machineId
126
-   *
127
-   * @return boolean
128
-   */
129
-  public function isValid($appId = null, $appSecret = null, $machineId = null)
130
-  {
118
+    }
119
+
120
+    /**
121
+     * Checks the validity of the access token.
122
+     *
123
+     * @param string|null $appId Application ID to use
124
+     * @param string|null $appSecret App secret value to use
125
+     * @param string|null $machineId
126
+     *
127
+     * @return boolean
128
+     */
129
+    public function isValid($appId = null, $appSecret = null, $machineId = null)
130
+    {
131 131
     $accessTokenInfo = $this->getInfo($appId, $appSecret);
132 132
     $machineId = $machineId ?: $this->machineId;
133 133
     return static::validateAccessToken($accessTokenInfo, $appId, $machineId);
134
-  }
135
-
136
-  /**
137
-   * Ensures the provided GraphSessionInfo object is valid,
138
-   *   throwing an exception if not.  Ensures the appId matches,
139
-   *   that the machineId matches if it's being used,
140
-   *   that the token is valid and has not expired.
141
-   *
142
-   * @param GraphSessionInfo $tokenInfo
143
-   * @param string|null $appId Application ID to use
144
-   * @param string|null $machineId
145
-   *
146
-   * @return boolean
147
-   */
148
-  public static function validateAccessToken(GraphSessionInfo $tokenInfo,
149
-                                             $appId = null, $machineId = null)
150
-  {
134
+    }
135
+
136
+    /**
137
+     * Ensures the provided GraphSessionInfo object is valid,
138
+     *   throwing an exception if not.  Ensures the appId matches,
139
+     *   that the machineId matches if it's being used,
140
+     *   that the token is valid and has not expired.
141
+     *
142
+     * @param GraphSessionInfo $tokenInfo
143
+     * @param string|null $appId Application ID to use
144
+     * @param string|null $machineId
145
+     *
146
+     * @return boolean
147
+     */
148
+    public static function validateAccessToken(GraphSessionInfo $tokenInfo,
149
+                                                $appId = null, $machineId = null)
150
+    {
151 151
     $targetAppId = FacebookSession::_getTargetAppId($appId);
152 152
 
153 153
     $appIdIsValid = $tokenInfo->getAppId() == $targetAppId;
@@ -156,90 +156,90 @@  discard block
 block discarded – undo
156 156
 
157 157
     // Not all access tokens return an expiration. E.g. an app access token.
158 158
     if ($tokenInfo->getExpiresAt() instanceof \DateTime) {
159
-      $accessTokenIsStillAlive = $tokenInfo->getExpiresAt()->getTimestamp() >= time();
159
+        $accessTokenIsStillAlive = $tokenInfo->getExpiresAt()->getTimestamp() >= time();
160 160
     } else {
161
-      $accessTokenIsStillAlive = true;
161
+        $accessTokenIsStillAlive = true;
162 162
     }
163 163
 
164 164
     return $appIdIsValid && $machineIdIsValid && $accessTokenIsValid && $accessTokenIsStillAlive;
165
-  }
166
-
167
-  /**
168
-   * Get a valid access token from a code.
169
-   *
170
-   * @param string $code
171
-   * @param string|null $appId
172
-   * @param string|null $appSecret
173
-   * @param string|null $machineId
174
-   *
175
-   * @return AccessToken
176
-   */
177
-  public static function getAccessTokenFromCode($code, $appId = null, $appSecret = null, $machineId = null)
178
-  {
165
+    }
166
+
167
+    /**
168
+     * Get a valid access token from a code.
169
+     *
170
+     * @param string $code
171
+     * @param string|null $appId
172
+     * @param string|null $appSecret
173
+     * @param string|null $machineId
174
+     *
175
+     * @return AccessToken
176
+     */
177
+    public static function getAccessTokenFromCode($code, $appId = null, $appSecret = null, $machineId = null)
178
+    {
179 179
     $params = array(
180
-      'code' => $code,
181
-      'redirect_uri' => '',
180
+        'code' => $code,
181
+        'redirect_uri' => '',
182 182
     );
183 183
 
184 184
     if ($machineId) {
185
-      $params['machine_id'] = $machineId;
185
+        $params['machine_id'] = $machineId;
186 186
     }
187 187
 
188 188
     return static::requestAccessToken($params, $appId, $appSecret);
189
-  }
190
-
191
-  /**
192
-   * Get a valid code from an access token.
193
-   *
194
-   * @param AccessToken|string $accessToken
195
-   * @param string|null $appId
196
-   * @param string|null $appSecret
197
-   *
198
-   * @return AccessToken
199
-   */
200
-  public static function getCodeFromAccessToken($accessToken, $appId = null, $appSecret = null)
201
-  {
189
+    }
190
+
191
+    /**
192
+     * Get a valid code from an access token.
193
+     *
194
+     * @param AccessToken|string $accessToken
195
+     * @param string|null $appId
196
+     * @param string|null $appSecret
197
+     *
198
+     * @return AccessToken
199
+     */
200
+    public static function getCodeFromAccessToken($accessToken, $appId = null, $appSecret = null)
201
+    {
202 202
     $accessToken = (string) $accessToken;
203 203
 
204 204
     $params = array(
205
-      'access_token' => $accessToken,
206
-      'redirect_uri' => '',
205
+        'access_token' => $accessToken,
206
+        'redirect_uri' => '',
207 207
     );
208 208
 
209 209
     return static::requestCode($params, $appId, $appSecret);
210
-  }
211
-
212
-  /**
213
-   * Exchanges a short lived access token with a long lived access token.
214
-   *
215
-   * @param string|null $appId
216
-   * @param string|null $appSecret
217
-   *
218
-   * @return AccessToken
219
-   */
220
-  public function extend($appId = null, $appSecret = null)
221
-  {
210
+    }
211
+
212
+    /**
213
+     * Exchanges a short lived access token with a long lived access token.
214
+     *
215
+     * @param string|null $appId
216
+     * @param string|null $appSecret
217
+     *
218
+     * @return AccessToken
219
+     */
220
+    public function extend($appId = null, $appSecret = null)
221
+    {
222 222
     $params = array(
223
-      'grant_type' => 'fb_exchange_token',
224
-      'fb_exchange_token' => $this->accessToken,
223
+        'grant_type' => 'fb_exchange_token',
224
+        'fb_exchange_token' => $this->accessToken,
225 225
     );
226 226
 
227 227
     return static::requestAccessToken($params, $appId, $appSecret);
228
-  }
229
-
230
-  /**
231
-   * Request an access token based on a set of params.
232
-   *
233
-   * @param array $params
234
-   * @param string|null $appId
235
-   * @param string|null $appSecret
236
-   *
237
-   * @return AccessToken
238
-   *
239
-   * @throws FacebookRequestException
240
-   */
241
-  public static function requestAccessToken(array $params, $appId = null, $appSecret = null)
242
-  {
228
+    }
229
+
230
+    /**
231
+     * Request an access token based on a set of params.
232
+     *
233
+     * @param array $params
234
+     * @param string|null $appId
235
+     * @param string|null $appSecret
236
+     *
237
+     * @return AccessToken
238
+     *
239
+     * @throws FacebookRequestException
240
+     */
241
+    public static function requestAccessToken(array $params, $appId = null, $appSecret = null)
242
+    {
243 243
     $response = static::request('/oauth/access_token', $params, $appId, $appSecret);
244 244
     $data = $response->getResponse();
245 245
 
@@ -248,133 +248,133 @@  discard block
 block discarded – undo
248 248
      * @see https://github.com/facebook/facebook-php-sdk-v4/issues/36
249 249
      */
250 250
     if (is_array($data)) {
251
-      if (isset($data['access_token'])) {
251
+        if (isset($data['access_token'])) {
252 252
         $expiresAt = isset($data['expires']) ? time() + $data['expires'] : 0;
253 253
         return new static($data['access_token'], $expiresAt);
254
-      }
254
+        }
255 255
     } elseif($data instanceof \stdClass) {
256
-      if (isset($data->access_token)) {
256
+        if (isset($data->access_token)) {
257 257
         $expiresAt = isset($data->expires_in) ? time() + $data->expires_in : 0;
258 258
         $machineId = isset($data->machine_id) ? (string) $data->machine_id : null;
259 259
         return new static((string) $data->access_token, $expiresAt, $machineId);
260
-      }
260
+        }
261 261
     }
262 262
 
263 263
     throw FacebookRequestException::create(
264
-      $response->getRawResponse(),
265
-      $data,
266
-      401
264
+        $response->getRawResponse(),
265
+        $data,
266
+        401
267 267
     );
268
-  }
269
-
270
-  /**
271
-   * Request a code from a long lived access token.
272
-   *
273
-   * @param array $params
274
-   * @param string|null $appId
275
-   * @param string|null $appSecret
276
-   *
277
-   * @return string
278
-   *
279
-   * @throws FacebookRequestException
280
-   */
281
-  public static function requestCode(array $params, $appId = null, $appSecret = null)
282
-  {
268
+    }
269
+
270
+    /**
271
+     * Request a code from a long lived access token.
272
+     *
273
+     * @param array $params
274
+     * @param string|null $appId
275
+     * @param string|null $appSecret
276
+     *
277
+     * @return string
278
+     *
279
+     * @throws FacebookRequestException
280
+     */
281
+    public static function requestCode(array $params, $appId = null, $appSecret = null)
282
+    {
283 283
     $response = static::request('/oauth/client_code', $params, $appId, $appSecret);
284 284
     $data = $response->getResponse();
285 285
 
286 286
     if (isset($data->code)) {
287
-      return (string) $data->code;
287
+        return (string) $data->code;
288 288
     }
289 289
 
290 290
     throw FacebookRequestException::create(
291
-      $response->getRawResponse(),
292
-      $data,
293
-      401
291
+        $response->getRawResponse(),
292
+        $data,
293
+        401
294 294
     );
295
-  }
296
-
297
-  /**
298
-   * Send a request to Graph with an app access token.
299
-   *
300
-   * @param string $endpoint
301
-   * @param array $params
302
-   * @param string|null $appId
303
-   * @param string|null $appSecret
304
-   *
305
-   * @return \Facebook\FacebookResponse
306
-   *
307
-   * @throws FacebookRequestException
308
-   */
309
-  protected static function request($endpoint, array $params, $appId = null, $appSecret = null)
310
-  {
295
+    }
296
+
297
+    /**
298
+     * Send a request to Graph with an app access token.
299
+     *
300
+     * @param string $endpoint
301
+     * @param array $params
302
+     * @param string|null $appId
303
+     * @param string|null $appSecret
304
+     *
305
+     * @return \Facebook\FacebookResponse
306
+     *
307
+     * @throws FacebookRequestException
308
+     */
309
+    protected static function request($endpoint, array $params, $appId = null, $appSecret = null)
310
+    {
311 311
     $targetAppId = FacebookSession::_getTargetAppId($appId);
312 312
     $targetAppSecret = FacebookSession::_getTargetAppSecret($appSecret);
313 313
 
314 314
     if (!isset($params['client_id'])) {
315
-      $params['client_id'] = $targetAppId;
315
+        $params['client_id'] = $targetAppId;
316 316
     }
317 317
     if (!isset($params['client_secret'])) {
318
-      $params['client_secret'] = $targetAppSecret;
318
+        $params['client_secret'] = $targetAppSecret;
319 319
     }
320 320
 
321 321
     // The response for this endpoint is not JSON, so it must be handled
322 322
     //   differently, not as a GraphObject.
323 323
     $request = new FacebookRequest(
324
-      FacebookSession::newAppSession($targetAppId, $targetAppSecret),
325
-      'GET',
326
-      $endpoint,
327
-      $params
324
+        FacebookSession::newAppSession($targetAppId, $targetAppSecret),
325
+        'GET',
326
+        $endpoint,
327
+        $params
328 328
     );
329 329
     return $request->execute();
330
-  }
331
-
332
-  /**
333
-   * Get more info about an access token.
334
-   *
335
-   * @param string|null $appId
336
-   * @param string|null $appSecret
337
-   *
338
-   * @return GraphSessionInfo
339
-   */
340
-  public function getInfo($appId = null, $appSecret = null)
341
-  {
330
+    }
331
+
332
+    /**
333
+     * Get more info about an access token.
334
+     *
335
+     * @param string|null $appId
336
+     * @param string|null $appSecret
337
+     *
338
+     * @return GraphSessionInfo
339
+     */
340
+    public function getInfo($appId = null, $appSecret = null)
341
+    {
342 342
     $params = array('input_token' => $this->accessToken);
343 343
 
344 344
     $request = new FacebookRequest(
345
-      FacebookSession::newAppSession($appId, $appSecret),
346
-      'GET',
347
-      '/debug_token',
348
-      $params
345
+        FacebookSession::newAppSession($appId, $appSecret),
346
+        'GET',
347
+        '/debug_token',
348
+        $params
349 349
     );
350 350
     $response = $request->execute()->getGraphObject(GraphSessionInfo::className());
351 351
 
352 352
     // Update the data on this token
353 353
     if ($response->getExpiresAt()) {
354
-      $this->expiresAt = $response->getExpiresAt();
354
+        $this->expiresAt = $response->getExpiresAt();
355 355
     }
356 356
 
357 357
     return $response;
358
-  }
359
-
360
-  /**
361
-   * Returns the access token as a string.
362
-   *
363
-   * @return string
364
-   */
365
-  public function __toString()
366
-  {
358
+    }
359
+
360
+    /**
361
+     * Returns the access token as a string.
362
+     *
363
+     * @return string
364
+     */
365
+    public function __toString()
366
+    {
367 367
     return $this->accessToken;
368
-  }
369
-
370
-  /**
371
-   * Returns true if the access token is an app session token.
372
-   *
373
-   * @return bool
374
-   */
375
-  public function isAppSession()
376
-  {
368
+    }
369
+
370
+    /**
371
+     * Returns true if the access token is an app session token.
372
+     *
373
+     * @return bool
374
+     */
375
+    public function isAppSession()
376
+    {
377 377
     return strpos($this->accessToken, "|") !== false;
378
-  }
378
+    }
379 379
 
380 380
 }
Please login to merge, or discard this patch.
Spacing   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -252,7 +252,7 @@
 block discarded – undo
252 252
         $expiresAt = isset($data['expires']) ? time() + $data['expires'] : 0;
253 253
         return new static($data['access_token'], $expiresAt);
254 254
       }
255
-    } elseif($data instanceof \stdClass) {
255
+    } elseif ($data instanceof \stdClass) {
256 256
       if (isset($data->access_token)) {
257 257
         $expiresAt = isset($data->expires_in) ? time() + $data->expires_in : 0;
258 258
         $machineId = isset($data->machine_id) ? (string) $data->machine_id : null;
Please login to merge, or discard this patch.
external_login/facebook-php-sdk/src/Facebook/Entities/SignedRequest.php 2 patches
Doc Comments   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -63,7 +63,7 @@  discard block
 block discarded – undo
63 63
   /**
64 64
    * Returns the raw signed request data.
65 65
    *
66
-   * @return string|null
66
+   * @return string
67 67
    */
68 68
   public function getRawSignedRequest()
69 69
   {
@@ -84,7 +84,7 @@  discard block
 block discarded – undo
84 84
    * Returns a property from the signed request data if available.
85 85
    *
86 86
    * @param string $key
87
-   * @param mixed|null $default
87
+   * @param integer $default
88 88
    *
89 89
    * @return mixed|null
90 90
    */
Please login to merge, or discard this patch.
Indentation   +255 added lines, -255 removed lines patch added patch discarded remove patch
@@ -33,99 +33,99 @@  discard block
 block discarded – undo
33 33
 class SignedRequest
34 34
 {
35 35
 
36
-  /**
37
-   * @var string
38
-   */
39
-  public $rawSignedRequest;
40
-
41
-  /**
42
-   * @var array
43
-   */
44
-  public $payload;
45
-
46
-  /**
47
-   * Instantiate a new SignedRequest entity.
48
-   *
49
-   * @param string|null $rawSignedRequest The raw signed request.
50
-   * @param string|null $state random string to prevent CSRF.
51
-   * @param string|null $appSecret
52
-   */
53
-  public function __construct($rawSignedRequest = null, $state = null, $appSecret = null)
54
-  {
36
+    /**
37
+     * @var string
38
+     */
39
+    public $rawSignedRequest;
40
+
41
+    /**
42
+     * @var array
43
+     */
44
+    public $payload;
45
+
46
+    /**
47
+     * Instantiate a new SignedRequest entity.
48
+     *
49
+     * @param string|null $rawSignedRequest The raw signed request.
50
+     * @param string|null $state random string to prevent CSRF.
51
+     * @param string|null $appSecret
52
+     */
53
+    public function __construct($rawSignedRequest = null, $state = null, $appSecret = null)
54
+    {
55 55
     if (!$rawSignedRequest) {
56
-      return;
56
+        return;
57 57
     }
58 58
 
59 59
     $this->rawSignedRequest = $rawSignedRequest;
60 60
     $this->payload = static::parse($rawSignedRequest, $state, $appSecret);
61
-  }
62
-
63
-  /**
64
-   * Returns the raw signed request data.
65
-   *
66
-   * @return string|null
67
-   */
68
-  public function getRawSignedRequest()
69
-  {
61
+    }
62
+
63
+    /**
64
+     * Returns the raw signed request data.
65
+     *
66
+     * @return string|null
67
+     */
68
+    public function getRawSignedRequest()
69
+    {
70 70
     return $this->rawSignedRequest;
71
-  }
72
-
73
-  /**
74
-   * Returns the parsed signed request data.
75
-   *
76
-   * @return array|null
77
-   */
78
-  public function getPayload()
79
-  {
71
+    }
72
+
73
+    /**
74
+     * Returns the parsed signed request data.
75
+     *
76
+     * @return array|null
77
+     */
78
+    public function getPayload()
79
+    {
80 80
     return $this->payload;
81
-  }
82
-
83
-  /**
84
-   * Returns a property from the signed request data if available.
85
-   *
86
-   * @param string $key
87
-   * @param mixed|null $default
88
-   *
89
-   * @return mixed|null
90
-   */
91
-  public function get($key, $default = null)
92
-  {
81
+    }
82
+
83
+    /**
84
+     * Returns a property from the signed request data if available.
85
+     *
86
+     * @param string $key
87
+     * @param mixed|null $default
88
+     *
89
+     * @return mixed|null
90
+     */
91
+    public function get($key, $default = null)
92
+    {
93 93
     if (isset($this->payload[$key])) {
94
-      return $this->payload[$key];
94
+        return $this->payload[$key];
95 95
     }
96 96
     return $default;
97
-  }
98
-
99
-  /**
100
-   * Returns user_id from signed request data if available.
101
-   *
102
-   * @return string|null
103
-   */
104
-  public function getUserId()
105
-  {
97
+    }
98
+
99
+    /**
100
+     * Returns user_id from signed request data if available.
101
+     *
102
+     * @return string|null
103
+     */
104
+    public function getUserId()
105
+    {
106 106
     return $this->get('user_id');
107
-  }
108
-
109
-  /**
110
-   * Checks for OAuth data in the payload.
111
-   *
112
-   * @return boolean
113
-   */
114
-  public function hasOAuthData()
115
-  {
107
+    }
108
+
109
+    /**
110
+     * Checks for OAuth data in the payload.
111
+     *
112
+     * @return boolean
113
+     */
114
+    public function hasOAuthData()
115
+    {
116 116
     return isset($this->payload['oauth_token']) || isset($this->payload['code']);
117
-  }
118
-
119
-  /**
120
-   * Creates a signed request from an array of data.
121
-   *
122
-   * @param array $payload
123
-   * @param string|null $appSecret
124
-   *
125
-   * @return string
126
-   */
127
-  public static function make(array $payload, $appSecret = null)
128
-  {
117
+    }
118
+
119
+    /**
120
+     * Creates a signed request from an array of data.
121
+     *
122
+     * @param array $payload
123
+     * @param string|null $appSecret
124
+     *
125
+     * @return string
126
+     */
127
+    public static function make(array $payload, $appSecret = null)
128
+    {
129 129
     $payload['algorithm'] = 'HMAC-SHA256';
130 130
     $payload['issued_at'] = time();
131 131
     $encodedPayload = static::base64UrlEncode(json_encode($payload));
@@ -134,20 +134,20 @@  discard block
 block discarded – undo
134 134
     $encodedSig = static::base64UrlEncode($hashedSig);
135 135
 
136 136
     return $encodedSig.'.'.$encodedPayload;
137
-  }
138
-
139
-  /**
140
-   * Validates and decodes a signed request and returns
141
-   * the payload as an array.
142
-   *
143
-   * @param string $signedRequest
144
-   * @param string|null $state
145
-   * @param string|null $appSecret
146
-   *
147
-   * @return array
148
-   */
149
-  public static function parse($signedRequest, $state = null, $appSecret = null)
150
-  {
137
+    }
138
+
139
+    /**
140
+     * Validates and decodes a signed request and returns
141
+     * the payload as an array.
142
+     *
143
+     * @param string $signedRequest
144
+     * @param string|null $state
145
+     * @param string|null $appSecret
146
+     *
147
+     * @return array
148
+     */
149
+    public static function parse($signedRequest, $state = null, $appSecret = null)
150
+    {
151 151
     list($encodedSig, $encodedPayload) = static::split($signedRequest);
152 152
 
153 153
     // Signature validation
@@ -159,228 +159,228 @@  discard block
 block discarded – undo
159 159
     $data = static::decodePayload($encodedPayload);
160 160
     static::validateAlgorithm($data);
161 161
     if ($state) {
162
-      static::validateCsrf($data, $state);
162
+        static::validateCsrf($data, $state);
163 163
     }
164 164
 
165 165
     return $data;
166
-  }
167
-
168
-  /**
169
-   * Validates the format of a signed request.
170
-   *
171
-   * @param string $signedRequest
172
-   *
173
-   * @throws FacebookSDKException
174
-   */
175
-  public static function validateFormat($signedRequest)
176
-  {
166
+    }
167
+
168
+    /**
169
+     * Validates the format of a signed request.
170
+     *
171
+     * @param string $signedRequest
172
+     *
173
+     * @throws FacebookSDKException
174
+     */
175
+    public static function validateFormat($signedRequest)
176
+    {
177 177
     if (strpos($signedRequest, '.') !== false) {
178
-      return;
178
+        return;
179 179
     }
180 180
 
181 181
     throw new FacebookSDKException(
182
-      'Malformed signed request.', 606
182
+        'Malformed signed request.', 606
183 183
     );
184
-  }
185
-
186
-  /**
187
-   * Decodes a raw valid signed request.
188
-   *
189
-   * @param string $signedRequest
190
-   *
191
-   * @returns array
192
-   */
193
-  public static function split($signedRequest)
194
-  {
184
+    }
185
+
186
+    /**
187
+     * Decodes a raw valid signed request.
188
+     *
189
+     * @param string $signedRequest
190
+     *
191
+     * @returns array
192
+     */
193
+    public static function split($signedRequest)
194
+    {
195 195
     static::validateFormat($signedRequest);
196 196
 
197 197
     return explode('.', $signedRequest, 2);
198
-  }
199
-
200
-  /**
201
-   * Decodes the raw signature from a signed request.
202
-   *
203
-   * @param string $encodedSig
204
-   *
205
-   * @returns string
206
-   *
207
-   * @throws FacebookSDKException
208
-   */
209
-  public static function decodeSignature($encodedSig)
210
-  {
198
+    }
199
+
200
+    /**
201
+     * Decodes the raw signature from a signed request.
202
+     *
203
+     * @param string $encodedSig
204
+     *
205
+     * @returns string
206
+     *
207
+     * @throws FacebookSDKException
208
+     */
209
+    public static function decodeSignature($encodedSig)
210
+    {
211 211
     $sig = static::base64UrlDecode($encodedSig);
212 212
 
213 213
     if ($sig) {
214
-      return $sig;
214
+        return $sig;
215 215
     }
216 216
 
217 217
     throw new FacebookSDKException(
218
-      'Signed request has malformed encoded signature data.', 607
218
+        'Signed request has malformed encoded signature data.', 607
219 219
     );
220
-  }
221
-
222
-  /**
223
-   * Decodes the raw payload from a signed request.
224
-   *
225
-   * @param string $encodedPayload
226
-   *
227
-   * @returns array
228
-   *
229
-   * @throws FacebookSDKException
230
-   */
231
-  public static function decodePayload($encodedPayload)
232
-  {
220
+    }
221
+
222
+    /**
223
+     * Decodes the raw payload from a signed request.
224
+     *
225
+     * @param string $encodedPayload
226
+     *
227
+     * @returns array
228
+     *
229
+     * @throws FacebookSDKException
230
+     */
231
+    public static function decodePayload($encodedPayload)
232
+    {
233 233
     $payload = static::base64UrlDecode($encodedPayload);
234 234
 
235 235
     if ($payload) {
236
-      $payload = json_decode($payload, true);
236
+        $payload = json_decode($payload, true);
237 237
     }
238 238
 
239 239
     if (is_array($payload)) {
240
-      return $payload;
240
+        return $payload;
241 241
     }
242 242
 
243 243
     throw new FacebookSDKException(
244
-      'Signed request has malformed encoded payload data.', 607
244
+        'Signed request has malformed encoded payload data.', 607
245 245
     );
246
-  }
247
-
248
-  /**
249
-   * Validates the algorithm used in a signed request.
250
-   *
251
-   * @param array $data
252
-   *
253
-   * @throws FacebookSDKException
254
-   */
255
-  public static function validateAlgorithm(array $data)
256
-  {
246
+    }
247
+
248
+    /**
249
+     * Validates the algorithm used in a signed request.
250
+     *
251
+     * @param array $data
252
+     *
253
+     * @throws FacebookSDKException
254
+     */
255
+    public static function validateAlgorithm(array $data)
256
+    {
257 257
     if (isset($data['algorithm']) && $data['algorithm'] === 'HMAC-SHA256') {
258
-      return;
258
+        return;
259 259
     }
260 260
 
261 261
     throw new FacebookSDKException(
262
-      'Signed request is using the wrong algorithm.', 605
262
+        'Signed request is using the wrong algorithm.', 605
263 263
     );
264
-  }
265
-
266
-  /**
267
-   * Hashes the signature used in a signed request.
268
-   *
269
-   * @param string $encodedData
270
-   * @param string|null $appSecret
271
-   *
272
-   * @return string
273
-   *
274
-   * @throws FacebookSDKException
275
-   */
276
-  public static function hashSignature($encodedData, $appSecret = null)
277
-  {
264
+    }
265
+
266
+    /**
267
+     * Hashes the signature used in a signed request.
268
+     *
269
+     * @param string $encodedData
270
+     * @param string|null $appSecret
271
+     *
272
+     * @return string
273
+     *
274
+     * @throws FacebookSDKException
275
+     */
276
+    public static function hashSignature($encodedData, $appSecret = null)
277
+    {
278 278
     $hashedSig = hash_hmac(
279
-      'sha256', $encodedData, FacebookSession::_getTargetAppSecret($appSecret), $raw_output = true
279
+        'sha256', $encodedData, FacebookSession::_getTargetAppSecret($appSecret), $raw_output = true
280 280
     );
281 281
 
282 282
     if ($hashedSig) {
283
-      return $hashedSig;
283
+        return $hashedSig;
284 284
     }
285 285
 
286 286
     throw new FacebookSDKException(
287
-      'Unable to hash signature from encoded payload data.', 602
287
+        'Unable to hash signature from encoded payload data.', 602
288 288
     );
289
-  }
290
-
291
-  /**
292
-   * Validates the signature used in a signed request.
293
-   *
294
-   * @param string $hashedSig
295
-   * @param string $sig
296
-   *
297
-   * @throws FacebookSDKException
298
-   */
299
-  public static function validateSignature($hashedSig, $sig)
300
-  {
289
+    }
290
+
291
+    /**
292
+     * Validates the signature used in a signed request.
293
+     *
294
+     * @param string $hashedSig
295
+     * @param string $sig
296
+     *
297
+     * @throws FacebookSDKException
298
+     */
299
+    public static function validateSignature($hashedSig, $sig)
300
+    {
301 301
     if (mb_strlen($hashedSig) === mb_strlen($sig)) {
302
-      $validate = 0;
303
-      for ($i = 0; $i < mb_strlen($sig); $i++) {
302
+        $validate = 0;
303
+        for ($i = 0; $i < mb_strlen($sig); $i++) {
304 304
         $validate |= ord($hashedSig[$i]) ^ ord($sig[$i]);
305
-      }
306
-      if ($validate === 0) {
305
+        }
306
+        if ($validate === 0) {
307 307
         return;
308
-      }
308
+        }
309 309
     }
310 310
 
311 311
     throw new FacebookSDKException(
312
-      'Signed request has an invalid signature.', 602
312
+        'Signed request has an invalid signature.', 602
313 313
     );
314
-  }
315
-
316
-  /**
317
-   * Validates a signed request against CSRF.
318
-   *
319
-   * @param array $data
320
-   * @param string $state
321
-   *
322
-   * @throws FacebookSDKException
323
-   */
324
-  public static function validateCsrf(array $data, $state)
325
-  {
314
+    }
315
+
316
+    /**
317
+     * Validates a signed request against CSRF.
318
+     *
319
+     * @param array $data
320
+     * @param string $state
321
+     *
322
+     * @throws FacebookSDKException
323
+     */
324
+    public static function validateCsrf(array $data, $state)
325
+    {
326 326
     if (isset($data['state']) && $data['state'] === $state) {
327
-      return;
327
+        return;
328 328
     }
329 329
 
330 330
     throw new FacebookSDKException(
331
-      'Signed request did not pass CSRF validation.', 604
331
+        'Signed request did not pass CSRF validation.', 604
332 332
     );
333
-  }
334
-
335
-  /**
336
-   * Base64 decoding which replaces characters:
337
-   *   + instead of -
338
-   *   / instead of _
339
-   * @link http://en.wikipedia.org/wiki/Base64#URL_applications
340
-   *
341
-   * @param string $input base64 url encoded input
342
-   *
343
-   * @return string decoded string
344
-   */
345
-  public static function base64UrlDecode($input)
346
-  {
333
+    }
334
+
335
+    /**
336
+     * Base64 decoding which replaces characters:
337
+     *   + instead of -
338
+     *   / instead of _
339
+     * @link http://en.wikipedia.org/wiki/Base64#URL_applications
340
+     *
341
+     * @param string $input base64 url encoded input
342
+     *
343
+     * @return string decoded string
344
+     */
345
+    public static function base64UrlDecode($input)
346
+    {
347 347
     $urlDecodedBase64 = strtr($input, '-_', '+/');
348 348
     static::validateBase64($urlDecodedBase64);
349 349
     return base64_decode($urlDecodedBase64);
350
-  }
351
-
352
-  /**
353
-   * Base64 encoding which replaces characters:
354
-   *   + instead of -
355
-   *   / instead of _
356
-   * @link http://en.wikipedia.org/wiki/Base64#URL_applications
357
-   *
358
-   * @param string $input string to encode
359
-   *
360
-   * @return string base64 url encoded input
361
-   */
362
-  public static function base64UrlEncode($input)
363
-  {
350
+    }
351
+
352
+    /**
353
+     * Base64 encoding which replaces characters:
354
+     *   + instead of -
355
+     *   / instead of _
356
+     * @link http://en.wikipedia.org/wiki/Base64#URL_applications
357
+     *
358
+     * @param string $input string to encode
359
+     *
360
+     * @return string base64 url encoded input
361
+     */
362
+    public static function base64UrlEncode($input)
363
+    {
364 364
     return strtr(base64_encode($input), '+/', '-_');
365
-  }
366
-
367
-  /**
368
-   * Validates a base64 string.
369
-   *
370
-   * @param string $input base64 value to validate
371
-   *
372
-   * @throws FacebookSDKException
373
-   */
374
-  public static function validateBase64($input)
375
-  {
365
+    }
366
+
367
+    /**
368
+     * Validates a base64 string.
369
+     *
370
+     * @param string $input base64 value to validate
371
+     *
372
+     * @throws FacebookSDKException
373
+     */
374
+    public static function validateBase64($input)
375
+    {
376 376
     $pattern = '/^[a-zA-Z0-9\/\r\n+]*={0,2}$/';
377 377
     if (preg_match($pattern, $input)) {
378
-      return;
378
+        return;
379 379
     }
380 380
 
381 381
     throw new FacebookSDKException(
382
-      'Signed request contains malformed base64 encoding.', 608
382
+        'Signed request contains malformed base64 encoding.', 608
383 383
     );
384
-  }
384
+    }
385 385
 
386 386
 }
Please login to merge, or discard this patch.
main/auth/external_login/functions.inc.php 3 patches
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -148,7 +148,7 @@
 block discarded – undo
148 148
  *      - language
149 149
  *      - courses : string of all courses code separated by '|'
150 150
  *      - admin : boolean
151
- * @return boolean
151
+ * @return boolean|null
152 152
  * @author ndiechburg <[email protected]>
153 153
  * */
154 154
 function external_update_user($new_user) {
Please login to merge, or discard this patch.
Spacing   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -20,7 +20,7 @@
 block discarded – undo
20 20
     //Those are the mandatory fields for user creation.
21 21
     //See external_add_user function for all the fields you can have.
22 22
     $table = USERINFO_TABLE;
23
-    $sql = "SELECT * from $table where username='" . Database::escape_string($login) . "'";
23
+    $sql = "SELECT * from $table where username='".Database::escape_string($login)."'";
24 24
     $result = Database::query($sql);
25 25
 
26 26
     if (Database::num_rows($result) == 0) { //false password
Please login to merge, or discard this patch.
Braces   +37 added lines, -24 removed lines patch added patch discarded remove patch
@@ -95,30 +95,43 @@
 block discarded – undo
95 95
  * */
96 96
 function external_add_user($u) {
97 97
     //Setting default
98
-    if (empty($u['password']))
99
-        $u['password'] = null;
100
-    if (empty($u['status']))
101
-        $u['status'] = 5;
102
-    if (!isset($u['official_code']))
103
-        $u['official_code'] = '';
104
-    if (!isset($u['language']))
105
-        $u['language'] = '';
106
-    if (!isset($u['phone']))
107
-        $u['phone'] = '';
108
-    if (!isset($u['picture_uri']))
109
-        $u['picture_uri'] = '';
110
-    if (!isset($u['auth_source']))
111
-        $u['auth_source'] = PLATFORM_AUTH_SOURCE;
112
-    if (!isset($u['expiration_date']))
113
-        $u['expiration_date'] = '0000-00-00 00:00:00';
114
-    if (!isset($u['active']))
115
-        $u['active'] = 1;
116
-    if (!isset($u['hr_dept_id']))
117
-        $u['hr_dept_id'] = 0; //id of responsible HR
118
-    if (!isset($u['extra']))
119
-        $u['extra'] = null;
120
-    if (!isset($u['encrypt_method']))
121
-        $u['encrypt_method'] = '';
98
+    if (empty($u['password'])) {
99
+            $u['password'] = null;
100
+    }
101
+    if (empty($u['status'])) {
102
+            $u['status'] = 5;
103
+    }
104
+    if (!isset($u['official_code'])) {
105
+            $u['official_code'] = '';
106
+    }
107
+    if (!isset($u['language'])) {
108
+            $u['language'] = '';
109
+    }
110
+    if (!isset($u['phone'])) {
111
+            $u['phone'] = '';
112
+    }
113
+    if (!isset($u['picture_uri'])) {
114
+            $u['picture_uri'] = '';
115
+    }
116
+    if (!isset($u['auth_source'])) {
117
+            $u['auth_source'] = PLATFORM_AUTH_SOURCE;
118
+    }
119
+    if (!isset($u['expiration_date'])) {
120
+            $u['expiration_date'] = '0000-00-00 00:00:00';
121
+    }
122
+    if (!isset($u['active'])) {
123
+            $u['active'] = 1;
124
+    }
125
+    if (!isset($u['hr_dept_id'])) {
126
+            $u['hr_dept_id'] = 0;
127
+    }
128
+    //id of responsible HR
129
+    if (!isset($u['extra'])) {
130
+            $u['extra'] = null;
131
+    }
132
+    if (!isset($u['encrypt_method'])) {
133
+            $u['encrypt_method'] = '';
134
+    }
122 135
 
123 136
     $chamilo_uid = UserManager::create_user($u['firstname'], $u['lastname'], $u['status'], $u['email'], $u['username'], $u['password'], $u['official_code'], $u['language'], $u['phone'], $u['picture_uri'], $u['auth_source'], $u['expiration_date'], $u['active'], $u['hr_dept_id'], $u['extra'], $u['encrypt_method']);
124 137
     return $chamilo_uid;
Please login to merge, or discard this patch.
main/auth/external_login/ldap.inc.php 2 patches
Doc Comments   +3 added lines, -2 removed lines patch added patch discarded remove patch
@@ -28,7 +28,7 @@  discard block
 block discarded – undo
28 28
 /**
29 29
  * Establishes a connection to the LDAP server and sets the protocol version
30 30
  *
31
- * @return resource ldap link identifier or false
31
+ * @return boolean ldap link identifier or false
32 32
  * @author ndiechburg <[email protected]>
33 33
  * */
34 34
 function extldap_connect()
@@ -77,6 +77,7 @@  discard block
 block discarded – undo
77 77
 /**
78 78
  * Authenticate user on external ldap server and return user ldap entry if that succeeds
79 79
  *
80
+ * @param string $password
80 81
  * @return mixed false if user cannot authenticate on ldap, user ldap entry if tha succeeds
81 82
  * @author ndiechburg <[email protected]>
82 83
  * Modified by [email protected]
@@ -237,7 +238,7 @@  discard block
 block discarded – undo
237 238
 
238 239
 /**
239 240
  * Imports all LDAP users into Chamilo
240
- * @return bool false on error, true otherwise
241
+ * @return false|null false on error, true otherwise
241 242
  */
242 243
 function extldap_import_all_users()
243 244
 {
Please login to merge, or discard this patch.
Spacing   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -303,7 +303,7 @@
 block discarded – undo
303 303
 
304 304
     // TODO the password, if encrypted at the source, will be encrypted twice, which makes it useless. Try to fix that.
305 305
     $passwordKey = isset($extldap_user_correspondance['password']) ? $extldap_user_correspondance['password'] : 'userPassword';
306
-    $password        = $data[$passwordKey][0];
306
+    $password = $data[$passwordKey][0];
307 307
 
308 308
     // To ease management, we add the step-year (etape-annee) code
309 309
     //$official_code = $etape."-".$annee;
Please login to merge, or discard this patch.
main/auth/key/key_auth.class.php 1 patch
Doc Comments   +4 added lines patch added patch discarded remove patch
@@ -65,6 +65,7 @@  discard block
 block discarded – undo
65 65
      * If empty it disables authentication.
66 66
      *
67 67
      * !! 10 chars max !!
68
+     * @param string $_
68 69
      */
69 70
     public static function enable_services($_)
70 71
     {
@@ -254,6 +255,9 @@  discard block
 block discarded – undo
254 255
         return Request::get('cidReq', 0);
255 256
     }
256 257
 
258
+    /**
259
+     * @return integer
260
+     */
257 261
     public function get_group_id()
258 262
     {
259 263
         return Request::get('gidReq', 0);
Please login to merge, or discard this patch.
main/auth/ldap/authldap.php 4 patches
Doc Comments   +3 added lines, -2 removed lines patch added patch discarded remove patch
@@ -67,7 +67,7 @@  discard block
 block discarded – undo
67 67
 require 'ldap_var.inc.php';
68 68
 /**
69 69
  *    Check login and password with LDAP
70
- *    @return true when login & password both OK, false otherwise
70
+ *    @return boolean when login & password both OK, false otherwise
71 71
  *    @author Roan Embrechts (based on code from Universit� Jean Monet)
72 72
  */
73 73
 
@@ -305,7 +305,7 @@  discard block
 block discarded – undo
305 305
 } // end of check
306 306
 /**
307 307
  * Set the protocol version with version from config file (enables LDAP version 3)
308
- * @param    resource    The LDAP connexion resource, passed by reference.
308
+ * @param    resource    resource LDAP connexion resource, passed by reference.
309 309
  * @return    void
310 310
  */
311 311
 function ldap_set_version(&$resource) {
@@ -323,6 +323,7 @@  discard block
 block discarded – undo
323 323
  * Handle bind (whether authenticated or not)
324 324
  * @param    resource    The LDAP handler to which we are connecting (by reference)
325 325
  * @param    resource    The LDAP bind handler we will be modifying
326
+ * @param boolean $ldap_bind
326 327
  * @return    boolean        Status of the bind assignment. True for success, false for failure.
327 328
  */
328 329
 function ldap_handle_bind(&$ldap_handler,&$ldap_bind) {
Please login to merge, or discard this patch.
Spacing   +92 added lines, -92 removed lines patch added patch discarded remove patch
@@ -78,16 +78,16 @@  discard block
 block discarded – undo
78 78
     // res=-1 -> the user does not exist in the ldap database
79 79
     // res=1 -> invalid password (user does exist)
80 80
 
81
-    if ($res==1) { //WRONG PASSWORD
81
+    if ($res == 1) { //WRONG PASSWORD
82 82
         //$errorMessage = "LDAP User or password incorrect, try again.<br />";
83 83
         if (isset($log)) unset($log); if (isset($uid)) unset($uid);
84 84
         $loginLdapSucces = false;
85 85
     }
86
-    if ($res==-1) { //WRONG USERNAME
86
+    if ($res == -1) { //WRONG USERNAME
87 87
         //$errorMessage =  "LDAP User or password incorrect, try again.<br />";
88 88
         $login_ldap_success = false;
89 89
     }
90
-    if ($res==0) { //LOGIN & PASSWORD OK - SUCCES
90
+    if ($res == 0) { //LOGIN & PASSWORD OK - SUCCES
91 91
         //$errorMessage = "Successful login w/ LDAP.<br>";
92 92
         $login_ldap_success = true;
93 93
     }
@@ -103,30 +103,30 @@  discard block
 block discarded – undo
103 103
  *    @author Stefan De Wannemacker
104 104
  *    @author Roan Embrechts
105 105
  */
106
-function ldap_find_user_info ($login) {
106
+function ldap_find_user_info($login) {
107 107
     //error_log('Entering ldap_find_user_info('.$login.')',0);
108 108
     global $ldap_host, $ldap_port, $ldap_basedn, $ldap_rdn, $ldap_pass, $ldap_search_dn;
109 109
     // basic sequence with LDAP is connect, bind, search,
110 110
     // interpret search result, close connection
111 111
 
112 112
     //echo "Connecting ...";
113
-    $ldap_connect = ldap_connect( $ldap_host, $ldap_port);
113
+    $ldap_connect = ldap_connect($ldap_host, $ldap_port);
114 114
     ldap_set_version($ldap_connect);
115 115
     if ($ldap_connect) {
116 116
         //echo " Connect to LDAP server successful ";
117 117
         //echo "Binding ...";
118 118
         $ldap_bind = false;
119
-        $ldap_bind_res = ldap_handle_bind($ldap_connect,$ldap_bind);
119
+        $ldap_bind_res = ldap_handle_bind($ldap_connect, $ldap_bind);
120 120
         if ($ldap_bind_res) {
121 121
             //echo " LDAP bind successful... ";
122 122
             //echo " Searching for uid... ";
123 123
             // Search surname entry
124 124
             //OLD: $sr=ldap_search($ldapconnect,"dc=rug, dc=ac, dc=be", "uid=$login");
125 125
             //echo "<p> ldapDc = '$LDAPbasedn' </p>";
126
-            if(!empty($ldap_search_dn)) {
127
-                $sr=ldap_search($ldap_connect, $ldap_search_dn, "uid=$login");
126
+            if (!empty($ldap_search_dn)) {
127
+                $sr = ldap_search($ldap_connect, $ldap_search_dn, "uid=$login");
128 128
             } else {
129
-                $sr=ldap_search($ldap_connect, $ldap_basedn, "uid=$login");
129
+                $sr = ldap_search($ldap_connect, $ldap_basedn, "uid=$login");
130 130
             }
131 131
             //echo " Search result is ".$sr;
132 132
             //echo " Number of entries returned is ".ldap_count_entries($ldapconnect,$sr);
@@ -177,25 +177,25 @@  discard block
 block discarded – undo
177 177
     $password1  = $ldap_pass_placeholder;
178 178
     $official_code = '';
179 179
 
180
-    define ("STUDENT",5);
181
-    define ("COURSEMANAGER",1);
180
+    define("STUDENT", 5);
181
+    define("COURSEMANAGER", 1);
182 182
 
183 183
     $tutor_field = api_get_setting('ldap_filled_tutor_field');
184 184
     $tutor_value = api_get_setting('ldap_filled_tutor_field_value');
185
-    if(empty($tutor_field)) {
185
+    if (empty($tutor_field)) {
186 186
         $status = STUDENT;
187 187
     } else {
188
-        if(empty($tutor_value)) {
188
+        if (empty($tutor_value)) {
189 189
             //in this case, we are assuming that the admin didn't give a criteria
190 190
             // so that if the field is not empty, it is a tutor
191
-            if(!empty($info_array[$tutor_field])) {
191
+            if (!empty($info_array[$tutor_field])) {
192 192
                 $status = COURSEMANAGER;
193 193
             } else {
194 194
                 $status = STUDENT;
195 195
             }
196 196
         } else {
197 197
             //the tutor_value is filled, so we need to check the contents of the LDAP field
198
-            if (is_array($info_array[$tutor_field]) && in_array($tutor_value,$info_array[$tutor_field])) {
198
+            if (is_array($info_array[$tutor_field]) && in_array($tutor_value, $info_array[$tutor_field])) {
199 199
                 $status = COURSEMANAGER;
200 200
             } else {
201 201
                 $status = STUDENT;
@@ -212,7 +212,7 @@  discard block
 block discarded – undo
212 212
     if (empty($language)) { $language = 'english'; }
213 213
     $_userId = UserManager::create_user($prenom, $nom, $status,
214 214
                      $email, $uname, $password, $official_code,
215
-                     $language,'', '', 'ldap');
215
+                     $language, '', '', 'ldap');
216 216
 
217 217
     //echo "new user added to Chamilo, id = $_userId";
218 218
 
@@ -246,58 +246,58 @@  discard block
 block discarded – undo
246 246
  * @param string password given by user
247 247
  * @return int 0 if authentication succeeded, 1 if password was incorrect, -1 if it didn't belong to LDAP
248 248
  */
249
-function ldap_authentication_check ($uname, $passwd) {
249
+function ldap_authentication_check($uname, $passwd) {
250 250
     //error_log('Entering ldap_authentication_check('.$uname.','.$passwd.')',0);
251
-    global $ldap_host, $ldap_port, $ldap_basedn, $ldap_host2, $ldap_port2,$ldap_rdn,$ldap_pass;
251
+    global $ldap_host, $ldap_port, $ldap_basedn, $ldap_host2, $ldap_port2, $ldap_rdn, $ldap_pass;
252 252
     //error_log('Entering ldap_authentication_check('.$uname.','.$passwd.')',0);
253 253
     // Establish anonymous connection with LDAP server
254 254
     // Etablissement de la connexion anonyme avec le serveur LDAP
255
-    $ds=ldap_connect($ldap_host,$ldap_port);
255
+    $ds = ldap_connect($ldap_host, $ldap_port);
256 256
     ldap_set_version($ds);
257 257
 
258 258
     $test_bind = false;
259
-    $test_bind_res = ldap_handle_bind($ds,$test_bind);
259
+    $test_bind_res = ldap_handle_bind($ds, $test_bind);
260 260
     //if problem, use the replica
261
-    if ($test_bind_res===false) {
262
-        $ds=ldap_connect($ldap_host2,$ldap_port2);
261
+    if ($test_bind_res === false) {
262
+        $ds = ldap_connect($ldap_host2, $ldap_port2);
263 263
         ldap_set_version($ds);
264 264
     } else {
265 265
         //error_log('Connected to server '.$ldap_host);
266 266
     }
267
-    if ($ds!==false) {
267
+    if ($ds !== false) {
268 268
         //Creation of filter containing values input by the user
269 269
         // Here it might be necessary to use $filter="(samaccountName=$uname)"; - see http://support.chamilo.org/issues/4675
270
-        $filter="(uid=$uname)";
270
+        $filter = "(uid=$uname)";
271 271
         // Open anonymous LDAP connection
272
-        $result=false;
273
-        $ldap_bind_res = ldap_handle_bind($ds,$result);
272
+        $result = false;
273
+        $ldap_bind_res = ldap_handle_bind($ds, $result);
274 274
 	// Executing the search with the $filter parametr
275 275
         //error_log('Searching for '.$filter.' on LDAP server',0);
276
-        $sr=ldap_search($ds,$ldap_basedn,$filter);
276
+        $sr = ldap_search($ds, $ldap_basedn, $filter);
277 277
         $info = ldap_get_entries($ds, $sr);
278
-        $dn=($info[0]["dn"]);
278
+        $dn = ($info[0]["dn"]);
279 279
         // debug !!    echo"<br> dn = $dn<br> pass = $passwd<br>";
280 280
         // closing 1st connection
281 281
         ldap_close($ds);
282 282
     }
283 283
 
284 284
     // test the Distinguish Name from the 1st connection
285
-    if ($dn=="") {
286
-        return (-1);        // doesn't belong to the addressbook
285
+    if ($dn == "") {
286
+        return (-1); // doesn't belong to the addressbook
287 287
     }
288 288
     //bug ldap.. if password empty, return 1!
289
-    if ($passwd=="") {
289
+    if ($passwd == "") {
290 290
         return(1);
291 291
     }
292 292
     // Opening 2nd LDAP connection : Connection user for password check
293
-    $ds=ldap_connect($ldap_host,$ldap_port);
293
+    $ds = ldap_connect($ldap_host, $ldap_port);
294 294
     ldap_set_version($ds);
295 295
     if (!$test_bind) {
296
-        $ds=ldap_connect($ldap_host2,$ldap_port2);
296
+        $ds = ldap_connect($ldap_host2, $ldap_port2);
297 297
         ldap_set_version($ds);
298 298
     }
299 299
     // return in case of wrong password connection error
300
-    if (@ldap_bind( $ds, $dn , $passwd) === false) {
300
+    if (@ldap_bind($ds, $dn, $passwd) === false) {
301 301
         return (1); // invalid password
302 302
     } else {// connection successfull
303 303
         return (0);
@@ -311,7 +311,7 @@  discard block
 block discarded – undo
311 311
 function ldap_set_version(&$resource) {
312 312
     //error_log('Entering ldap_set_version(&$resource)',0);
313 313
     global $ldap_version;
314
-    if ($ldap_version>2) {
314
+    if ($ldap_version > 2) {
315 315
         if (ldap_set_option($resource, LDAP_OPT_PROTOCOL_VERSION, 3)) {
316 316
             //ok - don't do anything
317 317
         } else {
@@ -325,14 +325,14 @@  discard block
 block discarded – undo
325 325
  * @param    resource    The LDAP bind handler we will be modifying
326 326
  * @return    boolean        Status of the bind assignment. True for success, false for failure.
327 327
  */
328
-function ldap_handle_bind(&$ldap_handler,&$ldap_bind) {
328
+function ldap_handle_bind(&$ldap_handler, &$ldap_bind) {
329 329
     //error_log('Entering ldap_handle_bind(&$ldap_handler,&$ldap_bind)',0);
330
-    global $ldap_rdn,$ldap_pass, $extldap_config;
330
+    global $ldap_rdn, $ldap_pass, $extldap_config;
331 331
     $ldap_rdn = $extldap_config['admin_dn'];
332 332
     $ldap_pass = $extldap_config['admin_password'];
333 333
     if (!empty($ldap_rdn) and !empty($ldap_pass)) {
334 334
         //error_log('Trying authenticated login :'.$ldap_rdn.'/'.$ldap_pass,0);
335
-        $ldap_bind = ldap_bind($ldap_handler,$ldap_rdn,$ldap_pass);
335
+        $ldap_bind = ldap_bind($ldap_handler, $ldap_rdn, $ldap_pass);
336 336
         if (!$ldap_bind) {
337 337
             //error_log('Authenticated login failed',0);
338 338
             //try in anonymous mode, you never know...
@@ -358,40 +358,40 @@  discard block
 block discarded – undo
358 358
 
359 359
     global $ldap_basedn, $ldap_host, $ldap_port, $ldap_rdn, $ldap_pass, $ldap_search_dn, $extldap_user_correspondance;
360 360
 
361
-    $keyword_firstname = isset($_GET['keyword_firstname']) ? trim(Database::escape_string($_GET['keyword_firstname'])): '';
361
+    $keyword_firstname = isset($_GET['keyword_firstname']) ? trim(Database::escape_string($_GET['keyword_firstname'])) : '';
362 362
     $keyword_lastname = isset($_GET['keyword_lastname']) ? trim(Database::escape_string($_GET['keyword_lastname'])) : '';
363 363
     $keyword_username = isset($_GET['keyword_username']) ? trim(Database::escape_string($_GET['keyword_username'])) : '';
364 364
     $keyword_type = isset($_GET['keyword_type']) ? Database::escape_string($_GET['keyword_type']) : '';
365 365
 
366
-    $ldap_query=array();
366
+    $ldap_query = array();
367 367
 
368 368
     if ($keyword_username != "") {
369 369
         $ldap_query[] = str_replace('%username%', $keyword_username, $ldap_search_dn);
370 370
     } else {
371
-        if ($keyword_lastname!=""){
372
-            $ldap_query[]="(".$extldap_user_correspondance['lastname']."=".$keyword_lastname."*)";
371
+        if ($keyword_lastname != "") {
372
+            $ldap_query[] = "(".$extldap_user_correspondance['lastname']."=".$keyword_lastname."*)";
373 373
         }
374
-        if ($keyword_firstname!="") {
375
-            $ldap_query[]="(".$extldap_user_correspondance['firstname']."=".$keyword_firstname."*)";
374
+        if ($keyword_firstname != "") {
375
+            $ldap_query[] = "(".$extldap_user_correspondance['firstname']."=".$keyword_firstname."*)";
376 376
         }
377 377
     }
378
-    if ($keyword_type !="" && $keyword_type !="all") {
379
-        $ldap_query[]="(employeeType=".$keyword_type.")";
378
+    if ($keyword_type != "" && $keyword_type != "all") {
379
+        $ldap_query[] = "(employeeType=".$keyword_type.")";
380 380
     }
381 381
 
382
-    if (count($ldap_query)>1){
383
-        $str_query.="(& ";
384
-        foreach ($ldap_query as $query){
385
-            $str_query.=" $query";
382
+    if (count($ldap_query) > 1) {
383
+        $str_query .= "(& ";
384
+        foreach ($ldap_query as $query) {
385
+            $str_query .= " $query";
386 386
         }
387
-        $str_query.=" )";
387
+        $str_query .= " )";
388 388
     } else {
389
-        $str_query= count($ldap_query) > 0 ? $ldap_query[0] : null;
389
+        $str_query = count($ldap_query) > 0 ? $ldap_query[0] : null;
390 390
     }
391 391
 
392 392
     $ds = ldap_connect($ldap_host, $ldap_port);
393 393
     ldap_set_version($ds);
394
-    if ($ds && count($ldap_query)>0) {
394
+    if ($ds && count($ldap_query) > 0) {
395 395
         $r = false;
396 396
         $res = ldap_handle_bind($ds, $r);
397 397
         //$sr = ldap_search($ds, "ou=test-ou,$ldap_basedn", $str_query);
@@ -401,7 +401,7 @@  discard block
 block discarded – undo
401 401
         return $info;
402 402
 
403 403
     } else {
404
-        if (count($ldap_query)!=0)
404
+        if (count($ldap_query) != 0)
405 405
             Display :: display_error_message(get_lang('LDAPConnectionError'));
406 406
         return array();
407 407
     }
@@ -414,7 +414,7 @@  discard block
 block discarded – undo
414 414
  */
415 415
 function ldap_get_number_of_users() {
416 416
     $info = ldap_get_users();
417
-    if (count($info)>0) {
417
+    if (count($info) > 0) {
418 418
         return $info['count'];
419 419
     } else {
420 420
         return 0;
@@ -434,9 +434,9 @@  discard block
 block discarded – undo
434 434
     $is_western_name_order = api_is_western_name_order();
435 435
     if (isset($_GET['submit'])) {
436 436
         $info = ldap_get_users();
437
-        if ($info['count']>0) {
438
-            for ($key = 0; $key < $info["count"]; $key ++) {
439
-                $user=array();
437
+        if ($info['count'] > 0) {
438
+            for ($key = 0; $key < $info["count"]; $key++) {
439
+                $user = array();
440 440
                 // Get uid from dn
441 441
                 //YW: this might be a variation between LDAP 2 and LDAP 3, but in LDAP 3, the uid is in
442 442
                 //the corresponding index of the array
@@ -470,9 +470,9 @@  discard block
 block discarded – undo
470 470
  * @return string Some HTML-code with modify-buttons
471 471
  * @author    Mustapha Alouani
472 472
  */
473
-function modify_filter($user_id,$url_params, $row) {
474
-    $query_string="id[]=".$row[0];
475
-    if (!empty($_GET['id_session'])){
473
+function modify_filter($user_id, $url_params, $row) {
474
+    $query_string = "id[]=".$row[0];
475
+    if (!empty($_GET['id_session'])) {
476 476
         $query_string .= '&amp;id_session='.Security::remove_XSS($_GET['id_session']);
477 477
     }
478 478
     //$url_params_id="id=".$row[0];
@@ -497,7 +497,7 @@  discard block
 block discarded – undo
497 497
     $firstname = api_convert_encoding($data['cn'][0], api_get_system_encoding(), 'UTF-8');
498 498
     $email = $data['mail'][0];
499 499
     // Get uid from dn
500
-    $dn_array=ldap_explode_dn($data['dn'],1);
500
+    $dn_array = ldap_explode_dn($data['dn'], 1);
501 501
     $username = $dn_array[0]; // uid is first key
502 502
     $outab[] = $data['edupersonprimaryaffiliation'][0]; // Here, "student"
503 503
     //$val = ldap_get_values_len($ds, $entry, "userPassword");
@@ -505,29 +505,29 @@  discard block
 block discarded – undo
505 505
     //$password = $val[0];
506 506
     // TODO the password, if encrypted at the source, will be encrypted twice, which makes it useless. Try to fix that.
507 507
     $password = $data['userPassword'][0];
508
-    $structure=$data['edupersonprimaryorgunitdn'][0];
509
-    $array_structure=explode(",", $structure);
510
-    $array_val=explode("=", $array_structure[0]);
511
-    $etape=$array_val[1];
512
-    $array_val=explode("=", $array_structure[1]);
513
-    $annee=$array_val[1];
508
+    $structure = $data['edupersonprimaryorgunitdn'][0];
509
+    $array_structure = explode(",", $structure);
510
+    $array_val = explode("=", $array_structure[0]);
511
+    $etape = $array_val[1];
512
+    $array_val = explode("=", $array_structure[1]);
513
+    $annee = $array_val[1];
514 514
     // To ease management, we add the step-year (etape-annee) code
515
-    $official_code=$etape."-".$annee;
516
-    $auth_source='ldap';
515
+    $official_code = $etape."-".$annee;
516
+    $auth_source = 'ldap';
517 517
     // No expiration date for students (recover from LDAP's shadow expiry)
518
-    $expiration_date='0000-00-00 00:00:00';
519
-    $active=1;
520
-    if(empty($status)){$status = 5;}
521
-    if(empty($phone)){$phone = '';}
522
-    if(empty($picture_uri)){$picture_uri = '';}
518
+    $expiration_date = '0000-00-00 00:00:00';
519
+    $active = 1;
520
+    if (empty($status)) {$status = 5; }
521
+    if (empty($phone)) {$phone = ''; }
522
+    if (empty($picture_uri)) {$picture_uri = ''; }
523 523
     // Adding user
524 524
     $user_id = 0;
525 525
     if (UserManager::is_username_available($username)) {
526
-        $user_id = UserManager::create_user($firstname,$lastname,$status,$email,$username,$password,$official_code,api_get_setting('platformLanguage'),$phone,$picture_uri,$auth_source,$expiration_date,$active);
526
+        $user_id = UserManager::create_user($firstname, $lastname, $status, $email, $username, $password, $official_code, api_get_setting('platformLanguage'), $phone, $picture_uri, $auth_source, $expiration_date, $active);
527 527
     } else {
528 528
         if ($update_if_exists) {
529 529
             $user = api_get_user_info($username);
530
-            $user_id=$user['user_id'];
530
+            $user_id = $user['user_id'];
531 531
             UserManager::update_user($user_id, $firstname, $lastname, $username, null, null, $email, $status, $official_code, $phone, $picture_uri, $expiration_date, $active);
532 532
         }
533 533
     }
@@ -544,21 +544,21 @@  discard block
 block discarded – undo
544 544
 
545 545
     // Database Table Definitions
546 546
     $tbl_session                        = Database::get_main_table(TABLE_MAIN_SESSION);
547
-    $tbl_session_rel_class                = Database::get_main_table(TABLE_MAIN_SESSION_CLASS);
547
+    $tbl_session_rel_class = Database::get_main_table(TABLE_MAIN_SESSION_CLASS);
548 548
     $tbl_session_rel_course                = Database::get_main_table(TABLE_MAIN_SESSION_COURSE);
549 549
     $tbl_session_rel_course_rel_user    = Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER);
550 550
     $tbl_course                            = Database::get_main_table(TABLE_MAIN_COURSE);
551 551
     $tbl_user                            = Database::get_main_table(TABLE_MAIN_USER);
552 552
     $tbl_session_rel_user                = Database::get_main_table(TABLE_MAIN_SESSION_USER);
553
-    $tbl_class                            = Database::get_main_table(TABLE_MAIN_CLASS);
554
-    $tbl_class_user                        = Database::get_main_table(TABLE_MAIN_CLASS_USER);
553
+    $tbl_class = Database::get_main_table(TABLE_MAIN_CLASS);
554
+    $tbl_class_user = Database::get_main_table(TABLE_MAIN_CLASS_USER);
555 555
 
556 556
     $id_session = (int) $id_session;
557 557
     // Once users are imported in the users base, we can assign them to the session
558
-    $result=Database::query("SELECT c_id FROM $tbl_session_rel_course WHERE session_id ='$id_session'");
559
-    $CourseList=array();
560
-    while ($row=Database::fetch_array($result)) {
561
-        $CourseList[]=$row['c_id'];
558
+    $result = Database::query("SELECT c_id FROM $tbl_session_rel_course WHERE session_id ='$id_session'");
559
+    $CourseList = array();
560
+    while ($row = Database::fetch_array($result)) {
561
+        $CourseList[] = $row['c_id'];
562 562
     }
563 563
     foreach ($CourseList as $enreg_course) {
564 564
         foreach ($UserList as $enreg_user) {
@@ -569,21 +569,21 @@  discard block
 block discarded – undo
569 569
               "('$id_session','$enreg_course','$enreg_user')");
570 570
         }
571 571
         $sql = "SELECT COUNT(user_id) as nbUsers ".
572
-               " FROM $tbl_session_rel_course_rel_user " .
572
+               " FROM $tbl_session_rel_course_rel_user ".
573 573
                " WHERE session_id='$id_session' ".
574 574
                " AND c_id='$enreg_course'";
575 575
         $rs = Database::query($sql);
576 576
         list($nbr_users) = Database::fetch_array($rs);
577 577
         Database::query("UPDATE $tbl_session_rel_course  ".
578
-               " SET nbr_users=$nbr_users " .
578
+               " SET nbr_users=$nbr_users ".
579 579
                " WHERE session_id='$id_session' ".
580 580
                " AND c_id='$enreg_course'");
581 581
     }
582 582
     foreach ($UserList as $enreg_user) {
583 583
         $enreg_user = (int) $enreg_user;
584 584
         Database::query("INSERT IGNORE INTO $tbl_session_rel_user ".
585
-               " (session_id, user_id, registered_at) " .
586
-               " VALUES('$id_session','$enreg_user', '" . api_get_utc_datetime() . "')");
585
+               " (session_id, user_id, registered_at) ".
586
+               " VALUES('$id_session','$enreg_user', '".api_get_utc_datetime()."')");
587 587
     }
588 588
     // We update the number of users in the session
589 589
     $sql = "SELECT COUNT(user_id) as nbUsers FROM $tbl_session_rel_user ".
@@ -598,13 +598,13 @@  discard block
 block discarded – undo
598 598
 function syncro_users() {
599 599
     global $ldap_basedn, $ldap_host, $ldap_port, $ldap_rdn, $ldap_pass, $ldap_search_dn;
600 600
     echo "Connecting ...";
601
-    $ldap_connect = ldap_connect( $ldap_host, $ldap_port);
601
+    $ldap_connect = ldap_connect($ldap_host, $ldap_port);
602 602
     ldap_set_version($ldap_connect);
603 603
     if ($ldap_connect) {
604 604
         //echo " Connect to LDAP server successful ";
605 605
         //echo "Binding ...";
606 606
         $ldap_bind = false;
607
-        $ldap_bind_res = ldap_handle_bind($ldap_connect,$ldap_bind);
607
+        $ldap_bind_res = ldap_handle_bind($ldap_connect, $ldap_bind);
608 608
         if ($ldap_bind_res) {
609 609
             //echo " LDAP bind successful... ";
610 610
             //echo " Searching for uid... ";
@@ -612,7 +612,7 @@  discard block
 block discarded – undo
612 612
             //OLD: $sr=ldap_search($ldapconnect,"dc=rug, dc=ac, dc=be", "uid=$login");
613 613
             //echo "<p> ldapDc = '$LDAPbasedn' </p>";
614 614
             $all_user_query = "uid=*";
615
-            if(!empty($ldap_search_dn)) {
615
+            if (!empty($ldap_search_dn)) {
616 616
                 $sr = ldap_search($ldap_connect, $ldap_search_dn, $all_user_query);
617 617
             } else {
618 618
                 $sr = ldap_search($ldap_connect, $ldap_basedn, $all_user_query);
@@ -620,7 +620,7 @@  discard block
 block discarded – undo
620 620
             //echo " Number of entries returned is ".ldap_count_entries($ldapconnect,$sr);
621 621
             //echo " Getting entries ...";
622 622
             $info = ldap_get_entries($ldap_connect, $sr);
623
-            for ($key = 0; $key < $info['count']; $key ++) {
623
+            for ($key = 0; $key < $info['count']; $key++) {
624 624
                 $user_id = ldap_add_user_by_array($info[$key], false);
625 625
                 if ($user_id) {
626 626
                     echo "User #$user_id created ";
Please login to merge, or discard this patch.
Braces   +9 added lines, -3 removed lines patch added patch discarded remove patch
@@ -80,7 +80,12 @@  discard block
 block discarded – undo
80 80
 
81 81
     if ($res==1) { //WRONG PASSWORD
82 82
         //$errorMessage = "LDAP User or password incorrect, try again.<br />";
83
-        if (isset($log)) unset($log); if (isset($uid)) unset($uid);
83
+        if (isset($log)) {
84
+            unset($log);
85
+        }
86
+        if (isset($uid)) {
87
+            unset($uid);
88
+        }
84 89
         $loginLdapSucces = false;
85 90
     }
86 91
     if ($res==-1) { //WRONG USERNAME
@@ -401,8 +406,9 @@  discard block
 block discarded – undo
401 406
         return $info;
402 407
 
403 408
     } else {
404
-        if (count($ldap_query)!=0)
405
-            Display :: display_error_message(get_lang('LDAPConnectionError'));
409
+        if (count($ldap_query)!=0) {
410
+                    Display :: display_error_message(get_lang('LDAPConnectionError'));
411
+        }
406 412
         return array();
407 413
     }
408 414
 }
Please login to merge, or discard this patch.
Indentation   +20 added lines, -21 removed lines patch added patch discarded remove patch
@@ -46,10 +46,9 @@  discard block
 block discarded – undo
46 46
     - Universite Jean Monet (J Dubois / Michel Courbon)
47 47
     - Michel Panckoucke for reporting and fixing a bug
48 48
     - Patrick Cool: fixing security hole
49
-
50
-    *    @author Roan Embrechts
51
-    *    @version 3.0
52
-    *    @package chamilo.auth.ldap
49
+ *    @author Roan Embrechts
50
+ *    @version 3.0
51
+ *    @package chamilo.auth.ldap
53 52
  * Note:
54 53
  * If you are using a firewall, you might need to check port 389 is open in
55 54
  * order for Chamilo to communicate with the LDAP server.
@@ -211,8 +210,8 @@  discard block
 block discarded – undo
211 210
     $language = api_get_setting('platformLanguage');
212 211
     if (empty($language)) { $language = 'english'; }
213 212
     $_userId = UserManager::create_user($prenom, $nom, $status,
214
-                     $email, $uname, $password, $official_code,
215
-                     $language,'', '', 'ldap');
213
+                        $email, $uname, $password, $official_code,
214
+                        $language,'', '', 'ldap');
216 215
 
217 216
     //echo "new user added to Chamilo, id = $_userId";
218 217
 
@@ -271,7 +270,7 @@  discard block
 block discarded – undo
271 270
         // Open anonymous LDAP connection
272 271
         $result=false;
273 272
         $ldap_bind_res = ldap_handle_bind($ds,$result);
274
-	// Executing the search with the $filter parametr
273
+    // Executing the search with the $filter parametr
275 274
         //error_log('Searching for '.$filter.' on LDAP server',0);
276 275
         $sr=ldap_search($ds,$ldap_basedn,$filter);
277 276
         $info = ldap_get_entries($ds, $sr);
@@ -564,35 +563,35 @@  discard block
 block discarded – undo
564 563
         foreach ($UserList as $enreg_user) {
565 564
             $enreg_user = (int) $enreg_user;
566 565
             Database::query("INSERT IGNORE ".
567
-              " INTO $tbl_session_rel_course_rel_user ".
568
-              "(session_id,c_id,user_id) VALUES ".
569
-              "('$id_session','$enreg_course','$enreg_user')");
566
+                " INTO $tbl_session_rel_course_rel_user ".
567
+                "(session_id,c_id,user_id) VALUES ".
568
+                "('$id_session','$enreg_course','$enreg_user')");
570 569
         }
571 570
         $sql = "SELECT COUNT(user_id) as nbUsers ".
572
-               " FROM $tbl_session_rel_course_rel_user " .
573
-               " WHERE session_id='$id_session' ".
574
-               " AND c_id='$enreg_course'";
571
+                " FROM $tbl_session_rel_course_rel_user " .
572
+                " WHERE session_id='$id_session' ".
573
+                " AND c_id='$enreg_course'";
575 574
         $rs = Database::query($sql);
576 575
         list($nbr_users) = Database::fetch_array($rs);
577 576
         Database::query("UPDATE $tbl_session_rel_course  ".
578
-               " SET nbr_users=$nbr_users " .
579
-               " WHERE session_id='$id_session' ".
580
-               " AND c_id='$enreg_course'");
577
+                " SET nbr_users=$nbr_users " .
578
+                " WHERE session_id='$id_session' ".
579
+                " AND c_id='$enreg_course'");
581 580
     }
582 581
     foreach ($UserList as $enreg_user) {
583 582
         $enreg_user = (int) $enreg_user;
584 583
         Database::query("INSERT IGNORE INTO $tbl_session_rel_user ".
585
-               " (session_id, user_id, registered_at) " .
586
-               " VALUES('$id_session','$enreg_user', '" . api_get_utc_datetime() . "')");
584
+                " (session_id, user_id, registered_at) " .
585
+                " VALUES('$id_session','$enreg_user', '" . api_get_utc_datetime() . "')");
587 586
     }
588 587
     // We update the number of users in the session
589 588
     $sql = "SELECT COUNT(user_id) as nbUsers FROM $tbl_session_rel_user ".
590
-           " WHERE session_id='$id_session' ".
591
-           " AND relation_type<>".SESSION_RELATION_TYPE_RRHH." ";
589
+            " WHERE session_id='$id_session' ".
590
+            " AND relation_type<>".SESSION_RELATION_TYPE_RRHH." ";
592 591
     $rs = Database::query($sql);
593 592
     list($nbr_users) = Database::fetch_array($rs);
594 593
     Database::query("UPDATE $tbl_session SET nbr_users=$nbr_users ".
595
-           " WHERE id='$id_session'");
594
+            " WHERE id='$id_session'");
596 595
 }
597 596
 
598 597
 function syncro_users() {
Please login to merge, or discard this patch.