Docs for page utility

Procedural File: utility_api.php

Page Details

Utility functions are *small* functions that are used often and therefore have *no* prefix, to keep their names short.

Utility functions have *no* dependencies on any other APIs, since they are included first in order to make them available to all the APIs. Miscellaneous functions that provide functionality on top of other APIS are found in the helper_api.

Copyright:	Copyright (C) 2000 - 2002 Kenzaburo Ito - kenito@300baud.org
Copyright:	Copyright (C) 2002 - 2009 MantisBT Team - mantisbt-dev@lists.sourceforge.net
Link:	http://www.mantisbt.org
Usedby:	bug_check_workflow()
Usedby:	collapse_api.php

Functions

get_gd_version [line 169]

int get_gd_version(
)

Return GD version

It doesn't use gd_info() so it works with PHP < 4.3.0 as well

API Tags:

Return:	represents gd version
Access:	public

[ Top ]

ini_get_bool [line 85]

bool ini_get_bool(
string $p_name 
)

Get the named php ini variable but return it as a bool

Parameters:

string

$p_name:

API Tags:

Access:

public

[ Top ]

ini_get_number [line 116]

int ini_get_number(
string $p_name 
)

Get the named php ini variable but return it as a number after converting "K" and "M"

Parameters:

string

$p_name:

API Tags:

Access:

public

[ Top ]

is_blank [line 70]

bool is_blank(
string $p_var 
)

Return true if the parameter is an empty string or a string

containing only whitespace, false otherwise

Parameters:

string

$p_var:

string to test

API Tags:

Access:

public

[ Top ]

is_page_name [line 188]

bool is_page_name(
string $p_string 
)

return true or false if string matches current page name

Parameters:

string

$p_string:

page name

API Tags:

Access:

public

[ Top ]

multi_sort [line 137]

array multi_sort(
array $p_array, string $p_key, [int $p_direction = ASCENDING] 
)

Sort a multi-dimensional array by one of its keys

Parameters:

array	$p_array:	Array to sort
string	$p_key:	key to sort array on
int	$p_direction:	sort direction

API Tags:

Return:	sorted array
Access:	public

[ Top ]

terminate_directory_path [line 54]

string terminate_directory_path(
string $p_path 
)

Add a trailing DIRECTORY_SEPARATOR to a string if it isn't present

Parameters:

string

$p_path:

API Tags:

Access:

public

[ Top ]

trans_bool [line 40]

string trans_bool(
int $p_num 
)

converts a 1 value to X

converts a 0 value to a space

Parameters:

int

$p_num:

boolean numeric

API Tags:

Return:	X or space
Access:	public

[ Top ]

Documentation generated on Sun, 05 Apr 2009 23:01:38 +0100 by phpDocumentor 1.4.1

	CoreAPI UtilityAPI

[ class tree: CoreAPI ] [ index: CoreAPI ] [ all elements ]