apereo / apereo/phpCAS

Remove `setPGTStorageDb()` and `setPGTStorageFile()` from the public API.

Open
#191 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

API Change
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.

setPGTStorage() should be sufficient for configuring PGT storage systems. Removing setPGTStorageDb() and setPGTStorageFile() will reduce the number of ways to accomplish the same result, lowering the number of code-paths to test.

setPGTStorageDb() and setPGTStorageFile() could be added to a backward-compatibility layer with a deprecation notice.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names setPGTStorageDb(), setPGTStorageFile(), and setPGTStorage() but does not identify files or tests. Start by locating those API methods and their callers, then review how the backward-compatibility layer handles deprecations. Done means the two convenience methods are removed from the public API or covered by the proposed compatibility path, with affected tests updated.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
authentication
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.