PHP 命名空間

PHP 命名空間(namespace)是在PHP 5.3中加入的，如果你學過C#和Java，那麼命名空間就不算什麼新事物。不過在PHP當中還是有著相當重要的意義。

PHP 命名空間可以解決以下兩類問題：

使用者寫的程式碼與PHP內部的類別/函數/常數或第三方類別/函數/常數之間的名字衝突。

為很長的識別碼名稱(通常是為了緩解第一類問題而定義的)創建一個別名（或簡短）的名稱，提高原始碼的可讀性。

定義命名空間

預設情況下，所有常數、類別和函數名稱都放在全域空間下，就和PHP支援命名空間之前一樣。

空間的命名中，我們通常使用公司、企業、個人的名稱或縮寫為標識，首字母要求大寫，並且不可以以數字開頭

命名空間透過關鍵字namespace 來聲明。如果一個檔案中包含命名空間，它必須在其它所有程式碼之前聲明命名空間。語法格式如下;

<?php

// 定義程式碼在 'MyProject' 命名空間中
namespace MyProject;
#// ... 程式碼. ..

?>

你也可以在同一個檔案中定義不同的命名空間程式碼，例如：

##<?php
namespace MyProject1;
// MyProject1 命名空間中的PHP代碼

namespace MyProject2;
// MyProject2 命名空間中的PHP代碼

///// MyProject2 命名空間中的PHP代碼

////#另一種語法

namespace MyProject3 {
// MyProject3 命名空間中的PHP代碼

}
?>

#在聲明命名空間之前唯一合法的程式碼是用來定義原始檔編碼方式的declare 語句。所有非 PHP 程式碼包括空格符都不能出現在命名空間的宣告之前。

<?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(); 
} 
?>

以下程式碼會出現語法錯誤：

<html>

<?php
namespace MyProject; // 命名空間前出現了「< html>」會致命錯誤-　命名空間必須是程式腳本的第一個語句

子命名空間

子名字空間的宣告與前面的範例完全一樣。唯一的區別是我們在名字空間和子名字空間之間添加了一個\符號用來分隔，子名字空間可以有任意的層級劃分，只要能明確按功能劃分即可：

<? php

namespace MyProject\Sub\Level; //宣告分層的單一命名空間

const CONNECT_OK = 1;
class Connection { /* ... */ }
function Connect() { /* ... */ }
}

上面的範例建立了常數MyProject\Sub\Level\CONNECT_OK，類別MyProject\ Sub\Level\Connection 和函數MyProject\Sub\Level\Connect。

命名空間使用

PHP 命名空間中的類別名稱可以透過三種方式引用：###

非限定名稱，或不包含前綴的類別名稱，例如 $a=new foo(); 或 foo::staticmethod();。如果目前命名空間是 currentnamespace，foo 將會解析為 currentnamespace\foo。如果使用 foo 的程式碼是全域的，不包含在任何命名空間中的程式碼，則 foo 會被解析為foo。警告：如果命名空間中的函數或常數未定義，則該非限定的函數名稱或常數名稱會被解析為全域函數名稱或常數名稱。

限定名稱,或包含前綴的名稱，例如 $a = new subnamespace\foo(); 或 subnamespace\foo::staticmethod();。如果目前的命名空間是 currentnamespace，則 foo 會被解析為 currentnamespace\subnamespace\foo。如果使用 foo 的程式碼是全域性的，不包含在任何命名空間中的程式碼，foo 會被解析為subnamespace\foo。

完全限定名稱，或包含了全域前綴運算符的名稱，例如， $a = new \currentnamespace\foo(); 或 \currentnamespace\foo::staticmethod();。在這種情況下，foo 總是被解析為程式碼中的文字名稱(literal name)currentnamespace\foo。

下面是一個使用這三種方式的實例：

file1.php 檔案程式碼

<?php
namespace Foo\Bar\subnamespace; 
const FOO = 1; 
function foo() {} 
class foo 
{ 
static function staticmethod() {} 
} 
?>

file2.php 檔案程式碼

