Stud.IP  5.4
Course_Forum_IndexController Class Reference
Inheritance diagram for Course_Forum_IndexController:
ForumController StudipController

Public Member Functions

 enter_seminar_action ()
 
 index_action ($topic_id=null, $page=null)
 
 newest_action ($page=null)
 
 latest_action ($page=null)
 
 favorites_action ($page=null)
 
 search_action ($page=null)
 
 add_entry_action ()
 
 delete_entry_action ($topic_id)
 
 update_entry_action ($topic_id)
 
 move_thread_action ($thread_id, $destination)
 
 set_favorite_action ($topic_id)
 
 unset_favorite_action ($topic_id)
 
 goto_page_action ($topic_id, $section, $page)
 
 like_action ($topic_id)
 
 dislike_action ($topic_id)
 
 close_thread_action ($topic_id, $redirect, $page=0)
 
 open_thread_action ($topic_id, $redirect, $page=0)
 
 make_sticky_action ($topic_id, $redirect, $page=0)
 
 make_unsticky_action ($topic_id, $redirect, $page=0)
 
 add_category_action ()
 
 remove_category_action ($category_id)
 
 edit_category_action ($category_id)
 
 savecats_action ()
 
 abo_action ($topic_id)
 
 remove_abo_action ($topic_id)
 
 pdfexport_action ($parent_id=null)
 
 rescue ($exception)
 
- Public Member Functions inherited from ForumController
 getId ()
 
 before_filter (&$action, &$args)
 
- Public Member Functions inherited from StudipController
 before_filter (&$action, &$args)
 
 erase_response ()
 
 perform ($unconsumed_path)
 
 after_filter ($action, $args)
 
 validate_args (&$args, $types=null)
 
 url_for ($to='')
 
 link_for ($to='')
 
 redirect ($to)
 
 relocate ($to)
 
 rescue ($exception)
 
 render_json ($data)
 
 render_csv ($data, $filename=null, $delimiter=';', $enclosure='"')
 
 render_file ( $file, $filename=null, $content_type=null, $content_disposition='attachment', Closure $callback=null, $chunk_size=262144)
 
 render_temporary_file ( $file, $filename=null, $content_type=null, $content_disposition='attachment', Closure $callback=null, $chunk_size=262144)
 
 render_form (\Studip\Forms\Form $form)
 
 relay ($to_uri)
 
 relayWithRedirect (... $args)
 
 perform_relayed ($unconsumed)
 
 render_template_as_string ($template, $layout=null)
 
 __call ($method, $arguments)
 
 has_action ($action)
 
 action_url ($action)
 
 action_link ($action)
 
 validate_datetime ($datetime, $format='H:i')
 
 render_spreadsheet (array $header, array $data, string $format, string $filename, ?string $filepath=null)
 

Additional Inherited Members

- Protected Member Functions inherited from StudipController
 render_pdf (TCPDF $pdf, $filename, $inline=false)
 
 controller_path ()
 
 getBodyElementIdForControllerAndAction ($unconsumed_path)
 
- Protected Attributes inherited from ForumController
 $with_session = true
 
- Protected Attributes inherited from StudipController
 $with_session = false
 
 $allow_nobody = true
 
 $_autobind = false
 

Member Function Documentation

◆ abo_action()

abo_action (   $topic_id)

◆ add_category_action()

add_category_action ( )

Add submitted category to current course

◆ add_entry_action()

add_entry_action ( )

Add a new entry. Has a simple spambot protection and checks the parent_id to add the entry to, throwing an exception if missing.

Exceptions
Exception

◆ close_thread_action()

close_thread_action (   $topic_id,
  $redirect,
  $page = 0 
)

This action is used to close a thread.

Parameters
string$topic_idthe topic which will be closed
string$redirectthe topic which will be shown after closing the thread
int$pagethe page number of the topic $redirect

◆ delete_entry_action()

delete_entry_action (   $topic_id)

Delete the submitted entry.

Parameters
string$topic_idthe entry to delete

◆ dislike_action()

dislike_action (   $topic_id)

Remove like for the submitted topic

Parameters
string$topic_idthe topic to unlike

◆ edit_category_action()

edit_category_action (   $category_id)

Change the name of the submitted category

Parameters
string$category_idthe category to edit

◆ enter_seminar_action()

enter_seminar_action ( )

redirect to correct page (overview or newest entries), depending on whether there are any entries.

◆ favorites_action()

favorites_action (   $page = null)

show the current users favorized entries

Parameters
int$pageshow entries on submitted page

◆ goto_page_action()

goto_page_action (   $topic_id,
  $section,
  $page 
)

Jump to page in the entries of the submitted parent-entry denoted by the submitted context (section)

Parameters
string$topic_idthe parent-topic to goto
string$sectionthe type of view (one of index/search)
int$pagethe page to jump to

◆ index_action()

index_action (   $topic_id = null,
  $page = null 
)

the main action for the forum. May be called with a topic_id to be displayed and optionally the page to display

Parameters
type$topic_idthe topic to display, defaults to the main view of the current seminar
type$pagethe page to be displayed (for thread-view)

◆ latest_action()

latest_action (   $page = null)

show all latest entries as flat list

Parameters
int$pageshow entries on submitted page

◆ like_action()

like_action (   $topic_id)

Like the submitted topic

Parameters
string$topic_idthe topic to like

◆ make_sticky_action()

make_sticky_action (   $topic_id,
  $redirect,
  $page = 0 
)

This action is used to mark a thread as sticky.

Parameters
string$topic_idthe topic which will be marked as sticky.
string$redirectthe topic which will be shown afterwards
int$pagethe page number of the topic $redirect

◆ make_unsticky_action()

make_unsticky_action (   $topic_id,
  $redirect,
  $page = 0 
)

This action is used to remove the sticky attribute from a topic.

Parameters
string$topic_idthe topic which will be marked as unsticky.
string$redirectthe topic which will be shown afterwards
int$pagethe page number of the topic $redirect

◆ move_thread_action()

move_thread_action (   $thread_id,
  $destination 
)

Move the submitted thread to the submitted parent

Parameters
string$thread_idthe thread to move
string$destinationthe threads new parent

◆ newest_action()

newest_action (   $page = null)

show newest entries

Parameters
int$pageshow entries on submitted page

◆ open_thread_action()

open_thread_action (   $topic_id,
  $redirect,
  $page = 0 
)

This action is used to open a thread.

Parameters
string$topic_idthe topic which will be opened
string$redirectthe topic which will be shown after opening the thread
int$pagethe page number of the topic $redirect

◆ pdfexport_action()

pdfexport_action (   $parent_id = null)

Generate a pdf-export for the whole forum or the passed subtree

Parameters
string$parent_id

◆ remove_abo_action()

remove_abo_action (   $topic_id)

Unsubscribe from the passed topic

Parameters
string$topic_id

◆ remove_category_action()

remove_category_action (   $category_id)

◆ rescue()

rescue (   $exception)

◆ savecats_action()

savecats_action ( )

Save the ordering of the categories

◆ search_action()

search_action (   $page = null)

show search results

Parameters
int$pageshow entries on submitted page

◆ set_favorite_action()

set_favorite_action (   $topic_id)

Mark the submitted entry as favorite

Parameters
string$topic_idthe entry to mark

◆ unset_favorite_action()

unset_favorite_action (   $topic_id)

Remove the submtted entry as favorite

Parameters
string$topic_idthe entry to unmark

◆ update_entry_action()

update_entry_action (   $topic_id)

Update the submitted entry.

Parameters
string$topic_idid of the entry to update
Exceptions
AccessDeniedException

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