| Method |
Description |
|
|
__call ( $key, $args ) : mixed |
Call function identified by hive key |
|
|
__construct ( ) |
! Bootstrap |
|
|
__get ( $key ) : mixed |
Alias for offsetget() |
|
|
__isset ( $key ) : mixed |
Alias for offsetexists() |
|
|
__set ( $key, $val ) : mixed |
Alias for offsetset() |
|
|
__unset ( $key ) : mixed |
Alias for offsetunset() |
|
|
abort ( ) |
Disconnect HTTP client |
|
|
agent ( ) : string |
Return HTTP user agent |
|
|
ajax ( ) : boolean |
Return TRUE if XMLHttpRequest detected |
|
|
alias ( $name, $params = [], $query = NULL ) : string |
Assemble url from alias name |
|
|
base64 ( $data, $mime ) : string |
Return Base64-encoded equivalent |
|
|
blacklisted ( $ip ) : boolean |
Return TRUE if IPv4 address exists in DNSBL |
|
|
build ( $url, $args = [] ) : string |
Replace tokenized URL with available token values |
|
|
call ( $func, $args = NULL, $hooks = '' ) : mixed | FALSE |
Execute callback/hooks (supports 'class->method' format) |
|
|
camelcase ( $str ) : string |
Convert snakecase string to camelcase |
|
|
chain ( $funcs, $args = NULL ) : array |
Execute specified callbacks in succession; Apply same arguments
to all callbacks |
|
|
checked ( $key ) : boolean |
Return TRUE if hive variable is 'on' |
|
|
clean ( $arg, $tags = NULL ) : mixed |
Remove HTML tags (except those enumerated) and non-printable
characters to mitigate XSS/code injection attacks |
|
|
clear ( $key ) : null |
Unset hive key |
|
|
compile ( $str ) : string |
Convert JS-style token to PHP expression |
|
|
concat ( $key, $val ) : string |
Concatenate string to hive string variable |
|
|
config ( $file, $allow = FALSE ) : object |
Configure framework according to .ini-style file settings;
If optional 2nd arg is provided, template strings are interpreted |
|
|
constants ( $class, $prefix = '' ) : array |
Convert class constants to array |
|
|
copy ( $src, $dst ) : mixed |
Copy contents of hive variable to another |
|
|
csv ( array $args ) : string |
Flatten array values and return as CSV string |
|
|
decode ( $str ) : string |
Convert HTML entities back to characters |
|
|
devoid ( $key, &$val = NULL ) : boolean |
Return TRUE if hive key is empty and not cached |
|
|
dump ( $expr ) : null |
Dump expression with syntax highlighting |
|
|
encode ( $str ) : string |
Convert special characters to HTML entities |
|
|
error ( $code, $text = '', array $trace = NULL, $level ) : null |
Log error; Execute ONERROR handler if defined, else display
default error page (HTML for synchronous requests, JSON string
for AJAX requests) |
|
|
exists ( $key, &$val = NULL ) : boolean |
Return TRUE if hive key is set
(or return timestamp and TTL if cached) |
|
|
expire ( $secs ) : null |
Send cache metadata to HTTP client |
|
|
extend ( $key, $src, $keep = FALSE ) : array |
Extend hive array variable with default values from $src |
|
|
extract ( $arr, $prefix ) : array |
Extract values of array whose keys start with the given prefix |
|
|
fixslashes ( $str ) : string |
Convert backslashes to slashes |
|
|
flip ( $key ) : array |
Swap keys and values of hive array variable |
|
|
format ( ) : string |
Return locale-aware formatted string |
|
|
get ( $key, $args = NULL ) : mixed |
Retrieve contents of hive key |
|
|
grab ( $func, $args = NULL ) : string | array |
Grab the real route handler behind the string expression |
|
|
hash ( $str ) : string |
Generate 64bit/base36 hash |
|
|
highlight ( $text ) : string |
Apply syntax highlighting |
|
|
hive ( ) : array |
Publish hive contents |
|
|
ip ( ) : string |
Sniff IP address |
|
|
language ( $code ) : string |
Assign/auto-detect language |
|
|
lexicon ( $path, $ttl ) : array |
Return lexicon entries |
|
|
map ( $url, $class, $ttl, $kbps ) : null |
Provide ReST interface by mapping HTTP verb to class method |
|
|
mask ( $pattern, $url = NULL ) |
Applies the specified URL mask and returns parameterized matches |
|
|
merge ( $key, $src, $keep = FALSE ) : array |
Merge array with hive array variable |
|
|
mock ( $pattern, array $args = NULL, array $headers = NULL, $body = NULL ) : mixed |
Mock HTTP request |
|
|
mset ( array $vars, $prefix = '', $ttl ) : null |
Multi-variable assignment using associative array |
|
|
mutex ( $id, $func, $args = NULL ) : mixed |
Create mutex, invoke callback then drop ownership when done |
|
|
offsetexists ( $key ) : mixed |
Convenience method for checking hive key |
|
|
offsetget ( $key ) : mixed |
Convenience method for retrieving hive value |
|
|
offsetset ( $key, $val ) : mixed |
Convenience method for assigning hive value |
|
|
offsetunset ( $key ) : null |
Convenience method for removing hive key |
|
|
parse ( $str ) : array |
Parse string containing key-value pairs |
|
|
pop ( $key ) : mixed |
Remove last element of hive array variable |
|
|
push ( $key, $val ) : mixed |
Add element to the end of hive array variable |
|
|
read ( $file, $lf = FALSE ) : string |
Read file (with option to apply Unix LF as standard line ending) |
|
|
recursive ( $arg, $func, $stack = [] ) : mixed |
Invoke callback recursively for all data types |
|
|
redirect ( $pattern, $url, $permanent = TRUE ) : null |
Redirect a route to another URL |
|
|
ref ( $key, $add = TRUE, &$var = NULL ) : mixed |
Get hive key reference/contents; Add non-existent hive keys,
array elements, and object properties by default |
|
|
rel ( $url ) : string |
Return path (and query parameters) relative to the base directory |
|
|
relay ( $funcs, $args = NULL ) : array |
Execute specified callbacks in succession; Relay result of
previous callback as argument to the next callback |
|
|
reroute ( $url = NULL, $permanent = FALSE ) : null |
Reroute to specified URI |
|
|
route ( $pattern, $handler, $ttl, $kbps ) : null |
Bind handler to route pattern |
|
|
run ( ) : mixed |
Match routes against incoming URI |
|
|
scrub ( &$var, $tags = NULL ) : mixed |
Similar to clean(), except that variable is passed by reference |
|
|
serialize ( $arg ) : string |
Return string representation of PHP value |
|
|
set ( $key, $val, $ttl ) : mixed |
Bind value to hive key |
|
|
shift ( $key ) : mixed |
Remove first element of hive array variable |
|
|
sign ( $num ) : integer |
Return -1 if specified number is negative, 0 if zero,
or 1 if the number is positive |
|
|
snakecase ( $str ) : string |
Convert camelcase string to snakecase |
|
|
split ( $str, $noempty = TRUE ) : array |
Split comma-, semi-colon, or pipe-separated string |
|
|
status ( $code ) : string |
Send HTTP status header; Return text equivalent of status code |
|
|
stringify ( $arg, array $stack = NULL ) : string |
Convert PHP expression/value to compressed exportable string |
|
|
sync ( $key ) : array |
Sync PHP global with corresponding hive key |
|
|
trace ( array $trace = NULL, $format = TRUE ) : string | array |
Return filtered stack trace as a formatted string (or array) |
|
|
unload ( $cwd ) |
Execute framework/application shutdown sequence |
|
|
unserialize ( $arg ) : string |
Return PHP value derived from string |
|
|
unshift ( $key, $val ) : mixed |
Add element to the beginning of hive array variable |
|
|
until ( $func, $args = NULL, $timeout = 60 ) : mixed |
Loop until callback returns TRUE (for long polling) |
|
|
visible ( $obj, $key ) : boolean |
Return TRUE if property has public visibility |
|
|
write ( $file, $data, $append = FALSE ) : integer | FALSE |
Exclusive file write |
|