Users
extends Admin
in package
Site admin console, mounted by admin/route-controller.php.
The passphrase session ($_SESSION['admin'] === 'yes') is the only administrator. Each action passes a capability name. That session is allowed every capability. A later tenant admin or organization admin can be given a subset of those names and a scope on the same actions.
Paths are relative to /admin because the front controller lives there. Symfony's path info is /catalog for /admin/catalog.
Table of Contents
Constants
- ROUTE : mixed = '/admin'
- SESSION_LESSONS_GRADE_REFRESH_AFTER_LAUNCH : mixed = 'tsugi_lessons_refresh_grades_on_view'
- When set after an outbound LTI 1.1 launch, the next {@see \Tsugi\Controllers\Lessons::get()} or {@see \Tsugi\Controllers\LaunchController::returnFromTool()} run clears the grade cache via {@see applyGradeRefreshAfterLaunchReturn()}.
Properties
- $capability : string
Methods
- applyGradeRefreshAfterLaunchReturn() : mixed
- After an outbound LTI launch, if {@see SESSION_LESSONS_GRADE_REFRESH_AFTER_LAUNCH} is set, invalidate the current user's grade cache and clear the flag (next page load / return handler).
- beacon() : mixed
- Preview and send one beacon. Does not migrate.
- checkCsrf() : bool
- True when the CSRF token is valid (fail closed). Flashes on failure.
- clear12345() : mixed
- configuredHomeUrl() : string
- Site home for redirects: {@see ConfigInfo::$apphome} when set and non-empty, else {@see ConfigInfo::$wwwroot}.
- courseLocalPrefixes() : array<string|int, string>
- First path segments under the course base that are course content.
- csrfField() : string
- Hidden CSRF_TOKEN input for cookie-session HTML forms that POST to Tsugi.
- csrfOk() : bool
- True when POST CSRF_TOKEN (or X-CSRF-TOKEN) matches the session token, or the browser marks this POST as same-origin.
- csrfRedirect() : bool
- For classic PHP tools that redirect with header('Location').
- detail() : mixed
- determineParentPath() : string
- Static helper to determine the parent path dynamically from the request
- determineToolHome() : string
- Static form of {@see toolHome()} for launch methods that have no instance.
- exitPlusLeftCourse() : mixed
- Stop a Plus launch that opened a site tool.
- index() : mixed
- isCourseRoute() : mixed
- True when this request is /courses/{id}{route}... (not the unprefixed tool URL).
- joinToolHome() : string
- Join a mounted tool home and a suffix without producing `//path`.
- map() : mixed
- outboundContextTitle() : mixed
- Course title for an outbound LTI launch.
- patchProfile() : mixed
- paths() : array<int, string>
- Folder indexes accept the directory, a slash, and index.php.
- plusLeftCourseApplies() : mixed
- True when this request is a Plus launch on a site URL.
- proxy() : mixed
- qaNotice() : mixed
- Warning for the admin console command list when any qa_ setting is turned on.
- requestPath() : string
- REQUEST_URI path with query stripped and a single leading slash.
- requireCsrf() : RedirectResponse|null
- Redirect back to $redirect when the CSRF token is missing or invalid.
- requireCsrfJson() : JsonResponse|null
- JSON 403 when the CSRF token is missing or invalid (no flash).
- requireOutboundLti11LaunchSession() : RedirectResponse|null
- Require LTI consumer session fields needed to sign an outbound LTI 1.1 launch.
- routes() : mixed
- sameOriginPost() : bool
- True when this request is a same-origin navigation (not a cross-site CSRF POST).
- sendLti11LaunchFromContent() : RedirectResponse|string
- Sign a lesson launch from an lti_content row.
- sendLti11LaunchFromLessonsItem() : RedirectResponse|string
- Build and print the auto-submit HTML for an LTI 1.1 basic-lti-launch-request to a tool URL described by a lessons.json / lessons-items item (same shape as {@see \Tsugi\Services\Lessons\LessonsService::getLtiByRlid()}).
- upgrade() : mixed
- appHomeUrl() : string
- App home (home_path, else apphome, else wwwroot).
- assetUrl() : mixed
- Alias for staticUrl() for backward compatibility
- controllerUrl() : string
- Generate URL to another controller
- courseFileBaseUrl() : string
- Current course base URL for Common Cartridge file-base rewriting.
- courseRequiredHtml() : string
- databaseReady() : mixed
- exitCourseRequired() : mixed
- A site tool such as grades was opened with no course.
- externalLinkAttrs() : array<string|int, mixed>
- Get link attributes for external vs same-site URLs
- gate() : RedirectResponse|Response|null
- here() : mixed
- Absolute URL of this admin request, without a query string.
- isAdmin() : bool
- Check if the current user is a site administrator
- isInstructor() : bool
- Check if the current logged-in user is an instructor/admin for the current context
- leavePageReturnScript() : string
- Point Continue at this tab's launch return before footer scripts replace TSUGI_SESSION_DATA with the current page.
- lmsAnalyticsKey() : string
- Build a stable key for LMS analytics, distinct from LTI resource_link_id values.
- lmsAnalyticsPath() : string
- Build a stable path identifier for LMS tools (no query/session params).
- lmsEnsureAnalyticsLink() : int|false
- Ensure there is an `lti_link` row for a local LMS page/tool and return link_id.
- lmsRecordLaunchAnalytics() : int|false
- Record LMS page/tool "launch" into Tsugi internal analytics, mirroring LTIX behavior.
- lockScreen() : RedirectResponse|Response
- plusLeftCourseHtml() : string
- renderLeavePage() : string
- Error page with Close Tab and Continue.
- requireAuth() : mixed
- Check authentication and context
- requireGlobalRoute() : RedirectResponse|null
- Bounce a course-mounted URL to a global (unprefixed) URL.
- requireInstructor() : bool
- Check if user is instructor/admin, redirect if not
- showAnalytics() : string
- Display analytics for an LMS tool
- staticUrl() : string
- Generate URL for a controller-specific static file (JS, CSS, etc.)
- toolHome() : string
- Get the base path for this tool (e.g., '/py4e/pages' or '/courses/2/pages')
- toolParent() : string
- Get the parent path one level above the tool home
- unlockPost() : RedirectResponse|null
- view() : mixed
- Run a page that used to be a script under admin/.
- viewDueDates() : bool
- Whether the current user may see due dates in this context (lti_membership.viewDueDates).
Constants
ROUTE
public
mixed
ROUTE
= '/admin'
SESSION_LESSONS_GRADE_REFRESH_AFTER_LAUNCH
When set after an outbound LTI 1.1 launch, the next {@see \Tsugi\Controllers\Lessons::get()} or {@see \Tsugi\Controllers\LaunchController::returnFromTool()} run clears the grade cache via {@see applyGradeRefreshAfterLaunchReturn()}.
public
mixed
SESSION_LESSONS_GRADE_REFRESH_AFTER_LAUNCH
= 'tsugi_lessons_refresh_grades_on_view'
Properties
$capability
protected
string
$capability
= 'admin'
Capability for this action. The passphrase session allows all of them.
Methods
applyGradeRefreshAfterLaunchReturn()
After an outbound LTI launch, if {@see SESSION_LESSONS_GRADE_REFRESH_AFTER_LAUNCH} is set, invalidate the current user's grade cache and clear the flag (next page load / return handler).
public
static applyGradeRefreshAfterLaunchReturn() : mixed
beacon()
Preview and send one beacon. Does not migrate.
public
beacon() : mixed
checkCsrf()
True when the CSRF token is valid (fail closed). Flashes on failure.
public
static checkCsrf() : bool
Return values
boolclear12345()
public
clear12345() : mixed
configuredHomeUrl()
Site home for redirects: {@see ConfigInfo::$apphome} when set and non-empty, else {@see ConfigInfo::$wwwroot}.
public
static configuredHomeUrl() : string
Return values
string —Non-empty path or URL (defaults to '/')
courseLocalPrefixes()
First path segments under the course base that are course content.
public
static courseLocalPrefixes() : array<string|int, string>
Passed into CCFileBase so that util does not know about controllers. Login, logout, admin, profile, and similar non-content routes are omitted.
Return values
array<string|int, string>csrfField()
Hidden CSRF_TOKEN input for cookie-session HTML forms that POST to Tsugi.
public
static csrfField() : string
Mints a session token if the current session does not have one yet (Google site login historically did not set CSRF_TOKEN; LTI launch does). Do not use this on LTI launches or signed webhooks.
Return values
stringcsrfOk()
True when POST CSRF_TOKEN (or X-CSRF-TOKEN) matches the session token, or the browser marks this POST as same-origin.
public
static csrfOk() : bool
Cookie-session pages (admin unlock) can lose the GET session cookie on the following POST; Chrome still sends Sec-Fetch-Site/Origin, which is enough to reject cross-site CSRF. LTI launches must not use this helper.
Return values
boolcsrfRedirect()
For classic PHP tools that redirect with header('Location').
public
static csrfRedirect(string $url) : bool
Parameters
- $url : string
-
Already session-bearing Location target.
Return values
bool —True when the caller should return (token was bad).
detail()
public
detail() : mixed
determineParentPath()
Static helper to determine the parent path dynamically from the request
public
static determineParentPath([string|null $route = null ]) : string
This is useful for static methods that need to determine the base path without having a Tool instance. It uses the same logic as toolParent() but works as a static method.
Parameters
- $route : string|null = null
-
Optional route to look for (if null, tries to detect from request)
Return values
string —The parent path (e.g., '/py4e' or '/ca4e/tsugi')
determineToolHome()
Static form of {@see toolHome()} for launch methods that have no instance.
public
static determineToolHome(string $route) : string
On a course-mounted page, a sibling tool keeps /courses/{id} even when
$route is not in this REQUEST_URI (Lessons → Quiz1).
Parameters
- $route : string
-
The route constant (e.g., '/discussions')
Return values
string —The mounted tool path (e.g., '/courses/2/discussions')
exitPlusLeftCourse()
Stop a Plus launch that opened a site tool.
public
static exitPlusLeftCourse() : mixed
The Tsugi router calls this before every Tool action. A route that is a closure has to call it itself. The page offers the launch course, Log out, and Close Tab. Close Tab is disabled while the browser tries to close the window. If the tab is still open after three seconds, that button is removed and the page says it could not close.
index()
public
index() : mixed
isCourseRoute()
True when this request is /courses/{id}{route}... (not the unprefixed tool URL).
public
static isCourseRoute([string|null $route = null ]) : mixed
Nested course dispatch rewrites pathInfo to $route but leaves REQUEST_URI unchanged, so this is the reliable split between a global tool URL and a course-mounted one. Do not use ReqScope::currentContextId() here — a global visit can still have a course in session.
Uses static::ROUTE unless $route is passed. Controllers without ROUTE return false unless $route is given.
Parameters
- $route : string|null = null
-
Tool path including leading slash (e.g. '/settings')
joinToolHome()
Join a mounted tool home and a suffix without producing `//path`.
public
static joinToolHome(string $home, string $suffix) : string
Parameters
- $home : string
-
toolHome() result
- $suffix : string
-
id or extra path (leading slash optional)
Return values
stringmap()
public
static map(Application $app, class-string $class, mixed $method, array<int, string> $paths) : mixed
Parameters
- $app : Application
- $class : class-string
- $method : mixed
- $paths : array<int, string>
outboundContextTitle()
Course title for an outbound LTI launch.
public
static outboundContextTitle() : mixed
Precedence: $_SESSION['context_title'], then the LTI session context_title, then $CFG->context_title.
Sending the site default here used to overwrite lti_context.title via adjustData.
patchProfile()
public
patchProfile() : mixed
paths()
Folder indexes accept the directory, a slash, and index.php.
public
static paths(mixed $urlPath[, mixed $folder = false ]) : array<int, string>
Scripts accept the bare name, a slash, and .php.
Parameters
- $urlPath : mixed
- $folder : mixed = false
Return values
array<int, string>plusLeftCourseApplies()
True when this request is a Plus launch on a site URL.
public
static plusLeftCourseApplies() : mixed
/courses/{id}/… still belongs to the launch. The course id stays in the session. A site tool that needs a course does not use it.
proxy()
public
proxy() : mixed
qaNotice()
Warning for the admin console command list when any qa_ setting is turned on.
public
static qaNotice() : mixed
The unlock form does not call this.
requestPath()
REQUEST_URI path with query stripped and a single leading slash.
public
static requestPath() : string
//courses is a protocol-relative URL (host "courses"). Apache/proxies
sometimes leave a doubled slash in REQUEST_URI; collapse it so tool
links stay /courses/123 instead of //courses/123.
Return values
stringrequireCsrf()
Redirect back to $redirect when the CSRF token is missing or invalid.
public
static requireCsrf(string $redirect) : RedirectResponse|null
Parameters
- $redirect : string
Return values
RedirectResponse|null —Null when the token is valid.
requireCsrfJson()
JSON 403 when the CSRF token is missing or invalid (no flash).
public
static requireCsrfJson([array<string|int, mixed>|null $payload = null ]) : JsonResponse|null
Parameters
- $payload : array<string|int, mixed>|null = null
Return values
JsonResponse|null —Null when the token is valid.
requireOutboundLti11LaunchSession()
Require LTI consumer session fields needed to sign an outbound LTI 1.1 launch.
public
static requireOutboundLti11LaunchSession(Application $app, mixed $redirect_path) : RedirectResponse|null
Parameters
- $app : Application
- $redirect_path : mixed
Return values
RedirectResponse|null —Null if session is sufficient; redirect with flash otherwise.
routes()
public
static routes(Application $app) : mixed
Parameters
- $app : Application
sameOriginPost()
True when this request is a same-origin navigation (not a cross-site CSRF POST).
public
static sameOriginPost() : bool
Return values
boolsendLti11LaunchFromContent()
Sign a lesson launch from an lti_content row.
public
static sendLti11LaunchFromContent(Application $app, array<string, mixed> $row, string $launch_presentation_return_url, string $redirect_path_on_error[, string|null $grade_refresh_session_key = null ]) : RedirectResponse|string
Parameters
- $app : Application
- $row : array<string, mixed>
- $launch_presentation_return_url : string
- $redirect_path_on_error : string
- $grade_refresh_session_key : string|null = null
Return values
RedirectResponse|stringsendLti11LaunchFromLessonsItem()
Build and print the auto-submit HTML for an LTI 1.1 basic-lti-launch-request to a tool URL described by a lessons.json / lessons-items item (same shape as {@see \Tsugi\Services\Lessons\LessonsService::getLtiByRlid()}).
public
static sendLti11LaunchFromLessonsItem(Application $app, object $lti, string $launch_presentation_return_url, string $redirect_path_on_error[, string $fallback_resource_link_title = '' ][, string|null $grade_refresh_session_key = null ]) : RedirectResponse|string
Parameters
- $app : Application
- $lti : object
-
Must have resource_link_id; launch is required for LTI tools (discussions POST to {wwwroot}/tool/tdiscus)
- $launch_presentation_return_url : string
-
Return URL after the external tool
- $redirect_path_on_error : string
-
Session addSession path for flash+redirect on failure
- $fallback_resource_link_title : string = ''
-
Used when $lti->title is missing
- $grade_refresh_session_key : string|null = null
-
If non-null, GradeUtil::invalidateGradesCurrentUser() and set this session key (typically self::SESSION_LESSONS_GRADE_REFRESH_AFTER_LAUNCH)
Return values
RedirectResponse|string —Empty string after HTML is printed; RedirectResponse on session failure only (caller handles other errors)
upgrade()
public
upgrade() : mixed
appHomeUrl()
App home (home_path, else apphome, else wwwroot).
protected
static appHomeUrl() : string
Return values
stringassetUrl()
Alias for staticUrl() for backward compatibility
protected
assetUrl(mixed $filename[, mixed $controllerName = null ]) : mixed
Use staticUrl() instead
Parameters
- $filename : mixed
- $controllerName : mixed = null
controllerUrl()
Generate URL to another controller
protected
controllerUrl(string $controllerRoute[, string|null $currentRoute = null ]) : string
Parameters
- $controllerRoute : string
-
The route of the target controller (e.g., '/pages', '/announcements')
- $currentRoute : string|null = null
-
Optional current route (defaults to detecting from context)
Return values
string —Full URL to the controller
courseFileBaseUrl()
Current course base URL for Common Cartridge file-base rewriting.
protected
courseFileBaseUrl(string $route) : string
Example: https://host/py4e or https://host/courses/2
Parameters
- $route : string
-
The route constant for this tool (e.g. '/pages')
Return values
string —Course base with no trailing slash
courseRequiredHtml()
protected
courseRequiredHtml() : string
Return values
stringdatabaseReady()
protected
databaseReady() : mixed
exitCourseRequired()
A site tool such as grades was opened with no course.
protected
exitCourseRequired() : mixed
Continue uses this tab's LTI return URL when one is stored, and the app home when it is not. A Plus launch never reaches this: the router stops it before the tool action.
externalLinkAttrs()
Get link attributes for external vs same-site URLs
protected
externalLinkAttrs(string $url[, string $linkLabel = 'Learn more' ]) : array<string|int, mixed>
Same-site links open in the current tab; external links get target="_blank" and rel="noopener noreferrer". Uses $CFG->apphome to determine same-site.
Parameters
- $url : string
-
The link URL
- $linkLabel : string = 'Learn more'
-
Optional label for aria-label (default: 'Learn more')
Return values
array<string|int, mixed> —['attrs' => string, 'aria_label' => string, 'external' => bool]
gate()
protected
gate(mixed $capability[, mixed $denied = 'form' ]) : RedirectResponse|Response|null
Parameters
- $capability : mixed
- $denied : mixed = 'form'
Return values
RedirectResponse|Response|null —Null when this request may continue.
here()
Absolute URL of this admin request, without a query string.
protected
here() : mixed
isAdmin()
Check if the current user is a site administrator
protected
isAdmin() : bool
Return values
bool —True if user is admin, false otherwise
isInstructor()
Check if the current logged-in user is an instructor/admin for the current context
protected
isInstructor() : bool
This method checks:
- If user is site admin (passphrase session)
- If user has instructor role or role_override in lti_membership table
- If user owns the context or its key
Reads context via ReqScope::currentContextId(); user id via ReqScope::loggedInUserId() (session or globals). Delegates to Membership::ensureInSession(), which caches a Membership instance in context-scoped session cache via Membership::ensureInSession() (single lti_membership SELECT when missing; ownership query only when role must be resolved).
Return values
bool —True if user is instructor/admin for the context, false otherwise
leavePageReturnScript()
Point Continue at this tab's launch return before footer scripts replace TSUGI_SESSION_DATA with the current page.
protected
static leavePageReturnScript(string $detail) : string
Same read and preference as Output::htmlError: error return, then return URL.
Parameters
- $detail : string
Return values
stringlmsAnalyticsKey()
Build a stable key for LMS analytics, distinct from LTI resource_link_id values.
protected
lmsAnalyticsKey([string|null $path = null ]) : string
Parameters
- $path : string|null = null
Return values
stringlmsAnalyticsPath()
Build a stable path identifier for LMS tools (no query/session params).
protected
lmsAnalyticsPath() : string
Examples:
- /lms/pages
- /lms/assignments
Return values
stringlmsEnsureAnalyticsLink()
Ensure there is an `lti_link` row for a local LMS page/tool and return link_id.
protected
lmsEnsureAnalyticsLink(int $context_id, string $link_key[, string|null $title = null ][, string|null $path = null ]) : int|false
We intentionally store LMS "tools" as synthetic lti_link records scoped to the
already-selected lti_context, so we can reuse the existing analytics tables
(lti_link_activity, lti_link_user_activity) without schema changes.
Parameters
- $context_id : int
- $link_key : string
- $title : string|null = null
- $path : string|null = null
Return values
int|falselmsRecordLaunchAnalytics()
Record LMS page/tool "launch" into Tsugi internal analytics, mirroring LTIX behavior.
protected
lmsRecordLaunchAnalytics(string $analytics_path[, string|null $title = null ]) : int|false
- Only records for learners (i.e., not instructors/admins)
- Stores data in lti_link_activity / lti_link_user_activity with event=0
Parameters
- $analytics_path : string
-
Required stable path for this tool (e.g., '/lms/pages')
- $title : string|null = null
-
Optional display title for this synthetic link
Return values
int|false —The link_id if successful, false otherwise
lockScreen()
protected
lockScreen() : RedirectResponse|Response
Return values
RedirectResponse|ResponseplusLeftCourseHtml()
protected
static plusLeftCourseHtml() : string
Return values
stringrenderLeavePage()
Error page with Close Tab and Continue.
protected
static renderLeavePage(array{title: string, paragraphs: array, home: string} $copy) : string
Continue starts at the app home. The page script points it at this tab's launch return when session storage has one.
Parameters
-
$copy
: array{title: string, paragraphs: array
, home: string}
Return values
stringrequireAuth()
Check authentication and context
protected
requireAuth() : mixed
Tags
requireGlobalRoute()
Bounce a course-mounted URL to a global (unprefixed) URL.
protected
requireGlobalRoute(string $globalUrl) : RedirectResponse|null
Parameters
- $globalUrl : string
-
Already session-bearing when the caller wants a session cookie
Return values
RedirectResponse|nullrequireInstructor()
Check if user is instructor/admin, redirect if not
protected
requireInstructor([string $redirectUrl = null ]) : bool
Parameters
- $redirectUrl : string = null
-
URL to redirect to if not authorized
Return values
bool —True if user is instructor/admin, false otherwise (and redirects)
showAnalytics()
Display analytics for an LMS tool
protected
showAnalytics(string $route[, string|null $title = null ]) : string
Automatically derives back_url and stable_path from the route.
Parameters
- $route : string
-
The route constant (e.g., '/pages', '/announcements')
- $title : string|null = null
-
Optional display title (defaults to route without leading slash, capitalized)
Return values
string —Empty string (outputs HTML directly)
staticUrl()
Generate URL for a controller-specific static file (JS, CSS, etc.)
protected
staticUrl(string $filename[, string|null $controllerName = null ]) : string
Static files are served from tsugi/lib/src/Controllers/static/{ControllerName}/ This method generates the proper URL for accessing these static files.
Parameters
- $filename : string
-
Static filename (e.g., 'tsugi-announce.js')
- $controllerName : string|null = null
-
Optional controller name (defaults to current controller)
Return values
string —Full URL to the static file
toolHome()
Get the base path for this tool (e.g., '/py4e/pages' or '/courses/2/pages')
protected
toolHome(string $route) : string
Looks at the current request URI and finds the tool's route within it, so nested mounts keep generating nested URLs.
Parameters
- $route : string
-
The route constant for this tool (e.g., '/pages', '/announcements')
Return values
string —The base path including the route (e.g., '/py4e/pages')
toolParent()
Get the parent path one level above the tool home
protected
toolParent([string $route = null ]) : string
This is useful for shared resources like static files that are mounted at a common path above individual controllers.
Parameters
- $route : string = null
-
The route constant for this tool (e.g., '/pages', '/announcements')
Return values
string —The parent path (e.g., '/py4e' if toolHome is '/py4e/pages')
unlockPost()
protected
unlockPost() : RedirectResponse|null
Return values
RedirectResponse|nullview()
Run a page that used to be a script under admin/.
protected
view(mixed $template[, array<string|int, mixed> $data = array() ]) : mixed
The include writes the response. Exit so the application does not send a second one.
Parameters
- $template : mixed
- $data : array<string|int, mixed> = array()
viewDueDates()
Whether the current user may see due dates in this context (lti_membership.viewDueDates).
protected
viewDueDates() : bool
Loads Membership via ensureInSession(); for non-admins also calls isInstructor() so the same cached object is used for role checks in mixed call order.