Library of commonly used functions. More...

Functions
	checkRole ($role, $account=null)
	Check whether the user has one of a specified set of roles. More...

	hasRole ($role, $account=null)
	Determine whether a user has a specific role explicitly set. More...

	filterByRole ($items, $field)
	Filter the given list, retaining only the objects that match the current user's role profile in the given parameter. More...

	formatAddress ()
	Utility function to nicely format addresses, etc. More...

	formatCurrency ($amount)
	Utility function to format currency using $ and , and stuff. More...

	formatDate ($date)
	Utility function to format date (no time component). More...

	formatMonthYear ($date)

	formatDateShort ($date)
	Utility function to format date in short form (MM/DD/YYYY), with no time component. More...

	formatDateLong ($date)

	formatTimestamp ($ts)
	Utility function to format readable date from a timestamp (no time component). More...

	formatTimestampShort ($ts)

	getMonthDays ($m, $y)
	Returns the number of days in the specified month. More...

	getMonthWeekDays ($month, $year)
	Get the number of week days in the specified month. More...

	formatTime12 ($time)
	Format a time in 12 hour clock, no seconds. More...

	formatDateTime12 ($time)
	Format a date and time in 12 hour clock, no seconds. More...

	formatDateTime12Hr ($datetime)

	formatStartDateToEndDate ($start, $end)

	format_phone ($phone)

	now ()
	Returns the current time and date in a database compatible format. More...

	today ()
	Returns today as a string. More...

	jsSafe ($str, $escapeEntities=false)
	Utility function to escape a string correctly for use in a Javascript client-side call. More...

	htmlsafe ($str)

	cleanHTMLTags ($str)

	HTMLToText ($html)

	cleanQuotes ($str)

	printMIMETypeList ($types)
	Outputs the MIME type list based on an array of MIME types. More...

	getDocType ($doc)
	Returns a human-readable type name for a document, based on the file extension of the supplied file name. More...

	getDocSize ($doc)
	Returns the file size in Kb for a document. More...

	getDocMimeType ($name)

	getDocIcon ($doc)

	checkNumeric ($p)
	Security helper function. More...

	checkNumericList ($p, $separator=",")
	Security helper function. More...

	checkIdentifier ($p)
	Security helper function. More...

	checkIdentifierList ($p)
	Security helper function. More...

	checkValidEmail ($e)
	Security helper function. More...

	checkValidDate ($d)
	Security helper function. More...

	checkValidDateTime ($d)
	Security helper function. More...

	checkPlainGUID ($guid)
	Checkes whether the provided string is an undecorated GUID (i.e. More...

	checkGUID ($guid)
	Checks whether the provided string is in a valid form for a GUID. More...

	color ($count)
	Utility function to nicely format addresses, etc. More...

	ellipsis ($txt, $max, $wholeWord=false)
	Truncate the supplied text at the given maximum length. More...

	rteSafe ($strText)

	firstSentence ($text)
	Returns the first sentence of the supplied text. More...

	stripHTML ($text)

	parseMultiParam ($collection, $param)
	Parse out multiple values from the provided collection that have the same root name, and return the results in an array. More...

	option ($value, $text, $sel="")
	Write out an option tag, marking as selected if applicable. More...

	str_option ($value, $text, $sel="")
	Write out an option tag to a string, marking as selected if applicable. More...

	registerRedirectLogCallback ($callback)

	redirect ($page)
	Simplified redirect. More...

	getCleanQueryString ()
	Returns the query string for the current page, cleaned of any Fakoli-related navigation parameters. More...

	trace ($msg, $lvl=3, $callStack=null)
	Send output to the trace log. More...

	getScaledSize ($size, $decimal_places=1)
	Get human-readable file size from raw number of bytes. More...

	roundFormat ($num, $abbrev=false)

	getIcon ($file)
	Retrieves a graphic icon appropriate for the given file. More...

	includeRemote ($host, $file)
	Includes the contents of the given remote file, with any relative src or href references converted to absolute references. More...

	getRemote ($url, $username="", $password="")
	Retrieve the contents of the remote file at the given URL. More...

	jsonRequest ($url, $params=array())
	Make a simple GET request to a JSON-return RESTful API, passing the supplied parameters. More...

	saveRemote ($url, $saveAs)
	Retreive the contents of the remote file at the given URL and save it to the specified location on the local disk. More...

	canonicalizeURL ($url)
	Takes a URL and converts relative URLs to absolute URLs for the current site. More...

	sanitizePath ($path)
	Sanitize a file path, removing relative path sections and ensuring the correct directory separator is used throughout. More...

	postRemote ($url, $data=null, $timeout=30)
	Make a POST request to a remote URL, returning the results. More...

	postRemoteXML ($url, $xml, $timeout=30)

	getRemoteHeaders ($url)
	Retrieve the HTTP headers for the specified remote URL (excluding the body). More...

	wrapURL ($url, $width=120)
	Break a URL at a given string position. More...

	codify ($name)
	Takes a text string and converts it into a code-compliant format, suitable for use as a variable name or identifier. More...

	prettify ($name)
	Takes a variable or field name and converts it into a human-readable version (assuming that the original contains human-readable words, of course). More...

	pluralize ($text, $count=0)
	Takes a singular string and makes it plural. More...

	formatAsHTML ($text)
	Takes a string and formats it for display as HTML, removing any HTML tags it contains, and converting carriage returns to br tags. More...

	startsWith ($text, $start)
	Tests whether a string starts with a given sub-string. More...

	endsWith ($text, $end)
	Tests whether a string ends with the given sub-string. More...

	stripHTMLTags ($text)
	Removes all HTML tags from the specified string. More...

	ordinalSuffix ($n, $sup=false)
	Adds the english ordinal suffix to a number. More...

	makeURL ($uri)
	Ensures that the http:// protocol specifier prefix is present in the supplied string. More...

	formatCheckListItemsforView ($options, $items)
	For dataitems that are rendered as CheckListFieldRenderer, this function converts the comma-delimited list of items for display. More...

	baseURI ($uri=null)
	Returns the base URI for the current script, with the query string removed. More...

	appendToQueryString ($qs, $params)
	Appends the specified parameters to the supplied query string. More...

	registerURLRewriteParameters ()
	Register any URL rewrite parameters that should be excluded from query string reformatting. More...

	getFullQueryString ($includePOST=true)
	Generates a query string containing the values passed to this page. More...

	toJSArray ($items, $field="")

	prettyPrintJSON ($json)
	Format the JSON in the supplied string to be more human-readable. More...

	makeRandomString ($len)
	Creates a randomized string of characters. More...

	arrayFilterKey ( $input, $callback)
	Filter an array based on applying the specified callback to the keys. More...

	ajaxReturn ($msg=null)
	Returns a string output and exits the script cleanly. More...

	getMIMEType ($filename)

	array_remove_keys ($array)
	Remove specified keys from the given array. More...

	xmlEntities ($string)
	Function to provide html to XML entity renaming. More...

	encode7bit ($text)
	Encode text to 7-bit clean format, suitable for mail headers. More...

	GUID ()
	Generates a version 4 GUID. More...

	plainGUID ()
	Generates a version 4 GUID with no punctutation. More...

	getBacktrace ($ignore=2)
	Returns a formatted backtrace suitable for debugging output. More...

	luhnTest ($num)
	Performs a Luhn validity test for credit card or IMEI numbers. More...

	countMatchingElements ($a, $b)
	Determines the number of items that two comma-separated lists have in common. More...

	printIncludes ($html=true, $return=false)
	Outputs a list of all included files. More...

	replaceValues ($substitutions, $target)
	Given an array of pairs of old and new values, replace all instances of old values with new values in the target string. More...

	fopen_utf8 ($filename)
	Opens a text file, detects the encoding, inteprets the BOM if present, attaches a stream filter to convert to UTF-8. More...

	fgetcsv_noBOM ($fp)

	tempdir ($dir=null, $prefix='tmp_', $mode=0700, $maxAttempts=1000)
	Creates a random unique temporary directory, with specified parameters, that does not already exist (like tempnam(), but for dirs). More...

Variables
	$image_types = array( "image/jpeg", "image/gif", "image/x-png", "image/pjpeg" )
	MIME types allowable for image uploads. More...

	$_redirectLogCallback = null

	$traceLevels

	$_icons

	$__urlRewriteParams = array()

Detailed Description

Library of commonly used functions.

Function Documentation

◆ ajaxReturn()

ajaxReturn ( $msg = null )

Returns a string output and exits the script cleanly.

We used to be able to use die(), but because of PHP 5's messed up session handling this throws an error if there is a custom session handler registered.

Parameters

string $msg

Definition at line 1783 of file functions.inc.

 {
      if (class_exists(FakoliEarlyExit))
      {
           throw new FakoliEarlyExit($msg);
      }
      else
      {
           session_write_close();
           die($msg);
      }
 }

◆ appendToQueryString()

appendToQueryString	(	$qs,
		$params
	)

Appends the specified parameters to the supplied query string.

Parameters

string	$qs	the query string
string	$params	parameters to append in query string format

Returns: string combined string

Definition at line 1594 of file functions.inc.

 {
      trace ("QS: $qs PARAMS: $params", 3);
      if (strpos($qs, "?") === false && strpos($qs, "&") === false) 
      {
           $qs .= "?$params";
           return $qs;
      }
  
      $qs .= "&$params";
      $qs = preg_replace("/&&+/", "&", $qs);
      if (strpos($qs, "?") === false) $qs = "?".$qs;
      
      return $qs;
 }

◆ array_remove_keys()

array_remove_keys ( $array )

Remove specified keys from the given array.

Parameters

array $array the array to strip

Returns: stripped array

Definition at line 1885 of file functions.inc.

 {
      for($i = 1; $i < func_num_args(); ++$i)
      {
           unset($array[func_get_arg($i)]);
      }
      
      return $array;
 }

◆ arrayFilterKey()

arrayFilterKey	(	$input,
		$callback
	)

Filter an array based on applying the specified callback to the keys.

Parameters

array	$input	the array to be filtered
callback	$callback	a callback function or method

Returns: array the filtered array.

Definition at line 1752 of file functions.inc.

 {
     if ( !is_array( $input ) ) 
     {
         return null;
     }
    
     if ( empty( $input ) ) 
     {
         return $input;
     }
    
     $filteredKeys = array_filter( array_keys( $input ), $callback );
     
     if ( empty( $filteredKeys ) ) 
     {
         return array();
     }
    
     $input = array_intersect_key( array_flip( $filteredKeys ), $input );
    
     return $input;
 }

◆ baseURI()

baseURI ( $uri = null )

Returns the base URI for the current script, with the query string removed.

string

Parameters

$uri	(optional) the URI to truncate - if not specified, the URI for the currently executing script is used.

Definition at line 1582 of file functions.inc.

 {
      if (!$uri) $uri = $_SERVER['REQUEST_URI'];
      return preg_replace("/\\?.*$/", "", $uri);
 }

◆ canonicalizeURL()

canonicalizeURL ( $url )

Takes a URL and converts relative URLs to absolute URLs for the current site.

Parameters

string $url the URL to convert

Returns: string full canonical form for the URL

Definition at line 1278 of file functions.inc.

 {
      global $config;
      
      if (startsWith($url, "http://") || startsWith($url, "https://")) return $url;
      
  
      if (!startsWith($url, "/"))
      {
           $out = realpath($config['homedir']."/".$url);
      }
      else
      {
           $out = realpath($config['homedir'].$url);
      }
      
      $out = str_replace('\\', '/', $out);
      
      if (!startsWith($out, $config['homedir'])) return null;
      $out = str_replace($config['homedir'], "http://{$config['http_host']}", $out);
      
      trace("$url -> $out", 4);
      return $out;
 }

◆ checkGUID()

checkGUID ( $guid )

Checks whether the provided string is in a valid form for a GUID.

Parameters

string $guid the GUID candidate

Returns: string the value of the parameter if it is a valid GUID

Definition at line 744 of file functions.inc.

 {
      if (preg_match('/^\{?[A-F0-9]{8}-[A-F0-9]{4}-[A-F0-9]{4}-[A-F0-9]{4}-[A-F0-9]{12}\}?$/i', $guid))
      {
           return $guid;
      }
      
      die("Invalid Parameter");
 }

◆ checkIdentifier()

checkIdentifier ( $p )

Security helper function.

Check that the given parameter is a valid identifier (alphanumeric, _ and digits only with no spaces). Empty string is valid

Definition at line 666 of file functions.inc.

 {
      return preg_match("/^[A-Za-z0-9_\\-\\.]*$/", $p) ? $p : die("Invalid Parameter");
 }

◆ checkIdentifierList()

checkIdentifierList ( $p )

Security helper function.

Check that the given parameter is a comma-separated list of valid identifiers (alphanumeric, _ and digits only with no spaces). Empty string is valid

Definition at line 675 of file functions.inc.

 {
      return preg_match("/^[A-Za-z0-9_\\-\\.,]*$/", $p) ? $p : die("Invalid Parameter");
 }

◆ checkNumeric()

checkNumeric ( $p )

Security helper function.

Check that the given parameter is a numeric value.

Parameters

string $p the parameter to check

Returns: the value of the parameter if it matches the required format

Definition at line 630 of file functions.inc.

 {
      if (is_array($p))
      {
           foreach($p as $v)
           {
                if ($v!="" && !is_numeric($v)) die("Invalid Parameter");
           }
      }
      else if ($p!="" && !is_numeric($p)) die("Invalid Parameter");
      return $p;
 }

◆ checkNumericList()

checkNumericList	(	$p,
		$separator = `","`
	)

Security helper function.

Check that the given parameter contains a list of numeric values with the given separator.

Parameters

string	$p	the parameter to check
string	$separator	the list separator (default to comma)

Returns: the value of the parameter if it matches the required format

Definition at line 649 of file functions.inc.

 {
      if (is_array($p))
      {
           foreach($p as $v)
           {
                if ($v != "" & !preg_match("/^[0-9\\.{$separator}]*$/", $v)) die("Invalid Parameter");
           }
      }
      else if ($p!="" && !preg_match("/^[0-9\\.{$separator}]*$/", $p)) die("Invalid Parameter");
      return $p;
 }

◆ checkPlainGUID()

checkPlainGUID ( $guid )

Checkes whether the provided string is an undecorated GUID (i.e.

a string of 32 hex characters)

Parameters

string $guid the GUID candidate

Returns: string the value of the parameter if it is a valid undecorated GUID

Definition at line 729 of file functions.inc.

 {
      if (preg_match('/^[A-F0-9]{32}$/i', $guid))
      {
           return $guid;
      }
  
      die("Invalid Parameter");
 }

◆ checkRole()

checkRole	(	$role,
		$account = `null`
	)

Check whether the user has one of a specified set of roles.

Parameters

string	$role	the role(s) to check against, as a comma-delimited list
object	$account	(optional) the account object to check (must have a 'role' property). If not provided, the default user account is used (assumed to be in the global $user variable).

Returns: boolean true if the user has one of the roles, false otherwise.

Definition at line 52 of file functions.inc.

 {
      global $user;
      
      if (!$account) $account = $user;
      
      if ($role == "" || $account->role == "admin") return true;
      if (!$account) return false;
      
      if ($role != "" && $account->role == "") return false;
      
      $userRoles = explode(",", $account->role);
      foreach($userRoles as $ur)
      {
           if ($ur == "admin") return true;
           $expr = "/\\b{$ur}\\b/";
           $allowed = (preg_match($expr, $role) > 0) ? true : false;
           if ($allowed) break;
      }
      
      return $allowed;
 }

◆ checkValidDate()

checkValidDate ( $d )

Security helper function.

Check that the given parameter is a valid date.

Parameters

string $d the date

Returns: string the value of the parameter if it is in a valid date format

Definition at line 695 of file functions.inc.

 {
      if (!$d) return $d;
      $formats = array("Y-m-d", "Y/m/d", "m/d/Y");
      foreach($formats as $format)
      {
           if ($d == date($format, strtotime($d))) return $d;
      }
      
      die("Invalid Parameter");
 }

◆ checkValidDateTime()

checkValidDateTime ( $d )

Security helper function.

Check that the given parameter is a valid date time.

Parameters

string $d the date time

Returns: string the value of the parameter if it is in a valid date time format

Definition at line 712 of file functions.inc.

 {
      if (!$d) return $d;
      $formats = array("Y-m-d H:i:s", "Y/m/d H:i:s", "m/d/Y H:i:s", "Y-m-d g:i:sa", "Y/m/d g:i:sa", "m/d/Y g:i:sa");
      foreach($formats as $format)
      {
           if ($d == date($format, strtotime($d))) return $d;
      }
      
      die("Invalid Parameter");
 }

◆ checkValidEmail()

checkValidEmail ( $e )

Security helper function.

Check that the given parameter is a valid email. Empty string is valid

Parameters

string $e the parameter to check

Returns: string the value of the parameter if it matches the required format

Definition at line 685 of file functions.inc.

 {
      return (filter_var($e, FILTER_VALIDATE_EMAIL)) ? $e : die("Invalid Parameter");
 }

◆ cleanHTMLTags()

cleanHTMLTags ( $str )

Definition at line 456 of file functions.inc.

 {
      return str_replace(array("<", ">"), array("&lt;", "&gt;"), $str);
 }

◆ cleanQuotes()

cleanQuotes ( $str )

Definition at line 470 of file functions.inc.

 {
      $chr_map = array(
                // Windows codepage 1252
                "\xC2\x82" => "'", // U+0082 U+201A single low-9 quotation mark
                "\xC2\x84" => '"', // U+0084 U+201E double low-9 quotation mark
                "\xC2\x8B" => "'", // U+008B U+2039 single left-pointing angle quotation mark
                "\xC2\x91" => "'", // U+0091 U+2018 left single quotation mark
                "\xC2\x92" => "'", // U+0092 U+2019 right single quotation mark
                "\xC2\x93" => '"', // U+0093 U+201C left double quotation mark
                "\xC2\x94" => '"', // U+0094 U+201D right double quotation mark
                "\xC2\x9B" => "'", // U+009B U+203A single right-pointing angle quotation mark
      
                // Regular Unicode     // U+0022 quotation mark (")
                // U+0027 apostrophe     (')
                "\xC2\xAB"     => '"', // U+00AB left-pointing double angle quotation mark
                "\xC2\xBB"     => '"', // U+00BB right-pointing double angle quotation mark
                "\xE2\x80\x98" => "'", // U+2018 left single quotation mark
                "\xE2\x80\x99" => "'", // U+2019 right single quotation mark
                "\xE2\x80\x9A" => "'", // U+201A single low-9 quotation mark
                "\xE2\x80\x9B" => "'", // U+201B single high-reversed-9 quotation mark
                "\xE2\x80\x9C" => '"', // U+201C left double quotation mark
                "\xE2\x80\x9D" => '"', // U+201D right double quotation mark
                "\xE2\x80\x9E" => '"', // U+201E double low-9 quotation mark
                "\xE2\x80\x9F" => '"', // U+201F double high-reversed-9 quotation mark
                "\xE2\x80\xB9" => "'", // U+2039 single left-pointing angle quotation mark
                "\xE2\x80\xBA" => "'", // U+203A single right-pointing angle quotation mark
      );
      $chr = array_keys  ($chr_map); // but: for efficiency you should
      $rpl = array_values($chr_map); // pre-calculate these two arrays
      $str = str_replace($chr, $rpl, html_entity_decode($str, ENT_QUOTES, "UTF-8"));  
      return $str;
 }

◆ codify()

codify ( $name )

Takes a text string and converts it into a code-compliant format, suitable for use as a variable name or identifier.

Principally this involved replacing all whitespace and sequences of non-word characters (such as punctuation) with underscores.

Parameters

$name the name to codify

Returns: the code-ish version of the name

Definition at line 1399 of file functions.inc.

 {
      $name = preg_replace("/[\\s\\W]+/", "_", $name);
      $name = str_replace("&", "and", $name);
      return $name;
 }

◆ color()

color ( $count )

Utility function to nicely format addresses, etc.

(skips blank entries, places all other entries on separate lines)

Parameters

integer $count the index of the current line

Deprecated

Definition at line 762 of file functions.inc.

 {
      
 $color = "#FFFFFF";
 if ($count%2==0) $color = "#EEEEEE";
 return $color;
 }

◆ countMatchingElements()

countMatchingElements	(	$a,
		$b
	)

Determines the number of items that two comma-separated lists have in common.

Useful for determining matches between checklist fields or roles.

Parameters

string	$a	the first string to test
string	$b	the second string to test

Returns: integer the number of elements they have in common

Definition at line 2011 of file functions.inc.

 {
      $arr1 = explode(",", $a);
      $arr2 = explode(",", $b);
      return count(array_intersect($arr1, $arr2));
 }

◆ ellipsis()

ellipsis	(	$txt,
		$max,
		$wholeWord = `false`
	)

Truncate the supplied text at the given maximum length.

If the string is truncated then an ellipsis is added.

Parameters

string	$txt	the text to truncate
integer	$max	the maximum allowed length
boolean	$wholeWord	true to truncate to whole words only

Returns: string the truncated string

Definition at line 779 of file functions.inc.

 {
      if (strlen($txt) > $max)
      {
           if (!$wholeWord)
           {
                $txt = substr($txt, 0, $max)."...";
           }
           else
           {
                $txt = substr($txt, 0, $max);
                $pos = strrpos($txt, " ");
                if ($pos)
                {
                     while($pos && $txt[$pos - 1] == '.')
                     {
                          $pos--;
                     }
                }
                $txt = substr($txt, 0, $pos)."...";
           }
      }
      
      return $txt;
 }

◆ encode7bit()

encode7bit ( $text )

Encode text to 7-bit clean format, suitable for mail headers.

Parameters

string $text the possibly unclean text

Returns: string the text with 8-bit characters encoded in hex format

Definition at line 1925 of file functions.inc.

 {
      return mb_encode_mimeheader($text, "iso-8859-1", "Q");
 }

◆ endsWith()

endsWith	(	$text,
		$end
	)

Tests whether a string ends with the given sub-string.

Parameters

$text	the string to test
$end	the sub-string to look for at the end

Returns: boolean true if the string ends with the sub-string, false otherwise

Definition at line 1481 of file functions.inc.

 {
      return (substr($text, -strlen($end)) == $end);
 }

◆ fgetcsv_noBOM()

fgetcsv_noBOM ( $fp )

Definition at line 2106 of file functions.inc.

 {
      $fields = fgetcsv($fp);
      if (is_array($fields))
      {
           $bom = pack('CCC', 0xEF, 0xBB, 0xBF);
           if (substr($fields[0], 0, 3) === $bom)
           {
                $fields[0] = substr($fields[0], 3);
           }
      }
      return $fields;
 }

◆ filterByRole()

filterByRole	(	$items,
		$field
	)

Filter the given list, retaining only the objects that match the current user's role profile in the given parameter.

Parameters

string	$items	the array of items to be filtered
string	$field	the name of the field defining the role restriction

Returns: array the filtered array

Definition at line 101 of file functions.inc.

 {
      $ret = array();
      foreach($items as $item)
      {
           if (checkRole($item->get($field)))
           {
                $ret[] = $item;
           }
      }
      
      return $ret;
 }

◆ firstSentence()

firstSentence ( $text )

Returns the first sentence of the supplied text.

HTML formatting is removed. The first sentence is defined as the text up to the first occurrence of the substring ". ". If this substring does not appear, the whole (HTML-stripped) text is returned.

Parameters

string $text the text of which the first sentence is to be returned

Definition at line 839 of file functions.inc.

 {
      $text = preg_replace("/<br>/i", " ", $text);
      $text = preg_replace("/<.*?>/", "", $text);
      $pos = strpos($text, ". ");
      return ($pos) ? substr($text, 0, $pos + 1) : $text;
 }

◆ fopen_utf8()

fopen_utf8 ( $filename )

Opens a text file, detects the encoding, inteprets the BOM if present, attaches a stream filter to convert to UTF-8.

Thanks to the author of this article: http://www.practicalweb.co.uk/blog/2008/05/18/reading-a-unicode-excel-file-in-php/

Parameters

string $filename the file to be opened for reading

Definition at line 2082 of file functions.inc.

                               {
      $encoding='';
      $handle = fopen($filename, 'r');
      $bom = fread($handle, 2);
      //   fclose($handle);
      rewind($handle);
      
      
      if($bom === chr(0xff).chr(0xfe)  || $bom === chr(0xfe).chr(0xff)){
           // UTF16 Byte Order Mark present
           $encoding = 'UTF-16';
      } else {
           $file_sample = fread($handle, 1000) . 'e'; //read first 1000 bytes
           // + e is a workaround for mb_string bug
           rewind($handle);
           
           $encoding = mb_detect_encoding($file_sample , 'UTF-8, UTF-7, ASCII, EUC-JP,SJIS, eucJP-win, SJIS-win, JIS, ISO-2022-JP');
      }
      if ($encoding && $encoding != 'UTF-8'){
           stream_filter_append($handle, 'convert.iconv.'.$encoding.'/UTF-8');
      }
      return  ($handle);
 }

◆ format_phone()

format_phone ( $phone )

Definition at line 398 of file functions.inc.

 {
      $phone = preg_replace("/[^0-9]/", "", $phone);
      
      if(strlen($phone) == 7)
           return preg_replace("/([0-9]{3})([0-9]{4})/", "$1-$2", $phone);
      elseif(strlen($phone) == 10)
           return preg_replace("/([0-9]{3})([0-9]{3})([0-9]{4})/", "($1) $2-$3", $phone);
      else
           return $phone;
 }

◆ formatAddress()

formatAddress ( )

Utility function to nicely format addresses, etc.

(skips blank entries, places all other entries on separate lines)

Deprecated

Definition at line 126 of file functions.inc.

 {
     $numargs = func_num_args();
     $arg_list = func_get_args();
     for ($i = 0; $i < $numargs; $i++) 
     {
           if ($arg_list[$i]) echo $arg_list[$i]."<br>\n";
     }
 } 

◆ formatAsHTML()

formatAsHTML ( $text )

Takes a string and formats it for display as HTML, removing any HTML tags it contains, and converting carriage returns to br tags.

Parameters

$text the text to format

Returns: string the formatted text

Definition at line 1456 of file functions.inc.

 {
      if (preg_match("/<.*?>/", $text)) return $text;
      $text = str_replace("\n", "<br/>", $text);
      
      return $text;
 }

◆ formatCheckListItemsforView()

formatCheckListItemsforView	(	$options,
		$items
	)

For dataitems that are rendered as CheckListFieldRenderer, this function converts the comma-delimited list of items for display.

To do: add handling of grouped checkboxes and provide parameter for delimiter between items

Deprecated

Definition at line 1555 of file functions.inc.

 {
      if(count($options) == 0) return;
  
      $values = explode(",", $items);
      
      foreach($values as $value)
      {
           if(array_key_exists($value, $options))
           {
                $list .= $options[$value] . ", ";
           }
           else
                $list .= $value . ", ";
      }
      
      if(strlen($list) > 0)
           $list = substr($list, 0, strlen($list) - 2);
      
      return $list;
 }

◆ formatCurrency()

formatCurrency ( $amount )

Utility function to format currency using $ and , and stuff.

Deprecated

Definition at line 142 of file functions.inc.

 {
      return "$".number_format($amount, 2, '.', ',');
 }

◆ formatDate()

formatDate ( $date )

Utility function to format date (no time component).

Parameters

string $date the date to format

Deprecated

Definition at line 154 of file functions.inc.

 {
      
      if ($date !='Jan 1 1900 12:00AM')
      {
           return date("F d, Y", strtotime($date));
      }    
 }

◆ formatDateLong()

formatDateLong ( $date )

Parameters

$date Deprecated

Definition at line 203 of file functions.inc.

 {
      $text = "";
      
      if ($date)
      {
           $text = date("l F j, Y", strtotime($date));
      }
      
      return $text;
 }

◆ formatDateShort()

formatDateShort ( $date )

Utility function to format date in short form (MM/DD/YYYY), with no time component.

Deprecated

Definition at line 183 of file functions.inc.

 {
      $text = "";
      
      if ($date)
      {
           $text = date("m/d/Y", strtotime($date));
      }
      
      if ($text == "01/01/1900") $text = "";
       
      return $text;
 }

◆ formatDateTime12()

formatDateTime12 ( $time )

Format a date and time in 12 hour clock, no seconds.

Deprecated

Definition at line 321 of file functions.inc.

 {
      return date("m/d/Y g:ia", $time);
 }

◆ formatDateTime12Hr()

formatDateTime12Hr ( $datetime )

Definition at line 334 of file functions.inc.

 {
      $yyyy = substr($datetime,0,4);
      $mm   = substr($datetime,5,2);
      $dd   = substr($datetime,8,2);
      $hh   = substr($datetime,11,2);
      $mi   = substr($datetime,14,2);
      $ss = "00";
      
     if ($yyyy == '0000') return "N/A";
     if($hh == '00')
           return date("m/d/Y", mktime($hh,$mi,$ss,$mm,$dd,$yyyy));
     else
           return date("m/d/Y g:ia", mktime($hh,$mi,$ss,$mm,$dd,$yyyy));
 }

◆ formatMonthYear()

formatMonthYear ( $date )

Parameters

$date Deprecated

Definition at line 169 of file functions.inc.

 {
      
      if ($date !='Jan 1 1900 12:00AM')
      {
           return date("F Y", strtotime($date));
      }    
 }

◆ formatStartDateToEndDate()

formatStartDateToEndDate	(	$start,
		$end
	)

Definition at line 361 of file functions.inc.

 {
      $yyyy = substr($start,0,4);
      $yyyy_2 = substr($end,0,4);
      $mm   = substr($start,5,2);
      $mm_2   = substr($end,5,2);
      $dd   = substr($start,8,2);
      $dd_2   = substr($end,8,2);
                
      if($yyyy != $yyyy_2 || $mm != $mm_2 || $dd != $dd_2)
      {
           return formatDateTime12Hr($start) ." &ndash; ". formatDateTime12Hr($end);
      }
      else
      {
           $hh   = substr($start,11,2);
           $mi   = substr($start,14,2);
           $hh_2   = substr($end,11,2);
           $mi_2   = substr($end,14,2);
           $s_time = date("g:ia", mktime($hh,$mi));
           $e_time = date("g:ia", mktime($hh_2,$mi_2));
           return formatDateShort($start) . " $s_time &ndash; $e_time";
      }    
 }

◆ formatTime12()

formatTime12 ( $time )

Format a time in 12 hour clock, no seconds.

Deprecated

Definition at line 311 of file functions.inc.

 {
      return date("g:ia", $time);
 }

◆ formatTimestamp()

formatTimestamp ( $ts )

Utility function to format readable date from a timestamp (no time component).

Timestamp is a string in the format 'YYYYMMDDHHIISS'.

Parameters

string $ts the timestamp to format.

Deprecated

Definition at line 223 of file functions.inc.

 {
           if (!$ts) return "N/A";
  
           
      $yyyy = substr($ts,0,4);
      $mm   = substr($ts,4,2);
      $dd   = substr($ts,6,2);
      $hh   = substr($ts,8,2);
      $mi   = substr($ts,10,2);
      $ss   = substr($ts,12,2);
  
     if ($yyyy == '0000') return "N/A";
               
      return date("F d, Y", mktime($hh,$mi,$ss,$mm,$dd,$yyyy));
 }

◆ formatTimestampShort()

formatTimestampShort ( $ts )

Definition at line 247 of file functions.inc.

 {
           if (!$ts) return "N/A";
  
      $yyyy = substr($ts,0,4);
      $mm   = substr($ts,4,2);
      $dd   = substr($ts,6,2);
      $hh   = substr($ts,8,2);
      $mi   = substr($ts,10,2);
      $ss   = substr($ts,12,2);
  
     if ($yyyy == '0000') return "N/A";
               
      return date("m/d/Y g:ia", mktime($hh,$mi,$ss,$mm,$dd,$yyyy));
      
 }

◆ getBacktrace()

getBacktrace ( $ignore = 2 )

Returns a formatted backtrace suitable for debugging output.

Definition at line 1962 of file functions.inc.

 {
      $trace = '';
      foreach (debug_backtrace() as $k => $v) {
           if ($k < $ignore) {
                continue;
           }
  
           array_walk($v['args'], function (&$item, $key) {
                $item = var_export($item, true);
           });
  
                $trace .= '#' . ($k - $ignore) . ' ' . $v['file'] . '(' . $v['line'] . '): ' . (isset($v['class']) ? $v['class'] . '->' : '') . $v['function'] . '(' . implode(', ', $v['args']) . ')' . "\n";
      }
  
      return $trace;
 }

◆ getCleanQueryString()

getCleanQueryString ( )

Returns the query string for the current page, cleaned of any Fakoli-related navigation parameters.

Definition at line 986 of file functions.inc.

 {
      $qs = $_SERVER['QUERY_STRING'];
  
      $params = array();
      
      foreach($_GET as $key => $value)
      {
           if ($key != "identifier" && $key != "section") $params[$key] = $value;
      }
      
      return http_build_query($params);
 }

◆ getDocIcon()

getDocIcon ( $doc )

Parameters

unknown_type $doc Deprecated

Definition at line 615 of file functions.inc.

 {
      global $doc_icons;
      $n = strtolower($doc);
      $extension = substr($n, strrpos($n, "."));
      $icon = $doc_icons[$extension];
      if (!$icon) $icon = "/fakoli/images/file_icon.png";
      return $icon;
 }

◆ getDocMimeType()

getDocMimeType ( $name )

Parameters

$name Deprecated

Definition at line 586 of file functions.inc.

 {
      global $doc_mime_types;
      
      $n = strtolower($name);
      $extension = substr($n, strrpos($n, "."));
      $type = $doc_mime_types[$extension];
      if (!$type) $type="application/octet-stream";
      return $type;
      
 }

◆ getDocSize()

getDocSize ( $doc )

Returns the file size in Kb for a document.

Parameters

string $doc the (local) URL of the document

Deprecated

Definition at line 554 of file functions.inc.

 {
     global $config;
     
     // Find the file name for the file on disk
     
     $doc_file = $doc;
     
     $doc_file = str_replace($config["uploadurl"], $config["uploaddir"], $doc_file);
     
     // If the file exists, return its size
     
     if (file_exists($doc_file))
     {
         $doc_size = (int)(filesize($doc_file)/1024);
     }
     else
     {
         $doc_size = 0;
     }
     
     return $doc_size;
 }

◆ getDocType()

getDocType ( $doc )

Returns a human-readable type name for a document, based on the file extension of the supplied file name.

Parameters

string $doc the filename of the document

Deprecated

Definition at line 531 of file functions.inc.

 {
     global $doc_extensions;
     
     $d = strtolower($doc);
     
     $ext = substr($d, strrpos($d, "."));
     
     $doc_type = $doc_extensions[$ext];
     
     if (!$doc_type) $doc_type = "Unknown";
     
     return $doc_type;
     
 }

◆ getFullQueryString()

getFullQueryString ( $includePOST = true )

Generates a query string containing the values passed to this page.

The default behavior is to include parameters passed both as GET and POST parameters. To retrieve only the GET parameters, pass false.

Parameters

boolean $includePOST true (default) to include POST parameters, false for only GET parameters

Returns: string the full query string for the current page.

Definition at line 1634 of file functions.inc.

 {
      global $__urlRewriteParams;
      
      $qs = "";
      $sep = "?";
      
      foreach($_GET as $name => $value)
      {
           if (array_key_exists($name, $__urlRewriteParams)) continue;
            
           if (is_array($value))
           {
                foreach($value as $key => $val)
                {
                     $qs .= $sep.urlencode($name)."[".urlencode($key)."]=".urlencode($val);
                     $sep = "&";
                }
           }
           else
           {
                $qs .= $sep.urlencode($name)."=".urlencode($value); 
                $sep = "&";
           }
      }
      
      if ($includePOST)
      {
           foreach($_POST as $name => $value)
           {
                if (is_array($value))
                {
                     foreach($value as $key => $val)
                     {
                          $qs .= $sep.urlencode($name)."[".urlencode($key)."]=".urlencode($val);
                          $sep = "&";
                     }
                }
                else
                {
                     $qs .= $sep.urlencode($name)."=".urlencode($value); 
                     $sep = "&";
                }
           }
      }
      
      trace("Full Query String: $qs", 3);
      return $qs;
 }

◆ getIcon()

getIcon ( $file )

Retrieves a graphic icon appropriate for the given file.

Parameters

$file the name of the file

Returns: string URL of the graphic icon for the file

Definition at line 1149 of file functions.inc.

 {
      global $_icons;
      global $auto_form_defaults;
      
      $ext = substr($file, strrpos($file, "."));
      $icon = $_icons[$ext];
      trace("getIcon($file) $ext $icon", 3);
      
      if (!isset($icon))
      {
           $icon = $_icons["default"];
      }
      
      return $auto_form_defaults["componentPath"].$icon;               
 }

◆ getMIMEType()

getMIMEType ( $filename )

Parameters

String $filename Deprecated

Definition at line 1802 of file functions.inc.

 {
      $mime_types = array(
  
           'txt' => 'text/plain',
         'htm' => 'text/html',
         'html' => 'text/html',
         'css' => 'text/css',
         'js' => 'application/javascript',
         'json' => 'application/json',
         'xml' => 'application/xml',
         'swf' => 'application/x-shockwave-flash',
         'flv' => 'video/x-flv',
  
         // images
         'png' => 'image/png',
         'jpe' => 'image/jpeg',
         'jpeg' => 'image/jpeg',
         'jpg' => 'image/jpeg',
         'gif' => 'image/gif',
         'bmp' => 'image/bmp',
         'ico' => 'image/vnd.microsoft.icon',
         'tiff' => 'image/tiff',
         'tif' => 'image/tiff',
         'svg' => 'image/svg+xml',
         'svgz' => 'image/svg+xml',
  
         // archives
         'zip' => 'application/zip',
         'rar' => 'application/x-rar-compressed',
         'exe' => 'application/x-msdownload',
         'msi' => 'application/x-msdownload',
         'cab' => 'application/vnd.ms-cab-compressed',
  
         // audio/video
         'mp3' => 'audio/mpeg',
           'm4a' => 'video/mp4',
         'qt' => 'video/quicktime',
         'mov' => 'video/quicktime',
  
         // adobe
         'pdf' => 'application/pdf',
         'psd' => 'image/vnd.adobe.photoshop',
         'ai' => 'application/postscript',
         'eps' => 'application/postscript',
         'ps' => 'application/postscript',
  
         // ms office
         'doc' => 'application/msword',
         'rtf' => 'application/rtf',
         'xls' => 'application/vnd.ms-excel',
         'ppt' => 'application/vnd.ms-powerpoint',
  
         // open office
         'odt' => 'application/vnd.oasis.opendocument.text',
         'ods' => 'application/vnd.oasis.opendocument.spreadsheet',
     );
  
     $ext = strtolower(array_pop(explode('.',$filename)));
  
     if (array_key_exists($ext, $mime_types)) 
     {
         return $mime_types[$ext];
     }
     elseif (function_exists('finfo_open')) 
     {
         $finfo = finfo_open(FILEINFO_MIME);
         $mimetype = finfo_file($finfo, $filename);
         finfo_close($finfo);
         return $mimetype;
     }
     else 
     {
      // Prevent other file types (such as source code or configuration files) from being served
         die("");
     }
 }

◆ getMonthDays()

getMonthDays	(	$m,
		$y
	)

Returns the number of days in the specified month.

Parameters

number	$m	the month number
number	$y	the year

Returns: number the number of days in that month

Deprecated

Definition at line 272 of file functions.inc.

 {
      $monthDays = array(31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31);
      $d = $monthDays[$m - 1];
      if ($m == 2 && ($y % 4) == 0 && ($y % 100) != 0) $d++;
      
      return $d;
 }

◆ getMonthWeekDays()

getMonthWeekDays	(	$month,
		$year
	)

Get the number of week days in the specified month.

Parameters

number	$m	the month number
number	$y	the year

Returns: number the number of week days in that month

Deprecated

Definition at line 289 of file functions.inc.

 {
      $weekDaysInMonth = array
      (
           28   =>   array(20, 20, 20, 20, 20, 20, 20),
           29   =>   array(21, 21, 21, 21, 21, 20, 20),
           30   =>   array(22, 22, 22, 22, 21, 20, 21),
           31   =>   array(23, 23, 23, 22, 21, 21, 22)
      );
      
      $days = getMonthDays($month, $year);
      $date = strtotime("$year-$month-01");
      
      $first = date("N", $date) - 1;
      return $weekDaysInMonth[$days][$first];
 }

◆ getRemote()

getRemote	(	$url,
		$username = `""`,
		$password = `""`
	)

Retrieve the contents of the remote file at the given URL.

Parameters

string	$url	the URL to retrieve
string	$username	(optional) username for basic authentication
string	$password	(optional) password for basic authentication

Returns: string the contents of the file at that URL

Definition at line 1192 of file functions.inc.

 {
      $url = canonicalizeURL($url);
      trace("Retrieving $url", 3);
      $ch = curl_init("$url");
      curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
      curl_setopt($ch, CURLOPT_HEADER, 0);
      curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
      
      if ($username)
      {
           curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
           curl_setopt($ch, CURLOPT_USERPWD, "$username:$password");
      }
      
      $html = curl_exec($ch);
      
      if ($html === FALSE) throw new Exception(curl_error($ch));
      
      curl_close($ch);
      
      return $html;
 }

◆ getRemoteHeaders()

getRemoteHeaders ( $url )

Retrieve the HTTP headers for the specified remote URL (excluding the body).

Parameters

string $url the URL to retrieve

Returns: the headers.

Definition at line 1359 of file functions.inc.

 {
      $ch = curl_init();
      curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
      curl_setopt($ch, CURLOPT_HEADER, 1);
      curl_setopt($ch, CURLOPT_NOBODY, 1);
      curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
      
      $html = curl_exec($ch);
      
      curl_close($ch);
      
      return $html;
 }

◆ getScaledSize()

getScaledSize	(	$size,
		$decimal_places = `1`
	)

Get human-readable file size from raw number of bytes.

Parameters

$size	the size of the file in bytes
$decimal_places	the number of decimal places in the output (default is 1)

Returns: string human-readable file size in appropriate units

Definition at line 1088 of file functions.inc.

 {
      if (!$size) return "";
      
      $result = "";
      if ($size > 1073741824)
      {
           $result = sprintf("%.{$decimal_places}fGB", ($size / 1073741824));
      }
      else if ($size > 1048576)
      {
           $result = sprintf("%.{$decimal_places}fMB", ($size / 1048576));
      }
      else if ($size > 1024)
      {
           $result = intval($size / 1024)."KB";
      }
      else
      {
           $result = "$size bytes";
      }
      
      return $result;
 }

◆ GUID()

GUID ( )

Generates a version 4 GUID.

Where random_int is available (PHP > 7.0) it is used to ensure cryptographically secure random numbers.

Returns: string

Definition at line 1935 of file functions.inc.

 {
      if (function_exists('random_int') === true)
      {
           return '{'.sprintf('%04X%04X-%04X-%04X-%04X-%04X%04X%04X', random_int(0, 65535), random_int(0, 65535), random_int(0, 65535), random_int(16384, 20479), random_int(32768, 49151), random_int(0, 65535), random_int(0, 65535), random_int(0, 65535)).'}';
      }
      
      if (function_exists('com_create_guid') === true)
      {
           return trim(com_create_guid(), '{}');
      }
  
      return '{'.sprintf('%04X%04X-%04X-%04X-%04X-%04X%04X%04X', mt_rand(0, 65535), mt_rand(0, 65535), mt_rand(0, 65535), mt_rand(16384, 20479), mt_rand(32768, 49151), mt_rand(0, 65535), mt_rand(0, 65535), mt_rand(0, 65535)).'}';
 }

◆ hasRole()

hasRole	(	$role,
		$account = `null`
	)

Determine whether a user has a specific role explicitly set.

Unlike checkRole() this does not always return true if a user is super or admin.

Parameters

string	$role
object	$account

Returns: boolean true if the user has the specified role explicitly set, false otherwise.

Definition at line 82 of file functions.inc.

 {
      global $user;
      
      if (!$account) $account = $user;
      if (!$role) return false;
  
      $expr = "/\\b{$role}\\b/";
      return (preg_match($expr, $account->role) > 0) ? true : false;
 }

◆ htmlsafe()

htmlsafe ( $str )

Definition at line 451 of file functions.inc.

 {
      return htmlspecialchars($str, ENT_QUOTES, 'UTF-8');
 }

◆ HTMLToText()

HTMLToText ( $html )

Definition at line 461 of file functions.inc.

 {
      $patterns = array("/<br>/", "/&nbsp;/", "/<p>/", "/<BR>/", "/<P>/");
      $replacements = array("\r\n", " ", "\r\n", "\r\n", "\r\n");
      $text =  stripHTML(preg_replace($patterns, $replacements, $html));
      
      return $text;
 }

◆ includeRemote()

includeRemote	(	$host,
		$file
	)

Includes the contents of the given remote file, with any relative src or href references converted to absolute references.

The included file is echoed directly to the output stream.

Parameters

$host	the host to retrieve the file from
$file	the URI of the file on the host

Definition at line 1173 of file functions.inc.

 {
      $ch = curl_init("http://$host/$file");
      curl_setopt($ch, CURLOPT_HEADER, 0);
      curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
      $html = curl_exec($ch);
      curl_close($ch);
      
      $html = preg_replace("/(src|href)(=['\"])\//", "$1$2http://$host/", $html);
      echo $html;
 }

◆ jsonRequest()

jsonRequest	(	$url,
		$params = `array()`
	)

Make a simple GET request to a JSON-return RESTful API, passing the supplied parameters.

Parameters

string	$url	the target URL for the API
array	$params	an array of parameters to pass, as key-value pairs

Definition at line 1221 of file functions.inc.

 {
      $qs = array();
      foreach($params as $key => $value)
      {
           $qs[] = "$key=".urlencode($value);
      }
      
      $qs = implode("&", $qs);
      
      $api = "{$url}?{$qs}";
      trace($api);
      $response = getRemote($api);
      return json_decode($response);
 }

◆ jsSafe()

jsSafe	(	$str,
		$escapeEntities = `false`
	)

Utility function to escape a string correctly for use in a Javascript client-side call.

Parameters

string $str the string to make safe.

Definition at line 434 of file functions.inc.

 {
      $str = str_replace("\\", "\\\\", $str);
      $str = preg_replace("/'/","\'",$str);
      $str = preg_replace('/"/','\"',$str);
      $str = str_replace("\r", "", $str);
      $str = str_replace("\n", "\\n", $str);
      $str = str_replace("&#39;", "\'", $str);
      $str = str_ireplace("</script>", "\\x3C/script\\x3E", $str);
      
      if ($escapeEntities)
      {
           $str = str_replace("&", "&amp;", $str);
      }
      return $str;
 }

◆ luhnTest()

luhnTest ( $num )

Performs a Luhn validity test for credit card or IMEI numbers.

Parameters

string $num credit card or IMEI number

Returns: boolean true if valid, false otherwise

Definition at line 1985 of file functions.inc.

 {
      $len = strlen($num);
      for ($i = $len-1; $i >= 0; $i--) 
      {
           $ord = ord($num[$i]);
           if (($len - 1) & $i) 
           {
                $sum += $ord;
           } 
           else 
           {
                $sum += $ord / 5 + (2 * $ord) % 10;
           }
      }
      return $sum % 10 == 0;
 }

◆ makeRandomString()

makeRandomString ( $len )

Creates a randomized string of characters.

This is not cryptographically secure and should not be used for cryptographic operations.

Parameters

int $len the length of the string to generate

Returns: string the generated string

Definition at line 1735 of file functions.inc.

 {
      $str = "";
      for($i = 0; $i < $len; ++$i)
      {
           $str .= chr(ord('a') + rand(0, 25));
      }
      
      return $str;
 }

◆ makeURL()

makeURL ( $uri )

Ensures that the http:// protocol specifier prefix is present in the supplied string.

Parameters

string $uri the string to process

Returns: string the full URL with protocol prefix added if it was missing.

Definition at line 1539 of file functions.inc.

 {
       if (!startsWith($uri, "http://")) $uri = "http://$uri";
       return $uri;
 }

◆ now()

now ( )

Returns the current time and date in a database compatible format.

Returns: string

Definition at line 416 of file functions.inc.

 {
      return date('Y/m/d H:i:s');
 }

◆ option()

option	(	$value,
		$text,
		$sel = `""`
	)

Write out an option tag, marking as selected if applicable.

Parameters

mixed	$value	the value of the option
string	$text	the text for the option
mixed	$sel	a value to compare to the $value field, to determine whether the option should be selected.

Definition at line 888 of file functions.inc.

 {
      echo "<option value='$value'";
      if ($sel === $value)
      {         
           echo " selected";
      }
      echo ">$text</option>";  
 }

◆ ordinalSuffix()

ordinalSuffix	(	$n,
		$sup = `false`
	)

Adds the english ordinal suffix to a number.

If the value passed is not purely numeric, it will be returned unchanged.

Parameters

$n	the value for the ordinal suffix
$sup	true to add HTML superscript tag, false for plain text

Returns: string the value with the appropriate ordinal suffix appended.

Definition at line 1503 of file functions.inc.

 {
      $suffix = "";
      if (is_numeric($n))
      {
           $n = trim($n);
           
           $lastTwo = substr($n, -2, 2);
           $lastOne = substr($n, -1, 1);
           
           if ($lastTwo == "11" || $lastTwo == "12" || $lastTwo == "13") $suffix = "th";
           else 
           {
                switch($lastOne)
                {
                     case "1": $suffix = "st"; break;
                     case "2": $suffix = "nd"; break;
                     case "3": $suffix = "rd"; break;
                     default: $suffix = "th";
                }
           }
      }
      else return $n;
  
      // JDG 2/10/12 - fix was not returning value if $sup false
      if ($sup) 
           return "$n<sup>$suffix</sup>"; 
      else
           return "$n$suffix";
 }

◆ parseMultiParam()

parseMultiParam	(	$collection,
		$param
	)

Parse out multiple values from the provided collection that have the same root name, and return the results in an array.

Parameters

array	$collection	the parameter collection (usually $_POST or $_GET)
string	$param	the root name for the params to search for

Definition at line 865 of file functions.inc.

 {
      $len = strlen($param);
      $values = array();
      
      foreach($collection as $field => $value)
      {
           if (!strncmp($field, $param, $len))
           {
                $values[] = $value;
           }
      }
      
      return $values;
 }

◆ plainGUID()

plainGUID ( )

Generates a version 4 GUID with no punctutation.

Returns: string

Definition at line 1954 of file functions.inc.

 {
      return str_replace(array("{", "}", "-"), array("", "", ""), GUID());
 }

◆ pluralize()

pluralize	(	$text,
		$count = `0`
	)

Takes a singular string and makes it plural.

Parameters

$text	the string to make plural
$count	integer (optional) the number of items, to determine whether to pluralize or not

Returns: string the plural version

Definition at line 1428 of file functions.inc.

 {
      if ($count == 1) return $text;
      
      $c = $text;
  
      if (preg_match("/[^aeiouAEIOU]y$/", $c))
      {
           $c = substr($c, 0, -1)."ies";
      }
      else if (preg_match("/(?:ss|[^aeiou]o|x|s|ch)$/", $c))
      {
           $c .= "es";
      }
      else
      {
           $c .= "s";
      }
  
      return $c;
 }

◆ postRemote()

postRemote	(	$url,
		$data = `null`,
		$timeout = `30`
	)

Make a POST request to a remote URL, returning the results.

Parameters

$url	the URL of the page to submit the POST request to
$data	the POST parameters, passed as an array of key => value pairs
$timeout	the amount of time to wait for the POST to complete

Returns: string the results of the POST request

Definition at line 1325 of file functions.inc.

 {
      $ch = curl_init();
      curl_setopt($ch, CURLOPT_URL, $url);
      curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
      curl_setopt($ch, CURLOPT_HEADER, 0);
      curl_setopt($ch, CURLOPT_POST, 1);
      curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
      curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $timeout);
      $result = trim(curl_exec($ch));
      curl_close($ch);
      return $result;
 }

