yiisoft/aliases

Named paths and URLs storage

2.0.0 2021-04-13 18:11 UTC

This package is auto-updated.

Last update: 2021-04-13 18:12:04 UTC


README

993323

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.

Latest Stable Version Total Downloads Build Status Scrutinizer Code Quality Code Coverage Mutation testing badge static analysis type-coverage

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/bit/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.

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. To run it:

./vendor/bin/infection

Static analysis

The code is statically analyzed with Psalm. To run static analysis:

./vendor/bin/psalm

Support the project

Open Collective

Follow updates

Official website Twitter Telegram Facebook Slack

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.