Final Class Yiisoft\Config\Composer\ConfigSettings
| Inheritance | Yiisoft\Config\Composer\ConfigSettings |
|---|
Psalm Types
| Name | Value |
|---|---|
| PackageConfigurationType | array<string, string|list<string>> |
| EnvironmentsConfigurationType | array<string, array<string, string|string[]>> |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| configPath() | Yiisoft\Config\Composer\ConfigSettings | |
| environmentsConfiguration() | Returns the environments configuration. | Yiisoft\Config\Composer\ConfigSettings |
| forRootPackage() | Yiisoft\Config\Composer\ConfigSettings | |
| forVendorPackage() | Yiisoft\Config\Composer\ConfigSettings | |
| options() | Yiisoft\Config\Composer\ConfigSettings | |
| packageConfiguration() | Returns the root package configuration. | Yiisoft\Config\Composer\ConfigSettings |
| path() | Yiisoft\Config\Composer\ConfigSettings |
Method Details
| public configPath( ): string |
public function configPath(): string
{
$sourceDirectory = $this->options->sourceDirectory();
return $this->path . (empty($sourceDirectory) ? '' : "/$sourceDirectory");
}
Returns the environments configuration.
| public environmentsConfiguration( ): array | ||
| return | array |
The environments configuration. |
|---|---|---|
public function environmentsConfiguration(): array
{
return $this->environmentsConfiguration;
}
| public static forRootPackage( \Composer\Composer $composer ): self | ||
| $composer | \Composer\Composer | |
public static function forRootPackage(Composer $composer): self
{
/** @psalm-suppress PossiblyFalseArgument */
return new self(
realpath(dirname(Factory::getComposerFile())),
$composer->getPackage()->getExtra(),
);
}
| public static forVendorPackage( \Composer\Composer $composer, \Composer\Package\BasePackage $package ): self | ||
| $composer | \Composer\Composer | |
| $package | \Composer\Package\BasePackage | |
public static function forVendorPackage(Composer $composer, BasePackage $package): self
{
/**
* @var string $rootPath Because we use library and composer-plugins only which always has installation path.
* @see PackagesListBuilder::getAllPackages()
*/
$rootPath = $composer->getInstallationManager()->getInstallPath($package);
return new self($rootPath, $package->getExtra());
}
| public options( ): Yiisoft\Config\Composer\Options |
public function options(): Options
{
return $this->options;
}
Returns the root package configuration.
| public packageConfiguration( ): array | ||
| return | array |
The root package configuration. |
|---|---|---|
public function packageConfiguration(): array
{
return $this->packageConfiguration;
}
Signup or Login in order to comment.