◆ postRemoteXML()

postRemoteXML	(	$url,
		$xml,
		$timeout = `30`
	)

Definition at line 1339 of file functions.inc.

 {
      $ch = curl_init($url);
      curl_setopt($ch, CURLOPT_MUTE, 1);
      curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0);
      curl_setopt($ch, CURLOPT_POST, 1);
      curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: text/xml'));
      curl_setopt($ch, CURLOPT_POSTFIELDS, $xml);
      curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
      curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $timeout);
      $result = trim(curl_exec($ch));
      curl_close($ch);
      return $result;
 }

◆ prettify()

prettify ( $name )

Takes a variable or field name and converts it into a human-readable version (assuming that the original contains human-readable words, of course).

It handles CamelCase and underscores. Individual words in the output are capitalized.

Parameters

$name the string to prettify

Returns: string the prettified version of the string

Definition at line 1413 of file functions.inc.

 {
      $name = preg_replace("/([a-z])([A-Z0-9])/", "$1 $2", $name);
      $name = str_replace("_", " ", $name);
      $name = ucwords($name);
      
      return $name;
 }

◆ prettyPrintJSON()

prettyPrintJSON ( $json )

Format the JSON in the supplied string to be more human-readable.

Parameters

string $json the JSON to pretty-print

