Skip to content

MGMT-191 Submission #161

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

MGMT-191 Submission #161

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3181e7b
Add standard submission field support to LTI Grades
dbhynds May 2, 2025
60cdcbd
Merge branch 'master' into mgmt-191-submission
dbhynds May 2, 2025
4cd2047
Update doc blocks
dbhynds May 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions src/LtiGrade.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ class LtiGrade
private $user_id;
private $submission_review;
private $canvas_extension;
private $submission;

public function __construct(?array $grade = null)
{
Expand All @@ -28,6 +29,7 @@ public function __construct(?array $grade = null)
$this->user_id = $grade['userId'] ?? null;
$this->submission_review = $grade['submissionReview'] ?? null;
$this->canvas_extension = $grade['https://canvas.instructure.com/lti/submission'] ?? null;
$this->submission = $grade['submission'] ?? null;
}

public function getArray(): array
Expand All @@ -42,6 +44,7 @@ public function getArray(): array
'userId' => $this->user_id,
'submissionReview' => $this->submission_review,
'https://canvas.instructure.com/lti/submission' => $this->canvas_extension,
'submission' => $this->submission,
];
}

Expand Down Expand Up @@ -169,4 +172,24 @@ public function setCanvasExtension($value): self

return $this;
}

/**
* @return array{startedAt?: ?string, submittedAt?: ?string}|null
*/
public function getSubmission()
{
return $this->submission;
}

/**
* @param array{startedAt?: ?string, submittedAt?: ?string} $value
*
* @see https://www.imsglobal.org/spec/lti-ags/v2p0
*/
public function setSubmission($value): self
{
$this->submission = $value;

return $this;
}
}
34 changes: 34 additions & 0 deletions tests/LtiGradeTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,6 +207,10 @@ public function test_it_casts_full_object_to_string()
'userId' => 'UserId',
'submissionReview' => 'SubmissionReview',
'https://canvas.instructure.com/lti/submission' => 'CanvasExtension',
'submission' => [
'startedAt' => '2023-01-15T12:30:45Z',
'submittedAt' => '2023-01-15T13:15:22Z',
],
];

$grade = new LtiGrade($expected);
Expand All @@ -226,6 +230,10 @@ public function test_it_casts_full_object_to_string_with0_grade()
'userId' => 'UserId',
'submissionReview' => 'SubmissionReview',
'https://canvas.instructure.com/lti/submission' => 'CanvasExtension',
'submission' => [
'startedAt' => '2023-01-15T12:30:45Z',
'submittedAt' => '2023-01-15T13:15:22Z',
],
];

$grade = new LtiGrade($expected);
Expand All @@ -237,4 +245,30 @@ public function test_it_casts_empty_object_to_string()
{
$this->assertEquals('[]', (string) $this->grade);
}

public function test_it_gets_submission()
{
$expected = [
'startedAt' => '2023-01-15T12:30:45Z',
'submittedAt' => '2023-01-15T13:15:22Z',
];
$grade = new LtiGrade(['submission' => $expected]);

$result = $grade->getSubmission();

$this->assertEquals($expected, $result);
}

public function test_it_sets_submission()
{
$expected = [
'startedAt' => '2023-01-15T12:30:45Z',
'submittedAt' => '2023-01-15T13:15:22Z',
];

$this->grade->setSubmission($expected);

$this->assertEquals($expected, $this->grade->getSubmission());
}

}