0 follower

Class Yiisoft\YiiDevTool\Infrastructure\CodeUsage\CodeUsage

All Classes | Methods
InheritanceYiisoft\YiiDevTool\Infrastructure\CodeUsage\CodeUsage

Public Methods

Hide inherited methods

Method Description Defined By
__construct() Yiisoft\YiiDevTool\Infrastructure\CodeUsage\CodeUsage
getEnvironments() Yiisoft\YiiDevTool\Infrastructure\CodeUsage\CodeUsage
getIdentifier() Yiisoft\YiiDevTool\Infrastructure\CodeUsage\CodeUsage
registerUsageInEnvironment() Yiisoft\YiiDevTool\Infrastructure\CodeUsage\CodeUsage
registerUsageInEnvironments() Yiisoft\YiiDevTool\Infrastructure\CodeUsage\CodeUsage
usedInEnvironment() Yiisoft\YiiDevTool\Infrastructure\CodeUsage\CodeUsage
usedOnlyInSpecifiedEnvironment() Yiisoft\YiiDevTool\Infrastructure\CodeUsage\CodeUsage

Method Details

Hide inherited methods

__construct() public method

public __construct( string $identifier, string|string[] $environments ): mixed
$identifier string

Unique identifier of code usage: namespace, package name, etc.
$environments string|string[]

Environment(s) in which the code is used.

 

                public function __construct(private string $identifier, $environments)
{
    $environments = (array) $environments;
    foreach ($environments as $environment) {
        if (!is_string($environment)) {
            throw new InvalidArgumentException('Each environment must be a string.');
        }
    }
    $this->environments = $environments;
}
getEnvironments() public method

public getEnvironments( ): string[]

                public function getEnvironments(): array
{
    return $this->environments;
}
getIdentifier() public method

public getIdentifier( ): string

                public function getIdentifier(): string
{
    return $this->identifier;
}
registerUsageInEnvironment() public method

public registerUsageInEnvironment( string $environment ): void
$environment string 

                public function registerUsageInEnvironment(string $environment): void
{
    if (!in_array($environment, $this->environments, true)) {
        $this->environments[] = $environment;
    }
}
registerUsageInEnvironments() public method

public registerUsageInEnvironments( string[] $environments ): void
$environments string[] 

                public function registerUsageInEnvironments(array $environments): void
{
    foreach ($environments as $environment) {
        if (!is_string($environment)) {
            throw new InvalidArgumentException('Each environment must be a string.');
        }
        $this->registerUsageInEnvironment($environment);
    }
}
usedInEnvironment() public method

public usedInEnvironment( string $environment ): boolean
$environment string 

                public function usedInEnvironment(string $environment): bool
{
    return in_array($environment, $this->environments, true);
}
usedOnlyInSpecifiedEnvironment() public method

public usedOnlyInSpecifiedEnvironment( string $environment ): boolean
$environment string 

                public function usedOnlyInSpecifiedEnvironment(string $environment): bool
{
    if (count($this->environments) !== 1) {
        return false;
    }
    return in_array($environment, $this->environments, true);
}