Documentation

Progress extends AbstractBaseApi

in package

• CanvasLMS
• Api
• Progress

Progress Class

// Finding a progress by ID
$progress = Progress::find(123);

// Checking progress status
if ($progress->isCompleted()) {
    $results = $progress->results;
    echo "Operation completed successfully";
} elseif ($progress->isFailed()) {
    echo "Operation failed: " . $progress->message;
} else {
    echo "Progress: " . $progress->completion . "%";
}

// Polling until completion
$progress = Progress::find(123);
$completedProgress = $progress->waitForCompletion(300, 2); // 5 minutes max, 2 second intervals

// Cancelling an operation
$progress->cancel("User requested cancellation");

// LTI context progress
$progress = Progress::findInLtiContext(456, 123); // course_id, progress_id

// Static polling utility
$progress = Progress::pollUntilComplete(123, 300, 2);

Tags

phpstan-consistent-constructor

Table of Contents

Constants

STATE_COMPLETED  : mixed = 'completed'

STATE_FAILED  : mixed = 'failed'

STATE_QUEUED  : mixed = 'queued'

Workflow state constants

STATE_RUNNING  : mixed = 'running'

Properties

$completion  : int|null

Percentage completed (0-100)

$contextId  : int|null

The ID of the object the job is associated with

$contextType  : string|null

The type of object (e.g., "Account", "Course", "User")

$createdAt  : DateTime|null

When the job was created

$id  : int|null

The unique identifier for the progress object

$message  : string|null

Optional descriptive message about current status

$results  : mixed

Optional results data when job completes

$tag  : string|null

Identifies the type of operation being performed

$updatedAt  : DateTime|null

When the progress was last updated

$url  : string|null

Endpoint URL for retrieving progress updates

$userId  : int|null

The ID of the user who initiated the job

$workflowState  : string|null

Current status of the job (queued, running, completed, failed)

$methodAliases  : array<string, array<string|int, string>>

Define method aliases

Methods

__callStatic()  : mixed

Magic method to handle function aliases

__construct()  : mixed

Progress constructor.

all()  : array<string|int, static>

Get all pages of results

cancel()  : Progress

Cancel a running operation

find()  : static

Find a progress object by ID

findInLtiContext()  : Progress

Find a progress object in LTI context

get()  : array<string|int, Progress>

Required by ApiInterface - fetch all progress objects (not typically used)

getCompletion()  : int|null

Get the completion percentage

getCompletionPercentage()  : float

Get the completion percentage as a float (0.0 to 100.0)

getContextId()  : int|null

Get the context ID

getContextType()  : string|null

Get the context type

getCreatedAt()  : DateTime|null

Get the creation date

getId()  : int|null

Get the unique identifier

getMessage()  : string|null

Get the status message

getResults()  : mixed

Get the operation results

getStatusDescription()  : string

Get a human-readable status description

getTag()  : string|null

Get the operation tag

getUpdatedAt()  : DateTime|null

Get the last update date

getUrl()  : string|null

Get the progress URL

getUserId()  : int|null

Get the user ID

getWorkflowState()  : string|null

Get the workflow state

isCompleted()  : bool

Check if the progress is completed

isFailed()  : bool

Check if the progress has failed

isFinished()  : bool

Check if the operation is finished (completed or failed)

isInProgress()  : bool

Check if the operation is currently in progress (queued or running)

isQueued()  : bool

Check if the progress is in queued state

isRunning()  : bool

Check if the progress is in running state

isSuccessful()  : bool

Check if the operation completed successfully

overrideApiClient()  : void

Set an API client for this class only, leaving other resources on the shared default.

paginate()  : PaginationResult

Get paginated results with metadata

pollUntilComplete()  : Progress

Static utility to poll a progress until completion

refresh()  : Progress

Refresh the progress object with latest data from API

resetApiClients()  : void

Clear the shared default client and all per-class overrides.

setApiClient()  : void

Set the shared default API client used by ALL resource classes.

setCompletion()  : void

Set the completion percentage

setContextId()  : void

Set the context ID

setContextType()  : void

Set the context type

setCreatedAt()  : void

Set the creation date

setId()  : void

Set the unique identifier

setMessage()  : void

Set the status message

setResults()  : void

Set the operation results

setTag()  : void

Set the operation tag

setUpdatedAt()  : void

Set the last update date

setUrl()  : void

Set the progress URL

setUserId()  : void

Set the user ID

setWorkflowState()  : void

Set the workflow state

stream()  : Generator<int, static>

Stream all items across all pages one at a time.

waitForCompletion()  : Progress

Wait for operation to complete with configurable polling

castValue()  : DateTime|mixed

Cast a value to the correct type

checkApiClient()  : void

Check if the API client is set, if not, instantiate a new one

convertPaginatedResponseToModels()  : array<string|int, static>

Helper method to convert paginated response data to model instances

createConfiguredHttpClient()  : HttpClient

Create an HttpClient with configured middleware

createPaginationResult()  : PaginationResult

Helper method to create PaginationResult from paginated response

getAliasMap()  : array<string, string>

Build a flat alias-to-method lookup from $methodAliases.

getApiClient()  : HttpClientInterface

Get the API client, initializing if necessary

getEndpoint()  : string

Get the API endpoint for this resource

getPaginatedResponse()  : PaginatedResponse

Helper method to get paginated response from API endpoint

hydrate()  : void

Assign API response data to properties with type coercion.

parseJsonResponse()  : array<string|int, mixed>

Parse JSON response from API safely handling StreamInterface

populate()  : void

Populate the object with new data

toDtoArray()  : array<string|int, mixed>

Convert the object to an array

validateContext()  : void

Validate a context type path segment against an allowlist.

foreach (User::stream(['per_page' => 100]) as $user) {
    processUser($user);
}