How to handwrite a composer package and upload it for publication

1. About composer

Composer is a dependency management tool for PHP5.3 or above. It allows you to declare the code libraries your project depends on and it will install them for you in your project. With it, we can easily use a command to reference other excellent codes into our project.

2. Dependency package management tool

java has maven, and the front-end has npm, Android has Gradle, and as the best language in the world also has composer

3. Composer Advantages

• You have a project that depends on several libraries.
• Some of these libraries depend on other libraries.
• You declare what you depend on.
• Composer will figure out which versions of packages need to be installed, and install them (download them into your project).

4. Common composer commands

• composer require：Install a software package
  
• composer update：will detect the environment and dependencies required by the new version of the package and automatically implement the upgrade of the tool package
  
• composer install：If there is no composer.json file, the dependencies in composer.json will be installed
  
• composer init : will initialize a composer.json configuration file
  

  ##5. Composer installation Refer to the novice tutorial

6. Handwrite a composer package

blog.

1. Execute in the directory: composer init

After execution, let us enter a package name. Just call it
guangtouqiang/blog.

Package name

name

The name of the package, which consists of the vendor name and the project name, separated by /.
• This is required for packages (libraries) that need to be published.
• For example, phpmailer/phpmailer

2. Execute guangtouqiang/blog:

Next let’s enter a description.

Description

description

A brief description of a package. Usually this is only one line at most.
• This is required for packages (libraries) that need to be published.

3. Enter the description this is guangtouqiang test bag

##4.
Enter author name (optional)

authors

This object must contain all the following properties.

• name: The author's name, usually his real name.
• email: The author’s email address.
• homepage: The URL address of the author's homepage.
• role: The author's role in this project (e.g. developer or translator).

Available stability identifiers:

, generally choose dev.

type

<ul> <li>包的安装类型，默认为<code>library。

library: 这是默认类型，它会简单的将文件复制到 vendor 目录。

project: 这表示当前包是一个项目，而不是一个库。例：框架应用程序 Symfony standard edition，内容管理系统 SilverStripe installer 或者完全成熟的分布式应用程序。使用 IDE 创建一个新的工作区时，这可以为其提供项目列表的初始化。

metapackage: 当一个空的包，包含依赖并且需要触发依赖的安装，这将不会对系统写入额外的文件。因此这种安装类型并不需要一个 dist 或 source。

composer-plugin: 一个安装类型为 composer-plugin 的包，它有一个自定义安装类型，可以为其它包提供一个 installler。详细请查看 自定义安装类型。

默认为 library

我们选择1，library即可！

7、需要输入开源协议

选择输入GPL,LGPL,BSD,MIT,Apache这些开源协议即可：

8、是否依赖于其它包，是否依赖于其它环境，这边都yes即可。

Search for a package：选择搜索php。

9、生成成功。

此时，目录下已经有个composer这些配置：

七、composer目录的修改

看下刚刚生成的composer.json：

{
    "name": "guangtouqiang/blog",
    "description": "this is guangtouqiang test bag",
    "type": "1",
    "require": {
        "php": "^7.0"
    },
    "license": "Apache-2.0",
    "authors": [
        {
            "name": "guangtouqiang",
            "email": "xiaozhengguo521@gmail.com"
        }
    ],
    "minimum-stability": "dev"}

再次基础上增加：

{
    "name": "guangtouqiang/blog",
    "description": "this is guangtouqiang test bag",
    "type": "1",
    "require": {
        "php": "^7.0"
    },
    "license": "Apache-2.0",
    "authors": [
        {
            "name": "guangtouqiang",
            "email": "xiaozhengguo521@gmail.com"
        }
    ],
    "minimum-stability": "dev",
    "autoload": {
        "psr-4": {
            "guangtouqiang\\": "src/guangtouqiang"
        }
    }}

命令行执行：composer dump-autoload，更新composer的命名空间与文件夹映射关系。

同样，需要新建一个src和guangtouqiang的文件夹：

在根目录新建个index.php测试一波：

输出：

注意命名空间的层级与文件夹层级是否相同，类名与文件名相同才能自动加载。

八、将写好的composer包上传

1、在github上新建个仓库

2、将本地的composer包上传到新仓库

• git init
• git add .
• git commit -m "xxx"
• git remote add origin 你的远程仓库地址
• git push -u origin master

3、登录https://packagist.org/packages/submit

4、将你github上的仓库地址复制进去：

5、配置webhook：

6、复制上图地址到github。

Addwebhook:

At this time, the github warehouse and packagist have been associated. But it still needs to be released to the official version before it can be used.

7. Tag the version

git tag -a v1.0.1 -m "First Edition"
git push origin v1.0.1

At this point, the labeling has been successful, and all our versions can be seen from packagist.

Execute composer require xx/xxx and it will be available for others to use.

9. Summary

For detailed description of composer.json, please refer to : Detailed use of composer.json

For more composer-related technical articles, please visit the composer tutorial column!

The above is the detailed content of How to handwrite a composer package and upload it for publication. For more information, please follow other related articles on the PHP Chinese website!