xp-framework/uses

This package is abandoned and no longer maintained. No replacement package was suggested.

Uses BC

v0.2.0 2016-01-09 15:01 UTC

Requires

• php: >=5.5.0
• xp-framework/core: ^6.4

Requires (Dev)

• xp-framework/unittest: ^6.5

BSD-3-Clause

• module
• xp

README

Backward compatibility for loading classes with uses() with XP 6.4.0+

Motivation

In XP 6.4.0, support for loading classes via uses() was dropped as part of the framework's path to PHP 7.0. Unfortunately, not everyone may be able to adapt their entire codebase in a timely manner. However, they still might want to be able to use newer versions of the framework, which include bugfixes they might need. This library can help during this transient state.

Background

Before the XP Framework was completely migrated to PHP namespaces, classes where declared as follows:

<?php
  uses('util.Filter');

  class Filters extends Object implements Filter {
    // ...
  }
?>

Notes:

• Classes exist in the global namespace, their names are inferred by the xp::$cn map which stores the association long name => literal.
• The Object can be referred to by its short name. This is because it belongs to a list of omnipresent classes.
• The Filter interface can be referred to by its short name. This is because it was loaded explicitely above, and happens regardless of whether it is declared namespaced or not.

What this library does

This library:

• Adds a uses() function. It takes care of loading classes, creating short name aliases for namespaced classes and handling imports.
• Injects a class loader in the class loading chain which adds support for legacy class declarations. It ensures class name / literal mappings are correctly registered.

If successfully installed, you will see the UsesCL line appear:

$ xp -v
XP 6.9.3-dev { PHP 7.0.0 & ZE 3.0.0 } @ Windows NT SLATE 10.0 build 10586 (Windows 10) i586
Copyright (c) 2001-2016 the XP group
UsesCL(cached: 0)
FileSystemCL<~/devel/xp/core/src/main/php>
# ...