Definition at line 1723 of file functions.inc.

 {
      return json_encode(json_decode($json), JSON_PRETTY_PRINT);
 }

◆ printIncludes()

printIncludes	(	$html = `true`,
		$return = `false`
	)

Outputs a list of all included files.

This is provided as a tool for troubleshooting.

Parameters

boolean	$html	whether to include HTML formatting in the output (default true)
boolean	$return	set to true to return the list as the return value, false to print to the output buffer

Definition at line 2023 of file functions.inc.

 {
      if ($return)
      {
           ob_start();
      }
      
      $includes = get_included_files();
      if ($html) echo "<ul>\n";
      foreach($includes as $include)
      {
           if ($html)
           {
                echo "<li>$include</li>";
           }
           else
           {
                echo $include."\n";
           }
      }
      if ($html) echo "</ul>";
      
      if ($return)
      {
           $out = ob_get_contents();
           ob_end_clean();
           return $out;
      }
 }

◆ printMIMETypeList()

printMIMETypeList ( $types )

Outputs the MIME type list based on an array of MIME types.

Use this function to generate the contents of ACCEPT= attributes for <INPUT TYPE="file" ...> tags.

Deprecated

Definition at line 511 of file functions.inc.

 {
   print "*";
   //foreach ($types as $t)
   //{
   //  if ($out) $out .= ",";
   //  $out .= $t;
   //}
  
   //print $out;
 }