<?php
namespace Foo\Bar; 
include 'file1.php'; 
const FOO = 2; 
function foo() {} 
class foo 
{ 
static function staticmethod() {} 
} 
/* 非限定名称 */ 
foo(); // 解析为 Foo\Bar\foo resolves to function Foo\Bar\foo 
foo::staticmethod(); 
// 解析为类 Foo\Bar\foo的静态方法staticmethod。resolves to class Foo\Bar\foo, method staticmethod 
echo FOO; // resolves to constant 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 
?>

注意存取任意全域類別、函數或常數，都可以使用完全限定名稱，例如\strlen() 或\Exception 或\INI_ALL。

在命名空間內部存取全域類別、函數和常數：

<?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 
?>

命名空間和動態語言特徵

PHP 命名空間的實作受到其語言本身的動態特徵的影響。因此，如果要將下面的程式碼轉換到命名空間中，動態存取元素。

example1.php 檔案程式碼：

<?php
class classname 
{ 
function __construct() 
{ 
echo __METHOD__,"\n"; 
} 
} 
function funcname() 
{ 
echo __FUNCTION__,"\n"; 
} 
const constname = "global"; 
$a = 'classname'; 
$obj = new $a; // prints classname::__construct 
$b = 'funcname'; 
$b(); // prints funcname 
echo constant('constname'), "\n"; // prints global 
?>

必須使用完全限定名稱（包括命名空間前綴的類別名稱）。注意因為在動態的類別名稱、函數名稱或常數名稱中，限定名稱和完全限定名稱沒有區別，因此其前導的反斜線是不必要的。

動態存取命名空間的元素

<?php
namespace namespacename; 
class classname 
{ 
function __construct() 
{ 
echo __METHOD__,"\n"; 
} 
} 
function funcname() 
{ 
echo __FUNCTION__,"\n"; 
}
const constname = "namespaced"; 
include 'example1.php'; 
$a = 'classname'; 
$obj = new $a; // prints classname::__construct 
$b = 'funcname'; 
$b(); // prints funcname 
echo constant('constname'), "\n"; // prints global 
/* note that if using double quotes, " \namespacename\classname" must be used */ 
$a = '\namespacename\classname'; 
$obj = new $a; // prints namespacename\classname::__construct 
$a = 'namespacename\classname'; 
$obj = new $a; // also prints namespacename\classname::__construct 
$b = 'namespacename\funcname'; 
$b(); // prints namespacename\funcname 
$b = '\namespacename\funcname'; 
$b(); // also prints namespacename\funcname 
echo constant('\namespacename\constname'), "\n"; // prints namespaced 
echo constant('namespacename\constname'), "\n"; // also prints namespaced 
?>

namespace關鍵字和__NAMESPACE__常數

PHP支援兩種抽象的存取目前命名空間內部元素的方法，__NAMESPACE__ 魔術常數和namespace關鍵字。

常數__NAMESPACE__的值是包含目前命名空間名稱的字串。在全域的，不包括在任何命名空間中的程式碼，它包含一個空的字串。

__NAMESPACE__ 範例, 在命名空間中的程式碼

<?php

namespace MyProject;

#echo '"' , __NAMESPACE__, '"'; // 輸出"MyProject"

#?>

__NAMESPACE__ 範例，全域程式碼

<?php

echo '"', __NAMESPACE__, '"'; // 輸出""

?>

常數__NAMESPACE__ 在動態建立名稱時很有用，例如：

使用__NAMESPACE__動態建立名稱

<?php

namespace MyProject;

function get($classname)
{
$a = __NAMESPACE__ . '\\' . $classname;

#' #return new $a;

}

#關鍵字namespace 可用來明確存取目前命名空間或子命名空間中的元素。它等價於類別中的 self 操作符。

namespace運算符，命名空間中的程式碼

<?php
namespace MyProject; 
use blah\blah as mine; // see "Using namespaces: importing/aliasing" 
blah\mine(); // calls function blah\blah\mine() 
namespace\blah\mine(); // calls function MyProject\blah\mine() 
namespace\func(); // calls function MyProject\func() 
namespace\sub\func(); // calls function MyProject\sub\func() 
namespace\cname::method(); // calls static method "method" of class MyProject\cname 
$a = new namespace\sub\cname(); // instantiates object of class MyProject\sub\cname 
$b = namespace\CONSTANT; // assigns value of constant MyProject\CONSTANT to $b 
?>

