The Yaf_Loader class

(Yaf >=1.0.0)

簡介

Yaf_Loader 類為Yaf提供了自動加載功能的全面解決方案。

在第一次使用的時候，將檢索 Yaf_Application 的實例， Yaf_Loader 實現(xiàn)了單利模式，并使用spl_autoload注冊它自己。 通過 Yaf_Loader::getInstance() 返回它的實例

Yaf_Loader 加載一個類時僅僅嘗試一次，如果失敗了， 后面的操作將取決于yaf.use_spl_auload， 如果這個配置項為On，Yaf_Loader::autoload() 將會返回FALSE， 從而把機會讓給其他的自動加載功能。如果這個配置項為Off（默認）， Yaf_Loader::autoload() 將會返回TRUE， 最重要的是將會拋出一個非常有用的警告（對于找出一個類加載失敗非常有用）。

注意:

請保持yaf.use_spl_autoload保持關(guān)閉，除非有一些library有自己的autoload機制，并且是無法改寫的。

默認情況下，Yaf_Loader 收集所有l(wèi)ibrary(類定義的腳本)儲存進在 php.ini(yaf.library)定義的global library directory之中。

如果你想使用 Yaf_Loader 搜索本地類（庫）（定義在application.ini， 默認情況下，它是 application.directory . "/libraray"）， 你需要使用 Yaf_Loader::registerLocalNameSpace() 注冊本地類前綴。

讓我們來看看一些例子（假設(shè) APPLICATION_PATH 是 application.directory）：

示例 #1 Config example

// Assuming the following configure in php.ini:
yaf.libraray = "/global_dir"

//Assuming the following configure in application.ini
application.libraray = APPLICATION_PATH "/library"
假設(shè)以下本地名稱空間已被注冊：

示例 #2 注冊本地命名空間

<?php
class Bootstrap extends Yaf_Bootstrap_Abstract{
     public function _initLoader($dispatcher) {
          Yaf_Loader::getInstance()->registerLocalNameSpace(array("Foo", "Bar"));
     }
?>
自動加載例子：

示例 #3 加載類

class Foo_Bar_Test =>
  // APPLICATION_PATH/library/Foo/Bar/Test.php
  
class GLO_Name  =>
  // /global_dir/Glo/Name.php
 
class BarNon_Test
  // /global_dir/Barnon/Test.php
在PHP 5.3中，你可以使用命名空間：

示例 #4 加載命名空間類

class \Foo\Bar\Dummy =>
   // APPLICATION_PATH/library/Foo/Bar/Dummy.php

class \FooBar\Bar\Dummy =>
   // /global_dir/FooBar/Bar/Dummy.php

你可能會注意到所有文件夾名字的首字母是大寫的，你可以通過在php.ini中設(shè)置 yaf.lowcase_path = On 來將它們小寫。

Yaf_Loader 也是設(shè)計來加載MVC類，響應的規(guī)則如下：

示例 #5 MVC類加載例子

Controller Classes =>
// APPLICATION_PATH/controllers/

Model Classes =>
// APPLICATION_PATH/models/

Plugin Classes =>
// APPLICATION_PATH/plugins/
Yaf 通過識別一個類的后綴（這個是默認的，你也可以通過改變配置項 yaf.name_suffix 來將它改為通過前綴識別）來決定它是否是一個MVC類：

示例 #6 MVC 類區(qū)別

Controller Classes =>
    // ***Controller

Model Classes =>
    // ***Model

Plugin Classes =>
    // ***Plugin
some examples:

示例 #7 MVC loading example

class IndexController
    // APPLICATION_PATH/controllers/Index.php

class DataModel =>
   // APPLICATION_PATH/models/Data.php

class DummyPlugin =>
  // APPLICATION_PATH/plugins/Dummy.php

class A_B_TestModel =>
  // APPLICATION_PATH/models/A/B/Test.php
該目錄將受 yaf.lowcase_path 的影響。

類摘要

class Yaf_Loader {
/* 屬性 */
protected $_local_ns;
protected $_library;
protected $_global_library;
static $_instance;
/* 方法 */
public autoload(): void
public clearLocalNamespace(): void
private__construct()
public static getInstance(): void
public getLibraryPath(bool $is_global = false): Yaf_Loader
public getLocalNamespace(): void
public getNamespacePath(string $namespaces): string
public getNamespaces(): array
public static import(): void
public isLocalName(): void
public registerLocalNamespace(mixed $prefix = ?): void
public registerNamespace(string|array $namespaces, string $path = ?): bool
public setLibraryPath(string $directory, bool $is_global = false): Yaf_Loader
}

屬性

_local_ns

_library

默認情況下，它的值是 application.directory . "/library"， 你可以通過修改application.ini(application.library)或者調(diào)用 Yaf_Loader::setLibraryPath() 改變它。

_global_library

_instance

目錄