◆ redirect()

redirect ( $page )

Simplified redirect.

Parameters

string $page the page to redirect to

Definition at line 930 of file functions.inc.

 {
      global $_redirectLogCallback;
      global $config;
   
      if ($config['prettyURLs'] === false)
      {
           $page = preg_replace("/^\\/?([\\w\\d_]+?)\\?/", "/page.php?identifier=$1&", $page);
           $page = preg_replace("/^\\/?([\\w\\d_]+)$/", "/page.php?identifier=$1", $page);
      }
      
      trace("redirect:: page is $page", 3);
      $server = $config['http_host'];
      if (!$server) $server="localhost:8080";
  
      //AJG: 3/9/11 - maintain current protocol by default
      
      $https = $_SERVER['HTTPS'];
      if ($https == "off") $https = false;
      if (isset($_SERVER['HTTP_X_FORWARDED_PROTO']) && $_SERVER['HTTP_X_FORWARDED_PROTO'] === 'https')
      {
           $https = true;
      }
      
      $protocol = $https ? "https" : "http";
      
      // JDG 9/27/10 - handle https
      if (!strncmp($page, "http://", 7) OR (!strncmp($page, "https://", 8)))
      {
           $location = $page;
      }
      else if ($page[0] == '/')
      {
           $location = "$protocol://$server$page";
      }
 //   else if (preg_match( "/^[\\w\\d_\\-]+$/", $page))
 //   {
 //        $location = "http://$server/$page";
 //   }
      else
      {
           $directory = str_replace(DIRECTORY_SEPARATOR, '/', dirname($_SERVER['REQUEST_URI']));
           if ($directory == "/") $directory = "";
           $location = "$protocol://".$server.$directory."/".$page;
      }
           
      header("Location: $location");
      if ($_redirectLogCallback) $_redirectLogCallback();
      session_write_close();
      exit;
 }

