README

Canvas LMS Kit

The most comprehensive PHP SDK for Canvas LMS API. Production-ready with 90% API coverage.

✨ Why Canvas LMS Kit?

🚀 Production Ready: Rate limiting, middleware support, battle-tested
📚 Comprehensive: 21 Canvas APIs fully implemented (90% coverage)
🛡️ Type Safe: Full PHP 8.1+ type declarations and PHPStan level 6
🔧 Developer Friendly: Intuitive Active Record pattern - just pass arrays!
📖 Well Documented: Extensive examples, guides, and API reference
⚡ Performance: Built-in pagination, caching support, and optimized queries

🎯 Quick Start

use CanvasLMS\Config;
use CanvasLMS\Api\Courses\Course;

Config::setApiKey('your-api-key');
Config::setBaseUrl('https://canvas.instructure.com');

// It's that simple!
$courses = Course::fetchAll();
foreach ($courses as $course) {
    echo $course->name . "\n";
}

📋 Requirements

PHP 8.1 or higher
Composer
Canvas LMS API token
Extensions: json, curl, mbstring

📦 Installation

composer require jjuanrivvera/canvas-lms-kit

⚙️ Configuration

use CanvasLMS\Config;

// Basic configuration
Config::setApiKey('your-api-key');
Config::setBaseUrl('https://canvas.instructure.com');

// Optional: Set account ID for scoped operations
Config::setAccountId(1);

// Optional: Configure middleware
Config::setMiddleware([
    'retry' => ['max_attempts' => 3],
    'rate_limit' => ['wait_on_limit' => true],
]);

💡 Usage Examples

Working with Courses

use CanvasLMS\Api\Courses\Course;

// List all courses
$courses = Course::fetchAll();

// Find a specific course
$course = Course::find(123);

// Create a new course - just pass an array!
$course = Course::create([
    'name' => 'Introduction to PHP',
    'course_code' => 'PHP101',
    'start_at' => '2025-02-01T00:00:00Z'
]);

// Update a course
$course->update([
    'name' => 'Advanced PHP Programming'
]);

// Delete a course
$course->delete();

Managing Assignments

use CanvasLMS\Api\Assignments\Assignment;

// Create an assignment - simple array syntax
$assignment = Assignment::create([
    'course_id' => 123,
    'name' => 'Final Project',
    'description' => 'Build a web application',
    'points_possible' => 100,
    'due_at' => '2025-03-15T23:59:59Z',
    'submission_types' => ['online_upload', 'online_url']
]);

// Grade submissions
$submission = $assignment->getSubmission($studentId);
$submission->grade([
    'posted_grade' => 95,
    'comment' => 'Excellent work!'
]);

File Uploads

use CanvasLMS\Api\Files\File;

// Upload a file to a course
$file = File::upload([
    'course_id' => 123,
    'file_path' => '/path/to/document.pdf',
    'name' => 'Course Syllabus.pdf',
    'parent_folder_path' => 'course_documents'
]);

📊 Supported APIs

✅ Currently Implemented (21 APIs - 90% Coverage)

📚 Core Course Management

✅ Courses - Full CRUD operations
✅ Modules - Content organization
✅ Module Items - Individual content items
✅ Sections - Course sections
✅ Tabs - Navigation customization
✅ Pages - Wiki-style content

👥 Users & Enrollment

✅ Users - User management
✅ Enrollments - Course enrollments
✅ Admin/Account - Administrative functions

📝 Assessment & Grading

✅ Assignments - Assignment management
✅ Quizzes - Quiz creation and management
✅ Quiz Submissions - Student attempts
✅ Submissions - Assignment submissions
✅ Submission Comments - Feedback
✅ Rubrics - Grading criteria

💬 Communication & Collaboration

✅ Discussion Topics - Forums and discussions
🔄 Announcements - Course announcements (coming soon)
🔄 Groups - Student groups (coming soon)

🔧 Tools & Integration

✅ Files - File management
✅ External Tools - LTI integrations
✅ Module Assignment Overrides - Custom dates
✅ Calendar Events - Event management
✅ Appointment Groups - Scheduling
✅ Progress - Async operation tracking

🚀 Advanced Features

Production-Ready Middleware

// The SDK automatically handles rate limiting and retries
$course = Course::find(123); // Protected by middleware

// Canvas API Rate Limiting (3000 requests/hour)
// ✅ Automatic throttling when approaching limits
// ✅ Smart backoff strategies
// ✅ Transparent to your application

Multi-Tenant Support

// Manage multiple Canvas instances
Config::setContext('production');
$prodCourse = Course::find(123);

Config::setContext('test');
$testCourse = Course::find(456);

Pagination Support

// Automatic pagination handling
$allCourses = Course::fetchAll(); // Fetches ALL pages automatically

// Manual pagination control
$paginator = Course::fetchAllPaginated(['per_page' => 50]);
foreach ($paginator as $page) {
    foreach ($page as $course) {
        // Process each course
    }
}

Relationship Methods

// Efficient relationship loading
$course = Course::find(123);
$students = $course->getStudents();
$assignments = $course->getAssignments();
$modules = $course->getModules();

🧪 Testing

# Using Docker (recommended)
docker compose exec php composer test
docker compose exec php composer check  # Run all checks

# Local development
composer test
composer cs-fix   # Fix coding standards
composer phpstan  # Static analysis

🤝 Contributing

We welcome contributions! Please see our Contributing Guidelines.

Quick Contribution Guide

Fork the repository
Create your feature branch (git checkout -b feature/amazing-feature)
Write tests for your changes
Ensure all tests pass (composer check)
Commit your changes (git commit -m 'Add amazing feature')
Push to the branch (git push origin feature/amazing-feature)
Open a Pull Request

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

💬 Support

Resources

📚 Wiki Documentation - Comprehensive guides
🔍 API Reference - Detailed API docs
💬 GitHub Discussions - Community forum
📧 Email: jjuanrivvera@gmail.com

⭐ Show Your Support

If you find this project helpful, please consider giving it a star on GitHub! It helps others discover the project and motivates continued development.

Built with ❤️ by the Canvas LMS Kit community

jjuanrivvera / canvas-lms-kit

Maintainers

Details