В части 1, мы обсуждали для чего нужны пространства имён (namespaces) в PHP, и что обозначает зарезервированное слово namespace. В этой статье мы исследуем оператор use и способ, которым PHP разрешает имена пространств имён.

В целях данной статьи мы будем использовать два почти идентичных кода, единственное различие которых — в их пространствах имён:

lib1.php:

1. <?php
2. // application library 1
3. namespace App\Lib1;
4.  
5. const MYCONST = 'App\Lib1\MYCONST';
6.  
7. function MyFunction() {
8.   return __FUNCTION__;
9. }
10.  
11. class MyClass {
12.   static function WhoAmI() {
13.     return __METHOD__;
14.   }
15. }
16. ?>

lib2.php:

1. <?php
2. // application library 2
3. namespace App\Lib2;
4.  
5. const MYCONST = 'App\Lib2\MYCONST';
6.  
7. function MyFunction() {
8.   return __FUNCTION__;
9. }
10.  
11. class MyClass {
12.   static function WhoAmI() {
13.     return __METHOD__;
14.   }
15. }
16. ?>

Прежде чем мы начнём, давайте вспомним несколько определений из PHP терминологии:

Полное квалифицированное имя (Fully-qualified name)

Любой PHP код может ссылаться на полное квалифицированное имя — идентификатор, начинающийся с разделителя пространства имён (т. е. обратного слэша — backslash), например: \App\Lib1\MYCONST, \App\Lib2\MyFunction() и т.д.

В полных квалифицированных именах нет никакой двусмысленности. Начальный обратный слэш действует аналогичным образом как и путь к файлу, обозначая «корень (root)» глобального пространства. Если бы мы выполняли различные MyFunction() в нашем глобальном пространстве, они могли бы быть вызваны из lib1.php или lib2.php с помощью \MyFunction().

Полные квалифицированные имена полезны для одноразового вызова функций или инициализации объектов. Однако, когда вы делаете много вызовов, они становятся непрактичными. Как мы узнаем ниже, PHP предлагает другие варианты в этих случаях.

Квалифицированное имя (Qualified name)

Идентификатор, имеющий как минимум хотя бы один разделитель пространства имён (namespace separator, фактически — обратный слэш), например Lib1\MyFunction().

Неквалифицированное имя (Unqualified name)

Идентификатор без разделителя пространства имён, например MyFunction().

Работа с одинаковыми пространствами имён

Обсудим следующий код:

myapp1.php:

1. <?php
2. namespace App\Lib1;
3.  
4. require_once('lib1.php');
5. require_once('lib2.php');
6.  
7. header('Content-type: text/plain');
8. echo MYCONST . "\n";
9. echo MyFunction() . "\n";
10. echo MyClass::WhoAmI() . "\n";
11. ?>

Хотя мы присоединили и lib1.php и lib2.php, идентификаторы MYCONST, MyFunction и MyClass будут относиться только к lib1.php. Это произойдет потому что код myapp1.php расположен в едином с App\Lib1 пространстве имён:

результат:

1. App\Lib1\MYCONST
2. App\Lib1\MyFunction
3. App\Lib1\MyClass::WhoAmI

Импортирование пространств имён (Namespace Importing)

Пространства имён могут быть импортированы с помощью оператора use, например:

myapp2.php:

1. <?php
2. use App\Lib2;
3.  
4. require_once('lib1.php');
5. require_once('lib2.php');
6.  
7. header('Content-type: text/plain');
8. echo Lib2\MYCONST . "\n";
9. echo Lib2\MyFunction() . "\n";
10. echo Lib2\MyClass::WhoAmI() . "\n";
11. ?>

Вы можете импортировать с помощью use одно или несколько пространств имён, разделяя их запятой. В данном примере, мы импортировали пространство имён App\Lib2. Мы все еще не можем ссылаться прямо на MYCONST, MyFunction или MyClass потому что наш код находится в глобальном пространстве и PHP будет искать их именно там. Но если мы добавим префикс «Lib2\», они станут квалифицированными именами, а PHP станет искать их в импортированных пространствах имён, пока не найдет полного совпадения.

результат:

1. App\Lib2\MYCONST
2. App\Lib2\MyFunction
3. App\Lib2\MyClass::WhoAmI

Псевдонимы пространства имён (Namespace Aliases)

Псевдонимы пространства имён, возможно, самая полезная конструкция. Псевдонимы позволяют ссылаться на длинные пространства имён с помощью короткого имени.

myapp3.php:

1. <?php
2. use App\Lib1 as L;
3. use App\Lib2\MyClass as Obj;
4.  
5. header('Content-type: text/plain');
6. require_once('lib1.php');
7. require_once('lib2.php');
8.  
9. echo L\MYCONST . "\n";
10. echo L\MyFunction() . "\n";
11. echo L\MyClass::WhoAmI() . "\n";
12. echo Obj::WhoAmI() . "\n";
13. ?>

Первый оператор use определяет App\Lib1 как «L». Любое квалифицированное имя, использующее «L», будет преобразовано во время компиляции в «App\Lib1». Поэтому, мы скорее сошлемся на L\MYCONST или L\MyFunction, чем на полное квалифицированное имя.

Второй оператор use более интересен. Он определяет «Obj» как псевдоним для класса «MyClass» в пределах пространства имён App\Lib2\. Эта операция применительна только для классов — не для констант или функций. Теперь мы можем использовать new Obj(), или вызывать статические методы, как показано выше.

результат:

1. App\Lib1\MYCONST
2. App\Lib1\MyFunction
3. App\Lib1\MyClass::WhoAmI
4. App\Lib2\MyClass::WhoAmI

Правила разбора имён

Имена PHP идентификаторов разрешаются следующими правилами пространств имён. для более полной информации, обратитесь к руководству по PHP (на английском / на русском)

1. Вызов квалифицированных функций разрешается во время компилирования.
2. Все квалифицированные имена транслируются во время компиляции в соответствии с текущими импортированными пространствами имён. К примеру, если импортировано пространство имён A::B::C, вызов C::D::e() будет транслирован как A::B::C::D::e().
3. Внутри пространства имён все квалифицированные имена транслируются согласно правилам импортирования, например, если пространство имён A\B\C импортируется как C, вызов C\D\e() транслируется в A\B\C\D\e().
4. Неквалифицированные имена классов транслируются во время компиляции в соответствии с текущими импортированными пространствами имён и полные имена заменяют короткие импортированные имена, например, если класс C в пространстве имён A\B импортирован как X, new X() будет транслирован в new A\B\C().
5. Внутри пространства имён вызов неквалифицированных функций интерпретируется во время компиляции. Например, если MyFunction() вызвана в пределах пространства имён A\B, PHP сперва ищет функцию \A\B\MyFunction(). Если она не будет найдена, PHP будет искать \MyFunction() в глобальном пространстве.
6. Вызовы неквалифицированных или квалифицированных имён классов интерпретируется во время компиляции. Например, если мы вызываем new C() в пределах пространства имён A\B, PHP будет искать класс A\B\C. Если он не будет найден, это приведет к попытке автозагрузки A\B\C.

В следующей части: ключевые слова и автозагрузка.

Читайте также:

Как использовать пространства имен в PHP, Часть 1: Основы
Как использовать пространства имён в PHP, Часть 3: Ключевые слова и автозагрузка

Примечания:

A/ Замечания, поправки, указания на неточности и проч. — приветствуются!

B/ Код подсвечен с помощью Source Code Highlighter.