MDL-62599 mod_lti: Update documentation
Change documentation for typeconfig property of service_base from stdClass to array.
This commit is contained in:
committed by
Jake Dallimore
parent
75f020862a
commit
8ca51fa124
@@ -62,7 +62,7 @@ abstract class service_base {
|
||||
private $toolproxy;
|
||||
/** @var stdClass LTI type object for the current service request. */
|
||||
private $type;
|
||||
/** @var stdClass LTI type config object for the current service request. */
|
||||
/** @var array LTI type config array for the current service request. */
|
||||
private $typeconfig;
|
||||
/** @var array Instances of the resources associated with this service. */
|
||||
protected $resources;
|
||||
@@ -176,9 +176,9 @@ abstract class service_base {
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the type config object.
|
||||
* Get the type config array.
|
||||
*
|
||||
* @return stdClass
|
||||
* @return array|null
|
||||
*/
|
||||
public function get_typeconfig() {
|
||||
|
||||
@@ -189,9 +189,9 @@ abstract class service_base {
|
||||
/**
|
||||
* Set the LTI type config object.
|
||||
*
|
||||
* @param object $typeconfig The LTI type config for this service request
|
||||
* @param array $typeconfig The LTI type config for this service request
|
||||
*
|
||||
* @var stdClass
|
||||
* @var array
|
||||
*/
|
||||
public function set_typeconfig($typeconfig) {
|
||||
|
||||
|
||||
@@ -473,7 +473,7 @@ class memberships extends \mod_lti\local\ltiservice\service_base {
|
||||
|
||||
/**
|
||||
* Determines whether a user attribute may be used as part of LTI membership
|
||||
* @param object $toolconfig Tool config
|
||||
* @param array $toolconfig Tool config
|
||||
* @param object $instanceconfig Tool instance config
|
||||
* @param array $fields Set of fields to return if allowed or not
|
||||
* @return array Verification which associates an attribute with a boolean (allowed or not)
|
||||
|
||||
Reference in New Issue
Block a user