ROM Kiosks - API Documentation
\

\

Classes

Catalog A Catalog is a class that manages tabular data.
Catalog A Catalog is a class that manages tabular data.
ExecutionTime A class to check the execution time of a script.
kiosk_checker Class to checks the kiosks to make sure they are still alive.
MySessionHandler A class to handle the current session. This class holds the name of the session and the user ID associated with it.
Permissions The Permissions class
Roles The Roles class
Status Manage status notices within the script.
TaskHandler Task handler.
User The User System

Constants

IMAGE_JPG_DIR

IMAGE_JPG_DIR

IMAGE_JPG_DIR

IMAGE_JPG_DIR

IMAGE_PNG_DIR

IMAGE_PNG_DIR

IMAGE_PNG_DIR

IMAGE_PNG_DIR

IMAGE_THUMB_DIR

IMAGE_THUMB_DIR

IMAGE_THUMB_DIR

IMAGE_THUMB_DIR

KIOSK_DEBUG

KIOSK_DEBUG

KIOSK_SQL

KIOSK_SQL

Functions

add_term()

add_term()

additionalFeatures()

additionalFeatures(  $row)

Parameters

$row

additionalFeatures()

additionalFeatures(  $row)

Parameters

$row

additionalFeatures()

additionalFeatures(  $row)

Parameters

$row

additionalFeatures()

additionalFeatures(  $row)

Parameters

$row

cdata_trim()

cdata_trim(  $data)

Parameters

$data

cdata_trim()

cdata_trim(  $data)

Parameters

$data

cdata_trim()

cdata_trim(  $data)

Parameters

$data

connect_db()

connect_db()

createMapXMLfile()

createMapXMLfile()

csv_to_array()

csv_to_array(  $filename)

Take a CSV file and convert it to an array

Parameters

$filename

csv_to_array()

csv_to_array(  $filename)

Given a csv file, return an array of rows.

Each row is itself an array of entries where the key is the column header name and the value is the actual content for that column in that row.

Parameters

$filename

filterColumns()

filterColumns(  $col)

Parameters

$col

filterColumns()

filterColumns(  $col)

Parameters

$col

filterColumns()

filterColumns(  $col)

Parameters

$col

filterColumns()

filterColumns(  $col)

Parameters

$col

fixOrdering()

fixOrdering(  $row)

Parameters

$row

fixOrdering()

fixOrdering(  $row)

Parameters

$row

fixOrdering()

fixOrdering(  $row)

Parameters

$row

fixOrdering()

fixOrdering(  $row)

Parameters

$row

fixOrdering()

fixOrdering(  $row)

Parameters

$row

fixOrdering()

fixOrdering(  $row)

Parameters

$row

fixOrdering()

fixOrdering(  $row)

Parameters

$row

formInput()

formInput(  $name,   $style_class,   $value = "",   $is_password = false,   $locked = false)

HTML FORM Functions

Parameters

$name
$style_class
$value
$is_password
$locked

formInput()

formInput(  $name,   $style_class,   $value = "",   $is_password = false,   $locked = false)

HTML FORM Functions

Parameters

$name
$style_class
$value
$is_password
$locked

formInput()

formInput(  $name,   $style_class,   $value = "",   $is_password = false,   $locked = false)

HTML FORM Functions

Parameters

$name
$style_class
$value
$is_password
$locked

formOptions()

formOptions(  $name,   $style_class,   $options_arr,   $match_select_value = NULL,   $multi_size = 1,   $locked = false)

Parameters

$name
$style_class
$options_arr
$match_select_value
$multi_size
$locked

formOptions()

formOptions(  $name,   $style_class,   $options_arr,   $match_select_value = NULL,   $multiple_size = 1,   $locked = false)

Parameters

$name
$style_class
$options_arr
$match_select_value
$multiple_size
$locked

formOptions()

formOptions(  $name,   $style_class,   $options_arr,   $match_select_value = NULL,   $multiple_size = 1,   $locked = false)

Parameters

$name
$style_class
$options_arr
$match_select_value
$multiple_size
$locked

get_files()

get_files(  $path_to_dir)

Parameters

$path_to_dir

getChecked()

getChecked(  $fieldName,   $dataArray,   $value,   $default = '')

Simliar to getV, this function compares the result to value and prints checked="checked" if there is a match

Parameters

$fieldName
$dataArray
$value
$default

getChecked()

getChecked(  $fieldName,   $dataArray,   $value)

Simliar to getV, this function compares the result to value and prints checked="checked" if there is a match

Parameters

$fieldName
$dataArray
$value

getChecked()

getChecked(  $fieldName,   $dataArray,   $value,   $default = '')

Simliar to getV, this function compares the result to value and prints checked="checked" if there is a match

Parameters

$fieldName
$dataArray
$value
$default

getV()

getV(  $fieldName,   $dataArray,   $new_default = '')

Gets the value found in the associative array.

This is to conveniently write values into input fields while doing a check

Parameters

$fieldName
$dataArray
$new_default

getV()

getV(  $fieldName,   $dataArray)

Gets the value found in the associative array.

This is to conveniently write values into input fields while doing a check

Parameters

$fieldName
$dataArray

getV()

getV(  $fieldName,   $dataArray,   $new_default = '')

Gets the value found in the associative array.

