如何创建一个由作曲家自动加载使用的库?

时间:2014-01-15 12:07:11

标签: php composer-php

我想让Composer自动加载this package

此套餐可在Packagist

上找到

我意识到我需要向composer.json添加内容,我需要在某处autoload.php

唯一应自动加载的类是Webbot.php

有人可以给我一步一步的分解来实现这个目标吗?

返回的Google搜索结果是自动加载库的说明。

我需要有关如何编写自动加载库的说明。

1 个答案:

答案 0 :(得分:12)

首先,您需要将您的包装结构化为PSR-0或PSR-4。我还没有开始使用PSR-4,因为它刚刚被接受为标准。 Composer仍将在未来很长一段时间内支持PSR-0。

这意味着您必须遵循以下规则:

  • 完全限定的命名空间和类必须具有以下内容 结构<Vendor Name>\(<Namespace>\)*<Class Name>
  • 每个命名空间必须具有顶级命名空间(“供应商名称”)。
  • 每个命名空间可以包含任意数量的子命名空间。
  • 每个命名空间分隔符在转换为DIRECTORY_SEPARATOR时 从文件系统加载。
  • CLASS NAME中的每个_字符都转换为a DIRECTORY_SEPARATOR。 _字符没有特殊含义 命名空间。
  • 完全限定的命名空间和类后缀为.php 从文件系统加载。
  • 供应商名称,名称空间和类名称中的字母字符 可以是小写和大写的任意组合。

Full FIG guidelines here

这意味着你的包应该放在你的github存储库中,如下所示:

-src
    -Simkimsia
        -Webbot
            -Webbot.php
-composer.json
-license.md
-{any other base level files}

Webbot.php将在命名空间中:Simkimsia\Webbot,由目录结构指定。

然后......由于这是一个github包,你可以使用repositories属性将它添加到你的项目composer.json中。

{
    "name" : 'test',
    "description" : 'Test',
    "keywords" : ['test'],
    "repositories" : [
    {
        "type": "vcs",
        "url": "https://github.com/simkimsia/webbot.git"
    }
    ],
    "require" : {
        "simkimsia/webbot" : "dev-master"
    }
}

该软件包将可从Composers自动加载中获得,并可以实例化为:

$webbot = new Simkimsia\Webbot\Webbot();

注意: 运行composer install后,将会提供作曲家autoload.php:

/vendor/composer/autoload.php

只需在PHP脚本的开头包含此文件,您的课程就可以使用。