Remove `serviceWeb()` and `serviceMail()` from public API
Nobody has claimed this yet.
- Dominant language
- PHP
- Stars
- 798
- Forks
- 419
- PR merge metrics
- No merged PRs in 30d
Description
This is just a reminder of things we might want to do for a 2.0 release that already will have breaking changes in the API.
The getProxiedService() and initializeProxiedService() functions should be sufficient entry points for all proxy requests. Removing serviceWeb() and serviceMail() will reduce the number of ways to accomplish the same result, lowering the number of code-paths to test.
phpCAS::serviceWeb() and phpCAS::serviceMail() could be added to a backward-compatibility layer with a deprecation notice.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating phpCAS::serviceWeb(), phpCAS::serviceMail(), getProxiedService(), and initializeProxiedService() in the public API. Review how a backward-compatibility layer and deprecation notice would fit the planned 2.0 breaking changes; done means the duplicate entry points are removed or deprecated as specified without leaving unsupported proxy paths.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- api, authentication
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100