Common class

Common class

There are a number of static functions and variables that you may find useful to use in your scripts which have been included in the common class.

Static variables

Accessible via common::$Variable_Name

common::timeLog()

Adds a line to a log file for debugging purposesExample

 
common::timeLog($str,$groupKey='default');
 

common::getCacheFile()

Check for a current cache file

Example

 
$output = common::getCacheFile($filesArray,$prefix,$folder,$extraVars,$otherFilesMTime,$ext,$refreshCache);
/*
$output = array(
	'contents'=>(contents string or false),
	'filename'=>(filename string),
	'timestamp'=>(Unix timestamp [filemtime] of the cache file)
)
*/
 

common::saveCacheFile()

Saves a string to a cache file with parameters for checking the cache again in future.

Example

 
common::saveCacheFile($filesArray,$prefix,$content,$folder,$extraVars,$otherFilesMTime,$ext);
 

common::simplePath()

Get a clean path instead of folder traversing statements

Example

 
$path = 'www/htdocs/../secret/';
$simplePath = common::simplePath($path);
//$simplePath = www/secret/
 

common::findFiles()

Returns an array of files matching a given regular expression in a given location

Example

 
$files = common::findFiles($path,$regex);
/*
$files = array(
	array(
		"path"=>(string),
		"filename"=>(string)
	),
	array(
		"path"=>(string),
		"filename"=>(string)
	)
)
*/
 

common::time_elapsed_string()

Will return a string rounded to the nearest second, minute, hour, day, month or year depending on how much time has elapsed. Similar behaviour to that on a Tweet when using Twitter.

Example

 
$ptime = strtotime("-27 hours");
$niceTime = common::time_elapsed_string($ptime);
//$niceTime = 1 day
 

common::isBot()

Returns if a robot/spider is detected browsing your website.

Example

 
$isRobot = common::isBot();
//$isRobot = (boolean)
 

common:formatSizeUnits()

Returns a filesize and dynamically chooses what units to use (bytes,KB,MB,GB)

Example

 
$bytes = file_get_contents("/path/to/file");
$filesize = common::formatSizeUnits($bytes);
//$filesize = 1KB
 

common::stripFalseArray()

Unsets any array keys that are false (boolean) recursively.

Example

 
$array = array(1, 2, false,array(3, false));
$newArray = common::stripFalseArray($array);
//$newArray = array(1, 2, array(3));
 

common::remoteFileTimes()

Performs a Curl request returning the contents and last modified time of multiple URLs

Example

 
$array = array("http://url.com/page","http://url2.com/file.js");
$fileTimes = common::getFileTimes($array);
/*
$fileTimes = array(
	array(
		"contents"=>(string),
		"timestamp"=>(Unix timestamp)
	),
	array(
		"contents"=>(string),
		"timestamp"=>(Unix timestamp)
	)
);
*/
 

common::remoteFileTime()

Performs a Curl request returning the contents and last modified time of a single URLs

Example

 
$url = "http://url.com/page";
$fileTime = common::getFileTime($url);
/*
$fileTime = array(
	"contents"=>(string),
	"timestamp"=>(Unix timestamp)
);
*/
 

common::pageCacheHeaders()

Add caching headers and detect/return a 301 header and empty page where applicable for a single file. It will also check any files that have been included to see if they have been modified.

Example

 
$file = "/var/www/bw.codes/htdocs/index.php";
$lastModified = common::pageCacheHeaders($file);

// The script may be terminated in this function. If not:
/*
$lastModified = (unix timestamp)
*/
 

common::querystringName()

Cleans a string for use in SEO friendly querystrings/clean URLs

Example

 
$itemName = "Yummy teapot";
$cleanName = common::querystringName($itemName);
/*
$cleanName = "yummy-teapot";
*/
 

common::getClientIP()

Check all known server variables for the Client's IP address until a valid IP is found.

Example

 
$clientIP = common::getClientIP();
/*
$clientIP = 123.223.32.41;
*/