External tool - Revision history

Mudrd8mz: Text replacement - "`" to ""`


2021-07-15T08:18:59Z
Text replacement - "<code (.*)>" to "<syntaxhighlight lang="$1">"

				
				
				
				
				
				← Older revision
				Revision as of 08:18, 15 July 2021
				
Line 17:
Line 17:
The request is routed to the LTI source plugin by using the message type.  For example, let's say this request was sent to the External Tool: The request is routed to the LTI source plugin by using the message type.  For example, let's say this request was sent to the External Tool:



<code xml> <syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<imsx_POXEnvelopeRequest xmlns="http://www.imsglobal.org/services/ltiv1p1/xsd/imsoms_v1p0"> <imsx_POXEnvelopeRequest xmlns="http://www.imsglobal.org/services/ltiv1p1/xsd/imsoms_v1p0">



Mudrd8mz: Text replacement - "" to ""

2021-07-14T13:31:05Z
Text replacement - "<code php>" to "<syntaxhighlight lang="php">"

				
				
				
				
				
				← Older revision
				Revision as of 13:31, 14 July 2021
				
Line 41:
Line 41:
In the above request, the message type is '''myCustomRequest'''.  Since this is not a standard request, a LTI source plugin can handle it.  We can do this by adding a LTI source plugin and for this example, we will call it ''widget''.  Then, in our ''ltisource_widget'' plugin, we must define a specific function In order to handle the request.  The function name takes on the form of '''component'''_'''messageType'''.  So, for our above request example we would create ''mod/lti/source/widget/lib.php'' and add this function to the file: In the above request, the message type is '''myCustomRequest'''.  Since this is not a standard request, a LTI source plugin can handle it.  We can do this by adding a LTI source plugin and for this example, we will call it ''widget''.  Then, in our ''ltisource_widget'' plugin, we must define a specific function In order to handle the request.  The function name takes on the form of '''component'''_'''messageType'''.  So, for our above request example we would create ''mod/lti/source/widget/lib.php'' and add this function to the file:



<code php> <syntaxhighlight lang="php">
/** /**
  * Handle a custom widget request.   * Handle a custom widget request.
Line 81:
Line 81:
A LTI source plugin can add itself to the add activities menu by implementing a '''component'''_get_types function in its lib.php file.  So, for example, if our LTI source plugin was ''widget'', then in ''mod/lti/source/widget/lib.php'' we would add the following function: A LTI source plugin can add itself to the add activities menu by implementing a '''component'''_get_types function in its lib.php file.  So, for example, if our LTI source plugin was ''widget'', then in ''mod/lti/source/widget/lib.php'' we would add the following function:



<code php> <syntaxhighlight lang="php">
function ltisource_widget_get_types() { function ltisource_widget_get_types() {
     $types   = array();      $types   = array();
Line 96:
Line 96:
But, this on its own doesn't actually do much at the moment.  You must also add another callback that gets called from the External Tool add instance form.  The callback takes on the form of '''component'''_add_instance_hook.  So, also add this function to ''mod/lti/source/widget/lib.php'': But, this on its own doesn't actually do much at the moment.  You must also add another callback that gets called from the External Tool add instance form.  The callback takes on the form of '''component'''_add_instance_hook.  So, also add this function to ''mod/lti/source/widget/lib.php'':



<code php> <syntaxhighlight lang="php">
function ltisource_widget_add_instance_hook() { function ltisource_widget_add_instance_hook() {
     // Do custom work here.      // Do custom work here.
Line 131:
Line 131:



====Sample implementation==== ====Sample implementation====
<code php> <syntaxhighlight lang="php">
// Prepare the request. // Prepare the request.
$request = lti_build_content_item_selection_request($id, $course, $returnurl, $title, $text, [], []); $request = lti_build_content_item_selection_request($id, $course, $returnurl, $title, $text, [], []);



Mudrd8mz: Text replacement - "" to ""
2021-07-14T13:09:41Z
Text replacement - "</code>" to "</syntaxhighlight>"

				
				
				
				
				
				← Older revision
				Revision as of 13:09, 14 July 2021
				
Line 37:
Line 37:
     </imsx_POXBody>      </imsx_POXBody>
</imsx_POXEnvelopeRequest> </imsx_POXEnvelopeRequest>
</code> </syntaxhighlight>



In the above request, the message type is '''myCustomRequest'''.  Since this is not a standard request, a LTI source plugin can handle it.  We can do this by adding a LTI source plugin and for this example, we will call it ''widget''.  Then, in our ''ltisource_widget'' plugin, we must define a specific function In order to handle the request.  The function name takes on the form of '''component'''_'''messageType'''.  So, for our above request example we would create ''mod/lti/source/widget/lib.php'' and add this function to the file: In the above request, the message type is '''myCustomRequest'''.  Since this is not a standard request, a LTI source plugin can handle it.  We can do this by adding a LTI source plugin and for this example, we will call it ''widget''.  Then, in our ''ltisource_widget'' plugin, we must define a specific function In order to handle the request.  The function name takes on the form of '''component'''_'''messageType'''.  So, for our above request example we would create ''mod/lti/source/widget/lib.php'' and add this function to the file:
Line 69:
Line 69:
     echo $responsexml->asXML();      echo $responsexml->asXML();
} }
</code> </syntaxhighlight>



'''Word of warning:''' If more than one LTI source plugins implement a function for handling the ''myCustomRequest'' message, then an exception will be thrown.  So, when coming up with names for your message types, try to keep them unique and perhaps prefix them with something unique about your service. '''Word of warning:''' If more than one LTI source plugins implement a function for handling the ''myCustomRequest'' message, then an exception will be thrown.  So, when coming up with names for your message types, try to keep them unique and perhaps prefix them with something unique about your service.
Line 92:
Line 92:
     return $types;      return $types;
} }
</code> </syntaxhighlight>



But, this on its own doesn't actually do much at the moment.  You must also add another callback that gets called from the External Tool add instance form.  The callback takes on the form of '''component'''_add_instance_hook.  So, also add this function to ''mod/lti/source/widget/lib.php'': But, this on its own doesn't actually do much at the moment.  You must also add another callback that gets called from the External Tool add instance form.  The callback takes on the form of '''component'''_add_instance_hook.  So, also add this function to ''mod/lti/source/widget/lib.php'':
Line 100:
Line 100:
     // Do custom work here.      // Do custom work here.
} }
</code> </syntaxhighlight>



At this point, the most common use case is to redirect to an external site to browse ''widget-like'' content.  Then the '''Extending the LTI protocol''' section can be used to create ''widget-like'' content in Moodle. At this point, the most common use case is to redirect to an external site to browse ''widget-like'' content.  Then the '''Extending the LTI protocol''' section can be used to create ''widget-like'' content in Moodle.
Line 137:
Line 137:
// Get the launch HTML. // Get the launch HTML.
$content = lti_post_launch_html($request->params, $request->url, false); $content = lti_post_launch_html($request->params, $request->url, false);
</code> </syntaxhighlight>



==See also== ==See also==
* [https://www.imsglobal.org/specs/lticiv1p0 Learning Tools Interoperability® Content-Item Message] * [https://www.imsglobal.org/specs/lticiv1p0 Learning Tools Interoperability® Content-Item Message]



Fpataleta: Developer documentation for LTI Content-Item Message
2016-11-30T03:20:32Z
Developer documentation for LTI Content-Item Message

				
				
				
				
				
				← Older revision
				Revision as of 03:20, 30 November 2016
				
Line 103:
Line 103:



At this point, the most common use case is to redirect to an external site to browse ''widget-like'' content.  Then the '''Extending the LTI protocol''' section can be used to create ''widget-like'' content in Moodle. At this point, the most common use case is to redirect to an external site to browse ''widget-like'' content.  Then the '''Extending the LTI protocol''' section can be used to create ''widget-like'' content in Moodle.

==LTI Content-Item==
Support for the LTI Content-Item message type in mod_lti has been implemented since Moodle 3.2. The Content-Item message type enables tool consumers to select content from a tool provider that also supports the Content-Item message type. Content selection can range from LTI links, HTML content, and even multimedia data (e.g. images, video, audio, etc).

In Moodle 3.2, LTI Content-Item is being used to fetch tool configuration data from a tool provider that can be used to configure an external tool activity. This is done using the ''Select content'' button on the External tool configuration page which launches a modal dialogue containing an interface from the Tool Provider that allows the user to fetch the tool configuration data. Hopefully, in future releases, additional features will be added, such as fetching and attaching content to an editor.

{{Moodle 3.2}}
===lti_build_content_item_selection_request()===
For developers who would like to send a ContentItemSelectionRequest to a Tool Provider, the function '''''lti_build_content_item_selection_request()''''' can be used. This function returns an object that contains the signed request parameters and the URL to the Tool Provider's Content-Item selection interface. It has the following parameters:

====Required parameters====
* '''$id''' ''int'' - The tool type's ID (from in the lti_types table).
* '''$course''' ''stdClass'' - The course object.
* '''$returnurl''' ''moodle_url'' - The return URL in the tool consumer (TC) that the tool provider (TP) will use to return the response for the Content-Item selection request. 

====Optional parameters====
* '''$title''' ''string'' - The tool's title, if available.
* '''$text''' ''string'' - The text to display to represent the content item. This value may be a long description of the content item.
* '''$mediatypes''' ''array'' - Array of MIME types types supported by the TC. If empty, the TC will support ltilink by default.
* '''$presentationtargets''' ''array'' - Array of ways in which the selected content item(s) can be requested to be opened (via the presentationDocumentTarget element for a returned content item). If empty, "frame", "iframe", and "window" will be supported by default.
* '''$autocreate''' ''bool'' - Indicates whether any content items returned by the TP would be automatically persisted.
* '''$multiple''' ''bool'' - Indicates whether the user should be permitted to select more than one item. False by default. any option for the user to cancel the operation. False by default.
* '''$unsigned''' ''bool'' - Indicates whether the TC is willing to accept an unsigned return message, or not. A signed message should always be required when the content item is being created automatically in the TC without further interaction from the user. False by default.
* '''$canconfirm''' ''bool'' - Flag for can_confirm parameter. False by default.
* '''$copyadvice''' ''bool'' - Indicates whether the TC is able and willing to make a local copy of a content item. False by default.
For more information about the request parameters, see [https://www.imsglobal.org/specs/lticiv1p0/specification-3 Content-Item Message - Information Model].

====Sample implementation====
<code php>
// Prepare the request.
$request = lti_build_content_item_selection_request($id, $course, $returnurl, $title, $text, [], []);

// Get the launch HTML.
$content = lti_post_launch_html($request->params, $request->url, false);
</code>

==See also==
* [https://www.imsglobal.org/specs/lticiv1p0 Learning Tools Interoperability® Content-Item Message]



Bushido: /* Addition to the add activities menu */
2014-05-16T19:54:33Z
Addition to the add activities menu

				
				
				
				
				
				← Older revision
				Revision as of 19:54, 16 May 2014
				
Line 102:
Line 102:
</code> </code>



At this point, the most common use case is to redirect to an external site to browse ''widget'' like content.  Then the '''Extending the LTI protocol''' section can be used to create ''widget'' content in Moodle. At this point, the most common use case is to redirect to an external site to browse ''widget-like'' content.  Then the '''Extending the LTI protocol''' section can be used to create ''widget-like'' content in Moodle.



Bushido at 18:55, 16 May 2014
2014-05-16T18:55:56Z


				
				
				
				
				
				← Older revision
				Revision as of 18:55, 16 May 2014
				
Line 27:
Line 27:
     </imsx_POXHeader>      </imsx_POXHeader>
     <imsx_POXBody>      <imsx_POXBody>
         <widgetCustomRequest><!-- LOOK HERE! -->          <myCustomRequest><!-- LOOK HERE! -->
             <widgetRecord><!-- This can be named whatever you want -->              <myRecord><!-- This can be named whatever you want -->
                 <sourcedGUID>                  <sourcedGUID>
                     <sourcedId>3124567</sourcedId>                      <sourcedId>3124567</sourcedId>
                 </sourcedGUID>                  </sourcedGUID>
                 <!-- You custom data in XML format -->                  <!-- You custom data in XML format -->
             </widgetRecord>              </myRecord>
         </widgetCustomRequest>          </myCustomRequest>
     </imsx_POXBody>      </imsx_POXBody>
</imsx_POXEnvelopeRequest> </imsx_POXEnvelopeRequest>
</code> </code>



In the above request, the message type is '''widgetCustomRequest'''.  Since this is not a standard request, a LTI source plugin can handle it.  We can do this by adding a LTI source plugin and for this example, we will call it ''widget''.  Then, in our ''ltisource_widget'' plugin, we must define a specific function In order to handle the request.  The function name takes on the form of '''component'''_'''messageType'''.  So, for our above request example we would create ''mod/lti/source/widget/lib.php'' and add this function to the file: In the above request, the message type is '''myCustomRequest'''.  Since this is not a standard request, a LTI source plugin can handle it.  We can do this by adding a LTI source plugin and for this example, we will call it ''widget''.  Then, in our ''ltisource_widget'' plugin, we must define a specific function In order to handle the request.  The function name takes on the form of '''component'''_'''messageType'''.  So, for our above request example we would create ''mod/lti/source/widget/lib.php'' and add this function to the file:



<code php> <code php>
Line 47:
Line 47:
  * @param object $data The LTI request details   * @param object $data The LTI request details
  */   */
function ltisource_widget_widgetCustomRequest($data) { function ltisource_widget_myCustomRequest($data) {
     $data->body;         // The raw LTI request XML body.      $data->body;         // The raw LTI request XML body.
     $data->xml;          // A SimpleXMLElement of the XML body.      $data->xml;          // A SimpleXMLElement of the XML body.
Line 71:
Line 71:
</code> </code>



'''Word of warning:''' If more than one LTI source plugins implement a function for handling the ''widgetCustomRequest'' message, then an exception will be thrown.  So, when coming up with names for your message types, try to keep them unique and perhaps prefix them with something unique about your service. '''Word of warning:''' If more than one LTI source plugins implement a function for handling the ''myCustomRequest'' message, then an exception will be thrown.  So, when coming up with names for your message types, try to keep them unique and perhaps prefix them with something unique about your service.



And that's about it!  With this extension point, you can build deep integrations with external services all while communicating through the LTI protocol. And that's about it!  With this extension point, you can build deep integrations with external services all while communicating through the LTI protocol.





Bushido: /* LTI Source Plugins */
2014-05-16T18:52:58Z
LTI Source Plugins

				
				
				
				
				
				← Older revision
				Revision as of 18:52, 16 May 2014
				
Line 4:
Line 4:
== LTI Source Plugins == == LTI Source Plugins ==



The External tool supports sub plugins that live under the ''mod/lti/source'' directory with the plugin type of ''ltisource''.  The purpose of a LTI source plugin is to extend the functionality of the External Tool activity.  Those extensions are discussed below. The External tool supports sub plugins that live under the ''mod/lti/source'' directory with the plugin type of ''ltisource''.  The purpose of a LTI source plugin is to extend the functionality of the External Tool activity.
 
The LTI source plugins support the following standard plugin features:
 
* Language file: ''mod/lti/source/pluginname/lang/en/ltisource_pluginname.php''
* [[Upgrade_API| Plugin upgrade API]] under the ''mod/lti/source/pluginname/db'' directory.



=== Extending the LTI protocol === === Extending the LTI protocol ===



Bushido: /* Addition to the add activities menu */
2014-05-16T17:59:36Z
Addition to the add activities menu

				
				
				
				
				
				← Older revision
				Revision as of 17:59, 16 May 2014
				
Line 74:
Line 74:
Overall, the following has a narrow use case, but it might be expanded in the future. Overall, the following has a narrow use case, but it might be expanded in the future.



A LTI source plugin can add itself to the [[Course_homepage#Activities_and_resources|add activities menu]] A LTI source plugin can add itself to the add activities menu by implementing a '''component'''_get_types function in its lib.php file.  So, for example, if our LTI source plugin was ''widget'', then in ''mod/lti/source/widget/lib.php'' we would add the following function:
 
<code php>
function ltisource_widget_get_types() {
    $types   = array();
    $types[] = (object) array(
        'modclass' => MOD_CLASS_ACTIVITY,
        'type'     => 'lti&amp;type=widget',
        'typestr'  => get_string('addwidget', 'ltisource_widget'),
        'help'     => get_string('addwidget_help', 'ltisource_widget'),
    );
    return $types;
}
</code>
 
But, this on its own doesn't actually do much at the moment.  You must also add another callback that gets called from the External Tool add instance form.  The callback takes on the form of '''component'''_add_instance_hook.  So, also add this function to ''mod/lti/source/widget/lib.php'':
 
<code php>
function ltisource_widget_add_instance_hook() {
    // Do custom work here.
}
</code>
 
At this point, the most common use case is to redirect to an external site to browse ''widget'' like content.  Then the '''Extending the LTI protocol''' section can be used to create ''widget'' content in Moodle.



Bushido at 17:45, 16 May 2014
2014-05-16T17:45:16Z


				
				
				
				
				
				← Older revision
				Revision as of 17:45, 16 May 2014
				
Line 69:
Line 69:



And that's about it!  With this extension point, you can build deep integrations with external services all while communicating through the LTI protocol. And that's about it!  With this extension point, you can build deep integrations with external services all while communicating through the LTI protocol.

=== Addition to the add activities menu ===

Overall, the following has a narrow use case, but it might be expanded in the future.

A LTI source plugin can add itself to the [[Course_homepage#Activities_and_resources|add activities menu]]



Bushido at 17:38, 16 May 2014
2014-05-16T17:38:56Z


				
				
				
				
				
				← Older revision
				Revision as of 17:38, 16 May 2014
				
Line 65:
Line 65:
} }
</code> </code>

'''Word of warning:''' If more than one LTI source plugins implement a function for handling the ''widgetCustomRequest'' message, then an exception will be thrown.  So, when coming up with names for your message types, try to keep them unique and perhaps prefix them with something unique about your service.

And that's about it!  With this extension point, you can build deep integrations with external services all while communicating through the LTI protocol.

← Older revision		Revision as of 08:18, 15 July 2021
Line 17:		Line 17:
	The request is routed to the LTI source plugin by using the message type. For example, let's say this request was sent to the External Tool:		The request is routed to the LTI source plugin by using the message type. For example, let's say this request was sent to the External Tool:

	<~~code~~ xml>		<syntaxhighlight lang="xml">
	<?xml version="1.0" encoding="UTF-8"?>		<?xml version="1.0" encoding="UTF-8"?>
	<imsx_POXEnvelopeRequest xmlns="http://www.imsglobal.org/services/ltiv1p1/xsd/imsoms_v1p0">		<imsx_POXEnvelopeRequest xmlns="http://www.imsglobal.org/services/ltiv1p1/xsd/imsoms_v1p0">

← Older revision		Revision as of 13:31, 14 July 2021
Line 41:		Line 41:
	In the above request, the message type is '''myCustomRequest'''. Since this is not a standard request, a LTI source plugin can handle it. We can do this by adding a LTI source plugin and for this example, we will call it ''widget''. Then, in our ''ltisource_widget'' plugin, we must define a specific function In order to handle the request. The function name takes on the form of '''component'''_'''messageType'''. So, for our above request example we would create ''mod/lti/source/widget/lib.php'' and add this function to the file:		In the above request, the message type is '''myCustomRequest'''. Since this is not a standard request, a LTI source plugin can handle it. We can do this by adding a LTI source plugin and for this example, we will call it ''widget''. Then, in our ''ltisource_widget'' plugin, we must define a specific function In order to handle the request. The function name takes on the form of '''component'''_'''messageType'''. So, for our above request example we would create ''mod/lti/source/widget/lib.php'' and add this function to the file:

	<~~code~~ php>		<syntaxhighlight lang="php">
	/**		/**
	* Handle a custom widget request.		* Handle a custom widget request.
Line 81:		Line 81:
	A LTI source plugin can add itself to the add activities menu by implementing a '''component'''_get_types function in its lib.php file. So, for example, if our LTI source plugin was ''widget'', then in ''mod/lti/source/widget/lib.php'' we would add the following function:		A LTI source plugin can add itself to the add activities menu by implementing a '''component'''_get_types function in its lib.php file. So, for example, if our LTI source plugin was ''widget'', then in ''mod/lti/source/widget/lib.php'' we would add the following function:

	<~~code~~ php>		<syntaxhighlight lang="php">
	function ltisource_widget_get_types() {		function ltisource_widget_get_types() {
	$types = array();		$types = array();
Line 96:		Line 96:
	But, this on its own doesn't actually do much at the moment. You must also add another callback that gets called from the External Tool add instance form. The callback takes on the form of '''component'''_add_instance_hook. So, also add this function to ''mod/lti/source/widget/lib.php'':		But, this on its own doesn't actually do much at the moment. You must also add another callback that gets called from the External Tool add instance form. The callback takes on the form of '''component'''_add_instance_hook. So, also add this function to ''mod/lti/source/widget/lib.php'':

	<~~code~~ php>		<syntaxhighlight lang="php">
	function ltisource_widget_add_instance_hook() {		function ltisource_widget_add_instance_hook() {
	// Do custom work here.		// Do custom work here.
Line 131:		Line 131:

	====Sample implementation====		====Sample implementation====
	<~~code~~ php>		<syntaxhighlight lang="php">
	// Prepare the request.		// Prepare the request.
	$request = lti_build_content_item_selection_request($id, $course, $returnurl, $title, $text, [], []);		$request = lti_build_content_item_selection_request($id, $course, $returnurl, $title, $text, [], []);

← Older revision		Revision as of 13:09, 14 July 2021
Line 37:		Line 37:
	</imsx_POXBody>		</imsx_POXBody>
	</imsx_POXEnvelopeRequest>		</imsx_POXEnvelopeRequest>
	</~~code~~>		</syntaxhighlight>

	In the above request, the message type is '''myCustomRequest'''. Since this is not a standard request, a LTI source plugin can handle it. We can do this by adding a LTI source plugin and for this example, we will call it ''widget''. Then, in our ''ltisource_widget'' plugin, we must define a specific function In order to handle the request. The function name takes on the form of '''component'''_'''messageType'''. So, for our above request example we would create ''mod/lti/source/widget/lib.php'' and add this function to the file:		In the above request, the message type is '''myCustomRequest'''. Since this is not a standard request, a LTI source plugin can handle it. We can do this by adding a LTI source plugin and for this example, we will call it ''widget''. Then, in our ''ltisource_widget'' plugin, we must define a specific function In order to handle the request. The function name takes on the form of '''component'''_'''messageType'''. So, for our above request example we would create ''mod/lti/source/widget/lib.php'' and add this function to the file:
Line 69:		Line 69:
	echo $responsexml->asXML();		echo $responsexml->asXML();
	}		}
	</~~code~~>		</syntaxhighlight>

	'''Word of warning:''' If more than one LTI source plugins implement a function for handling the ''myCustomRequest'' message, then an exception will be thrown. So, when coming up with names for your message types, try to keep them unique and perhaps prefix them with something unique about your service.		'''Word of warning:''' If more than one LTI source plugins implement a function for handling the ''myCustomRequest'' message, then an exception will be thrown. So, when coming up with names for your message types, try to keep them unique and perhaps prefix them with something unique about your service.
Line 92:		Line 92:
	return $types;		return $types;
	}		}
	</~~code~~>		</syntaxhighlight>

	But, this on its own doesn't actually do much at the moment. You must also add another callback that gets called from the External Tool add instance form. The callback takes on the form of '''component'''_add_instance_hook. So, also add this function to ''mod/lti/source/widget/lib.php'':		But, this on its own doesn't actually do much at the moment. You must also add another callback that gets called from the External Tool add instance form. The callback takes on the form of '''component'''_add_instance_hook. So, also add this function to ''mod/lti/source/widget/lib.php'':
Line 100:		Line 100:
	// Do custom work here.		// Do custom work here.
	}		}
	</~~code~~>		</syntaxhighlight>

	At this point, the most common use case is to redirect to an external site to browse ''widget-like'' content. Then the '''Extending the LTI protocol''' section can be used to create ''widget-like'' content in Moodle.		At this point, the most common use case is to redirect to an external site to browse ''widget-like'' content. Then the '''Extending the LTI protocol''' section can be used to create ''widget-like'' content in Moodle.
Line 137:		Line 137:
	// Get the launch HTML.		// Get the launch HTML.
	$content = lti_post_launch_html($request->params, $request->url, false);		$content = lti_post_launch_html($request->params, $request->url, false);
	</~~code~~>		</syntaxhighlight>

	==See also==		==See also==
	* [https://www.imsglobal.org/specs/lticiv1p0 Learning Tools Interoperability® Content-Item Message]		* [https://www.imsglobal.org/specs/lticiv1p0 Learning Tools Interoperability® Content-Item Message]

← Older revision		Revision as of 03:20, 30 November 2016
Line 103:		Line 103:

	At this point, the most common use case is to redirect to an external site to browse ''widget-like'' content. Then the '''Extending the LTI protocol''' section can be used to create ''widget-like'' content in Moodle.		At this point, the most common use case is to redirect to an external site to browse ''widget-like'' content. Then the '''Extending the LTI protocol''' section can be used to create ''widget-like'' content in Moodle.

			==LTI Content-Item==
			Support for the LTI Content-Item message type in mod_lti has been implemented since Moodle 3.2. The Content-Item message type enables tool consumers to select content from a tool provider that also supports the Content-Item message type. Content selection can range from LTI links, HTML content, and even multimedia data (e.g. images, video, audio, etc).

			In Moodle 3.2, LTI Content-Item is being used to fetch tool configuration data from a tool provider that can be used to configure an external tool activity. This is done using the ''Select content'' button on the External tool configuration page which launches a modal dialogue containing an interface from the Tool Provider that allows the user to fetch the tool configuration data. Hopefully, in future releases, additional features will be added, such as fetching and attaching content to an editor.

			{{Moodle 3.2}}
			===lti_build_content_item_selection_request()===
			For developers who would like to send a ContentItemSelectionRequest to a Tool Provider, the function '''''lti_build_content_item_selection_request()''''' can be used. This function returns an object that contains the signed request parameters and the URL to the Tool Provider's Content-Item selection interface. It has the following parameters:

			====Required parameters====
			* '''$id''' ''int'' - The tool type's ID (from in the lti_types table).
			* '''$course''' ''stdClass'' - The course object.
			* '''$returnurl''' ''moodle_url'' - The return URL in the tool consumer (TC) that the tool provider (TP) will use to return the response for the Content-Item selection request.

			====Optional parameters====
			* '''$title''' ''string'' - The tool's title, if available.
			* '''$text''' ''string'' - The text to display to represent the content item. This value may be a long description of the content item.
			* '''$mediatypes''' ''array'' - Array of MIME types types supported by the TC. If empty, the TC will support ltilink by default.
			* '''$presentationtargets''' ''array'' - Array of ways in which the selected content item(s) can be requested to be opened (via the presentationDocumentTarget element for a returned content item). If empty, "frame", "iframe", and "window" will be supported by default.
			* '''$autocreate''' ''bool'' - Indicates whether any content items returned by the TP would be automatically persisted.
			* '''$multiple''' ''bool'' - Indicates whether the user should be permitted to select more than one item. False by default. any option for the user to cancel the operation. False by default.
			* '''$unsigned''' ''bool'' - Indicates whether the TC is willing to accept an unsigned return message, or not. A signed message should always be required when the content item is being created automatically in the TC without further interaction from the user. False by default.
			* '''$canconfirm''' ''bool'' - Flag for can_confirm parameter. False by default.
			* '''$copyadvice''' ''bool'' - Indicates whether the TC is able and willing to make a local copy of a content item. False by default.
			For more information about the request parameters, see [https://www.imsglobal.org/specs/lticiv1p0/specification-3 Content-Item Message - Information Model].

			====Sample implementation====
			<code php>
			// Prepare the request.
			$request = lti_build_content_item_selection_request($id, $course, $returnurl, $title, $text, [], []);

			// Get the launch HTML.
			$content = lti_post_launch_html($request->params, $request->url, false);
			</code>

			==See also==
			* [https://www.imsglobal.org/specs/lticiv1p0 Learning Tools Interoperability® Content-Item Message]

← Older revision		Revision as of 19:54, 16 May 2014
Line 102:		Line 102:
	</code>		</code>

	At this point, the most common use case is to redirect to an external site to browse ''widget'' ~~like~~ content. Then the '''Extending the LTI protocol''' section can be used to create ''widget'' content in Moodle.		At this point, the most common use case is to redirect to an external site to browse ''widget-like'' content. Then the '''Extending the LTI protocol''' section can be used to create ''widget-like'' content in Moodle.

← Older revision		Revision as of 18:55, 16 May 2014
Line 27:		Line 27:
	</imsx_POXHeader>		</imsx_POXHeader>
	<imsx_POXBody>		<imsx_POXBody>
	<~~widgetCustomRequest~~><!-- LOOK HERE! -->		<myCustomRequest><!-- LOOK HERE! -->
	<~~widgetRecord~~><!-- This can be named whatever you want -->		<myRecord><!-- This can be named whatever you want -->
	<sourcedGUID>		<sourcedGUID>
	<sourcedId>3124567</sourcedId>		<sourcedId>3124567</sourcedId>
	</sourcedGUID>		</sourcedGUID>
	<!-- You custom data in XML format -->		<!-- You custom data in XML format -->
	</~~widgetRecord~~>		</myRecord>
	</~~widgetCustomRequest~~>		</myCustomRequest>
	</imsx_POXBody>		</imsx_POXBody>
	</imsx_POXEnvelopeRequest>		</imsx_POXEnvelopeRequest>
	</code>		</code>

	In the above request, the message type is '''~~widgetCustomRequest~~'''. Since this is not a standard request, a LTI source plugin can handle it. We can do this by adding a LTI source plugin and for this example, we will call it ''widget''. Then, in our ''ltisource_widget'' plugin, we must define a specific function In order to handle the request. The function name takes on the form of '''component'''_'''messageType'''. So, for our above request example we would create ''mod/lti/source/widget/lib.php'' and add this function to the file:		In the above request, the message type is '''myCustomRequest'''. Since this is not a standard request, a LTI source plugin can handle it. We can do this by adding a LTI source plugin and for this example, we will call it ''widget''. Then, in our ''ltisource_widget'' plugin, we must define a specific function In order to handle the request. The function name takes on the form of '''component'''_'''messageType'''. So, for our above request example we would create ''mod/lti/source/widget/lib.php'' and add this function to the file:

	<code php>		<code php>
Line 47:		Line 47:
	* @param object $data The LTI request details		* @param object $data The LTI request details
	*/		*/
	function ~~ltisource_widget_widgetCustomRequest~~($data) {		function ltisource_widget_myCustomRequest($data) {
	$data->body; // The raw LTI request XML body.		$data->body; // The raw LTI request XML body.
	$data->xml; // A SimpleXMLElement of the XML body.		$data->xml; // A SimpleXMLElement of the XML body.
Line 71:		Line 71:
	</code>		</code>

	'''Word of warning:''' If more than one LTI source plugins implement a function for handling the ''~~widgetCustomRequest~~'' message, then an exception will be thrown. So, when coming up with names for your message types, try to keep them unique and perhaps prefix them with something unique about your service.		'''Word of warning:''' If more than one LTI source plugins implement a function for handling the ''myCustomRequest'' message, then an exception will be thrown. So, when coming up with names for your message types, try to keep them unique and perhaps prefix them with something unique about your service.

	And that's about it! With this extension point, you can build deep integrations with external services all while communicating through the LTI protocol.		And that's about it! With this extension point, you can build deep integrations with external services all while communicating through the LTI protocol.

← Older revision		Revision as of 18:52, 16 May 2014
Line 4:		Line 4:
	== LTI Source Plugins ==		== LTI Source Plugins ==

	The External tool supports sub plugins that live under the ''mod/lti/source'' directory with the plugin type of ''ltisource''. The purpose of a LTI source plugin is to extend the functionality of the External Tool activity. ~~Those extensions are discussed below~~.		The External tool supports sub plugins that live under the ''mod/lti/source'' directory with the plugin type of ''ltisource''. The purpose of a LTI source plugin is to extend the functionality of the External Tool activity.

			The LTI source plugins support the following standard plugin features:

			* Language file: ''mod/lti/source/pluginname/lang/en/ltisource_pluginname.php''
			* [[Upgrade_API\| Plugin upgrade API]] under the ''mod/lti/source/pluginname/db'' directory.

	=== Extending the LTI protocol ===		=== Extending the LTI protocol ===

← Older revision		Revision as of 17:59, 16 May 2014
Line 74:		Line 74:
	Overall, the following has a narrow use case, but it might be expanded in the future.		Overall, the following has a narrow use case, but it might be expanded in the future.

	A LTI source plugin can add itself to the ~~[[Course_homepage#Activities_and_resources\|~~add activities menu]]		A LTI source plugin can add itself to the add activities menu by implementing a '''component'''_get_types function in its lib.php file. So, for example, if our LTI source plugin was ''widget'', then in ''mod/lti/source/widget/lib.php'' we would add the following function:

			<code php>
			function ltisource_widget_get_types() {
			$types = array();
			$types[] = (object) array(
			'modclass' => MOD_CLASS_ACTIVITY,
			'type' => 'lti&type=widget',
			'typestr' => get_string('addwidget', 'ltisource_widget'),
			'help' => get_string('addwidget_help', 'ltisource_widget'),
			);
			return $types;
			}
			</code>

			But, this on its own doesn't actually do much at the moment. You must also add another callback that gets called from the External Tool add instance form. The callback takes on the form of '''component'''_add_instance_hook. So, also add this function to ''mod/lti/source/widget/lib.php'':

			<code php>
			function ltisource_widget_add_instance_hook() {
			// Do custom work here.
			}
			</code>

			At this point, the most common use case is to redirect to an external site to browse ''widget'' like content. Then the '''Extending the LTI protocol''' section can be used to create ''widget'' content in Moodle.

← Older revision		Revision as of 17:45, 16 May 2014
Line 69:		Line 69:

	And that's about it! With this extension point, you can build deep integrations with external services all while communicating through the LTI protocol.		And that's about it! With this extension point, you can build deep integrations with external services all while communicating through the LTI protocol.

			=== Addition to the add activities menu ===

			Overall, the following has a narrow use case, but it might be expanded in the future.

			A LTI source plugin can add itself to the [[Course_homepage#Activities_and_resources\|add activities menu]]

← Older revision		Revision as of 17:38, 16 May 2014
Line 65:		Line 65:
	}		}
	</code>		</code>

			'''Word of warning:''' If more than one LTI source plugins implement a function for handling the ''widgetCustomRequest'' message, then an exception will be thrown. So, when coming up with names for your message types, try to keep them unique and perhaps prefix them with something unique about your service.

			And that's about it! With this extension point, you can build deep integrations with external services all while communicating through the LTI protocol.