2 /*=====================================================================*\
3 || ###################################################################
4 || # Blue Static ISSO Framework
5 || # Copyright (c)2005-2009 Blue Static
7 || # This program is free software; you can redistribute it and/or modify
8 || # it under the terms of the GNU General Public License as published by
9 || # the Free Software Foundation; version 2 of the License.
11 || # This program is distributed in the hope that it will be useful, but
12 || # WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
13 || # or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
16 || # You should have received a copy of the GNU General Public License along
17 || # with this program; if not, write to the Free Software Foundation, Inc.,
18 || # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
19 || ###################################################################
20 \*=====================================================================*/
23 * Static functions (Functions.php)
31 * This is a bunch of static functions wrapped in a class for modularity and
32 * namespace collisions.
35 * @copyright Copyright (c)2005 - 2009, Blue Static
45 private static $cookiePath = '/';
48 * Cookie domain setting
51 private static $cookieDomain = '';
54 * Cookie expiration time
57 private static $cookieTimeout = 900;
60 * Current swapped CSS class
63 public static $cssClass = '';
68 private function __construct()
72 * Sets the cookie path
74 * @param string New path
76 public static function set_cookie_path($path)
78 self
::$cookiePath = $path;
82 * Sets the cookie domain setting
84 * @param string Cookie domain
86 public static function set_cookie_domain($domain)
88 self
::$cookieDomain = $domain;
92 * Sets the cookie timeout
94 * @param integer Cookie timeout
96 public static function set_cookie_timeout($timeout)
98 self
::$cookieTimeout = intval($timeout);
102 * Sets a cookie in the user's computer/browing session
104 * @param string Name of the cookie
105 * @param string Value of the cookie, FALSE to clear
106 * @param bool Is the cookie permanent?
108 public static function cookie($name, $value, $sticky = true
)
111 if ($value === false
)
113 setcookie($name, $value, time() - (2 * self
::$cookieTimeout), self
::$cookiePath, self
::$cookieDomain);
120 $expire = time() +
60 * 60 * 24 * 365;
124 $expire = time() + self
::$cookieTimeout;
127 setcookie($name, $value, $expire, self
::$cookiePath, self
::$cookieDomain);
132 * Alternate between two CSS classes
134 * @param string First CSS class name
135 * @param string Second CSS class name
137 public static function swap_css_classes($class1 = 'alt1', $class2 = 'alt2')
141 self
::$cssClass = ($count %
2) ?
$class1 : $class2;
146 * Returns the 'source path' version of a file path. It adds a
147 * directory separator to the end of a string if it does not already
152 * @return string Path with directory separator ending
154 public static function fetch_source_path($source)
156 if (substr($source, strlen($source) - 1) != DIRECTORY_SEPARATOR
)
158 $source .= DIRECTORY_SEPARATOR
;
164 * Force-download a file by sending application/octetstream
166 * @param string The text of the file to be streamed
167 * @param string File name of the new file
168 * @param bool Whether or not to die after stringeaming the file
170 public static function download_file($file, $name, $exit = true
)
172 header("Content-Type: application/octetstream");
173 header("Content-Type: application/octet-stream");
174 header('Expires: ' . gmdate('D, d M Y H:i:s') . ' GMT');
175 header('Content-Disposition: attachment; filename="' . $name . '"');
176 header('Content-length: ' . strlen($file));
177 header('Cache-Control: must-revalidate, post-check=0, pre-check=0');
178 header('Pragma: public');
189 * Verify that an email address is valid via regex
191 * @param string An email address
193 * @return bool Validity of the email address
195 public static function is_valid_email($email)
197 return (preg_match('#^[a-z0-9\.\-\+_]+?@(.*?\.)*?[a-z0-9\-_]+?\.[a-z]{2,4}$#i', $email));
201 * Generates a random string of random length (unless otherwise
204 * @param integer Optional length
206 * @return string A random string
208 public static function random($length = 0)
210 // length wasn't provided, so create our own
213 $length = rand(20, 65);
217 while (strlen($string) < $length)
219 $type = rand(0, 300);
222 $string .= rand(0, 9);
224 else if ($type < 200)
226 $string .= chr(rand(65, 90));
230 $string .= chr(rand(97, 122));
238 * Sets the current array position to be the specified key. This
239 * function should be avoided on large arrays.
241 * @param array The array whose counter is to be updated
242 * @param mixed The key of the element of the array that the counter is to be set to
244 * @return mixed Return the elelment of the array that we just put the counter to
246 public static function array_set_current(&$array, $key)
249 while (current($array) !== false
)
251 if (key($array) == $key)
257 return current($array);
261 * Calculates the microtime difference by taking a given microtime and
262 * subtracting it from the current one
264 * @param string The start microtime
266 * @return float Microtime difference
268 public static function fetch_microtime_diff($mtstart)
270 $mtend = microtime();
271 list($startMicro, $startSec) = explode(' ', $mtstart);
272 list($endMicro, $endSec) = explode(' ', $mtend);
273 return ($endMicro +
$endSec) - ($startMicro +
$startSec);
277 * Fetches the extension of a file by extracting everything after the
280 * @param string Filename
282 * @return string The extension for the specifid file name
284 public static function fetch_extension($filename)
286 $array = explode('.', $filename);
288 if (sizeof($array) == 1)
293 return strval(end($array));
297 * Gets the maximum file size for attachment uploading, as specified by
298 * PHP. If no value is present, 10 MB (represented in bytes) is
301 * @return integer The maximum file upload size in bytes
303 public static function fetch_max_php_file_size()
305 if ($size = @ini_get('upload_max_filesize'))
307 if (preg_match('#[^0-9].#', $size))
313 return intval($size) * 1048576;
323 * Scans a specified directory path and returns an array of all the
324 * items in that directory. Directories found by this are end in a "/"
326 * @param string Path to scan
327 * @param bool Whether or not to recursively scan the directories encountered
328 * @param bool Ignore files beginning with a dot
330 * @return array A list of all the files in the specified path
332 public static function scan_directory($path, $recurse = true
, $ignoreDot = true
)
334 return self
::_help_scan_directory($path, $recurse, $ignoreDot, '');
338 * Scans a specified directory path and returns an array of all the
339 * items in that directory. Directories found by this are end in a "/"
341 * @param string Path to scan
342 * @param bool Whether or not to recursively scan the directories encountered
343 * @param bool Ignore files beginning with a dot
344 * @param string Add to the beginning of the path
346 * @return array A list of all the files in the specified path
348 private static function _help_scan_directory($path, $recurse = true
, $ignoreDot = true
, $pathAdd = '')
351 $path = self
::fetch_source_path($path);
353 $dir = new DirectoryIterator($path);
354 foreach ($dir as $file)
356 $name = $file->getFilename();
357 if (($file->isDot() ||
$name[0] == '.') && $ignoreDot)
362 if ($file->isDir() && $recurse)
364 $filelist = array_merge($filelist, self
::_help_scan_directory($path . $name, $recurse, $ignoreDot, $pathAdd . BSFunctions
::fetch_source_path(str_replace($path, '', $file->getPathname()))));
368 $filelist[] = $pathAdd . $name;
375 * Changes line breaks into one format
378 * @param string New line break (default is UNIX \n format)
380 * @return string Text with one type of line break
382 public static function convert_line_breaks($text, $convert_to = "\n")
385 $text = str_replace(array("\r\n", "\r", "\n"), "\n", $text);
386 $text = str_replace("\n", $convert_to, $text);
391 * Removes all empty() [by PHP's standards] elements in an array. This
392 * can be used in place of using PREG_SPLIT_NO_EMPTY.
394 * @param array An array to strip empties from
396 * @return array Full-valued array
398 public static function array_strip_empty($array)
400 foreach ($array as $key => $value)
402 if (is_array($array["$key"]))
404 $array["$key"] = self
::array_strip_empty($array["$key"]);
406 else if (empty($value) ||
is_null($value))
408 unset($array["$key"]);
415 * A backtrace formatter.
417 * This is very slightly modified from PEAR/PHP_Compat (PHP license)
419 * @author Laurent Laville <pear@laurent-laville.org>
420 * @author Aidan Lister <aidan@php.net>
422 * @param array The backtrace from debug_backtrace() to format
424 * @return string Formatted output
426 public static function format_backtrace($backtrace)
428 // Unset call to debug_print_backtrace
429 array_shift($backtrace);
430 if (empty($backtrace))
437 foreach ($backtrace as $i => $call)
439 if (!isset($call['file']))
441 $call['file'] = '(null)';
443 if (!isset($call['line']))
447 $location = $call['file'] . ':' . $call['line'];
448 $function = (isset($call['class'])) ?
$call['class'] . (isset($call['type']) ?
$call['type'] : '.') . $call['function'] : $call['function'];
451 if (isset($call['args']))
454 foreach ($call['args'] as $arg)
460 elseif (is_object($arg))
462 $args[] = get_class($arg);
469 $params = implode(', ', $args);
472 $calls[] = sprintf('#%d %s(%s) called at [%s]', $i, $function, $params, $location);
475 return implode("\n", $calls);
479 * A variation of PHP's substr() method that takes in the start
480 * and end position of a string, rather than a start and length. This
481 * mimics Java's String.substring() method.
483 * @param string The string
484 * @param integer Start position
485 * @param integer End position
487 * @return string Part of a string
489 public static function substring($string, $start, $end)
491 return substr($string, $start, $end - $start);