名前空間の使用法: エイリアス/インポート

    (PHP 5 >= 5.3.0, PHP 7, PHP 8)

    外部の完全修飾名をエイリアスで参照したりインポートしたりする機能は、 名前空間において非常に重要なものです。 これは、Unix 系のファイルシステムでファイルやディレクトリへのシンボリックリンクを作成することに似ています。

    PHP は定数、関数、クラス、インターフェイス、トレイト、列挙型(Enum)、名前空間のエイリアスやインポートをサポートしています。

    エイリアス作成には use 演算子を使用します。 ここに、5 種類すべてのインポート方法の例を示します。

    例1 use 演算子によるインポート/エイリアス

    <?php
    namespace foo;
    use     My\Full\Classname as Another;

    // これは use My\Full\NSname as NSname と同じです
    use My\Full\NSname;

    // グローバルクラスをインポートします
    use ArrayObject;

    // 関数をインポートします
    use function My\Full\functionName;

    // 関数のエイリアスを定義します
    use function My\Full\functionName as func;

    // 定数をインポートします
    use const My\Full\CONSTANT;

    $obj = new namespace\Another; // foo\Another クラスのオブジェクトのインスタンスを作成します
    $obj = new Another; // My\Full\Classname クラスのオブジェクトのインスタンスを作成します
    NSname\subns\func(); // My\Full\NSname\subns\func 関数をコールします
    $a = new ArrayObject(array(1)); // ArrayObject クラスのオブジェクトのインスタンスを作成します
    // "use ArrayObject" がなければ、foo\ArrayObject クラスのオブジェクトのインスタンスを作成することになります
    func(); // 関数 My\Full\functionName を呼びます
    echo CONSTANT; // 定数 My\Full\CONSTANT の値を表示します
    ?>
    名前空間つきの名前 (完全修飾形式の名前空間は区切り文字を含んだ Foo\Bar のようなもので、グローバルな場合は区切り文字を含まない FooBar のようになります) では先頭のバックスラッシュは不要で、推奨されないことに注意しましょう。 インポートする名前は完全修飾形式でなければならず、 現在の名前空間からの相対指定で処理されることはないからです。

    PHP では、複数の use 文を同一行に置くための便利なショートカットもサポートしています。

    例2 use 演算子によるインポート/エイリアスで、複数の use 文を組み合わせる例

    <?php
    use My\Full\Classname as Another, My\Full\NSname;

    $obj = new Another; // My\Full\Classname クラスのオブジェクトのインスタンスを作成します
    NSname\subns\func(); // My\Full\NSname\subns\func 関数をコールします
    ?>

    インポートはコンパイル時に行われるので、動的なクラス名、関数名や定数名には影響を及ぼしません。

    例3 インポートと動的名

    <?php
    use My\Full\Classname as Another, My\Full\NSname;

    $obj = new Another; // My\Full\Classname クラスのオブジェクトのインスタンスを作成します
    $a = 'Another';
    $obj = new $a; // Another クラスのオブジェクトのインスタンスを作成します
    ?>

    さらにインポートの影響が及ぶのは非修飾名および修飾名のみです。 完全修飾名は絶対的なものであり、インポートの影響を受けることはありません。

    例4 インポートと完全修飾名

    <?php
    use My\Full\Classname as Another, My\Full\NSname;

    $obj = new Another; // My\Full\Classname クラスのオブジェクトのインスタンスを作成します
    $obj = new \Another; // Another クラスのオブジェクトのインスタンスを作成します
    $obj = new Another\thing; // My\Full\Classname\thing クラスのオブジェクトのインスタンスを作成します
    $obj = new \Another\thing; // Another\thing クラスのオブジェクトのインスタンスを作成します
    ?>

    インポート時のスコープ規則

    use キーワードの宣言は、ファイル内の一番外側のスコープ (グローバルスコープ) あるいは名前空間宣言の中で行わなければなりません。 これは、インポートが実行時ではなくコンパイル時に行われるためです。 ブロック内のスコープではインポートできません。 次の例は、use キーワードの間違った使い方を示すものです。

    例5 間違ったインポートの例

    <?php
    namespace Languages;

    function     toGreenlandic()
    {
    use     Languages\Danish;

    // ...
    }
    ?>

    注意:

    インポート規則はファイル単位のものです。つまり、インクルードされたファイルは インクロード元の親ファイルのインポート規則を 引き継ぎません。

    use 宣言のグループ化

    同じ namespace から複数のクラスや関数そして定数をインポートする際には、 それらをひとつの use にまとめることができます。

    <?php

    use some\namespace\ClassA;
    use     some\namespace\ClassB;
    use     some\namespace\ClassC as C;

    use function     some\namespace\fn_a;
    use function     some\namespace\fn_b;
    use function     some\namespace\fn_c;

    use const     some\namespace\ConstA;
    use const     some\namespace\ConstB;
    use const     some\namespace\ConstC;

    // 上記のコードは、グループ化されたuse宣言と同等です。
    use some\namespace\{ClassA, ClassB, ClassC as C};
    use function     some\namespace\{fn_a, fn_b, fn_c};
    use const     some\namespace\{ConstA, ConstB, ConstC};

    Improve This Page

    Learn How To Improve This Page • Submit a Pull Request • Report a Bug
    ＋add a note

    User Contributed Notes 17 notes

    up
    194
    dominic_mayers at yahoo dot com
    8 years ago
    The keyword "use" has been recycled for three distinct applications:
    1- to import/alias classes, traits, constants, etc. in namespaces,
    2- to insert traits in classes,
    3- to inherit variables in closures.
    This page is only about the first application: importing/aliasing. Traits can be inserted in classes, but this is different from importing a trait in a namespace, which cannot be done in a block scope, as pointed out in example 5. This can be confusing, especially since all searches for the keyword "use" are directed to the documentation here on importing/aliasing.
    up
    156
    anon
    10 years ago
    The <?php use ?> statement does not load the class file. You have to do this with the <?php require ?> statement or by using an autoload function.
    up
    56
    Mawia HL
    7 years ago
    Here is a handy way of importing classes, functions and conts using a single use keyword:

    <?php
    use Mizo\Web\ {
    Php\WebSite,
    Php\KeyWord,
    Php\UnicodePrint,
    JS\JavaScript,
    function     JS\printTotal,
    function     JS\printList,
    const     JS\BUAIKUM,
    const     JS\MAUTAM
    };
    ?>
    up
    80
    k at webnfo dot com
    11 years ago
    Note that you can not alias global namespace:

    use \ as test;

    echo test\strlen('');

    won't work.
    up
    33
    xzero at elite7hackers dot net
    7 years ago
    I couldn't find answer to this question so I tested myself.
    I think it's worth noting:

    <?php
    use ExistingNamespace\NonExsistingClass;
    use     ExistingNamespace\NonExsistingClass as whatever;
    use     NonExistingNamespace\NonExsistingClass;
    use     NonExistingNamespace\NonExsistingClass as whatever;
    ?>

    None of above will actually cause errors unless you actually try to use class you tried to import.

    <?php
    // And this code will issue standard PHP error for non existing class.
    use ExistingNamespace\NonExsistingClass as whatever;
    $whatever = new whatever();
    ?>
    up
    23
    me at ruslanbes dot com
    8 years ago
    Note the code `use ns1\c1` may refer to importing class `c1` from namespace `ns1` as well as importing whole namespace `ns1\c1` or even import both of them in one line. Example:

    <?php
    namespace ns1;

    class     c1{}

    namespace     ns1\c1;

    class     c11{}

    namespace     main;

    use     ns1\c1;

    $c1 = new c1();
    $c11 = new c1\c11();

    var_dump($c1); // object(ns1\c1)#1 (0) { }
    var_dump($c11); // object(ns1\c1\c11)#2 (0) { }
    up
    28
    c dot 1 at smithies dot org
    13 years ago
    If you are testing your code at the CLI, note that namespace aliases do not work!

    (Before I go on, all the backslashes in this example are changed to percent signs because I cannot get sensible results to display in the posting preview otherwise. Please mentally translate all percent signs henceforth as backslashes.)

    Suppose you have a class you want to test in myclass.php:

    <?php
    namespace my%space;
    class     myclass {
    // ...
    }
    ?>

    and you then go into the CLI to test it. You would like to think that this would work, as you type it line by line:

    require 'myclass.php';
    use my%space%myclass; // should set 'myclass' as alias for 'my%space%myclass'
    $x = new myclass; // FATAL ERROR

    I believe that this is because aliases are only resolved at compile time, whereas the CLI simply evaluates statements; so use statements are ineffective in the CLI.

    If you put your test code into test.php:
    <?php
    require 'myclass.php';
    use     my%space%myclass;
    $x = new myclass;
    //...
    ?>
    it will work fine.

    I hope this reduces the number of prematurely bald people.
    up
    20
    x at d dot a dot r dot k dot REMOVEDOTSANDTHIS dot gray dot org
    11 years ago
    You are allowed to "use" the same resource multiple times as long as it is imported under a different alias at each invocation.

    For example:

    <?php
    use Lend;
    use     Lend\l1;
    use     Lend\l1 as l3;
    use     Lend\l2;
    use     Lend\l1\Keller;
    use     Lend\l1\Keller as Stellar;
    use     Lend\l1\Keller as Zellar;
    use     Lend\l2\Keller as Dellar;

    ...

    ?>

    In the above example, "Keller", "Stellar", and "Zellar" are all references to "\Lend\l1\Keller", as are "Lend\l1\Keller", "l1\Keller", and "l3\Keller".
    up
    16
    cl
    11 years ago
    Something that is not immediately obvious, particular with PHP 5.3, is that namespace resolutions within an import are not resolved recursively. i.e.: if you alias an import and then use that alias in another import then this latter import will not be fully resolved with the former import.

    For example:
    use \Controllers as C;
    use C\First;
    use C\Last;

    Both the First and Last namespaces are NOT resolved as \Controllers\First or \Controllers\Last as one might intend.
    up
    3
    ultimater at gmail dot com
    8 years ago
    Note that "use" importing/aliasing only applies to the current namespace block.

    <?php

    namespace SuperCoolLibrary
    {
    class     Meta
    {
    static public function     getVersion()
    {
    return     '2.7.1';
    }
    }
    }

    namespace
    {
    use     SuperCoolLibrary\Meta;
    echo     Meta::getVersion();//outputs 2.7.1
    }

    namespace
    {
    echo     Meta::getVersion();//fatal error
    }

    ?>

    To get the expected behavior, you'd use:
    class_alias('SuperCoolLibrary\Meta','Meta');
    up
    1
    ZhangLiang
    7 years ago
    In Chinese,there is an error in translation:
    // 如果不使用 "use \ArrayObject" ，则实例化一个 foo\ArrayObject 对象
    it should be
    // 如果不使用 "use ArrayObject" ，则实例化一个 foo\ArrayObject 对象

    /*********************************************/
    中文下翻译有错误
    // 如果不使用 "use \ArrayObject" ，则实例化一个 foo\ArrayObject 对象
    这句话应该是
    // 如果不使用 "use ArrayObject" ，则实例化一个 foo\ArrayObject 对象
    up
    0
    eithed at google mail
    3 years ago
    Bear in mind that it's perfectly fine to alias namespaces, ie:

    <?php
    use A\B\C\D\E\User;

    new     User();
    ?>

    can be also written as:

    <?php
    use A\B\C\D\E as ENamespace;

    new     ENamespace\User();
    ?>

    however following will not work:

    <?php
    use A\B\C\D\E as ENamespace;
    use     ENamespace\User;

    new     User();
    ?>

    > PHP Error: Class "ENamespace\User" not found
    up
    0
    thinice at gmail.com
    13 years ago
    Because imports happen at compile time, there's no polymorphism potential by embedding the use keyword in a conditonal.

    e.g.:

    <?php
    if ($objType == 'canine') {
    use     Animal\Canine as Beast;
    }
    if (    $objType == 'bovine') {
    use     Animal\Bovine as Beast;
    }

    $oBeast = new Beast;
    $oBeast->feed();
    ?>
    up
    -2
    dominic_mayers at yahoo dot com
    8 years ago
    To clarify the distinction between inserting a trait in a class and importing a trait in a namespace, here is an example where we first import and then insert a trait.

    <?php
    namespace ns1;
    trait     T {
    static     $a = "In T";
    }

    namespace     ns2;
    use     ns1\T; // Importing the name of trait ns1\T in the namespace ns2
    class C {
    use     T; // Inserting trait T in the class C, making use of the imported name.
    }

    namespace     main;
    use     ns2\C;
    echo     C::$a; // In T;
    up
    -5
    kelerest123 at gmail dot com
    9 years ago
    For the fifth example (example #5):

    When in block scope, it is not an illegal use of use keyword, because it is used for sharing things with traits.
    up
    -3
    info at ensostudio dot ru
    4 years ago
    Note: you can import not existed items without errors:
    <?php
    use UndefinedClass;
    use function     undefined_fn;
    use const     UNDEFINED_CONST;
    ?>
    but you cant use/call they:
    <?php
    $new UndefinedClass    ; // Error: Use of undefined class
    use function undefined_fn; // Error: Use of undefined function
    use const UNDEFINED_CONST; // Error: Use of undefined constant
    ?>
    up
    -3
    tuxedobob
    2 years ago
    Note that because this is processed at compile time, this doesn't work when running PHP in interactive mode. use commands won't throw an error, but they won't do anything, either.
    ＋add a note
    To Top