|
| 1 | +# CodeMommy AutoloadPHP 1.0 开发手册 |
| 2 | + |
| 3 | +CodeMommy AutoloadPHP(以下简称AutoloadPHP)是开源项目组织[CodeMommy](http://www.codemommy.com)为PHP语言开发的自动加载库,可以很方便的按照您的需要加载PHP文件。 |
| 4 | +## 目录 |
| 5 | + |
| 6 | +- [环境要求](#环境要求) |
| 7 | +- [安装](#安装) |
| 8 | +- [使用](#使用) |
| 9 | + - [自动加载文件夹(PSR-4)](#自动加载文件夹(PSR-4)) |
| 10 | + - [自动加载文件](#自动加载文件) |
| 11 | + - [包含文件](#包含文件) |
| 12 | + |
| 13 | +## 环境要求 |
| 14 | + |
| 15 | +- PHP >= 5.3.0 |
| 16 | + |
| 17 | +## 安装 |
| 18 | + |
| 19 | +AutoloadPHP使用Composer进行包管理,我们推荐您使用此方法进行安装,您只需要在安装有Composer的环境下执行下面的命令并在入口文件引用Composer生成的*autoload.php*文件即可。 |
| 20 | + |
| 21 | +```bash |
| 22 | +$ composer require codemommy/autoloadphp |
| 23 | +``` |
| 24 | + |
| 25 | +```php |
| 26 | +<?php |
| 27 | +require_once './vendor/autoload.php'; |
| 28 | +``` |
| 29 | + |
| 30 | +当然,您也可以使用传统的安装方式。直接访问[此链接](https://github.com/CodeMommy/AutoloadPHP/releases)下载相应版本的压缩包,然后解压缩到您的项目目录。在需要使用AutoloadPHP的地方,请引用*autoload.php*文件即可。 |
| 31 | + |
| 32 | +```php |
| 33 | +<?php |
| 34 | +require_once './project/CodeMommy/AutoloadPHP/autoload.php'; |
| 35 | +``` |
| 36 | + |
| 37 | +## 使用 |
| 38 | + |
| 39 | +在使用AutoloadPHP之前都需要引用AutoloadPHP的命名空间。 |
| 40 | + |
| 41 | +```php |
| 42 | +<?php |
| 43 | +use CodeMommy\AutoloadPHP\Autoload; |
| 44 | +``` |
| 45 | + |
| 46 | +### 自动加载文件夹(PSR-4) |
| 47 | + |
| 48 | +通过Autoload类的静态方法directory即可实现,此方法没有返回值,参数如下: |
| 49 | + |
| 50 | +| 参数名 | 类型 | 说明 | 默认值 | 其他 | |
| 51 | +| --- | --- | --- | --- |--- | |
| 52 | +| directory | String | 需要加载的目录路径 | '.' | | |
| 53 | +| namespaceRoot | String |命名空间根名称 | '' | | |
| 54 | + |
| 55 | +例如: |
| 56 | + |
| 57 | +```php |
| 58 | +<?php |
| 59 | +Autoload::directory('/path/CodeMommy/AutoloadPHP', 'CodeMommy\\AutoloadPHP'); |
| 60 | +``` |
| 61 | + |
| 62 | +声明: |
| 63 | + |
| 64 | +```php |
| 65 | +<?php |
| 66 | +/** |
| 67 | + * Directory |
| 68 | + * @param string $directory |
| 69 | + * @param string $namespaceRoot |
| 70 | + * @return mixed |
| 71 | + */ |
| 72 | +public static function directory($directory = '.', $namespaceRoot = ''); |
| 73 | +``` |
| 74 | + |
| 75 | +### 自动加载文件 |
| 76 | + |
| 77 | +通过Autoload类的静态方法file即可实现,此方法没有返回值,参数如下: |
| 78 | + |
| 79 | +| 参数名 | 类型 | 说明 | 默认值 | 其他 | |
| 80 | +| --- | --- | --- | --- |--- | |
| 81 | +| file | String | 需要加载的文件路径 | '' | | |
| 82 | +| className | String | 类名称 | '' | | |
| 83 | + |
| 84 | +例如: |
| 85 | + |
| 86 | +```php |
| 87 | +<?php |
| 88 | +Autoload::file('/path/CodeMommy/AutoloadPHP.php', 'CodeMommy\\AutoloadPHP'); |
| 89 | +``` |
| 90 | + |
| 91 | +声明: |
| 92 | + |
| 93 | +```php |
| 94 | +<?php |
| 95 | +/** |
| 96 | + * File |
| 97 | + * @param string $file |
| 98 | + * @param string $className |
| 99 | + */ |
| 100 | +public static function file($file = '', $className = ''); |
| 101 | +``` |
| 102 | + |
| 103 | +### 包含文件 |
| 104 | + |
| 105 | +通过Autoload类的静态方法basic即可实现,此方法没有返回值,参数如下: |
| 106 | + |
| 107 | +| 参数名 | 类型 | 说明 | 默认值 | 其他 | |
| 108 | +| --- | --- | --- | --- |--- | |
| 109 | +| file | String | 需要加载的文件路径 | '' | | |
| 110 | +| isOnce | Bool | 是否只加载一次 | true | | |
| 111 | + |
| 112 | +例如: |
| 113 | + |
| 114 | +```php |
| 115 | +<?php |
| 116 | +Autoload::basic('/path/CodeMommy/AutoloadPHP/autoload.php', true); |
| 117 | +``` |
| 118 | + |
| 119 | +声明: |
| 120 | + |
| 121 | +```php |
| 122 | +<?php |
| 123 | +/** |
| 124 | + * Basic |
| 125 | + * @param string $file |
| 126 | + * @param bool $isOnce |
| 127 | + */ |
| 128 | +public static function basic($file = '', $isOnce = true) |
| 129 | +``` |
0 commit comments