FuelPHP Framework - Class and Namespace alias library

fuelphp-storage

Last update: Feb 20, 2022

Related tags

Miscellaneous alias

Overview

Fuel Alias

Library for lazy class aliasing.

Install

Via Composer

$ composer require fuelphp/alias

Usage

Within FuelPHP class aliases are used to provide easy access to namespaced classes and facilitate class inheritance injection.

The package exposes an alias manager which lets you create 3 types of aliases:

Literal
A one-to-one translation. Class "Namespaced\Classname" translates to "Another\Classname".
Namespace
Namespace aliases allow you to alias an entire namespace with one call.
Replacement
A pattern is matched an through replacements a new class is generated. "Namespace\*" maps to "Alias\$1".

When registering the alias manager append or prepends itself to the autoload stack to act as a pre-processor or fallback. Depending on the amount of aliases and it could be beneficial to alternate between pre- or appending.

By default the manager will prepend itself to the autoloader stack.

Basic Usage

// Create a new alias manager
$manager = new Fuel\Alias\Manager;

// Register the manager
$manager->register();

// Alias one class
$manager->alias('Alias\Me', 'To\This');

// Or alias many
$manager->alias([
	'Alias\This' => 'To\Me',
	'AndAlias\This' => 'To\SomethingElse',
]);

//

Namespace usage

// alias to a less deep namespace
$manager->aliasNamespace('Less\Deep', 'Some\Super\Deep\Name\Space');


// alias a namespace to global
$manager->aliasNamespace('Some\Space', '');

Pattern Usage

$manager = new Fuel\Alias\Manager;

// Alias with wildcards
$manager->aliasPattern('Namespaced\*', 'Other\\$1');

$otherThing = new Namespaced\Thing;

This can result into class resolving that doesn't exists. Luckily the package is smart enough the check wether the class exists and will continue to look for the correct class if the resolved class does not exist. This is also taken into account when it comes to caching. Only resolved classes that exist will be cached.

Contributing

Thank you for considering contribution to FuelPHP framework. Please see CONTRIBUTING for details.

License

The MIT License (MIT). Please see License File for more information.

Comments

Convert tests to use vfs

Update the cache tests to use vfs to make them cleaner and simplify the build script.

Ultimately remove the cache class once the fuelphp/cache package is finished.

opened by emlynwest 0
Recursive resolve based on aliases

It would be a good feature to be able to resolve aliases which are also defined as aliases in the manager.

So AliasedClass->OneMoreAliasedClass->RealClass could work.

Real life example: Fuel v1 legacy support

Namespace\OldClassName->New\Name\Space\NewClassName Namespace -> ''

This way OldClassName is available from the global namespace.

Temporary workaround is to use as many managers as the required levels, but that is ugly.

opened by sagikazarmark 4

FuelPHP Framework - Class and Namespace alias library

Related tags

Overview

Fuel Alias

Install

Usage

Basic Usage

Namespace usage

Pattern Usage

Contributing

License

You might also like...

Utilities to scan PHP code and generate class maps.

WooCommerce function and class declaration stubs for static analysis.

Optimizes class loading performance by generating a single PHP file containing all of the autoloaded files.

A class to help convert bytes into other units (kb, mb, etc).

A small package to add computed properties to any PHP class. 🐘

COP4331 Class Project 1 - "ConnectUs" virtual contact manager/Rolodex

Class for manage directly leds on raspberry pi in PHP

A class for easy connection to the zarinpal port

Music website developed as a final group project for our Webpage Development class.

Comments

Convert tests to use vfs

Recursive resolve based on aliases

Releases(2.0.0)

2.0.0(Jan 1, 2015)

Owner

fuelphp-storage

Exploiting and fixing security vulnerabilities of an old version of E-Class. Project implemented as part of the class YS13 Cyber-Security.

A simple, standalone, modern PHP class inspector and mapper library, wrapping PHPs native reflection in a fluent interface

Basic class library to read, write and view files using PHP.

Allows generate class files parse from json and map json to php object, including multi-level and complex objects;

CRUD Build a system to insert student name information, grade the class name, and edit and delete this information

A lightweight php class for formatting sql statements. Handles automatic indentation and syntax highlighting.

Demonstration of OOP concepts and usage of Abstract class & Interfaces

Polonium is a world class old school ✍️ blog website made with Php and Tailwind 🌀

This PHP class uploads files and manipulates images very easily

PHP class for convert KA letters to LAT and back