◆ registerRedirectLogCallback()

registerRedirectLogCallback ( $callback )

Definition at line 920 of file functions.inc.

 {
      global $_redirectLogCallback;
      $_redirectLogCallback = $callback;
 }

◆ registerURLRewriteParameters()

registerURLRewriteParameters ( )

Register any URL rewrite parameters that should be excluded from query string reformatting.

Definition at line 1616 of file functions.inc.

 {
      global $__urlRewriteParams;
      
      for($i = 0; $i < func_num_args(); ++$i)
      {
           $__urlRewriteParams[func_get_arg($i)] = true;
      }         
 }

◆ replaceValues()

replaceValues	(	$substitutions,
		$target
	)

Given an array of pairs of old and new values, replace all instances of old values with new values in the target string.

Parameters

array	$substitutions	array of old and new values
string	$target	the target string to update

Returns: string the updated string

Definition at line 2060 of file functions.inc.

 {
      foreach($substitutions as $old => $new)
      {
           $expr = "/\\b{$old}\\b/";
           trace("{$expr} => $new", 3);
           $target = preg_replace($expr, $new, $target);
           trace($target, 3);
      }
      
      return $target;
 }

◆ roundFormat()

roundFormat	(	$num,
		$abbrev = `false`
	)

Definition at line 1113 of file functions.inc.

 {
      if (!$num) return "";
      
      $result = "";
      if ($abbrev == false) {
           if ($num >= 1000000000) {
                $result = sprintf("%.1f billion", ($num / 1000000000));
           } elseif ($num >= 1000000) {
                $result = sprintf("%.1f million", ($num / 1000000));;
           } elseif ($num >= 1000) {
                $result = sprintf("%.0f,000", ($num / 1000));;
           }
      } else {
           if ($num >= 1000000000) {
                $result = sprintf("%.1f bn", ($num / 1000000000));
           } elseif ($num >= 1000000) {
                $result = sprintf("%.1f m", ($num / 1000000));;
           } elseif ($num >= 1000) {
                $result = sprintf("%.0f,000", ($num / 1000));
           }
      }
      return $result;
 }

