Skip to content

Commit

Permalink
Renaming global functions to include lti prefix
Browse files Browse the repository at this point in the history
  • Loading branch information
scriby committed Nov 7, 2011
1 parent b9b2e7b commit dbb0fec
Show file tree
Hide file tree
Showing 3 changed files with 190 additions and 190 deletions.
20 changes: 10 additions & 10 deletions mod/lti/locallib.php
Expand Up @@ -120,11 +120,11 @@ function lti_view($instance, $makeobject=false) {
$requestparams["oauth_callback"] = "about:blank";

$submittext = get_string('press_to_submit', 'lti');
$parms = sign_parameters($requestparams, $endpoint, "POST", $key, $secret, $submittext, $orgid /*, $orgdesc*/);
$parms = lti_sign_parameters($requestparams, $endpoint, "POST", $key, $secret, $submittext, $orgid /*, $orgdesc*/);

$debuglaunch = ( $instance->debuglaunch == 1 );

$content = post_launch_html($parms, $endpoint, $debuglaunch);
$content = lti_post_launch_html($parms, $endpoint, $debuglaunch);

echo $content;
}
Expand Down Expand Up @@ -219,13 +219,13 @@ function lti_build_request($instance, $typeconfig, $course) {
$custom = array();
$instructorcustom = array();
if ($customstr) {
$custom = split_custom_parameters($customstr);
$custom = lti_split_custom_parameters($customstr);
}
if (!isset($typeconfig['allowinstructorcustom']) || $typeconfig['allowinstructorcustom'] == 0) {
$requestparams = array_merge($custom, $requestparams);
} else {
if ($instructorcustomstr) {
$instructorcustom = split_custom_parameters($instructorcustomstr);
$instructorcustom = lti_split_custom_parameters($instructorcustomstr);
}
foreach ($instructorcustom as $key => $val) {
if (array_key_exists($key, $custom)) {
Expand All @@ -247,7 +247,7 @@ function lti_build_request($instance, $typeconfig, $course) {
*
* @return Array of custom parameters
*/
function split_custom_parameters($customstr) {
function lti_split_custom_parameters($customstr) {
$textlib = textlib_get_instance();

$lines = preg_split("/[\n;]/", $customstr);
Expand All @@ -259,7 +259,7 @@ function split_custom_parameters($customstr) {
}
$key = trim($textlib->substr($line, 0, $pos));
$val = trim($textlib->substr($line, $pos+1));
$key = map_keyname($key);
$key = lti_map_keyname($key);
$retval['custom_'.$key] = $val;
}
return $retval;
Expand All @@ -272,7 +272,7 @@ function split_custom_parameters($customstr) {
*
* @return string Processed name
*/
function map_keyname($key) {
function lti_map_keyname($key) {
$textlib = textlib_get_instance();

$newkey = "";
Expand Down Expand Up @@ -778,7 +778,7 @@ function lti_update_config($config) {
* @param $orgid LMS name
* @param $orgdesc LMS key
*/
function sign_parameters($oldparms, $endpoint, $method, $oauthconsumerkey, $oauthconsumersecret, $submittext, $orgid /*, $orgdesc*/) {
function lti_sign_parameters($oldparms, $endpoint, $method, $oauthconsumerkey, $oauthconsumersecret, $submittext, $orgid /*, $orgdesc*/) {
global $lastbasestring;
$parms = $oldparms;
$parms["lti_version"] = "LTI-1p0";
Expand Down Expand Up @@ -814,7 +814,7 @@ function sign_parameters($oldparms, $endpoint, $method, $oauthconsumerkey, $oaut
* @param $endpoint URL of the external tool
* @param $debug Debug (true/false)
*/
function post_launch_html($newparms, $endpoint, $debug=false) {
function lti_post_launch_html($newparms, $endpoint, $debug=false) {
global $lastbasestring;

$r = "<form action=\"".$endpoint."\" name=\"ltiLaunchForm\" id=\"ltiLaunchForm\" method=\"post\" encType=\"application/x-www-form-urlencoded\">\n";
Expand Down Expand Up @@ -898,7 +898,7 @@ function post_launch_html($newparms, $endpoint, $debug=false) {
* @param bool $allgroup print all groups info if user can access all groups, suitable for index.php
* @return string
*/
function submittedlink($cm, $allgroups=false) {
function lti_submittedlink($cm, $allgroups=false) {
global $CFG;

$submitted = '';
Expand Down
10 changes: 5 additions & 5 deletions mod/lti/simpletest/testlocallib.php
Expand Up @@ -55,13 +55,13 @@
class lti_locallib_test extends UnitTestCase {
public static $includecoverage = array('mod/lti/locallib.php');
function test_split_custom_parameters() {
$this->assertEqual(split_custom_parameters("x=1\ny=2"),
$this->assertEqual(lti_split_custom_parameters("x=1\ny=2"),
array('custom_x' => '1', 'custom_y'=> '2'));
$this->assertEqual(split_custom_parameters('x=1;y=2'),
$this->assertEqual(lti_split_custom_parameters('x=1;y=2'),
array('custom_x' => '1', 'custom_y'=> '2'));
$this->assertEqual(split_custom_parameters('Review:Chapter=1.2.56'),
$this->assertEqual(lti_split_custom_parameters('Review:Chapter=1.2.56'),
array('custom_review_chapter' => '1.2.56'));
$this->assertEqual(split_custom_parameters('Complex!@#$^*(){}[]KEY=Complex!@#$^*(){}[]Value'),
$this->assertEqual(lti_split_custom_parameters('Complex!@#$^*(){}[]KEY=Complex!@#$^*(){}[]Value'),
array('custom_complex____________key' => 'Complex!@#$^*(){}[]Value'));
$this->assertEqual(5, 5);
}
Expand All @@ -71,7 +71,7 @@ function test_sign_parameters() {

$requestparams = array('resource_link_id' => '123', 'resource_link_title' => 'Weekly Blog', 'user_id' => '789', 'roles' => 'Learner', 'context_id' => '12345', 'context_label' => 'SI124', 'context_title' => 'Social Computing');

$parms = sign_parameters($requestparams, 'http://www.imsglobal.org/developer/LTI/tool.php', 'POST',
$parms = lti_sign_parameters($requestparams, 'http://www.imsglobal.org/developer/LTI/tool.php', 'POST',
'lmsng.school.edu', 'secret', 'Click Me', 'lmsng.school.edu' /*, $org_desc*/);
$this->assertTrue(isset($parms['oauth_nonce']));
$this->assertTrue(isset($parms['oauth_signature']));
Expand Down

0 comments on commit dbb0fec

Please sign in to comment.