Meta-value for parameters that need user's configuration
Open
Nobody has claimed this yet.
type:enhancement
- Dominant language
- PHP
- Stars
- 34
- Forks
- 9
- Avg merge
- 1h 7m
- Merged PRs (30d)
- 1
Description
For example: https://github.com/yiisoft/yii-cycle/blob/master/config/params.php#L35
'connections' => []
needs to be configured
'connections' => [
// Example SQLite connection:
'sqlite' => new \Cycle\Database\Config\SQLiteDriverConfig(
connection: new \Cycle\Database\Config\SQLite\DsnConnectionConfig(
// see https://www.php.net/manual/pdo.construct.php, DSN for connection syntax
dsn: 'sqlite:runtime/database.db'
)
),
],
Nice to have meta-value like
'connections' => new ConfigurationNeeded([
'sqlite' => '...'
])
When config-plugin meets this value it may throw error that application is not configured properly.
Additionally it may prompt values during composer install phase
Contributor guide
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 with the example in config/params.php and review how the config-plugin currently processes user configuration. Clarify whether the ConfigurationNeeded meta-value should only report missing configuration or also prompt during composer install, then define completion around the agreed behavior and its coverage.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100