Docs for page misc.php

Procedural File: misc.php

Page Details

This file defines all other base functionality.

Author:	Paul Bukowski <pbukowski@telaxus.com>
Version:	1.0
Copyright:	Copyright © 2006, Telaxus LLC
License:	SPL

Class

Description

EpesiHTML

Functions

detect_iphone [line 517]

void detect_iphone(
)

[ Top ]

detect_mobile_device [line 401]

void detect_mobile_device(
)

[ Top ]

dir_tree [line 247]

array dir_tree(
string $path, [integer $hidden = false], [integer $maxdepth = -1], [ $d = 0] 
)

Returns directory tree starting at given directory.

Parameters:

string	$path:	starting directory
integer	$hidden:	maximum depth of the tree
integer	$maxdepth:	depth counter, for internal use
	$d:

API Tags:

Return:

directory tree

[ Top ]

ereg_tree [line 281]

array ereg_tree(
string $path, string $pattern, [mixed $maxdepth = -1], [integer $d = 0], integer 4 
)

Returns files tree matching pattern starting at given directory.

Parameters:

integer	4:	depth counter, for internal use
string	$path:	starting directory
string	$pattern:	glob pattern
mixed	$maxdepth:	glob flags
integer	$d:	maximum depth of the tree

API Tags:

Return:

directory tree

[ Top ]

escapeJS [line 356]

void escapeJS(
 $str, [ $double = true], [ $single = true] 
)

Parameters:

	$str:
	$double:
	$single:

[ Top ]

eval_js [line 93]

void eval_js(
string $u, [ $del_on_loc = true] 
)

Adds js block to eval. If no argument is specified returns saved jses.

Parameters:

string	$u:	javascrpit code
	$del_on_loc:

[ Top ]

eval_js_once [line 102]

bool eval_js_once(
string $u, [ $del_on_loc = false] 
)

Adds js block to eval. Given js will be evaluated only once.

Parameters:

string	$u:	javascrpit code
	$del_on_loc:

API Tags:

Return:

true on success, false otherwise

[ Top ]

filesize_hr [line 363]

void filesize_hr(
 $size 
)

Parameters:

$size:

[ Top ]

generate_password [line 20]

string generate_password(
[integer $length = 8] 
)

Generates random string of specified length.

Parameters:

integer

$length:

length

API Tags:

Return:

random string

[ Top ]

get_epesi_url [line 358]

void get_epesi_url(
)

[ Top ]

harden_characters [line 180]

void harden_characters(
 $array 
)

Parameters:

$array:

[ Top ]

json_decode [line 377]

void json_decode(
 $content, [ $assoc = false] 
)

Parameters:

	$content:
	$assoc:

[ Top ]

json_encode [line 389]

void json_encode(
 $content 
)

Parameters:

$content:

[ Top ]

load_css [line 74]

void load_css(
string $u, [ $loader = null] 
)

Requests css loading.

Parameters:

string	$u:	css file path and name
	$loader:

[ Top ]

load_js [line 84]

void load_js(
string $u, [boolean $loader = null] 
)

Adds js to load.

Parameters:

string	$u:	javascript file
boolean	$loader:	append contents of js file instead of use src tag?

[ Top ]

location [line 52]

string location(
[array $u = null], [ $ret = false], [ $clear = true] 
)

Redirects to specified url. First parameter is array of variables to pass with redirection.

If no argument is specified returns saved redirect url.

Parameters:

array	$u:
	$ret:
	$clear:

API Tags:

Return:

saved url

[ Top ]

on_exit [line 122]

mixed on_exit(
[mixed $u = null], [mixed $args = null], [bool $stable = true], [bool $ret = false] 
)

Adds method to call on exit.

Parameters:

mixed	$u:	function to call
mixed	$args:	list of arguments
bool	$stable:	if set to false the function will be called only once, location() doesn't affect with double call
bool	$ret:	if set to true the function will return currently hold list of functions (don't use it in modules)

API Tags:

Return:

returns function list if requested, true if function was added to list, false otherwise

[ Top ]

on_init [line 148]

mixed on_init(
[mixed $u = null], [mixed $args = null], [bool $stable = true], [bool $ret = false] 
)

Adds method to call on init.

Parameters:

mixed	$u:	function to call
mixed	$args:	list of arguments
bool	$stable:	if set to false the function will be called only once, location() doesn't affect with double call
bool	$ret:	if set to true the function will return currently hold list of functions (don't use it in modules)

API Tags:

Return:

function list if requested, true if function was added to list, false otherwise

[ Top ]

recursive_copy [line 333]

void recursive_copy(
string $src, string $dest 
)

Copies directory recursively, along with all files stored under source directory.

If destination directory doesn't exist it will be created.

Parameters:

string	$src:	source directory
string	$dest:	destination directory

[ Top ]

recursive_rmdir [line 308]

void recursive_rmdir(
string $path 
)

Removes directory recursively, deleteing all files stored under this directory

Parameters:

string

$path:

directory to remove

[ Top ]

strip_html [line 164]

void strip_html(
 $data 
)

Parameters:

$data:

[ Top ]

strip_js [line 194]

void strip_js(
 $input 
)

Parameters:

$input:

[ Top ]

unharden_characters [line 187]

void unharden_characters(
 $array 
)

Parameters:

$array:

[ Top ]

Documentation generated on Fri, 26 Dec 2008 21:44:00 -0500 by phpDocumentor 1.4.2

	epesi-base

[ class tree: epesi-base ] [ index: epesi-base ] [ all elements ]