DiscussionsUi
in package
Discussion pages shared by the controller and the tool/tdiscus launch shell.
Page methods return a path to redirect to, or null after they have rendered.
Table of Contents
Constants
- paginator_width : mixed = 7
Properties
- $urls : DiscussionUrls|null
Methods
- analyticsPage() : string|null
- Instructor analytics for this discussion's link. The tool shell keeps its own /analytics page.
- apiAddSubComment() : string|null
- apiSetBoolean() : string|null
- bind() : mixed
- commentFormPage() : string|null
- commentRemovePage() : string|null
- displayNameHtmlFromRow() : mixed
- renderComment() : mixed
- threadFormPage() : string|null
- threadListPage() : string|null
- threadPage() : string|null
- threadRemovePage() : string|null
- toolUrls() : mixed
- addComment() : mixed
- addSubComment() : mixed
- ckeditorFooter() : mixed
- ckeditorLoad() : mixed
- finish() : mixed
- ltiOrigin() : mixed
- paginator() : mixed
- renderBooleanScript() : mixed
- renderBooleanSwitch() : mixed
- renderControllerSettings() : mixed
- renderThreadRow() : mixed
- renderToggle() : mixed
- searchBox() : mixed
- urls() : mixed
- useLaunchSettings() : mixed
- The LTI settings dialog writes the global launch link. Use it only when that link is the discussion on this request.
Constants
paginator_width
public
mixed
paginator_width
= 7
Properties
$urls
private
static DiscussionUrls|null
$urls
= null
Methods
analyticsPage()
Instructor analytics for this discussion's link. The tool shell keeps its own /analytics page.
public
static analyticsPage() : string|null
Return values
string|nullapiAddSubComment()
public
static apiAddSubComment([mixed $afterComment = null ]) : string|null
Parameters
- $afterComment : mixed = null
Return values
string|null —Error text, or null after the fragment is rendered
apiSetBoolean()
public
static apiSetBoolean(mixed $kind, mixed $id, mixed $column, mixed $value) : string|null
Parameters
- $kind : mixed
- $id : mixed
- $column : mixed
- $value : mixed
Return values
string|nullbind()
public
static bind(DiscussionUrls $urls) : mixed
Parameters
- $urls : DiscussionUrls
commentFormPage()
public
static commentFormPage(mixed $commentId) : string|null
Parameters
- $commentId : mixed
Return values
string|nullcommentRemovePage()
public
static commentRemovePage(mixed $commentId) : string|null
Parameters
- $commentId : mixed
Return values
string|nulldisplayNameHtmlFromRow()
public
static displayNameHtmlFromRow(array<string, mixed> $row) : mixed
Parameters
- $row : array<string, mixed>
renderComment()
public
static renderComment(mixed $thread_id, array<string, mixed> $comment) : mixed
Parameters
- $thread_id : mixed
- $comment : array<string, mixed>
threadFormPage()
public
static threadFormPage([int|null $threadId = null ]) : string|null
Parameters
- $threadId : int|null = null
Return values
string|nullthreadListPage()
public
static threadListPage() : string|null
Return values
string|nullthreadPage()
public
static threadPage(mixed $threadId[, callable|null $afterComment = null ]) : string|null
Parameters
- $threadId : mixed
- $afterComment : callable|null = null
-
Called after a successful reply. The tool uses this for grade passback.
Return values
string|nullthreadRemovePage()
public
static threadRemovePage(mixed $threadId) : string|null
Parameters
- $threadId : mixed
Return values
string|nulltoolUrls()
public
static toolUrls() : mixed
addComment()
private
static addComment(mixed $thread_id) : mixed
Parameters
- $thread_id : mixed
addSubComment()
private
static addSubComment(mixed $html_id, mixed $thread_id, mixed $comment_id) : mixed
Parameters
- $html_id : mixed
- $thread_id : mixed
- $comment_id : mixed
ckeditorFooter()
private
static ckeditorFooter() : mixed
ckeditorLoad()
private
static ckeditorLoad() : mixed
finish()
private
static finish(mixed $withBoolean, mixed $withEditor) : mixed
Parameters
- $withBoolean : mixed
- $withEditor : mixed
ltiOrigin()
private
static ltiOrigin() : mixed
paginator()
private
static paginator(mixed $baseurl, mixed $start, mixed $pagesize, mixed $total) : mixed
Parameters
- $baseurl : mixed
- $start : mixed
- $pagesize : mixed
- $total : mixed
renderBooleanScript()
private
static renderBooleanScript() : mixed
renderBooleanSwitch()
private
static renderBooleanSwitch(mixed $type, mixed $thread_id, mixed $variable, mixed $title, mixed $value, mixed $set, mixed $icon[, mixed $color = false ]) : mixed
Parameters
- $type : mixed
- $thread_id : mixed
- $variable : mixed
- $title : mixed
- $value : mixed
- $set : mixed
- $icon : mixed
- $color : mixed = false
renderControllerSettings()
private
static renderControllerSettings() : mixed
renderThreadRow()
private
static renderThreadRow(array<string, mixed> $thread, mixed $has_read_baseline) : mixed
Parameters
- $thread : array<string, mixed>
- $has_read_baseline : mixed
renderToggle()
private
static renderToggle(mixed $title, mixed $id, mixed $icon[, mixed $color = false ]) : mixed
Parameters
- $title : mixed
- $id : mixed
- $icon : mixed
- $color : mixed = false
searchBox()
private
static searchBox([mixed $sortby = false ]) : mixed
Parameters
- $sortby : mixed = false
urls()
private
static urls() : mixed
useLaunchSettings()
The LTI settings dialog writes the global launch link. Use it only when that link is the discussion on this request.
private
static useLaunchSettings() : mixed