Skip to content

⚠️ !Breaking Change! Prefix wrapper methods that send a request with fetch - #33

Merged
pavog merged 1 commit into
masterfrom
fetch-methods
Oct 20, 2026
Merged

pavog merged 1 commit into
masterfrom
fetch-methods

Conversation

@pavog

@pavog pavog commented Oct 19, 2026

Copy link
Copy Markdown
Member

Several wrapper methods started with get although they send a request to the Modrinth API every time they are called, e.g. $version->getProject(). This is easy to miss, because they look like the getters of the generated models.

All wrapper methods that send a request now start with fetch. The old names are removed, not deprecated. The PHPDoc of each method states that it sends a request every time it is called. The README explains the naming convention.

Wrapper Old New
Notification getUser() fetchUser()
Project getThread() fetchThread()
Project, SearchProject getDependencies() fetchDependencies()
Project, SearchProject getMembers() fetchMembers()
SearchProject getFullProject() fetchFullProject()
TeamMember getTeamMembers() fetchTeamMembers()
User getProjects() fetchProjects()
User getNotifications() fetchNotifications()
User getFollowedProjects() fetchFollowedProjects()
User getPayoutHistory() fetchPayoutHistory()
Version getProject() fetchProject()
Version getAuthor() fetchAuthor()
VersionDependency getProject() fetchProject()
VersionDependency getVersion() fetchVersion()
Threads\Report getProject() fetchProject()
Threads\Report getUser() fetchUser()
Threads\Report getVersion() fetchVersion()
Threads\Report getThread() fetchThread()
Threads\Thread getProject() fetchProject()
Threads\Thread getReport() fetchReport()
Threads\ThreadMessage getAuthor() fetchAuthor()

Methods that do not send a request keep their names, e.g. Version::getDependencies(), TeamMember::getUser(), Thread::getMessages() and ThreadMessage::getThread(). fetchProjectVersions() and SearchProject::fetchAuthor() already had the right name.

@pavog
pavog requested a review from JulianVennen October 19, 2026 16:41
@pavog pavog added this to the v5 milestone Oct 20, 2026
@pavog
pavog merged commit e9d7b30 into master Oct 20, 2026
4 checks passed
@pavog
pavog deleted the fetch-methods branch October 20, 2026 10:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants