Application
Table of Contents
Interfaces
- ExternalLaunchProvider
- Builds an outbound launch request for an external tool.
- BadgeSharePlatform
- Interface for badge sharing to social media platforms.
Classes
- Access
- BlobUtil
- ConfigInfo
- A class that contains the configuration fields and defaults.
- Activity
- Site admin console, mounted by admin/route-controller.php.
- Badges
- Site admin console, mounted by admin/route-controller.php.
- Blob
- BLOB status, migration, and cleanup screens.
- Catalog
- Site admin console, mounted by admin/route-controller.php.
- Check
- Modal checks linked from the administration console.
- Context
- Site admin console, mounted by admin/route-controller.php.
- Expire
- Site-wide data expiry at /admin/expire.
- External
- Site admin console, mounted by admin/route-controller.php.
- Guid
- GUID column status for the core LTI tables, and a bounded null fill.
- Install
- Installed modules, at /admin/modules.
- Key
- Keys for the passphrase admin.
- Site admin console, mounted by admin/route-controller.php.
- Org
- Site admin console, mounted by admin/route-controller.php.
- Permissions
- Permission tables at /admin/permissions.
- Profile
- Site admin console, mounted by admin/route-controller.php.
- Site
- Site admin console, mounted by admin/route-controller.php.
- Users
- Site admin console, mounted by admin/route-controller.php.
- Admin
- Site admin console, mounted by admin/route-controller.php.
- Analytics
- Base class for Lumos controllers.
- Announcements
- Base class for LMS tool controllers
- Analytics
- LTI/cookieless analytics for the current launch link.
- AnalyticsCookie
- Cookie-session analytics for top-frame LMS tools.
- Annotate
- Annotator storage API.
- GradeSubmit
- POST /api/grade-submit.php
- LtiExtRoster
- LTI 1.1 basic-lis-readmembershipsforcontext.
- Notifications
- Cookie-session notifications endpoint for unread notifications and announcements.
- PoxResult
- LTI 1.1 Outcomes service.
- RecordAttempt
- POST /api/record-attempt.php
- Router
- Maps the first /api/ path segment to the class that used to be that script.
- Rpc
- POST /api/rpc.php
- Settings
- POST /api/settings.php
- Socket
- Approximate web sockets if not present.
- StickyGrader
- Sticky grader annotation store.
- Assignments
- Base class for LMS tool controllers
- Badges
- Base class for LMS tool controllers
- Calendar
- Base class for LMS tool controllers
- Catalog
- Base class for LMS tool controllers
- Content
- Lessons with the module cards in a left column and the selected module on the right.
- Courses
- Base class for LMS tool controllers
- Discussions
- Base class for LMS tool controllers
- DiscussionsUi
- Discussion pages shared by the controller and the tool/tdiscus launch shell.
- DiscussionUrls
- Links for one discussion, either under the controller or under tool/tdiscus.
- Files
- Course files tool (Canvas Files / Sakai Resources style).
- GoogleClassroom
- Google Classroom pages. Public URLs stay /gclass/login, /gclass/assign, /gclass/launch, and /gclass/share.
- Grades
- Base class for LMS tool controllers
- Home
- Course home: site-wide at /home, course-mounted at /courses/{id}/home.
- Ags
- Assignments and Grades for one course.
- Nrps
- GET /ims/nrps/context/{contextId}/memberships
- Token
- POST /lti/token and POST /ims/token.
- Instructor
- Logged-in instructor home for sites that are not the old one-course lessons site.
- Labs
- Labs catalog route (/labs). Site mode (www vs labs) is configured by the host app (e.g. py4e).
- LaunchController
- Outbound LTI 1.1 launches by lessons resource_link_id at /launch/{resource_link_id}.
- Lessons
- Base class for LMS tool controllers
- Login
- Base class for LMS tool controllers
- Logout
- Base class for Lumos controllers.
- Map
- Base class for Lumos controllers.
- Notifications
- Base class for LMS tool controllers
- Outline
- Every module on one page. Module headers and section headings open and close.
- Pages
- Base class for LMS tool controllers
- Profile
- Base class for Lumos controllers.
- Quiz1
- Base class for LMS tool controllers
- ReqScopeDebug
- Temporary dump of ReqScope and the launch object.
- Roster
- Course roster, and the Plus pull log when this course came from an LMS.
- ServiceWorkerController
- ServiceWorker controller for serving service worker JavaScript at /sw.js
- Ses
- Amazon SES → SNS webhook for bounce/complaint events.
- Settings
- Instructor settings: site-wide at /settings, course-mounted at /courses/{id}/settings.
- StaticFiles
- StaticFiles controller for serving controller-specific static files (JS, CSS, etc.)
- Stripe
- Stripe Checkout routes for premium / supporter payments.
- Student
- View this manifest course as one of four course-local test students.
- Tool
- Base class for LMS tool controllers
- Topics
- Base class for LMS tool controllers
- Tsugi
- Lumos application for a Tsugi web request.
- Activity
- Activity utilities
- Admin
- Admin console session.
- Annotate
- Our class to handle annotation storage
- Badges
- Open Badges 2.0 and 3.0 JSON generation utilities
- Cache
- A very simple Cache - currently implemented in session
- ContentItem
- This is a ContentItem class with Tsugi-specific convienences.
- Context
- This is a class to provide access to the resource context level data.
- ContextImages
- 1-1 course branding images on lti_context (hero 16:9 + square icon).
- Debug
- This is a place holder. Other than dumpPost() it needs a bit of work.
- DeepLinkResponse
- This is a general purpose DeepLink class with no Tsugi-specific dependencies.
- Entity
- This is a class holding common functionality to be extended by various other classes.
- Guid
- Printable guids for the four core LTI rows.
- I18N
- Internationalization (i18n) utility class for translation support
- Key
- This is a class to provide access to the resource key level data.
- Keyset
- Helper class for Using Tsugi's internal global outgoing keyset
- Launch
- This captures all of the data associated with the LTI Launch.
- LaunchPresentation
- LTI launch_presentation parameters for this request.
- Link
- This is a class to provide access to the resource link level data.
- LTIX
- This an opinionated LTI class that defines how Tsugi tools interact with LTI
- Mail utilities — delegates to Tsugi\Services\Mail\MailService
- Manifest
- Versioned course manifest, keyed by immutable manifest_id.
- Membership
- The launching user's membership in the current context (lti_membership).
- Profile
- Site profile for a Google-login (or similarly linked) user.
- ReqScope
- Request-scoped Tsugi runtime state for one PHP request.
- ReqScopeException
- ReqScope could not be hydrated from the given ids.
- Rest
- Helper class for Tsugi REST end points
- Result
- This is a class to provide access to the user's result data.
- Roster
- This is a class to provide access to roster information from a site.
- Settings
- This is a class to provide access to the setting service.
- SQLDialect
- This is a helper class for SQL dialect handling
- Tool
- Provide support for a Tsugi Tool
- User
- This is a class to provide access to user data from the LTI launch.
- Aes
- AesCtr
- AesOpenSSL
- Entry
- A adaptive, multi-scale compressed time series of event counter buckets
- GoogleClassroom
- GoogleLogin
- A very simple Google Login
- JWT
- JSON Web Token implementation
- GradeUtil
- SimpleGradeDetail
- UI
- Png
- This is a set of PNG related libraries
- LinkedIn integration helpers for "Add to profile" (Licenses & Certifications).
- Application
- Lumos application for a Tsugi web request.
- Controller
- Base class for Lumos controllers.
- ExceptionHandler
- Exception handler for the Application
- Router
- Router for a Lumos application.
- OAuthConsumer
- OAuthDataStore
- OAuthException
- OAuthRequest
- OAuthServer
- OAuthSignatureMethod
- OAuthSignatureMethod_HMAC_SHA1
- OAuthSignatureMethod_HMAC_SHA256
- OAuthSignatureMethod_PLAINTEXT
- OAuthSignatureMethod_RSA_SHA1
- OAuthToken
- OAuthUtil
- TrivialOAuthDataStore
- A Trivial memory-based store - no support for tokens
- AdminService
- Helpers that used to be required from admin/.
- AnalyticsService
- Launch-activity view model for one resource link.
- BadgeService
- Service for minted badge operations (OB2/OB3).
- CourseBadges
- Badge definitions stored on a course manifest, with pictures in Files Public.
- CourseCopy
- Copy into the current manifest course by exporting a Common Cartridge and letting the import code apply it.
- Decision
- Result of matching one incoming cartridge resource to cc_object rows.
- Fingerprint
- Canonical content hash for one cartridge resource.
- Fixtures
- Tiny mixed Common Cartridge for walker tests (not a Canvas dump).
- Importer
- Import a Common Cartridge into a course: Files, Pages, Quiz1, LTI links, Lessons.
- ImportException
- Thrown when a Common Cartridge zip or imsmanifest.xml cannot be read.
- Matcher
- Classify an incoming cartridge resource against existing cc_object rows.
- Package
- Open a Common Cartridge zip and index imsmanifest.xml (CC 1.1 or 1.2).
- Pending
- Hold an uploaded cartridge zip across the Settings import select step.
- Session
- In-memory Common Cartridge import run: classify, record objects, append log.
- Store
- Persist cc_import / cc_import_log / cc_object rows.
- Walker
- Walk a cartridge zip into a Session (classify + log, no local pages yet).
- Wipe
- Clear a course's importable content so a cartridge can load onto a blank outline.
- CatalogRepository
- Site-wide course_catalog rows. List queries never SELECT hero BLOBs.
- ContextUserSettings
- One row per person per course in lti_context_user_settings.
- CourseNav
- Teacher-edited course top nav: catalog, normalize, compile to MenuSet.
- CourseDelete
- Soft-delete a course, or permanently remove one.
- CoursesService
- Course rules that are not HTTP.
- DiscussionsService
- Thread and comment storage for one discussion.
- ExternalLaunchRequest
- Value object representing an outbound external-tool launch.
- RemoteTsugiLaunchProvider
- Current outbound launch provider for "remote Tsugi tool" forwarding.
- FileRepository
- Course Files tool rows, folders, and hrefs. Does not emit HTTP.
- ClassroomQueue
- Classroom grades waiting on the teacher, and the log of attempts.
- Gradebook
- Store a grade on the lti_result row already loaded in ReqScope.
- GradeCategoryRepository
- Course grade categories and the link columns that sit in them.
- HomeLayout
- Ordered blocks an instructor chooses for the course home page.
- AccessToken
- OAuth 2 client-credentials tokens for LTI Advantage services.
- AssignmentsGrades
- LTI Advantage Assignment and Grade Services, version 2.
- NamesRoles
- LTI Advantage Names and Roles Provisioning Service, version 2.
- PnpConnector
- Personal Needs and Preferences claim on LTI 1.3 launches.
- LessonDue
- Due dates on a lesson item, and on the link once that item has one.
- LessonPublish
- Student access for a lesson assignment. The link's published flag is the value the lesson, the grade book, and Manage due dates all read.
- LessonsCartridge
- Common Cartridge export from an in-memory Lessons document (v2 items).
- LessonsLegacyExport
- File-based lessons.json Common Cartridge zip.
- LessonsLegacyFiles
- Legacy /cc/export helper: turn same-server public file URLs into cartridge bytes.
- LessonsLegacyGift
- Legacy /cc/export helper: optionally turn GIFT LTI launches into QTI assessments.
- LessonsNormalize
- Canonical Lessons item model and lossless legacy normalizer.
- LessonsService
- GoogleLoginResult
- Outcome of a Google site login attempt.
- GoogleLoginService
- Google site login: OAuth callback, then the google.com user, site course, and session.
- MailService
- Outbound mail: Amazon SES when configured, otherwise PHP mail().
- OrgScope
- One organization and its ancestors or descendants, as a SQL relation.
- OrgService
- Tenant-scoped organization tree.
- Lti11CourseTool
- The course Settings form for an LTI 1.1 tool on that course.
- Lti11TestLaunch
- A signed LTI 1.1 test launch for a tool this course can already see.
- Lti13CourseTool
- Course Settings editor for one LTI 1.3 registration this course owns.
- Lti13TestLaunch
- A signed LTI 1.3 resource-link test for a tool this course can already see.
- LtiContentService
- One outbound launch. A lesson item stores content_id. Launch fields live here.
- LtiLessonPlacement
- Lesson placements for one LTI 1.3 deployment.
- PlatformDynamicRegistration
- IMS Dynamic Registration with Tsugi as the platform.
- ToolDeploymentGrant
- What a deployment is willing to release from the registration's request.
- ToolDeploymentService
- One LTI deployment of an outbound registration, and where it may be used.
- ToolMessagePlacement
- Which placements a known LTI message type may carry.
- ToolPlacementService
- Placements a registered message can use, and which of those a deployment enables.
- ToolRegistrationDocument
- Parsed Dynamic Registration state, plus the raw protocol log.
- ToolRegistrationService
- Outbound LTI tool registration inside one tenant key.
- PageRepository
- Load and persist course wiki pages and page_history. Does not emit HTTP.
- Permission
- In-memory registry of permissions declared by services.
- PermissionTables
- Admin reads and writes for the permission tables.
- GradeSync
- Push a Plus course column and its scores to the controlling LMS.
- PlusShell
- Course-navigation launch for a Plus course.
- RosterSync
- Keep a Plus course roster in step with the controlling LMS.
- Answer
- One answer alternative or accepted response. Semantic, not GIFT/QTI syntax.
- CartridgeFixtures
- Isolated Common Cartridge 1.2 fixtures for LMS interoperability testing.
- CartridgeValidator
- Structural checks for a Quiz1 Common Cartridge 1.2 package.
- ExportException
- Thrown when a quiz cannot be exported as valid Common Cartridge QTI.
- GiftExporter
- Serialize a Quiz1 quiz as Moodle GIFT text.
- GiftImporter
- Parse Moodle GIFT into a format-neutral Quiz1 quiz.
- Grader
- Score a Quiz1 quiz from submitted student responses.
- Html
- Safe HTML for quiz prompts and answers, using HTMLPurifier like Discussions.
- ImportException
- Thrown when GIFT or QTI cannot be turned into a Quiz1 quiz.
- Qti12Exporter
- Serialize a Quiz1 quiz as Common Cartridge QTI 1.2.1 assessment XML.
- Qti12Importer
- Parse Common Cartridge QTI 1.2.1 (and close cousins) into a Quiz1 quiz.
- Question
- One quiz question in the format-neutral Quiz1 model.
- QuestionTypes
- Semantic question types for Quiz1 (not QTI element names).
- Quiz1
- Format-neutral quiz: title, instructions, ordered questions.
- Quiz1Repository
- Load and persist Quiz1 semantic records. Does not know about QTI XML.
- SampleQuiz1
- Representative quiz exercising every Common Cartridge QTI question type.
- Service
- Base class for Tsugi services.
- DynamicRegistration
- LTI Advantage dynamic registration (LMS OpenID config + client registration).
- Expire
- PII / record-expiry helpers for the Settings controller.
- Site
- Installation-wide site config. One row (site_id = 1).
- StudentView
- Instructor "view as student" for one manifest course.
- Analytics
- Old class name for LTI tools outside this repo.
- Annotate
- Our class to handle annotation markup
- BadgeShareHead
- Generates Open Graph and Twitter Card meta tags for badge assertion pages.
- BadgeShareRegistry
- Registry of badge share platforms. Returns platform instances without a case statement.
- BlueskyShare
- Share badge to Bluesky via compose intent.
- FacebookShare
- Share badge to Facebook via sharer.
- LinkedInShare
- Share badge to LinkedIn (post/share, distinct from adding to LinkedIn certificate).
- TwitterShare
- Share badge to Twitter/X via web intent.
- CKEditor
- CKEditor 5 helper for Tsugi applications.
- CrudForm
- This is a class that supports the creation of simple CRUD forms.
- DemoLogin
- Config-gated simulated Google site login (no Google account).
- HandleBars
- This is a class that suports the HandleBars use cases in Tsugi
- Lessons
- Old class name for LTI tools outside this repo.
- Menu
- Our class to generate menus
- MenuEntry
- Our class to generate menus
- MenuSet
- Our class to capture a set of top menus
- Output
- Pages
- Utility class for Pages functionality
- SettingsDialog
- SettingsForm
- Supporter
- Supporter / premium status UI shared across learner pages.
- Table
- Our class to generate pageable tables.
- Theme
- Topics
- Autograder
- Shared helpers for Tsugi autograder tools (WebGrader, PythonGrader, DBGrader, …).
- Caliper
- This is a general purpose LTI class with no Tsugi-specific dependencies.
- CanvasAssessmentMeta
- Canvas course-export quiz settings (assessment_meta.xml).
- CanvasModuleMeta
- This class allows us to produce the Canvas course_settings/module_meta.xml extension in a CC
- CC
- This class allows us to produce an IMS Common Cartridge (1.2 by default, 1.1 for Moodle).
- CC_LTI
- Wrap the DOMDocument class with some convienence methods
- CC_LTI_Outcome
- Wrap the DOMDocument class with some convienence methods
- CC_Topic
- Wrap the DOMDocument class with some convienence methods
- CC_WebLink
- Wrap the DOMDocument class with some convienence methods
- CCFileBase
- Expand and canonicalize Common Cartridge course-local URLs in HTML.
- CCIdentifier
- Utility class for generating deterministic, hash-based identifiers for IMS Common Cartridge exports.
- Color
- ContentItem
- This is a general purpose ContentItem class with no Tsugi-specific dependencies.
- DeepLinkRequest
- This is a general purpose DeepLinkRequest class
- DeepLinkResponse
- This is a general purpose DeepLink class with no Tsugi-specific dependencies.
- FakeName
- Some really small, simple, and self-contained utility public static functions
- FileRouter
- Super Simple File Based Router
- Git
- Git Interface Class
- GitRepo
- Git Repository Interface Class
- HSLuv
- Port of HSLuv Color library to PHP by Carlos Cabo. V.2.0.0 Original by Alexei Boronine. https://github.com/hsluv
- KVS
- LinkHeader
- LinkHeaderItem
- LTI
- This is a general purpose LTI class with no Tsugi-specific dependencies.
- LTI13
- This is a general purpose LTI 1.3 class with no Tsugi-specific dependencies.
- LTIConstants
- MCache
- Optional Memcached client for application data.
- Mersenne_Twister
- This provides a deterministic pseudo-random sequence that is seedable
- Mimeparse
- Mimeparser class. This class provides basic functions for handling mime-types. It can handle matching mime-types against a list of media-ranges. See section 14.1 of the HTTP specification [RFC 2616] for a complete explanation.
- Net
- Outbound HTTP using the PHP curl extension.
- NotificationsService
- NotificationsService - Utility class for managing user notifications
- Ob3DataIntegrity
- Data Integrity Proof for Open Badges 3.0 (eddsa-jcs-2022 cryptosuite)
- PDOX
- This is our "improved" version of PDO
- PDOXStatement
- This is our "improved" version of PDOStatement
- PS
- An Approximation of a Python String in PHP
- SakaiCustom
- Sakai LTI custom substitution parameters for deep linking and tool registration.
- Stripe
- Stripe Checkout and payment fulfillment helpers.
- TsugiDOM
- Wrap the DOMDocument class with some convienence methods
- U
- Some really small, simple, and self-contained utility public static functions
- UrlRouter
- Simple URL Routing for "Old school" PHP apps
Traits
- JsonTrait
- This is a class holding convienence methods to access the json column for the core objects.
- SessionTrait
- This is a trait convienence methods to access the session from the launch object
- SettingsTrait
- This is a class holding convienence methods to access settings from core objects.
Constants
- COOKIE_SESSION : mixed = \true
- MAIL_BULK_DEFAULT_LIMIT : mixed = 200
- MAIL_BULK_MAX_RECIPIENTS : mixed = 200
- PDO_WILL_CATCH : mixed = true
- SANITY_DB_ALLOW_NO_TABLES : mixed = \true
- SANITY_DB_ALLOW_NO_TABLES : mixed = \true
Functions
- proxySmallJsonResolveIps() : mixed
- proxySmallJsonValidateUrl() : mixed
- bulk_mail_cli_shell_quote() : mixed
- Shell-escape a value for single-quoted CLI args.
- bulk_mail_cli_instructions() : string
- Build equivalent scripts/send-bulk-mail.php instructions for the current form values.
- showDynamicConfig() : mixed
- mail_admin_nav() : mixed
- Shared top links for Admin → Mail pages (and testmail).
- org_manager_url() : string
- org_manager_tenants() : array<int, array<string, mixed>>
- org_manager_find_tenant() : array<string, mixed>|null
- org_manager_tenant_label() : string
- org_manager_indent() : string
- org_manager_parent_choices() : array<int, array<string, mixed>>
- Parents this org may move under: the same tenant, excluding itself and its descendants.
- org_manager_blocked() : string
- org_manager_count() : string
- org_manager_join() : string
- org_manager_courses() : array<int, array<string, mixed>>
- Courses in this tenant, including where they are placed.
- org_manager_post() : void
- org_manager_posted_parent() : int|null
- org_manager_posted_type() : string|null
- org_manager_require_course() : void
- org_manager_require_in_tenant() : void
- Refuse an organization id that is not in the tenant currently open.
- admin_profile_pretty_json() : mixed
- admin_profile_cell() : mixed
- redirect() : mixed
- response() : mixed
Constants
COOKIE_SESSION
public
mixed
COOKIE_SESSION
= \true
MAIL_BULK_DEFAULT_LIMIT
public
mixed
MAIL_BULK_DEFAULT_LIMIT
= 200
MAIL_BULK_MAX_RECIPIENTS
public
mixed
MAIL_BULK_MAX_RECIPIENTS
= 200
PDO_WILL_CATCH
public
mixed
PDO_WILL_CATCH
= true
SANITY_DB_ALLOW_NO_TABLES
public
mixed
SANITY_DB_ALLOW_NO_TABLES
= \true
SANITY_DB_ALLOW_NO_TABLES
public
mixed
SANITY_DB_ALLOW_NO_TABLES
= \true
Functions
proxySmallJsonResolveIps()
proxySmallJsonResolveIps(mixed $host) : mixed
Parameters
- $host : mixed
proxySmallJsonValidateUrl()
proxySmallJsonValidateUrl(mixed $proxyUrl) : mixed
Parameters
- $proxyUrl : mixed
bulk_mail_cli_shell_quote()
Shell-escape a value for single-quoted CLI args.
bulk_mail_cli_shell_quote(mixed $value) : mixed
Parameters
- $value : mixed
bulk_mail_cli_instructions()
Build equivalent scripts/send-bulk-mail.php instructions for the current form values.
bulk_mail_cli_instructions(mixed $context_id, mixed $from_user_id, mixed $subject, mixed $body, mixed $single_email, mixed $days, mixed $exclude_recent_bulk_days, mixed $limit, mixed $include_opted_out, mixed $premium_only) : string
Includes --rate=5 as a batch-mode tip (UI send does not pace).
Parameters
- $context_id : mixed
- $from_user_id : mixed
- $subject : mixed
- $body : mixed
- $single_email : mixed
- $days : mixed
- $exclude_recent_bulk_days : mixed
- $limit : mixed
- $include_opted_out : mixed
- $premium_only : mixed
Return values
string —Multi-line text for a copyable textarea
showDynamicConfig()
showDynamicConfig(mixed $url) : mixed
Parameters
- $url : mixed
mail_admin_nav()
Shared top links for Admin → Mail pages (and testmail).
mail_admin_nav([string $active = 'home' ]) : mixed
Parameters
- $active : string = 'home'
-
One of: home, test, bulk, suppress, events, sent
org_manager_url()
org_manager_url(int $keyId[, mixed $orgId = 0 ]) : string
Parameters
- $keyId : int
- $orgId : mixed = 0
Return values
stringorg_manager_tenants()
org_manager_tenants() : array<int, array<string, mixed>>
Return values
array<int, array<string, mixed>>org_manager_find_tenant()
org_manager_find_tenant(array<int, array<string, mixed>> $tenants, int $keyId) : array<string, mixed>|null
Parameters
- $tenants : array<int, array<string, mixed>>
- $keyId : int
Return values
array<string, mixed>|nullorg_manager_tenant_label()
org_manager_tenant_label(array<string, mixed> $row) : string
Parameters
- $row : array<string, mixed>
Return values
stringorg_manager_indent()
org_manager_indent(array<string, mixed> $org) : string
Parameters
- $org : array<string, mixed>
Return values
stringorg_manager_parent_choices()
Parents this org may move under: the same tenant, excluding itself and its descendants.
org_manager_parent_choices(array<int, array<string, mixed>> $orgs, int $orgId) : array<int, array<string, mixed>>
Parameters
- $orgs : array<int, array<string, mixed>>
- $orgId : int
Return values
array<int, array<string, mixed>>org_manager_blocked()
org_manager_blocked(array<string, mixed> $holdings) : string
Parameters
- $holdings : array<string, mixed>
Return values
string —empty when the org may be deleted
org_manager_count()
org_manager_count(int $n, string $one, string $many) : string
Parameters
- $n : int
- $one : string
- $many : string
Return values
stringorg_manager_join()
org_manager_join(array<string|int, string> $parts) : string
Parameters
- $parts : array<string|int, string>
Return values
stringorg_manager_courses()
Courses in this tenant, including where they are placed.
org_manager_courses(int $keyId) : array<int, array<string, mixed>>
Parameters
- $keyId : int
Return values
array<int, array<string, mixed>>org_manager_post()
org_manager_post(int $keyId) : void
Parameters
- $keyId : int
org_manager_posted_parent()
org_manager_posted_parent() : int|null
Return values
int|nullorg_manager_posted_type()
org_manager_posted_type() : string|null
Return values
string|nullorg_manager_require_course()
org_manager_require_course(int $keyId, int $contextId) : void
Parameters
- $keyId : int
- $contextId : int
org_manager_require_in_tenant()
Refuse an organization id that is not in the tenant currently open.
org_manager_require_in_tenant(int $keyId, int|null $orgId) : void
A null parent is the tenant root and is allowed.
Parameters
- $keyId : int
- $orgId : int|null
admin_profile_pretty_json()
admin_profile_pretty_json(mixed $raw) : mixed
Parameters
- $raw : mixed
admin_profile_cell()
admin_profile_cell(mixed $value) : mixed
Parameters
- $value : mixed
redirect()
redirect([mixed $to = null ][, mixed $status = 302 ][, mixed $headers = [] ]) : mixed
Parameters
- $to : mixed = null
- $status : mixed = 302
- $headers : mixed = []
response()
response([mixed $content = '' ][, mixed $status = 200 ][, array<string|int, mixed> $headers = [] ]) : mixed
Parameters
- $content : mixed = ''
- $status : mixed = 200
- $headers : array<string|int, mixed> = []