scherbak-electronics/php-app-template

一个超极简的PHP应用程序模板,带有预配置的Composer自动加载。

v1.0.2 2024-06-27 14:47 UTC

This package is auto-updated.

Last update: 2024-09-27 15:22:36 UTC


README

这是一个尽可能简化的PHP应用程序模板,旨在提供具有Composer自动加载的基本项目结构。它非常适合超小型极简项目或需要干净、超极简设置且能够按需扩展的脚本。

特点

  • 最小化设置:初始时只存在两个文件(composer.jsonmain.php)。
  • Composer自动加载:已配置PSR-4自动加载,您可以在 src/ 目录下添加类。

入门指南

以下说明将帮助您在本地机器上复制项目并运行,以便进行开发和测试。

先决条件

您需要在系统上安装Composer才能使用此项目模板。您可以通过访问官方Composer网站上的说明下载并安装Composer。

安装

要基于此模板开始新项目,请运行以下命令

composer create-project scherbak-electronics/php-app-template path/to/your-new-project

结构

  • src/:您的PHP类应该放置的目录(遵循 App\ 命名空间)。
  • main.php:一个简单的PHP脚本,用于演示设置。根据需要修改或扩展它。为了便于从命令行直接执行脚本,请在文件开头包含shebang行 #!/usr/bin/env php

用法

安装后,您可以在 src/ 目录中开始添加PHP类。例如,要添加一个新的类 Example,创建一个包含以下内容的文件 src/Example.php

<?php
namespace App;

class Example {
    public function sayHello() {
        return "Hello from Example class!";
    }
}

然后您可以在 main.php 文件中使用此类

<?php
require __DIR__ . '/vendor/autoload.php';

use App\Example;

$example = new Example();
echo $example->sayHello();

要运行您的脚本,请使用

php main.php

贡献

贡献使得开源社区成为一个学习、灵感和创作的绝佳地方。您所提供的任何贡献都将受到高度赞赏。

许可

该项目以MIT许可证开源,但没有详细的LICENSE文件,对此表示歉意。