Forum Class Reference

Inheritance diagram for Forum:

Collaboration diagram for Forum:

Public Member Functions
	getForumCategories ($course_id)
	createForumCategory ($course_id)
	getForumCategory ($category_id)
	updateForumCategory ($category_id)
	deleteForumCategory ($category_id)
	getCategoryEntries ($category_id)
	appendForumEntry ($category_id)
	getForumEntry ($entry_id)
	addForumEntry ($parent_id)
	updateForumEntry ($entry_id)
	deleteForumEntry ($entry_id)
	convertEntry ($raw)
Public Member Functions inherited from RouteMap
	__construct ()
	init ($router, $route)
	paginated ($data, $total, $uri_params=[], $query_params=[])
	paginate ($uri_format, $total, $offset=null, $limit=null)
	collect ($data)
	status ($status)
	headers ($headers=[])
	body ($body)
	contentType ($mime_type, $params=[])
	error ($status, $body=null)
	etag ($value, $strong_etag=true, $new_resource=null)
	expires ($amount, $cache_control=[])
	cacheControl ($values)
	halt ()
	lastModified ($time)
	notFound ($body=null)
	redirect ($url, $args=null)
	sendFile ($_path, $opts=[])
	url ($addr, $url_params=null)
	urlf ($addr_f, $format_params, $url_params=null)
	getRoutes ($http_method=null)

Static Public Member Functions
static	before ()

Additional Inherited Members
Protected Member Functions inherited from RouteMap
	extractConditions ($docblock, $conditions=[])
Protected Attributes inherited from RouteMap
	$pagination = false
	$offset
	$limit

Detailed Description

Author

mlunz.nosp@m.ena@.nosp@m.uos.d.nosp@m.e @license GPL 2 or later @condition course_id ^[a-f0-9]{32}$

Member Function Documentation

addForumEntry()

addForumEntry

(

$parent_id

)

Add a new forum entry to an existing one

Postcondition

/forum_entry/:entry_id

Here is the call graph for this function:

appendForumEntry()

appendForumEntry

(

$category_id

)

Add a new forum entry to an existing one

Postcondition

/forum_category/:category_id/areas

Here is the call graph for this function:

before()

static before ( )

static

convertEntry()

convertEntry

(

$raw

)

Here is the call graph for this function:

createForumCategory()

createForumCategory

(

$course_id

)

Create a new category

Postcondition

/course/:course_id/forum_categories

Here is the call graph for this function:

deleteForumCategory()

deleteForumCategory

(

$category_id

)

Delete a category

@delete /forum_category/:category_id

Here is the call graph for this function:

deleteForumEntry()

deleteForumEntry

(

$entry_id

)

Delete an entry

@delete /forum_entry/:entry_id

Here is the call graph for this function:

getCategoryEntries()

getCategoryEntries

(

$category_id

)

Show entries of a category

@get /forum_category/:category_id/areas

Here is the call graph for this function:

getForumCategories()

getForumCategories

(

$course_id

)

List all categories of a forum

@get /course/:course_id/forum_categories

Here is the call graph for this function:

getForumCategory()

getForumCategory

(

$category_id

)

Read a category

@get /forum_category/:category_id

Here is the call graph for this function:

getForumEntry()

getForumEntry

(

$entry_id

)

Get a forum entry

@get /forum_entry/:entry_id

Here is the call graph for this function:

updateForumCategory()

updateForumCategory

(

$category_id

)

Update a category

@put /forum_category/:category_id

Here is the call graph for this function:

updateForumEntry()

updateForumEntry

(

$entry_id

)

Update an existing one forum entry

@put /forum_entry/:entry_id

Here is the call graph for this function:

---

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

• app/routes/Forum.php