L-electron-Rare/moodle
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

MDL-18162 mod_forum: Correct phpdoc for forum_clean_search_terms

Browse Source
This commit is contained in:
Andrew Nicols
2014-05-28 09:36:02 +08:00
parent 529d4cdbc6
commit 646021e728
1 changed files with 18 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files
mod/forum/search.php
+18 -15
View File
@@ -296,10 +296,12 @@ echo $OUTPUT->paging_bar($totalcount, $page, $perpage, $url);
echo $OUTPUT->footer();
/**
* @todo Document this function
*/
/**
* Print a full-sized search form for the specified course.
*
* @param object $course The Course that will be searched.
* @return void The function prints the form.
*/
function forum_print_big_search_form($course) {
global $CFG, $DB, $words, $subject, $phrase, $user, $userid, $fullwords, $notwords, $datefrom, $dateto, $PAGE, $OUTPUT;
@@ -421,12 +423,13 @@ function forum_print_big_search_form($course) {
/**
* This function takes each word out of the search string, makes sure they are at least
* two characters long and returns an array containing every good word.
* two characters long and returns an string of the space-separated search
* terms.
*
* @param string $words String containing space-separated strings to search for
* @param string $prefix String to prepend to the each token taken out of $words
* @returns array
* @todo Take the hardcoded limit out of this function and put it into a user-specified parameter
* @param string $words String containing space-separated strings to search for.
* @param string $prefix String to prepend to the each token taken out of $words.
* @return string The filtered search terms, separated by spaces.
* @todo Take the hardcoded limit out of this function and put it into a user-specified parameter.
*/
function forum_clean_search_terms($words, $prefix='') {
$searchterms = explode(' ', $words);
@@ -440,15 +443,16 @@ function forum_clean_search_terms($words, $prefix='') {
return trim(implode(' ', $searchterms));
}
/**
* @todo Document this function
*/
/**
* Retrieve a list of the forums that this user can view.
*
* @param object $course The Course to use.
* @return array A set of formatted forum names stored against the forum id.
*/
function forum_menu_list($course) {
$menu = array();
$modinfo = get_fast_modinfo($course);
if (empty($modinfo->instances['forum'])) {
return $menu;
}
@@ -466,4 +470,3 @@ function forum_menu_list($course) {
return $menu;
}