Output

Get a key from the session

Set a key in the session

Forget a key in the session

Flush the session

Return the original $_POST array

Pull a keyed variable from the original LTI post data in the current session with default

Update a keyed variable from the original LTI post data in the current session with default

Pull a keyed variable from the original LTI post data in the current session with default

Pull out a custom variable from the LTIX session. Do not include the "custom_" prefix - this is automatic.

Set the JSON header

Start the header material of a normal Tsugi Page

This outputs everything but does not close the tag so the tool can add its own head material before calling bodyStart().

If this class is set to buffer, the output is returned in a string instead of being printed to the response.

Set the header variables for a Tsugi Page

If this class is set to buffer, the output is returned in a string instead of being printed to the response.

Finish the head and start the body of a Tsugi HTML page.

By default this demands that we are in a GET request. It is a fatal error to call this code if we are responding to a POST request unless this behavior is overidden.

Outputs a splash page used if the tool is not configured or instructor has never been there before.

templateInclude - Include a handlebars template, dealing with i18n

Deprecated - Moved to HandleBars

templateProcess - Process a handlebars template, dealing with i18n

Deprecated - Moved to HandleBars

getUtilUrl - Get a URL in the utility script space - does not add session

Handle the heartbeat calls. This is UI code basically.

Make sure when you call this, you have handled whether the session is cookie based or not and included config.php appropriately

if ( isset($_GET[session_name()]) ) { $cookie = false; } else { define('COOKIE_SESSION', true); $cookie = true; }

require_once "../config.php";

\Tsugi\UI\Output::handleHeartBeat($cookie);

Welcome the user to the course

Emit a properly styled done button for use in the launched frame/window

This is a bit tricky because custom settings can control the "Done" behavior. These settings can come from one of three places: (1) in the link settings, (2) from a custom parameter named 'done', or (3) from a GET parameter done=

The value for this is a URL, "_close", or "_return".

TODO: Implement _return

Emit a properly styled close button for use in own popup

Set header Content for any Tsugi-generated pages.

Set footer Content for any Tsugi-generated pages.

Store the top navigation in the session

Emit the top navigation block and optionally the tool navigation

Priority order: (1) Navigation in the session (2) If we are launched via LTI w/o a session

The embedded menu - for now just one button.

..

Dump a debug array with messages and optional detail

This kind of debug array comes back from some of the grade calls. We loop through printing the messages and put the detail into a togglable pre tag is present.

Get a fully-qualified URL for the spinner.

Get a fully-qualified URL for the default icon image.

Return the text for a full-screen loader

echo($OUTPUT->getScreenOverlay(false)); ...

Embed a YouTube video using the standard pattern

Redirect to a local URL, adding session if necessary

Note that this is only needed for AJAX and header() calls as <form> and <a href tags are properly handled already by the PHP built-in "don't use cookies for session" support.

Gets an absolute static path to the specified file

Retrieves or generates a theme based on optional specs (base color, dark mode flag).

$TSUGI_LAUNCH theme data is provided, it will override the $CFG data. Otherwise, $CFG theme data will be used (either a theme_base or legacy theme data) If $CFG and $TSUGI_LAUNCH theme data aren't provided, regular defaults will be used.

Adjust the theme from various places based on the following low-to-high precedence

(4) From a Key Setting (3) From a Context Setting (2) From a Link Setting (1) From a custom launch variable prefixed by "tsugi_theme_"