vch-lt / path
PHP SDK and Craft CMS adapter for Path patient tracking software
Requires
- php: ^8.1
- guzzlehttp/guzzle: ^7.0
- guzzlehttp/psr7: ^2.5
- psr/http-client: ^1.0
- psr/http-message: ^1.0 || ^2.0
Suggests
- craftcms/cms: ^4.0 || ^5.0 for the Craft CMS module
This package is auto-updated.
Last update: 2026-07-28 05:53:29 UTC
README
Path SDK connects course websites to the Path learner API. This repository publishes the JavaScript
package @vch-lt/path and Composer package vch-lt/path from the same source commit and version tag.
Shared contract
Both languages expose the same primary operations:
getLearnerState()returnsuser,course,milestones, andprogressat the state root.checkAuth()returns the authenticated user ornull.- The authenticated user's read-only course attributes are at
user.attributes. - Learner-store data is fetched separately and only when requested.
- Progress is looked up by milestone slug with
getProgress(state, slug).
The Path wire response places attributes at its root. Each SDK moves those values onto the
authenticated user. If any learner-state request, authorization, server, network, decoding, or
response-shape error occurs, the read resolves to this stable logged-out state:
user = null
course = null
milestones = []
progress = []
Progress, learner-store, and logout operations are strict and report errors. Applications that
redirect when user is null will therefore also redirect during a Path outage.
Guides
This release supports Path's current raw ?path-token= login callback. It does not implement the
pending PKCE registration/activity API; that protocol requires a later breaking SDK release.