Docs for page functions.php

Procedural File: functions.php

Page Details

functions.php This file is a place to put useful functions that can be used throughout Kuote.

Only generic functions should be placed here. Class specific functions should be placed in the class file as static methods.

Copyright:	2006
Author:	Kyle Hall

Functions

add_include_path [line 17]

void add_include_path(
string $path 
)

Adds the given path to PHPs set of include paths

Parameters:

string

$path:

The path to be included

[ Top ]

createCourseOfferListArray [line 345]

void createCourseOfferListArray(
)

[ Top ]

createLearningListArray [line 365]

void createLearningListArray(
 $encodedCourseOrOffering 
)

Parameters:

$encodedCourseOrOffering:

[ Top ]

createOfferCourseForm [line 119]

HTML_Quickform createOfferCourseForm(
)

Creates an Offer Course form using HTML_Quickform.

API Tags:

Return:	The generated form object.
Deprecated:

[ Top ]

createOfferLearningForm [line 161]

HTML_Quickform createOfferLearningForm(
 $courseOffering 
)

Creates an Offer Learning form using HTML_Quickform.

Parameters:

$courseOffering:

API Tags:

Return:	The generated form object.
Deprecated:

[ Top ]

createQuestionForm [line 206]

HTML_Quickform createQuestionForm(
int $crsId, int $learningId, int $questionNumber, string $function, string $subfunction 
)

Creates a Create Question form using HTML_Quickform.

Parameters:

int	$crsId:	Id of the Course the question is part of.
int	$learningId:	Id of the Learning the question is part of.
int	$questionNumber:	The number of the question, i.e. question 6
string	$function:	The function the form is under, i.e. create, update
string	$subfunction:	The subfunction the form is under, i.e. question

API Tags:

Return:	The generated form object.
Deprecated:

[ Top ]

createSelectCourseForm [line 277]

HTML_Quickform createSelectCourseForm(
)

Creates an Offer Course form using HTML_Quickform.

API Tags:

Return:	The generated form object.
Deprecated:

[ Top ]

createSelectCourseOfferForm [line 296]

void createSelectCourseOfferForm(
)

[ Top ]

createSelectLearningForm [line 321]

void createSelectLearningForm(
 $encodedCourseOrOffering 
)

Parameters:

$encodedCourseOrOffering:

[ Top ]

form_object_decode [line 37]

mixed form_object_decode(
string $object 
)

Decodes a PHP object encoded with form_object_encode.

Parameters:

string

$object:

The object to be decoded.

API Tags:

Return:

The PHP object that was encoded.

[ Top ]

form_object_encode [line 27]

string form_object_encode(
mixed $object 
)

Encodes a PHP object so that it may be passed by forms.

Parameters:

mixed

$object:

The object to be encoded.

API Tags:

Return:

The object represented as a decodable string.

[ Top ]

getNextQuestionNumber [line 408]

void getNextQuestionNumber(
 $learningId 
)

Parameters:

$learningId:

[ Top ]

getQuestionsArray [line 387]

void getQuestionsArray(
 $learningId 
)

Parameters:

$learningId:

[ Top ]

get_date_string [line 49]

string get_date_string(
int $year, int $month, int $day 
)

Creates a date string of the format YYYY-MM-DD

Parameters:

int	$year:	The year in the format YYYY.
int	$month:	The month as a number, ex. 3, 7, 11
int	$day:	The day as a number, ex. 3, 9, 21

API Tags:

Return:

The data as a string of the format YYYY-MM-DD

[ Top ]

isEmpty [line 97]

void isEmpty(
 $data 
)

Parameters:

$data:

[ Top ]

jsRefresh [line 107]

void jsRefresh(
)

[ Top ]

print_pr [line 101]

void print_pr(
 $data 
)

Parameters:

$data:

[ Top ]

returnCourseObject [line 422]

void returnCourseObject(
 $crsId 
)

Parameters:

$crsId:

[ Top ]

returnLearningObject [line 450]

void returnLearningObject(
 $learningId 
)

Parameters:

$learningId:

[ Top ]

returnObject [line 436]

void returnObject(
 $objectType,  $objectId 
)

Parameters:

	$objectType:
	$objectId:

[ Top ]

rm [line 62]

void rm(
$fileglob $fileglob 
)

Vigorously erase files and directories.

Parameters:

$fileglob

$fileglob:

mixed If string, must be a file name (foo.txt), glob pattern (*.txt), or directory name. If array, must be an array of file names, glob patterns, or directories.

[ Top ]

updateRequestAndPostValues [line 464]

void updateRequestAndPostValues(
 $Object 
)

Parameters:

$Object:

[ Top ]

Documentation generated on Fri, 15 Dec 2006 11:17:33 -0500 by phpDocumentor 1.3.0

	Kuote

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