◆ rteSafe()

rteSafe ( $strText )

Parameters

unknown_type $strText Deprecated

Definition at line 811 of file functions.inc.

                            {
     //returns safe code for preloading in the RTE
     $tmpString = $strText;
     
     //convert all types of single quotes
     $tmpString = str_replace(chr(145), chr(39), $tmpString);
     $tmpString = str_replace(chr(146), chr(39), $tmpString);
     $tmpString = str_replace("'", "&#39;", $tmpString);
     
     //convert all types of double quotes
     $tmpString = str_replace(chr(147), chr(34), $tmpString);
     $tmpString = str_replace(chr(148), chr(34), $tmpString);
 //  $tmpString = str_replace("\"", "\"", $tmpString);
     
     //replace carriage returns & line feeds
     $tmpString = str_replace(chr(10), " ", $tmpString);
     $tmpString = str_replace(chr(13), " ", $tmpString);
     
     return $tmpString;
 }

◆ sanitizePath()

sanitizePath ( $path )

Sanitize a file path, removing relative path sections and ensuring the correct directory separator is used throughout.

Parameters

string $path potentially dirty path

Returns: string clean path

Definition at line 1309 of file functions.inc.

 {
      $path = str_replace("/", DIRECTORY_SEPARATOR, $path);
      $path = str_replace("\\", DIRECTORY_SEPARATOR, $path);
      $path = str_replace("..".DIRECTORY_SEPARATOR, DIRECTORY_SEPARATOR, $path);
      $path = str_replace(DIRECTORY_SEPARATOR.DIRECTORY_SEPARATOR, DIRECTORY_SEPARATOR, $path);
      return $path;
 }

