mod_forum\output\big_search_form Class Reference

Big search form class. More...

Inheritance diagram for mod_forum\output\big_search_form:

Public Member Functions
	__construct ($course)
	Constructor. More...
	export_for_template (renderer_base $output)
	Function to export the renderer data in a format that is suitable for a mustache template. More...
	set_datefrom ($value)
	Set date from. More...
	set_dateto ($value)
	Set date to. More...
	set_forumid ($forumid)
	Forum ID setter search criteria. More...
	set_fullwords ($value)
	Set full words. More...
	set_notwords ($value)
	Set not words. More...
	set_phrase ($value)
	Set phrase. More...
	set_starredonly ($value)
	Set starred only value. More...
	set_subject ($value)
	Set subject. More...
	set_tags ($value)
	Set tags. More...
	set_user ($value)
	Set user. More...
	set_words ($value)
	Set words. More...

Public Attributes
string	$actionurl
	The URL of the search form.
	$course
	$datefrom
	$dateto
	$forumoptions
	$fullwords
bool	$guestuser
	Is the user a guest user?
	$notwords
	$phrase
	$showfullwords
bool	$starredonly
	Whether the include starredonly checkbox is checked.
	$subject
	$tags
	$user
	$words

Detailed Description

Big search form class.

Copyright

2016 Frédéric Massart - FMCorz.net

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Constructor & Destructor Documentation

__construct()

mod_forum\output\big_search_form::__construct

(

$course

)

Constructor.

Parameters

object	$course	The course.
object	$user	The user.

Member Function Documentation

export_for_template()

mod_forum\output\big_search_form::export_for_template

(

renderer_base

$output

)

Function to export the renderer data in a format that is suitable for a mustache template.

This means:

1. No complex types - only stdClass, array, int, string, float, bool
2. Any additional info that is required for the template is pre-calculated (e.g. capability checks).

Parameters

renderer_base

$output

Used to do a final render of any components that need to be rendered for export.

Return values

stdClass|array

Implements templatable.

set_datefrom()

mod_forum\output\big_search_form::set_datefrom

(

$value

)

Set date from.

Parameters

mixed

$value

Date from.

set_dateto()

mod_forum\output\big_search_form::set_dateto

(

$value

)

Set date to.

Parameters

mixed

$value

Date to.

set_forumid()

mod_forum\output\big_search_form::set_forumid

(

$forumid

)

Forum ID setter search criteria.

Parameters

int

$forumid

The forum ID.

set_fullwords()

mod_forum\output\big_search_form::set_fullwords

(

$value

)

Set full words.

Parameters

mixed

$value

Full words.

set_notwords()

mod_forum\output\big_search_form::set_notwords

(

$value

)

Set not words.

Parameters

mixed

$value

Not words.

set_phrase()

mod_forum\output\big_search_form::set_phrase

(

$value

)

Set phrase.

Parameters

mixed

$value

Phrase.

set_starredonly()

mod_forum\output\big_search_form::set_starredonly

(

$value

)

Set starred only value.

Parameters

mixed

$value

Bool.

set_subject()

mod_forum\output\big_search_form::set_subject

(

$value

)

Set subject.

Parameters

mixed

$value

Subject.

set_tags()

mod_forum\output\big_search_form::set_tags

(

$value

)

Set tags.

Parameters

mixed

$value

Tags.

set_user()

mod_forum\output\big_search_form::set_user

(

$value

)

Set user.

Parameters

mixed

$value

User.

set_words()

mod_forum\output\big_search_form::set_words

(

$value

)

Set words.

Parameters

mixed

$value

Words.

---

The documentation for this class was generated from the following file:

• mod/forum/classes/output/big_search_form.php