Yii Aliases
The package aim is to store path aliases, i.e. short name representing a long path (a file path, a URL, etc.). Path alias value may have another value as its part. For example, @vendor may store path to vendor directory while @bin may store @vendor/bin.
Requirements
- PHP 7.4 or higher.
Installation
The package could be installed with composer:
composer require yiisoft/aliases --prefer-dist
General usage
A path alias must start with the character '@' so that it can be easily differentiated from non-alias paths.
use Yiisoft\Aliases\Aliases;
$aliases = new Aliases([
'@root' => __DIR__,
]);
$aliases->set('@vendor', '@root/vendor');
$aliases->set('@bin', '@vendor/bin');
echo $aliases->get('@bin/phpunit');
The code about would output "/path/to/vendor/bin/phpunit".
Note that set() method does not check if the given path exists or not. All it does is to associate the alias with the path.
The path could be:
- a directory or a file path (e.g.
/tmp,/tmp/main.txt) - a URL (e.g.
http://www.yiiframework.com) - a path alias (e.g.
@yii/base). It will be resolved on {@see get()} call.
Any trailing / and \ characters in the given path will be trimmed.
To bulk translate path aliases into actual paths use getArray() method:
$aliases = new Aliases([
'@root' => '/my/app',
]);
// Value will be ['src' => '/my/app/src', 'tests' => '/my/app/tests']
$directories = $aliases->getAll(['src' => '@root/src', 'tests' => '@root/tests']);
Alias priorities
In case multiple aliases are registered with same root (prefix), then the most specific has precedence:
use Yiisoft\Aliases\Aliases;
$aliases = new Aliases([
'@vendor' => __DIR__ . '/vendor',
'@vendor/test' => '/special/location'
]);
echo $aliases->get('@vendor/test');
That would output /special/location since @vendor/test is more specific match than @vendor.
Alias removal
If you need to remove alias runtime:
use Yiisoft\Aliases\Aliases;
$aliases = new Aliases([
'@root' => __DIR__,
]);
$aliases->remove('@root');
Testing
Unit testing
The package is tested with PHPUnit. To run tests:
./vendor/bin/phpunit
Mutation testing
The package tests are checked with Infection mutation framework with Infection Static Analysis Plugin. To run it:
./vendor/bin/roave-infection-static-analysis-plugin
Static analysis
The code is statically analyzed with Psalm. To run static analysis:
./vendor/bin/psalm
License
The Yii Aliases is free software. It is released under the terms of the BSD License. Please see LICENSE for more information.
Maintained by Yii Software.
Support the project
Follow updates
![Replace $params['aliases'] to $params['yiisoft/aliases']['aliases']](https://avatars.githubusercontent.com/u/525501?v=4)
26 Jul 4, 2022
11 Mar 15, 2022
13 Nov 11, 2022
7 Aug 12, 2022
1 Jan 22, 2022
5 Oct 8, 2022
136 Dec 30, 2022
1 Feb 5, 2022
1 Jul 28, 2022
16 Nov 11, 2022
24 Nov 12, 2022
50 Dec 26, 2022
6 Aug 25, 2022
9.6k Jan 1, 2023
3 Jul 31, 2022
3 Nov 2, 2022
245 Dec 18, 2022
3 Sep 4, 2021
18 Nov 12, 2022