Documentation

C3Tools
in package

This takes care of tools specifically pertaining to C3 Use this sparingly: everything that is a tool should be in Tool everything specific to C3 should be in its own class This is mainly a legacy class for the old awful functions.php file

Table of Contents

chooseFormat()  : mixed
decrypt()  : mixed
decryptData()  : mixed
doPagination()  : string
Creates pagination query string using all available properties ATTENTION! If you add more vars here, add them to RoutesHelper::pagination_vars otherwise users will be bounced PAGES OPTIONS When a page is provided, we use the default number of records or the one provided to figure out LIMIT
encrypt()  : mixed
encryptData()  : mixed
idFromCookie()  : mixed
makeLocalHash()  : mixed
sendEmail()  : mixed
shuffle_assoc()  : mixed
textDate()  : mixed
textTime()  : mixed
USCompactDate()  : mixed

Methods

chooseFormat()

public static chooseFormat(mixed $files, mixed $what[, mixed $all = false ]) : mixed
Parameters
$files : mixed
$what : mixed
$all : mixed = false
Return values
mixed

decrypt()

public static decrypt(mixed $encrypted, mixed $password[, mixed $salt = '-aR$%pè+43wERTaHk' ]) : mixed
Parameters
$encrypted : mixed
$password : mixed
$salt : mixed = '-aR$%pè+43wERTaHk'
Return values
mixed

decryptData()

public static decryptData(mixed $data, mixed $password) : mixed
Parameters
$data : mixed
$password : mixed
Return values
mixed

doPagination()

Creates pagination query string using all available properties ATTENTION! If you add more vars here, add them to RoutesHelper::pagination_vars otherwise users will be bounced PAGES OPTIONS When a page is provided, we use the default number of records or the one provided to figure out LIMIT

public static doPagination(mixed $args[, mixed $public = false ]) : string
Parameters
$args : mixed
$public : mixed = false
Tags
args

p int :

args

page int : START OPTIONS

args

start int :

args

from int : RECORDS OPTIONS

args

records int :

args

limit int :

args

default_records int : This is used in case we don't know if user provided records and pagination uses a different default max

public

bool : If TRUE, does not return the query string, used to serve back to the user pagination info

Return values
string

encrypt()

public static encrypt(mixed $decrypted, mixed $password[, mixed $salt = '-aR$%pè+43wERTaHk' ]) : mixed
Parameters
$decrypted : mixed
$password : mixed
$salt : mixed = '-aR$%pè+43wERTaHk'
Return values
mixed

encryptData()

public static encryptData(mixed $data, mixed $password) : mixed
Parameters
$data : mixed
$password : mixed
Return values
mixed

idFromCookie()

public static idFromCookie(mixed $cookie) : mixed
Parameters
$cookie : mixed
Return values
mixed

makeLocalHash()

public static makeLocalHash(mixed $ip, mixed $member_id) : mixed
Parameters
$ip : mixed
$member_id : mixed
Return values
mixed

sendEmail()

public static sendEmail(mixed $args) : mixed
Parameters
$args : mixed
Return values
mixed

shuffle_assoc()

public static shuffle_assoc(mixed &$array) : mixed
Parameters
$array : mixed
Return values
mixed

textDate()

public static textDate(mixed $date) : mixed
Parameters
$date : mixed
Return values
mixed

textTime()

public static textTime(mixed $date[, mixed $seconds = false ]) : mixed
Parameters
$date : mixed
$seconds : mixed = false
Return values
mixed

USCompactDate()

public static USCompactDate(mixed $date) : mixed
Parameters
$date : mixed
Return values
mixed

Search results