Application
Table of Contents
Interfaces
- MiddlewareInterface
- Interface for HTTP client middleware
- ApiInterface
- DTOInterface
- HttpClientInterface
Classes
- AbstractBaseApi
- Abstract base class for Canvas LMS API resources.
- Analytics
- Analytics API for Canvas LMS
- Bookmark
- Canvas LMS Bookmarks API
- BrandConfig
- BrandConfig API
- CourseReports
- Canvas Course Reports API
- DeveloperKey
- Canvas Developer Keys API
- Login
- Canvas LMS Login API
- SharedBrandConfig
- SharedBrandConfig API
- OAuth
- OAuth 2.0 authentication utility for Canvas LMS
- Canvas
- Canvas facade class for making raw API calls to arbitrary Canvas URLs.
- Config
- AbstractBaseDto
- Abstract base class for Data Transfer Objects (DTOs).
- CreateBookmarkDTO
- Data Transfer Object for creating Canvas bookmarks
- UpdateBookmarkDTO
- Data Transfer Object for updating Canvas bookmarks
- CreateConferenceDTO
- Data Transfer Object for creating conferences.
- UpdateConferenceDTO
- Data Transfer Object for updating conferences.
- CreateCourseDTO
- Abstract base class for Data Transfer Objects (DTOs).
- UpdateCourseDTO
- Abstract base class for Data Transfer Objects (DTOs).
- CreateDeveloperKeyDTO
- DTO for creating Canvas Developer Keys
- UpdateDeveloperKeyDTO
- DTO for updating Canvas Developer Keys
- CreateEnrollmentDTO
- Abstract base class for Data Transfer Objects (DTOs).
- UpdateEnrollmentDTO
- Abstract base class for Data Transfer Objects (DTOs).
- UpdateFeatureFlagDTO
- Data Transfer Object for updating feature flags in Canvas LMS.
- CreateLoginDTO
- Data Transfer Object for creating a new login (pseudonym)
- PasswordResetDTO
- Data Transfer Object for password reset request
- UpdateLoginDTO
- Data Transfer Object for updating an existing login (pseudonym)
- BulkUpdateModuleAssignmentOverridesDTO
- Bulk Update Module Assignment Overrides DTO
- CreateModuleDTO
- Abstract base class for Data Transfer Objects (DTOs).
- CreateModuleItemDTO
- Create Module Item DTO
- UpdateModuleDTO
- Abstract base class for Data Transfer Objects (DTOs).
- UpdateModuleItemDTO
- Update Module Item DTO
- CreateOutcomeGroupDTO
- Data Transfer Object for creating outcome groups.
- UpdateOutcomeGroupDTO
- Data Transfer Object for updating outcome groups.
- CreateOutcomeDTO
- Data Transfer Object for creating outcomes.
- UpdateOutcomeDTO
- Data Transfer Object for updating outcomes.
- CreateRubricAssessmentDTO
- Data Transfer Object for creating Canvas rubric assessments.
- CreateRubricAssociationDTO
- Data Transfer Object for creating Canvas rubric associations.
- CreateRubricDTO
- Data Transfer Object for creating Canvas rubrics.
- UpdateRubricAssessmentDTO
- Data Transfer Object for updating Canvas rubric assessments.
- UpdateRubricAssociationDTO
- Data Transfer Object for updating Canvas rubric associations.
- UpdateRubricDTO
- Data Transfer Object for updating Canvas rubrics.
- CreateSectionDTO
- Data Transfer Object for creating Canvas sections.
- UpdateSectionDTO
- Data Transfer Object for updating Canvas sections.
- CreateSharedBrandConfigDTO
- CreateSharedBrandConfigDTO
- UpdateSharedBrandConfigDTO
- UpdateSharedBrandConfigDTO
- CreateUserDTO
- Abstract base class for Data Transfer Objects (DTOs).
- UpdateUserDTO
- Abstract base class for Data Transfer Objects (DTOs).
- CanvasApiException
- ConfigurationException
- Exception thrown when configuration is invalid or missing.
- MissingApiKeyException
- MissingBaseUrlException
- MissingOAuthTokenException
- Exception thrown when an OAuth token is required but not configured
- OAuthRefreshFailedException
- Exception thrown when OAuth token refresh fails
- OAuthTokenExpiredException
- Exception thrown when an OAuth token has expired and cannot be refreshed
- HttpClient
- HTTP client for Canvas LMS API communication.
- AbstractMiddleware
- Base class for HTTP client middleware
- LoggingMiddleware
- Middleware for logging HTTP requests and responses with sensitive data sanitization
- OAuth2RefreshMiddleware
- Middleware for automatic OAuth token refresh on 401 responses
- RateLimitMiddleware
- Middleware for handling Canvas API rate limits using a leaky bucket algorithm
- RetryMiddleware
- Middleware for retrying failed requests with exponential backoff
- ActivityStreamItem
- Base class for activity stream items
- ActivityStreamSummary
- Activity stream summary item
- AnnouncementItem
- Announcement activity stream item
- AssessmentRequestItem
- Assessment request activity stream item
- Avatar
- Avatar option object
- CollaborationItem
- Collaboration activity stream item
- ConferenceItem
- Conference activity stream item
- ConferenceRecording
- ConferenceRecording represents a recording of a web conference.
- ConversationItem
- Conversation activity stream item
- CourseNickname
- Course Nickname object
- DiscussionTopicItem
- Discussion topic activity stream item
- GradebookHistoryDay
- GradebookHistoryDay represents a date with grading activity.
- GradebookHistoryGrader
- GradebookHistoryGrader represents a grader who worked on assignments on a specific day.
- MessageItem
- Message activity stream item
- OutcomeLink
- OutcomeLink represents the relationship between an outcome and a group.
- OutcomeRating
- OutcomeRating object for rating scale definitions.
- PageView
- Page View object
- Profile
- User Profile object
- SubmissionHistory
- SubmissionHistory represents the complete history of versions for a submission.
- SubmissionItem
- Submission activity stream item
- SubmissionVersion
- SubmissionVersion represents a version of a submission with grade change history.
- TodoItem
- Todo item for users
- UpcomingEvent
- Upcoming event for users
- Version
- Version information for Canvas LMS Kit
Traits
- ActivityLoggingTrait
- Trait for standardized activity logging across Canvas LMS API classes.
Functions
- str_to_snake_case() : string
- Convert a string from camelCase or PascalCase to snake_case.
Functions
str_to_snake_case()
Convert a string from camelCase or PascalCase to snake_case.
str_to_snake_case(string $string) : string
Parameters
- $string : string
-
The string to convert
Return values
string —The converted string in snake_case format