◆ saveRemote()

saveRemote	(	$url,
		$saveAs
	)

Retreive the contents of the remote file at the given URL and save it to the specified location on the local disk.

Parameters

$url	the URL to retrieve
$saveAs	the path and file name where the downloaded file should be stored.

Returns: returns the content type of the retrieved file as specified by the server

Definition at line 1246 of file functions.inc.

 {
      trace("Downloading $url to $saveAs", 3);
      
      $ch = curl_init ($url);
      curl_setopt($ch, CURLOPT_HEADER, 0);
      curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
      curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
      curl_setopt($ch, CURLOPT_BINARYTRANSFER,1);
      curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
      
      $contentType = curl_getinfo($ch, CURLINFO_CONTENT_TYPE);
      $bytes = curl_exec($ch);
      curl_close ($ch);
      
      trace(count($bytes)." bytes recieved", 3);
      
      if(file_exists($saveAs))
      {
           unlink($saveAs);
      }
      
      file_put_contents($saveAs, $bytes);
      
      return $contentType;
 }

◆ startsWith()

startsWith	(	$text,
		$start
	)

Tests whether a string starts with a given sub-string.

Parameters

$text	the string to test
$start	the sub-string to look for at the start

Returns: boolean true if the string starts with the sub-string, false otherwise

Definition at line 1470 of file functions.inc.

 {
      return (strncmp($text, $start, strlen($start)) == 0);
 }

◆ str_option()

str_option	(	$value,
		$text,
		$sel = `""`
	)

Write out an option tag to a string, marking as selected if applicable.

Parameters

mixed	$value	the value of the option
string	$text	the text for the option
mixed	$sel	a value to compare to the $value field, to determine whether the option should be selected.

Definition at line 906 of file functions.inc.

 {
      $opt = "<option value='$value'";
      if ($sel == $value)
      {
           $opt .= " selected";
      }
      $opt .= ">$text</option>";
  
      return $opt;
 }

◆ stripHTML()

stripHTML ( $text )

Definition at line 847 of file functions.inc.

 {
      /*$text = preg_replace("/<.*?>/", "", $text);*/
      $text = strip_tags($text);
      
      // JDG 5/19/2011 - remove &ndash, &nbsp;
      $text = html_entity_decode($text);
      $text = trim($text);
      return $text;
 }

◆ stripHTMLTags()

stripHTMLTags ( $text )

Removes all HTML tags from the specified string.

Parameters

$text the string from which tags are to be removed

Returns: string the cleaned text.

Definition at line 1491 of file functions.inc.

 {
      return preg_replace("/<.*?>/", "", $text);
 }

◆ tempdir()

tempdir	(	$dir = `null`,
		$prefix = `'tmp_'`,
		$mode = `0700`,
		$maxAttempts = `1000`
	)

