PHPackages yiisoft/aliases - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Framework](/categories/framework) 4. / 5. yiisoft/aliases ActiveLibrary[Framework](/categories/framework) yiisoft/aliases =============== Named paths and URLs storage 3.1.1(5mo ago)241.2M↓20.8%8[3 issues](https://github.com/yiisoft/aliases/issues)20BSD-3-ClausePHPPHP 8.1 - 8.5CI passing Since Jun 6Pushed 3mo ago16 watchersCompare [ Source](https://github.com/yiisoft/aliases)[ Packagist](https://packagist.org/packages/yiisoft/aliases)[ Docs](https://www.yiiframework.com/)[ GitHub Sponsors](https://github.com/sponsors/yiisoft)[ OpenCollective](https://opencollective.com/yiisoft)[ RSS](/packages/yiisoft-aliases/feed)WikiDiscussions master Synced 1mo ago READMEChangelog (4)Dependencies (9)Versions (16)Used By (20) [ ![Yii](https://camo.githubusercontent.com/8317c17418b39410a660f5149071d26c5023c0d5fb2b7ebb771324812f666d73/68747470733a2f2f796969736f66742e6769746875622e696f2f646f63732f696d616765732f7969695f6c6f676f2e737667) ](https://github.com/yiisoft) Yii Aliases =========== [](#yii-aliases) [![Latest Stable Version](https://camo.githubusercontent.com/f27e03875a8e89852e130ece01762bf7991f92bc079018a6dcbe6a60fa356477/68747470733a2f2f706f7365722e707567782e6f72672f796969736f66742f616c69617365732f76)](https://packagist.org/packages/yiisoft/aliases)[![Total Downloads](https://camo.githubusercontent.com/60552cb8bc4897114c5d3a9596179d2d80249b12d775e14693b2497a93886949/68747470733a2f2f706f7365722e707567782e6f72672f796969736f66742f616c69617365732f646f776e6c6f616473)](https://packagist.org/packages/yiisoft/aliases)[![Build status](https://github.com/yiisoft/aliases/actions/workflows/build.yml/badge.svg)](https://github.com/yiisoft/aliases/actions/workflows/build.yml)[![Code Coverage](https://camo.githubusercontent.com/37b6d03103b362ac4de084c3dc2df457751c313f85b7053059a71da729dbaa30/68747470733a2f2f636f6465636f762e696f2f67682f796969736f66742f616c69617365732f6272616e63682f6d61737465722f67726170682f62616467652e737667)](https://codecov.io/gh/yiisoft/aliases)[![Mutation testing badge](https://camo.githubusercontent.com/7db5707a938884aaedc04a29444afd979df72390644b7ab72d07e66d7d5b5e50/68747470733a2f2f696d672e736869656c64732e696f2f656e64706f696e743f7374796c653d666c61742675726c3d68747470733a2f2f62616467652d6170692e737472796b65722d6d757461746f722e696f2f6769746875622e636f6d2f796969736f66742f616c69617365732f6d6173746572)](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/aliases/master)[![Static analysis](https://github.com/yiisoft/aliases/actions/workflows/static.yml/badge.svg?branch=master)](https://github.com/yiisoft/aliases/actions/workflows/static.yml?query=branch%3Amaster)[![type-coverage](https://camo.githubusercontent.com/9a980df2250c325bd4320370783b3e1ee8c4ac84a9332f1e2c75a0f603f871bf/68747470733a2f2f73686570686572642e6465762f6769746875622f796969736f66742f616c69617365732f636f7665726167652e737667)](https://shepherd.dev/github/yiisoft/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 ------------ [](#requirements) - PHP 8.1 - 8.5. Installation ------------ [](#installation) The package could be installed with [Composer](https://getcomposer.org): ``` composer require yiisoft/aliases ``` General usage ------------- [](#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. `https://www.yiiframework.com`) - a path alias (e.g. `@yii/base`). It will be resolved on `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 [](#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 [](#alias-removal) If you need to remove alias runtime: ``` use Yiisoft\Aliases\Aliases; $aliases = new Aliases([ '@root' => __DIR__, ]); $aliases->remove('@root'); ``` ### Alias references [](#alias-references) The package provides `AliasReference` class that implements `ReferenceInterface` from [Yii Definition](https://github.com/yiisoft/definitions). It allows you to create references to aliases that will be resolved at runtime: ``` // Create a reference to an alias $reference = \Yiisoft\Aliases\AliasReference::to('@public/assets'); // The reference will be resolved when needed $configPath = $reference->resolve($container); ``` This is particularly useful in dependency injection configurations where you want to inject resolved paths but the aliases are not available at configuration time. Documentation ------------- [](#documentation) - [Internals](docs/internals.md) If you need help or have a question, the [Yii Forum](https://forum.yiiframework.com/c/yii-3-0/63) is a good place for that. You may also check out other [Yii Community Resources](https://www.yiiframework.com/community). License ------- [](#license) The Yii Aliases is free software. It is released under the terms of the BSD License. Please see [`LICENSE`](./LICENSE.md) for more information. Maintained by [Yii Software](https://www.yiiframework.com/). Support the project ------------------- [](#support-the-project) [![Open Collective](https://camo.githubusercontent.com/a2b15f8e2268d4e3842e00d41ff7a57cce2ad8bd8d8769c5dc4fa05a546a4f62/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4f70656e253230436f6c6c6563746976652d73706f6e736f722d3765616466313f6c6f676f3d6f70656e253230636f6c6c656374697665266c6f676f436f6c6f723d376561646631266c6162656c436f6c6f723d353535353535)](https://opencollective.com/yiisoft) Follow updates -------------- [](#follow-updates) [![Official website](https://camo.githubusercontent.com/d6b0929173e28cc627430d2519ca1853466a70f37395877eaf4820cb3e1e1909/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f506f77657265645f62792d5969695f4672616d65776f726b2d677265656e2e7376673f7374796c653d666c6174)](https://www.yiiframework.com/)[![Twitter](https://camo.githubusercontent.com/d077c362ac639792171af8bc002ee827816733dfc0925f70b557e6d151022226/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f747769747465722d666f6c6c6f772d3144413146323f6c6f676f3d74776974746572266c6f676f436f6c6f723d314441314632266c6162656c436f6c6f723d3535353535353f7374796c653d666c6174)](https://twitter.com/yiiframework)[![Telegram](https://camo.githubusercontent.com/4e38dd12535575c39c65bea7119b95e663abb2d1f4e3d669a27bbda07ef603f0/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f74656c656772616d2d6a6f696e2d3144413146323f7374796c653d666c6174266c6f676f3d74656c656772616d)](https://t.me/yii3en)[![Facebook](https://camo.githubusercontent.com/48204e301b34b29b0815854544f04c337fc0692096cab35e9a1f8c53a42c2307/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f66616365626f6f6b2d6a6f696e2d3144413146323f7374796c653d666c6174266c6f676f3d66616365626f6f6b266c6f676f436f6c6f723d666666666666)](https://www.facebook.com/groups/yiitalk)[![Slack](https://camo.githubusercontent.com/1a3645ba1c97e6684d0349bc478201e1621ba0d3efad516d81035364d442bad7/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f736c61636b2d6a6f696e2d3144413146323f7374796c653d666c6174266c6f676f3d736c61636b)](https://yiiframework.com/go/slack) ### Health Score 64 — FairBetter than 99% of packages Maintenance73 Regular maintenance activity Popularity50 Moderate usage in the ecosystem Community42 Growing community involvement Maturity80 Battle-tested with a long release history Bus Factor2 2 contributors hold 50%+ of commits How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~167 days Recently: every ~424 days Total 13 Last Release 165d ago Major Versions 1.1.4 → 2.0.02021-04-13 2.0.0 → 3.0.02023-02-13 PHP version history (4 changes)1.0.0PHP ^7.4 1.0.1PHP ^7.4|^8.0 3.1.0PHP 8.1 - 8.4 3.1.1PHP 8.1 - 8.5 ### Community Maintainers ![](https://www.gravatar.com/avatar/261a6249c6f605f3956a2fae40fbb813f6b2e1e6f2bf806180c851a965426e54?d=identicon)[cebe](/maintainers/cebe) ![](https://www.gravatar.com/avatar/fc29e4e7068a00fe9b9db37b8aadda1db6020adcacef810461e47b99c2b150e6?d=identicon)[samdark](/maintainers/samdark) ![](https://www.gravatar.com/avatar/ccb75e3312d6bd454ea445ea308139fd185a4ca906ca5df21cc66e6a35de25a3?d=identicon)[SilverFire](/maintainers/SilverFire) ![](https://www.gravatar.com/avatar/99106256c24a8cb23871b99fa90e48f37f1aa71608c185759b7d2a88683a5918?d=identicon)[hiqsol](/maintainers/hiqsol) --- Top Contributors [![samdark](https://avatars.githubusercontent.com/u/47294?v=4)](https://github.com/samdark "samdark (60 commits)")[![vjik](https://avatars.githubusercontent.com/u/525501?v=4)](https://github.com/vjik "vjik (25 commits)")[![terabytesoftw](https://avatars.githubusercontent.com/u/42547589?v=4)](https://github.com/terabytesoftw "terabytesoftw (10 commits)")[![devanych](https://avatars.githubusercontent.com/u/20116244?v=4)](https://github.com/devanych "devanych (7 commits)")[![xepozz](https://avatars.githubusercontent.com/u/6815714?v=4)](https://github.com/xepozz "xepozz (6 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (5 commits)")[![damasco](https://avatars.githubusercontent.com/u/1377554?v=4)](https://github.com/damasco "damasco (4 commits)")[![luizcmarin](https://avatars.githubusercontent.com/u/67489841?v=4)](https://github.com/luizcmarin "luizcmarin (4 commits)")[![mspirkov](https://avatars.githubusercontent.com/u/63721828?v=4)](https://github.com/mspirkov "mspirkov (4 commits)")[![dependabot-preview[bot]](https://avatars.githubusercontent.com/in/2141?v=4)](https://github.com/dependabot-preview[bot] "dependabot-preview[bot] (3 commits)")[![skugarev](https://avatars.githubusercontent.com/u/22639131?v=4)](https://github.com/skugarev "skugarev (1 commits)")[![rustamwin](https://avatars.githubusercontent.com/u/16498265?v=4)](https://github.com/rustamwin "rustamwin (1 commits)")[![viktorprogger](https://avatars.githubusercontent.com/u/7670669?v=4)](https://github.com/viktorprogger "viktorprogger (1 commits)")[![Fantom409](https://avatars.githubusercontent.com/u/14968877?v=4)](https://github.com/Fantom409 "Fantom409 (1 commits)") --- Tags aliashacktoberfestpathyii3alias ### Code Quality TestsPHPUnit Static AnalysisRector ### Embed Badge ![Health badge](/badges/yiisoft-aliases/health.svg) ``` [![Health](https://phpackages.com/badges/yiisoft-aliases/health.svg)](https://phpackages.com/packages/yiisoft-aliases) ``` ### Alternatives [laravel/passport Laravel Passport provides OAuth2 server support to Laravel. 3.4k85.0M532](/packages/laravel-passport)[nolimits4web/swiper Most modern mobile touch slider and framework with hardware accelerated transitions 41.8k177.2k1](/packages/nolimits4web-swiper)[laravel/dusk Laravel Dusk provides simple end-to-end testing and browser automation. 1.9k36.7M259](/packages/laravel-dusk)[laravel/prompts Add beautiful and user-friendly forms to your command-line applications. 712181.8M596](/packages/laravel-prompts)[cakephp/chronos A simple API extension for DateTime. 1.4k47.7M121](/packages/cakephp-chronos)[laravel/pail Easily delve into your Laravel application's log files directly from the command line. 91545.3M590](/packages/laravel-pail) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)