This is to conveniently write values into input fields while doing a check

Parameters

$fieldName
$dataArray
$new_default

getV()

getV(  $fieldName,   $dataArray,   $new_default = '')

Gets the value found in the associative array.

This is to conveniently write values into input fields while doing a check

Parameters

$fieldName
$dataArray
$new_default

insert_glossary_terms()

insert_glossary_terms(  $input_str,   $term,   $glossary_id)

Parameters

$input_str
$term
$glossary_id

isUserLocked()

isUserLocked(  $lang)

Write a disabled statement if this user is not allowed to edit the text.

Parameters

$lang

microtime_float()

microtime_float()

mysql_insert_array()

mysql_insert_array(  $dbh,   $arr,   $table)

Takes an array and inserts it into the given table.

Parameters

$dbh
$arr
$table

mysqlFieldNamesArray()

mysqlFieldNamesArray(  $mysqlResource)

Parameters

$mysqlResource

parse_bolds()

parse_bolds(  $str)

Parameters

$str

parse_italics()

parse_italics(  $str)

Parameters

$str

parse_linebreaks()

parse_linebreaks(  $str)

Parameters

$str

parse_paragraphs()

parse_paragraphs(  $str)

Parameters

$str

parse_scientific_tags()

parse_scientific_tags(  $str)

Parameters

$str

print_arr()

print_arr(  $arr)

Parameters

$arr

print_arr()

print_arr(  $arr)

Parameters

$arr

print_br()

print_br(  $str)

Parameters

$str

print_h1()

print_h1(  $str)

Parameters

$str

print_h2()

print_h2(  $str)

Parameters

$str

print_p()

print_p(  $str)

Parameters

$str

process_text()

process_text(  $field,   $value)

Parameters

$field
$value

resultsWithOptions()

resultsWithOptions(  $row)

Parameters

$row

resultsWithOptions()

resultsWithOptions(  $row)

Parameters

$row

sqlite_insert_array()

sqlite_insert_array(  $arr,   $table,   $valid_cols = NULL,   $filter = NULL)

EXAMPLE filter function: pass "modify_tjff_query"

function modify_tjff_query(&$field, &$value) {

if($field=="running_time") { if(!is_numeric($value)) { // Remove "min" which is probably there $value = str_replace("min", "", $value); $value = trim($value); } return; } else if($field=="description") { $value = "

".$value."

"; return; } }

Parameters

$arr
$table
$valid_cols
$filter

sqlite_insert_array_with_parsing()

sqlite_insert_array_with_parsing(  $arr,   $table,   $valid_cols = NULL,   $filter = NULL)

Parameters

$arr
$table
$valid_cols
$filter

stripImageName()

stripImageName(  $arg)

Parameters

$arg

stripImageName()

stripImageName(  $arg)

Parameters

$arg

tabularData()

tabularData(  $data_func,   $param_arr,   $headings_arr = NULL,   $column_func = NULL,   $style_class = "",   $sort_key = NULL,   $sort_order = "ASC")

Parameters

$data_func
$param_arr
$headings_arr
$column_func
$style_class
$sort_key
$sort_order

tabularData()

tabularData(  $data_func,   $param_arr,   $headings_arr = NULL,   $column_func = NULL,   $style_class = "",   $sort_key = NULL,   $sort_order = "ASC",   $cname)

Parameters

$data_func
$param_arr
$headings_arr
$column_func
$style_class
$sort_key
$sort_order
$cname

tabularData()

tabularData(  $data_func,   $param_arr,   $headings_arr = NULL,   $column_func = NULL,   $style_class = "",   $sort_key = NULL,   $sort_order = "ASC",   $cname)

Parameters

$data_func
$param_arr
$headings_arr
$column_func
$style_class
$sort_key
$sort_order
$cname

updateRetiredFlag()

updateRetiredFlag(  $col)

Parameters

$col

updateRetiredFlag()

updateRetiredFlag(  $col)

Parameters

$col

updateRetiredFlag()

updateRetiredFlag(  $col)

Parameters

$col

usToSpaces()

usToSpaces(  $str)

Parameters

$str

usToSpaces()

usToSpaces(  $str)

Parameters

$str

usToSpaces()

usToSpaces(  $str)

Parameters

$str

well_formed_check()

well_formed_check(  $xmlfile)

Parameters

$xmlfile

well_formed_check()

well_formed_check(  $xmlfile)

Parameters

$xmlfile

well_formed_check()

well_formed_check(  $xmlfile)

Parameters

$xmlfile

writeApprovalStamp()

writeApprovalStamp(  $decision)

Writes out the approval stamp used in saving this data

Parameters

$decision

writeContent()

writeContent()

writeContent()

writeContent()

writeContent()

writeContent()

writeContent()

writeContent()

writeContent()

writeContent()

writeContent()

writeContent()

writeContent()

writeContent()

writeContent()

writeContent()

This is written into the content area of the template.

writeContent()

writeContent()

This is written into the content area of the template.

writeContent()

writeContent()

writeContent()

writeContent()

writeContent()

writeContent()

writeContent()

writeContent()

writeContent()

writeContent()

writeContent()

writeContent()

writeContent()

writeContent()

writeContent()

writeContent()

writeContent()

writeContent()

writeContent()

writeContent()

writeContent()

writeContent()