BigTree

arrayToXML

Turns a PHP array into an XML string.

Return Value: A string of XML.

static arrayToXML($array, $tab = "")

arrayFilterRecursive

Recursively filters an array.

Return Value: A filtered array

static arrayFilterRecursive($array)

classAutoLoader

Internal function to automatically load module classes as needed.

static classAutoLoader()

cleanFile

Makes sure that a file path doesn't contain abusive characters (i.e. ../)

Return Value: Cleaned up string.

static cleanFile($file)

colorMesh

Returns a color a % of the way between two colors.

Return Value: A hex value color between the first and second colors.

static colorMesh($first_color, $second_color, $percentage)

copyDirectory

Copies a directory and sets writable permissions.

Return Value: true if the copy was successful

static copyDirectory($source, $destination)

copyFile

Copies a file into a directory, even if that directory doesn't exist yet.

Return Value: true if the copy was successful, false if the directories were not writable or the source was not readable.

static copyFile($from, $to)

cURL

Posts to a given URL and returns the response.
Wrapper for cURL.
The last response code is stored in $bigtree["last_curl_response_code"].
The last error is stored in $bigtree["last_curl_error"].

Return Value: The string response from the URL.

static cURL($url, $post = false, $options = [], $strict_security = true, $output_file = false, $updating_bundle = false)

currentURL

Return the current active URL with correct protocall and port

static currentURL($port = false)

dateFormat

Formats a date that originates in the config defined date format into another.

Return Value: A date string or false if date parsing failed

static dateFormat($date, $format = "Y-m-d H:i:s")

dateFromOffset

Returns a formatted date from a date and an offset.
e.g. "January 1, 2015" and "2 months" returns "2015-03-01 00:00:00"

Return Value: A date string

static dateFromOffset($start_date, $offset, $format = "Y-m-d H:i:s")

deleteDirectory

Deletes a directory including everything in it.

Return Value: true if successful

static deleteDirectory($dir)

describeTable

Gives in depth information about a MySQL table's structure and keys.

Return Value: An array of table information.

static describeTable($table)

directoryContents

Returns a directory's files and subdirectories (with their files) in a flat array with file paths.

Return Value: Returns false if the directory cannot be read.

static directoryContents($directory, $recursive = true, $extension = false, $include_git = false)

formatBytes

Formats bytes into larger units to make them more readable.

Return Value: A string with the number of bytes in kilobytes, megabytes, or gigabytes.

static formatBytes($size)

formatCSS3

Replaces CSS3 delcarations with vendor appropriate ones to reduce CSS redundancy.

Return Value: A string of CSS with vendor prefixes.

static formatCSS3($css)

formatVendorPrefixes

A preg_replace function for transforming a standard CSS3 entry into a vendor prefixed string.

Return Value: Replaced string.

static formatVendorPrefixes($data)

geocodeAddress

Returns a latitude and longitude for a given address.
This method is deprecated and exists only for backwards compatibility (BigTreeGeocoding should be used directly).

Return Value: An associative array with "latitude" and "longitude" keys (or false if geocoding failed).

static geocodeAddress($address)

getAvailableFileName

Gets a web safe available file name in a given directory.

Return Value: An available, web safe file name.

static getAvailableFileName($directory, $file, $prefixes = [])

getCookie

Gets a cookie set by setCookie and decodes it.

static getCookie($id)

getFieldSelectOptions

Get the <select> options of all the fields in a table.

static getFieldSelectOptions($table, $default = "", $sorting = false)

getTableSelectOptions

Get the <select> options for all of tables in the database excluding bigtree_ prefixed tables.

static getTableSelectOptions($default = false)

getIsSSL

Returns whether BigTree believes it's being served over SSL or not.

static getIsSSL()

globalizeArray

Globalizes all the keys of an array into global variables without compromising super global ($_) variables.
Optionally runs a list of functions (passed in after the array) on the data.

static globalizeArray($array, $functions)

globalizeArrayRecursion

Used by globalizeArray for recursion.

static globalizeArrayRecursion()

globalizeGETVars

Globalizes all the $_GET variables without compromising $_ variables.
Optionally runs a list of functions passed in as arguments on the data.

static globalizeGETVars($functions)

globalizePOSTVars

Globalizes all the $_POST variables without compromising $_ variables.
Optionally runs a list of functions passed in as arguments on the data.

static globalizePOSTVars($functions)

gravatar

Returns a properly formatted gravatar url.

static gravatar($email, $size = 56, $default = false, $rating = "g")

isDirectoryWritable

Extend's PHP's is_writable to support directories that don't exist yet.

Return Value: true if the directory exists and is writable or could be created, otherwise false.

static isDirectoryWritable($path)

isExternalLink

Check if URL is external, relative to site root

Return Value: true if link is external

static isExternalLink($url)

json

Encodes a variable as JSON. Uses pretty print if available. Optionally escapes for SQL.

Return Value: A JSON encoded string.

static json($var, $sql = false)

makeDirectory

Makes a directory (and all applicable parent directories).
Sets permissions to 777.

static makeDirectory($directory)

moveFile

Moves a file into a directory, even if that directory doesn't exist yet.

Return Value: true if the move was successful, false if the directories were not writable.

