A
Access Class in namespace Tsugi\Blob $ConfigInfo #apphomeProperty in class ConfigInfo
The Application URL when Tsugi is part of an application $ConfigInfo #autoapprovekeysProperty in class ConfigInfo
$ConfigInfo #adminpwProperty in class ConfigInfo
This is the PW that you need to access the Administration features of this application. $ConfigInfo #analytics_keyProperty in class ConfigInfo
Configure analytics for this Tsugi instance. $ConfigInfo #analytics_nameProperty in class ConfigInfo
Analytics Class in namespace Tsugi\Controllers Activity Class in namespace Tsugi\Core Activity utilities Annotate Class in namespace Tsugi\Core Our class to handle annotation storage ContentItem ::allowMultipleMethod in class ContentItem allowMultiple - Returns true if we can return multiple items ContentItem ::allowLtiLinkItemMethod in class ContentItem allowLtiLinkItem - Returns true if we can return LTI Link Items ContentItem ::allowLinkMethod in class ContentItem allowLink - Returns true if we can return URLs ContentItem ::allowContentItemMethod in class ContentItem allowContentItem - Returns true if we can return HTML Items ContentItem ::allowImportItemMethod in class ContentItem allowImportItem - Returns true if we can return Common Cartridges LTIX ::adjustDataMethod in class LTIX Make sure that the data in our lti_ tables matches the POST data LTIX ::abort_with_error_logMethod in class LTIX We are aborting this request. If this is a launch, redirect back $Link #activityProperty in class Link
The count of the overall activity on this link at the moment of launch $Tool #analyticsProperty in class Tool
$User #adminProperty in class User
Is the user an administrator? Aes Class in namespace Tsugi\Crypt AesCtr Class in namespace Tsugi\Crypt AesOpenSSL Class in namespace Tsugi\Crypt $GoogleLogin #access_tokenProperty in class GoogleLogin
$GoogleLogin #authentication_objectProperty in class GoogleLogin
Png ::addOrReplaceTextInPngMethod in class Png Png ::addPngChunkMethod in class Png Application Class in namespace Tsugi\Lumen The Tsugi variant of a Lumen Application OAuthServer ::add_signature_methodMethod in class OAuthServer TrivialOAuthDataStore ::add_consumerMethod in class TrivialOAuthDataStore Analytics Class in namespace Tsugi\UI Our class to show analytics Annotate Class in namespace Tsugi\UI Our class to handle annotation markup $Lessons #anchorProperty in class Lessons
Lessons ::adjustArrayMethod in class Lessons Make non-array into an array and adjust paths Lessons ::absolute_url_refMethod in class Lessons Menu ::addMethod in class Menu Add an entry to the menu Menu ::addLinkMethod in class Menu Add an link to the menu Menu ::addSeparatorMethod in class Menu Add a separator to the menu $MenuEntry #attrProperty in class MenuEntry
Extra attributes MenuSet ::addLeftMethod in class MenuSet Add an entty to the Left Menu MenuSet ::addRightMethod in class MenuSet Add an entty to the Right Menu Output ::adjust_themeMethod in class Output Adjust the theme from various places based on the following low-to-high precedence SettingsDialog ::attrMethod in class SettingsDialog Return the attributes to add to a tag to connect to activate the settings modal SettingsForm ::attrMethod in class SettingsForm Return the attributes to add to a tag to connect to activate the settings modal $Topics #anchorProperty in class Topics
Topics ::adjustArrayMethod in class Topics Make non-array into an array and adjust paths CC ::add_moduleMethod in class CC Adds a module to the manifest CC ::add_sub_moduleMethod in class CC Adds a sub module to a module CC ::add_web_linkMethod in class CC CC ::add_topicMethod in class CC CC ::add_lti_linkMethod in class CC Add an LTI link resource item CC ::add_resource_itemMethod in class CC Add a resource to the manifest. ContentItem ::allowMultipleMethod in class ContentItem allowMultiple - Returns true if we can return LTI Link Items ContentItem ::allowLtiLinkItemMethod in class ContentItem allowLtiLinkItem - Returns true if we can return LTI Link Items ContentItem ::allowLinkMethod in class ContentItem allowLink - Returns true if we can return HTML Items ContentItem ::allowContentItemMethod in class ContentItem allowContentItem - Returns true if we can return HTML Items ContentItem ::allowImportItemMethod in class ContentItem allowImportItem - Returns true if we can return IMS Common Cartridges ContentItem ::addLtiLinkItemMethod in class ContentItem addLtiLinkItem - Add an LTI Link Content Item ContentItem ::addLtiLinkItemExtendedMethod in class ContentItem addLtiLinkItemExtended - Add an LTI Link Content Item ContentItem ::addContentItemMethod in class ContentItem addContentItem - Add an Content Item ContentItem ::addContentItemExtendedMethod in class ContentItem addContentItemExtended - Add an Content Item ContentItem ::addFileItemMethod in class ContentItem addFileItem - Add an File Item DeepLinkRequest ::allowMimetypeMethod in class DeepLinkRequest allowMimetype - Returns true if we can return LTI Link Items DeepLinkRequest ::allowMultipleMethod in class DeepLinkRequest allowMultiple - Returns true if we can return multiple items DeepLinkRequest ::acceptTypeMethod in class DeepLinkRequest acceptType - Returns true if the string is in the accept_types DeepLinkRequest ::allowLtiLinkItemMethod in class DeepLinkRequest allowLtiLinkItem - Returns true if we can return LTI Link Items
"accept_types": ["link", "file", "html", "ltiResourceLink", "image"], DeepLinkRequest ::allowContentItemMethod in class DeepLinkRequest allowContentItem - Returns true if we can return HTML Items DeepLinkRequest ::allowLinkMethod in class DeepLinkRequest allowLink - Returns true if we can return HTML Items DeepLinkRequest ::allowImportItemMethod in class DeepLinkRequest allowImportItem - Returns true if we can return IMS Common Cartridges DeepLinkResponse ::addLtiLinkItemMethod in class DeepLinkResponse addLtiLinkItem - Add an LTI Link Deep Link DeepLinkResponse ::addLtiLinkItemExtendedMethod in class DeepLinkResponse addLtiLinkItemExtended - Add an LTI Link Content Item DeepLinkResponse ::addContentItemMethod in class DeepLinkResponse addContentItem - Add an Content Item DeepLinkResponse ::addContentItemExtendedMethod in class DeepLinkResponse addContentItemExtended - Add an Content Item DeepLinkResponse ::addFileItemMethod in class DeepLinkResponse addFileItem - Add an File Item GitRepo ::addMethod in class GitRepo Runs a git add call GitRepo ::active_branchMethod in class GitRepo Returns name of active branch GitRepo ::add_tagMethod in class GitRepo Add a new tag on the current position LTI ::addCustomMethod in class LTI LinkHeader ::allMethod in class LinkHeader get all items LinkHeader ::addMethod in class LinkHeader add a LinkHeaderItem. TsugiDOM ::add_childMethod in class TsugiDOM TsugiDOM ::add_child_nsMethod in class TsugiDOM U ::addSessionMethod in class U U ::add_url_parmMethod in class U U ::absolute_url_refMethod in class U U ::absolute_urlMethod in class U U ::apache_request_headersMethod in class U U ::array_Integer_SerializeMethod in class U Tightly serialize an integer-only PHP array U ::array_Integer_Serialize_MapMethod in class U U ::array_Integer_DeserializeMethod in class U Deserialize an tightly serialized integer-only PHP array U ::array_kshiftMethod in class U Pull off the first element of a key/value array U ::allow_trackMethod in class U U ::apcAvailableMethod in class U Return if APC cache is available (Deprecated) U ::apcuAvailableMethod in class U Return if APCU cache is available U ::appCacheGetMethod in class U U ::appCacheSetMethod in class U U ::appCacheDeleteMethod in class U B
BlobUtil Class in namespace Tsugi\Blob BlobUtil ::blob2blobMethod in class BlobUtil Check and migrate a blob from blob_file to blob_blob BlobUtil ::blob2fileMethod in class BlobUtil Check and migrate a blob to its corresponding file $ConfigInfo #branch_overrideProperty in class ConfigInfo
$ConfigInfo #bootswatchProperty in class ConfigInfo
$ConfigInfo #bootswatch_colorProperty in class ConfigInfo
$ConfigInfo #badge_encrypt_passwordProperty in class ConfigInfo
Badge generation settings - once you start issuing badges - don't change these $ConfigInfo #badge_assert_saltProperty in class ConfigInfo
$ConfigInfo #badge_pathProperty in class ConfigInfo
$ConfigInfo #badge_urlProperty in class ConfigInfo
Keyset ::build_jwkMethod in class Keyset LTIX ::buildLaunchMethod in class LTIX $Launch #base_stringProperty in class Launch
Get the base string from the launch. $Entry #bucketsProperty in class Entry
The buckets key->value $OAuthRequest #base_stringProperty in class OAuthRequest
OAuthRequest ::build_signatureMethod in class OAuthRequest OAuthSignatureMethod_HMAC_SHA1 ::build_signatureMethod in class OAuthSignatureMethod_HMAC_SHA1 OAuthSignatureMethod_HMAC_SHA256 ::build_signatureMethod in class OAuthSignatureMethod_HMAC_SHA256 OAuthSignatureMethod_PLAINTEXT ::build_signatureMethod in class OAuthSignatureMethod_PLAINTEXT OAuthSignatureMethod_RSA_SHA1 ::build_signatureMethod in class OAuthSignatureMethod_RSA_SHA1 OAuthUtil ::build_http_queryMethod in class OAuthUtil Analytics ::buttonMethod in class Analytics Emit a properly styled "settings" button $Output #bufferProperty in class Output
Output ::bodyStartMethod in class Output Finish the head and start the body of a Tsugi HTML page. SettingsDialog ::buttonTextMethod in class SettingsDialog Emit a properly styled "settings" button SettingsDialog ::buttonMethod in class SettingsDialog Emit a properly styled "settings" button SettingsForm ::buttonTextMethod in class SettingsForm Emit a properly styled "settings" button SettingsForm ::buttonMethod in class SettingsForm Emit a properly styled "settings" button $Git #binProperty in class Git
Git executable location $GitRepo #bareProperty in class GitRepo
LTI ::bodyRequestMethod in class LTI LTI13 ::base_jwtMethod in class LTI13 Build up a basic JWT LTI13 ::build_jwt_htmlMethod in class LTI13 Build an HTML form to submit a JWT Mimeparse ::best_matchMethod in class Mimeparse Takes a list of supported mime-types and finds the best match
for all the media-ranges listed in header. The value of header
must be a string that conforms to the format of the HTTP Accept:
header. The value of supported is an Enumerable of mime-types Net ::bodySocketMethod in class Net Net ::bodyStreamMethod in class Net Net ::bodyCurlMethod in class Net C
BlobUtil ::checkFileSafetyMethod in class BlobUtil ConfigInfo Class in namespace Tsugi\Config A class that contains the configuration fields and defaults. $ConfigInfo #cookiesecretProperty in class ConfigInfo
Configure the long-term login cookie encryption values. $ConfigInfo #cookienameProperty in class ConfigInfo
$ConfigInfo #cookiepadProperty in class ConfigInfo
$ConfigInfo #context_titleProperty in class ConfigInfo
$ConfigInfo #certificationProperty in class ConfigInfo
Profile ::checkboxMethod in class Profile Cache Class in namespace Tsugi\Core A very simple Cache - currently implemented in session Cache ::checkMethod in class Cache Check and return a value from the cache. Cache ::clearMethod in class Cache Delete an entry from the cache. ContentItem Class in namespace Tsugi\Core This is a ContentItem class with Tsugi-specific convienences. Context Class in namespace Tsugi\Core This is a class to provide access to the resource context level data. Context ::createLineItemMethod in class Context Create a lineitem in the LMS Debug ::clearMethod in class Debug LTIX ::caliperSendMethod in class LTIX Send a Caliper Body to the correct URL using the key and secret LTIX ::curPageUrlMethod in class LTIX curPageUrl - Returns the URL to the currently executing script with query string LTIX ::curPageUrlNoQueryMethod in class LTIX curPageUrlNoQuery - Returns the URL to the currently executing query without query string LTIX ::curPageUrlFolderMethod in class LTIX curPageUrlFolder - Returns the URL to the folder currently executing LTIX ::curPageUrlScriptMethod in class LTIX curPageUrlScript - Returns the URL to the currently executing script LTIX ::curPageUrlBaseMethod in class LTIX curPageUrlBase - Returns the protocol, host, and port for the current URL $Launch #contextProperty in class Launch
Get the Context associated with the launch. $Launch #current_urlProperty in class Launch
Must be a string that is the current called URL. Mail ::computeCheckMethod in class Mail Tool ::canvasToolRegistrationMethod in class Tool Tool ::canvasStoreRegistrationMethod in class Tool Aes ::cipherMethod in class Aes AES Cipher function: encrypt 'input' with Rijndael algorithm SecureCookie ::createMethod in class SecureCookie Entry ::clickMethod in class Entry Record a click. $GoogleLogin #client_idProperty in class GoogleLogin
$GoogleLogin #client_secretProperty in class GoogleLogin
GoogleLogin ::curl_postMethod in class GoogleLogin Utility code in order not to have external dependencies
and to have some logging. GoogleLogin ::curl_getMethod in class GoogleLogin Utility code in order not to have external dependencies
and to have some logging. $OAuthConsumer #callback_urlProperty in class OAuthConsumer
OAuthSignatureMethod ::check_signatureMethod in class OAuthSignatureMethod OAuthSignatureMethod_RSA_SHA1 ::check_signatureMethod in class OAuthSignatureMethod_RSA_SHA1 CrudForm Class in namespace Tsugi\UI This is a class that supports the creation of simple CRUD forms. Output ::closeButtonMethod in class Output Emit a properly styled close button for use in own popup Output ::closeMenuSetMethod in class Output SettingsDialog ::colorMethod in class SettingsDialog Handle a settings color box SettingsDialog ::checkboxMethod in class SettingsDialog Handle a settings checkbox SettingsForm ::checkboxMethod in class SettingsForm Handle a settings checkbox $Topics #courseProperty in class Topics
The course object CC Class in namespace Tsugi\Util This class allows us to produce an IMS Common Cartridge Version 1.2 CC_LTI_Outcome Class in namespace Tsugi\Util CC_Topic Class in namespace Tsugi\Util CC_WebLink Class in namespace Tsugi\Util Caliper Class in namespace Tsugi\Util This is a general purpose LTI class with no Tsugi-specific dependencies. Color Class in namespace Tsugi\Util ContentItem Class in namespace Tsugi\Util This is a general purpose ContentItem class with no Tsugi-specific dependencies. $DeepLinkRequest #claimProperty in class DeepLinkRequest
FileRouter ::cwdMethod in class FileRouter Gives the current folder of the executing script Git ::createMethod in class Git Create a new git repository Git ::clone_remoteMethod in class Git Clones a remote repo into a directory and then returns a GitRepo object
for the newly created local repo GitRepo ::create_newMethod in class GitRepo Create a new git repository GitRepo ::commitMethod in class GitRepo Runs a git commit call GitRepo ::clone_toMethod in class GitRepo Runs a git clone call to clone the current repository
into a different directory GitRepo ::clone_fromMethod in class GitRepo Runs a git clone call to clone a different repository
into the current repository GitRepo ::clone_remoteMethod in class GitRepo Runs a git clone call to clone a remote repository
into the current repository GitRepo ::cleanMethod in class GitRepo Runs a git clean call GitRepo ::create_branchMethod in class GitRepo Runs a git branch call GitRepo ::checkoutMethod in class GitRepo Runs a git checkout call LTI ::compareBaseStringsMethod in class LTI LTI13 ::createLineItemMethod in class LTI13 Create a lineitem in the LMS LTI13 ::cleanup_PKCS8Method in class LTI13 Cleanup common mess-ups in PKCS8 strings LTI13 ::checkLTI11TransitionMethod in class LTI13 Check the OAuth signature for an LTI 1.3 Launch JWT LTI13 ::compute_HMAC_SHA256Method in class LTI13 Compute the HMAC256 of a string (part of LTI 1.1 Transition) $TsugiDOM #currentNamespaceProperty in class TsugiDOM
U ::conservativeUrlMethod in class U U ::curPHPUrlMethod in class U Return the URL as seen by PHP (no query string or parameters) U ::conversion_timeMethod in class U Give the current time in the "conversion format" U ::createGUIDMethod in class U Create a unique GUID
return string UrlRouter ::cwdMethod in class UrlRouter Gives the current folder of the executing script D
BlobUtil ::deleteBlobMethod in class BlobUtil Delete a blob based on its id $ConfigInfo #dbuserProperty in class ConfigInfo
Database user for the PDO connection $ConfigInfo #dbpassProperty in class ConfigInfo
Database password for the PDO connection $ConfigInfo #dbprefixProperty in class ConfigInfo
A prefix to prepend to all table names. $ConfigInfo #DEVELOPERProperty in class ConfigInfo
Enable developer features of the application. $ConfigInfo #dirrootProperty in class ConfigInfo
Top level file system folder for the application $ConfigInfo #datarootProperty in class ConfigInfo
Configure where TSUGI will store uploaded files. $ConfigInfo #defaultmenuProperty in class ConfigInfo
A default menu for pages $ConfigInfo #dbversionProperty in class ConfigInfo
Context ::deleteLineItemMethod in class Context Delete a lineitem from the LMS Debug Class in namespace Tsugi\Core This is a place holder. Other than dumpPost() it needs a bit of work. Debug ::dumpMethod in class Debug Debug ::dumpPostMethod in class Debug Dump out the contents of the $_POST properly escaped in pre tags. DeepLinkResponse Class in namespace Tsugi\Core This is a general purpose DeepLink class with no Tsugi-specific dependencies. LTIX ::decrypt_secretMethod in class LTIX Decrypt a secret from the session LTIX ::displayNameFromClaimMethod in class LTIX Get a display name from a LTI 1.3 user claim $Launch #deeplinkProperty in class Launch
The deeplink url, if any Launch ::documentTargetMethod in class Launch Return the document target
The value for this property MUST be one of: frame, iframe, or window. $Roster #dataProperty in class Roster
$User #displaynameProperty in class User
The user's display name WebSocket ::decodeTokenMethod in class WebSocket Decode and parse a token to make sure it is valid AesCtr ::decryptMethod in class AesCtr Decrypt a text encrypted by AES in counter mode of operation AesOpenSSL ::decryptMethod in class AesOpenSSL Decrypt a text encrypted by AES in counter mode of operation SecureCookie ::decryptMethod in class SecureCookie SecureCookie ::deleteMethod in class SecureCookie Entry ::deSerializeMethod in class Entry De-Serialize scale, timestart and buckets (can be compressed) GoogleClassroom ::destroy_instructor_tokenMethod in class GoogleClassroom JWT ::decodeMethod in class JWT $OAuthServer #data_storeProperty in class OAuthServer
Output ::doAnalyticsMethod in class Output Output ::defaultMenuSetMethod in class Output Output ::dumpDebugArrayMethod in class Output Dump a debug array with messages and optional detail Output ::doRedirectMethod in class Output Redirect to a local URL, adding session if necessary Output ::displaySizeMethod in class Output SettingsDialog ::dueDateMethod in class SettingsDialog Emit the text and form fields to support due dates SettingsDialog ::doneMethod in class SettingsDialog Emit the text and form fields to support the done option SettingsForm ::dueDateMethod in class SettingsForm Emit the text and form fields to support due dates SettingsForm ::doneMethod in class SettingsForm Emit the text and form fields to support the done option $Table #DEFAULT_PAGE_LENGTHProperty in class Table
Table ::doFormMethod in class Table Table ::doUrlMethod in class Table $Theme #dark_modeProperty in class Theme
Theme ::defaultsMethod in class Theme Get default theme values from a configured theme or the actual defaults Theme ::deriveTsugiColorsMethod in class Theme Derive a range of named colors from a single base color DeepLinkRequest Class in namespace Tsugi\Util This is a general purpose DeepLinkRequest class DeepLinkResponse Class in namespace Tsugi\Util This is a general purpose DeepLink class with no Tsugi-specific dependencies. GitRepo ::delete_branchMethod in class GitRepo Runs a git branch -[d|D] call KVS ::deleteMethod in class KVS LTI13 ::dump_jwtMethod in class LTI13 Print out the contents of the JWT LTI13 ::deleteLineItemMethod in class LTI13 Delete a lineitem from the LMS Net ::doGetMethod in class Net Net ::doBodyMethod in class Net TsugiDOM ::delete_tagMethod in class TsugiDOM TsugiDOM ::delete_tag_nsMethod in class TsugiDOM TsugiDOM ::delete_childrenMethod in class TsugiDOM TsugiDOM ::delete_children_nsMethod in class TsugiDOM TsugiDOM ::dump_dom_listMethod in class TsugiDOM TsugiDOM ::dump_dom_nodeMethod in class TsugiDOM TsugiDOM ::dump_dom_levelsMethod in class TsugiDOM U ::die_with_error_logMethod in class U U ::displaySizeMethod in class U E
BlobUtil ::emptyPostSessionLostMethod in class BlobUtil Check to see if the $_POST is completely broken in file upload
Sometimes, if the maxUpload_SIZE is exceeded, it deletes all of $_POST
and we lose our session. BlobUtil ::emptyPostMethod in class BlobUtil Check to see if the $_POST is completely broken in file upload
Sometimes, if the maxUpload_SIZE is exceeded, it deletes all of $_POST $ConfigInfo #extensionsProperty in class ConfigInfo
Extensions $ConfigInfo #eventcheckProperty in class ConfigInfo
$ConfigInfo #eventtimeProperty in class ConfigInfo
$ConfigInfo #eventpushtimeProperty in class ConfigInfo
$ConfigInfo #eventpushcountProperty in class ConfigInfo
$ConfigInfo #expire_pii_daysProperty in class ConfigInfo
The defaults for data expiration. Data expiration is not done by default, but can
be triggered in the Tsugi Admin UI or via a php CLI program. $ConfigInfo #expire_user_daysProperty in class ConfigInfo
$ConfigInfo #expire_context_daysProperty in class ConfigInfo
$ConfigInfo #expire_tenant_daysProperty in class ConfigInfo
Cache ::expiresMethod in class Cache Check when value in the cache expires $Context #ENTITY_NAMEProperty in class Context
Entity Class in namespace Tsugi\Core This is a class holding commmon functionality to be extended by various other classes. $Key #ENTITY_NAMEProperty in class Key
$Keyset #expireProperty in class Keyset
LTIX ::encrypt_secretMethod in class LTIX Encrypt a secret to put into the session LTIX ::extractPostMethod in class LTIX Pull the LTI POST data into our own data structure LTIX ::extractJWTMethod in class LTIX Pull the LTI JWT data into our own data structure LTIX ::encode_jwtMethod in class LTIX encode and sign a JWT with a bunch of parameters $Launch #error_messageProperty in class Launch
Get the error message if something went wrong with the setup (TBD) $Link #ENTITY_NAMEProperty in class Link
$User #ENTITY_NAMEProperty in class User
$User #emailProperty in class User
The user's email WebSocket ::enabledMethod in class WebSocket Determine if this server is configured for web sockets. AesCtr ::encryptMethod in class AesCtr Encrypt a text using AES encryption in Counter mode of operation
- see http://csrc.nist.gov/publications/nistpubs/800-38a/sp800-38a.pdf AesOpenSSL ::encryptMethod in class AesOpenSSL Unicode multi-byte character safe SecureCookie ::encryptMethod in class SecureCookie Utility code to deal with Secure Cookies. SecureCookie ::extractMethod in class SecureCookie Entry Class in namespace Tsugi\Event A adaptive, multi-scale compressed time series of event counter buckets JWT ::encodeMethod in class JWT ExceptionHandler Class in namespace Tsugi\Lumen Lessons ::expandLinkMethod in class Lessons MenuSet ::exportMethod in class MenuSet Export a menu to JSON Output ::exitButtonMethod in class Output Emit a properly styled done button for use in the launched frame/window Output ::embeddedMenuMethod in class Output The embedded menu - for now just one button. Output ::embedYouTubeMethod in class Output Embed a YouTube video using the standard pattern SettingsDialog ::endMethod in class SettingsDialog Finish the form output SettingsForm ::endMethod in class SettingsForm Finish the form output $GitRepo #envoptsProperty in class GitRepo
KVS ::extractWhereMethod in class KVS KVS ::extractOrderMethod in class KVS LTI13 ::extract_issuer_keyMethod in class LTI13 Pull out the issuer_key from a JWT LTI13 ::extract_issuer_key_stringMethod in class LTI13 Pull out the composite issuer_key from issuer and audience LTI13 ::extract_access_tokenMethod in class LTI13 Extract an access token from returned data LTI13 ::encode_jwtMethod in class LTI13 Sign and encode a JWT LTI13 ::extractKeyFromKeySetMethod in class LTI13 Extract a public key from a string containing a JSON keyset $PDOXStatement #ellapsed_timeProperty in class PDOXStatement
$PDOXStatement #errorImplodeProperty in class PDOXStatement
$PDOXStatement #errorCodeOverrideProperty in class PDOXStatement
$PDOXStatement #errorInfoOverrideProperty in class PDOXStatement
PDOXStatement ::errorCodeMethod in class PDOXStatement PDOXStatement ::errorInfoMethod in class PDOXStatement PS ::endsWithMethod in class PS U ::echo_logMethod in class U U ::error_outMethod in class U U ::endsWithMethod in class U U ::escapeHtmlMethod in class U Make an htmlentities() that is more tolerant than the PHP 8.2 version. UrlRouter ::executeMethod in class UrlRouter F
BlobUtil ::fixFileNameMethod in class BlobUtil $ConfigInfo #fontawesomeProperty in class ConfigInfo
$Launch #for_userProperty in class Launch
Get the "For User" associated with the launch. $User #firstnameProperty in class User
The user's first name OAuthRequest ::from_requestMethod in class OAuthRequest attempt to build up a request from what was passed to the server OAuthRequest ::from_consumer_and_tokenMethod in class OAuthRequest pretty much a helper function to set up the request OAuthServer ::fetch_request_tokenMethod in class OAuthServer process a request_token request
returns the request token on success OAuthServer ::fetch_access_tokenMethod in class OAuthServer process an access_token request
returns the access token on success OAuthSignatureMethod_RSA_SHA1 ::fetch_public_certMethod in class OAuthSignatureMethod_RSA_SHA1 OAuthSignatureMethod_RSA_SHA1 ::fetch_private_certMethod in class OAuthSignatureMethod_RSA_SHA1 Annotate ::footerMethod in class Annotate Define the function tsugiStartAnnotation(id) to start the annotations on a div CrudForm ::fieldToTitleMethod in class CrudForm Maps a field name to a presentable title. Lessons ::footerMethod in class Lessons Output ::flashMessagesMethod in class Output Output ::footerStartMethod in class Output Output ::footerEndMethod in class Output Output ::footerMethod in class Output Theme ::findLMidPointForHueMethod in class Theme Take a color and move it along its luminance until it is halfway between
a given dark color and white Topics ::footerMethod in class Topics Color ::fixRgbMethod in class Color Allow array pr parameter form for RGB FileRouter Class in namespace Tsugi\Util Super Simple File Based Router FileRouter ::fileCheckMethod in class FileRouter GitRepo ::fetchMethod in class GitRepo Runs a git fetch on the current branch HSLuv ::fromRgbMethod in class HSLuv HSLuv ::fromRgbIntMethod in class HSLuv HSLuv ::fromHexMethod in class HSLuv LinkHeader ::fromStringMethod in class LinkHeader Builds a LinkHeader instance from a string. Mimeparse ::fitness_and_quality_parsedMethod in class Mimeparse Find the best match for a given mime-type against a list of
media_ranges that have already been parsed by Mimeparser::parse_media_range() PS ::findMethod in class PS G
BlobUtil ::getFolderNameMethod in class BlobUtil BlobUtil ::getBlobFolderMethod in class BlobUtil BlobUtil ::getAccessUrlForBlobMethod in class BlobUtil $ConfigInfo #google_translateProperty in class ConfigInfo
Enable Google Translate on this site $ConfigInfo #git_commandProperty in class ConfigInfo
Configure git for auto-installation $ConfigInfo #giftquizzesProperty in class ConfigInfo
Path (on disk) to the gift quiz content. $ConfigInfo #google_client_idProperty in class ConfigInfo
$ConfigInfo #google_client_secretProperty in class ConfigInfo
$ConfigInfo #google_map_api_keyProperty in class ConfigInfo
$ConfigInfo #google_login_newProperty in class ConfigInfo
$ConfigInfo #google_classroom_secretProperty in class ConfigInfo
Legacy: Google Classroom support - this was an experiment and is no longer supported
First, Go to https://console.developers.google.com/apis/credentials
And add access to "Google Classroom API" to your google_client_id (above) $ConfigInfo #google_classroom_logoProperty in class ConfigInfo
(legacy) This should be an absolute URL that will be used to populate previews
in Google Classroom ConfigInfo ::getExtensionMethod in class ConfigInfo ConfigInfo ::getCurrentFileMethod in class ConfigInfo ConfigInfo ::getScriptFolderMethod in class ConfigInfo ConfigInfo ::getCurrentFileUrlMethod in class ConfigInfo ConfigInfo ::getLoginUrlMethod in class ConfigInfo ConfigInfo ::getPwdMethod in class ConfigInfo Get the current working directory of a file ConfigInfo ::getUrlFullMethod in class ConfigInfo ConfigInfo ::getScriptPathMethod in class ConfigInfo ConfigInfo ::getScriptPathFullMethod in class ConfigInfo ConfigInfo ::getScriptNameMethod in class ConfigInfo Get the name of the script relative to the server document root ConfigInfo ::getCurrentUrlMethod in class ConfigInfo Get the current URL we are executing - no query parameters ConfigInfo ::getCurrentUrlFolderMethod in class ConfigInfo Get the current folder of the URL we are executing - no trailing slash Analytics ::getAnalyticsMethod in class Analytics Login ::getMethod in class Login Map ::getMapMethod in class Map Map ::getjsonMethod in class Map Profile ::getProfileMethod in class Profile ContentItem ::getContentItemSelectionMethod in class ContentItem Return the parameters to send back to the LMS Context ::getLineItemsTokenMethod in class Context Wrapper to get line items token so we can add caching Context ::getGradeTokenMethod in class Context Wrapper to get grade token JsonTrait ::getJsonMethod in class JsonTrait Load the json field for this entity JsonTrait ::getJsonKeyLegacyMethod in class JsonTrait JsonTrait ::getJsonKeyMethod in class JsonTrait Get a JSON key for this entity Keyset ::getSigningMethod in class Keyset Keyset ::getCurrentKeysMethod in class Keyset LTIX ::getConnectionMethod in class LTIX Get a singleton global connection or set it up if not already set up. LTIX ::getBrowserMarkMethod in class LTIX LTIX ::getPlatformPublicKeyMethod in class LTIX getPlatformPublicKey - Get the platform public key for the various sources LTIX ::getCompositeKeyMethod in class LTIX LTIX ::gradeGetMethod in class LTIX Load the grade for a particular row and update our local copy (Deprecated - moved to Result) LTIX ::gradeSendMethod in class LTIX Send a grade and update our local copy (Deprecated - moved to Result) LTIX ::gradeSendDueDateMethod in class LTIX Send a grade applying the due date logic and only increasing grades (Deprecated - moved to Result) LTIX ::getKeySecretForLaunchMethod in class LTIX getKeySecretForLaunch - Retrieve a Key/Secret for a Launch LTIX ::getCoreLaunchDataMethod in class LTIX getCoreLaunchData - Get the launch data common across launch types LTIX ::getLaunchDataMethod in class LTIX getLaunchData - Get the launch data for a normal LTI 1.x launch LTIX ::getContentItemMethod in class LTIX getLaunchData - Get the launch data for am LTI ContentItem launch LTIX ::getLaunchUrlMethod in class LTIX getLaunchData - Get the launch data for am LTI ContentItem launch LTIX ::getLaunchContentMethod in class LTIX getLaunchContent - Get the launch data for am LTI ContentItem launch LTIX ::getBrowserSignatureMethod in class LTIX LTIX ::getBrowserSignatureRawMethod in class LTIX LTIX ::getTsugiStateCookieNameMethod in class LTIX LTIX ::getKidForKeyMethod in class LTIX Compute the kid has value from a public key LTIX ::getLatestHistoryIdsMethod in class LTIX Retrieve the context and link ids for a previous installation of the tool, such as
if it were imported from another site during a site import. Returns false, if not. $Link #gradeProperty in class Link
The current grade for the user Link ::getPlacementSecretMethod in class Link Get the placement secret for this Link $Result #gradeProperty in class Result
The current grade for the user Result ::gradeGetMethod in class Result Load the grade for a particular row and update our local copy Result ::gradeSendStaticMethod in class Result Send a grade and update our local copy Result ::gradeSendMethod in class Result Send a grade and update our local copy Result ::gradeSendDueDateMethod in class Result Send a grade applying the due date logic and only increasing grades Result ::getJsonForUserMethod in class Result Get a JSON for a different user Result ::getJsonKeyForUserMethod in class Result Get a JSON key for a result for a different user Result ::getNoteMethod in class Result Get a Note Settings ::getDebugArrayMethod in class Settings Retrieve the debug array for the last operation. User ::getNameAndEmailMethod in class User Construct the user's name / email combination User ::getFirstNameMethod in class User Get the user's first name, falling back to email WebSocket ::getPortMethod in class WebSocket Returns the port that the configured web socket server WebSocket ::getProxyPortMethod in class WebSocket Returns the proxyport if set in config WebSocket ::getHostMethod in class WebSocket Returns the host that the configured web socket server WebSocket ::getTokenMethod in class WebSocket Build and sign a token for a particular link_id WebSocket ::getSpaceFromTokenMethod in class WebSocket Pull out the host and link_id so as to create the "space" GoogleClassroom Class in namespace Tsugi\Google GoogleClassroom ::getClientMethod in class GoogleClassroom Returns an authorized Clasroom API client. GoogleClassroom ::gradeSendMethod in class GoogleClassroom GoogleLogin Class in namespace Tsugi\Google A very simple Google Login GoogleLogin ::getLoginUrlMethod in class GoogleLogin Get the login url GoogleLogin ::getAccessTokenMethod in class GoogleLogin Get the access token GoogleLogin ::getUserInfoMethod in class GoogleLogin GradeUtil Class in namespace Tsugi\Grades GradeUtil ::gradeLoadAllMethod in class GradeUtil GradeUtil ::gradeShowAllMethod in class GradeUtil GradeUtil ::gradeLoadMethod in class GradeUtil GradeUtil ::gradeShowInfoMethod in class GradeUtil GradeUtil ::gradeUpdateJsonMethod in class GradeUtil UI ::gradeTableMethod in class UI OAuthRequest ::get_parameterMethod in class OAuthRequest OAuthRequest ::get_parametersMethod in class OAuthRequest OAuthRequest ::get_signable_parametersMethod in class OAuthRequest The request parameters, sorted and concatenated into a normalized string. OAuthRequest ::get_signature_base_stringMethod in class OAuthRequest Returns the base string of this request OAuthRequest ::get_normalized_http_methodMethod in class OAuthRequest just uppercases the http method OAuthRequest ::get_normalized_http_urlMethod in class OAuthRequest parses the url and rebuilds it to be
scheme://host/path OAuthSignatureMethod_HMAC_SHA1 ::get_nameMethod in class OAuthSignatureMethod_HMAC_SHA1 OAuthSignatureMethod_HMAC_SHA256 ::get_nameMethod in class OAuthSignatureMethod_HMAC_SHA256 OAuthSignatureMethod_PLAINTEXT ::get_nameMethod in class OAuthSignatureMethod_PLAINTEXT OAuthSignatureMethod_RSA_SHA1 ::get_nameMethod in class OAuthSignatureMethod_RSA_SHA1 OAuthUtil ::get_headers_internalMethod in class OAuthUtil OAuthUtil ::get_headersMethod in class OAuthUtil Analytics ::graphBodyMethod in class Analytics Output a Graph Analytics ::graphScriptMethod in class Analytics Output a Graph Lessons ::getSettingMethod in class Lessons get a setting for the lesson Lessons ::getModuleByAnchorMethod in class Lessons Get a module associated with an anchor Lessons ::getLtiByRlidMethod in class Lessons Get an LTI or Discussion associated with a resource link ID Lessons ::getModuleByRlidMethod in class Lessons Get a module associated with a resource link ID Lessons ::getUrlResourcesMethod in class Lessons Lessons ::getCustomWithInheritMethod in class Lessons Check if a setting value is in a resource in a Lesson Output ::getUtilUrlMethod in class Output getUtilUrl - Get a URL in the utility script space - does not add session Output ::getSpinnerUrlMethod in class Output Get a fully-qualified URL for the spinner. Output ::getDefaultIconMethod in class Output Get a fully-qualified URL for the default icon image. Output ::getScreenOverlayMethod in class Output Return the text for a full-screen loader Output ::getLocalStaticMethod in class Output Gets an absolute static path to the specified file Output ::get_themeMethod in class Output Retrieves or generates a theme based on optional specs (base color, dark mode flag). SettingsDialog ::getDueDateMethod in class SettingsDialog Get the due data data in an object SettingsDialog ::getDueDateDeltaMethod in class SettingsDialog Show a due date delta in reasonable units SettingsForm ::getDueDateMethod in class SettingsForm Get the due data data in an object SettingsForm ::getDueDateDeltaMethod in class SettingsForm Show a due date delta in reasonable units Theme ::getLegacyThemeMethod in class Theme Topics ::getUrlResourcesMethod in class Topics Topics ::getTopicByAnchorMethod in class Topics Get a topic associated with an anchor Topics ::getTopicByRlidMethod in class Topics Get a topic associated with a resource link ID Topics ::getLtiByRlidMethod in class Topics Get an LTI associated with a resource link ID Topics ::getCustomWithInheritMethod in class Topics Check if a setting value is in a resource in a Topic Caliper ::getISO8601Method in class Caliper Get Caliper-style ISO8601 Datetime from unix timestamp ContentItem ::getContentItemSelectionMethod in class ContentItem Return the parameters to send back to the LMS DeepLinkRequest ::getClaimMethod in class DeepLinkRequest getClaim - get a extension claim DeepLinkResponse ::getContentItemSelectionMethod in class DeepLinkResponse Return the claims array to send back to the LMS Git Class in namespace Tsugi\Util Git Interface Class Git ::get_binMethod in class Git Gets git executable path GitRepo Class in namespace Tsugi\Util Git Repository Interface Class GitRepo ::git_directory_pathMethod in class GitRepo Get the path to the git repo directory (eg. the ".git" directory) GitRepo ::get_descriptionMethod in class GitRepo Gets the project description. LTI ::get_stringMethod in class LTI LTI ::getLastOAuthBodyBaseStringMethod in class LTI LTI ::getLastOAuthBodyHashInfoMethod in class LTI LTI ::getAuthorizationHeaderMethod in class LTI LTI ::getContentTypeHeaderMethod in class LTI LTI ::getOAuthKeyFromHeadersMethod in class LTI LTI ::getPOXGradeMethod in class LTI Retrieve a grade using the LTI 1.1 protocol (POX) LTI ::getPOXGradeRequestMethod in class LTI LTI ::getPOXRequestMethod in class LTI LTI ::getPOXResponseMethod in class LTI LTI ::getContextMembershipsMethod in class LTI LTI ::getResultJSONMethod in class LTI Return an array suitable for sending to the LTI 2.x result_url LTI ::getLtiLinkJSONMethod in class LTI getLtiLinkJson - Get a JSON object for an LTI Link Content Item Return LTI13 ::getGradeTokenMethod in class LTI13 Retrieve a grade token LTI13 ::getNRPSTokenMethod in class LTI13 Retrieve a Names and Roles Provisioning Service (NRPS) token LTI13 ::getNRPSWithSourceDidsTokenMethod in class LTI13 Retrieve a Names and Roles Provisioning Service (NRPS) token with source_dids LTI13 ::getLineItemsTokenMethod in class LTI13 Retrieve a LineItems token LTI13 ::get_access_tokenMethod in class LTI13 Retrieve an access token LTI13 ::generatePKCS8PairMethod in class LTI13 LTI13 ::getLTI11TransitionBaseMethod in class LTI13 Compute the base string for a Launch JWT LinkHeader ::getRelMethod in class LinkHeader gets an item for a certain rel LinkHeaderItem ::getUriMethod in class LinkHeaderItem Get URI. LinkHeaderItem ::getRelMethod in class LinkHeaderItem Get rel attribute LinkHeaderItem ::getAttributeMethod in class LinkHeaderItem Get an attribute. Mersenne_Twister ::getNextMethod in class Mersenne_Twister Get the next pseudo-random number in the sequence Mersenne_Twister ::gaussianMethod in class Mersenne_Twister Net ::getLastGETURLMethod in class Net Net ::getLastGETImplMethod in class Net Net ::getLastHeadersSentMethod in class Net Net ::getLastHttpResponseMethod in class Net Net ::getLastCurlErrorMethod in class Net Net ::getLastHeadersReceivedMethod in class Net Net ::getLastBODYURLMethod in class Net Net ::getLastBODYMethodMethod in class Net Net ::getLastBODYImplMethod in class Net Net ::getLastBODYContentMethod in class Net Net ::getLastBODYDebugMethod in class Net Net ::getStreamMethod in class Net Net ::getCurlMethod in class Net Net ::getBodySentDebugMethod in class Net Net ::getBodyReceivedDebugMethod in class Net Net ::getGetSentDebugMethod in class Net Net ::getGetReceivedDebugMethod in class Net Net ::getIPMethod in class Net Get the actual IP address of the incoming request. PS ::getMethod in class PS TsugiDOM ::get_elementMethod in class TsugiDOM TsugiDOM ::get_tagMethod in class TsugiDOM TsugiDOM ::get_tag_nsMethod in class TsugiDOM U ::getMethod in class U Produce a Python-style get() to avoid use of ternary operator U ::get_request_documentMethod in class U Get the last bit of the path U ::get_base_urlMethod in class U Get the protocol, host, and port from an absolute URL U ::get_rest_pathMethod in class U Get the path to the current request, w/o trailing slash U ::get_rest_parentMethod in class U Get the path to one above the current request, w/o trailing slash U ::goodFolderMethod in class U U ::getCallerMethod in class U U ::getServerBaseMethod in class U H
Tool ::handleConfigMethod in class Tool Annotate ::headerMethod in class Annotate Provide the header material to support annotations CrudForm ::handleInsertMethod in class CrudForm Insert data from a $_POST of one of our generated forms insert form into the database. CrudForm ::handleUpdateMethod in class CrudForm Apply the results of an update form to the database HandleBars Class in namespace Tsugi\UI This is a class that suports the HandleBars use cases in Tsugi Lessons ::headerMethod in class Lessons emit the header material $MenuEntry #hrefProperty in class MenuEntry
The place to go for a link $MenuSet #homeProperty in class MenuSet
The Home Menu Output ::headerJsonMethod in class Output Set the JSON header Output ::headerMethod in class Output Start the header material of a normal Tsugi Page Output ::headerDataMethod in class Output Set the header variables for a Tsugi Page Output ::helpModalMethod in class Output Output ::helpButtonMethod in class Output Output ::handleHeartBeatMethod in class Output Handle the heartbeat calls. This is UI code basically. Output ::htmlErrorMethod in class Output SettingsDialog ::handleSettingsPostMethod in class SettingsDialog Handle incoming settings post data SettingsForm ::handleSettingsPostMethod in class SettingsForm Handle incoming settings post data Theme ::hslToRgbMethod in class Theme Topics ::headerMethod in class Topics emit the header material Color ::hexMethod in class Color Convert a RGB to hex HSLuv Class in namespace Tsugi\Util Port of HSLuv Color library to PHP by Carlos Cabo. V.2.0.0
Original by Alexei Boronine. https://github.com/hsluv HSLuv ::hsluvToLchMethod in class HSLuv HSLuv ::hpluvToLchMethod in class HSLuv HSLuv ::hexToRgbMethod in class HSLuv HSLuv ::hsluvToRgbMethod in class HSLuv HSLuv ::hpluvToRgbMethod in class HSLuv LTI ::handleOAuthBodyPOSTMethod in class LTI LTI13 ::handle_curl_errorMethod in class LTI13 Handle a curl that fails Net ::httpSuccessMethod in class Net Return true if the http code is 2xx (success) U ::htmlpre_utf8Method in class U U ::htmlspec_utf8Method in class U U ::htmlent_utf8Method in class U U ::http_response_codeMethod in class U I
BlobUtil ::isPngOrJpegMethod in class BlobUtil Make sure the contents of this file are a PNG or JPEG BlobUtil ::isTestKeyMethod in class BlobUtil isTestKey - Indicate if this is a key that is supposed to stay in blob_file $ConfigInfo #install_folderProperty in class ConfigInfo
Indicate which folder to install new modules into. $Context #idProperty in class Context
The integer primary key for this context in the 'lti_context' table. I18N Class in namespace Tsugi\Core Some really small, simple, and self-contained utility public static functions $Key #idProperty in class Key
The integer primary key for this context in the 'lti_key' table. Launch ::isLTI13Method in class Launch Return whether this is an LTI13 launch or not Launch ::isSakaiMethod in class Launch Indicate if this launch came from Sakai Launch ::isCanvasMethod in class Launch Indicate if this launch came from Canvas Launch ::isMoodleMethod in class Launch Indicate if this launch came from Moodle Launch ::isCourseraMethod in class Launch Indicate if this launch came from Coursera Launch ::isLTIAdvantageMethod in class Launch Return a boolean is this is an LTI Advantage launch $Link #idProperty in class Link
The integer primary key for this link in the 'lti_link' table. $Result #idProperty in class Result
The integer primary key for this link in the 'lti_result' table. $Roster #idProperty in class Roster
$User #idProperty in class User
The integer primary key for this user in the 'lti_user' table. $User #imageProperty in class User
The User's Image / Avatar $User #instructorProperty in class User
Is the user an instructor? CrudForm ::insertFormMethod in class CrudForm Generate the HTML for an insert form. Lessons ::isSingleMethod in class Lessons Indicate we are in a single lesson MenuSet ::importMethod in class MenuSet Import a menu from JSON $SettingsDialog #instructor_overrideProperty in class SettingsDialog
SettingsDialog ::instructorMethod in class SettingsDialog Check if the current user is an instructor SettingsDialog ::isSettingsPostMethod in class SettingsDialog Check for incoming settings post data SettingsForm ::isSettingsPostMethod in class SettingsForm Check for incoming settings post data Theme ::isActiveMethod in class Theme Topics ::isSingleMethod in class Topics Indicate we are in a single topic $DeepLinkResponse #itemsProperty in class DeepLinkResponse
Git ::is_repoMethod in class Git Checks if a variable is an instance of GitRepo KVS ::insertMethod in class KVS KVS ::insertOrUpdateMethod in class KVS LTI ::isRequestCheckMethod in class LTI Determines if this is a valid Basic LTI message LTI ::isRequestMethod in class LTI Determines if this is a valid Basic LTI message LTI ::isValidMessageTypeMethod in class LTI LTI ::isValidVersionMethod in class LTI LTI13 ::isRequestDetailMethod in class LTI13 Returns true if this is an LTI 1.3 message with minimum values to meet the protocol LTI13 ::isRequestMethod in class LTI13 Returns true if this is an LTI 1.3 message with minimum values to meet the protocol LTI13 ::isValidMessageTypeMethod in class LTI13 Check the incoming message type LTI13 ::isValidVersionMethod in class LTI13 Check the incoming message version Net ::isRoutableMethod in class Net $PS #internalProperty in class PS
U ::isCliMethod in class U U ::iso8601Method in class U U ::isGUIDValidMethod in class U U ::isValidCSSColorMethod in class U Validate a CSS color value U ::isEmptyMethod in class U Determine if a variable is empty U ::isNotEmptyMethod in class U Imitate StringUtils.isNotEmpty() U ::isKeyNotEmptyMethod in class U Check if a key in an array is not empty J
JsonTrait Class in namespace Tsugi\Core This is a class holding convienence methods to access the json column for the core objects. LTIX ::jsonSendMethod in class LTIX Send a JSON Body to a URL after looking up the key and secret JWT Class in namespace Tsugi\Google JSON Web Token implementation JWT ::jsonDecodeMethod in class JWT JWT ::jsonEncodeMethod in class JWT Output ::jsonErrorMethod in class Output Output ::jsonAuthErrorMethod in class Output Output ::jsonOutputMethod in class Output Output ::json_encode_string_valueMethod in class Output $ContentItem #jsonProperty in class ContentItem
$DeepLinkResponse #jsonProperty in class DeepLinkResponse
LTI ::jsonIndentMethod in class LTI LTI13 ::jonPostelMethod in class LTI13 Apply Jon Postel's Law as appropriate U ::json_decodeMethod in class U Build an "always works" json_decode() K
$Context #keyProperty in class Context
Key Class in namespace Tsugi\Core This is a class to provide access to the resource key level data. $Key #keyProperty in class Key
Keyset Class in namespace Tsugi\Core $Launch #keyProperty in class Launch
Get the User associated with the launch. $User #keyProperty in class User
The logical key for this user in the 'lti_user' table. Aes ::keyExpansionMethod in class Aes Key expansion for Rijndael cipher(): performs key expansion on cipher key
to generate a key schedule $OAuthConsumer #keyProperty in class OAuthConsumer
$OAuthToken #keyProperty in class OAuthToken
KVS Class in namespace Tsugi\Util $KVS #KVS_TABLEProperty in class KVS
$KVS #KVS_FK_NAMEProperty in class KVS
$KVS #KVS_SK_NAMEProperty in class KVS
L
$ConfigInfo #langProperty in class ConfigInfo
$ConfigInfo #launcherrorProperty in class ConfigInfo
The path to an LTI-launch error handling page $ConfigInfo #lessonsProperty in class ConfigInfo
$ConfigInfo #lumen_storageProperty in class ConfigInfo
Storage location for Lumen Application. $ConfigInfo #launchactivityProperty in class ConfigInfo
$ConfigInfo #login_return_urlProperty in class ConfigInfo
$ConfigInfo #logout_return_urlProperty in class ConfigInfo
Defaults to $CFG->apphome if defined and $CFG->wwwroot if that is not defined or false $ConfigInfo #loaderProperty in class ConfigInfo
The autoloader to be used when loading classes. ConfigInfo ::localhostMethod in class ConfigInfo Are we on localhost? Login Class in namespace Tsugi\Controllers Logout Class in namespace Tsugi\Controllers Annotate ::loadAnnotationsMethod in class Annotate Load the Annotations Context ::loadNamesAndRolesMethod in class Context Load the roster if we can get it from the LMS Context ::loadLineItemsMethod in class Context Load our lineitems from the LMS Context ::loadLineItemMethod in class Context Load the detiail for a lineitem from the LMS Context ::loadResultsMethod in class Context Load the results for a line item Debug ::logMethod in class Debug $Entity #launchProperty in class Entity
A reference to our containing launch LTIX Class in namespace Tsugi\Core This an opinionated LTI class that defines how Tsugi tools interact with LTI LTIX ::launchCheckMethod in class LTIX Silently check if this is a launch and if so, handle it and redirect
back to ourselves LTIX ::ltiParameterMethod in class LTIX Pull a keyed variable from the LTI data in the current session with default LTIX ::ltiRawPostArrayMethod in class LTIX Return the original $_POST array LTIX ::ltiRawParameterMethod in class LTIX Pull a keyed variable from the original LTI post data in the current session with default LTIX ::ltiCustomGetMethod in class LTIX Pull out a custom variable from the LTIX session. Do not
include the "custom_" prefix - this is automatic. LTIX ::loadAllDataMethod in class LTIX Load the data from our lti_ tables using one long LEFT JOIN LTIX ::launchAuthorizationFlowMethod in class LTIX Handle the optional LTI pre 1.3 Launch Authorization flow LTIX ::ltiLinkUrlMethod in class LTIX ltiLinkUrl - Returns true if we can return LTI Links for this launch LTIX ::loginSecureCookieMethod in class LTIX Launch Class in namespace Tsugi\Core This captures all of the data associated with the LTI Launch. $Launch #linkProperty in class Launch
Get the Link associated with the launch. Launch ::ltiParameterArrayMethod in class Launch Pull a keyed variable from the LTI data in the current session with default Launch ::ltiParameterMethod in class Launch Pull a keyed variable from the LTI data in the current session with default Launch ::ltiParameterUpdateMethod in class Launch Update a keyed variable from the LTI data in the current session with default Launch ::ltiRawPostArrayMethod in class Launch Return the original $_POST array Launch ::ltiRawJWTMethod in class Launch Return the original JWT Launch ::ltiRawParameterMethod in class Launch Pull a keyed variable from the original LTI post data in the current session with default Launch ::ltiJWTClaimMethod in class Launch Pull a claim from the body of the Launch JWT Launch ::ltiMessageTypeMethod in class Launch Return the LTI 1.3 Message Type with Reasonable Fall Backs Launch ::ltiCustomGetMethod in class Launch Pull out a custom variable from the LTIX session. Link Class in namespace Tsugi\Core This is a class to provide access to the resource link level data. Link ::loadLinkInfoMethod in class Link Load link information for a different link than current $Result #lastSendTransportProperty in class Result
The transport used to send the most recent grade. Result ::lookupResultBypassMethod in class Result SessionTrait ::ltiRawPostArrayMethod in class SessionTrait Return the original $_POST array SessionTrait ::ltiParameterMethod in class SessionTrait Pull a keyed variable from the original LTI post data in the current session with default SessionTrait ::ltiParameterUpdateMethod in class SessionTrait Update a keyed variable from the original LTI post data in the current session with default SessionTrait ::ltiRawParameterMethod in class SessionTrait Pull a keyed variable from the original LTI post data in the current session with default SessionTrait ::ltiCustomGetMethod in class SessionTrait Pull out a custom variable from the LTIX session. Do not
include the "custom_" prefix - this is automatic. Settings ::linkSetAllMethod in class Settings Set all of the the link-level settings. Settings ::linkGetAllMethod in class Settings Retrieve an array of all of the link level settings Settings ::linkGetMethod in class Settings Retrieve a particular key from the link settings. Settings ::linkSetMethod in class Settings Set or update a key to a new value in link settings. Settings ::linkUpdateMethod in class Settings Set or update a number of keys to new values in link settings. Tool ::loadRegistrationMethod in class Tool $User #launchProperty in class User
$User #lastnameProperty in class User
The user's last name $User #localeProperty in class User
The User's Locale User ::loadUserInfoBypassMethod in class User Load a user's info from the user_id User ::loadUserInfoBypassBySubjectMethod in class User Load a user's info from the user's subbect AesCtr ::legacyEncryptMethod in class AesCtr $GoogleLogin #last_responseProperty in class GoogleLogin
GradeUtil ::loadGradesForCourseMethod in class GradeUtil Load all the grades for the current user / course including resource_link_id SimpleGradeDetail ::linkMethod in class SimpleGradeDetail LTIX Class in namespace Tsugi\Laravel This is a class to enable building Laravel Apps using Tsugi LTIX ::laravelSetupMethod in class LTIX OAuthDataStore ::lookup_consumerMethod in class OAuthDataStore OAuthDataStore ::lookup_tokenMethod in class OAuthDataStore OAuthDataStore ::lookup_nonceMethod in class OAuthDataStore TrivialOAuthDataStore ::lookup_consumerMethod in class TrivialOAuthDataStore TrivialOAuthDataStore ::lookup_tokenMethod in class TrivialOAuthDataStore TrivialOAuthDataStore ::lookup_nonceMethod in class TrivialOAuthDataStore Lessons Class in namespace Tsugi\UI $Lessons #lessonsProperty in class Lessons
All the lessons $MenuEntry #linkProperty in class MenuEntry
The link data $MenuSet #leftProperty in class MenuSet
The Left Menu $Output #launchProperty in class Output
A reference to our containing launch SettingsDialog ::linkMethod in class SettingsDialog Emit a properly styled "settings" link SettingsForm ::linkMethod in class SettingsForm Emit a properly styled "settings" link Theme ::luminosityPairMethod in class Theme Take a color, move a pair of colors outwards towards white and black
until the colors are at least as far apart as $difference $CC #last_typeProperty in class CC
$CC #last_fileProperty in class CC
$CC #last_identifierProperty in class CC
$CC #last_identifierrefProperty in class CC
Color ::luminanceMethod in class Color Calculate the relative luminance of an RGB color. GitRepo ::list_branchesMethod in class GitRepo Runs a git branch call GitRepo ::list_remote_branchesMethod in class GitRepo Lists remote branches (using git branch -r). GitRepo ::list_tagsMethod in class GitRepo List all the available repository tags. GitRepo ::logMethod in class GitRepo List log entries. HSLuv ::luvToXyzMethod in class HSLuv HSLuv ::luvToLchMethod in class HSLuv HSLuv ::lchToLuvMethod in class HSLuv HSLuv ::lchToHsluvMethod in class HSLuv HSLuv ::lchToHpluvMethod in class HSLuv HSLuv ::lchToRgbMethod in class HSLuv LTI Class in namespace Tsugi\Util This is a general purpose LTI class with no Tsugi-specific dependencies. LTI ::ltiLinkUrlMethod in class LTI ltiLinkUrl - Returns true if we can return LTI Links for this launch LTI13 Class in namespace Tsugi\Util This is a general purpose LTI 1.3 class with no Tsugi-specific dependencies. LTI13 ::loadNRPSMethod in class LTI13 Load the memberships and roles if we can get it from the LMS LTI13 ::loadLineItemsMethod in class LTI13 Load our lineitems from the LMS LTI13 ::loadLineItemMethod in class LTI13 Load the detiail for a lineitem from the LMS LTI13 ::loadResultsMethod in class LTI13 Load the results for a line item LTIConstants Class in namespace Tsugi\Util LinkHeader Class in namespace Tsugi\Util LinkHeaderItem Class in namespace Tsugi\Util PS ::lenMethod in class PS PS ::lowerMethod in class PS U ::lti_sha256Method in class U U ::lmsDieMethod in class U U ::line_outMethod in class U M
BlobUtil ::mkdirSha256Method in class BlobUtil BlobUtil ::maxUploadMethod in class BlobUtil BlobUtil ::maxUploadBytesMethod in class BlobUtil BlobUtil ::migrateMethod in class BlobUtil Check and migrate a blob from an old place to the right new place $ConfigInfo #migrateblobsProperty in class ConfigInfo
This turns on auto-migration of blobs from the database to dataroot, as
blobs are accessed $ConfigInfo #maildomainProperty in class ConfigInfo
Configure mail sending. $ConfigInfo #mailsecretProperty in class ConfigInfo
$ConfigInfo #maileolProperty in class ConfigInfo
Map Class in namespace Tsugi\Controllers Keyset ::maintainMethod in class Keyset Mail Class in namespace Tsugi\Core Mail utilities $SQLDialect #markerProperty in class SQLDialect
WebSocket ::makeTokenMethod in class WebSocket Build a plaintext token for a particular link_id $Entry #maxlenProperty in class Entry
The default maximum length of a serialized set of buckets $Lessons #moduleProperty in class Lessons
The individual module Lessons ::makeUrlResourceMethod in class Lessons Menu Class in namespace Tsugi\UI Our class to generate menus $Menu #menuProperty in class Menu
The entries - an array of MenuEntry objects MenuEntry Class in namespace Tsugi\UI Our class to generate menus MenuSet Class in namespace Tsugi\UI Our class to capture a set of top menus Output ::modalStringMethod in class Output Output ::menuNavMethod in class Output Output ::maxCacheHeaderMethod in class Output Table ::makeUrlMethod in class Table Table ::matchColumnsMethod in class Table Topics ::makeUrlResourceMethod in class Topics Caliper ::miniCaliperMethod in class Caliper Minimal Caliper Event GitRepo ::mergeMethod in class GitRepo Runs a git merge call LTI ::mapCustomNameMethod in class LTI Lower case and turn non letters / numbers into underscores per LTI 1.1 Mersenne_Twister Class in namespace Tsugi\Util This provides a deterministic pseudo-random sequence that is seedable Mimeparse Class in namespace Tsugi\Util 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. N
$ConfigInfo #noncecheckProperty in class ConfigInfo
Set the nonce clearing factor $ConfigInfo #noncetimeProperty in class ConfigInfo
Set the expiration time for nonces in seconds LTIX ::noteLoggedInMethod in class LTIX Update the login_at fields as appropriate Launch ::newLaunchMethod in class Launch set up parameters for an outbound launch from this launch OAuthDataStore ::new_request_tokenMethod in class OAuthDataStore OAuthDataStore ::new_access_tokenMethod in class OAuthDataStore TrivialOAuthDataStore ::new_request_tokenMethod in class TrivialOAuthDataStore TrivialOAuthDataStore ::new_access_tokenMethod in class TrivialOAuthDataStore Lessons ::nostyleUrlMethod in class Lessons Lessons ::nostyleLinkMethod in class Lessons Output ::noCacheHeaderMethod in class Output Output ::noBufferMethod in class Output SettingsDialog ::numberMethod in class SettingsDialog Handle a settings number box SettingsForm ::numberMethod in class SettingsForm Handle a settings number box Topics ::nostyleUrlMethod in class Topics Net Class in namespace Tsugi\Util This general purpose library for HTTP communications. O
Access ::openContentMethod in class Access $ConfigInfo #ownernameProperty in class ConfigInfo
Information on the owner of this system $ConfigInfo #owneremailProperty in class ConfigInfo
$ConfigInfo #OFFLINEProperty in class ConfigInfo
Effectively an "airplane mode" for the appliction. Profile ::optionMethod in class Profile LTIX ::oauth_parametersMethod in class LTIX The LTI parameter data $Launch #outputProperty in class Launch
Return the output helper class. $GoogleLogin #openid_realmProperty in class GoogleLogin
OAuthConsumer Class in namespace Tsugi\OAuth OAuthDataStore Class in namespace Tsugi\OAuth OAuthException Class in namespace Tsugi\OAuth OAuthRequest Class in namespace Tsugi\OAuth OAuthServer Class in namespace Tsugi\OAuth OAuthSignatureMethod Class in namespace Tsugi\OAuth OAuthSignatureMethod_HMAC_SHA1 Class in namespace Tsugi\OAuth OAuthSignatureMethod_HMAC_SHA256 Class in namespace Tsugi\OAuth OAuthSignatureMethod_PLAINTEXT Class in namespace Tsugi\OAuth OAuthSignatureMethod_RSA_SHA1 Class in namespace Tsugi\OAuth OAuthToken Class in namespace Tsugi\OAuth OAuthUtil Class in namespace Tsugi\OAuth Output Class in namespace Tsugi\UI Output ::output_theme_cssMethod in class Output Git ::openMethod in class Git Open an existing git repository P
$ConfigInfo #providekeysProperty in class ConfigInfo
Whether or not we accept key requests on this system $ConfigInfo #pdoProperty in class ConfigInfo
Database connection information to configure the PDO connection $ConfigInfo #pdo_optionsProperty in class ConfigInfo
Additional parameter for the PDO constructor with an array of key-value options $ConfigInfo #prefer_lti1_for_grade_sendProperty in class ConfigInfo
Profile Class in namespace Tsugi\Controllers Profile ::postProfileMethod in class Profile Activity ::pushCaliperEventsMethod in class Activity Send the backlog of caliper events, but don't overrun Activity ::purgeCaliperEventsMethod in class Activity Periodic cleanup of broken Caliper events ContentItem ::prepareResponseMethod in class ContentItem Make up a response $Context #PRIMARY_KEYProperty in class Context
DeepLinkResponse ::prepareResponseMethod in class DeepLinkResponse Make up a response $Key #PRIMARY_KEYProperty in class Key
LTIX ::populateRosterMethod in class LTIX populateRoster $Launch #pdoxProperty in class Launch
Return the PDOX connection used by Tsugi. $Link #PRIMARY_KEYProperty in class Link
Rest ::preFlightMethod in class Rest Preflight a REST request - handle OPTIONS $Result #PRIMARY_KEYProperty in class Result
SQLDialect ::patchDataTypesMethod in class SQLDialect SQLDialect ::patchPostgresQuotesMethod in class SQLDialect Tool ::patchRegistrationMethod in class Tool $User #PRIMARY_KEYProperty in class User
Png Class in namespace Tsugi\Image This is a set of PNG related libraries Png ::phpTextChunkMethod in class Png ExceptionHandler ::pleaseDontReportMethod in class ExceptionHandler Indicate an exception that should not be reported $OAuthRequest #POST_INPUTProperty in class OAuthRequest
OAuthUtil ::parse_parametersMethod in class OAuthUtil $Lessons #positionProperty in class Lessons
Output ::pageTitleMethod in class Output Table ::pagedQueryMethod in class Table Table ::pagedHeaderMethod in class Table Table ::pagedTableMethod in class Table Table ::pagedAutoMethod in class Table GitRepo ::pushMethod in class GitRepo Push specific branch to a remote GitRepo ::pullMethod in class GitRepo Pull specific branch from remote HSLuv ::p_toRgbMethod in class HSLuv HSLuv ::p_toHexMethod in class HSLuv HSLuv ::p_fromRgbMethod in class HSLuv HSLuv ::p_fromHexMethod in class HSLuv LTI ::postLaunchHTMLMethod in class LTI LTI ::parseContextMembershipsResponseMethod in class LTI LTI ::parseResponseMethod in class LTI LTI13 ::parse_jwtMethod in class LTI13 Parse and validate a raw JWT Mimeparse ::parse_mime_typeMethod in class Mimeparse Carves up a mime-type and returns an Array of the [type, subtype, params]
where "params" is a Hash of all the parameters for the media range. Mimeparse ::parse_media_rangeMethod in class Mimeparse Carves up a media range and returns an Array of the
[type, subtype, params] where "params" is a Hash of all
the parameters for the media range. Net ::parseHeadersMethod in class Net Extract a set of header lines into an array PDOXStatement Class in namespace Tsugi\Util This is our "improved" version of PDOStatement $PDOXStatement #PDOXProperty in class PDOXStatement
PS Class in namespace Tsugi\Util An Approximation of a Python String in PHP U ::print_stack_traceMethod in class U U ::parse_rest_pathMethod in class U Get the controller for the current request Q
Mimeparse ::quality_parsedMethod in class Mimeparse Find the best match for a given mime-type against a list of
media_ranges that have already been parsed by Mimeparser::parse_media_range() Mimeparse ::qualityMethod in class Mimeparse Returns the quality "q" of a mime-type when compared against
the media-ranges in ranges. For example: R
BlobUtil ::return_bytesMethod in class BlobUtil $ConfigInfo #redisProperty in class ConfigInfo
Adding in support for using Redis for session caching. $ConfigInfo #resource_type_prefixProperty in class ConfigInfo
Prefix for tool registration codes. $ConfigInfo #require_conformance_parametersProperty in class ConfigInfo
Analytics ::routesMethod in class Analytics Login ::routesMethod in class Login Logout ::routesMethod in class Logout Map ::routesMethod in class Map Profile ::routesMethod in class Profile Profile ::radioMethod in class Profile ContentItem ::returnUrlMethod in class ContentItem returnUrl - Returns the content_item_return_url LTIX ::requireDataMethod in class LTIX Handle launch and/or set up the LTI session and global variables LTIX ::requireDataOverrideMethod in class LTIX Handle the launch, but with the caller given the chance to override defaults LTIX ::restoreLTISessionMethod in class LTIX Restore an LTI session and check if it worked LTIX ::requireDataPrivateMethod in class LTIX Internal method to handle the data setup LTIX ::removeQueryStringMethod in class LTIX removeQueryString - Drop a query string from a url $Launch #resultProperty in class Launch
Get the Result associated with the launch. $Launch #request_parmsProperty in class Launch
Must be an array equivalent to $_REQUEST. If this is present
We do not assume access to $_POST or $_GET and we assume
that we cannot use header() so the caller must $Launch #redirect_urlProperty in class Launch
If this is non-null when we return, the caller must redirect to a GET of the same URL. Launch ::returnUrlMethod in class Launch Return the return Url $Link #result_idProperty in class Link
The result_id for the link (if set) Rest Class in namespace Tsugi\Core Helper class for Tsugi REST end points Result Class in namespace Tsugi\Core This is a class to provide access to the user's result data. Roster Class in namespace Tsugi\Core This is a class to provide access to roster information from a site. Tool ::runMethod in class Tool Entry ::reconstructMethod in class Entry Reconstruct to the actual times Entry ::reScaleMethod in class Entry Double the Scale - Return copy of new buckets GoogleClassroom ::retrieve_instructor_tokenMethod in class GoogleClassroom $GoogleLogin #redirectProperty in class GoogleLogin
Png ::removeTextChunksMethod in class Png Application ::resolveExceptionHandlerMethod in class Application Override the Exception Handler Application ::registerLogBindingsMethod in class Application Override the log bindings to use the php error log ExceptionHandler ::renderMethod in class ExceptionHandler Render an exception into an HTTP response. $Lessons #resource_linksProperty in class Lessons
Index by resource_link Lessons ::renderMethod in class Lessons Lessons ::renderSingleMethod in class Lessons Lessons ::renderAllMethod in class Lessons Lessons ::renderAssignmentsMethod in class Lessons Lessons ::renderBadgesMethod in class Lessons Lessons ::renderDiscussionsMethod in class Lessons $MenuSet #rightProperty in class MenuSet
The Right Menu Output ::returnMenuSetMethod in class Output $SettingsDialog #ready_overrideProperty in class SettingsDialog
SettingsDialog ::readyMethod in class SettingsDialog Check if we are ready to go Theme ::rgbToHslMethod in class Theme $Topics #resource_linksProperty in class Topics
Index by resource_link Topics ::renderMethod in class Topics Topics ::renderSingleMethod in class Topics Topics ::renderAllMethod in class Topics $CC #resource_countProperty in class CC
Color ::rgbMethod in class Color Convert a hex color to RGB. Color ::relativeLuminanceMethod in class Color Calculate the relative luminance of two colors. ContentItem ::returnUrlMethod in class ContentItem returnUrl - Returns the content_item_return_url DeepLinkRequest ::returnUrlMethod in class DeepLinkRequest returnUrl - Returns the deep_link_return_url $GitRepo #repo_pathProperty in class GitRepo
GitRepo ::run_commandMethod in class GitRepo Run a command in the git repository GitRepo ::runMethod in class GitRepo Run a git command in the git repository GitRepo ::rmMethod in class GitRepo Runs a git rm call HSLuv ::rgbToXyzMethod in class HSLuv HSLuv ::rgbToHexMethod in class HSLuv HSLuv ::rgbToLchMethod in class HSLuv HSLuv ::rgbToHsluvMethod in class HSLuv HSLuv ::rgbToHpluvMethod in class HSLuv LTI ::replaceResultRequestMethod in class LTI LTI13 ::raw_jwtMethod in class LTI13 Find the JWT in the request data LinkHeader ::removeRelMethod in class LinkHeader removes a certain relation PS ::replaceMethod in class PS PS ::rfindMethod in class PS TsugiDOM ::replace_textMethod in class TsugiDOM TsugiDOM ::replace_text_nsMethod in class TsugiDOM U ::route_get_local_pathMethod in class U U ::rest_pathMethod in class U Return a rest-path U ::reconstruct_queryMethod in class U U ::remove_relative_pathMethod in class U Remove any relative elements from a path UrlRouter ::routeMethod in class UrlRouter S
Access ::serveContentMethod in class Access Access ::serveContentOldMethod in class Access BlobUtil ::safeFileSuffixMethod in class BlobUtil BlobUtil ::setBackrefMethod in class BlobUtil Set the backref for a file entry $ConfigInfo #servicenameProperty in class ConfigInfo
This is how the system will refer to itself. $ConfigInfo #servicedescProperty in class ConfigInfo
This is how the system will describe itself. $ConfigInfo #slow_queryProperty in class ConfigInfo
The slow_query setting indicated when we want PDOX to log a query for being too slow. $ConfigInfo #staticrootProperty in class ConfigInfo
Set the URL prefix for the static content folder (i.e. on a CDN) $ConfigInfo #sessionsaltProperty in class ConfigInfo
Configure the security for constructing LTI Launch session IDs $ConfigInfo #storehideProperty in class ConfigInfo
Tools to hide in the store for non-admin users. Each tool sets their status
in their register.php with a line like:
"tool_phase" => "sample",
If this is null, then all tools are shown. $ConfigInfo #sessionlifetimeProperty in class ConfigInfo
Set the session timeout - in seconds ConfigInfo ::serverPrefixMethod in class ConfigInfo Return a prefix unique to this server for things like shared cache keys Activity ::sendCaliperEventMethod in class Activity Annotate ::storeAnnotationsMethod in class Annotate Store the Annotations Cache ::setMethod in class Cache Place an entry in the cache. $Context #secretProperty in class Context
Context ::sendLineItemResultMethod in class Context Send a lineitem result to the LMS I18N ::setLocaleMethod in class I18N Set the LOCAL for the current user I18N ::setupTextDomainMethod in class I18N Set up the translation entities JsonTrait ::setJsonMethod in class JsonTrait Set the JSON entry for this entity JsonTrait ::setJsonKeyMethod in class JsonTrait Set/update a JSON key for this entity JsonTrait ::setJsonKeysMethod in class JsonTrait Set/update an array of JSON keys for this entity $Key #secretProperty in class Key
LTIX ::setCookieStrongMethod in class LTIX LTIX ::setupSessionMethod in class LTIX Extract all of the post data, set up data in tables, and set up session. LTIX ::session_startMethod in class LTIX Optionally handle launch and/or set up the LTI session and global variables LTIX ::signParametersMethod in class LTIX signParameters - Look up the key and secret and call the underlying code in LTI LTIX ::settingsSendMethod in class LTIX Send settings to the LMS using the simple JSON approach $Launch #session_objectProperty in class Launch
If present, it means all session management is above us. Launch ::session_getMethod in class Launch Get a key from the session Launch ::session_putMethod in class Launch Set a key in the session Launch ::session_forgetMethod in class Launch Forget a key in the session Launch ::session_flushMethod in class Launch Flush the session Launch ::settingsCascadeMethod in class Launch Check for a setting starting nearby Link ::settingsDefaultsFromCustomMethod in class Link Load defaults from custom parameters once Mail ::sendMethod in class Mail Result ::setJsonForUserMethod in class Result Set JSON for a different user Result ::setJsonKeyForUserMethod in class Result Set a JSON key for a result for a different user Result ::setNoteMethod in class Result Set the Note for this result SQLDialect Class in namespace Tsugi\Core This is a helper class to transform MySQL and PgSQL dialects SQLDialect ::sqlPatchMethod in class SQLDialect SQLDialect ::sqlCreate2PostgresMethod in class SQLDialect SQLDialect ::sqlInsert2PostgresMethod in class SQLDialect SQLDialect ::sqlAlter2PostgresMethod in class SQLDialect SessionTrait Class in namespace Tsugi\Core This is a trait convienence methods to access the session from the launch object SessionTrait ::session_getMethod in class SessionTrait Get a key from the session SessionTrait ::session_putMethod in class SessionTrait Set a key in the session SessionTrait ::session_forgetMethod in class SessionTrait Forget a key in the session SessionTrait ::session_flushMethod in class SessionTrait Flush the session Settings Class in namespace Tsugi\Core This is a class to provide access to the setting service. SettingsTrait Class in namespace Tsugi\Core This is a class holding convienence methods to access settings from core objects. $SettingsTrait #settingsDebugArrayProperty in class SettingsTrait
SettingsTrait ::settingsGetAllMethod in class SettingsTrait Retrieve an array of all of the settings SettingsTrait ::settingsGetMethod in class SettingsTrait Retrieve a particular key from the settings. SettingsTrait ::settingsSetMethod in class SettingsTrait Update a single key in settings SettingsTrait ::settingsUpdateMethod in class SettingsTrait Set or update a number of keys to new values in link settings. SettingsTrait ::settingsSetAllMethod in class SettingsTrait Replace all the settings (Dangerous) SettingsTrait ::settingsDebugMethod in class SettingsTrait Retrieve the debug array for the last operation. Tool ::sendTemplatesMethod in class Tool SecureCookie Class in namespace Tsugi\Crypt SecureCookie ::setMethod in class SecureCookie $Entry #scaleProperty in class Entry
The scale in seconds Entry ::serializeMethod in class Entry Serialize to a key=value pair JWT ::signMethod in class JWT SimpleGradeDetail Class in namespace Tsugi\Grades $OAuthConsumer #secretProperty in class OAuthConsumer
OAuthRequest ::set_parameterMethod in class OAuthRequest OAuthRequest ::sign_requestMethod in class OAuthRequest $OAuthServer #signature_methodsProperty in class OAuthServer
$OAuthToken #secretProperty in class OAuthToken
OAuthUtil ::split_headerMethod in class OAuthUtil CrudForm ::selectSqlMethod in class CrudForm Produce the SELECT statement for a table, set of fields and where clause. $MenuEntry #SEPARATORProperty in class MenuEntry
The constant for a separator MenuEntry ::separatorMethod in class MenuEntry Construct a menu entry separator MenuSet ::setHomeMethod in class MenuSet Set the Home Menu Output ::splashPageMethod in class Output Outputs a splash page used if the tool is not configured or instructor has never been there before. Output ::setAppHeaderMethod in class Output Set header Content for any Tsugi-generated pages. Output ::setAppFooterMethod in class Output Set footer Content for any Tsugi-generated pages. Output ::safe_var_cleanupMethod in class Output Output ::safe_var_dumpMethod in class Output Output ::safe_print_rMethod in class Output SettingsDialog Class in namespace Tsugi\UI SettingsDialog ::startMethod in class SettingsDialog SettingsDialog ::selectMethod in class SettingsDialog Handle a settings selector box SettingsForm Class in namespace Tsugi\UI SettingsForm ::startMethod in class SettingsForm SettingsForm ::selectMethod in class SettingsForm Handle a settings selector box CC ::set_titleMethod in class CC CC ::set_descriptionMethod in class CC CC_Topic ::set_titleMethod in class CC_Topic CC_Topic ::set_textMethod in class CC_Topic CC_WebLink ::set_titleMethod in class CC_WebLink CC_WebLink ::set_urlMethod in class CC_WebLink Caliper ::smallCaliperMethod in class Caliper Required:
$json->data[0]->actor->id = $user;
$json->data[0]->object->{'@id'} = $path;
$json->eventTime = Caliper::getISO8601($timestamp); Caliper ::sensorCanvasPageViewMethod in class Caliper This is just a test method to return properly formatted JSON for the Canvas prototype Caliper Git ::set_binMethod in class Git Sets git executable path GitRepo ::set_repo_pathMethod in class GitRepo Set the repository's path GitRepo ::statusMethod in class GitRepo Runs a 'git status' call GitRepo ::set_descriptionMethod in class GitRepo Sets the project description. GitRepo ::setenvMethod in class GitRepo Sets custom environment options for calling Git KVS ::selectOneMethod in class KVS KVS ::selectAllMethod in class KVS LTI ::signParametersMethod in class LTI LTI ::sendOAuthGETMethod in class LTI LTI ::sendOAuthBodyMethod in class LTI LTI ::sendPOXGradeMethod in class LTI Send a grade using the LTI 1.1 protocol (POX) LTI ::sendJSONGradeMethod in class LTI Send a grade using the JSON protocol from IMS LTI 2.x LTI ::sendJSONSettingsMethod in class LTI Send setings data using the JSON protocol from IMS LTI 2.x LTI ::sendJSONBodyMethod in class LTI Send a JSON body LTI 2.x Style LTI13 ::sendLineItemResultMethod in class LTI13 Send a line item result LTI13 ::signLTI11TransitionMethod in class LTI13 Compute the OAuth signature for an LTI 1.3 Launch JWT LinkHeaderItem ::setUriMethod in class LinkHeaderItem Set a new URI. LinkHeaderItem ::setAttributeMethod in class LinkHeaderItem Set attribute Mersenne_Twister ::setSeedMethod in class Mersenne_Twister Mersenne_Twister ::shuffleMethod in class Mersenne_Twister Net ::send403Method in class Net Send a 403 header Net ::send400Method in class Net Send a 400 (Malformed request) header Net ::serverIPMethod in class Net Net ::setCookieStrongMethod in class Net Put as much oomph into setting a cookie as we can $PDOXStatement #successProperty in class PDOXStatement
$PDOXStatement #sqlQueryProperty in class PDOXStatement
$PDOXStatement #sqlOriginalQueryProperty in class PDOXStatement
PS ::setMethod in class PS PS ::sMethod in class PS PS ::startsWithMethod in class PS PS ::sliceMethod in class PS PS ::stripMethod in class PS emulate python strip() PS ::splitMethod in class PS emulate the Python split() TsugiDOM ::set_namespaceMethod in class TsugiDOM U ::session_safe_idMethod in class U U ::safe_hrefMethod in class U U ::success_outMethod in class U U ::startsWithMethod in class U U ::safe_var_dumpMethod in class U U ::safe_arrayMethod in class U U ::strlenMethod in class U Build a PHP 7 strlen for PHP 8.2 and later T
$ConfigInfo #timezoneProperty in class ConfigInfo
Default time zone - see http://www.php.net/. $ConfigInfo #testblobsProperty in class ConfigInfo
Configure lti keys that go into blob_blob regardless of $dataroot $ConfigInfo #tool_foldersProperty in class ConfigInfo
Indicate which directories to scan for tools. $ConfigInfo #themeProperty in class ConfigInfo
An array of css styles to apply to css variables used to skin Tsugi. $ConfigInfo #theme_baseProperty in class ConfigInfo
The color to be used as the theme base
This could optionally be overridden by a launch parameter $ConfigInfo #theme_dark_modeProperty in class ConfigInfo
A boolean indicator as to whether dark mode should be used
This could optionally be overridden by a launch parameter $ConfigInfo #tdiscusProperty in class ConfigInfo
The url of the installed instance of the tdiscus tool. $ConfigInfo #topicsProperty in class ConfigInfo
$Context #TABLE_NAMEProperty in class Context
$Context #titleProperty in class Context
The context title $Key #TABLE_NAMEProperty in class Key
$Key #titleProperty in class Key
The key title $Keyset #ttlProperty in class Keyset
$Link #TABLE_NAMEProperty in class Link
$Link #titleProperty in class Link
The link title $Result #TABLE_NAMEProperty in class Result
Tool Class in namespace Tsugi\Core Provide support for a Tsugi Tool $User #TABLE_NAMEProperty in class User
$Entry #timestartProperty in class Entry
The earliest time for the first bucket - default first entry $Entry #totalProperty in class Entry
The total number of clicks Application ::tsugiRerouteMethod in class Application tsugiReroute - Send the browser to a new location with session Application ::tsugiRedirectHomeMethod in class Application Application ::tsugiRedirectMethod in class Application Application ::tsugiFlashSuccessMethod in class Application tsugiFlashSuccess - Add a success message to the old and new flash session. Application ::tsugiFlashErrorMethod in class Application tsugiFlashError - Add an error message to the old and new flash session. OAuthRequest ::to_urlMethod in class OAuthRequest builds a url usable for a GET request OAuthRequest ::to_postdataMethod in class OAuthRequest builds the data one would send in a POST request OAuthRequest ::to_header_internalMethod in class OAuthRequest builds the Authorization: header OAuthRequest ::to_headerMethod in class OAuthRequest OAuthRequest ::to_alternate_headerMethod in class OAuthRequest $OAuthServer #timestamp_thresholdProperty in class OAuthServer
OAuthToken ::to_stringMethod in class OAuthToken generates the basic string serialization of a token that a server
would respond to request_token and access_token calls with TrivialOAuthDataStore Class in namespace Tsugi\OAuth A Trivial memory-based store - no support for tokens HandleBars ::templateIncludeMethod in class HandleBars templateInclude - Include a handlebars template, dealing with i18n HandleBars ::templateProcessMethod in class HandleBars templateProcess - Process a handlebars template, dealing with i18n Output ::templateIncludeMethod in class Output templateInclude - Include a handlebars template, dealing with i18n Output ::templateProcessMethod in class Output templateProcess - Process a handlebars template, dealing with i18n Output ::togglePreMethod in class Output Output ::togglePreScriptMethod in class Output Output ::topNavSessionMethod in class Output Store the top navigation in the session Output ::topNavMethod in class Output Emit the top navigation block and optionally the tool navigation SettingsDialog ::textMethod in class SettingsDialog Handle a settings text box SettingsDialog ::textareaMethod in class SettingsDialog Handle a settings textarea box SettingsForm ::textMethod in class SettingsForm Handle a settings text box SettingsForm ::textareaMethod in class SettingsForm Handle a settings textarea box Table Class in namespace Tsugi\UI Our class to generate pageable tables. Theme Class in namespace Tsugi\UI $Theme #theme_baseProperty in class Theme
Topics Class in namespace Tsugi\UI $Topics #topicsProperty in class Topics
All the topics $Topics #topicProperty in class Topics
The individual topic $Topics #topicpositionProperty in class Topics
FileRouter ::trimQueryMethod in class FileRouter GitRepo ::test_gitMethod in class GitRepo Tests if git is installed HSLuv ::toRgbMethod in class HSLuv HSLuv ::toRgbIntMethod in class HSLuv HSLuv ::toHexMethod in class HSLuv TsugiDOM Class in namespace Tsugi\Util Wrap the DOMDocument class with some convienence methods UrlRouter ::trimQueryMethod in class UrlRouter U
BlobUtil ::uploadTooLargeMethod in class BlobUtil BlobUtil ::uploadToBlobMethod in class BlobUtil uploadToBlob - returns blob_id or false BlobUtil ::uploadFileToBlobMethod in class BlobUtil Legacy code - returns array [id, sha256] BlobUtil ::uploadPathToBlobMethod in class BlobUtil Read a file off local disk and put it into a blob BlobUtil ::uploadFileToStringMethod in class BlobUtil $ConfigInfo #upgradingProperty in class ConfigInfo
Set to true to redirect all requests to the upgrading.php script $ConfigInfo #universal_analyticsProperty in class ConfigInfo
Configure universal analytics for this Tsugi instance. $ConfigInfo #unifyProperty in class ConfigInfo
Context ::updateLineItemMethod in class Context Update a lineitem in the LMS $Launch #userProperty in class Launch
Get the User associated with the launch. $Link #user_activityProperty in class Link
The count of the user's activity on this link at the moment of launch $Roster #urlProperty in class Roster
User Class in namespace Tsugi\Core This is a class to provide access to the resource context level data. AesCtr ::ursMethod in class AesCtr Entry ::uncompressEntryMethod in class Entry Optionally uncompress a serialized entry if it is compressed JWT ::urlsafeB64DecodeMethod in class JWT JWT ::urlsafeB64EncodeMethod in class JWT UI Class in namespace Tsugi\Grades OAuthRequest ::unset_parameterMethod in class OAuthRequest OAuthUtil ::urlencode_rfc3986Method in class OAuthUtil OAuthUtil ::urldecode_rfc3986Method in class OAuthUtil CrudForm ::updateFormMethod in class CrudForm Generate the HTML for an update form. KVS ::updateMethod in class KVS LTI13 ::updateLineItemMethod in class LTI13 Update a lineitem in the LMS PS ::upperMethod in class PS U Class in namespace Tsugi\Util Some really small, simple, and self-contained utility public static functions UrlRouter Class in namespace Tsugi\Util Simple URL Routing for "Old school" PHP apps V
BlobUtil ::validateUploadMethod in class BlobUtil Returns true if this is a good upload, an error string if not $ConfigInfo #verifypeerProperty in class ConfigInfo
Indicate whether the PHP on this server wants to verify SSL or not $ConfigInfo #vendorrootProperty in class ConfigInfo
$ConfigInfo #vendorincludeProperty in class ConfigInfo
$ConfigInfo #vendorstaticProperty in class ConfigInfo
Login ::viewLoginMethod in class Login Map ::viewMapMethod in class Map Map ::viewErrorMethod in class Map LTIX ::var_dumpMethod in class LTIX Dump out the internal data structures adssociated with the
current launch. Best if used within a pre tag. Launch ::var_dumpMethod in class Launch Dump out the internal data structures associated with the
current launch. Best if used within a pre tag. Entry ::viewModelMethod in class Entry Produce an view model of the entire object $OAuthRequest #versionProperty in class OAuthRequest
$OAuthServer #versionProperty in class OAuthServer
OAuthServer ::verify_requestMethod in class OAuthServer verify an api call, checks all the parameters CrudForm ::valueToFieldMethod in class CrudForm Maps a default value to a field. KVS ::validateMethod in class KVS Validate a kvs record LTI ::verifyKeyAndSecretMethod in class LTI Verify the message signature for this request LTI13 ::verifyPublicKeyMethod in class LTI13 Verify the Public Key for this request $Net #VERIFY_PEERProperty in class Net
W
$ConfigInfo #wwwrootProperty in class ConfigInfo
The URL where tsugi is located $ConfigInfo #websocket_secretProperty in class ConfigInfo
If we have a web socket server, put its URL here
Do not add a path here - just the host and port
Make sure the port is open on your server $ConfigInfo #websocket_urlProperty in class ConfigInfo
$ConfigInfo #websocket_proxyportProperty in class ConfigInfo
LTIX ::wrapped_session_getMethod in class LTIX Wrap getting a key from the session LTIX ::wrapped_session_allMethod in class LTIX Get all session values LTIX ::wrapped_session_putMethod in class LTIX Wrap setting a key from the session LTIX ::wrapped_session_forgetMethod in class LTIX Wrap forgetting a key from the session LTIX ::wrapped_session_flushMethod in class LTIX Wrap flushing the session WebSocket Class in namespace Tsugi\Core This class contains the server side of Tsugi notification web sockets Output ::welcomeUserCourseMethod in class Output Welcome the user to the course $Topics #warpwire_baseurlProperty in class Topics
Git ::windows_modeMethod in class Git Sets up library for use in a default Windows environment X
Output ::xmlErrorMethod in class Output Output ::xmlAuthErrorMethod in class Output Output ::xmlOutputMethod in class Output HSLuv ::xyzToRgbMethod in class HSLuv HSLuv ::xyzToLuvMethod in class HSLuv Y
$ConfigInfo #youtube_urlProperty in class ConfigInfo
The url of the installed YouTube tool Z
CC ::zip_add_url_to_moduleMethod in class CC CC ::zip_add_lti_to_moduleMethod in class CC CC ::zip_add_lti_outcome_to_moduleMethod in class CC CC ::zip_add_topic_to_moduleMethod in class CC _
ConfigInfo ::__constructMethod in class ConfigInfo Create the configuration object. DeepLinkResponse ::__constructMethod in class DeepLinkResponse I18N ::_mMethod in class I18N Translate a messege from the master domain I18N ::_meMethod in class I18N Echo translated a message from the master domain I18N ::_eMethod in class I18N Echo a translated message from a textdomain I18N ::__Method in class I18N Translate a messege from the master domain Tool ::__constructMethod in class Tool Entry ::__constructMethod in class Entry GoogleLogin ::__constructMethod in class GoogleLogin Application ::__constructMethod in class Application Requires a Tsugi Launch object for initializing. OAuthConsumer ::__constructMethod in class OAuthConsumer OAuthConsumer ::__toStringMethod in class OAuthConsumer OAuthRequest ::__constructMethod in class OAuthRequest OAuthRequest ::__toStringMethod in class OAuthRequest OAuthServer ::__constructMethod in class OAuthServer OAuthToken ::__constructMethod in class OAuthToken key = the token
secret = the token secret OAuthToken ::__toStringMethod in class OAuthToken Lessons ::__constructMethod in class Lessons MenuEntry ::__constructMethod in class MenuEntry Construct a menu entry from a link and href SettingsDialog ::__constructMethod in class SettingsDialog Construct us with with a container that has a settings trait and launch Topics ::__constructMethod in class Topics CC ::__constructMethod in class CC CC_LTI_Outcome ::__constructMethod in class CC_LTI_Outcome CC_Topic ::__constructMethod in class CC_Topic CC_WebLink ::__constructMethod in class CC_WebLink ContentItem ::__constructMethod in class ContentItem DeepLinkRequest ::__constructMethod in class DeepLinkRequest DeepLinkResponse ::__constructMethod in class DeepLinkResponse GitRepo ::__constructMethod in class GitRepo Constructor KVS ::__constructMethod in class KVS LinkHeader ::__constructMethod in class LinkHeader Constructor LinkHeader ::__toStringMethod in class LinkHeader Cast contents to string. LinkHeaderItem ::__constructMethod in class LinkHeaderItem Constructor. LinkHeaderItem ::__toStringMethod in class LinkHeaderItem cast item to string Mersenne_Twister ::__constructMethod in class Mersenne_Twister PDOXStatement ::__constructMethod in class PDOXStatement PS ::__constructMethod in class PS PS ::__toStringMethod in class PS TsugiDOM ::__constructMethod in class TsugiDOM