0 follower

Final Class Yiisoft\Aliases\Aliases

All Classes | Methods

Inheritance	Yiisoft\Aliases\Aliases

Public Methods

Hide inherited methods

Method	Description	Defined By
__construct()		Yiisoft\Aliases\Aliases
get()	Translates a path alias into an actual path.	Yiisoft\Aliases\Aliases
getAll()	Returns all path aliases translated into an actual paths.	Yiisoft\Aliases\Aliases
getArray()	Bulk translates path aliases into actual paths.	Yiisoft\Aliases\Aliases
remove()	Remove alias.	Yiisoft\Aliases\Aliases
set()	Registers a path alias.	Yiisoft\Aliases\Aliases

Method Details

Hide inherited methods

__construct() public method

See also:

public mixed __construct ( array $config = [] )
$config	array
throws	InvalidArgumentException	If `$path` is an invalid alias.

Source code

                public function __construct(array $config = [])
{
    foreach ($config as $alias => $path) {
        $this->set($alias, $path);
    }
}

get() public method

Translates a path alias into an actual path.

The translation is done according to the following procedure:

If the given alias does not start with '@', it is returned back without change;
Otherwise, look for the longest registered alias that matches the beginning part of the given alias. If it exists, replace the matching part of the given alias with the corresponding registered path.
Throw an exception if path alias cannot be resolved.

For example, if '@vendor' is registered as the alias to the vendor directory, say '/path/to/vendor'. The alias '@vendor/yiisoft' would then be translated into '/path/to/vendor/yiisoft'.

If you have registered two aliases '@foo' and '@foo/bar'. Then translating '@foo/bar/config' would replace the part '@foo/bar' (instead of '@foo') with the corresponding registered path. This is because the longest alias takes precedence.

However, if the alias to be translated is '@foo/barbar/config', then '@foo' will be replaced instead of '@foo/bar', because '/' serves as the boundary character.

Note, this method does not check if the returned path exists or not.

See also \Yiisoft\Aliases\setAlias().

public string get ( string $alias )
$alias	string	The alias to be translated.
return	string	The path corresponding to the alias.
throws	InvalidArgumentException	If the root alias is not previously registered.

Source code

                public function get(string $alias): string
{
    if (!$this->isAlias($alias)) {
        return $alias;
    }
    $foundAlias = $this->findAlias($alias);
    if ($foundAlias === null) {
        throw new InvalidArgumentException("Invalid path alias: $alias");
    }
    $foundSubAlias = $this->findAlias($foundAlias);
    if ($foundSubAlias === null) {
        return $foundAlias;
    }
    return $this->get($foundSubAlias);
}

getAll() public method

Returns all path aliases translated into an actual paths.

public array getAll ( )
return	array	Actual paths indexed by alias name.

Source code

                public function getAll(): array
{
    $result = [];
    foreach ($this->aliases as $name => $path) {
        if (is_array($path)) {
            foreach ($path as $innerName => $innerPath) {
                $result[$innerName] = $innerPath;
            }
        } else {
            $result[$name] = $this->get($path);
        }
    }
    return $result;
}

getArray() public method

Bulk translates path aliases into actual paths.

public string[] getArray ( string[] $aliases )
$aliases	string[]	Aliases to be translated.
return	string[]	The paths corresponding to the aliases.
throws	InvalidArgumentException	If the root alias was not previously registered.

Source code

                public function getArray(array $aliases): array
{
    return array_map(
        fn (string $alias) => $this->get($alias),
        $aliases,
    );
}

remove() public method

Remove alias.

public void remove ( string $alias )
$alias	string	Alias to be removed.

Source code

                public function remove(string $alias): void
{
    if (!$this->isAlias($alias)) {
        $alias = '@' . $alias;
    }
    $pos = strpos($alias, '/');
    $root = $pos === false ? $alias : substr($alias, 0, $pos);
    if (array_key_exists($root, $this->aliases)) {
        if (is_array($this->aliases[$root])) {
            unset($this->aliases[$root][$alias]);
        } elseif ($pos === false) {
            unset($this->aliases[$root]);
        }
    }
}

set() public method

Registers a path alias.

A path alias is a short name representing a long path (a file path, a URL, etc.)

For example, @vendor may store path to vendor directory.

A path alias must start with the character '@' so that it can be easily differentiated from non-alias paths.

Note that this method does not check if the given path exists or not. All it does is to associate the alias with the path.

Any trailing '/' and '\' characters in the given path will be trimmed.

See also get().

public void set ( string $alias, string $path )
$alias	string	The alias name (e.g. "@vendor"). It must start with a '@' character. It may contain the forward slash '/' which serves as boundary character when performing alias translation by {@see \Yiisoft\Aliases\get()}.
$path	string	The path corresponding to the alias. Trailing '/' and '\' characters will be trimmed. This can be a directory or a file path (e.g. `/tmp`, `/tmp/main.txt`) a URL (e.g. `https://www.yiiframework.com`) a path alias (e.g. `@vendor/yiisoft`). It will be resolved on {@see \Yiisoft\Aliases\get()} call.

Source code

                public function set(string $alias, string $path): void
{
    if (!$this->isAlias($alias)) {
        $alias = '@' . $alias;
    }
    $pos = strpos($alias, '/');
    /** @psalm-var string $root */
    $root = $pos === false ? $alias : substr($alias, 0, $pos);
    $path = rtrim($path, '\\/');
    if (!array_key_exists($root, $this->aliases)) {
        if ($pos === false) {
            $this->aliases[$root] = $path;
        } else {
            $this->aliases[$root] = [$alias => $path];
        }
    } elseif (is_string($this->aliases[$root])) {
        if ($pos === false) {
            $this->aliases[$root] = $path;
        } else {
            $this->aliases[$root] = [
                $alias => $path,
                $root => $this->aliases[$root],
            ];
        }
    } else {
        $this->aliases[$root][$alias] = $path;
        krsort($this->aliases[$root]);
    }
}