static moveFile($from, $to)

nextSQLColumnDefinition

Return the next SQL name definition from a string.

Return Value: A string.

static nextSQLColumnDefinition($string)

parsedFilesArray

Parses the $_FILES array and returns an array more like a normal $_POST array.

Return Value: A more sensible array, or a piece of that sensible array if "part" is set.

static parsedFilesArray($part = false)

path

Get the proper path for a file based on whether a custom override exists.

Return Value: Hard file path to a custom/ (preferred) or core/ file depending on what exists.

static path($file)

pathInfo

Wrapper for PHP's pathinfo to make sure it supports returning "filename"

Return Value: Everything PHP's pathinfo() returns (with "filename" even when PHP doesn't support it).

static pathInfo($file)

phpDateTojQuery

Converts a PHP date() format to jQuery date picker format.

Return Value: jQuery date picker formatting string.

static phpDateTojQuery($format)

placeholderImage

Generates placeholder image data.

Return Value: Nothing; Renders a placeholder image

static placeholderImage($width, $height, $bg_color = false, $text_color = false, $icon_path = false, $text_string = false)

postMaxSize

Returns in bytes the maximum size of a POST.

static postMaxSize()

prefixFile

Prefixes a file name with a given prefix.

Return Value: The full path or file name with a prefix appended to the file name.

static prefixFile($file, $prefix)

putFile

Writes data to a file, even if that directory for the file doesn't exist yet.
Sets the file permissions to 777 if the file did not exist.

Return Value: true if the move was successful, false if the directories were not writable.

static putFile($file, $contents)

randomString

Returns a random string.

Return Value: A random string.

static randomString($length = 8, $seeds = 'alphanum')

redirect

Simple URL redirect via header with proper code #

static redirect($url = false, $code = ["302"])

relativeTime

Turns a timestamp into "… hours ago" formatting.

Return Value: A string describing how long ago the passed time was.

static relativeTime($time)

remoteIP

Returns the remote user's IP address (works with load balancers).

Return Value: An IP address

static remoteIP()

route

Returns the proper file to include based on existence of subdirectories or .php files with given route names.
Used by the CMS for routing ajax and modules.

Return Value: An array with the first element being the file to include and the second element being an array containing extraneous routes from the end of the path.

static route($directory, $path)

runningAsSU

Checks if the current script is running as the owner of the script.
Useful for determining whether you need to 777 a file you're creating.

Return Value: true if PHP is running as the user that owns the file

static runningAsSU()

runParser

Evaluates code in a function scope with $item and $value
Used mostly internally in the admin for parsers.

Return Value: Modified $value

static runParser($item, $value, $code)

safeEncode

Modifies a string so that it is safe for display on the web (tags and quotes modified for usage inside attributes) without double-encoding.
Ensures that other html entities (like &hellip;) turn into UTF-8 characters before encoding.
Only to be used when your website's character set is UTF-8.

Return Value: Encoded string.

static safeEncode($string)

sendEmail

Sends an email using PHPMailer

Return Value: true if email is sent, otherwise false.

static sendEmail($to, $subject, $html, $text = "", $from = false, $return = false, $cc = false, $bcc = false, $headers = [], $ = [])

setCookie

Sets a site-wide cookie with support for arrays.
Cookies set by setCookie should be retrieved via getCookie (all values are JSON encoded).

static setCookie($id, $value, $expiration)

setDirectoryPermissions

Sets writable permissions for a whole directory.
If the web server is not running as the owner of the current script, permissions will be 777.

static setDirectoryPermissions($location)

setPermissions

Checks to see if the current user the web server is running as is the owner of the current script.
If they are not the same user, the file/directory is given a 777 permission so that the script owner can still manage the file.

static setPermissions($location)

tableCompare

Returns a list of SQL commands required to turn one table into another.

Return Value: An array of SQL calls to perform to turn Table A into Table B.

static tableCompare($table_a, $table_b)

tableContents

Returns an array of INSERT statements for the rows of a given table.
The INSERT statements will be binary safe with binary columns requested in hex.

Return Value: An array.

static tableContents($table)

tableExists

Determines whether a SQL table exists.

Return Value: true if table exists, otherwise false.

static tableExists($table)

touchFile

touch()s a file even if the directory for it doesn't exist yet.

static touchFile($file)

translateArray

Steps through an array and creates internal page links for all parts of it.

Return Value: An array with internal page links encoded.

static translateArray($array)

trimLength

A smarter version of trim that works with HTML.

Return Value: A string trimmed to the proper number of characters.

static trimLength($string, $length)

unformatBytes

Formats a string of kilobytes / megabytes / gigabytes back into bytes.

Return Value: The number of bytes.

static unformatBytes($size)

untranslateArray

Steps through an array and creates hard links for all internal page links.

Return Value: An array with internal page links decoded.

static untranslateArray($array)

unzip

Unzips a file.

static unzip($file, $destination)

uploadMaxFileSize

Returns Apache's max file size value for use in forms.

Return Value: The integer value for setting a form's MAX_FILE_SIZE.

static uploadMaxFileSize()

urlExists

Attempts to connect to a URL using cURL.

Return Value: true if it can connect, false if connection failed.

static urlExists($url)