-
Notifications
You must be signed in to change notification settings - Fork 105
/
Copy pathnamespaces.xml
1495 lines (1397 loc) · 46.3 KB
/
namespaces.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 874f7c1266d4e4f2e1e6c79b5fb48b590caa1197 Maintainer: Altair Status: ready -->
<!-- CREDITS: mowangjuanzi, Luffy -->
<chapter xml:id="language.namespaces" xmlns="http://docbook.org/ns/docbook"
version="1.1">
<title>命名空间概述</title>
<titleabbrev>概述</titleabbrev>
<sect1 xml:id="language.namespaces.rationale">
<title>命名空间概述</title>
<?phpdoc print-version-for="namespaces"?>
<simpara>
什么是命名空间?从广义上来说,命名空间是一种封装事物的方法。在很多地方都可以见到这种抽象概念。例如,在操作系统中目录用来将相关文件分组,对于目录中的文件来说,它就扮演了命名空间的角色。具体举个例子,文件
<literal>foo.txt</literal> 可以同时在目录 <literal>/home/greg</literal> 和
<literal>/home/other</literal> 中存在,但在同一个目录中不能存在两个
<literal>foo.txt</literal> 文件。另外,在目录 <literal>/home/greg</literal> 外访问
<literal>foo.txt</literal> 文件时,我们必须将目录名以及目录分隔符放在文件名之前得到
<literal>/home/greg/foo.txt</literal>。这个原理应用到程序设计领域就是命名空间的概念。
</simpara>
<simpara>
在 PHP 中,命名空间用来解决在编写类库或应用程序时创建可重用的代码如类或函数时碰到的两类问题:
</simpara>
<para>
<orderedlist>
<listitem>
<simpara>
用户编写的代码与PHP内部的类/函数/常量或第三方类/函数/常量之间的名字冲突。
</simpara>
</listitem>
<listitem>
<simpara>
为很长的标识符名称(通常是为了缓解第一类问题而定义的)创建一个别名(或简短)的名称,提高源代码的可读性。
</simpara>
</listitem>
</orderedlist>
</para>
<simpara>
PHP 命名空间提供了一种将相关的类、函数和常量组合到一起的途径。下面是一个说明 PHP
命名空间语法的示例:
</simpara>
<example>
<title>命名空间语法示例</title>
<programlisting role="php">
<![CDATA[
<?php
namespace my\name; // 参考 "定义命名空间" 小节
class MyClass {}
function myfunction() {}
const MYCONST = 1;
$a = new MyClass;
$c = new \my\name\MyClass; // 参考 "全局空间" 小节
$a = strlen('hi'); // 参考 "使用命名空间:后备全局函数/常量" 小节
$d = namespace\MYCONST; // 参考 "namespace操作符和__NAMESPACE__常量” 小节
$d = __NAMESPACE__ . '\MYCONST';
echo constant($d); // 参考 "命名空间和动态语言特征" 小节
?>
]]>
</programlisting>
</example>
<note>
<simpara>
命名空间名称大小写不敏感。
</simpara>
</note>
<note>
<para>
名为 <literal>PHP</literal> 的命名空间,以及以这些名字开头的命名空间
(例如 <literal>PHP\Classes</literal>)被保留用作语言内核使用,
而不应该在用户空间的代码中使用。
</para>
</note>
</sect1>
<sect1 xml:id="language.namespaces.definition">
<title>定义命名空间</title>
<titleabbrev>命名空间</titleabbrev>
<?phpdoc print-version-for="namespaces"?>
<para>
虽然任意合法的 PHP 代码都可以包含在命名空间中,但只有以下类型的代码受命名空间的影响,它们是:类(包括抽象类和 trait)、接口、函数和常量。
</para>
<para>
命名空间通过关键字 <literal>namespace</literal>
来声明。如果一个文件中包含命名空间,它必须在其它所有代码之前声明命名空间,除了一个以外:<xref linkend="control-structures.declare" />关键字。
<example>
<title>声明单个命名空间</title>
<programlisting role="php">
<![CDATA[
<?php
namespace MyProject;
const CONNECT_OK = 1;
class Connection { /* ... */ }
function connect() { /* ... */ }
?>
]]>
</programlisting>
</example>
<note>
<simpara>
完全限定名称(就是以反斜杠开头的名称)不能用于命名空间的声明。
因为该结构会解析成相对命名空间表达式。
</simpara>
</note>
在声明命名空间之前唯一合法的代码是用于定义源文件编码方式的 <literal>declare</literal>
语句。另外,所有非 PHP
代码包括空白符都不能出现在命名空间的声明之前:
<example>
<title>声明单个命名空间</title>
<programlisting role="php">
<![CDATA[
<html>
<?php
namespace MyProject; // 致命错误 - 命名空间必须是程序脚本的第一条语句
?>
]]>
</programlisting>
</example>
</para>
<para>
另外,与 PHP 其它的语言特征不同,同一个命名空间可以定义在多个文件中,即允许将同一个命名空间的内容分割存放在不同的文件中。
</para>
</sect1>
<sect1 xml:id="language.namespaces.nested">
<title>定义子命名空间</title>
<titleabbrev>子命名空间</titleabbrev>
<?phpdoc print-version-for="namespaces"?>
<para>
与目录和文件的关系很象,PHP
命名空间也允许指定层次化的命名空间的名称。因此,命名空间的名字可以使用分层次的方式定义:
<example>
<title>声明分层次的单个命名空间</title>
<programlisting role="php">
<![CDATA[
<?php
namespace MyProject\Sub\Level;
const CONNECT_OK = 1;
class Connection { /* ... */ }
function connect() { /* ... */ }
?>
]]>
</programlisting>
</example>
上面的例子创建了常量 <literal>MyProject\Sub\Level\CONNECT_OK</literal>,类
<literal>MyProject\Sub\Level\Connection</literal> 和函数
<literal>MyProject\Sub\Level\connect</literal>。
</para>
</sect1>
<sect1 xml:id="language.namespaces.definitionmultiple">
<title>在同一个文件中定义多个命名空间</title>
<titleabbrev>在一个文件中定义多个命名空间</titleabbrev>
<?phpdoc print-version-for="namespaces"?>
<para>
也可以在同一个文件中定义多个命名空间。在同一个文件中定义多个命名空间有两种语法形式。
</para>
<para>
<example>
<title>定义多个命名空间,简单组合语法</title>
<programlisting role="php">
<![CDATA[
<?php
namespace MyProject;
const CONNECT_OK = 1;
class Connection { /* ... */ }
function connect() { /* ... */ }
namespace AnotherProject;
const CONNECT_OK = 1;
class Connection { /* ... */ }
function connect() { /* ... */ }
?>
]]>
</programlisting>
</example>
</para>
<para>
不建议使用这种语法在单个文件中定义多个命名空间。建议使用下面的大括号形式的语法。
</para>
<para>
<example>
<title>定义多个命名空间,大括号语法</title>
<programlisting role="php">
<![CDATA[
<?php
namespace MyProject {
const CONNECT_OK = 1;
class Connection { /* ... */ }
function connect() { /* ... */ }
}
namespace AnotherProject {
const CONNECT_OK = 1;
class Connection { /* ... */ }
function connect() { /* ... */ }
}
?>
]]>
</programlisting>
</example>
</para>
<para>
在实际的编程实践中,非常不提倡在同一个文件中定义多个命名空间。这种方式的主要用于将多个 PHP
脚本合并在同一个文件中。
</para>
<para>
将全局的非命名空间中的代码与命名空间中的代码组合在一起,只能使用大括号形式的语法。全局代码必须用一个不带名称的 namespace
语句加上大括号括起来,例如:
<example>
<title>定义多个命名空间和不包含在命名空间中的代码</title>
<programlisting role="php">
<![CDATA[
<?php
namespace MyProject {
const CONNECT_OK = 1;
class Connection { /* ... */ }
function connect() { /* ... */ }
}
namespace { // 全局代码
session_start();
$a = MyProject\connect();
echo MyProject\Connection::start();
}
?>
]]>
</programlisting>
</example>
</para>
<para>
除了开始的 declare 语句外,命名空间的括号外不得有任何 PHP 代码。
<example>
<title>定义多个命名空间和不包含在命名空间中的代码</title>
<programlisting role="php">
<![CDATA[
<?php
declare(encoding='UTF-8');
namespace MyProject {
const CONNECT_OK = 1;
class Connection { /* ... */ }
function connect() { /* ... */ }
}
namespace { // 全局代码
session_start();
$a = MyProject\connect();
echo MyProject\Connection::start();
}
?>
]]>
</programlisting>
</example>
</para>
</sect1>
<sect1 xml:id="language.namespaces.basics">
<title>使用命名空间:基础</title>
<titleabbrev>基础</titleabbrev>
<?phpdoc print-version-for="namespaces"?>
<para>
在讨论如何使用命名空间之前,必须了解 PHP
是如何知道要使用哪一个命名空间中的元素的。可以将 PHP
命名空间与文件系统作一个简单的类比。在文件系统中访问一个文件有三种方式:
<orderedlist>
<listitem>
<simpara>
相对文件名形式如 <literal>foo.txt</literal>。它会被解析为
<literal>currentdirectory/foo.txt</literal>,其中 <literal>currentdirectory</literal>
表示当前目录。因此如果当前目录是
<literal>/home/foo</literal>,则该文件名被解析为 <literal>/home/foo/foo.txt</literal>。
</simpara>
</listitem>
<listitem>
<simpara>
相对路径名形式如 <literal>subdirectory/foo.txt</literal>。它会被解析为
<literal>currentdirectory/subdirectory/foo.txt</literal>。
</simpara>
</listitem>
<listitem>
<simpara>
绝对路径名形式如 <literal>/main/foo.txt</literal>。它会被解析为 <literal>/main/foo.txt</literal>。
</simpara>
</listitem>
</orderedlist>
PHP 命名空间中的元素使用同样的原理。例如,类名可以通过三种方式引用:
<orderedlist>
<listitem>
<simpara>
非限定名称,或不包含前缀的类名称,例如
<literal>$a=new foo();</literal> 或
<literal>foo::staticmethod();</literal>。如果当前命名空间是
<literal>currentnamespace</literal>,foo 将被解析为
<literal>currentnamespace\foo</literal>。如果使用 foo
的代码是全局的,不包含在任何命名空间中的代码,则 foo
会被解析为 <literal>foo</literal>。
</simpara>
<simpara>
警告:如果命名空间中的函数或常量未定义,则该非限定的函数名称或常量名称会被解析为全局函数名称或常量名称。详情参见
<link linkend="language.namespaces.fallback">使用命名空间:后备全局函数名称/常量名称</link>。
</simpara>
</listitem>
<listitem>
<simpara>
限定名称,或包含前缀的名称,例如
<literal>$a = new subnamespace\foo();</literal> 或
<literal>subnamespace\foo::staticmethod();</literal>。如果当前的命名空间是
<literal>currentnamespace</literal>,则 foo 会被解析为
<literal>currentnamespace\subnamespace\foo</literal>。如果使用
foo 的代码是全局的,不包含在任何命名空间中的代码,foo
会被解析为 <literal>subnamespace\foo</literal>。
</simpara>
</listitem>
<listitem>
<simpara>
完全限定名称,或包含了全局前缀操作符的名称,例如,
<literal>$a = new \currentnamespace\foo();</literal> 或
<literal>\currentnamespace\foo::staticmethod();</literal>。在这种情况下,foo
总是被解析为代码中的文字名(literal name)<literal>currentnamespace\foo</literal>。
</simpara>
</listitem>
</orderedlist>
</para>
<para>
下面是一个使用这三种方式的实例:
<informalexample>
<simpara>file1.php</simpara>
<programlisting role="php">
<![CDATA[
<?php
namespace Foo\Bar\subnamespace;
const FOO = 1;
function foo() {}
class foo
{
static function staticmethod() {}
}
?>
]]>
</programlisting>
<simpara>file2.php</simpara>
<programlisting role="php">
<![CDATA[
<?php
namespace Foo\Bar;
include 'file1.php';
const FOO = 2;
function foo() {}
class foo
{
static function staticmethod() {}
}
/* 非限定名称 */
foo(); // 解析为函数 Foo\Bar\foo
foo::staticmethod(); // 解析为类 Foo\Bar\foo 的静态方法 staticmethod
echo FOO; // 解析为常量 Foo\Bar\FOO
/* 限定名称 */
subnamespace\foo(); // 解析为函数 Foo\Bar\subnamespace\foo
subnamespace\foo::staticmethod(); // 解析为类 Foo\Bar\subnamespace\foo,
// 以及类的方法 staticmethod
echo subnamespace\FOO; // 解析为常量 Foo\Bar\subnamespace\FOO
/* 完全限定名称 */
\Foo\Bar\foo(); // 解析为函数 Foo\Bar\foo
\Foo\Bar\foo::staticmethod(); // 解析为类 Foo\Bar\foo, 以及类的方法 staticmethod
echo \Foo\Bar\FOO; // 解析为常量 Foo\Bar\FOO
?>
]]>
</programlisting>
</informalexample>
</para>
<para>
注意访问任意全局类、函数或常量,都可以使用完全限定名称,例如
<function>\strlen</function> 或 <classname>\Exception</classname> 或
\<constant>INI_ALL</constant>。
<example>
<title>在命名空间内部访问全局类、函数和常量</title>
<programlisting role="php">
<![CDATA[
<?php
namespace Foo;
function strlen() {}
const INI_ALL = 3;
class Exception {}
$a = \strlen('hi'); // 调用全局函数strlen
$b = \INI_ALL; // 访问全局常量 INI_ALL
$c = new \Exception('error'); // 实例化全局类 Exception
?>
]]>
</programlisting>
</example>
</para>
</sect1>
<sect1 xml:id="language.namespaces.dynamic">
<title>命名空间和动态语言特征</title>
<titleabbrev>命名空间和动态语言特征</titleabbrev>
<?phpdoc print-version-for="namespaces"?>
<para>
PHP 命名空间的实现受到其语言自身的动态特征的影响。因此,如果要将下面的代码转换到命名空间中:
<example>
<title>动态访问元素</title>
<simpara>example1.php:</simpara>
<programlisting role="php">
<![CDATA[
<?php
class classname
{
function __construct()
{
echo __METHOD__,"\n";
}
}
function funcname()
{
echo __FUNCTION__,"\n";
}
const constname = "global";
$a = 'classname';
$obj = new $a; // 输出 classname::__construct
$b = 'funcname';
$b(); // 输出 funcname
echo constant('constname'), "\n"; // 输出 global
?>
]]>
</programlisting>
</example>
必须使用完全限定名称(包括命名空间前缀的类名称)。注意因为在动态的类名称、函数名称或常量名称中,限定名称和完全限定名称没有区别,因此其前导的反斜杠是不必要的。
<example>
<title>动态访问命名空间的元素</title>
<programlisting role="php">
<![CDATA[
<?php
namespace namespacename;
class classname
{
function __construct()
{
echo __METHOD__,"\n";
}
}
function funcname()
{
echo __FUNCTION__,"\n";
}
const constname = "namespaced";
/* 注意,如果使用双引号,要这样写 "\\namespacename\\classname" */
$a = '\namespacename\classname';
$obj = new $a; // 输出 namespacename\classname::__construct
$a = 'namespacename\classname';
$obj = new $a; // 也会输出 namespacename\classname::__construct
$b = 'namespacename\funcname';
$b(); // 输出 namespacename\funcname
$b = '\namespacename\funcname';
$b(); // 也会输出 namespacename\funcname
echo constant('\namespacename\constname'), "\n"; // 输出 namespaced
echo constant('namespacename\constname'), "\n"; // 也会输出 namespaced
?>
]]>
</programlisting>
</example>
</para>
<para>
请一定别忘了阅读 <link linkend="language.namespaces.faq.quote">对字符串中的命名空间名称转义的注解</link>.
</para>
</sect1>
<sect1 xml:id="language.namespaces.nsconstants">
<title>namespace 关键字和 __NAMESPACE__ 魔术常量</title>
<titleabbrev>namespace 关键字和 __NAMESPACE__</titleabbrev>
<?phpdoc print-version-for="namespaces"?>
<para>
PHP支持两种抽象的访问当前命名空间内部元素的方法,<constant>__NAMESPACE__</constant>
魔术常量和 <literal>namespace</literal> 关键字。
</para>
<para>
常量 <constant>__NAMESPACE__</constant> 的值是包含当前命名空间名称的字符串。在全局的,不包括在任何命名空间中的代码,它包含一个空的字符串。
<example>
<title>__NAMESPACE__ 示例, 在命名空间中的代码</title>
<programlisting role="php">
<![CDATA[
<?php
namespace MyProject;
echo '"', __NAMESPACE__, '"'; // 输出 "MyProject"
?>
]]>
</programlisting>
</example>
<example>
<title>__NAMESPACE__ 示例,全局代码</title>
<programlisting role="php">
<![CDATA[
<?php
echo '"', __NAMESPACE__, '"'; // 输出 ""
?>
]]>
</programlisting>
</example>
常量 <constant>__NAMESPACE__</constant> 在动态创建名称时很有用,例如:
<example>
<title>使用 __NAMESPACE__ 动态创建名称</title>
<programlisting role="php">
<![CDATA[
<?php
namespace MyProject;
function get($classname)
{
$a = __NAMESPACE__ . '\\' . $classname;
return new $a;
}
?>
]]>
</programlisting>
</example>
</para>
<para>
关键字 <literal>namespace</literal> 可用来显式访问当前命名空间或子命名空间中的元素。它等价于类中的
<literal>self</literal> 操作符。
<example>
<title>namespace 操作符,命名空间中的代码</title>
<programlisting role="php">
<![CDATA[
<?php
namespace MyProject;
use blah\blah as mine; // 参考 "使用命名空间:别名/导入"
blah\mine(); // 调用函数 MyProject\blah\mine()
namespace\blah\mine(); // 调用函数 MyProject\blah\mine()
namespace\func(); // 调用函数 MyProject\func()
namespace\sub\func(); // 调用函数 MyProject\sub\func()
namespace\cname::method(); // 调用 class MyProject\cname 的静态方法 "method"
$a = new namespace\sub\cname(); // class MyProject\sub\cname 的实例对象
$b = namespace\CONSTANT; // 设置 $b 的值为常量 MyProject\CONSTANT
?>
]]>
</programlisting>
</example>
<example>
<title>namespace 操作符, 全局代码</title>
<programlisting role="php">
<![CDATA[
<?php
namespace\func(); // 调用函数 func()
namespace\sub\func(); // 调用函数 sub\func()
namespace\cname::method(); // 调用 class cname 的静态方法 "method"
$a = new namespace\sub\cname(); // class sub\cname 的实例对象
$b = namespace\CONSTANT; // 设置 $b 的值为常量 CONSTANT
?>
]]>
</programlisting>
</example>
</para>
</sect1>
<sect1 xml:id="language.namespaces.importing">
<title>使用命名空间:别名/导入</title>
<titleabbrev>别名和导入</titleabbrev>
<?phpdoc print-version-for="namespaces"?>
<para>
允许通过别名引用或导入外部的完全限定名称,是命名空间的一个重要特征。这有点类似于在类
unix 文件系统中可以创建对其它的文件或目录的符号连接。
</para>
<para>
PHP 可以为这些项目导入或设置别名:
常量、函数、类、接口、trait、枚举和命名空间。
</para>
<para>
别名是通过操作符 <literal>use</literal> 来实现的。下面是五种导入方式的例子:
<example>
<title>使用 use 操作符导入/使用别名</title>
<programlisting role="php">
<![CDATA[
<?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 的值
?>
]]>
</programlisting>
</example>
注意对命名空间中的名称(包含命名空间分隔符的完全限定名称如
<literal>Foo\Bar</literal> 以及相对的不包含命名空间分隔符的全局名称如
<literal>FooBar</literal>)来说,前导的反斜杠是不必要的也不推荐的,因为导入的名称必须是完全限定的,不会根据当前的命名空间作相对解析。
</para>
<para>
为了简化操作,PHP 还支持在一行中使用多个 use 语句
<example>
<title>通过 use 操作符导入/使用别名,一行中包含多个 use 语句</title>
<programlisting role="php">
<![CDATA[
<?php
use My\Full\Classname as Another, My\Full\NSname;
$obj = new Another; // 实例化 My\Full\Classname 对象
NSname\subns\func(); // 调用函数 My\Full\NSname\subns\func
?>
]]>
</programlisting>
</example>
</para>
<para>
导入操作是在编译执行的,但动态的类名称、函数名称或常量名称则不是。
<example>
<title>导入和动态名称</title>
<programlisting role="php">
<![CDATA[
<?php
use My\Full\Classname as Another, My\Full\NSname;
$obj = new Another; // 实例化一个 My\Full\Classname 对象
$a = 'Another';
$obj = new $a; // 实际化一个 Another 对象
?>
]]>
</programlisting>
</example>
</para>
<para>
另外,导入操作只影响非限定名称和限定名称。完全限定名称由于是确定的,故不受导入的影响。
<example>
<title>导入和完全限定名称</title>
<programlisting role="php">
<![CDATA[
<?php
use My\Full\Classname as Another, My\Full\NSname;
$obj = new Another; // class My\Full\Classname 的实例对象
$obj = new \Another; // class Another 的实例对象
$obj = new Another\thing; // class My\Full\Classname\thing 的实例对象
$obj = new \Another\thing; // class Another\thing 的实例对象
?>
]]>
</programlisting>
</example>
</para>
<sect2 xml:id="language.namespaces.importing.scope">
<title>导入规则的范围</title>
<para>
<literal>use</literal> 关键词必须在文件最外层范围
(全局作用域)或在命名空间声明内。
由于导入发生在编译时,而不是运行时,所以不能放入块作用域。
以下例子展示了不合规则的 <literal>use</literal> 关键词使用示例:
</para>
<para>
<example>
<title>不合规的导入规则</title>
<programlisting role="php">
<![CDATA[
<?php
namespace Languages;
function toGreenlandic()
{
use Languages\Danish;
// ...
}
?>
]]>
</programlisting>
</example>
</para>
<note>
<para>
导入规则独立于每个文件,意味着包含的文件
<emphasis>不会</emphasis>继承父文件的导入规则。
</para>
</note>
</sect2>
<sect2 xml:id="language.namespaces.importing.group">
<title><literal>use</literal> 声明编组</title>
<para>
通过单个 &use.namespace; 语句,可以将来自同一个 &namespace; 的
类、函数、常量一起编组导入。
</para>
<informalexample>
<programlisting role="php">
<![CDATA[
<?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};
]]>
</programlisting>
</informalexample>
</sect2>
</sect1>
<sect1 xml:id="language.namespaces.global">
<title>全局空间</title>
<titleabbrev>全局空间</titleabbrev>
<?phpdoc print-version-for="namespaces"?>
<para>
如果没有定义任何命名空间,所有的类与函数的定义都是在全局空间,与
PHP 引入命名空间概念前一样。在名称前加上前缀 <literal>\</literal>
表示该名称是全局空间中的名称,即使该名称位于其它的命名空间中时也是如此。
<example>
<title>使用全局空间说明</title>
<programlisting role="php">
<![CDATA[
<?php
namespace A\B\C;
/* 这个函数是 A\B\C\fopen */
function fopen() {
/* ... */
$f = \fopen(...); // 调用全局的fopen函数
return $f;
}
?>
]]>
</programlisting>
</example>
</para>
</sect1>
<sect1 xml:id="language.namespaces.fallback">
<title>使用命名空间:回退到全局函数和常量的全局空间</title>
<titleabbrev>回退到全局空间</titleabbrev>
<?phpdoc print-version-for="namespaces"?>
<para>
在一个命名空间中,当 PHP
遇到一个非限定的类、函数或常量名称时,它使用不同的优先策略来解析该名称。类名称总是解析到当前命名空间中的名称。因此在访问系统内部或不包含在命名空间中的类名称时,必须使用完全限定名称,例如:
<example>
<title>在命名空间中访问全局类</title>
<programlisting role="php">
<![CDATA[
<?php
namespace A\B\C;
class Exception extends \Exception {}
$a = new Exception('hi'); // $a 是类 A\B\C\Exception 的一个对象
$b = new \Exception('hi'); // $b 是类 Exception 的一个对象
$c = new ArrayObject; // 致命错误, 找不到 A\B\C\ArrayObject 类
?>
]]>
</programlisting>
</example>
</para>
<para>
对于函数和常量来说,如果当前命名空间中不存在该函数或常量,PHP
会退而使用全局空间中的函数或常量。
<example>
<title>命名空间中后备的全局函数/常量</title>
<programlisting role="php">
<![CDATA[
<?php
namespace A\B\C;
const E_ERROR = 45;
function strlen($str)
{
return \strlen($str) - 1;
}
echo E_ERROR, "\n"; // 输出 "45"
echo INI_ALL, "\n"; // 输出 "7" - 使用全局常量 INI_ALL
echo strlen('hi'), "\n"; // 输出 "1"
if (is_array('hi')) { // 输出 "is not array"
echo "is array\n";
} else {
echo "is not array\n";
}
?>
]]>
</programlisting>
</example>
</para>
</sect1>
<sect1 xml:id="language.namespaces.rules">
<title>名称解析规则</title>
<titleabbrev>名称解析规则</titleabbrev>
<?phpdoc print-version-for="namespaces"?>
<para>
在说明名称解析规则之前,我们先看一些重要的定义:
<variablelist>
<title>命名空间名称定义</title>
<varlistentry>
<term>非限定名称(Unqualified name)</term>
<listitem>
<para>
名称中不包含命名空间分隔符的标识符,例如 <literal>Foo</literal>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>限定名称(Qualified name)</term>
<listitem>
<para>
名称中含有命名空间分隔符的标识符,例如 <literal>Foo\Bar</literal>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>完全限定名称(Fully qualified name)</term>
<listitem>
<para>
名称中包含命名空间分隔符,并以命名空间分隔符开始的标识符,例如 <literal>\Foo\Bar</literal>。
<literal>namespace\Foo</literal> 也是一个完全限定名称。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>相对名称(Relative name)</term>
<listitem>
<para>
这是个以 <literal>namespace</literal> 开头的标识符,
例如
<literal>namespace\Foo\Bar</literal>。
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
名称解析遵循下列规则:
<orderedlist>
<listitem>
<simpara>
完全限定名称总是会解析成没有前缀符号的命名空间名称。
<literal>\A\B</literal> 解析为 <literal>A\B</literal>。
</simpara>
</listitem>
<listitem>
<simpara>
解析相对名称时,会用当前命名空间的名称替换掉 <literal>namespace</literal>。
如果名称出现在全局命名空间,会截掉 <literal>namespace\</literal> 前缀。
例如,在命名空间 <literal>X\Y</literal> 里的 <literal>namespace\A</literal> 会被解析成 <literal>X\Y\A</literal>。
在全局命名空间里,同样的名字却被解析成 <literal>A</literal>。
</simpara>
</listitem>
<listitem>
<simpara>
对于限定名称,名字的第一段会根据当前 class/namespace 导入表进行翻译。
比如命名空间 <literal>A\B\C</literal> 被导入为 <literal>C</literal>,
名称 <literal>C\D\E</literal> 会被翻译成
<literal>A\B\C\D\E</literal>。
</simpara>
</listitem>
<listitem>
<simpara>
对于限定名称,如果没有应用导入规则,就将当前命名空间添加为名称的前缀。
例如,位于命名空间 <literal>A\B</literal> 内的名称 <literal>C\D\E</literal>
会解析成 <literal>A\B\C\D\E</literal>。
</simpara>
</listitem>
<listitem>
<simpara>
根据符号类型和对应的当前导入表,解析非限定名称。
这也就是说,根据 class/namespace 导入表翻译类名称;
根据函数导入表翻译函数名称;
根据常量导入表翻译常量名称。
比如,在
<literal>use A\B\C;</literal> 后,类似 <literal>new C()</literal> 这样的名称会解析为
<literal>A\B\C()</literal>。
类似的,<literal>use function A\B\foo;</literal> 后,
<literal>foo()</literal> 的用法,解析名称为 <literal>A\B\foo</literal>。
</simpara>
</listitem>
<listitem>
<simpara>
如果没有应用导入规则,对于类似 class 符号的非限定名称,会添加当前命名空间作为前缀。
比如命名空间 <literal>A\B</literal> 内的 <literal>new C()</literal>
会把名称解析为 <literal>A\B\C</literal>。
</simpara>
</listitem>
<listitem>
<simpara>
如果没有应用导入规则,非限定名称指向函数或常量,且代码位于全局命名空间之外,则会在运行时解析名称。
假设代码位于命名空间 <literal>A\B</literal> 中,
下面演示了调用函数
<literal>foo()</literal> 是如何解析的:
</simpara>
<orderedlist>
<listitem>
<simpara>
在当前命名空间中查找函数:
<literal>A\B\foo()</literal>。
</simpara>
</listitem>
<listitem>
<simpara>
它会尝试找到并调用 <emphasis>全局</emphasis> 的函数
<literal>foo()</literal>。
</simpara>
</listitem>
</orderedlist>
</listitem>
</orderedlist>
</para>
<example>
<title>名称解析示例</title>
<programlisting role="php">
<![CDATA[
<?php
namespace A;
use B\D, C\E as F;
// 函数调用
foo(); // 首先尝试调用定义在命名空间"A"中的函数foo()
// 再尝试调用全局函数 "foo"
\foo(); // 调用全局空间函数 "foo"
my\foo(); // 调用定义在命名空间"A\my"中函数 "foo"
F(); // 首先尝试调用定义在命名空间"A"中的函数 "F"
// 再尝试调用全局函数 "F"
// 类引用
new B(); // 创建命名空间 "A" 中定义的类 "B" 的一个对象
// 如果未找到,则尝试自动装载类 "A\B"
new D(); // 使用导入规则,创建命名空间 "B" 中定义的类 "D" 的一个对象
// 如果未找到,则尝试自动装载类 "B\D"
new F(); // 使用导入规则,创建命名空间 "C" 中定义的类 "E" 的一个对象
// 如果未找到,则尝试自动装载类 "C\E"
new \B(); // 创建定义在全局空间中的类 "B" 的一个对象
// 如果未发现,则尝试自动装载类 "B"
new \D(); // 创建定义在全局空间中的类 "D" 的一个对象
// 如果未发现,则尝试自动装载类 "D"
new \F(); // 创建定义在全局空间中的类 "F" 的一个对象
// 如果未发现,则尝试自动装载类 "F"
// 调用另一个命名空间中的静态方法或命名空间函数
B\foo(); // 调用命名空间 "A\B" 中函数 "foo"
B::foo(); // 调用命名空间 "A" 中定义的类 "B" 的 "foo" 方法
// 如果未找到类 "A\B" ,则尝试自动装载类 "A\B"
D::foo(); // 使用导入规则,调用命名空间 "B" 中定义的类 "D" 的 "foo" 方法
// 如果类 "B\D" 未找到,则尝试自动装载类 "B\D"