samsonasik/ci4-album

CodeIgniter 4 相册模块的示例

资助包维护!
samsonasik

1.15.0 2024-05-02 02:29 UTC

README

Latest Version ci build Mutation testing badge Code Coverage PHPStan Downloads

功能

安装

1. 获取模块

a. 使用 composer require

composer require samsonasik/ci4-album

或者

b. 手动,通过在项目根目录中的 app/ThirdParty 目录下克隆此仓库到 app/ThirdParty 目录

cd app/ThirdParty
git clone git@github.com:samsonasik/ci4-album.git

有关常见克隆问题的故障排除,请参阅https://help.github.com/en/github/authenticating-to-github/error-permission-denied-publickey#

然后注册 "Album" 到 App/Config/Autoload.php 的 psr4 属性

		$psr4 = [
			'App'         => APPPATH,                // To ensure filters, etc still found,
			APP_NAMESPACE => APPPATH,                // For custom namespace
			'Config'      => APPPATH . 'Config',
			'Album'       => APPPATH . 'ThirdParty/ci4-album/src', // <-- add this line
		];

2. 根据您现有的数据库设置 CI_ENVIRONMENT、基础 URL、索引页和数据库配置在您的 .env 文件中(如果您没有 .env 文件,您可以从 env 文件中复制第一个:cp env .env)。如果数据库不存在,请先创建数据库。

# .env file
CI_ENVIRONMENT = development

app.baseURL = 'http://localhost:8080'
app.indexPage = ''

database.default.hostname = localhost
database.default.database = ci4_crud
database.default.username = root
database.default.password =
database.default.DBDriver = MySQLi

3. 运行数据库迁移

php spark migrate -n Album

4. 运行数据库种子(可选)

php spark db:seed "Album\Database\Seeds\AlbumSeeder"
php spark db:seed "Album\Database\Seeds\TrackSeeder"

5. 运行开发服务器

php spark serve

6. 在浏览器中打开 http://localhost:8080/album

设置

通过将 src/Config/Album.php 文件复制到 app/Config 目录并修改命名空间为 Config 来配置每页分页。

<?php namespace Config;

use CodeIgniter\Config\BaseConfig;

class Album extends BaseConfig
{
    public $paginationPerPage = 10;
}
// app/Config/Album.php

在上面的类中,可以更改 paginationPerPage 属性的值。

测试

在第一次运行时,您需要创建数据库,并为测试目的设置从 phpunit.xml.dist 文件中的 phpunit.xml 文件

cd /path/to/modules/ci4-album
cp phpunit.xml.dist phpunit.xml

然后配置 phpunit.xml 以确保它具有与您的本地开发环境相匹配的数据库配置。如果数据库不存在,请先创建数据库。

	<php>
		<server name="app.baseURL" value="http://localhost:8080"/>
		<const name="HOMEPATH" value="./"/>
		<const name="CONFIGPATH" value="./vendor/codeigniter4/framework/app/Config/"/>
		<const name="PUBLICPATH" value="./vendor/codeigniter4/framework/public/"/>
		<env name="database.tests.hostname" value="localhost"/>
		<env name="database.tests.database" value="ci4_crud_test"/>
		<env name="database.tests.username" value="root"/>
		<env name="database.tests.password" value=""/>
		<env name="database.tests.DBDriver" value="MySQLi"/>
		<env name="database.tests.DBPrefix" value=""/>
	</php>

确保您为 测试 使用 不同的数据库

之后,安装 codeigniter 和 phpunit 依赖项

cd /path/to/modules/ci4-album && composer install

最后,运行测试

vendor/bin/phpunit

贡献

非常欢迎贡献。请阅读 CONTRIBUTING.md