Creates a random unique temporary directory, with specified parameters, that does not already exist (like tempnam(), but for dirs).

Created dir will begin with the specified prefix, followed by random numbers.

string|null $dir Base directory under which to create temp dir. If null, the default system temp dir (sys_get_temp_dir()) will be used. string $prefix String with which to prefix created dirs. int $mode Octal file permission mask for the newly-created dir. Should begin with a 0. int $maxAttempts Maximum attempts before giving up (to prevent endless loops). string|bool Full path to newly-created dir, or false on failure.

Definition at line 2139 of file functions.inc.

 {
      /* Use the system temp dir by default. */
      if (is_null($dir))
      {
           $dir = sys_get_temp_dir();
      }
      
      /* Trim trailing slashes from $dir. */
      $dir = rtrim($dir, DIRECTORY_SEPARATOR);
      
      /* If we don't have permission to create a directory, fail, otherwise we will
       * be stuck in an endless loop.
       */
      if (!is_dir($dir) || !is_writable($dir))
      {
           return false;
      }
      
      /* Make sure characters in prefix are safe. */
      if (strpbrk($prefix, '\\/:*?"<>|') !== false)
      {
           return false;
      }
      
      /* Attempt to create a random directory until it works. Abort if we reach
       * $maxAttempts. Something screwy could be happening with the filesystem
       * and our loop could otherwise become endless.
       */
      $attempts = 0;
      do
      {
           $path = sprintf('%s%s%s%s', $dir, DIRECTORY_SEPARATOR, $prefix, mt_rand(100000, mt_getrandmax()));
      } while (
                !mkdir($path, $mode) &&
                $attempts++ < $maxAttempts
                );
      
      return $path;
 }

◆ today()

today ( )

Returns today as a string.

All of it.

Definition at line 424 of file functions.inc.

 {
      return date('Y-m-d');
 }

◆ toJSArray()

toJSArray	(	$items,
		$field = `""`
	)

Definition at line 1694 of file functions.inc.

 {
      $js_arr = "[";
      $first = true;
  
      if(count($items) == 0)
           return "";
           
      if(is_object($items[0]) && !$field)
      {
           $field = $items[0]->getPrimaryKey();
      }
           
      foreach($items as $item)
      {
           if (!$first) $js_arr .=", ";
           $js_arr .= (is_object($item) && $field) ? $item->$field : $item;
           $first = false;
      }
           
      $js_arr .= "]";
      
      return $js_arr;
 }

◆ trace()

trace	(	$msg,
		$lvl = `3`,
		$callStack = `null`
	)

Send output to the trace log.

Parameters

string	$msg	the message to output
int	$lvl	the severity level (0-5) of this message

Definition at line 1010 of file functions.inc.

 {
      global $config;
      global $traceLevels;
      
      if ($lvl <= $config["trace_level"])
      {
           switch($config["trace_detail"])
           {
           case TraceDetailFull:
                
                $callStack = $callStack ? $callStack : debug_backtrace();
                if (count($callStack) > 1)
                {
                     $callingFn = $callStack[1];
                }
                else
                {
                     $callingFn = $callStack[0];
                }
                $file = str_replace($config["homedir"], "", $callingFn["file"]);
                $ref = $file.":".$callingFn["line"]." ";
                if ($callingFn["class"])
                {
                     $ref .= $callingFn["class"].$callingFn["type"];
                }
                
                $ref .= $callingFn["function"]."(): ";
                
                error_log("[".$traceLevels[$lvl]."] ".date("Y-m-d H:i:s")." : ".$_SERVER['REQUEST_URI']." : ".$ref." ".$msg."\r\n", 3, $config["trace_path"]);
                break;
  
           case TraceDetailHigh:
                
                $callStack = $callStack ? $callStack : debug_backtrace();
  
                if (count($callStack) > 1)
                {
                     $callingFn = $callStack[1];
                }
                else
                {
                     $callingFn = $callStack[0];
                }              
                
                $file = str_replace($config["homedir"], "", $callingFn["file"]);
                $ref = $file.":".$callingFn["line"]." ";
                if ($callingFn["class"])
                {
                     $ref .= $callingFn["class"].$callingFn["type"];
                }
                
                $ref .= $callingFn["function"]."(): ";
                
                error_log("[".$traceLevels[$lvl]."] ".date("Y-m-d H:i:s")." : ".$ref." ".$msg."\r\n", 3, $config["trace_path"]);
                break;
                
                     
           case TraceDetailMedium:
                error_log("[".$traceLevels[$lvl]."] ".date("Y-m-d H:i:s : ").$msg."\r\n", 3, $config["trace_path"]);
                break;
  
           case TraceDetailNormal:
           default:
                
                error_log("[".$traceLevels[$lvl]."] ".$msg."\r\n", 3, $config["trace_path"]);
                break;
           }
      }
 }

◆ wrapURL()

wrapURL	(	$url,
		$width = `120`
	)

Break a URL at a given string position.

This can help prevent long URLs from messing up your page layout.

Parameters

$url	the URL to break
$width	the maximum line length (in characters)

Returns: string the URL, wrapped for display

Definition at line 1381 of file functions.inc.

 {
      $text = str_replace(" ", "%20", $url);
      $text = str_replace("/", " ", $text);
      $text = wordwrap($text, $width, "/<br>", true);
      $text = str_replace(" ", "/", $text);
      
      return $text;
 }

◆ xmlEntities()

xmlEntities ( $string )

Function to provide html to XML entity renaming.

Provides fallback for PHP versions earlier than 5.4 that do not have the ENT_XML1 format available for the htmlentities() call.

Parameters

string $string the string to convert

Returns: string

Definition at line 1903 of file functions.inc.

 {
      if (defined(ENT_XML1)) return htmlentities($value, ENT_XML1);
  
      $result = '';
      foreach (str_split(utf8_decode(htmlspecialchars($string))) as $char)
      {
           $num = ord($char);
           if ($num > 127) {
                $result .= '&#' . $num . ';';
           } else {
                $result .= $char;
           }
      }
      return $result;
 }

Variable Documentation

◆ $__urlRewriteParams

$__urlRewriteParams = array()

Definition at line 1610 of file functions.inc.

◆ $_icons

$_icons

Initial value:

= array(".doc"      =>   "/images/msword_icon.png",
                    ".xls"         =>   "/images/msexcel_icon.png",
                    ".pdf"         =>   "/images/pdf_icon.png",
                    ".ppt"         =>   "/images/ppt_icon.png",
                    "default" =>   "/images/file_icon.png")

Definition at line 1138 of file functions.inc.

◆ $_redirectLogCallback

$_redirectLogCallback = null

Definition at line 918 of file functions.inc.

◆ $image_types

$image_types = array( "image/jpeg", "image/gif", "image/x-png", "image/pjpeg" )

MIME types allowable for image uploads.

Definition at line 118 of file functions.inc.

◆ $traceLevels

$traceLevels

Initial value:

= array(1 =>   "FATAL",
                          2   =>   "ERROR",
                          3   =>   "TRACE",
                          4   =>   "DEBUG",
                          5  =>  "NOTE*")

Definition at line 1000 of file functions.inc.

Functions

Variables

Detailed Description

Function Documentation

◆ ajaxReturn()

◆ appendToQueryString()

◆ array_remove_keys()

◆ arrayFilterKey()

◆ baseURI()

◆ canonicalizeURL()

◆ checkGUID()

◆ checkIdentifier()

◆ checkIdentifierList()

◆ checkNumeric()

◆ checkNumericList()

◆ checkPlainGUID()

◆ checkRole()

◆ checkValidDate()

◆ checkValidDateTime()

◆ checkValidEmail()

◆ cleanHTMLTags()

◆ cleanQuotes()

◆ codify()

◆ color()

◆ countMatchingElements()

◆ ellipsis()

◆ encode7bit()

◆ endsWith()

◆ fgetcsv_noBOM()

◆ filterByRole()

◆ firstSentence()

◆ fopen_utf8()

◆ format_phone()

◆ formatAddress()

◆ formatAsHTML()

◆ formatCheckListItemsforView()

◆ formatCurrency()

◆ formatDate()

◆ formatDateLong()

◆ formatDateShort()

◆ formatDateTime12()

◆ formatDateTime12Hr()

◆ formatMonthYear()

◆ formatStartDateToEndDate()

◆ formatTime12()

◆ formatTimestamp()

◆ formatTimestampShort()

◆ getBacktrace()

◆ getCleanQueryString()

◆ getDocIcon()

◆ getDocMimeType()

◆ getDocSize()

◆ getDocType()

◆ getFullQueryString()

◆ getIcon()

◆ getMIMEType()

◆ getMonthDays()

◆ getMonthWeekDays()

◆ getRemote()

◆ getRemoteHeaders()

◆ getScaledSize()

◆ GUID()

◆ hasRole()

◆ htmlsafe()

◆ HTMLToText()

◆ includeRemote()

◆ jsonRequest()

◆ jsSafe()

◆ luhnTest()

◆ makeRandomString()

◆ makeURL()

◆ now()

◆ option()

◆ ordinalSuffix()

◆ parseMultiParam()

◆ plainGUID()

◆ pluralize()

◆ postRemote()

◆ postRemoteXML()

◆ prettify()