Skip to content

[8.x] Allow users to specify configuration keys to be used for primitive binding #36241

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 12, 2021
Merged

[8.x] Allow users to specify configuration keys to be used for primitive binding #36241

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions src/Illuminate/Container/ContextualBindingBuilder.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,4 +81,20 @@ public function giveTagged($tag)
return is_array($taggedServices) ? $taggedServices : iterator_to_array($taggedServices);
});
}

/**
* Define configuration key to be used to look up in configuration to bind as a primitive.
*
* @param string $key
* @param ?string $default
Copy link
Collaborator

@GrahamCampbell GrahamCampbell Feb 13, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

bad cs

Copy link

@matason matason Feb 13, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bad CS because the first line of the docblock should be wrapped?

Copy link
Contributor Author

@simensen simensen Feb 13, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My bad on this. My guess might be there are two spaces between string and $key instead of just one? Or maybe the long line. :) Either way, my bad. I had actually fixed a few other things that the styleci bot complained about and figured it was all good since it passed.

Copy link

@matason matason Feb 13, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@simensen I found this which says two spaces between @param and the type and then two spaces before the variable name so it could be that.

* @return void
*/
public function giveConfig($key, $default = null)
{
$this->give(function ($container) use ($key, $default) {
$config = $container->get('config');

return $config->get($key, $default);
});
}
}
146 changes: 146 additions & 0 deletions tests/Container/ContextualBindingTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

namespace Illuminate\Tests\Container;

use Illuminate\Config\Repository;
use Illuminate\Container\Container;
use PHPUnit\Framework\TestCase;

Expand Down Expand Up @@ -359,6 +360,127 @@ public function testContextualBindingGivesTagsForVariadic()
$this->assertInstanceOf(ContainerContextImplementationStub::class, $resolvedInstance->stubs[0]);
$this->assertInstanceOf(ContainerContextImplementationStubTwo::class, $resolvedInstance->stubs[1]);
}

public function testContextualBindingGivesValuesFromConfigOptionalValueNull()
{
$container = new Container;

$container->singleton('config', function () {
return new Repository([
'test' => [
'username' => 'laravel',
'password' => 'hunter42',
],
]);
});

$container
->when(ContainerTestContextInjectFromConfigIndividualValues::class)
->needs('$username')
->giveConfig('test.username');

$container
->when(ContainerTestContextInjectFromConfigIndividualValues::class)
->needs('$password')
->giveConfig('test.password');

$resolvedInstance = $container->make(ContainerTestContextInjectFromConfigIndividualValues::class);

$this->assertEquals('laravel', $resolvedInstance->username);
$this->assertEquals('hunter42', $resolvedInstance->password);
$this->assertNull($resolvedInstance->alias);
}

public function testContextualBindingGivesValuesFromConfigOptionalValueSet()
{
$container = new Container;

$container->singleton('config', function () {
return new Repository([
'test' => [
'username' => 'laravel',
'password' => 'hunter42',
'alias' => 'lumen',
],
]);
});

$container
->when(ContainerTestContextInjectFromConfigIndividualValues::class)
->needs('$username')
->giveConfig('test.username');

$container
->when(ContainerTestContextInjectFromConfigIndividualValues::class)
->needs('$password')
->giveConfig('test.password');

$container
->when(ContainerTestContextInjectFromConfigIndividualValues::class)
->needs('$alias')
->giveConfig('test.alias');

$resolvedInstance = $container->make(ContainerTestContextInjectFromConfigIndividualValues::class);

$this->assertEquals('laravel', $resolvedInstance->username);
$this->assertEquals('hunter42', $resolvedInstance->password);
$this->assertEquals('lumen', $resolvedInstance->alias);
}

public function testContextualBindingGivesValuesFromConfigWithDefault()
{
$container = new Container;

$container->singleton('config', function () {
return new Repository([
'test' => [
'password' => 'hunter42',
],
]);
});

$container
->when(ContainerTestContextInjectFromConfigIndividualValues::class)
->needs('$username')
->giveConfig('test.username', 'DEFAULT_USERNAME');

$container
->when(ContainerTestContextInjectFromConfigIndividualValues::class)
->needs('$password')
->giveConfig('test.password');

$resolvedInstance = $container->make(ContainerTestContextInjectFromConfigIndividualValues::class);

$this->assertEquals('DEFAULT_USERNAME', $resolvedInstance->username);
$this->assertEquals('hunter42', $resolvedInstance->password);
$this->assertNull($resolvedInstance->alias);
}

public function testContextualBindingGivesValuesFromConfigArray()
{
$container = new Container;

$container->singleton('config', function () {
return new Repository([
'test' => [
'username' => 'laravel',
'password' => 'hunter42',
'alias' => 'lumen',
],
]);
});

$container
->when(ContainerTestContextInjectFromConfigArray::class)
->needs('$settings')
->giveConfig('test');

$resolvedInstance = $container->make(ContainerTestContextInjectFromConfigArray::class);

$this->assertEquals('laravel', $resolvedInstance->settings['username']);
$this->assertEquals('hunter42', $resolvedInstance->settings['password']);
$this->assertEquals('lumen', $resolvedInstance->settings['alias']);
}
}

interface IContainerContextContractStub
Expand Down Expand Up @@ -474,3 +596,27 @@ public function __construct(ContainerContextNonContractStub $other, IContainerCo
$this->stubs = $stubs;
}
}

class ContainerTestContextInjectFromConfigIndividualValues
{
public $username;
public $password;
public $alias = null;

public function __construct($username, $password, $alias = null)
{
$this->username = $username;
$this->password = $password;
$this->alias = $alias;
}
}

class ContainerTestContextInjectFromConfigArray
{
public $settings;

public function __construct($settings)
{
$this->settings = $settings;
}
}