milo/alias-expander

Runtime alias expanding to fully qualified class name.

Maintainers

Details

github.com/milo/alias-expander

Source

Issues

Installs: 25

Dependents: 0

Suggesters: 0

Security: 0

Stars: 2

Watchers: 3

Forks: 0

Open Issues: 0

v1.0.0 2013-07-22 11:22 UTC

Requires

  • php: >=5.3.0

Requires (Dev)

BSD-3-Clause, GPL-2.0, GPL-3.0, MIT 447f2b0248b6f8641b0cad728ee0336174122336

This package is auto-updated.

Last update: 2024-04-06 07:47:18 UTC

README

It is a tool for run-time class alias expanding to its fully qualified name. In brief, it is a workaround for missing ::class constant from PHP 5.5 in PHP 5.3+ and a helper for annotations processing.

# An ordinary 'use' usage in namespaced code. But how to expand the alias to full class name?
use Other\Lib as OL;

# in PHP 5.5+
echo OL::class;  // 'Other\Lib'

# in PHP 5.3+
echo Alias::expand('OL');  // 'Other\Lib'


# If the static call is too long for you, wrap it in own function. It will be easy to replace
# when upgrade to PHP 5.5.
function aliasFqn($alias) {
	return \Milo\Alias::expand($alias, 1);
}


# Due to performance, it is good to set writable directory for caching.
Alias::getExpander()->setCacheDir('/path/to/tmp');


# If you want to be strict and ensure that alias expands only to defined class name,
# set exists checking. This is a debugging advantage against to ::class in PHP 5.5.
Alias::getExpander()->setExistsCheck(TRUE);
# or
Alias::getExpander()->setExistsCheck(E_USER_WARNING);


# Expanding an alias in explicitly specified file and line context is useful
# for annotations processing.
$method = new ReflectionMethod($object, 'method');
Alias::expandExplicit('NS\Alias', $method->getFileName(), $method->getStartLine());


# The Milo\Alias class is only a static wrapper for the Milo\AliasExpander object.
# You can use a non-static variation in the same way.
$expander = new Milo\AliasExpander;
$expander->expand('OL');
$expander->expandExplicit('OL', $file, $line);
$expander->setCacheDir('/path/to/tmp');
...

If you know the Nette Framework, there is a prepared version of expander for using with Nette\Cache.

$storage = new Nette\Caching\Storages\FileStorage('/path/to/tmp');
$expander = new Milo\Nette\AliasExpander($storage);

There are some limitations:

  • One line code like namespace First; AliasExpander::expand('Foo'); namespace Second; may leads to wrong expanding. It is not so easy to implement it because PHP tokenizer and debug_backtrace() provides only line number, but not the column. This can be a problem in minified code.
  • Keywords self, static and parent are not expanded as in PHP 5.5, but this can be easily solved by __CLASS__, get_called_class() and get_parent_class() instead of AliasExpander using.

Licence

You may use all files under the terms of the New BSD Licence, or the GNU Public Licence (GPL) version 2 or 3, or the MIT Licence.

Tests

The AliasExpander tests are written for Nette Tester. Two steps are required to run them:

# Download the Tester tool
composer.phar update --dev

# Run the tests
vendor/bin/tester tests

Build Status