namespace運算子, 全域程式碼

<?php
namespace\func(); // calls function func() 
namespace\sub\func(); // calls function sub\func() 
namespace\cname::method(); // calls static method "method" of class cname 
$a = new namespace\sub\cname(); // instantiates object of class sub\cname 
$b = namespace\CONSTANT; // assigns value of constant CONSTANT to $b 
?>

使用命名空間：別名/匯入

#PHP 命名空間支援有兩種使用別名或匯入方式：為類別名稱使用別名，或為命名空間名稱使用別名。注意PHP不支援導入函數或常數。

在PHP中，別名是透過運算子use 來實現的. 以下是一個使用所有可能的三種導入方式的範例：

1、使用use運算子匯入/使用別名

<?php
namespace foo; 
use My\Full\Classname as Another; 
// 下面的例子与 use My\Full\NSname as NSname 相同 
use My\Full\NSname; 
// 导入一个全局类 
use \ArrayObject; 
$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 对象 
?>

2、一行中包含多個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; // instantiates object of class Another 
$obj = new Another\thing; // 实例化对象的类 My\Full\Classname\thing 
$obj = new \Another\thing; // instantiates object of class Another\thing 
?>

use 關鍵字的使用：

必須在PHP檔案的頂部，也就是PHP的開標籤<?php或者名字空間的聲明之後緊接著使用use關鍵字來導入代碼。

使用use關鍵字匯入程式碼時無需在類別名稱最前面加上\符號，因為PHP假設匯入的名字空間是完全合格的。

use關鍵字必須在全域的作用域中使用（也就是說不可以在類別或函數裡使用）

use關鍵字可以放在名字空間的宣告之下，用來導入其他名字空間下的代碼。

使用命名空間：後備全域函數/常數#########在一個命名空間中，當PHP 遇到一個非限定的類別、函數或常數名稱時，它使用不同的優先策略來解析該名稱。類別名稱總是解析到目前命名空間中的名稱。因此在存取系統內部或不包含在命名空間中的類別名稱時，必須使用完全限定名稱，例如：#######1、在命名空間中存取全域類別###

<?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 类 
?>

###對於函數和常數來說，如果目前命名空間中不存在該函數或常數，PHP 會退而使用全域空間中的函數或常數。 ######2、命名空間中後備的全域函數/常數###

<?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"; 
} ?>

###全域空間######如果沒有定義任何命名空間，所有的類別與函數的定義都是在全域空間，與PHP 引入命名空間概念前一樣。在名稱前加上前綴 \ 表示該名稱是全域空間中的名稱，即使該名稱位於其它的命名空間中也是如此。 ######使用全域空間說明######使用全域名字空間只需在類別名稱前面加上一個\符號例如: throw new \ Exception();###

<?php
namespace A\B\C; 
/* 这个函数是 A\B\C\fopen */ 
function fopen() { 
/* ... */ 
$f = \fopen(...); // 调用全局的fopen函数 
return $f; 
?>

###命名空間的順序# ##

自從有了命名空間之後，最容易出錯的該是使用類別的時候，這個類別的尋找路徑是什麼樣的了。

<?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"

#\B \foo(); // 呼叫命名空間"B" 中的函數"foo"

\B::foo(); // 呼叫全域空間中的類別"B" 的"foo" 方法
// 如果類別"B" 找不到，則嘗試自動載入類別"B"

// 目前命名空間中的靜態方法或函數

A\B::foo( ); // 呼叫命名空間"A\A" 中定義的類別"B" 的"foo" 方法
// 如果類別"A\A\B" 未找到，則嘗試自動載入類別"A\A \B"

\A\B::foo(); // 呼叫命名空間"A\B" 中定義的類別"B" 的"foo" 方法
// 如果類別"A\B" 未找到，則嘗試自動裝載類別"A\B"

?>